libZSservicesZSamazonka-comprehendZSamazonka-comprehend
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Comprehend

Contents

Description

Derived from API version 2017-11-27 of the AWS service descriptions, licensed under Apache 2.0.

Amazon Comprehend is an AWS 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.

Synopsis

Service Configuration

defaultService :: Service Source #

API version 2017-11-27 of the Amazon Comprehend SDK configuration.

Errors

Error matchers are designed for use with the functions provided by Control.Exception.Lens. This allows catching (and rethrowing) service specific errors returned by Comprehend.

ResourceUnavailableException

_ResourceUnavailableException :: AsError a => Getting (First ServiceError) a ServiceError Source #

The specified resource is not available. Check the resource and try your request again.

InvalidRequestException

ResourceLimitExceededException

_ResourceLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #

The maximum number of resources per account has been exceeded. Review the resources, and then try your request again.

TooManyTagsException

_TooManyTagsException :: AsError a => Getting (First ServiceError) a ServiceError Source #

The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.

TooManyRequestsException

_TooManyRequestsException :: AsError a => Getting (First ServiceError) a ServiceError Source #

The number of requests exceeds the limit. Resubmit your request later.

ConcurrentModificationException

_ConcurrentModificationException :: AsError a => Getting (First ServiceError) a ServiceError Source #

Concurrent modification of the tags associated with an Amazon Comprehend resource is not supported.

InternalServerException

_InternalServerException :: AsError a => Getting (First ServiceError) a ServiceError Source #

An internal server error occurred. Retry your request.

BatchSizeLimitExceededException

_BatchSizeLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #

The number of documents in the request exceeds the limit of 25. Try your request again with fewer documents.

UnsupportedLanguageException

_UnsupportedLanguageException :: AsError a => Getting (First ServiceError) a ServiceError Source #

Amazon Comprehend can't process the language of the input text. For custom entity recognition APIs, only English, Spanish, French, Italian, German, or Portuguese are accepted. For a list of supported languages, see supported-languages.

JobNotFoundException

_JobNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #

The specified job was not found. Check the job ID and try again.

TooManyTagKeysException

_TooManyTagKeysException :: AsError a => Getting (First ServiceError) a ServiceError Source #

The request contains more tag keys than can be associated with a resource (50 tag keys per resource).

InvalidFilterException

_InvalidFilterException :: AsError a => Getting (First ServiceError) a ServiceError Source #

The filter specified for the operation is invalid. Specify a different filter.

KmsKeyValidationException

_KmsKeyValidationException :: AsError a => Getting (First ServiceError) a ServiceError Source #

The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.

ResourceNotFoundException

_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #

The specified resource ARN was not found. Check the ARN and try your request again.

TextSizeLimitExceededException

_TextSizeLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #

The size of the input text exceeds the limit. Use a smaller document.

ResourceInUseException

_ResourceInUseException :: AsError a => Getting (First ServiceError) a ServiceError Source #

The specified resource name is already in use. Use a different name and try your request again.

Waiters

Waiters poll by repeatedly sending a request until some remote success condition configured by the Wait specification is fulfilled. The Wait specification determines how many attempts should be made, in addition to delay and retry strategies.

Operations

Some AWS operations return results that are incomplete and require subsequent requests in order to obtain the entire result set. The process of sending subsequent requests to continue where a previous request left off is called pagination. For example, the ListObjects operation of Amazon S3 returns up to 1000 objects at a time, and you must send subsequent requests with the appropriate Marker in order to retrieve the next page of results.

Operations that have an AWSPager instance can transparently perform subsequent requests, correctly setting Markers and other request facets to iterate through the entire result set of a truncated API operation. Operations which support this have an additional note in the documentation.

Many operations have the ability to filter results on the server side. See the individual operation parameters for details.

BatchDetectSentiment

data BatchDetectSentiment Source #

See: newBatchDetectSentiment smart constructor.

Instances

Instances details
Eq BatchDetectSentiment Source # 
Instance details

Defined in Amazonka.Comprehend.BatchDetectSentiment

Show BatchDetectSentiment Source # 
Instance details

Defined in Amazonka.Comprehend.BatchDetectSentiment

Generic BatchDetectSentiment Source # 
Instance details

Defined in Amazonka.Comprehend.BatchDetectSentiment

Associated Types

type Rep BatchDetectSentiment :: Type -> Type #

NFData BatchDetectSentiment Source # 
Instance details

Defined in Amazonka.Comprehend.BatchDetectSentiment

Methods

rnf :: BatchDetectSentiment -> () #

Hashable BatchDetectSentiment Source # 
Instance details

Defined in Amazonka.Comprehend.BatchDetectSentiment

ToJSON BatchDetectSentiment Source # 
Instance details

Defined in Amazonka.Comprehend.BatchDetectSentiment

AWSRequest BatchDetectSentiment Source # 
Instance details

Defined in Amazonka.Comprehend.BatchDetectSentiment

Associated Types

type AWSResponse BatchDetectSentiment #

ToHeaders BatchDetectSentiment Source # 
Instance details

Defined in Amazonka.Comprehend.BatchDetectSentiment

ToPath BatchDetectSentiment Source # 
Instance details

Defined in Amazonka.Comprehend.BatchDetectSentiment

ToQuery BatchDetectSentiment Source # 
Instance details

Defined in Amazonka.Comprehend.BatchDetectSentiment

type Rep BatchDetectSentiment Source # 
Instance details

Defined in Amazonka.Comprehend.BatchDetectSentiment

type Rep BatchDetectSentiment = D1 ('MetaData "BatchDetectSentiment" "Amazonka.Comprehend.BatchDetectSentiment" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "BatchDetectSentiment'" 'PrefixI 'True) (S1 ('MetaSel ('Just "textList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive [Sensitive Text])) :*: S1 ('MetaSel ('Just "languageCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 LanguageCode)))
type AWSResponse BatchDetectSentiment Source # 
Instance details

Defined in Amazonka.Comprehend.BatchDetectSentiment

newBatchDetectSentiment Source #

Create a value of BatchDetectSentiment with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:textList:BatchDetectSentiment', batchDetectSentiment_textList - A list containing the text of the input documents. The list can contain a maximum of 25 documents. Each document must contain fewer that 5,000 bytes of UTF-8 encoded characters.

$sel:languageCode:BatchDetectSentiment', batchDetectSentiment_languageCode - The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.

data BatchDetectSentimentResponse Source #

See: newBatchDetectSentimentResponse smart constructor.

Instances

Instances details
Eq BatchDetectSentimentResponse Source # 
Instance details

Defined in Amazonka.Comprehend.BatchDetectSentiment

Show BatchDetectSentimentResponse Source # 
Instance details

Defined in Amazonka.Comprehend.BatchDetectSentiment

Generic BatchDetectSentimentResponse Source # 
Instance details

Defined in Amazonka.Comprehend.BatchDetectSentiment

Associated Types

type Rep BatchDetectSentimentResponse :: Type -> Type #

NFData BatchDetectSentimentResponse Source # 
Instance details

Defined in Amazonka.Comprehend.BatchDetectSentiment

type Rep BatchDetectSentimentResponse Source # 
Instance details

Defined in Amazonka.Comprehend.BatchDetectSentiment

type Rep BatchDetectSentimentResponse = D1 ('MetaData "BatchDetectSentimentResponse" "Amazonka.Comprehend.BatchDetectSentiment" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "BatchDetectSentimentResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: (S1 ('MetaSel ('Just "resultList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [BatchDetectSentimentItemResult]) :*: S1 ('MetaSel ('Just "errorList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [BatchItemError]))))

newBatchDetectSentimentResponse Source #

Create a value of BatchDetectSentimentResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:BatchDetectSentimentResponse', batchDetectSentimentResponse_httpStatus - The response's http status code.

$sel:resultList:BatchDetectSentimentResponse', batchDetectSentimentResponse_resultList - 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.

$sel:errorList:BatchDetectSentimentResponse', batchDetectSentimentResponse_errorList - 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.

DeleteEntityRecognizer

data DeleteEntityRecognizer Source #

See: newDeleteEntityRecognizer smart constructor.

Instances

Instances details
Eq DeleteEntityRecognizer Source # 
Instance details

Defined in Amazonka.Comprehend.DeleteEntityRecognizer

Read DeleteEntityRecognizer Source # 
Instance details

Defined in Amazonka.Comprehend.DeleteEntityRecognizer

Show DeleteEntityRecognizer Source # 
Instance details

Defined in Amazonka.Comprehend.DeleteEntityRecognizer

Generic DeleteEntityRecognizer Source # 
Instance details

Defined in Amazonka.Comprehend.DeleteEntityRecognizer

Associated Types

type Rep DeleteEntityRecognizer :: Type -> Type #

NFData DeleteEntityRecognizer Source # 
Instance details

Defined in Amazonka.Comprehend.DeleteEntityRecognizer

Methods

rnf :: DeleteEntityRecognizer -> () #

Hashable DeleteEntityRecognizer Source # 
Instance details

Defined in Amazonka.Comprehend.DeleteEntityRecognizer

ToJSON DeleteEntityRecognizer Source # 
Instance details

Defined in Amazonka.Comprehend.DeleteEntityRecognizer

AWSRequest DeleteEntityRecognizer Source # 
Instance details

Defined in Amazonka.Comprehend.DeleteEntityRecognizer

Associated Types

type AWSResponse DeleteEntityRecognizer #

ToHeaders DeleteEntityRecognizer Source # 
Instance details

Defined in Amazonka.Comprehend.DeleteEntityRecognizer

ToPath DeleteEntityRecognizer Source # 
Instance details

Defined in Amazonka.Comprehend.DeleteEntityRecognizer

ToQuery DeleteEntityRecognizer Source # 
Instance details

Defined in Amazonka.Comprehend.DeleteEntityRecognizer

type Rep DeleteEntityRecognizer Source # 
Instance details

Defined in Amazonka.Comprehend.DeleteEntityRecognizer

type Rep DeleteEntityRecognizer = D1 ('MetaData "DeleteEntityRecognizer" "Amazonka.Comprehend.DeleteEntityRecognizer" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "DeleteEntityRecognizer'" 'PrefixI 'True) (S1 ('MetaSel ('Just "entityRecognizerArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DeleteEntityRecognizer Source # 
Instance details

Defined in Amazonka.Comprehend.DeleteEntityRecognizer

newDeleteEntityRecognizer Source #

Create a value of DeleteEntityRecognizer with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:entityRecognizerArn:DeleteEntityRecognizer', deleteEntityRecognizer_entityRecognizerArn - The Amazon Resource Name (ARN) that identifies the entity recognizer.

data DeleteEntityRecognizerResponse Source #

See: newDeleteEntityRecognizerResponse smart constructor.

Instances

Instances details
Eq DeleteEntityRecognizerResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DeleteEntityRecognizer

Read DeleteEntityRecognizerResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DeleteEntityRecognizer

Show DeleteEntityRecognizerResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DeleteEntityRecognizer

Generic DeleteEntityRecognizerResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DeleteEntityRecognizer

Associated Types

type Rep DeleteEntityRecognizerResponse :: Type -> Type #

NFData DeleteEntityRecognizerResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DeleteEntityRecognizer

type Rep DeleteEntityRecognizerResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DeleteEntityRecognizer

type Rep DeleteEntityRecognizerResponse = D1 ('MetaData "DeleteEntityRecognizerResponse" "Amazonka.Comprehend.DeleteEntityRecognizer" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "DeleteEntityRecognizerResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDeleteEntityRecognizerResponse Source #

Create a value of DeleteEntityRecognizerResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:DeleteEntityRecognizerResponse', deleteEntityRecognizerResponse_httpStatus - The response's http status code.

DescribeKeyPhrasesDetectionJob

data DescribeKeyPhrasesDetectionJob Source #

See: newDescribeKeyPhrasesDetectionJob smart constructor.

Instances

Instances details
Eq DescribeKeyPhrasesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeKeyPhrasesDetectionJob

Read DescribeKeyPhrasesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeKeyPhrasesDetectionJob

Show DescribeKeyPhrasesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeKeyPhrasesDetectionJob

Generic DescribeKeyPhrasesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeKeyPhrasesDetectionJob

Associated Types

type Rep DescribeKeyPhrasesDetectionJob :: Type -> Type #

NFData DescribeKeyPhrasesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeKeyPhrasesDetectionJob

Hashable DescribeKeyPhrasesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeKeyPhrasesDetectionJob

ToJSON DescribeKeyPhrasesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeKeyPhrasesDetectionJob

AWSRequest DescribeKeyPhrasesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeKeyPhrasesDetectionJob

ToHeaders DescribeKeyPhrasesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeKeyPhrasesDetectionJob

ToPath DescribeKeyPhrasesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeKeyPhrasesDetectionJob

ToQuery DescribeKeyPhrasesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeKeyPhrasesDetectionJob

type Rep DescribeKeyPhrasesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeKeyPhrasesDetectionJob

type Rep DescribeKeyPhrasesDetectionJob = D1 ('MetaData "DescribeKeyPhrasesDetectionJob" "Amazonka.Comprehend.DescribeKeyPhrasesDetectionJob" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "DescribeKeyPhrasesDetectionJob'" 'PrefixI 'True) (S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DescribeKeyPhrasesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeKeyPhrasesDetectionJob

newDescribeKeyPhrasesDetectionJob Source #

Create a value of DescribeKeyPhrasesDetectionJob with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:jobId:DescribeKeyPhrasesDetectionJob', describeKeyPhrasesDetectionJob_jobId - The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.

data DescribeKeyPhrasesDetectionJobResponse Source #

Instances

Instances details
Eq DescribeKeyPhrasesDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeKeyPhrasesDetectionJob

Read DescribeKeyPhrasesDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeKeyPhrasesDetectionJob

Show DescribeKeyPhrasesDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeKeyPhrasesDetectionJob

Generic DescribeKeyPhrasesDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeKeyPhrasesDetectionJob

NFData DescribeKeyPhrasesDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeKeyPhrasesDetectionJob

type Rep DescribeKeyPhrasesDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeKeyPhrasesDetectionJob

type Rep DescribeKeyPhrasesDetectionJobResponse = D1 ('MetaData "DescribeKeyPhrasesDetectionJobResponse" "Amazonka.Comprehend.DescribeKeyPhrasesDetectionJob" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "DescribeKeyPhrasesDetectionJobResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "keyPhrasesDetectionJobProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe KeyPhrasesDetectionJobProperties)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDescribeKeyPhrasesDetectionJobResponse Source #

Create a value of DescribeKeyPhrasesDetectionJobResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:keyPhrasesDetectionJobProperties:DescribeKeyPhrasesDetectionJobResponse', describeKeyPhrasesDetectionJobResponse_keyPhrasesDetectionJobProperties - An object that contains the properties associated with a key phrases detection job.

$sel:httpStatus:DescribeKeyPhrasesDetectionJobResponse', describeKeyPhrasesDetectionJobResponse_httpStatus - The response's http status code.

ListEntitiesDetectionJobs (Paginated)

data ListEntitiesDetectionJobs Source #

See: newListEntitiesDetectionJobs smart constructor.

Instances

Instances details
Eq ListEntitiesDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListEntitiesDetectionJobs

Read ListEntitiesDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListEntitiesDetectionJobs

Show ListEntitiesDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListEntitiesDetectionJobs

Generic ListEntitiesDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListEntitiesDetectionJobs

Associated Types

type Rep ListEntitiesDetectionJobs :: Type -> Type #

NFData ListEntitiesDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListEntitiesDetectionJobs

Hashable ListEntitiesDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListEntitiesDetectionJobs

ToJSON ListEntitiesDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListEntitiesDetectionJobs

AWSPager ListEntitiesDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListEntitiesDetectionJobs

AWSRequest ListEntitiesDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListEntitiesDetectionJobs

ToHeaders ListEntitiesDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListEntitiesDetectionJobs

ToPath ListEntitiesDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListEntitiesDetectionJobs

ToQuery ListEntitiesDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListEntitiesDetectionJobs

type Rep ListEntitiesDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListEntitiesDetectionJobs

type Rep ListEntitiesDetectionJobs = D1 ('MetaData "ListEntitiesDetectionJobs" "Amazonka.Comprehend.ListEntitiesDetectionJobs" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "ListEntitiesDetectionJobs'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "filter'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EntitiesDetectionJobFilter)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))))
type AWSResponse ListEntitiesDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListEntitiesDetectionJobs

newListEntitiesDetectionJobs :: ListEntitiesDetectionJobs Source #

Create a value of ListEntitiesDetectionJobs with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:nextToken:ListEntitiesDetectionJobs', listEntitiesDetectionJobs_nextToken - Identifies the next page of results to return.

$sel:filter':ListEntitiesDetectionJobs', listEntitiesDetectionJobs_filter - 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.

$sel:maxResults:ListEntitiesDetectionJobs', listEntitiesDetectionJobs_maxResults - The maximum number of results to return in each page. The default is 100.

data ListEntitiesDetectionJobsResponse Source #

See: newListEntitiesDetectionJobsResponse smart constructor.

Instances

Instances details
Eq ListEntitiesDetectionJobsResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ListEntitiesDetectionJobs

Read ListEntitiesDetectionJobsResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ListEntitiesDetectionJobs

Show ListEntitiesDetectionJobsResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ListEntitiesDetectionJobs

Generic ListEntitiesDetectionJobsResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ListEntitiesDetectionJobs

Associated Types

type Rep ListEntitiesDetectionJobsResponse :: Type -> Type #

NFData ListEntitiesDetectionJobsResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ListEntitiesDetectionJobs

type Rep ListEntitiesDetectionJobsResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ListEntitiesDetectionJobs

type Rep ListEntitiesDetectionJobsResponse = D1 ('MetaData "ListEntitiesDetectionJobsResponse" "Amazonka.Comprehend.ListEntitiesDetectionJobs" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "ListEntitiesDetectionJobsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "entitiesDetectionJobPropertiesList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [EntitiesDetectionJobProperties])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListEntitiesDetectionJobsResponse Source #

Create a value of ListEntitiesDetectionJobsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:entitiesDetectionJobPropertiesList:ListEntitiesDetectionJobsResponse', listEntitiesDetectionJobsResponse_entitiesDetectionJobPropertiesList - A list containing the properties of each job that is returned.

$sel:nextToken:ListEntitiesDetectionJobs', listEntitiesDetectionJobsResponse_nextToken - Identifies the next page of results to return.

$sel:httpStatus:ListEntitiesDetectionJobsResponse', listEntitiesDetectionJobsResponse_httpStatus - The response's http status code.

CreateEndpoint

data CreateEndpoint Source #

See: newCreateEndpoint smart constructor.

Instances

Instances details
Eq CreateEndpoint Source # 
Instance details

Defined in Amazonka.Comprehend.CreateEndpoint

Read CreateEndpoint Source # 
Instance details

Defined in Amazonka.Comprehend.CreateEndpoint

Show CreateEndpoint Source # 
Instance details

Defined in Amazonka.Comprehend.CreateEndpoint

Generic CreateEndpoint Source # 
Instance details

Defined in Amazonka.Comprehend.CreateEndpoint

Associated Types

type Rep CreateEndpoint :: Type -> Type #

NFData CreateEndpoint Source # 
Instance details

Defined in Amazonka.Comprehend.CreateEndpoint

Methods

rnf :: CreateEndpoint -> () #

Hashable CreateEndpoint Source # 
Instance details

Defined in Amazonka.Comprehend.CreateEndpoint

ToJSON CreateEndpoint Source # 
Instance details

Defined in Amazonka.Comprehend.CreateEndpoint

AWSRequest CreateEndpoint Source # 
Instance details

Defined in Amazonka.Comprehend.CreateEndpoint

Associated Types

type AWSResponse CreateEndpoint #

ToHeaders CreateEndpoint Source # 
Instance details

Defined in Amazonka.Comprehend.CreateEndpoint

ToPath CreateEndpoint Source # 
Instance details

Defined in Amazonka.Comprehend.CreateEndpoint

ToQuery CreateEndpoint Source # 
Instance details

Defined in Amazonka.Comprehend.CreateEndpoint

type Rep CreateEndpoint Source # 
Instance details

Defined in Amazonka.Comprehend.CreateEndpoint

type Rep CreateEndpoint = D1 ('MetaData "CreateEndpoint" "Amazonka.Comprehend.CreateEndpoint" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "CreateEndpoint'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dataAccessRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "clientRequestToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])))) :*: (S1 ('MetaSel ('Just "endpointName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "modelArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "desiredInferenceUnits") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural)))))
type AWSResponse CreateEndpoint Source # 
Instance details

Defined in Amazonka.Comprehend.CreateEndpoint

newCreateEndpoint Source #

Create a value of CreateEndpoint with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:dataAccessRoleArn:CreateEndpoint', createEndpoint_dataAccessRoleArn - The Amazon Resource Name (ARN) of the AWS identity and Access Management (IAM) role that grants Amazon Comprehend read access to trained custom models encrypted with a customer managed key (ModelKmsKeyId).

$sel:clientRequestToken:CreateEndpoint', createEndpoint_clientRequestToken - An idempotency token provided by the customer. If this token matches a previous endpoint creation request, Amazon Comprehend will not return a ResourceInUseException.

$sel:tags:CreateEndpoint', createEndpoint_tags - Tags associated with the endpoint being created. A tag is a key-value pair that adds metadata to the endpoint. For example, a tag with "Sales" as the key might be added to an endpoint to indicate its use by the sales department.

$sel:endpointName:CreateEndpoint', createEndpoint_endpointName - This is the descriptive suffix that becomes part of the EndpointArn used for all subsequent requests to this resource.

$sel:modelArn:CreateEndpoint', createEndpoint_modelArn - The Amazon Resource Number (ARN) of the model to which the endpoint will be attached.

$sel:desiredInferenceUnits:CreateEndpoint', createEndpoint_desiredInferenceUnits - 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.

data CreateEndpointResponse Source #

See: newCreateEndpointResponse smart constructor.

Instances

Instances details
Eq CreateEndpointResponse Source # 
Instance details

Defined in Amazonka.Comprehend.CreateEndpoint

Read CreateEndpointResponse Source # 
Instance details

Defined in Amazonka.Comprehend.CreateEndpoint

Show CreateEndpointResponse Source # 
Instance details

Defined in Amazonka.Comprehend.CreateEndpoint

Generic CreateEndpointResponse Source # 
Instance details

Defined in Amazonka.Comprehend.CreateEndpoint

Associated Types

type Rep CreateEndpointResponse :: Type -> Type #

NFData CreateEndpointResponse Source # 
Instance details

Defined in Amazonka.Comprehend.CreateEndpoint

Methods

rnf :: CreateEndpointResponse -> () #

type Rep CreateEndpointResponse Source # 
Instance details

Defined in Amazonka.Comprehend.CreateEndpoint

type Rep CreateEndpointResponse = D1 ('MetaData "CreateEndpointResponse" "Amazonka.Comprehend.CreateEndpoint" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "CreateEndpointResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "endpointArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateEndpointResponse Source #

Create a value of CreateEndpointResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:endpointArn:CreateEndpointResponse', createEndpointResponse_endpointArn - The Amazon Resource Number (ARN) of the endpoint being created.

$sel:httpStatus:CreateEndpointResponse', createEndpointResponse_httpStatus - The response's http status code.

StopEventsDetectionJob

data StopEventsDetectionJob Source #

See: newStopEventsDetectionJob smart constructor.

Instances

Instances details
Eq StopEventsDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopEventsDetectionJob

Read StopEventsDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopEventsDetectionJob

Show StopEventsDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopEventsDetectionJob

Generic StopEventsDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopEventsDetectionJob

Associated Types

type Rep StopEventsDetectionJob :: Type -> Type #

NFData StopEventsDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopEventsDetectionJob

Methods

rnf :: StopEventsDetectionJob -> () #

Hashable StopEventsDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopEventsDetectionJob

ToJSON StopEventsDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopEventsDetectionJob

AWSRequest StopEventsDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopEventsDetectionJob

Associated Types

type AWSResponse StopEventsDetectionJob #

ToHeaders StopEventsDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopEventsDetectionJob

ToPath StopEventsDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopEventsDetectionJob

ToQuery StopEventsDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopEventsDetectionJob

type Rep StopEventsDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopEventsDetectionJob

type Rep StopEventsDetectionJob = D1 ('MetaData "StopEventsDetectionJob" "Amazonka.Comprehend.StopEventsDetectionJob" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "StopEventsDetectionJob'" 'PrefixI 'True) (S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse StopEventsDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopEventsDetectionJob

newStopEventsDetectionJob Source #

Create a value of StopEventsDetectionJob with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:jobId:StopEventsDetectionJob', stopEventsDetectionJob_jobId - The identifier of the events detection job to stop.

data StopEventsDetectionJobResponse Source #

See: newStopEventsDetectionJobResponse smart constructor.

Instances

Instances details
Eq StopEventsDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StopEventsDetectionJob

Read StopEventsDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StopEventsDetectionJob

Show StopEventsDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StopEventsDetectionJob

Generic StopEventsDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StopEventsDetectionJob

Associated Types

type Rep StopEventsDetectionJobResponse :: Type -> Type #

NFData StopEventsDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StopEventsDetectionJob

type Rep StopEventsDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StopEventsDetectionJob

type Rep StopEventsDetectionJobResponse = D1 ('MetaData "StopEventsDetectionJobResponse" "Amazonka.Comprehend.StopEventsDetectionJob" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "StopEventsDetectionJobResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "jobStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobStatus)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newStopEventsDetectionJobResponse Source #

Create a value of StopEventsDetectionJobResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:jobId:StopEventsDetectionJob', stopEventsDetectionJobResponse_jobId - The identifier of the events detection job to stop.

$sel:jobStatus:StopEventsDetectionJobResponse', stopEventsDetectionJobResponse_jobStatus - The status of the events detection job.

$sel:httpStatus:StopEventsDetectionJobResponse', stopEventsDetectionJobResponse_httpStatus - The response's http status code.

StartSentimentDetectionJob

data StartSentimentDetectionJob Source #

See: newStartSentimentDetectionJob smart constructor.

Instances

Instances details
Eq StartSentimentDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartSentimentDetectionJob

Read StartSentimentDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartSentimentDetectionJob

Show StartSentimentDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartSentimentDetectionJob

Generic StartSentimentDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartSentimentDetectionJob

Associated Types

type Rep StartSentimentDetectionJob :: Type -> Type #

NFData StartSentimentDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartSentimentDetectionJob

Hashable StartSentimentDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartSentimentDetectionJob

ToJSON StartSentimentDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartSentimentDetectionJob

AWSRequest StartSentimentDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartSentimentDetectionJob

ToHeaders StartSentimentDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartSentimentDetectionJob

ToPath StartSentimentDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartSentimentDetectionJob

ToQuery StartSentimentDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartSentimentDetectionJob

type Rep StartSentimentDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartSentimentDetectionJob

type Rep StartSentimentDetectionJob = D1 ('MetaData "StartSentimentDetectionJob" "Amazonka.Comprehend.StartSentimentDetectionJob" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "StartSentimentDetectionJob'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "jobName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "vpcConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VpcConfig))) :*: (S1 ('MetaSel ('Just "volumeKmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "clientRequestToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :*: S1 ('MetaSel ('Just "inputDataConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 InputDataConfig)) :*: (S1 ('MetaSel ('Just "outputDataConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 OutputDataConfig) :*: (S1 ('MetaSel ('Just "dataAccessRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "languageCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 LanguageCode))))))
type AWSResponse StartSentimentDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartSentimentDetectionJob

newStartSentimentDetectionJob Source #

Create a value of StartSentimentDetectionJob with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:jobName:StartSentimentDetectionJob', startSentimentDetectionJob_jobName - The identifier of the job.

$sel:vpcConfig:StartSentimentDetectionJob', startSentimentDetectionJob_vpcConfig - 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.

$sel:volumeKmsKeyId:StartSentimentDetectionJob', startSentimentDetectionJob_volumeKmsKeyId - ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:

  • KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
  • Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

$sel:clientRequestToken:StartSentimentDetectionJob', startSentimentDetectionJob_clientRequestToken - A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

$sel:tags:StartSentimentDetectionJob', startSentimentDetectionJob_tags - Tags to be associated with the sentiment detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.

$sel:inputDataConfig:StartSentimentDetectionJob', startSentimentDetectionJob_inputDataConfig - Specifies the format and location of the input data for the job.

$sel:outputDataConfig:StartSentimentDetectionJob', startSentimentDetectionJob_outputDataConfig - Specifies where to send the output files.

$sel:dataAccessRoleArn:StartSentimentDetectionJob', startSentimentDetectionJob_dataAccessRoleArn - The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions.

$sel:languageCode:StartSentimentDetectionJob', startSentimentDetectionJob_languageCode - The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.

data StartSentimentDetectionJobResponse Source #

Instances

Instances details
Eq StartSentimentDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StartSentimentDetectionJob

Read StartSentimentDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StartSentimentDetectionJob

Show StartSentimentDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StartSentimentDetectionJob

Generic StartSentimentDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StartSentimentDetectionJob

Associated Types

type Rep StartSentimentDetectionJobResponse :: Type -> Type #

NFData StartSentimentDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StartSentimentDetectionJob

type Rep StartSentimentDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StartSentimentDetectionJob

type Rep StartSentimentDetectionJobResponse = D1 ('MetaData "StartSentimentDetectionJobResponse" "Amazonka.Comprehend.StartSentimentDetectionJob" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "StartSentimentDetectionJobResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "jobArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "jobStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobStatus)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newStartSentimentDetectionJobResponse Source #

Create a value of StartSentimentDetectionJobResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:jobId:StartSentimentDetectionJobResponse', startSentimentDetectionJobResponse_jobId - The identifier generated for the job. To get the status of a job, use this identifier with the operation.

$sel:jobArn:StartSentimentDetectionJobResponse', startSentimentDetectionJobResponse_jobArn - The Amazon Resource Name (ARN) of the sentiment detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:

arn:<partition>:comprehend:<region>:<account-id>:sentiment-detection-job/<job-id>

The following is an example job ARN:

arn:aws:comprehend:us-west-2:111122223333:sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab

$sel:jobStatus:StartSentimentDetectionJobResponse', startSentimentDetectionJobResponse_jobStatus - The status of the job.

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

$sel:httpStatus:StartSentimentDetectionJobResponse', startSentimentDetectionJobResponse_httpStatus - The response's http status code.

BatchDetectSyntax

data BatchDetectSyntax Source #

See: newBatchDetectSyntax smart constructor.

Instances

Instances details
Eq BatchDetectSyntax Source # 
Instance details

Defined in Amazonka.Comprehend.BatchDetectSyntax

Show BatchDetectSyntax Source # 
Instance details

Defined in Amazonka.Comprehend.BatchDetectSyntax

Generic BatchDetectSyntax Source # 
Instance details

Defined in Amazonka.Comprehend.BatchDetectSyntax

Associated Types

type Rep BatchDetectSyntax :: Type -> Type #

NFData BatchDetectSyntax Source # 
Instance details

Defined in Amazonka.Comprehend.BatchDetectSyntax

Methods

rnf :: BatchDetectSyntax -> () #

Hashable BatchDetectSyntax Source # 
Instance details

Defined in Amazonka.Comprehend.BatchDetectSyntax

ToJSON BatchDetectSyntax Source # 
Instance details

Defined in Amazonka.Comprehend.BatchDetectSyntax

AWSRequest BatchDetectSyntax Source # 
Instance details

Defined in Amazonka.Comprehend.BatchDetectSyntax

Associated Types

type AWSResponse BatchDetectSyntax #

ToHeaders BatchDetectSyntax Source # 
Instance details

Defined in Amazonka.Comprehend.BatchDetectSyntax

ToPath BatchDetectSyntax Source # 
Instance details

Defined in Amazonka.Comprehend.BatchDetectSyntax

ToQuery BatchDetectSyntax Source # 
Instance details

Defined in Amazonka.Comprehend.BatchDetectSyntax

type Rep BatchDetectSyntax Source # 
Instance details

Defined in Amazonka.Comprehend.BatchDetectSyntax

type Rep BatchDetectSyntax = D1 ('MetaData "BatchDetectSyntax" "Amazonka.Comprehend.BatchDetectSyntax" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "BatchDetectSyntax'" 'PrefixI 'True) (S1 ('MetaSel ('Just "textList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive [Sensitive Text])) :*: S1 ('MetaSel ('Just "languageCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SyntaxLanguageCode)))
type AWSResponse BatchDetectSyntax Source # 
Instance details

Defined in Amazonka.Comprehend.BatchDetectSyntax

newBatchDetectSyntax Source #

Create a value of BatchDetectSyntax with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:textList:BatchDetectSyntax', batchDetectSyntax_textList - A list containing the text of the input documents. The list can contain a maximum of 25 documents. Each document must contain fewer that 5,000 bytes of UTF-8 encoded characters.

$sel:languageCode:BatchDetectSyntax', batchDetectSyntax_languageCode - The language of the input documents. You can specify any of the following languages supported by Amazon Comprehend: German ("de"), English ("en"), Spanish ("es"), French ("fr"), Italian ("it"), or Portuguese ("pt"). All documents must be in the same language.

data BatchDetectSyntaxResponse Source #

See: newBatchDetectSyntaxResponse smart constructor.

Instances

Instances details
Eq BatchDetectSyntaxResponse Source # 
Instance details

Defined in Amazonka.Comprehend.BatchDetectSyntax

Show BatchDetectSyntaxResponse Source # 
Instance details

Defined in Amazonka.Comprehend.BatchDetectSyntax

Generic BatchDetectSyntaxResponse Source # 
Instance details

Defined in Amazonka.Comprehend.BatchDetectSyntax

Associated Types

type Rep BatchDetectSyntaxResponse :: Type -> Type #

NFData BatchDetectSyntaxResponse Source # 
Instance details

Defined in Amazonka.Comprehend.BatchDetectSyntax

type Rep BatchDetectSyntaxResponse Source # 
Instance details

Defined in Amazonka.Comprehend.BatchDetectSyntax

type Rep BatchDetectSyntaxResponse = D1 ('MetaData "BatchDetectSyntaxResponse" "Amazonka.Comprehend.BatchDetectSyntax" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "BatchDetectSyntaxResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: (S1 ('MetaSel ('Just "resultList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [BatchDetectSyntaxItemResult]) :*: S1 ('MetaSel ('Just "errorList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [BatchItemError]))))

newBatchDetectSyntaxResponse Source #

Create a value of BatchDetectSyntaxResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:BatchDetectSyntaxResponse', batchDetectSyntaxResponse_httpStatus - The response's http status code.

$sel:resultList:BatchDetectSyntaxResponse', batchDetectSyntaxResponse_resultList - 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.

$sel:errorList:BatchDetectSyntaxResponse', batchDetectSyntaxResponse_errorList - 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.

StartTopicsDetectionJob

data StartTopicsDetectionJob Source #

See: newStartTopicsDetectionJob smart constructor.

Instances

Instances details
Eq StartTopicsDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartTopicsDetectionJob

Read StartTopicsDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartTopicsDetectionJob

Show StartTopicsDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartTopicsDetectionJob

Generic StartTopicsDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartTopicsDetectionJob

Associated Types

type Rep StartTopicsDetectionJob :: Type -> Type #

NFData StartTopicsDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartTopicsDetectionJob

Methods

rnf :: StartTopicsDetectionJob -> () #

Hashable StartTopicsDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartTopicsDetectionJob

ToJSON StartTopicsDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartTopicsDetectionJob

AWSRequest StartTopicsDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartTopicsDetectionJob

ToHeaders StartTopicsDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartTopicsDetectionJob

ToPath StartTopicsDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartTopicsDetectionJob

ToQuery StartTopicsDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartTopicsDetectionJob

type Rep StartTopicsDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartTopicsDetectionJob

type Rep StartTopicsDetectionJob = D1 ('MetaData "StartTopicsDetectionJob" "Amazonka.Comprehend.StartTopicsDetectionJob" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "StartTopicsDetectionJob'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "jobName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "vpcConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VpcConfig))) :*: (S1 ('MetaSel ('Just "volumeKmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "numberOfTopics") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))) :*: ((S1 ('MetaSel ('Just "clientRequestToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag]))) :*: (S1 ('MetaSel ('Just "inputDataConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 InputDataConfig) :*: (S1 ('MetaSel ('Just "outputDataConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 OutputDataConfig) :*: S1 ('MetaSel ('Just "dataAccessRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))
type AWSResponse StartTopicsDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartTopicsDetectionJob

newStartTopicsDetectionJob Source #

Create a value of StartTopicsDetectionJob with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:jobName:StartTopicsDetectionJob', startTopicsDetectionJob_jobName - The identifier of the job.

$sel:vpcConfig:StartTopicsDetectionJob', startTopicsDetectionJob_vpcConfig - Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your topic detection job. For more information, see Amazon VPC.

$sel:volumeKmsKeyId:StartTopicsDetectionJob', startTopicsDetectionJob_volumeKmsKeyId - ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:

  • KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
  • Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

$sel:numberOfTopics:StartTopicsDetectionJob', startTopicsDetectionJob_numberOfTopics - The number of topics to detect.

$sel:clientRequestToken:StartTopicsDetectionJob', startTopicsDetectionJob_clientRequestToken - A unique identifier for the request. If you do not set the client request token, Amazon Comprehend generates one.

$sel:tags:StartTopicsDetectionJob', startTopicsDetectionJob_tags - Tags to be associated with the topics detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.

$sel:inputDataConfig:StartTopicsDetectionJob', startTopicsDetectionJob_inputDataConfig - Specifies the format and location of the input data for the job.

$sel:outputDataConfig:StartTopicsDetectionJob', startTopicsDetectionJob_outputDataConfig - 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

$sel:dataAccessRoleArn:StartTopicsDetectionJob', startTopicsDetectionJob_dataAccessRoleArn - The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions.

data StartTopicsDetectionJobResponse Source #

See: newStartTopicsDetectionJobResponse smart constructor.

Instances

Instances details
Eq StartTopicsDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StartTopicsDetectionJob

Read StartTopicsDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StartTopicsDetectionJob

Show StartTopicsDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StartTopicsDetectionJob

Generic StartTopicsDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StartTopicsDetectionJob

Associated Types

type Rep StartTopicsDetectionJobResponse :: Type -> Type #

NFData StartTopicsDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StartTopicsDetectionJob

type Rep StartTopicsDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StartTopicsDetectionJob

type Rep StartTopicsDetectionJobResponse = D1 ('MetaData "StartTopicsDetectionJobResponse" "Amazonka.Comprehend.StartTopicsDetectionJob" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "StartTopicsDetectionJobResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "jobArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "jobStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobStatus)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newStartTopicsDetectionJobResponse Source #

Create a value of StartTopicsDetectionJobResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:jobId:StartTopicsDetectionJobResponse', startTopicsDetectionJobResponse_jobId - The identifier generated for the job. To get the status of the job, use this identifier with the DescribeTopicDetectionJob operation.

$sel:jobArn:StartTopicsDetectionJobResponse', startTopicsDetectionJobResponse_jobArn - The Amazon Resource Name (ARN) of the topics detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:

arn:<partition>:comprehend:<region>:<account-id>:topics-detection-job/<job-id>

The following is an example job ARN:

arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab

$sel:jobStatus:StartTopicsDetectionJobResponse', startTopicsDetectionJobResponse_jobStatus - The status of the job:

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

$sel:httpStatus:StartTopicsDetectionJobResponse', startTopicsDetectionJobResponse_httpStatus - The response's http status code.

DescribeEventsDetectionJob

data DescribeEventsDetectionJob Source #

See: newDescribeEventsDetectionJob smart constructor.

Instances

Instances details
Eq DescribeEventsDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeEventsDetectionJob

Read DescribeEventsDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeEventsDetectionJob

Show DescribeEventsDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeEventsDetectionJob

Generic DescribeEventsDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeEventsDetectionJob

Associated Types

type Rep DescribeEventsDetectionJob :: Type -> Type #

NFData DescribeEventsDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeEventsDetectionJob

Hashable DescribeEventsDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeEventsDetectionJob

ToJSON DescribeEventsDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeEventsDetectionJob

AWSRequest DescribeEventsDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeEventsDetectionJob

ToHeaders DescribeEventsDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeEventsDetectionJob

ToPath DescribeEventsDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeEventsDetectionJob

ToQuery DescribeEventsDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeEventsDetectionJob

type Rep DescribeEventsDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeEventsDetectionJob

type Rep DescribeEventsDetectionJob = D1 ('MetaData "DescribeEventsDetectionJob" "Amazonka.Comprehend.DescribeEventsDetectionJob" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "DescribeEventsDetectionJob'" 'PrefixI 'True) (S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DescribeEventsDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeEventsDetectionJob

newDescribeEventsDetectionJob Source #

Create a value of DescribeEventsDetectionJob with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:jobId:DescribeEventsDetectionJob', describeEventsDetectionJob_jobId - The identifier of the events detection job.

data DescribeEventsDetectionJobResponse Source #

Instances

Instances details
Eq DescribeEventsDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeEventsDetectionJob

Read DescribeEventsDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeEventsDetectionJob

Show DescribeEventsDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeEventsDetectionJob

Generic DescribeEventsDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeEventsDetectionJob

Associated Types

type Rep DescribeEventsDetectionJobResponse :: Type -> Type #

NFData DescribeEventsDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeEventsDetectionJob

type Rep DescribeEventsDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeEventsDetectionJob

type Rep DescribeEventsDetectionJobResponse = D1 ('MetaData "DescribeEventsDetectionJobResponse" "Amazonka.Comprehend.DescribeEventsDetectionJob" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "DescribeEventsDetectionJobResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "eventsDetectionJobProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EventsDetectionJobProperties)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDescribeEventsDetectionJobResponse Source #

Create a value of DescribeEventsDetectionJobResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:eventsDetectionJobProperties:DescribeEventsDetectionJobResponse', describeEventsDetectionJobResponse_eventsDetectionJobProperties - An object that contains the properties associated with an event detection job.

$sel:httpStatus:DescribeEventsDetectionJobResponse', describeEventsDetectionJobResponse_httpStatus - The response's http status code.

DeleteEndpoint

data DeleteEndpoint Source #

See: newDeleteEndpoint smart constructor.

Constructors

DeleteEndpoint' Text 

Instances

Instances details
Eq DeleteEndpoint Source # 
Instance details

Defined in Amazonka.Comprehend.DeleteEndpoint

Read DeleteEndpoint Source # 
Instance details

Defined in Amazonka.Comprehend.DeleteEndpoint

Show DeleteEndpoint Source # 
Instance details

Defined in Amazonka.Comprehend.DeleteEndpoint

Generic DeleteEndpoint Source # 
Instance details

Defined in Amazonka.Comprehend.DeleteEndpoint

Associated Types

type Rep DeleteEndpoint :: Type -> Type #

NFData DeleteEndpoint Source # 
Instance details

Defined in Amazonka.Comprehend.DeleteEndpoint

Methods

rnf :: DeleteEndpoint -> () #

Hashable DeleteEndpoint Source # 
Instance details

Defined in Amazonka.Comprehend.DeleteEndpoint

ToJSON DeleteEndpoint Source # 
Instance details

Defined in Amazonka.Comprehend.DeleteEndpoint

AWSRequest DeleteEndpoint Source # 
Instance details

Defined in Amazonka.Comprehend.DeleteEndpoint

Associated Types

type AWSResponse DeleteEndpoint #

ToHeaders DeleteEndpoint Source # 
Instance details

Defined in Amazonka.Comprehend.DeleteEndpoint

ToPath DeleteEndpoint Source # 
Instance details

Defined in Amazonka.Comprehend.DeleteEndpoint

ToQuery DeleteEndpoint Source # 
Instance details

Defined in Amazonka.Comprehend.DeleteEndpoint

type Rep DeleteEndpoint Source # 
Instance details

Defined in Amazonka.Comprehend.DeleteEndpoint

type Rep DeleteEndpoint = D1 ('MetaData "DeleteEndpoint" "Amazonka.Comprehend.DeleteEndpoint" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "DeleteEndpoint'" 'PrefixI 'True) (S1 ('MetaSel ('Just "endpointArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DeleteEndpoint Source # 
Instance details

Defined in Amazonka.Comprehend.DeleteEndpoint

newDeleteEndpoint Source #

Create a value of DeleteEndpoint with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:endpointArn:DeleteEndpoint', deleteEndpoint_endpointArn - The Amazon Resource Number (ARN) of the endpoint being deleted.

data DeleteEndpointResponse Source #

See: newDeleteEndpointResponse smart constructor.

Instances

Instances details
Eq DeleteEndpointResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DeleteEndpoint

Read DeleteEndpointResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DeleteEndpoint

Show DeleteEndpointResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DeleteEndpoint

Generic DeleteEndpointResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DeleteEndpoint

Associated Types

type Rep DeleteEndpointResponse :: Type -> Type #

NFData DeleteEndpointResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DeleteEndpoint

Methods

rnf :: DeleteEndpointResponse -> () #

type Rep DeleteEndpointResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DeleteEndpoint

type Rep DeleteEndpointResponse = D1 ('MetaData "DeleteEndpointResponse" "Amazonka.Comprehend.DeleteEndpoint" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "DeleteEndpointResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDeleteEndpointResponse Source #

Create a value of DeleteEndpointResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:DeleteEndpointResponse', deleteEndpointResponse_httpStatus - The response's http status code.

UpdateEndpoint

data UpdateEndpoint Source #

See: newUpdateEndpoint smart constructor.

Instances

Instances details
Eq UpdateEndpoint Source # 
Instance details

Defined in Amazonka.Comprehend.UpdateEndpoint

Read UpdateEndpoint Source # 
Instance details

Defined in Amazonka.Comprehend.UpdateEndpoint

Show UpdateEndpoint Source # 
Instance details

Defined in Amazonka.Comprehend.UpdateEndpoint

Generic UpdateEndpoint Source # 
Instance details

Defined in Amazonka.Comprehend.UpdateEndpoint

Associated Types

type Rep UpdateEndpoint :: Type -> Type #

NFData UpdateEndpoint Source # 
Instance details

Defined in Amazonka.Comprehend.UpdateEndpoint

Methods

rnf :: UpdateEndpoint -> () #

Hashable UpdateEndpoint Source # 
Instance details

Defined in Amazonka.Comprehend.UpdateEndpoint

ToJSON UpdateEndpoint Source # 
Instance details

Defined in Amazonka.Comprehend.UpdateEndpoint

AWSRequest UpdateEndpoint Source # 
Instance details

Defined in Amazonka.Comprehend.UpdateEndpoint

Associated Types

type AWSResponse UpdateEndpoint #

ToHeaders UpdateEndpoint Source # 
Instance details

Defined in Amazonka.Comprehend.UpdateEndpoint

ToPath UpdateEndpoint Source # 
Instance details

Defined in Amazonka.Comprehend.UpdateEndpoint

ToQuery UpdateEndpoint Source # 
Instance details

Defined in Amazonka.Comprehend.UpdateEndpoint

type Rep UpdateEndpoint Source # 
Instance details

Defined in Amazonka.Comprehend.UpdateEndpoint

type Rep UpdateEndpoint = D1 ('MetaData "UpdateEndpoint" "Amazonka.Comprehend.UpdateEndpoint" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "UpdateEndpoint'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "desiredModelArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "desiredInferenceUnits") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :*: (S1 ('MetaSel ('Just "desiredDataAccessRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "endpointArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse UpdateEndpoint Source # 
Instance details

Defined in Amazonka.Comprehend.UpdateEndpoint

newUpdateEndpoint Source #

Create a value of UpdateEndpoint with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:desiredModelArn:UpdateEndpoint', updateEndpoint_desiredModelArn - The ARN of the new model to use when updating an existing endpoint.

$sel:desiredInferenceUnits:UpdateEndpoint', updateEndpoint_desiredInferenceUnits - 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.

$sel:desiredDataAccessRoleArn:UpdateEndpoint', updateEndpoint_desiredDataAccessRoleArn - Data access role ARN to use in case the new model is encrypted with a customer CMK.

$sel:endpointArn:UpdateEndpoint', updateEndpoint_endpointArn - The Amazon Resource Number (ARN) of the endpoint being updated.

data UpdateEndpointResponse Source #

See: newUpdateEndpointResponse smart constructor.

Instances

Instances details
Eq UpdateEndpointResponse Source # 
Instance details

Defined in Amazonka.Comprehend.UpdateEndpoint

Read UpdateEndpointResponse Source # 
Instance details

Defined in Amazonka.Comprehend.UpdateEndpoint

Show UpdateEndpointResponse Source # 
Instance details

Defined in Amazonka.Comprehend.UpdateEndpoint

Generic UpdateEndpointResponse Source # 
Instance details

Defined in Amazonka.Comprehend.UpdateEndpoint

Associated Types

type Rep UpdateEndpointResponse :: Type -> Type #

NFData UpdateEndpointResponse Source # 
Instance details

Defined in Amazonka.Comprehend.UpdateEndpoint

Methods

rnf :: UpdateEndpointResponse -> () #

type Rep UpdateEndpointResponse Source # 
Instance details

Defined in Amazonka.Comprehend.UpdateEndpoint

type Rep UpdateEndpointResponse = D1 ('MetaData "UpdateEndpointResponse" "Amazonka.Comprehend.UpdateEndpoint" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "UpdateEndpointResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newUpdateEndpointResponse Source #

Create a value of UpdateEndpointResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:UpdateEndpointResponse', updateEndpointResponse_httpStatus - The response's http status code.

ListTagsForResource

data ListTagsForResource Source #

See: newListTagsForResource smart constructor.

Instances

Instances details
Eq ListTagsForResource Source # 
Instance details

Defined in Amazonka.Comprehend.ListTagsForResource

Read ListTagsForResource Source # 
Instance details

Defined in Amazonka.Comprehend.ListTagsForResource

Show ListTagsForResource Source # 
Instance details

Defined in Amazonka.Comprehend.ListTagsForResource

Generic ListTagsForResource Source # 
Instance details

Defined in Amazonka.Comprehend.ListTagsForResource

Associated Types

type Rep ListTagsForResource :: Type -> Type #

NFData ListTagsForResource Source # 
Instance details

Defined in Amazonka.Comprehend.ListTagsForResource

Methods

rnf :: ListTagsForResource -> () #

Hashable ListTagsForResource Source # 
Instance details

Defined in Amazonka.Comprehend.ListTagsForResource

ToJSON ListTagsForResource Source # 
Instance details

Defined in Amazonka.Comprehend.ListTagsForResource

AWSRequest ListTagsForResource Source # 
Instance details

Defined in Amazonka.Comprehend.ListTagsForResource

Associated Types

type AWSResponse ListTagsForResource #

ToHeaders ListTagsForResource Source # 
Instance details

Defined in Amazonka.Comprehend.ListTagsForResource

ToPath ListTagsForResource Source # 
Instance details

Defined in Amazonka.Comprehend.ListTagsForResource

ToQuery ListTagsForResource Source # 
Instance details

Defined in Amazonka.Comprehend.ListTagsForResource

type Rep ListTagsForResource Source # 
Instance details

Defined in Amazonka.Comprehend.ListTagsForResource

type Rep ListTagsForResource = D1 ('MetaData "ListTagsForResource" "Amazonka.Comprehend.ListTagsForResource" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "ListTagsForResource'" 'PrefixI 'True) (S1 ('MetaSel ('Just "resourceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse ListTagsForResource Source # 
Instance details

Defined in Amazonka.Comprehend.ListTagsForResource

newListTagsForResource Source #

Create a value of ListTagsForResource with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:resourceArn:ListTagsForResource', listTagsForResource_resourceArn - The Amazon Resource Name (ARN) of the given Amazon Comprehend resource you are querying.

data ListTagsForResourceResponse Source #

See: newListTagsForResourceResponse smart constructor.

Instances

Instances details
Eq ListTagsForResourceResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ListTagsForResource

Read ListTagsForResourceResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ListTagsForResource

Show ListTagsForResourceResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ListTagsForResource

Generic ListTagsForResourceResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ListTagsForResource

Associated Types

type Rep ListTagsForResourceResponse :: Type -> Type #

NFData ListTagsForResourceResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ListTagsForResource

type Rep ListTagsForResourceResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ListTagsForResource

type Rep ListTagsForResourceResponse = D1 ('MetaData "ListTagsForResourceResponse" "Amazonka.Comprehend.ListTagsForResource" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "ListTagsForResourceResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "resourceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListTagsForResourceResponse Source #

Create a value of ListTagsForResourceResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:resourceArn:ListTagsForResource', listTagsForResourceResponse_resourceArn - The Amazon Resource Name (ARN) of the given Amazon Comprehend resource you are querying.

$sel:tags:ListTagsForResourceResponse', listTagsForResourceResponse_tags - Tags associated with the Amazon Comprehend resource being queried. A tag is a key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.

$sel:httpStatus:ListTagsForResourceResponse', listTagsForResourceResponse_httpStatus - The response's http status code.

BatchDetectKeyPhrases

data BatchDetectKeyPhrases Source #

See: newBatchDetectKeyPhrases smart constructor.

Instances

Instances details
Eq BatchDetectKeyPhrases Source # 
Instance details

Defined in Amazonka.Comprehend.BatchDetectKeyPhrases

Show BatchDetectKeyPhrases Source # 
Instance details

Defined in Amazonka.Comprehend.BatchDetectKeyPhrases

Generic BatchDetectKeyPhrases Source # 
Instance details

Defined in Amazonka.Comprehend.BatchDetectKeyPhrases

Associated Types

type Rep BatchDetectKeyPhrases :: Type -> Type #

NFData BatchDetectKeyPhrases Source # 
Instance details

Defined in Amazonka.Comprehend.BatchDetectKeyPhrases

Methods

rnf :: BatchDetectKeyPhrases -> () #

Hashable BatchDetectKeyPhrases Source # 
Instance details

Defined in Amazonka.Comprehend.BatchDetectKeyPhrases

ToJSON BatchDetectKeyPhrases Source # 
Instance details

Defined in Amazonka.Comprehend.BatchDetectKeyPhrases

AWSRequest BatchDetectKeyPhrases Source # 
Instance details

Defined in Amazonka.Comprehend.BatchDetectKeyPhrases

Associated Types

type AWSResponse BatchDetectKeyPhrases #

ToHeaders BatchDetectKeyPhrases Source # 
Instance details

Defined in Amazonka.Comprehend.BatchDetectKeyPhrases

ToPath BatchDetectKeyPhrases Source # 
Instance details

Defined in Amazonka.Comprehend.BatchDetectKeyPhrases

ToQuery BatchDetectKeyPhrases Source # 
Instance details

Defined in Amazonka.Comprehend.BatchDetectKeyPhrases

type Rep BatchDetectKeyPhrases Source # 
Instance details

Defined in Amazonka.Comprehend.BatchDetectKeyPhrases

type Rep BatchDetectKeyPhrases = D1 ('MetaData "BatchDetectKeyPhrases" "Amazonka.Comprehend.BatchDetectKeyPhrases" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "BatchDetectKeyPhrases'" 'PrefixI 'True) (S1 ('MetaSel ('Just "textList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive [Sensitive Text])) :*: S1 ('MetaSel ('Just "languageCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 LanguageCode)))
type AWSResponse BatchDetectKeyPhrases Source # 
Instance details

Defined in Amazonka.Comprehend.BatchDetectKeyPhrases

newBatchDetectKeyPhrases Source #

Create a value of BatchDetectKeyPhrases with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:textList:BatchDetectKeyPhrases', batchDetectKeyPhrases_textList - A list containing the text of the input documents. The list can contain a maximum of 25 documents. Each document must contain fewer that 5,000 bytes of UTF-8 encoded characters.

$sel:languageCode:BatchDetectKeyPhrases', batchDetectKeyPhrases_languageCode - The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.

data BatchDetectKeyPhrasesResponse Source #

See: newBatchDetectKeyPhrasesResponse smart constructor.

Instances

Instances details
Eq BatchDetectKeyPhrasesResponse Source # 
Instance details

Defined in Amazonka.Comprehend.BatchDetectKeyPhrases

Show BatchDetectKeyPhrasesResponse Source # 
Instance details

Defined in Amazonka.Comprehend.BatchDetectKeyPhrases

Generic BatchDetectKeyPhrasesResponse Source # 
Instance details

Defined in Amazonka.Comprehend.BatchDetectKeyPhrases

Associated Types

type Rep BatchDetectKeyPhrasesResponse :: Type -> Type #

NFData BatchDetectKeyPhrasesResponse Source # 
Instance details

Defined in Amazonka.Comprehend.BatchDetectKeyPhrases

type Rep BatchDetectKeyPhrasesResponse Source # 
Instance details

Defined in Amazonka.Comprehend.BatchDetectKeyPhrases

type Rep BatchDetectKeyPhrasesResponse = D1 ('MetaData "BatchDetectKeyPhrasesResponse" "Amazonka.Comprehend.BatchDetectKeyPhrases" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "BatchDetectKeyPhrasesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: (S1 ('MetaSel ('Just "resultList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [BatchDetectKeyPhrasesItemResult]) :*: S1 ('MetaSel ('Just "errorList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [BatchItemError]))))

newBatchDetectKeyPhrasesResponse Source #

Create a value of BatchDetectKeyPhrasesResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:BatchDetectKeyPhrasesResponse', batchDetectKeyPhrasesResponse_httpStatus - The response's http status code.

$sel:resultList:BatchDetectKeyPhrasesResponse', batchDetectKeyPhrasesResponse_resultList - 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.

$sel:errorList:BatchDetectKeyPhrasesResponse', batchDetectKeyPhrasesResponse_errorList - 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.

DescribeSentimentDetectionJob

data DescribeSentimentDetectionJob Source #

See: newDescribeSentimentDetectionJob smart constructor.

Instances

Instances details
Eq DescribeSentimentDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeSentimentDetectionJob

Read DescribeSentimentDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeSentimentDetectionJob

Show DescribeSentimentDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeSentimentDetectionJob

Generic DescribeSentimentDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeSentimentDetectionJob

Associated Types

type Rep DescribeSentimentDetectionJob :: Type -> Type #

NFData DescribeSentimentDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeSentimentDetectionJob

Hashable DescribeSentimentDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeSentimentDetectionJob

ToJSON DescribeSentimentDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeSentimentDetectionJob

AWSRequest DescribeSentimentDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeSentimentDetectionJob

ToHeaders DescribeSentimentDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeSentimentDetectionJob

ToPath DescribeSentimentDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeSentimentDetectionJob

ToQuery DescribeSentimentDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeSentimentDetectionJob

type Rep DescribeSentimentDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeSentimentDetectionJob

type Rep DescribeSentimentDetectionJob = D1 ('MetaData "DescribeSentimentDetectionJob" "Amazonka.Comprehend.DescribeSentimentDetectionJob" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "DescribeSentimentDetectionJob'" 'PrefixI 'True) (S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DescribeSentimentDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeSentimentDetectionJob

newDescribeSentimentDetectionJob Source #

Create a value of DescribeSentimentDetectionJob with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:jobId:DescribeSentimentDetectionJob', describeSentimentDetectionJob_jobId - The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.

data DescribeSentimentDetectionJobResponse Source #

Instances

Instances details
Eq DescribeSentimentDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeSentimentDetectionJob

Read DescribeSentimentDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeSentimentDetectionJob

Show DescribeSentimentDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeSentimentDetectionJob

Generic DescribeSentimentDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeSentimentDetectionJob

NFData DescribeSentimentDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeSentimentDetectionJob

type Rep DescribeSentimentDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeSentimentDetectionJob

type Rep DescribeSentimentDetectionJobResponse = D1 ('MetaData "DescribeSentimentDetectionJobResponse" "Amazonka.Comprehend.DescribeSentimentDetectionJob" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "DescribeSentimentDetectionJobResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "sentimentDetectionJobProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SentimentDetectionJobProperties)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDescribeSentimentDetectionJobResponse Source #

Create a value of DescribeSentimentDetectionJobResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:sentimentDetectionJobProperties:DescribeSentimentDetectionJobResponse', describeSentimentDetectionJobResponse_sentimentDetectionJobProperties - An object that contains the properties associated with a sentiment detection job.

$sel:httpStatus:DescribeSentimentDetectionJobResponse', describeSentimentDetectionJobResponse_httpStatus - The response's http status code.

StartEntitiesDetectionJob

data StartEntitiesDetectionJob Source #

See: newStartEntitiesDetectionJob smart constructor.

Instances

Instances details
Eq StartEntitiesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartEntitiesDetectionJob

Read StartEntitiesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartEntitiesDetectionJob

Show StartEntitiesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartEntitiesDetectionJob

Generic StartEntitiesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartEntitiesDetectionJob

Associated Types

type Rep StartEntitiesDetectionJob :: Type -> Type #

NFData StartEntitiesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartEntitiesDetectionJob

Hashable StartEntitiesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartEntitiesDetectionJob

ToJSON StartEntitiesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartEntitiesDetectionJob

AWSRequest StartEntitiesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartEntitiesDetectionJob

ToHeaders StartEntitiesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartEntitiesDetectionJob

ToPath StartEntitiesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartEntitiesDetectionJob

ToQuery StartEntitiesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartEntitiesDetectionJob

type Rep StartEntitiesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartEntitiesDetectionJob

type Rep StartEntitiesDetectionJob = D1 ('MetaData "StartEntitiesDetectionJob" "Amazonka.Comprehend.StartEntitiesDetectionJob" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "StartEntitiesDetectionJob'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "entityRecognizerArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "jobName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "vpcConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VpcConfig)) :*: (S1 ('MetaSel ('Just "volumeKmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "clientRequestToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :*: S1 ('MetaSel ('Just "inputDataConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 InputDataConfig)) :*: (S1 ('MetaSel ('Just "outputDataConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 OutputDataConfig) :*: (S1 ('MetaSel ('Just "dataAccessRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "languageCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 LanguageCode))))))
type AWSResponse StartEntitiesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartEntitiesDetectionJob

newStartEntitiesDetectionJob Source #

Create a value of StartEntitiesDetectionJob with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:entityRecognizerArn:StartEntitiesDetectionJob', startEntitiesDetectionJob_entityRecognizerArn - The Amazon Resource Name (ARN) that identifies the specific entity recognizer to be used by the StartEntitiesDetectionJob. This ARN is optional and is only used for a custom entity recognition job.

$sel:jobName:StartEntitiesDetectionJob', startEntitiesDetectionJob_jobName - The identifier of the job.

$sel:vpcConfig:StartEntitiesDetectionJob', startEntitiesDetectionJob_vpcConfig - 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.

$sel:volumeKmsKeyId:StartEntitiesDetectionJob', startEntitiesDetectionJob_volumeKmsKeyId - ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:

  • KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
  • Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

$sel:clientRequestToken:StartEntitiesDetectionJob', startEntitiesDetectionJob_clientRequestToken - A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

$sel:tags:StartEntitiesDetectionJob', startEntitiesDetectionJob_tags - Tags to be associated with the entities detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.

$sel:inputDataConfig:StartEntitiesDetectionJob', startEntitiesDetectionJob_inputDataConfig - Specifies the format and location of the input data for the job.

$sel:outputDataConfig:StartEntitiesDetectionJob', startEntitiesDetectionJob_outputDataConfig - Specifies where to send the output files.

$sel:dataAccessRoleArn:StartEntitiesDetectionJob', startEntitiesDetectionJob_dataAccessRoleArn - The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions.

$sel:languageCode:StartEntitiesDetectionJob', startEntitiesDetectionJob_languageCode - 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.

data StartEntitiesDetectionJobResponse Source #

See: newStartEntitiesDetectionJobResponse smart constructor.

Instances

Instances details
Eq StartEntitiesDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StartEntitiesDetectionJob

Read StartEntitiesDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StartEntitiesDetectionJob

Show StartEntitiesDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StartEntitiesDetectionJob

Generic StartEntitiesDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StartEntitiesDetectionJob

Associated Types

type Rep StartEntitiesDetectionJobResponse :: Type -> Type #

NFData StartEntitiesDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StartEntitiesDetectionJob

type Rep StartEntitiesDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StartEntitiesDetectionJob

type Rep StartEntitiesDetectionJobResponse = D1 ('MetaData "StartEntitiesDetectionJobResponse" "Amazonka.Comprehend.StartEntitiesDetectionJob" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "StartEntitiesDetectionJobResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "jobArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "jobStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobStatus)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newStartEntitiesDetectionJobResponse Source #

Create a value of StartEntitiesDetectionJobResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:jobId:StartEntitiesDetectionJobResponse', startEntitiesDetectionJobResponse_jobId - The identifier generated for the job. To get the status of job, use this identifier with the operation.

$sel:jobArn:StartEntitiesDetectionJobResponse', startEntitiesDetectionJobResponse_jobArn - The Amazon Resource Name (ARN) of the entities detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:

arn:<partition>:comprehend:<region>:<account-id>:entities-detection-job/<job-id>

The following is an example job ARN:

arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/1234abcd12ab34cd56ef1234567890ab

$sel:jobStatus:StartEntitiesDetectionJobResponse', startEntitiesDetectionJobResponse_jobStatus - The status of the job.

  • SUBMITTED - The job has been received and is queued for processing.
  • IN_PROGRESS - Amazon Comprehend is processing the job.
  • COMPLETED - The job was successfully completed and the output is available.
  • FAILED - The job did not complete. To get details, use the operation.
  • 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.

$sel:httpStatus:StartEntitiesDetectionJobResponse', startEntitiesDetectionJobResponse_httpStatus - The response's http status code.

StopPiiEntitiesDetectionJob

data StopPiiEntitiesDetectionJob Source #

See: newStopPiiEntitiesDetectionJob smart constructor.

Instances

Instances details
Eq StopPiiEntitiesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopPiiEntitiesDetectionJob

Read StopPiiEntitiesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopPiiEntitiesDetectionJob

Show StopPiiEntitiesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopPiiEntitiesDetectionJob

Generic StopPiiEntitiesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopPiiEntitiesDetectionJob

Associated Types

type Rep StopPiiEntitiesDetectionJob :: Type -> Type #

NFData StopPiiEntitiesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopPiiEntitiesDetectionJob

Hashable StopPiiEntitiesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopPiiEntitiesDetectionJob

ToJSON StopPiiEntitiesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopPiiEntitiesDetectionJob

AWSRequest StopPiiEntitiesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopPiiEntitiesDetectionJob

ToHeaders StopPiiEntitiesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopPiiEntitiesDetectionJob

ToPath StopPiiEntitiesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopPiiEntitiesDetectionJob

ToQuery StopPiiEntitiesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopPiiEntitiesDetectionJob

type Rep StopPiiEntitiesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopPiiEntitiesDetectionJob

type Rep StopPiiEntitiesDetectionJob = D1 ('MetaData "StopPiiEntitiesDetectionJob" "Amazonka.Comprehend.StopPiiEntitiesDetectionJob" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "StopPiiEntitiesDetectionJob'" 'PrefixI 'True) (S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse StopPiiEntitiesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopPiiEntitiesDetectionJob

newStopPiiEntitiesDetectionJob Source #

Create a value of StopPiiEntitiesDetectionJob with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:jobId:StopPiiEntitiesDetectionJob', stopPiiEntitiesDetectionJob_jobId - The identifier of the PII entities detection job to stop.

data StopPiiEntitiesDetectionJobResponse Source #

Instances

Instances details
Eq StopPiiEntitiesDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StopPiiEntitiesDetectionJob

Read StopPiiEntitiesDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StopPiiEntitiesDetectionJob

Show StopPiiEntitiesDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StopPiiEntitiesDetectionJob

Generic StopPiiEntitiesDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StopPiiEntitiesDetectionJob

NFData StopPiiEntitiesDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StopPiiEntitiesDetectionJob

type Rep StopPiiEntitiesDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StopPiiEntitiesDetectionJob

type Rep StopPiiEntitiesDetectionJobResponse = D1 ('MetaData "StopPiiEntitiesDetectionJobResponse" "Amazonka.Comprehend.StopPiiEntitiesDetectionJob" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "StopPiiEntitiesDetectionJobResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "jobStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobStatus)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newStopPiiEntitiesDetectionJobResponse Source #

Create a value of StopPiiEntitiesDetectionJobResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:jobId:StopPiiEntitiesDetectionJob', stopPiiEntitiesDetectionJobResponse_jobId - The identifier of the PII entities detection job to stop.

$sel:jobStatus:StopPiiEntitiesDetectionJobResponse', stopPiiEntitiesDetectionJobResponse_jobStatus - The status of the PII entities detection job.

$sel:httpStatus:StopPiiEntitiesDetectionJobResponse', stopPiiEntitiesDetectionJobResponse_httpStatus - The response's http status code.

DescribeEntityRecognizer

data DescribeEntityRecognizer Source #

See: newDescribeEntityRecognizer smart constructor.

Instances

Instances details
Eq DescribeEntityRecognizer Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeEntityRecognizer

Read DescribeEntityRecognizer Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeEntityRecognizer

Show DescribeEntityRecognizer Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeEntityRecognizer

Generic DescribeEntityRecognizer Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeEntityRecognizer

Associated Types

type Rep DescribeEntityRecognizer :: Type -> Type #

NFData DescribeEntityRecognizer Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeEntityRecognizer

Hashable DescribeEntityRecognizer Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeEntityRecognizer

ToJSON DescribeEntityRecognizer Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeEntityRecognizer

AWSRequest DescribeEntityRecognizer Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeEntityRecognizer

ToHeaders DescribeEntityRecognizer Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeEntityRecognizer

ToPath DescribeEntityRecognizer Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeEntityRecognizer

ToQuery DescribeEntityRecognizer Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeEntityRecognizer

type Rep DescribeEntityRecognizer Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeEntityRecognizer

type Rep DescribeEntityRecognizer = D1 ('MetaData "DescribeEntityRecognizer" "Amazonka.Comprehend.DescribeEntityRecognizer" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "DescribeEntityRecognizer'" 'PrefixI 'True) (S1 ('MetaSel ('Just "entityRecognizerArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DescribeEntityRecognizer Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeEntityRecognizer

newDescribeEntityRecognizer Source #

Create a value of DescribeEntityRecognizer with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:entityRecognizerArn:DescribeEntityRecognizer', describeEntityRecognizer_entityRecognizerArn - The Amazon Resource Name (ARN) that identifies the entity recognizer.

data DescribeEntityRecognizerResponse Source #

See: newDescribeEntityRecognizerResponse smart constructor.

Instances

Instances details
Eq DescribeEntityRecognizerResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeEntityRecognizer

Show DescribeEntityRecognizerResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeEntityRecognizer

Generic DescribeEntityRecognizerResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeEntityRecognizer

Associated Types

type Rep DescribeEntityRecognizerResponse :: Type -> Type #

NFData DescribeEntityRecognizerResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeEntityRecognizer

type Rep DescribeEntityRecognizerResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeEntityRecognizer

type Rep DescribeEntityRecognizerResponse = D1 ('MetaData "DescribeEntityRecognizerResponse" "Amazonka.Comprehend.DescribeEntityRecognizer" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "DescribeEntityRecognizerResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "entityRecognizerProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EntityRecognizerProperties)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDescribeEntityRecognizerResponse Source #

Create a value of DescribeEntityRecognizerResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:entityRecognizerProperties:DescribeEntityRecognizerResponse', describeEntityRecognizerResponse_entityRecognizerProperties - Describes information associated with an entity recognizer.

$sel:httpStatus:DescribeEntityRecognizerResponse', describeEntityRecognizerResponse_httpStatus - The response's http status code.

DetectSentiment

data DetectSentiment Source #

See: newDetectSentiment smart constructor.

Instances

Instances details
Eq DetectSentiment Source # 
Instance details

Defined in Amazonka.Comprehend.DetectSentiment

Show DetectSentiment Source # 
Instance details

Defined in Amazonka.Comprehend.DetectSentiment

Generic DetectSentiment Source # 
Instance details

Defined in Amazonka.Comprehend.DetectSentiment

Associated Types

type Rep DetectSentiment :: Type -> Type #

NFData DetectSentiment Source # 
Instance details

Defined in Amazonka.Comprehend.DetectSentiment

Methods

rnf :: DetectSentiment -> () #

Hashable DetectSentiment Source # 
Instance details

Defined in Amazonka.Comprehend.DetectSentiment

ToJSON DetectSentiment Source # 
Instance details

Defined in Amazonka.Comprehend.DetectSentiment

AWSRequest DetectSentiment Source # 
Instance details

Defined in Amazonka.Comprehend.DetectSentiment

Associated Types

type AWSResponse DetectSentiment #

ToHeaders DetectSentiment Source # 
Instance details

Defined in Amazonka.Comprehend.DetectSentiment

ToPath DetectSentiment Source # 
Instance details

Defined in Amazonka.Comprehend.DetectSentiment

ToQuery DetectSentiment Source # 
Instance details

Defined in Amazonka.Comprehend.DetectSentiment

type Rep DetectSentiment Source # 
Instance details

Defined in Amazonka.Comprehend.DetectSentiment

type Rep DetectSentiment = D1 ('MetaData "DetectSentiment" "Amazonka.Comprehend.DetectSentiment" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "DetectSentiment'" 'PrefixI 'True) (S1 ('MetaSel ('Just "text") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text)) :*: S1 ('MetaSel ('Just "languageCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 LanguageCode)))
type AWSResponse DetectSentiment Source # 
Instance details

Defined in Amazonka.Comprehend.DetectSentiment

newDetectSentiment Source #

Create a value of DetectSentiment with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:text:DetectSentiment', detectSentiment_text - A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded characters.

$sel:languageCode:DetectSentiment', detectSentiment_languageCode - The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.

data DetectSentimentResponse Source #

See: newDetectSentimentResponse smart constructor.

Instances

Instances details
Eq DetectSentimentResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DetectSentiment

Show DetectSentimentResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DetectSentiment

Generic DetectSentimentResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DetectSentiment

Associated Types

type Rep DetectSentimentResponse :: Type -> Type #

NFData DetectSentimentResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DetectSentiment

Methods

rnf :: DetectSentimentResponse -> () #

type Rep DetectSentimentResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DetectSentiment

type Rep DetectSentimentResponse = D1 ('MetaData "DetectSentimentResponse" "Amazonka.Comprehend.DetectSentiment" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "DetectSentimentResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "sentiment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SentimentType)) :*: (S1 ('MetaSel ('Just "sentimentScore") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SentimentScore)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDetectSentimentResponse Source #

Create a value of DetectSentimentResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:sentiment:DetectSentimentResponse', detectSentimentResponse_sentiment - The inferred sentiment that Amazon Comprehend has the highest level of confidence in.

$sel:sentimentScore:DetectSentimentResponse', detectSentimentResponse_sentimentScore - An object that lists the sentiments, and their corresponding confidence levels.

$sel:httpStatus:DetectSentimentResponse', detectSentimentResponse_httpStatus - The response's http status code.

StartDominantLanguageDetectionJob

data StartDominantLanguageDetectionJob Source #

See: newStartDominantLanguageDetectionJob smart constructor.

Instances

Instances details
Eq StartDominantLanguageDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartDominantLanguageDetectionJob

Read StartDominantLanguageDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartDominantLanguageDetectionJob

Show StartDominantLanguageDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartDominantLanguageDetectionJob

Generic StartDominantLanguageDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartDominantLanguageDetectionJob

Associated Types

type Rep StartDominantLanguageDetectionJob :: Type -> Type #

NFData StartDominantLanguageDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartDominantLanguageDetectionJob

Hashable StartDominantLanguageDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartDominantLanguageDetectionJob

ToJSON StartDominantLanguageDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartDominantLanguageDetectionJob

AWSRequest StartDominantLanguageDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartDominantLanguageDetectionJob

ToHeaders StartDominantLanguageDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartDominantLanguageDetectionJob

ToPath StartDominantLanguageDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartDominantLanguageDetectionJob

ToQuery StartDominantLanguageDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartDominantLanguageDetectionJob

type Rep StartDominantLanguageDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartDominantLanguageDetectionJob

type Rep StartDominantLanguageDetectionJob = D1 ('MetaData "StartDominantLanguageDetectionJob" "Amazonka.Comprehend.StartDominantLanguageDetectionJob" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "StartDominantLanguageDetectionJob'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "jobName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "vpcConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VpcConfig))) :*: (S1 ('MetaSel ('Just "volumeKmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "clientRequestToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :*: S1 ('MetaSel ('Just "inputDataConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 InputDataConfig)) :*: (S1 ('MetaSel ('Just "outputDataConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 OutputDataConfig) :*: S1 ('MetaSel ('Just "dataAccessRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse StartDominantLanguageDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartDominantLanguageDetectionJob

newStartDominantLanguageDetectionJob Source #

Create a value of StartDominantLanguageDetectionJob with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:jobName:StartDominantLanguageDetectionJob', startDominantLanguageDetectionJob_jobName - An identifier for the job.

$sel:vpcConfig:StartDominantLanguageDetectionJob', startDominantLanguageDetectionJob_vpcConfig - 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.

$sel:volumeKmsKeyId:StartDominantLanguageDetectionJob', startDominantLanguageDetectionJob_volumeKmsKeyId - ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:

  • KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
  • Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

$sel:clientRequestToken:StartDominantLanguageDetectionJob', startDominantLanguageDetectionJob_clientRequestToken - A unique identifier for the request. If you do not set the client request token, Amazon Comprehend generates one.

$sel:tags:StartDominantLanguageDetectionJob', startDominantLanguageDetectionJob_tags - Tags to be associated with the dominant language detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.

$sel:inputDataConfig:StartDominantLanguageDetectionJob', startDominantLanguageDetectionJob_inputDataConfig - Specifies the format and location of the input data for the job.

$sel:outputDataConfig:StartDominantLanguageDetectionJob', startDominantLanguageDetectionJob_outputDataConfig - Specifies where to send the output files.

$sel:dataAccessRoleArn:StartDominantLanguageDetectionJob', startDominantLanguageDetectionJob_dataAccessRoleArn - The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions.

data StartDominantLanguageDetectionJobResponse Source #

Instances

Instances details
Eq StartDominantLanguageDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StartDominantLanguageDetectionJob

Read StartDominantLanguageDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StartDominantLanguageDetectionJob

Show StartDominantLanguageDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StartDominantLanguageDetectionJob

Generic StartDominantLanguageDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StartDominantLanguageDetectionJob

NFData StartDominantLanguageDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StartDominantLanguageDetectionJob

type Rep StartDominantLanguageDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StartDominantLanguageDetectionJob

type Rep StartDominantLanguageDetectionJobResponse = D1 ('MetaData "StartDominantLanguageDetectionJobResponse" "Amazonka.Comprehend.StartDominantLanguageDetectionJob" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "StartDominantLanguageDetectionJobResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "jobArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "jobStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobStatus)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newStartDominantLanguageDetectionJobResponse Source #

Create a value of StartDominantLanguageDetectionJobResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:jobId:StartDominantLanguageDetectionJobResponse', startDominantLanguageDetectionJobResponse_jobId - The identifier generated for the job. To get the status of a job, use this identifier with the operation.

$sel:jobArn:StartDominantLanguageDetectionJobResponse', startDominantLanguageDetectionJobResponse_jobArn - The Amazon Resource Name (ARN) of the dominant language detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:

arn:<partition>:comprehend:<region>:<account-id>:dominant-language-detection-job/<job-id>

The following is an example job ARN:

arn:aws:comprehend:us-west-2:111122223333:dominant-language-detection-job/1234abcd12ab34cd56ef1234567890ab

$sel:jobStatus:StartDominantLanguageDetectionJobResponse', startDominantLanguageDetectionJobResponse_jobStatus - The status of the job.

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

$sel:httpStatus:StartDominantLanguageDetectionJobResponse', startDominantLanguageDetectionJobResponse_httpStatus - The response's http status code.

StopTrainingDocumentClassifier

data StopTrainingDocumentClassifier Source #

See: newStopTrainingDocumentClassifier smart constructor.

Instances

Instances details
Eq StopTrainingDocumentClassifier Source # 
Instance details

Defined in Amazonka.Comprehend.StopTrainingDocumentClassifier

Read StopTrainingDocumentClassifier Source # 
Instance details

Defined in Amazonka.Comprehend.StopTrainingDocumentClassifier

Show StopTrainingDocumentClassifier Source # 
Instance details

Defined in Amazonka.Comprehend.StopTrainingDocumentClassifier

Generic StopTrainingDocumentClassifier Source # 
Instance details

Defined in Amazonka.Comprehend.StopTrainingDocumentClassifier

Associated Types

type Rep StopTrainingDocumentClassifier :: Type -> Type #

NFData StopTrainingDocumentClassifier Source # 
Instance details

Defined in Amazonka.Comprehend.StopTrainingDocumentClassifier

Hashable StopTrainingDocumentClassifier Source # 
Instance details

Defined in Amazonka.Comprehend.StopTrainingDocumentClassifier

ToJSON StopTrainingDocumentClassifier Source # 
Instance details

Defined in Amazonka.Comprehend.StopTrainingDocumentClassifier

AWSRequest StopTrainingDocumentClassifier Source # 
Instance details

Defined in Amazonka.Comprehend.StopTrainingDocumentClassifier

ToHeaders StopTrainingDocumentClassifier Source # 
Instance details

Defined in Amazonka.Comprehend.StopTrainingDocumentClassifier

ToPath StopTrainingDocumentClassifier Source # 
Instance details

Defined in Amazonka.Comprehend.StopTrainingDocumentClassifier

ToQuery StopTrainingDocumentClassifier Source # 
Instance details

Defined in Amazonka.Comprehend.StopTrainingDocumentClassifier

type Rep StopTrainingDocumentClassifier Source # 
Instance details

Defined in Amazonka.Comprehend.StopTrainingDocumentClassifier

type Rep StopTrainingDocumentClassifier = D1 ('MetaData "StopTrainingDocumentClassifier" "Amazonka.Comprehend.StopTrainingDocumentClassifier" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "StopTrainingDocumentClassifier'" 'PrefixI 'True) (S1 ('MetaSel ('Just "documentClassifierArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse StopTrainingDocumentClassifier Source # 
Instance details

Defined in Amazonka.Comprehend.StopTrainingDocumentClassifier

newStopTrainingDocumentClassifier Source #

Create a value of StopTrainingDocumentClassifier with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:documentClassifierArn:StopTrainingDocumentClassifier', stopTrainingDocumentClassifier_documentClassifierArn - The Amazon Resource Name (ARN) that identifies the document classifier currently being trained.

data StopTrainingDocumentClassifierResponse Source #

Instances

Instances details
Eq StopTrainingDocumentClassifierResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StopTrainingDocumentClassifier

Read StopTrainingDocumentClassifierResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StopTrainingDocumentClassifier

Show StopTrainingDocumentClassifierResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StopTrainingDocumentClassifier

Generic StopTrainingDocumentClassifierResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StopTrainingDocumentClassifier

NFData StopTrainingDocumentClassifierResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StopTrainingDocumentClassifier

type Rep StopTrainingDocumentClassifierResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StopTrainingDocumentClassifier

type Rep StopTrainingDocumentClassifierResponse = D1 ('MetaData "StopTrainingDocumentClassifierResponse" "Amazonka.Comprehend.StopTrainingDocumentClassifier" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "StopTrainingDocumentClassifierResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newStopTrainingDocumentClassifierResponse Source #

Create a value of StopTrainingDocumentClassifierResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:StopTrainingDocumentClassifierResponse', stopTrainingDocumentClassifierResponse_httpStatus - The response's http status code.

DescribeDocumentClassificationJob

data DescribeDocumentClassificationJob Source #

See: newDescribeDocumentClassificationJob smart constructor.

Instances

Instances details
Eq DescribeDocumentClassificationJob Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeDocumentClassificationJob

Read DescribeDocumentClassificationJob Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeDocumentClassificationJob

Show DescribeDocumentClassificationJob Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeDocumentClassificationJob

Generic DescribeDocumentClassificationJob Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeDocumentClassificationJob

Associated Types

type Rep DescribeDocumentClassificationJob :: Type -> Type #

NFData DescribeDocumentClassificationJob Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeDocumentClassificationJob

Hashable DescribeDocumentClassificationJob Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeDocumentClassificationJob

ToJSON DescribeDocumentClassificationJob Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeDocumentClassificationJob

AWSRequest DescribeDocumentClassificationJob Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeDocumentClassificationJob

ToHeaders DescribeDocumentClassificationJob Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeDocumentClassificationJob

ToPath DescribeDocumentClassificationJob Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeDocumentClassificationJob

ToQuery DescribeDocumentClassificationJob Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeDocumentClassificationJob

type Rep DescribeDocumentClassificationJob Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeDocumentClassificationJob

type Rep DescribeDocumentClassificationJob = D1 ('MetaData "DescribeDocumentClassificationJob" "Amazonka.Comprehend.DescribeDocumentClassificationJob" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "DescribeDocumentClassificationJob'" 'PrefixI 'True) (S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DescribeDocumentClassificationJob Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeDocumentClassificationJob

newDescribeDocumentClassificationJob Source #

Create a value of DescribeDocumentClassificationJob with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:jobId:DescribeDocumentClassificationJob', describeDocumentClassificationJob_jobId - The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.

data DescribeDocumentClassificationJobResponse Source #

Instances

Instances details
Eq DescribeDocumentClassificationJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeDocumentClassificationJob

Read DescribeDocumentClassificationJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeDocumentClassificationJob

Show DescribeDocumentClassificationJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeDocumentClassificationJob

Generic DescribeDocumentClassificationJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeDocumentClassificationJob

NFData DescribeDocumentClassificationJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeDocumentClassificationJob

type Rep DescribeDocumentClassificationJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeDocumentClassificationJob

type Rep DescribeDocumentClassificationJobResponse = D1 ('MetaData "DescribeDocumentClassificationJobResponse" "Amazonka.Comprehend.DescribeDocumentClassificationJob" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "DescribeDocumentClassificationJobResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "documentClassificationJobProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DocumentClassificationJobProperties)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDescribeDocumentClassificationJobResponse Source #

Create a value of DescribeDocumentClassificationJobResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:documentClassificationJobProperties:DescribeDocumentClassificationJobResponse', describeDocumentClassificationJobResponse_documentClassificationJobProperties - An object that describes the properties associated with the document classification job.

$sel:httpStatus:DescribeDocumentClassificationJobResponse', describeDocumentClassificationJobResponse_httpStatus - The response's http status code.

ContainsPiiEntities

data ContainsPiiEntities Source #

See: newContainsPiiEntities smart constructor.

Instances

Instances details
Eq ContainsPiiEntities Source # 
Instance details

Defined in Amazonka.Comprehend.ContainsPiiEntities

Read ContainsPiiEntities Source # 
Instance details

Defined in Amazonka.Comprehend.ContainsPiiEntities

Show ContainsPiiEntities Source # 
Instance details

Defined in Amazonka.Comprehend.ContainsPiiEntities

Generic ContainsPiiEntities Source # 
Instance details

Defined in Amazonka.Comprehend.ContainsPiiEntities

Associated Types

type Rep ContainsPiiEntities :: Type -> Type #

NFData ContainsPiiEntities Source # 
Instance details

Defined in Amazonka.Comprehend.ContainsPiiEntities

Methods

rnf :: ContainsPiiEntities -> () #

Hashable ContainsPiiEntities Source # 
Instance details

Defined in Amazonka.Comprehend.ContainsPiiEntities

ToJSON ContainsPiiEntities Source # 
Instance details

Defined in Amazonka.Comprehend.ContainsPiiEntities

AWSRequest ContainsPiiEntities Source # 
Instance details

Defined in Amazonka.Comprehend.ContainsPiiEntities

Associated Types

type AWSResponse ContainsPiiEntities #

ToHeaders ContainsPiiEntities Source # 
Instance details

Defined in Amazonka.Comprehend.ContainsPiiEntities

ToPath ContainsPiiEntities Source # 
Instance details

Defined in Amazonka.Comprehend.ContainsPiiEntities

ToQuery ContainsPiiEntities Source # 
Instance details

Defined in Amazonka.Comprehend.ContainsPiiEntities

type Rep ContainsPiiEntities Source # 
Instance details

Defined in Amazonka.Comprehend.ContainsPiiEntities

type Rep ContainsPiiEntities = D1 ('MetaData "ContainsPiiEntities" "Amazonka.Comprehend.ContainsPiiEntities" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "ContainsPiiEntities'" 'PrefixI 'True) (S1 ('MetaSel ('Just "text") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "languageCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 LanguageCode)))
type AWSResponse ContainsPiiEntities Source # 
Instance details

Defined in Amazonka.Comprehend.ContainsPiiEntities

newContainsPiiEntities Source #

Create a value of ContainsPiiEntities with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:text:ContainsPiiEntities', containsPiiEntities_text - Creates a new document classification request to analyze a single document in real-time, returning personally identifiable information (PII) entity labels.

$sel:languageCode:ContainsPiiEntities', containsPiiEntities_languageCode - The language of the input documents.

data ContainsPiiEntitiesResponse Source #

See: newContainsPiiEntitiesResponse smart constructor.

Instances

Instances details
Eq ContainsPiiEntitiesResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ContainsPiiEntities

Read ContainsPiiEntitiesResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ContainsPiiEntities

Show ContainsPiiEntitiesResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ContainsPiiEntities

Generic ContainsPiiEntitiesResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ContainsPiiEntities

Associated Types

type Rep ContainsPiiEntitiesResponse :: Type -> Type #

NFData ContainsPiiEntitiesResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ContainsPiiEntities

type Rep ContainsPiiEntitiesResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ContainsPiiEntities

type Rep ContainsPiiEntitiesResponse = D1 ('MetaData "ContainsPiiEntitiesResponse" "Amazonka.Comprehend.ContainsPiiEntities" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "ContainsPiiEntitiesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "labels") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [EntityLabel])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newContainsPiiEntitiesResponse Source #

Create a value of ContainsPiiEntitiesResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:labels:ContainsPiiEntitiesResponse', containsPiiEntitiesResponse_labels - The labels used in the document being analyzed. Individual labels represent personally identifiable information (PII) entity types.

$sel:httpStatus:ContainsPiiEntitiesResponse', containsPiiEntitiesResponse_httpStatus - The response's http status code.

ListEventsDetectionJobs

data ListEventsDetectionJobs Source #

See: newListEventsDetectionJobs smart constructor.

Instances

Instances details
Eq ListEventsDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListEventsDetectionJobs

Read ListEventsDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListEventsDetectionJobs

Show ListEventsDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListEventsDetectionJobs

Generic ListEventsDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListEventsDetectionJobs

Associated Types

type Rep ListEventsDetectionJobs :: Type -> Type #

NFData ListEventsDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListEventsDetectionJobs

Methods

rnf :: ListEventsDetectionJobs -> () #

Hashable ListEventsDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListEventsDetectionJobs

ToJSON ListEventsDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListEventsDetectionJobs

AWSRequest ListEventsDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListEventsDetectionJobs

ToHeaders ListEventsDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListEventsDetectionJobs

ToPath ListEventsDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListEventsDetectionJobs

ToQuery ListEventsDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListEventsDetectionJobs

type Rep ListEventsDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListEventsDetectionJobs

type Rep ListEventsDetectionJobs = D1 ('MetaData "ListEventsDetectionJobs" "Amazonka.Comprehend.ListEventsDetectionJobs" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "ListEventsDetectionJobs'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "filter'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EventsDetectionJobFilter)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))))
type AWSResponse ListEventsDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListEventsDetectionJobs

newListEventsDetectionJobs :: ListEventsDetectionJobs Source #

Create a value of ListEventsDetectionJobs with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:nextToken:ListEventsDetectionJobs', listEventsDetectionJobs_nextToken - Identifies the next page of results to return.

$sel:filter':ListEventsDetectionJobs', listEventsDetectionJobs_filter - 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.

$sel:maxResults:ListEventsDetectionJobs', listEventsDetectionJobs_maxResults - The maximum number of results to return in each page.

data ListEventsDetectionJobsResponse Source #

See: newListEventsDetectionJobsResponse smart constructor.

Instances

Instances details
Eq ListEventsDetectionJobsResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ListEventsDetectionJobs

Read ListEventsDetectionJobsResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ListEventsDetectionJobs

Show ListEventsDetectionJobsResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ListEventsDetectionJobs

Generic ListEventsDetectionJobsResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ListEventsDetectionJobs

Associated Types

type Rep ListEventsDetectionJobsResponse :: Type -> Type #

NFData ListEventsDetectionJobsResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ListEventsDetectionJobs

type Rep ListEventsDetectionJobsResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ListEventsDetectionJobs

type Rep ListEventsDetectionJobsResponse = D1 ('MetaData "ListEventsDetectionJobsResponse" "Amazonka.Comprehend.ListEventsDetectionJobs" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "ListEventsDetectionJobsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "eventsDetectionJobPropertiesList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [EventsDetectionJobProperties])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListEventsDetectionJobsResponse Source #

Create a value of ListEventsDetectionJobsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:eventsDetectionJobPropertiesList:ListEventsDetectionJobsResponse', listEventsDetectionJobsResponse_eventsDetectionJobPropertiesList - A list containing the properties of each job that is returned.

$sel:nextToken:ListEventsDetectionJobs', listEventsDetectionJobsResponse_nextToken - Identifies the next page of results to return.

$sel:httpStatus:ListEventsDetectionJobsResponse', listEventsDetectionJobsResponse_httpStatus - The response's http status code.

BatchDetectEntities

data BatchDetectEntities Source #

See: newBatchDetectEntities smart constructor.

Instances

Instances details
Eq BatchDetectEntities Source # 
Instance details

Defined in Amazonka.Comprehend.BatchDetectEntities

Show BatchDetectEntities Source # 
Instance details

Defined in Amazonka.Comprehend.BatchDetectEntities

Generic BatchDetectEntities Source # 
Instance details

Defined in Amazonka.Comprehend.BatchDetectEntities

Associated Types

type Rep BatchDetectEntities :: Type -> Type #

NFData BatchDetectEntities Source # 
Instance details

Defined in Amazonka.Comprehend.BatchDetectEntities

Methods

rnf :: BatchDetectEntities -> () #

Hashable BatchDetectEntities Source # 
Instance details

Defined in Amazonka.Comprehend.BatchDetectEntities

ToJSON BatchDetectEntities Source # 
Instance details

Defined in Amazonka.Comprehend.BatchDetectEntities

AWSRequest BatchDetectEntities Source # 
Instance details

Defined in Amazonka.Comprehend.BatchDetectEntities

Associated Types

type AWSResponse BatchDetectEntities #

ToHeaders BatchDetectEntities Source # 
Instance details

Defined in Amazonka.Comprehend.BatchDetectEntities

ToPath BatchDetectEntities Source # 
Instance details

Defined in Amazonka.Comprehend.BatchDetectEntities

ToQuery BatchDetectEntities Source # 
Instance details

Defined in Amazonka.Comprehend.BatchDetectEntities

type Rep BatchDetectEntities Source # 
Instance details

Defined in Amazonka.Comprehend.BatchDetectEntities

type Rep BatchDetectEntities = D1 ('MetaData "BatchDetectEntities" "Amazonka.Comprehend.BatchDetectEntities" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "BatchDetectEntities'" 'PrefixI 'True) (S1 ('MetaSel ('Just "textList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive [Sensitive Text])) :*: S1 ('MetaSel ('Just "languageCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 LanguageCode)))
type AWSResponse BatchDetectEntities Source # 
Instance details

Defined in Amazonka.Comprehend.BatchDetectEntities

newBatchDetectEntities Source #

Create a value of BatchDetectEntities with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:textList:BatchDetectEntities', batchDetectEntities_textList - A list containing the text of the input documents. The list can contain a maximum of 25 documents. Each document must contain fewer than 5,000 bytes of UTF-8 encoded characters.

$sel:languageCode:BatchDetectEntities', batchDetectEntities_languageCode - The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.

data BatchDetectEntitiesResponse Source #

See: newBatchDetectEntitiesResponse smart constructor.

Instances

Instances details
Eq BatchDetectEntitiesResponse Source # 
Instance details

Defined in Amazonka.Comprehend.BatchDetectEntities

Show BatchDetectEntitiesResponse Source # 
Instance details

Defined in Amazonka.Comprehend.BatchDetectEntities

Generic BatchDetectEntitiesResponse Source # 
Instance details

Defined in Amazonka.Comprehend.BatchDetectEntities

Associated Types

type Rep BatchDetectEntitiesResponse :: Type -> Type #

NFData BatchDetectEntitiesResponse Source # 
Instance details

Defined in Amazonka.Comprehend.BatchDetectEntities

type Rep BatchDetectEntitiesResponse Source # 
Instance details

Defined in Amazonka.Comprehend.BatchDetectEntities

type Rep BatchDetectEntitiesResponse = D1 ('MetaData "BatchDetectEntitiesResponse" "Amazonka.Comprehend.BatchDetectEntities" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "BatchDetectEntitiesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: (S1 ('MetaSel ('Just "resultList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [BatchDetectEntitiesItemResult]) :*: S1 ('MetaSel ('Just "errorList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [BatchItemError]))))

newBatchDetectEntitiesResponse Source #

Create a value of BatchDetectEntitiesResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:BatchDetectEntitiesResponse', batchDetectEntitiesResponse_httpStatus - The response's http status code.

$sel:resultList:BatchDetectEntitiesResponse', batchDetectEntitiesResponse_resultList - 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.

$sel:errorList:BatchDetectEntitiesResponse', batchDetectEntitiesResponse_errorList - 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.

CreateEntityRecognizer

data CreateEntityRecognizer Source #

See: newCreateEntityRecognizer smart constructor.

Instances

Instances details
Eq CreateEntityRecognizer Source # 
Instance details

Defined in Amazonka.Comprehend.CreateEntityRecognizer

Read CreateEntityRecognizer Source # 
Instance details

Defined in Amazonka.Comprehend.CreateEntityRecognizer

Show CreateEntityRecognizer Source # 
Instance details

Defined in Amazonka.Comprehend.CreateEntityRecognizer

Generic CreateEntityRecognizer Source # 
Instance details

Defined in Amazonka.Comprehend.CreateEntityRecognizer

Associated Types

type Rep CreateEntityRecognizer :: Type -> Type #

NFData CreateEntityRecognizer Source # 
Instance details

Defined in Amazonka.Comprehend.CreateEntityRecognizer

Methods

rnf :: CreateEntityRecognizer -> () #

Hashable CreateEntityRecognizer Source # 
Instance details

Defined in Amazonka.Comprehend.CreateEntityRecognizer

ToJSON CreateEntityRecognizer Source # 
Instance details

Defined in Amazonka.Comprehend.CreateEntityRecognizer

AWSRequest CreateEntityRecognizer Source # 
Instance details

Defined in Amazonka.Comprehend.CreateEntityRecognizer

Associated Types

type AWSResponse CreateEntityRecognizer #

ToHeaders CreateEntityRecognizer Source # 
Instance details

Defined in Amazonka.Comprehend.CreateEntityRecognizer

ToPath CreateEntityRecognizer Source # 
Instance details

Defined in Amazonka.Comprehend.CreateEntityRecognizer

ToQuery CreateEntityRecognizer Source # 
Instance details

Defined in Amazonka.Comprehend.CreateEntityRecognizer

type Rep CreateEntityRecognizer Source # 
Instance details

Defined in Amazonka.Comprehend.CreateEntityRecognizer

type AWSResponse CreateEntityRecognizer Source # 
Instance details

Defined in Amazonka.Comprehend.CreateEntityRecognizer

newCreateEntityRecognizer Source #

Create a value of CreateEntityRecognizer with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:versionName:CreateEntityRecognizer', createEntityRecognizer_versionName - The version name given to the newly created recognizer. Version names can be a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The version name must be unique among all models with the same recognizer name in the account/ AWS Region.

$sel:modelKmsKeyId:CreateEntityRecognizer', createEntityRecognizer_modelKmsKeyId - ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId can be either of the following formats

  • KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
  • Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

$sel:vpcConfig:CreateEntityRecognizer', createEntityRecognizer_vpcConfig - Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your custom entity recognizer. For more information, see Amazon VPC.

$sel:volumeKmsKeyId:CreateEntityRecognizer', createEntityRecognizer_volumeKmsKeyId - ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:

  • KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
  • Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

$sel:clientRequestToken:CreateEntityRecognizer', createEntityRecognizer_clientRequestToken - A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

$sel:tags:CreateEntityRecognizer', createEntityRecognizer_tags - Tags to be associated with the entity recognizer being created. A tag is a key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.

$sel:recognizerName:CreateEntityRecognizer', createEntityRecognizer_recognizerName - The name given to the newly created recognizer. Recognizer names can be a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The name must be unique in the account/region.

$sel:dataAccessRoleArn:CreateEntityRecognizer', createEntityRecognizer_dataAccessRoleArn - The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.

$sel:inputDataConfig:CreateEntityRecognizer', createEntityRecognizer_inputDataConfig - 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.

$sel:languageCode:CreateEntityRecognizer', createEntityRecognizer_languageCode - You can specify any of the following languages supported by Amazon Comprehend: English ("en"), Spanish ("es"), French ("fr"), Italian ("it"), German ("de"), or Portuguese ("pt"). All documents must be in the same language.

data CreateEntityRecognizerResponse Source #

See: newCreateEntityRecognizerResponse smart constructor.

Instances

Instances details
Eq CreateEntityRecognizerResponse Source # 
Instance details

Defined in Amazonka.Comprehend.CreateEntityRecognizer

Read CreateEntityRecognizerResponse Source # 
Instance details

Defined in Amazonka.Comprehend.CreateEntityRecognizer

Show CreateEntityRecognizerResponse Source # 
Instance details

Defined in Amazonka.Comprehend.CreateEntityRecognizer

Generic CreateEntityRecognizerResponse Source # 
Instance details

Defined in Amazonka.Comprehend.CreateEntityRecognizer

Associated Types

type Rep CreateEntityRecognizerResponse :: Type -> Type #

NFData CreateEntityRecognizerResponse Source # 
Instance details

Defined in Amazonka.Comprehend.CreateEntityRecognizer

type Rep CreateEntityRecognizerResponse Source # 
Instance details

Defined in Amazonka.Comprehend.CreateEntityRecognizer

type Rep CreateEntityRecognizerResponse = D1 ('MetaData "CreateEntityRecognizerResponse" "Amazonka.Comprehend.CreateEntityRecognizer" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "CreateEntityRecognizerResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "entityRecognizerArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateEntityRecognizerResponse Source #

Create a value of CreateEntityRecognizerResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:entityRecognizerArn:CreateEntityRecognizerResponse', createEntityRecognizerResponse_entityRecognizerArn - The Amazon Resource Name (ARN) that identifies the entity recognizer.

$sel:httpStatus:CreateEntityRecognizerResponse', createEntityRecognizerResponse_httpStatus - The response's http status code.

StopKeyPhrasesDetectionJob

data StopKeyPhrasesDetectionJob Source #

See: newStopKeyPhrasesDetectionJob smart constructor.

Instances

Instances details
Eq StopKeyPhrasesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopKeyPhrasesDetectionJob

Read StopKeyPhrasesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopKeyPhrasesDetectionJob

Show StopKeyPhrasesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopKeyPhrasesDetectionJob

Generic StopKeyPhrasesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopKeyPhrasesDetectionJob

Associated Types

type Rep StopKeyPhrasesDetectionJob :: Type -> Type #

NFData StopKeyPhrasesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopKeyPhrasesDetectionJob

Hashable StopKeyPhrasesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopKeyPhrasesDetectionJob

ToJSON StopKeyPhrasesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopKeyPhrasesDetectionJob

AWSRequest StopKeyPhrasesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopKeyPhrasesDetectionJob

ToHeaders StopKeyPhrasesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopKeyPhrasesDetectionJob

ToPath StopKeyPhrasesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopKeyPhrasesDetectionJob

ToQuery StopKeyPhrasesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopKeyPhrasesDetectionJob

type Rep StopKeyPhrasesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopKeyPhrasesDetectionJob

type Rep StopKeyPhrasesDetectionJob = D1 ('MetaData "StopKeyPhrasesDetectionJob" "Amazonka.Comprehend.StopKeyPhrasesDetectionJob" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "StopKeyPhrasesDetectionJob'" 'PrefixI 'True) (S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse StopKeyPhrasesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopKeyPhrasesDetectionJob

newStopKeyPhrasesDetectionJob Source #

Create a value of StopKeyPhrasesDetectionJob with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:jobId:StopKeyPhrasesDetectionJob', stopKeyPhrasesDetectionJob_jobId - The identifier of the key phrases detection job to stop.

data StopKeyPhrasesDetectionJobResponse Source #

Instances

Instances details
Eq StopKeyPhrasesDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StopKeyPhrasesDetectionJob

Read StopKeyPhrasesDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StopKeyPhrasesDetectionJob

Show StopKeyPhrasesDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StopKeyPhrasesDetectionJob

Generic StopKeyPhrasesDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StopKeyPhrasesDetectionJob

Associated Types

type Rep StopKeyPhrasesDetectionJobResponse :: Type -> Type #

NFData StopKeyPhrasesDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StopKeyPhrasesDetectionJob

type Rep StopKeyPhrasesDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StopKeyPhrasesDetectionJob

type Rep StopKeyPhrasesDetectionJobResponse = D1 ('MetaData "StopKeyPhrasesDetectionJobResponse" "Amazonka.Comprehend.StopKeyPhrasesDetectionJob" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "StopKeyPhrasesDetectionJobResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "jobStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobStatus)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newStopKeyPhrasesDetectionJobResponse Source #

Create a value of StopKeyPhrasesDetectionJobResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:jobId:StopKeyPhrasesDetectionJob', stopKeyPhrasesDetectionJobResponse_jobId - The identifier of the key phrases detection job to stop.

$sel:jobStatus:StopKeyPhrasesDetectionJobResponse', stopKeyPhrasesDetectionJobResponse_jobStatus - Either STOP_REQUESTED if the job is currently running, or STOPPED if the job was previously stopped with the StopKeyPhrasesDetectionJob operation.

$sel:httpStatus:StopKeyPhrasesDetectionJobResponse', stopKeyPhrasesDetectionJobResponse_httpStatus - The response's http status code.

CreateDocumentClassifier

data CreateDocumentClassifier Source #

See: newCreateDocumentClassifier smart constructor.

Instances

Instances details
Eq CreateDocumentClassifier Source # 
Instance details

Defined in Amazonka.Comprehend.CreateDocumentClassifier

Read CreateDocumentClassifier Source # 
Instance details

Defined in Amazonka.Comprehend.CreateDocumentClassifier

Show CreateDocumentClassifier Source # 
Instance details

Defined in Amazonka.Comprehend.CreateDocumentClassifier

Generic CreateDocumentClassifier Source # 
Instance details

Defined in Amazonka.Comprehend.CreateDocumentClassifier

Associated Types

type Rep CreateDocumentClassifier :: Type -> Type #

NFData CreateDocumentClassifier Source # 
Instance details

Defined in Amazonka.Comprehend.CreateDocumentClassifier

Hashable CreateDocumentClassifier Source # 
Instance details

Defined in Amazonka.Comprehend.CreateDocumentClassifier

ToJSON CreateDocumentClassifier Source # 
Instance details

Defined in Amazonka.Comprehend.CreateDocumentClassifier

AWSRequest CreateDocumentClassifier Source # 
Instance details

Defined in Amazonka.Comprehend.CreateDocumentClassifier

ToHeaders CreateDocumentClassifier Source # 
Instance details

Defined in Amazonka.Comprehend.CreateDocumentClassifier

ToPath CreateDocumentClassifier Source # 
Instance details

Defined in Amazonka.Comprehend.CreateDocumentClassifier

ToQuery CreateDocumentClassifier Source # 
Instance details

Defined in Amazonka.Comprehend.CreateDocumentClassifier

type Rep CreateDocumentClassifier Source # 
Instance details

Defined in Amazonka.Comprehend.CreateDocumentClassifier

type Rep CreateDocumentClassifier = D1 ('MetaData "CreateDocumentClassifier" "Amazonka.Comprehend.CreateDocumentClassifier" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "CreateDocumentClassifier'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "versionName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "modelKmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "mode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DocumentClassifierMode)))) :*: (S1 ('MetaSel ('Just "vpcConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VpcConfig)) :*: (S1 ('MetaSel ('Just "volumeKmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "outputDataConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DocumentClassifierOutputDataConfig))))) :*: ((S1 ('MetaSel ('Just "clientRequestToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :*: S1 ('MetaSel ('Just "documentClassifierName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :*: (S1 ('MetaSel ('Just "dataAccessRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "inputDataConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DocumentClassifierInputDataConfig) :*: S1 ('MetaSel ('Just "languageCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 LanguageCode))))))
type AWSResponse CreateDocumentClassifier Source # 
Instance details

Defined in Amazonka.Comprehend.CreateDocumentClassifier

newCreateDocumentClassifier Source #

Create a value of CreateDocumentClassifier with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:versionName:CreateDocumentClassifier', createDocumentClassifier_versionName - The version name given to the newly created classifier. Version names can have a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The version name must be unique among all models with the same classifier name in the account/AWS Region.

$sel:modelKmsKeyId:CreateDocumentClassifier', createDocumentClassifier_modelKmsKeyId - ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId can be either of the following formats:

  • KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
  • Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

$sel:mode:CreateDocumentClassifier', createDocumentClassifier_mode - Indicates the mode in which the classifier will be trained. The classifier can be trained in multi-class mode, which identifies one and only one class for each document, or multi-label mode, which identifies one or more labels for each document. In multi-label mode, multiple labels for an individual document are separated by a delimiter. The default delimiter between labels is a pipe (|).

$sel:vpcConfig:CreateDocumentClassifier', createDocumentClassifier_vpcConfig - Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your custom classifier. For more information, see Amazon VPC.

$sel:volumeKmsKeyId:CreateDocumentClassifier', createDocumentClassifier_volumeKmsKeyId - ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:

  • KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
  • Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

$sel:outputDataConfig:CreateDocumentClassifier', createDocumentClassifier_outputDataConfig - Enables the addition of output results configuration parameters for custom classifier jobs.

$sel:clientRequestToken:CreateDocumentClassifier', createDocumentClassifier_clientRequestToken - A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

$sel:tags:CreateDocumentClassifier', createDocumentClassifier_tags - Tags to be associated with the document classifier being created. A tag is a key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.

$sel:documentClassifierName:CreateDocumentClassifier', createDocumentClassifier_documentClassifierName - The name of the document classifier.

$sel:dataAccessRoleArn:CreateDocumentClassifier', createDocumentClassifier_dataAccessRoleArn - The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.

$sel:inputDataConfig:CreateDocumentClassifier', createDocumentClassifier_inputDataConfig - Specifies the format and location of the input data for the job.

$sel:languageCode:CreateDocumentClassifier', createDocumentClassifier_languageCode - The language of the input documents. You can specify any of the following languages supported by Amazon Comprehend: German ("de"), English ("en"), Spanish ("es"), French ("fr"), Italian ("it"), or Portuguese ("pt"). All documents must be in the same language.

data CreateDocumentClassifierResponse Source #

See: newCreateDocumentClassifierResponse smart constructor.

Instances

Instances details
Eq CreateDocumentClassifierResponse Source # 
Instance details

Defined in Amazonka.Comprehend.CreateDocumentClassifier

Read CreateDocumentClassifierResponse Source # 
Instance details

Defined in Amazonka.Comprehend.CreateDocumentClassifier

Show CreateDocumentClassifierResponse Source # 
Instance details

Defined in Amazonka.Comprehend.CreateDocumentClassifier

Generic CreateDocumentClassifierResponse Source # 
Instance details

Defined in Amazonka.Comprehend.CreateDocumentClassifier

Associated Types

type Rep CreateDocumentClassifierResponse :: Type -> Type #

NFData CreateDocumentClassifierResponse Source # 
Instance details

Defined in Amazonka.Comprehend.CreateDocumentClassifier

type Rep CreateDocumentClassifierResponse Source # 
Instance details

Defined in Amazonka.Comprehend.CreateDocumentClassifier

type Rep CreateDocumentClassifierResponse = D1 ('MetaData "CreateDocumentClassifierResponse" "Amazonka.Comprehend.CreateDocumentClassifier" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "CreateDocumentClassifierResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "documentClassifierArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateDocumentClassifierResponse Source #

Create a value of CreateDocumentClassifierResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:documentClassifierArn:CreateDocumentClassifierResponse', createDocumentClassifierResponse_documentClassifierArn - The Amazon Resource Name (ARN) that identifies the document classifier.

$sel:httpStatus:CreateDocumentClassifierResponse', createDocumentClassifierResponse_httpStatus - The response's http status code.

ListPiiEntitiesDetectionJobs

data ListPiiEntitiesDetectionJobs Source #

See: newListPiiEntitiesDetectionJobs smart constructor.

Instances

Instances details
Eq ListPiiEntitiesDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListPiiEntitiesDetectionJobs

Read ListPiiEntitiesDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListPiiEntitiesDetectionJobs

Show ListPiiEntitiesDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListPiiEntitiesDetectionJobs

Generic ListPiiEntitiesDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListPiiEntitiesDetectionJobs

Associated Types

type Rep ListPiiEntitiesDetectionJobs :: Type -> Type #

NFData ListPiiEntitiesDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListPiiEntitiesDetectionJobs

Hashable ListPiiEntitiesDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListPiiEntitiesDetectionJobs

ToJSON ListPiiEntitiesDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListPiiEntitiesDetectionJobs

AWSRequest ListPiiEntitiesDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListPiiEntitiesDetectionJobs

ToHeaders ListPiiEntitiesDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListPiiEntitiesDetectionJobs

ToPath ListPiiEntitiesDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListPiiEntitiesDetectionJobs

ToQuery ListPiiEntitiesDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListPiiEntitiesDetectionJobs

type Rep ListPiiEntitiesDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListPiiEntitiesDetectionJobs

type Rep ListPiiEntitiesDetectionJobs = D1 ('MetaData "ListPiiEntitiesDetectionJobs" "Amazonka.Comprehend.ListPiiEntitiesDetectionJobs" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "ListPiiEntitiesDetectionJobs'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "filter'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PiiEntitiesDetectionJobFilter)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))))
type AWSResponse ListPiiEntitiesDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListPiiEntitiesDetectionJobs

newListPiiEntitiesDetectionJobs :: ListPiiEntitiesDetectionJobs Source #

Create a value of ListPiiEntitiesDetectionJobs with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:nextToken:ListPiiEntitiesDetectionJobs', listPiiEntitiesDetectionJobs_nextToken - Identifies the next page of results to return.

$sel:filter':ListPiiEntitiesDetectionJobs', listPiiEntitiesDetectionJobs_filter - 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.

$sel:maxResults:ListPiiEntitiesDetectionJobs', listPiiEntitiesDetectionJobs_maxResults - The maximum number of results to return in each page.

data ListPiiEntitiesDetectionJobsResponse Source #

Instances

Instances details
Eq ListPiiEntitiesDetectionJobsResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ListPiiEntitiesDetectionJobs

Read ListPiiEntitiesDetectionJobsResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ListPiiEntitiesDetectionJobs

Show ListPiiEntitiesDetectionJobsResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ListPiiEntitiesDetectionJobs

Generic ListPiiEntitiesDetectionJobsResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ListPiiEntitiesDetectionJobs

NFData ListPiiEntitiesDetectionJobsResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ListPiiEntitiesDetectionJobs

type Rep ListPiiEntitiesDetectionJobsResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ListPiiEntitiesDetectionJobs

type Rep ListPiiEntitiesDetectionJobsResponse = D1 ('MetaData "ListPiiEntitiesDetectionJobsResponse" "Amazonka.Comprehend.ListPiiEntitiesDetectionJobs" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "ListPiiEntitiesDetectionJobsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "piiEntitiesDetectionJobPropertiesList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PiiEntitiesDetectionJobProperties])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListPiiEntitiesDetectionJobsResponse Source #

Create a value of ListPiiEntitiesDetectionJobsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:nextToken:ListPiiEntitiesDetectionJobs', listPiiEntitiesDetectionJobsResponse_nextToken - Identifies the next page of results to return.

$sel:piiEntitiesDetectionJobPropertiesList:ListPiiEntitiesDetectionJobsResponse', listPiiEntitiesDetectionJobsResponse_piiEntitiesDetectionJobPropertiesList - A list containing the properties of each job that is returned.

$sel:httpStatus:ListPiiEntitiesDetectionJobsResponse', listPiiEntitiesDetectionJobsResponse_httpStatus - The response's http status code.

ListEntityRecognizers (Paginated)

data ListEntityRecognizers Source #

See: newListEntityRecognizers smart constructor.

Instances

Instances details
Eq ListEntityRecognizers Source # 
Instance details

Defined in Amazonka.Comprehend.ListEntityRecognizers

Read ListEntityRecognizers Source # 
Instance details

Defined in Amazonka.Comprehend.ListEntityRecognizers

Show ListEntityRecognizers Source # 
Instance details

Defined in Amazonka.Comprehend.ListEntityRecognizers

Generic ListEntityRecognizers Source # 
Instance details

Defined in Amazonka.Comprehend.ListEntityRecognizers

Associated Types

type Rep ListEntityRecognizers :: Type -> Type #

NFData ListEntityRecognizers Source # 
Instance details

Defined in Amazonka.Comprehend.ListEntityRecognizers

Methods

rnf :: ListEntityRecognizers -> () #

Hashable ListEntityRecognizers Source # 
Instance details

Defined in Amazonka.Comprehend.ListEntityRecognizers

ToJSON ListEntityRecognizers Source # 
Instance details

Defined in Amazonka.Comprehend.ListEntityRecognizers

AWSPager ListEntityRecognizers Source # 
Instance details

Defined in Amazonka.Comprehend.ListEntityRecognizers

AWSRequest ListEntityRecognizers Source # 
Instance details

Defined in Amazonka.Comprehend.ListEntityRecognizers

Associated Types

type AWSResponse ListEntityRecognizers #

ToHeaders ListEntityRecognizers Source # 
Instance details

Defined in Amazonka.Comprehend.ListEntityRecognizers

ToPath ListEntityRecognizers Source # 
Instance details

Defined in Amazonka.Comprehend.ListEntityRecognizers

ToQuery ListEntityRecognizers Source # 
Instance details

Defined in Amazonka.Comprehend.ListEntityRecognizers

type Rep ListEntityRecognizers Source # 
Instance details

Defined in Amazonka.Comprehend.ListEntityRecognizers

type Rep ListEntityRecognizers = D1 ('MetaData "ListEntityRecognizers" "Amazonka.Comprehend.ListEntityRecognizers" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "ListEntityRecognizers'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "filter'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EntityRecognizerFilter)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))))
type AWSResponse ListEntityRecognizers Source # 
Instance details

Defined in Amazonka.Comprehend.ListEntityRecognizers

newListEntityRecognizers :: ListEntityRecognizers Source #

Create a value of ListEntityRecognizers with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:nextToken:ListEntityRecognizers', listEntityRecognizers_nextToken - Identifies the next page of results to return.

$sel:filter':ListEntityRecognizers', listEntityRecognizers_filter - Filters the list of entities returned. You can filter on Status, SubmitTimeBefore, or SubmitTimeAfter. You can only set one filter at a time.

$sel:maxResults:ListEntityRecognizers', listEntityRecognizers_maxResults - The maximum number of results to return on each page. The default is 100.

data ListEntityRecognizersResponse Source #

See: newListEntityRecognizersResponse smart constructor.

Instances

Instances details
Eq ListEntityRecognizersResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ListEntityRecognizers

Show ListEntityRecognizersResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ListEntityRecognizers

Generic ListEntityRecognizersResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ListEntityRecognizers

Associated Types

type Rep ListEntityRecognizersResponse :: Type -> Type #

NFData ListEntityRecognizersResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ListEntityRecognizers

type Rep ListEntityRecognizersResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ListEntityRecognizers

type Rep ListEntityRecognizersResponse = D1 ('MetaData "ListEntityRecognizersResponse" "Amazonka.Comprehend.ListEntityRecognizers" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "ListEntityRecognizersResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "entityRecognizerPropertiesList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [EntityRecognizerProperties])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListEntityRecognizersResponse Source #

Create a value of ListEntityRecognizersResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:nextToken:ListEntityRecognizers', listEntityRecognizersResponse_nextToken - Identifies the next page of results to return.

$sel:entityRecognizerPropertiesList:ListEntityRecognizersResponse', listEntityRecognizersResponse_entityRecognizerPropertiesList - The list of properties of an entity recognizer.

$sel:httpStatus:ListEntityRecognizersResponse', listEntityRecognizersResponse_httpStatus - The response's http status code.

StopSentimentDetectionJob

data StopSentimentDetectionJob Source #

See: newStopSentimentDetectionJob smart constructor.

Instances

Instances details
Eq StopSentimentDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopSentimentDetectionJob

Read StopSentimentDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopSentimentDetectionJob

Show StopSentimentDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopSentimentDetectionJob

Generic StopSentimentDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopSentimentDetectionJob

Associated Types

type Rep StopSentimentDetectionJob :: Type -> Type #

NFData StopSentimentDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopSentimentDetectionJob

Hashable StopSentimentDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopSentimentDetectionJob

ToJSON StopSentimentDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopSentimentDetectionJob

AWSRequest StopSentimentDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopSentimentDetectionJob

ToHeaders StopSentimentDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopSentimentDetectionJob

ToPath StopSentimentDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopSentimentDetectionJob

ToQuery StopSentimentDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopSentimentDetectionJob

type Rep StopSentimentDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopSentimentDetectionJob

type Rep StopSentimentDetectionJob = D1 ('MetaData "StopSentimentDetectionJob" "Amazonka.Comprehend.StopSentimentDetectionJob" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "StopSentimentDetectionJob'" 'PrefixI 'True) (S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse StopSentimentDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopSentimentDetectionJob

newStopSentimentDetectionJob Source #

Create a value of StopSentimentDetectionJob with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:jobId:StopSentimentDetectionJob', stopSentimentDetectionJob_jobId - The identifier of the sentiment detection job to stop.

data StopSentimentDetectionJobResponse Source #

See: newStopSentimentDetectionJobResponse smart constructor.

Instances

Instances details
Eq StopSentimentDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StopSentimentDetectionJob

Read StopSentimentDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StopSentimentDetectionJob

Show StopSentimentDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StopSentimentDetectionJob

Generic StopSentimentDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StopSentimentDetectionJob

Associated Types

type Rep StopSentimentDetectionJobResponse :: Type -> Type #

NFData StopSentimentDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StopSentimentDetectionJob

type Rep StopSentimentDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StopSentimentDetectionJob

type Rep StopSentimentDetectionJobResponse = D1 ('MetaData "StopSentimentDetectionJobResponse" "Amazonka.Comprehend.StopSentimentDetectionJob" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "StopSentimentDetectionJobResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "jobStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobStatus)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newStopSentimentDetectionJobResponse Source #

Create a value of StopSentimentDetectionJobResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:jobId:StopSentimentDetectionJob', stopSentimentDetectionJobResponse_jobId - The identifier of the sentiment detection job to stop.

$sel:jobStatus:StopSentimentDetectionJobResponse', stopSentimentDetectionJobResponse_jobStatus - Either STOP_REQUESTED if the job is currently running, or STOPPED if the job was previously stopped with the StopSentimentDetectionJob operation.

$sel:httpStatus:StopSentimentDetectionJobResponse', stopSentimentDetectionJobResponse_httpStatus - The response's http status code.

DetectDominantLanguage

data DetectDominantLanguage Source #

See: newDetectDominantLanguage smart constructor.

Instances

Instances details
Eq DetectDominantLanguage Source # 
Instance details

Defined in Amazonka.Comprehend.DetectDominantLanguage

Show DetectDominantLanguage Source # 
Instance details

Defined in Amazonka.Comprehend.DetectDominantLanguage

Generic DetectDominantLanguage Source # 
Instance details

Defined in Amazonka.Comprehend.DetectDominantLanguage

Associated Types

type Rep DetectDominantLanguage :: Type -> Type #

NFData DetectDominantLanguage Source # 
Instance details

Defined in Amazonka.Comprehend.DetectDominantLanguage

Methods

rnf :: DetectDominantLanguage -> () #

Hashable DetectDominantLanguage Source # 
Instance details

Defined in Amazonka.Comprehend.DetectDominantLanguage

ToJSON DetectDominantLanguage Source # 
Instance details

Defined in Amazonka.Comprehend.DetectDominantLanguage

AWSRequest DetectDominantLanguage Source # 
Instance details

Defined in Amazonka.Comprehend.DetectDominantLanguage

Associated Types

type AWSResponse DetectDominantLanguage #

ToHeaders DetectDominantLanguage Source # 
Instance details

Defined in Amazonka.Comprehend.DetectDominantLanguage

ToPath DetectDominantLanguage Source # 
Instance details

Defined in Amazonka.Comprehend.DetectDominantLanguage

ToQuery DetectDominantLanguage Source # 
Instance details

Defined in Amazonka.Comprehend.DetectDominantLanguage

type Rep DetectDominantLanguage Source # 
Instance details

Defined in Amazonka.Comprehend.DetectDominantLanguage

type Rep DetectDominantLanguage = D1 ('MetaData "DetectDominantLanguage" "Amazonka.Comprehend.DetectDominantLanguage" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "DetectDominantLanguage'" 'PrefixI 'True) (S1 ('MetaSel ('Just "text") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text))))
type AWSResponse DetectDominantLanguage Source # 
Instance details

Defined in Amazonka.Comprehend.DetectDominantLanguage

newDetectDominantLanguage Source #

Create a value of DetectDominantLanguage with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:text:DetectDominantLanguage', detectDominantLanguage_text - A UTF-8 text string. Each string should contain at least 20 characters and must contain fewer that 5,000 bytes of UTF-8 encoded characters.

data DetectDominantLanguageResponse Source #

See: newDetectDominantLanguageResponse smart constructor.

Instances

Instances details
Eq DetectDominantLanguageResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DetectDominantLanguage

Show DetectDominantLanguageResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DetectDominantLanguage

Generic DetectDominantLanguageResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DetectDominantLanguage

Associated Types

type Rep DetectDominantLanguageResponse :: Type -> Type #

NFData DetectDominantLanguageResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DetectDominantLanguage

type Rep DetectDominantLanguageResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DetectDominantLanguage

type Rep DetectDominantLanguageResponse = D1 ('MetaData "DetectDominantLanguageResponse" "Amazonka.Comprehend.DetectDominantLanguage" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "DetectDominantLanguageResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "languages") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DominantLanguage])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDetectDominantLanguageResponse Source #

Create a value of DetectDominantLanguageResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:languages:DetectDominantLanguageResponse', detectDominantLanguageResponse_languages - The languages that Amazon Comprehend detected in the input text. For each language, the response returns the RFC 5646 language code and the level of confidence that Amazon Comprehend has in the accuracy of its inference. For more information about RFC 5646, see Tags for Identifying Languages on the IETF Tools web site.

$sel:httpStatus:DetectDominantLanguageResponse', detectDominantLanguageResponse_httpStatus - The response's http status code.

ClassifyDocument

data ClassifyDocument Source #

See: newClassifyDocument smart constructor.

Instances

Instances details
Eq ClassifyDocument Source # 
Instance details

Defined in Amazonka.Comprehend.ClassifyDocument

Show ClassifyDocument Source # 
Instance details

Defined in Amazonka.Comprehend.ClassifyDocument

Generic ClassifyDocument Source # 
Instance details

Defined in Amazonka.Comprehend.ClassifyDocument

Associated Types

type Rep ClassifyDocument :: Type -> Type #

NFData ClassifyDocument Source # 
Instance details

Defined in Amazonka.Comprehend.ClassifyDocument

Methods

rnf :: ClassifyDocument -> () #

Hashable ClassifyDocument Source # 
Instance details

Defined in Amazonka.Comprehend.ClassifyDocument

ToJSON ClassifyDocument Source # 
Instance details

Defined in Amazonka.Comprehend.ClassifyDocument

AWSRequest ClassifyDocument Source # 
Instance details

Defined in Amazonka.Comprehend.ClassifyDocument

Associated Types

type AWSResponse ClassifyDocument #

ToHeaders ClassifyDocument Source # 
Instance details

Defined in Amazonka.Comprehend.ClassifyDocument

ToPath ClassifyDocument Source # 
Instance details

Defined in Amazonka.Comprehend.ClassifyDocument

ToQuery ClassifyDocument Source # 
Instance details

Defined in Amazonka.Comprehend.ClassifyDocument

type Rep ClassifyDocument Source # 
Instance details

Defined in Amazonka.Comprehend.ClassifyDocument

type Rep ClassifyDocument = D1 ('MetaData "ClassifyDocument" "Amazonka.Comprehend.ClassifyDocument" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "ClassifyDocument'" 'PrefixI 'True) (S1 ('MetaSel ('Just "text") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text)) :*: S1 ('MetaSel ('Just "endpointArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse ClassifyDocument Source # 
Instance details

Defined in Amazonka.Comprehend.ClassifyDocument

newClassifyDocument Source #

Create a value of ClassifyDocument with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:text:ClassifyDocument', classifyDocument_text - The document text to be analyzed.

$sel:endpointArn:ClassifyDocument', classifyDocument_endpointArn - The Amazon Resource Number (ARN) of the endpoint.

data ClassifyDocumentResponse Source #

See: newClassifyDocumentResponse smart constructor.

Instances

Instances details
Eq ClassifyDocumentResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ClassifyDocument

Show ClassifyDocumentResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ClassifyDocument

Generic ClassifyDocumentResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ClassifyDocument

Associated Types

type Rep ClassifyDocumentResponse :: Type -> Type #

NFData ClassifyDocumentResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ClassifyDocument

type Rep ClassifyDocumentResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ClassifyDocument

type Rep ClassifyDocumentResponse = D1 ('MetaData "ClassifyDocumentResponse" "Amazonka.Comprehend.ClassifyDocument" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "ClassifyDocumentResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "labels") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DocumentLabel])) :*: (S1 ('MetaSel ('Just "classes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DocumentClass])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newClassifyDocumentResponse Source #

Create a value of ClassifyDocumentResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

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

$sel:classes:ClassifyDocumentResponse', classifyDocumentResponse_classes - The classes used by the document being analyzed. These are used for multi-class trained models. Individual classes are mutually exclusive and each document is expected to have only a single class assigned to it. For example, an animal can be a dog or a cat, but not both at the same time.

$sel:httpStatus:ClassifyDocumentResponse', classifyDocumentResponse_httpStatus - The response's http status code.

StartEventsDetectionJob

data StartEventsDetectionJob Source #

See: newStartEventsDetectionJob smart constructor.

Instances

Instances details
Eq StartEventsDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartEventsDetectionJob

Read StartEventsDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartEventsDetectionJob

Show StartEventsDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartEventsDetectionJob

Generic StartEventsDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartEventsDetectionJob

Associated Types

type Rep StartEventsDetectionJob :: Type -> Type #

NFData StartEventsDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartEventsDetectionJob

Methods

rnf :: StartEventsDetectionJob -> () #

Hashable StartEventsDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartEventsDetectionJob

ToJSON StartEventsDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartEventsDetectionJob

AWSRequest StartEventsDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartEventsDetectionJob

ToHeaders StartEventsDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartEventsDetectionJob

ToPath StartEventsDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartEventsDetectionJob

ToQuery StartEventsDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartEventsDetectionJob

type Rep StartEventsDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartEventsDetectionJob

type Rep StartEventsDetectionJob = D1 ('MetaData "StartEventsDetectionJob" "Amazonka.Comprehend.StartEventsDetectionJob" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "StartEventsDetectionJob'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "jobName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "clientRequestToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :*: S1 ('MetaSel ('Just "inputDataConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 InputDataConfig))) :*: ((S1 ('MetaSel ('Just "outputDataConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 OutputDataConfig) :*: S1 ('MetaSel ('Just "dataAccessRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "languageCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 LanguageCode) :*: S1 ('MetaSel ('Just "targetEventTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty Text))))))
type AWSResponse StartEventsDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartEventsDetectionJob

newStartEventsDetectionJob Source #

Create a value of StartEventsDetectionJob with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:jobName:StartEventsDetectionJob', startEventsDetectionJob_jobName - The identifier of the events detection job.

$sel:clientRequestToken:StartEventsDetectionJob', startEventsDetectionJob_clientRequestToken - An unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

$sel:tags:StartEventsDetectionJob', startEventsDetectionJob_tags - Tags to be associated with the events detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.

$sel:inputDataConfig:StartEventsDetectionJob', startEventsDetectionJob_inputDataConfig - Specifies the format and location of the input data for the job.

$sel:outputDataConfig:StartEventsDetectionJob', startEventsDetectionJob_outputDataConfig - Specifies where to send the output files.

$sel:dataAccessRoleArn:StartEventsDetectionJob', startEventsDetectionJob_dataAccessRoleArn - The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.

$sel:languageCode:StartEventsDetectionJob', startEventsDetectionJob_languageCode - The language code of the input documents.

$sel:targetEventTypes:StartEventsDetectionJob', startEventsDetectionJob_targetEventTypes - The types of events to detect in the input documents.

data StartEventsDetectionJobResponse Source #

See: newStartEventsDetectionJobResponse smart constructor.

Instances

Instances details
Eq StartEventsDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StartEventsDetectionJob

Read StartEventsDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StartEventsDetectionJob

Show StartEventsDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StartEventsDetectionJob

Generic StartEventsDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StartEventsDetectionJob

Associated Types

type Rep StartEventsDetectionJobResponse :: Type -> Type #

NFData StartEventsDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StartEventsDetectionJob

type Rep StartEventsDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StartEventsDetectionJob

type Rep StartEventsDetectionJobResponse = D1 ('MetaData "StartEventsDetectionJobResponse" "Amazonka.Comprehend.StartEventsDetectionJob" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "StartEventsDetectionJobResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "jobArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "jobStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobStatus)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newStartEventsDetectionJobResponse Source #

Create a value of StartEventsDetectionJobResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:jobId:StartEventsDetectionJobResponse', startEventsDetectionJobResponse_jobId - An unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

$sel:jobArn:StartEventsDetectionJobResponse', startEventsDetectionJobResponse_jobArn - The Amazon Resource Name (ARN) of the events detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:

arn:<partition>:comprehend:<region>:<account-id>:events-detection-job/<job-id>

The following is an example job ARN:

arn:aws:comprehend:us-west-2:111122223333:events-detection-job/1234abcd12ab34cd56ef1234567890ab

$sel:jobStatus:StartEventsDetectionJobResponse', startEventsDetectionJobResponse_jobStatus - The status of the events detection job.

$sel:httpStatus:StartEventsDetectionJobResponse', startEventsDetectionJobResponse_httpStatus - The response's http status code.

DescribeTopicsDetectionJob

data DescribeTopicsDetectionJob Source #

See: newDescribeTopicsDetectionJob smart constructor.

Instances

Instances details
Eq DescribeTopicsDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeTopicsDetectionJob

Read DescribeTopicsDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeTopicsDetectionJob

Show DescribeTopicsDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeTopicsDetectionJob

Generic DescribeTopicsDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeTopicsDetectionJob

Associated Types

type Rep DescribeTopicsDetectionJob :: Type -> Type #

NFData DescribeTopicsDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeTopicsDetectionJob

Hashable DescribeTopicsDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeTopicsDetectionJob

ToJSON DescribeTopicsDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeTopicsDetectionJob

AWSRequest DescribeTopicsDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeTopicsDetectionJob

ToHeaders DescribeTopicsDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeTopicsDetectionJob

ToPath DescribeTopicsDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeTopicsDetectionJob

ToQuery DescribeTopicsDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeTopicsDetectionJob

type Rep DescribeTopicsDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeTopicsDetectionJob

type Rep DescribeTopicsDetectionJob = D1 ('MetaData "DescribeTopicsDetectionJob" "Amazonka.Comprehend.DescribeTopicsDetectionJob" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "DescribeTopicsDetectionJob'" 'PrefixI 'True) (S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DescribeTopicsDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeTopicsDetectionJob

newDescribeTopicsDetectionJob Source #

Create a value of DescribeTopicsDetectionJob with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:jobId:DescribeTopicsDetectionJob', describeTopicsDetectionJob_jobId - The identifier assigned by the user to the detection job.

data DescribeTopicsDetectionJobResponse Source #

Instances

Instances details
Eq DescribeTopicsDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeTopicsDetectionJob

Read DescribeTopicsDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeTopicsDetectionJob

Show DescribeTopicsDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeTopicsDetectionJob

Generic DescribeTopicsDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeTopicsDetectionJob

Associated Types

type Rep DescribeTopicsDetectionJobResponse :: Type -> Type #

NFData DescribeTopicsDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeTopicsDetectionJob

type Rep DescribeTopicsDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeTopicsDetectionJob

type Rep DescribeTopicsDetectionJobResponse = D1 ('MetaData "DescribeTopicsDetectionJobResponse" "Amazonka.Comprehend.DescribeTopicsDetectionJob" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "DescribeTopicsDetectionJobResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "topicsDetectionJobProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TopicsDetectionJobProperties)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDescribeTopicsDetectionJobResponse Source #

Create a value of DescribeTopicsDetectionJobResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:topicsDetectionJobProperties:DescribeTopicsDetectionJobResponse', describeTopicsDetectionJobResponse_topicsDetectionJobProperties - The list of properties for the requested job.

$sel:httpStatus:DescribeTopicsDetectionJobResponse', describeTopicsDetectionJobResponse_httpStatus - The response's http status code.

ListDocumentClassificationJobs (Paginated)

data ListDocumentClassificationJobs Source #

See: newListDocumentClassificationJobs smart constructor.

Instances

Instances details
Eq ListDocumentClassificationJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListDocumentClassificationJobs

Read ListDocumentClassificationJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListDocumentClassificationJobs

Show ListDocumentClassificationJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListDocumentClassificationJobs

Generic ListDocumentClassificationJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListDocumentClassificationJobs

Associated Types

type Rep ListDocumentClassificationJobs :: Type -> Type #

NFData ListDocumentClassificationJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListDocumentClassificationJobs

Hashable ListDocumentClassificationJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListDocumentClassificationJobs

ToJSON ListDocumentClassificationJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListDocumentClassificationJobs

AWSPager ListDocumentClassificationJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListDocumentClassificationJobs

AWSRequest ListDocumentClassificationJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListDocumentClassificationJobs

ToHeaders ListDocumentClassificationJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListDocumentClassificationJobs

ToPath ListDocumentClassificationJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListDocumentClassificationJobs

ToQuery ListDocumentClassificationJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListDocumentClassificationJobs

type Rep ListDocumentClassificationJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListDocumentClassificationJobs

type Rep ListDocumentClassificationJobs = D1 ('MetaData "ListDocumentClassificationJobs" "Amazonka.Comprehend.ListDocumentClassificationJobs" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "ListDocumentClassificationJobs'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "filter'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DocumentClassificationJobFilter)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))))
type AWSResponse ListDocumentClassificationJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListDocumentClassificationJobs

newListDocumentClassificationJobs :: ListDocumentClassificationJobs Source #

Create a value of ListDocumentClassificationJobs with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:nextToken:ListDocumentClassificationJobs', listDocumentClassificationJobs_nextToken - Identifies the next page of results to return.

$sel:filter':ListDocumentClassificationJobs', listDocumentClassificationJobs_filter - 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.

$sel:maxResults:ListDocumentClassificationJobs', listDocumentClassificationJobs_maxResults - The maximum number of results to return in each page. The default is 100.

data ListDocumentClassificationJobsResponse Source #

Instances

Instances details
Eq ListDocumentClassificationJobsResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ListDocumentClassificationJobs

Read ListDocumentClassificationJobsResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ListDocumentClassificationJobs

Show ListDocumentClassificationJobsResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ListDocumentClassificationJobs

Generic ListDocumentClassificationJobsResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ListDocumentClassificationJobs

NFData ListDocumentClassificationJobsResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ListDocumentClassificationJobs

type Rep ListDocumentClassificationJobsResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ListDocumentClassificationJobs

type Rep ListDocumentClassificationJobsResponse = D1 ('MetaData "ListDocumentClassificationJobsResponse" "Amazonka.Comprehend.ListDocumentClassificationJobs" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "ListDocumentClassificationJobsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "documentClassificationJobPropertiesList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DocumentClassificationJobProperties])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

DetectPiiEntities

data DetectPiiEntities Source #

See: newDetectPiiEntities smart constructor.

Instances

Instances details
Eq DetectPiiEntities Source # 
Instance details

Defined in Amazonka.Comprehend.DetectPiiEntities

Read DetectPiiEntities Source # 
Instance details

Defined in Amazonka.Comprehend.DetectPiiEntities

Show DetectPiiEntities Source # 
Instance details

Defined in Amazonka.Comprehend.DetectPiiEntities

Generic DetectPiiEntities Source # 
Instance details

Defined in Amazonka.Comprehend.DetectPiiEntities

Associated Types

type Rep DetectPiiEntities :: Type -> Type #

NFData DetectPiiEntities Source # 
Instance details

Defined in Amazonka.Comprehend.DetectPiiEntities

Methods

rnf :: DetectPiiEntities -> () #

Hashable DetectPiiEntities Source # 
Instance details

Defined in Amazonka.Comprehend.DetectPiiEntities

ToJSON DetectPiiEntities Source # 
Instance details

Defined in Amazonka.Comprehend.DetectPiiEntities

AWSRequest DetectPiiEntities Source # 
Instance details

Defined in Amazonka.Comprehend.DetectPiiEntities

Associated Types

type AWSResponse DetectPiiEntities #

ToHeaders DetectPiiEntities Source # 
Instance details

Defined in Amazonka.Comprehend.DetectPiiEntities

ToPath DetectPiiEntities Source # 
Instance details

Defined in Amazonka.Comprehend.DetectPiiEntities

ToQuery DetectPiiEntities Source # 
Instance details

Defined in Amazonka.Comprehend.DetectPiiEntities

type Rep DetectPiiEntities Source # 
Instance details

Defined in Amazonka.Comprehend.DetectPiiEntities

type Rep DetectPiiEntities = D1 ('MetaData "DetectPiiEntities" "Amazonka.Comprehend.DetectPiiEntities" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "DetectPiiEntities'" 'PrefixI 'True) (S1 ('MetaSel ('Just "text") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "languageCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 LanguageCode)))
type AWSResponse DetectPiiEntities Source # 
Instance details

Defined in Amazonka.Comprehend.DetectPiiEntities

newDetectPiiEntities Source #

Create a value of DetectPiiEntities with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:text:DetectPiiEntities', detectPiiEntities_text - A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded characters.

$sel:languageCode:DetectPiiEntities', detectPiiEntities_languageCode - The language of the input documents.

data DetectPiiEntitiesResponse Source #

See: newDetectPiiEntitiesResponse smart constructor.

Instances

Instances details
Eq DetectPiiEntitiesResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DetectPiiEntities

Read DetectPiiEntitiesResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DetectPiiEntities

Show DetectPiiEntitiesResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DetectPiiEntities

Generic DetectPiiEntitiesResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DetectPiiEntities

Associated Types

type Rep DetectPiiEntitiesResponse :: Type -> Type #

NFData DetectPiiEntitiesResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DetectPiiEntities

type Rep DetectPiiEntitiesResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DetectPiiEntities

type Rep DetectPiiEntitiesResponse = D1 ('MetaData "DetectPiiEntitiesResponse" "Amazonka.Comprehend.DetectPiiEntities" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "DetectPiiEntitiesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "entities") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PiiEntity])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDetectPiiEntitiesResponse Source #

Create a value of DetectPiiEntitiesResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:entities:DetectPiiEntitiesResponse', detectPiiEntitiesResponse_entities - 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.

$sel:httpStatus:DetectPiiEntitiesResponse', detectPiiEntitiesResponse_httpStatus - The response's http status code.

ListEndpoints

data ListEndpoints Source #

See: newListEndpoints smart constructor.

Instances

Instances details
Eq ListEndpoints Source # 
Instance details

Defined in Amazonka.Comprehend.ListEndpoints

Read ListEndpoints Source # 
Instance details

Defined in Amazonka.Comprehend.ListEndpoints

Show ListEndpoints Source # 
Instance details

Defined in Amazonka.Comprehend.ListEndpoints

Generic ListEndpoints Source # 
Instance details

Defined in Amazonka.Comprehend.ListEndpoints

Associated Types

type Rep ListEndpoints :: Type -> Type #

NFData ListEndpoints Source # 
Instance details

Defined in Amazonka.Comprehend.ListEndpoints

Methods

rnf :: ListEndpoints -> () #

Hashable ListEndpoints Source # 
Instance details

Defined in Amazonka.Comprehend.ListEndpoints

ToJSON ListEndpoints Source # 
Instance details

Defined in Amazonka.Comprehend.ListEndpoints

AWSRequest ListEndpoints Source # 
Instance details

Defined in Amazonka.Comprehend.ListEndpoints

Associated Types

type AWSResponse ListEndpoints #

ToHeaders ListEndpoints Source # 
Instance details

Defined in Amazonka.Comprehend.ListEndpoints

ToPath ListEndpoints Source # 
Instance details

Defined in Amazonka.Comprehend.ListEndpoints

ToQuery ListEndpoints Source # 
Instance details

Defined in Amazonka.Comprehend.ListEndpoints

type Rep ListEndpoints Source # 
Instance details

Defined in Amazonka.Comprehend.ListEndpoints

type Rep ListEndpoints = D1 ('MetaData "ListEndpoints" "Amazonka.Comprehend.ListEndpoints" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "ListEndpoints'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "filter'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EndpointFilter)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))))
type AWSResponse ListEndpoints Source # 
Instance details

Defined in Amazonka.Comprehend.ListEndpoints

newListEndpoints :: ListEndpoints Source #

Create a value of ListEndpoints with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:nextToken:ListEndpoints', listEndpoints_nextToken - Identifies the next page of results to return.

$sel:filter':ListEndpoints', listEndpoints_filter - 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.

$sel:maxResults:ListEndpoints', listEndpoints_maxResults - The maximum number of results to return in each page. The default is 100.

data ListEndpointsResponse Source #

See: newListEndpointsResponse smart constructor.

Instances

Instances details
Eq ListEndpointsResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ListEndpoints

Read ListEndpointsResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ListEndpoints

Show ListEndpointsResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ListEndpoints

Generic ListEndpointsResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ListEndpoints

Associated Types

type Rep ListEndpointsResponse :: Type -> Type #

NFData ListEndpointsResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ListEndpoints

Methods

rnf :: ListEndpointsResponse -> () #

type Rep ListEndpointsResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ListEndpoints

type Rep ListEndpointsResponse = D1 ('MetaData "ListEndpointsResponse" "Amazonka.Comprehend.ListEndpoints" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "ListEndpointsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "endpointPropertiesList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [EndpointProperties])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListEndpointsResponse Source #

Create a value of ListEndpointsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:endpointPropertiesList:ListEndpointsResponse', listEndpointsResponse_endpointPropertiesList - Displays a list of endpoint properties being retrieved by the service in response to the request.

$sel:nextToken:ListEndpoints', listEndpointsResponse_nextToken - Identifies the next page of results to return.

$sel:httpStatus:ListEndpointsResponse', listEndpointsResponse_httpStatus - The response's http status code.

DetectEntities

data DetectEntities Source #

See: newDetectEntities smart constructor.

Instances

Instances details
Eq DetectEntities Source # 
Instance details

Defined in Amazonka.Comprehend.DetectEntities

Show DetectEntities Source # 
Instance details

Defined in Amazonka.Comprehend.DetectEntities

Generic DetectEntities Source # 
Instance details

Defined in Amazonka.Comprehend.DetectEntities

Associated Types

type Rep DetectEntities :: Type -> Type #

NFData DetectEntities Source # 
Instance details

Defined in Amazonka.Comprehend.DetectEntities

Methods

rnf :: DetectEntities -> () #

Hashable DetectEntities Source # 
Instance details

Defined in Amazonka.Comprehend.DetectEntities

ToJSON DetectEntities Source # 
Instance details

Defined in Amazonka.Comprehend.DetectEntities

AWSRequest DetectEntities Source # 
Instance details

Defined in Amazonka.Comprehend.DetectEntities

Associated Types

type AWSResponse DetectEntities #

ToHeaders DetectEntities Source # 
Instance details

Defined in Amazonka.Comprehend.DetectEntities

ToPath DetectEntities Source # 
Instance details

Defined in Amazonka.Comprehend.DetectEntities

ToQuery DetectEntities Source # 
Instance details

Defined in Amazonka.Comprehend.DetectEntities

type Rep DetectEntities Source # 
Instance details

Defined in Amazonka.Comprehend.DetectEntities

type Rep DetectEntities = D1 ('MetaData "DetectEntities" "Amazonka.Comprehend.DetectEntities" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "DetectEntities'" 'PrefixI 'True) (S1 ('MetaSel ('Just "languageCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LanguageCode)) :*: (S1 ('MetaSel ('Just "endpointArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "text") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text)))))
type AWSResponse DetectEntities Source # 
Instance details

Defined in Amazonka.Comprehend.DetectEntities

newDetectEntities Source #

Create a value of DetectEntities with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:languageCode:DetectEntities', detectEntities_languageCode - The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.

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.

$sel:endpointArn:DetectEntities', detectEntities_endpointArn - 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.

$sel:text:DetectEntities', detectEntities_text - A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded characters.

data DetectEntitiesResponse Source #

See: newDetectEntitiesResponse smart constructor.

Instances

Instances details
Eq DetectEntitiesResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DetectEntities

Show DetectEntitiesResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DetectEntities

Generic DetectEntitiesResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DetectEntities

Associated Types

type Rep DetectEntitiesResponse :: Type -> Type #

NFData DetectEntitiesResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DetectEntities

Methods

rnf :: DetectEntitiesResponse -> () #

type Rep DetectEntitiesResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DetectEntities

type Rep DetectEntitiesResponse = D1 ('MetaData "DetectEntitiesResponse" "Amazonka.Comprehend.DetectEntities" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "DetectEntitiesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "entities") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Entity])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDetectEntitiesResponse Source #

Create a value of DetectEntitiesResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:entities:DetectEntitiesResponse', detectEntitiesResponse_entities - 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 how-entities.

$sel:httpStatus:DetectEntitiesResponse', detectEntitiesResponse_httpStatus - The response's http status code.

DescribeDocumentClassifier

data DescribeDocumentClassifier Source #

See: newDescribeDocumentClassifier smart constructor.

Instances

Instances details
Eq DescribeDocumentClassifier Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeDocumentClassifier

Read DescribeDocumentClassifier Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeDocumentClassifier

Show DescribeDocumentClassifier Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeDocumentClassifier

Generic DescribeDocumentClassifier Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeDocumentClassifier

Associated Types

type Rep DescribeDocumentClassifier :: Type -> Type #

NFData DescribeDocumentClassifier Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeDocumentClassifier

Hashable DescribeDocumentClassifier Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeDocumentClassifier

ToJSON DescribeDocumentClassifier Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeDocumentClassifier

AWSRequest DescribeDocumentClassifier Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeDocumentClassifier

ToHeaders DescribeDocumentClassifier Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeDocumentClassifier

ToPath DescribeDocumentClassifier Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeDocumentClassifier

ToQuery DescribeDocumentClassifier Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeDocumentClassifier

type Rep DescribeDocumentClassifier Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeDocumentClassifier

type Rep DescribeDocumentClassifier = D1 ('MetaData "DescribeDocumentClassifier" "Amazonka.Comprehend.DescribeDocumentClassifier" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "DescribeDocumentClassifier'" 'PrefixI 'True) (S1 ('MetaSel ('Just "documentClassifierArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DescribeDocumentClassifier Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeDocumentClassifier

newDescribeDocumentClassifier Source #

Create a value of DescribeDocumentClassifier with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:documentClassifierArn:DescribeDocumentClassifier', describeDocumentClassifier_documentClassifierArn - The Amazon Resource Name (ARN) that identifies the document classifier. The operation returns this identifier in its response.

data DescribeDocumentClassifierResponse Source #

Instances

Instances details
Eq DescribeDocumentClassifierResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeDocumentClassifier

Show DescribeDocumentClassifierResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeDocumentClassifier

Generic DescribeDocumentClassifierResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeDocumentClassifier

Associated Types

type Rep DescribeDocumentClassifierResponse :: Type -> Type #

NFData DescribeDocumentClassifierResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeDocumentClassifier

type Rep DescribeDocumentClassifierResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeDocumentClassifier

type Rep DescribeDocumentClassifierResponse = D1 ('MetaData "DescribeDocumentClassifierResponse" "Amazonka.Comprehend.DescribeDocumentClassifier" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "DescribeDocumentClassifierResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "documentClassifierProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DocumentClassifierProperties)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDescribeDocumentClassifierResponse Source #

Create a value of DescribeDocumentClassifierResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:documentClassifierProperties:DescribeDocumentClassifierResponse', describeDocumentClassifierResponse_documentClassifierProperties - An object that contains the properties associated with a document classifier.

$sel:httpStatus:DescribeDocumentClassifierResponse', describeDocumentClassifierResponse_httpStatus - The response's http status code.

DescribeDominantLanguageDetectionJob

data DescribeDominantLanguageDetectionJob Source #

Instances

Instances details
Eq DescribeDominantLanguageDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeDominantLanguageDetectionJob

Read DescribeDominantLanguageDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeDominantLanguageDetectionJob

Show DescribeDominantLanguageDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeDominantLanguageDetectionJob

Generic DescribeDominantLanguageDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeDominantLanguageDetectionJob

NFData DescribeDominantLanguageDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeDominantLanguageDetectionJob

Hashable DescribeDominantLanguageDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeDominantLanguageDetectionJob

ToJSON DescribeDominantLanguageDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeDominantLanguageDetectionJob

AWSRequest DescribeDominantLanguageDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeDominantLanguageDetectionJob

ToHeaders DescribeDominantLanguageDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeDominantLanguageDetectionJob

ToPath DescribeDominantLanguageDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeDominantLanguageDetectionJob

ToQuery DescribeDominantLanguageDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeDominantLanguageDetectionJob

type Rep DescribeDominantLanguageDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeDominantLanguageDetectionJob

type Rep DescribeDominantLanguageDetectionJob = D1 ('MetaData "DescribeDominantLanguageDetectionJob" "Amazonka.Comprehend.DescribeDominantLanguageDetectionJob" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "DescribeDominantLanguageDetectionJob'" 'PrefixI 'True) (S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DescribeDominantLanguageDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeDominantLanguageDetectionJob

newDescribeDominantLanguageDetectionJob Source #

Create a value of DescribeDominantLanguageDetectionJob with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:jobId:DescribeDominantLanguageDetectionJob', describeDominantLanguageDetectionJob_jobId - The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.

data DescribeDominantLanguageDetectionJobResponse Source #

Instances

Instances details
Eq DescribeDominantLanguageDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeDominantLanguageDetectionJob

Read DescribeDominantLanguageDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeDominantLanguageDetectionJob

Show DescribeDominantLanguageDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeDominantLanguageDetectionJob

Generic DescribeDominantLanguageDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeDominantLanguageDetectionJob

NFData DescribeDominantLanguageDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeDominantLanguageDetectionJob

type Rep DescribeDominantLanguageDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeDominantLanguageDetectionJob

type Rep DescribeDominantLanguageDetectionJobResponse = D1 ('MetaData "DescribeDominantLanguageDetectionJobResponse" "Amazonka.Comprehend.DescribeDominantLanguageDetectionJob" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "DescribeDominantLanguageDetectionJobResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dominantLanguageDetectionJobProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DominantLanguageDetectionJobProperties)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDescribeDominantLanguageDetectionJobResponse Source #

Create a value of DescribeDominantLanguageDetectionJobResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:dominantLanguageDetectionJobProperties:DescribeDominantLanguageDetectionJobResponse', describeDominantLanguageDetectionJobResponse_dominantLanguageDetectionJobProperties - An object that contains the properties associated with a dominant language detection job.

$sel:httpStatus:DescribeDominantLanguageDetectionJobResponse', describeDominantLanguageDetectionJobResponse_httpStatus - The response's http status code.

ListEntityRecognizerSummaries

data ListEntityRecognizerSummaries Source #

See: newListEntityRecognizerSummaries smart constructor.

Instances

Instances details
Eq ListEntityRecognizerSummaries Source # 
Instance details

Defined in Amazonka.Comprehend.ListEntityRecognizerSummaries

Read ListEntityRecognizerSummaries Source # 
Instance details

Defined in Amazonka.Comprehend.ListEntityRecognizerSummaries

Show ListEntityRecognizerSummaries Source # 
Instance details

Defined in Amazonka.Comprehend.ListEntityRecognizerSummaries

Generic ListEntityRecognizerSummaries Source # 
Instance details

Defined in Amazonka.Comprehend.ListEntityRecognizerSummaries

Associated Types

type Rep ListEntityRecognizerSummaries :: Type -> Type #

NFData ListEntityRecognizerSummaries Source # 
Instance details

Defined in Amazonka.Comprehend.ListEntityRecognizerSummaries

Hashable ListEntityRecognizerSummaries Source # 
Instance details

Defined in Amazonka.Comprehend.ListEntityRecognizerSummaries

ToJSON ListEntityRecognizerSummaries Source # 
Instance details

Defined in Amazonka.Comprehend.ListEntityRecognizerSummaries

AWSRequest ListEntityRecognizerSummaries Source # 
Instance details

Defined in Amazonka.Comprehend.ListEntityRecognizerSummaries

ToHeaders ListEntityRecognizerSummaries Source # 
Instance details

Defined in Amazonka.Comprehend.ListEntityRecognizerSummaries

ToPath ListEntityRecognizerSummaries Source # 
Instance details

Defined in Amazonka.Comprehend.ListEntityRecognizerSummaries

ToQuery ListEntityRecognizerSummaries Source # 
Instance details

Defined in Amazonka.Comprehend.ListEntityRecognizerSummaries

type Rep ListEntityRecognizerSummaries Source # 
Instance details

Defined in Amazonka.Comprehend.ListEntityRecognizerSummaries

type Rep ListEntityRecognizerSummaries = D1 ('MetaData "ListEntityRecognizerSummaries" "Amazonka.Comprehend.ListEntityRecognizerSummaries" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "ListEntityRecognizerSummaries'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))))
type AWSResponse ListEntityRecognizerSummaries Source # 
Instance details

Defined in Amazonka.Comprehend.ListEntityRecognizerSummaries

newListEntityRecognizerSummaries :: ListEntityRecognizerSummaries Source #

Create a value of ListEntityRecognizerSummaries with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:nextToken:ListEntityRecognizerSummaries', listEntityRecognizerSummaries_nextToken - Identifies the next page of results to return.

$sel:maxResults:ListEntityRecognizerSummaries', listEntityRecognizerSummaries_maxResults - The maximum number of results to return on each page. The default is 100.

data ListEntityRecognizerSummariesResponse Source #

Instances

Instances details
Eq ListEntityRecognizerSummariesResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ListEntityRecognizerSummaries

Read ListEntityRecognizerSummariesResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ListEntityRecognizerSummaries

Show ListEntityRecognizerSummariesResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ListEntityRecognizerSummaries

Generic ListEntityRecognizerSummariesResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ListEntityRecognizerSummaries

NFData ListEntityRecognizerSummariesResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ListEntityRecognizerSummaries

type Rep ListEntityRecognizerSummariesResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ListEntityRecognizerSummaries

type Rep ListEntityRecognizerSummariesResponse = D1 ('MetaData "ListEntityRecognizerSummariesResponse" "Amazonka.Comprehend.ListEntityRecognizerSummaries" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "ListEntityRecognizerSummariesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "entityRecognizerSummariesList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [EntityRecognizerSummary])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

StopEntitiesDetectionJob

data StopEntitiesDetectionJob Source #

See: newStopEntitiesDetectionJob smart constructor.

Instances

Instances details
Eq StopEntitiesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopEntitiesDetectionJob

Read StopEntitiesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopEntitiesDetectionJob

Show StopEntitiesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopEntitiesDetectionJob

Generic StopEntitiesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopEntitiesDetectionJob

Associated Types

type Rep StopEntitiesDetectionJob :: Type -> Type #

NFData StopEntitiesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopEntitiesDetectionJob

Hashable StopEntitiesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopEntitiesDetectionJob

ToJSON StopEntitiesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopEntitiesDetectionJob

AWSRequest StopEntitiesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopEntitiesDetectionJob

ToHeaders StopEntitiesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopEntitiesDetectionJob

ToPath StopEntitiesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopEntitiesDetectionJob

ToQuery StopEntitiesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopEntitiesDetectionJob

type Rep StopEntitiesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopEntitiesDetectionJob

type Rep StopEntitiesDetectionJob = D1 ('MetaData "StopEntitiesDetectionJob" "Amazonka.Comprehend.StopEntitiesDetectionJob" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "StopEntitiesDetectionJob'" 'PrefixI 'True) (S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse StopEntitiesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopEntitiesDetectionJob

newStopEntitiesDetectionJob Source #

Create a value of StopEntitiesDetectionJob with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:jobId:StopEntitiesDetectionJob', stopEntitiesDetectionJob_jobId - The identifier of the entities detection job to stop.

data StopEntitiesDetectionJobResponse Source #

See: newStopEntitiesDetectionJobResponse smart constructor.

Instances

Instances details
Eq StopEntitiesDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StopEntitiesDetectionJob

Read StopEntitiesDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StopEntitiesDetectionJob

Show StopEntitiesDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StopEntitiesDetectionJob

Generic StopEntitiesDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StopEntitiesDetectionJob

Associated Types

type Rep StopEntitiesDetectionJobResponse :: Type -> Type #

NFData StopEntitiesDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StopEntitiesDetectionJob

type Rep StopEntitiesDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StopEntitiesDetectionJob

type Rep StopEntitiesDetectionJobResponse = D1 ('MetaData "StopEntitiesDetectionJobResponse" "Amazonka.Comprehend.StopEntitiesDetectionJob" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "StopEntitiesDetectionJobResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "jobStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobStatus)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newStopEntitiesDetectionJobResponse Source #

Create a value of StopEntitiesDetectionJobResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:jobId:StopEntitiesDetectionJob', stopEntitiesDetectionJobResponse_jobId - The identifier of the entities detection job to stop.

$sel:jobStatus:StopEntitiesDetectionJobResponse', stopEntitiesDetectionJobResponse_jobStatus - Either STOP_REQUESTED if the job is currently running, or STOPPED if the job was previously stopped with the StopEntitiesDetectionJob operation.

$sel:httpStatus:StopEntitiesDetectionJobResponse', stopEntitiesDetectionJobResponse_httpStatus - The response's http status code.

StopTrainingEntityRecognizer

data StopTrainingEntityRecognizer Source #

See: newStopTrainingEntityRecognizer smart constructor.

Instances

Instances details
Eq StopTrainingEntityRecognizer Source # 
Instance details

Defined in Amazonka.Comprehend.StopTrainingEntityRecognizer

Read StopTrainingEntityRecognizer Source # 
Instance details

Defined in Amazonka.Comprehend.StopTrainingEntityRecognizer

Show StopTrainingEntityRecognizer Source # 
Instance details

Defined in Amazonka.Comprehend.StopTrainingEntityRecognizer

Generic StopTrainingEntityRecognizer Source # 
Instance details

Defined in Amazonka.Comprehend.StopTrainingEntityRecognizer

Associated Types

type Rep StopTrainingEntityRecognizer :: Type -> Type #

NFData StopTrainingEntityRecognizer Source # 
Instance details

Defined in Amazonka.Comprehend.StopTrainingEntityRecognizer

Hashable StopTrainingEntityRecognizer Source # 
Instance details

Defined in Amazonka.Comprehend.StopTrainingEntityRecognizer

ToJSON StopTrainingEntityRecognizer Source # 
Instance details

Defined in Amazonka.Comprehend.StopTrainingEntityRecognizer

AWSRequest StopTrainingEntityRecognizer Source # 
Instance details

Defined in Amazonka.Comprehend.StopTrainingEntityRecognizer

ToHeaders StopTrainingEntityRecognizer Source # 
Instance details

Defined in Amazonka.Comprehend.StopTrainingEntityRecognizer

ToPath StopTrainingEntityRecognizer Source # 
Instance details

Defined in Amazonka.Comprehend.StopTrainingEntityRecognizer

ToQuery StopTrainingEntityRecognizer Source # 
Instance details

Defined in Amazonka.Comprehend.StopTrainingEntityRecognizer

type Rep StopTrainingEntityRecognizer Source # 
Instance details

Defined in Amazonka.Comprehend.StopTrainingEntityRecognizer

type Rep StopTrainingEntityRecognizer = D1 ('MetaData "StopTrainingEntityRecognizer" "Amazonka.Comprehend.StopTrainingEntityRecognizer" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "StopTrainingEntityRecognizer'" 'PrefixI 'True) (S1 ('MetaSel ('Just "entityRecognizerArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse StopTrainingEntityRecognizer Source # 
Instance details

Defined in Amazonka.Comprehend.StopTrainingEntityRecognizer

newStopTrainingEntityRecognizer Source #

Create a value of StopTrainingEntityRecognizer with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:entityRecognizerArn:StopTrainingEntityRecognizer', stopTrainingEntityRecognizer_entityRecognizerArn - The Amazon Resource Name (ARN) that identifies the entity recognizer currently being trained.

data StopTrainingEntityRecognizerResponse Source #

Instances

Instances details
Eq StopTrainingEntityRecognizerResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StopTrainingEntityRecognizer

Read StopTrainingEntityRecognizerResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StopTrainingEntityRecognizer

Show StopTrainingEntityRecognizerResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StopTrainingEntityRecognizer

Generic StopTrainingEntityRecognizerResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StopTrainingEntityRecognizer

NFData StopTrainingEntityRecognizerResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StopTrainingEntityRecognizer

type Rep StopTrainingEntityRecognizerResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StopTrainingEntityRecognizer

type Rep StopTrainingEntityRecognizerResponse = D1 ('MetaData "StopTrainingEntityRecognizerResponse" "Amazonka.Comprehend.StopTrainingEntityRecognizer" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "StopTrainingEntityRecognizerResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newStopTrainingEntityRecognizerResponse Source #

Create a value of StopTrainingEntityRecognizerResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:StopTrainingEntityRecognizerResponse', stopTrainingEntityRecognizerResponse_httpStatus - The response's http status code.

StartPiiEntitiesDetectionJob

data StartPiiEntitiesDetectionJob Source #

See: newStartPiiEntitiesDetectionJob smart constructor.

Instances

Instances details
Eq StartPiiEntitiesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartPiiEntitiesDetectionJob

Read StartPiiEntitiesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartPiiEntitiesDetectionJob

Show StartPiiEntitiesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartPiiEntitiesDetectionJob

Generic StartPiiEntitiesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartPiiEntitiesDetectionJob

Associated Types

type Rep StartPiiEntitiesDetectionJob :: Type -> Type #

NFData StartPiiEntitiesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartPiiEntitiesDetectionJob

Hashable StartPiiEntitiesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartPiiEntitiesDetectionJob

ToJSON StartPiiEntitiesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartPiiEntitiesDetectionJob

AWSRequest StartPiiEntitiesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartPiiEntitiesDetectionJob

ToHeaders StartPiiEntitiesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartPiiEntitiesDetectionJob

ToPath StartPiiEntitiesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartPiiEntitiesDetectionJob

ToQuery StartPiiEntitiesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartPiiEntitiesDetectionJob

type Rep StartPiiEntitiesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartPiiEntitiesDetectionJob

type AWSResponse StartPiiEntitiesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartPiiEntitiesDetectionJob

newStartPiiEntitiesDetectionJob Source #

Create a value of StartPiiEntitiesDetectionJob with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:jobName:StartPiiEntitiesDetectionJob', startPiiEntitiesDetectionJob_jobName - The identifier of the job.

$sel:redactionConfig:StartPiiEntitiesDetectionJob', startPiiEntitiesDetectionJob_redactionConfig - 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.

$sel:clientRequestToken:StartPiiEntitiesDetectionJob', startPiiEntitiesDetectionJob_clientRequestToken - A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

$sel:tags:StartPiiEntitiesDetectionJob', startPiiEntitiesDetectionJob_tags - Tags to be associated with the PII entities detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.

$sel:inputDataConfig:StartPiiEntitiesDetectionJob', startPiiEntitiesDetectionJob_inputDataConfig - The input properties for a PII entities detection job.

$sel:outputDataConfig:StartPiiEntitiesDetectionJob', startPiiEntitiesDetectionJob_outputDataConfig - Provides configuration parameters for the output of PII entity detection jobs.

$sel:mode:StartPiiEntitiesDetectionJob', startPiiEntitiesDetectionJob_mode - Specifies whether the output provides the locations (offsets) of PII entities or a file in which PII entities are redacted.

$sel:dataAccessRoleArn:StartPiiEntitiesDetectionJob', startPiiEntitiesDetectionJob_dataAccessRoleArn - The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.

$sel:languageCode:StartPiiEntitiesDetectionJob', startPiiEntitiesDetectionJob_languageCode - The language of the input documents.

data StartPiiEntitiesDetectionJobResponse Source #

Instances

Instances details
Eq StartPiiEntitiesDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StartPiiEntitiesDetectionJob

Read StartPiiEntitiesDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StartPiiEntitiesDetectionJob

Show StartPiiEntitiesDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StartPiiEntitiesDetectionJob

Generic StartPiiEntitiesDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StartPiiEntitiesDetectionJob

NFData StartPiiEntitiesDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StartPiiEntitiesDetectionJob

type Rep StartPiiEntitiesDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StartPiiEntitiesDetectionJob

type Rep StartPiiEntitiesDetectionJobResponse = D1 ('MetaData "StartPiiEntitiesDetectionJobResponse" "Amazonka.Comprehend.StartPiiEntitiesDetectionJob" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "StartPiiEntitiesDetectionJobResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "jobArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "jobStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobStatus)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newStartPiiEntitiesDetectionJobResponse Source #

Create a value of StartPiiEntitiesDetectionJobResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:jobId:StartPiiEntitiesDetectionJobResponse', startPiiEntitiesDetectionJobResponse_jobId - The identifier generated for the job.

$sel:jobArn:StartPiiEntitiesDetectionJobResponse', startPiiEntitiesDetectionJobResponse_jobArn - The Amazon Resource Name (ARN) of the PII entity detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:

arn:<partition>:comprehend:<region>:<account-id>:pii-entities-detection-job/<job-id>

The following is an example job ARN:

arn:aws:comprehend:us-west-2:111122223333:pii-entities-detection-job/1234abcd12ab34cd56ef1234567890ab

$sel:jobStatus:StartPiiEntitiesDetectionJobResponse', startPiiEntitiesDetectionJobResponse_jobStatus - The status of the job.

$sel:httpStatus:StartPiiEntitiesDetectionJobResponse', startPiiEntitiesDetectionJobResponse_httpStatus - The response's http status code.

ListKeyPhrasesDetectionJobs (Paginated)

data ListKeyPhrasesDetectionJobs Source #

See: newListKeyPhrasesDetectionJobs smart constructor.

Instances

Instances details
Eq ListKeyPhrasesDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListKeyPhrasesDetectionJobs

Read ListKeyPhrasesDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListKeyPhrasesDetectionJobs

Show ListKeyPhrasesDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListKeyPhrasesDetectionJobs

Generic ListKeyPhrasesDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListKeyPhrasesDetectionJobs

Associated Types

type Rep ListKeyPhrasesDetectionJobs :: Type -> Type #

NFData ListKeyPhrasesDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListKeyPhrasesDetectionJobs

Hashable ListKeyPhrasesDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListKeyPhrasesDetectionJobs

ToJSON ListKeyPhrasesDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListKeyPhrasesDetectionJobs

AWSPager ListKeyPhrasesDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListKeyPhrasesDetectionJobs

AWSRequest ListKeyPhrasesDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListKeyPhrasesDetectionJobs

ToHeaders ListKeyPhrasesDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListKeyPhrasesDetectionJobs

ToPath ListKeyPhrasesDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListKeyPhrasesDetectionJobs

ToQuery ListKeyPhrasesDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListKeyPhrasesDetectionJobs

type Rep ListKeyPhrasesDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListKeyPhrasesDetectionJobs

type Rep ListKeyPhrasesDetectionJobs = D1 ('MetaData "ListKeyPhrasesDetectionJobs" "Amazonka.Comprehend.ListKeyPhrasesDetectionJobs" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "ListKeyPhrasesDetectionJobs'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "filter'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe KeyPhrasesDetectionJobFilter)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))))
type AWSResponse ListKeyPhrasesDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListKeyPhrasesDetectionJobs

newListKeyPhrasesDetectionJobs :: ListKeyPhrasesDetectionJobs Source #

Create a value of ListKeyPhrasesDetectionJobs with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:nextToken:ListKeyPhrasesDetectionJobs', listKeyPhrasesDetectionJobs_nextToken - Identifies the next page of results to return.

$sel:filter':ListKeyPhrasesDetectionJobs', listKeyPhrasesDetectionJobs_filter - 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.

$sel:maxResults:ListKeyPhrasesDetectionJobs', listKeyPhrasesDetectionJobs_maxResults - The maximum number of results to return in each page. The default is 100.

data ListKeyPhrasesDetectionJobsResponse Source #

Instances

Instances details
Eq ListKeyPhrasesDetectionJobsResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ListKeyPhrasesDetectionJobs

Read ListKeyPhrasesDetectionJobsResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ListKeyPhrasesDetectionJobs

Show ListKeyPhrasesDetectionJobsResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ListKeyPhrasesDetectionJobs

Generic ListKeyPhrasesDetectionJobsResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ListKeyPhrasesDetectionJobs

NFData ListKeyPhrasesDetectionJobsResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ListKeyPhrasesDetectionJobs

type Rep ListKeyPhrasesDetectionJobsResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ListKeyPhrasesDetectionJobs

type Rep ListKeyPhrasesDetectionJobsResponse = D1 ('MetaData "ListKeyPhrasesDetectionJobsResponse" "Amazonka.Comprehend.ListKeyPhrasesDetectionJobs" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "ListKeyPhrasesDetectionJobsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "keyPhrasesDetectionJobPropertiesList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [KeyPhrasesDetectionJobProperties])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListKeyPhrasesDetectionJobsResponse Source #

Create a value of ListKeyPhrasesDetectionJobsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:keyPhrasesDetectionJobPropertiesList:ListKeyPhrasesDetectionJobsResponse', listKeyPhrasesDetectionJobsResponse_keyPhrasesDetectionJobPropertiesList - A list containing the properties of each job that is returned.

$sel:nextToken:ListKeyPhrasesDetectionJobs', listKeyPhrasesDetectionJobsResponse_nextToken - Identifies the next page of results to return.

$sel:httpStatus:ListKeyPhrasesDetectionJobsResponse', listKeyPhrasesDetectionJobsResponse_httpStatus - The response's http status code.

DescribeEntitiesDetectionJob

data DescribeEntitiesDetectionJob Source #

See: newDescribeEntitiesDetectionJob smart constructor.

Instances

Instances details
Eq DescribeEntitiesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeEntitiesDetectionJob

Read DescribeEntitiesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeEntitiesDetectionJob

Show DescribeEntitiesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeEntitiesDetectionJob

Generic DescribeEntitiesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeEntitiesDetectionJob

Associated Types

type Rep DescribeEntitiesDetectionJob :: Type -> Type #

NFData DescribeEntitiesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeEntitiesDetectionJob

Hashable DescribeEntitiesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeEntitiesDetectionJob

ToJSON DescribeEntitiesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeEntitiesDetectionJob

AWSRequest DescribeEntitiesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeEntitiesDetectionJob

ToHeaders DescribeEntitiesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeEntitiesDetectionJob

ToPath DescribeEntitiesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeEntitiesDetectionJob

ToQuery DescribeEntitiesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeEntitiesDetectionJob

type Rep DescribeEntitiesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeEntitiesDetectionJob

type Rep DescribeEntitiesDetectionJob = D1 ('MetaData "DescribeEntitiesDetectionJob" "Amazonka.Comprehend.DescribeEntitiesDetectionJob" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "DescribeEntitiesDetectionJob'" 'PrefixI 'True) (S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DescribeEntitiesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeEntitiesDetectionJob

newDescribeEntitiesDetectionJob Source #

Create a value of DescribeEntitiesDetectionJob with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:jobId:DescribeEntitiesDetectionJob', describeEntitiesDetectionJob_jobId - The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.

data DescribeEntitiesDetectionJobResponse Source #

Instances

Instances details
Eq DescribeEntitiesDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeEntitiesDetectionJob

Read DescribeEntitiesDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeEntitiesDetectionJob

Show DescribeEntitiesDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeEntitiesDetectionJob

Generic DescribeEntitiesDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeEntitiesDetectionJob

NFData DescribeEntitiesDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeEntitiesDetectionJob

type Rep DescribeEntitiesDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeEntitiesDetectionJob

type Rep DescribeEntitiesDetectionJobResponse = D1 ('MetaData "DescribeEntitiesDetectionJobResponse" "Amazonka.Comprehend.DescribeEntitiesDetectionJob" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "DescribeEntitiesDetectionJobResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "entitiesDetectionJobProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EntitiesDetectionJobProperties)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDescribeEntitiesDetectionJobResponse Source #

Create a value of DescribeEntitiesDetectionJobResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:entitiesDetectionJobProperties:DescribeEntitiesDetectionJobResponse', describeEntitiesDetectionJobResponse_entitiesDetectionJobProperties - An object that contains the properties associated with an entities detection job.

$sel:httpStatus:DescribeEntitiesDetectionJobResponse', describeEntitiesDetectionJobResponse_httpStatus - The response's http status code.

ListDocumentClassifierSummaries

data ListDocumentClassifierSummaries Source #

See: newListDocumentClassifierSummaries smart constructor.

Instances

Instances details
Eq ListDocumentClassifierSummaries Source # 
Instance details

Defined in Amazonka.Comprehend.ListDocumentClassifierSummaries

Read ListDocumentClassifierSummaries Source # 
Instance details

Defined in Amazonka.Comprehend.ListDocumentClassifierSummaries

Show ListDocumentClassifierSummaries Source # 
Instance details

Defined in Amazonka.Comprehend.ListDocumentClassifierSummaries

Generic ListDocumentClassifierSummaries Source # 
Instance details

Defined in Amazonka.Comprehend.ListDocumentClassifierSummaries

Associated Types

type Rep ListDocumentClassifierSummaries :: Type -> Type #

NFData ListDocumentClassifierSummaries Source # 
Instance details

Defined in Amazonka.Comprehend.ListDocumentClassifierSummaries

Hashable ListDocumentClassifierSummaries Source # 
Instance details

Defined in Amazonka.Comprehend.ListDocumentClassifierSummaries

ToJSON ListDocumentClassifierSummaries Source # 
Instance details

Defined in Amazonka.Comprehend.ListDocumentClassifierSummaries

AWSRequest ListDocumentClassifierSummaries Source # 
Instance details

Defined in Amazonka.Comprehend.ListDocumentClassifierSummaries

ToHeaders ListDocumentClassifierSummaries Source # 
Instance details

Defined in Amazonka.Comprehend.ListDocumentClassifierSummaries

ToPath ListDocumentClassifierSummaries Source # 
Instance details

Defined in Amazonka.Comprehend.ListDocumentClassifierSummaries

ToQuery ListDocumentClassifierSummaries Source # 
Instance details

Defined in Amazonka.Comprehend.ListDocumentClassifierSummaries

type Rep ListDocumentClassifierSummaries Source # 
Instance details

Defined in Amazonka.Comprehend.ListDocumentClassifierSummaries

type Rep ListDocumentClassifierSummaries = D1 ('MetaData "ListDocumentClassifierSummaries" "Amazonka.Comprehend.ListDocumentClassifierSummaries" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "ListDocumentClassifierSummaries'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))))
type AWSResponse ListDocumentClassifierSummaries Source # 
Instance details

Defined in Amazonka.Comprehend.ListDocumentClassifierSummaries

newListDocumentClassifierSummaries :: ListDocumentClassifierSummaries Source #

Create a value of ListDocumentClassifierSummaries with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:nextToken:ListDocumentClassifierSummaries', listDocumentClassifierSummaries_nextToken - Identifies the next page of results to return.

$sel:maxResults:ListDocumentClassifierSummaries', listDocumentClassifierSummaries_maxResults - The maximum number of results to return on each page. The default is 100.

data ListDocumentClassifierSummariesResponse Source #

Instances

Instances details
Eq ListDocumentClassifierSummariesResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ListDocumentClassifierSummaries

Read ListDocumentClassifierSummariesResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ListDocumentClassifierSummaries

Show ListDocumentClassifierSummariesResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ListDocumentClassifierSummaries

Generic ListDocumentClassifierSummariesResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ListDocumentClassifierSummaries

NFData ListDocumentClassifierSummariesResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ListDocumentClassifierSummaries

type Rep ListDocumentClassifierSummariesResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ListDocumentClassifierSummaries

type Rep ListDocumentClassifierSummariesResponse = D1 ('MetaData "ListDocumentClassifierSummariesResponse" "Amazonka.Comprehend.ListDocumentClassifierSummaries" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "ListDocumentClassifierSummariesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "documentClassifierSummariesList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DocumentClassifierSummary])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

StopDominantLanguageDetectionJob

data StopDominantLanguageDetectionJob Source #

See: newStopDominantLanguageDetectionJob smart constructor.

Instances

Instances details
Eq StopDominantLanguageDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopDominantLanguageDetectionJob

Read StopDominantLanguageDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopDominantLanguageDetectionJob

Show StopDominantLanguageDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopDominantLanguageDetectionJob

Generic StopDominantLanguageDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopDominantLanguageDetectionJob

Associated Types

type Rep StopDominantLanguageDetectionJob :: Type -> Type #

NFData StopDominantLanguageDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopDominantLanguageDetectionJob

Hashable StopDominantLanguageDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopDominantLanguageDetectionJob

ToJSON StopDominantLanguageDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopDominantLanguageDetectionJob

AWSRequest StopDominantLanguageDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopDominantLanguageDetectionJob

ToHeaders StopDominantLanguageDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopDominantLanguageDetectionJob

ToPath StopDominantLanguageDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopDominantLanguageDetectionJob

ToQuery StopDominantLanguageDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopDominantLanguageDetectionJob

type Rep StopDominantLanguageDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopDominantLanguageDetectionJob

type Rep StopDominantLanguageDetectionJob = D1 ('MetaData "StopDominantLanguageDetectionJob" "Amazonka.Comprehend.StopDominantLanguageDetectionJob" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "StopDominantLanguageDetectionJob'" 'PrefixI 'True) (S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse StopDominantLanguageDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopDominantLanguageDetectionJob

newStopDominantLanguageDetectionJob Source #

Create a value of StopDominantLanguageDetectionJob with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:jobId:StopDominantLanguageDetectionJob', stopDominantLanguageDetectionJob_jobId - The identifier of the dominant language detection job to stop.

data StopDominantLanguageDetectionJobResponse Source #

Instances

Instances details
Eq StopDominantLanguageDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StopDominantLanguageDetectionJob

Read StopDominantLanguageDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StopDominantLanguageDetectionJob

Show StopDominantLanguageDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StopDominantLanguageDetectionJob

Generic StopDominantLanguageDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StopDominantLanguageDetectionJob

NFData StopDominantLanguageDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StopDominantLanguageDetectionJob

type Rep StopDominantLanguageDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StopDominantLanguageDetectionJob

type Rep StopDominantLanguageDetectionJobResponse = D1 ('MetaData "StopDominantLanguageDetectionJobResponse" "Amazonka.Comprehend.StopDominantLanguageDetectionJob" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "StopDominantLanguageDetectionJobResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "jobStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobStatus)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newStopDominantLanguageDetectionJobResponse Source #

Create a value of StopDominantLanguageDetectionJobResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:jobId:StopDominantLanguageDetectionJob', stopDominantLanguageDetectionJobResponse_jobId - The identifier of the dominant language detection job to stop.

$sel:jobStatus:StopDominantLanguageDetectionJobResponse', stopDominantLanguageDetectionJobResponse_jobStatus - Either STOP_REQUESTED if the job is currently running, or STOPPED if the job was previously stopped with the StopDominantLanguageDetectionJob operation.

$sel:httpStatus:StopDominantLanguageDetectionJobResponse', stopDominantLanguageDetectionJobResponse_httpStatus - The response's http status code.

TagResource

data TagResource Source #

See: newTagResource smart constructor.

Constructors

TagResource' Text [Tag] 

Instances

Instances details
Eq TagResource Source # 
Instance details

Defined in Amazonka.Comprehend.TagResource

Read TagResource Source # 
Instance details

Defined in Amazonka.Comprehend.TagResource

Show TagResource Source # 
Instance details

Defined in Amazonka.Comprehend.TagResource

Generic TagResource Source # 
Instance details

Defined in Amazonka.Comprehend.TagResource

Associated Types

type Rep TagResource :: Type -> Type #

NFData TagResource Source # 
Instance details

Defined in Amazonka.Comprehend.TagResource

Methods

rnf :: TagResource -> () #

Hashable TagResource Source # 
Instance details

Defined in Amazonka.Comprehend.TagResource

ToJSON TagResource Source # 
Instance details

Defined in Amazonka.Comprehend.TagResource

AWSRequest TagResource Source # 
Instance details

Defined in Amazonka.Comprehend.TagResource

Associated Types

type AWSResponse TagResource #

ToHeaders TagResource Source # 
Instance details

Defined in Amazonka.Comprehend.TagResource

Methods

toHeaders :: TagResource -> [Header] #

ToPath TagResource Source # 
Instance details

Defined in Amazonka.Comprehend.TagResource

ToQuery TagResource Source # 
Instance details

Defined in Amazonka.Comprehend.TagResource

type Rep TagResource Source # 
Instance details

Defined in Amazonka.Comprehend.TagResource

type Rep TagResource = D1 ('MetaData "TagResource" "Amazonka.Comprehend.TagResource" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "TagResource'" 'PrefixI 'True) (S1 ('MetaSel ('Just "resourceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Tag])))
type AWSResponse TagResource Source # 
Instance details

Defined in Amazonka.Comprehend.TagResource

newTagResource Source #

Create a value of TagResource with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:resourceArn:TagResource', tagResource_resourceArn - The Amazon Resource Name (ARN) of the given Amazon Comprehend resource to which you want to associate the tags.

$sel:tags:TagResource', tagResource_tags - Tags being associated with a specific Amazon Comprehend resource. There can be a maximum of 50 tags (both existing and pending) associated with a specific resource.

data TagResourceResponse Source #

See: newTagResourceResponse smart constructor.

Instances

Instances details
Eq TagResourceResponse Source # 
Instance details

Defined in Amazonka.Comprehend.TagResource

Read TagResourceResponse Source # 
Instance details

Defined in Amazonka.Comprehend.TagResource

Show TagResourceResponse Source # 
Instance details

Defined in Amazonka.Comprehend.TagResource

Generic TagResourceResponse Source # 
Instance details

Defined in Amazonka.Comprehend.TagResource

Associated Types

type Rep TagResourceResponse :: Type -> Type #

NFData TagResourceResponse Source # 
Instance details

Defined in Amazonka.Comprehend.TagResource

Methods

rnf :: TagResourceResponse -> () #

type Rep TagResourceResponse Source # 
Instance details

Defined in Amazonka.Comprehend.TagResource

type Rep TagResourceResponse = D1 ('MetaData "TagResourceResponse" "Amazonka.Comprehend.TagResource" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "TagResourceResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newTagResourceResponse Source #

Create a value of TagResourceResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:TagResourceResponse', tagResourceResponse_httpStatus - The response's http status code.

DescribePiiEntitiesDetectionJob

data DescribePiiEntitiesDetectionJob Source #

See: newDescribePiiEntitiesDetectionJob smart constructor.

Instances

Instances details
Eq DescribePiiEntitiesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.DescribePiiEntitiesDetectionJob

Read DescribePiiEntitiesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.DescribePiiEntitiesDetectionJob

Show DescribePiiEntitiesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.DescribePiiEntitiesDetectionJob

Generic DescribePiiEntitiesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.DescribePiiEntitiesDetectionJob

Associated Types

type Rep DescribePiiEntitiesDetectionJob :: Type -> Type #

NFData DescribePiiEntitiesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.DescribePiiEntitiesDetectionJob

Hashable DescribePiiEntitiesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.DescribePiiEntitiesDetectionJob

ToJSON DescribePiiEntitiesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.DescribePiiEntitiesDetectionJob

AWSRequest DescribePiiEntitiesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.DescribePiiEntitiesDetectionJob

ToHeaders DescribePiiEntitiesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.DescribePiiEntitiesDetectionJob

ToPath DescribePiiEntitiesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.DescribePiiEntitiesDetectionJob

ToQuery DescribePiiEntitiesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.DescribePiiEntitiesDetectionJob

type Rep DescribePiiEntitiesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.DescribePiiEntitiesDetectionJob

type Rep DescribePiiEntitiesDetectionJob = D1 ('MetaData "DescribePiiEntitiesDetectionJob" "Amazonka.Comprehend.DescribePiiEntitiesDetectionJob" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "DescribePiiEntitiesDetectionJob'" 'PrefixI 'True) (S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DescribePiiEntitiesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.DescribePiiEntitiesDetectionJob

newDescribePiiEntitiesDetectionJob Source #

Create a value of DescribePiiEntitiesDetectionJob with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:jobId:DescribePiiEntitiesDetectionJob', describePiiEntitiesDetectionJob_jobId - The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.

data DescribePiiEntitiesDetectionJobResponse Source #

Instances

Instances details
Eq DescribePiiEntitiesDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DescribePiiEntitiesDetectionJob

Read DescribePiiEntitiesDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DescribePiiEntitiesDetectionJob

Show DescribePiiEntitiesDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DescribePiiEntitiesDetectionJob

Generic DescribePiiEntitiesDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DescribePiiEntitiesDetectionJob

NFData DescribePiiEntitiesDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DescribePiiEntitiesDetectionJob

type Rep DescribePiiEntitiesDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DescribePiiEntitiesDetectionJob

type Rep DescribePiiEntitiesDetectionJobResponse = D1 ('MetaData "DescribePiiEntitiesDetectionJobResponse" "Amazonka.Comprehend.DescribePiiEntitiesDetectionJob" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "DescribePiiEntitiesDetectionJobResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "piiEntitiesDetectionJobProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PiiEntitiesDetectionJobProperties)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

ListTopicsDetectionJobs (Paginated)

data ListTopicsDetectionJobs Source #

See: newListTopicsDetectionJobs smart constructor.

Instances

Instances details
Eq ListTopicsDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListTopicsDetectionJobs

Read ListTopicsDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListTopicsDetectionJobs

Show ListTopicsDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListTopicsDetectionJobs

Generic ListTopicsDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListTopicsDetectionJobs

Associated Types

type Rep ListTopicsDetectionJobs :: Type -> Type #

NFData ListTopicsDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListTopicsDetectionJobs

Methods

rnf :: ListTopicsDetectionJobs -> () #

Hashable ListTopicsDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListTopicsDetectionJobs

ToJSON ListTopicsDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListTopicsDetectionJobs

AWSPager ListTopicsDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListTopicsDetectionJobs

AWSRequest ListTopicsDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListTopicsDetectionJobs

ToHeaders ListTopicsDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListTopicsDetectionJobs

ToPath ListTopicsDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListTopicsDetectionJobs

ToQuery ListTopicsDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListTopicsDetectionJobs

type Rep ListTopicsDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListTopicsDetectionJobs

type Rep ListTopicsDetectionJobs = D1 ('MetaData "ListTopicsDetectionJobs" "Amazonka.Comprehend.ListTopicsDetectionJobs" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "ListTopicsDetectionJobs'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "filter'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TopicsDetectionJobFilter)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))))
type AWSResponse ListTopicsDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListTopicsDetectionJobs

newListTopicsDetectionJobs :: ListTopicsDetectionJobs Source #

Create a value of ListTopicsDetectionJobs with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:nextToken:ListTopicsDetectionJobs', listTopicsDetectionJobs_nextToken - Identifies the next page of results to return.

$sel:filter':ListTopicsDetectionJobs', listTopicsDetectionJobs_filter - 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.

$sel:maxResults:ListTopicsDetectionJobs', listTopicsDetectionJobs_maxResults - The maximum number of results to return in each page. The default is 100.

data ListTopicsDetectionJobsResponse Source #

See: newListTopicsDetectionJobsResponse smart constructor.

Instances

Instances details
Eq ListTopicsDetectionJobsResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ListTopicsDetectionJobs

Read ListTopicsDetectionJobsResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ListTopicsDetectionJobs

Show ListTopicsDetectionJobsResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ListTopicsDetectionJobs

Generic ListTopicsDetectionJobsResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ListTopicsDetectionJobs

Associated Types

type Rep ListTopicsDetectionJobsResponse :: Type -> Type #

NFData ListTopicsDetectionJobsResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ListTopicsDetectionJobs

type Rep ListTopicsDetectionJobsResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ListTopicsDetectionJobs

type Rep ListTopicsDetectionJobsResponse = D1 ('MetaData "ListTopicsDetectionJobsResponse" "Amazonka.Comprehend.ListTopicsDetectionJobs" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "ListTopicsDetectionJobsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "topicsDetectionJobPropertiesList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [TopicsDetectionJobProperties])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListTopicsDetectionJobsResponse Source #

Create a value of ListTopicsDetectionJobsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:nextToken:ListTopicsDetectionJobs', listTopicsDetectionJobsResponse_nextToken - Identifies the next page of results to return.

$sel:topicsDetectionJobPropertiesList:ListTopicsDetectionJobsResponse', listTopicsDetectionJobsResponse_topicsDetectionJobPropertiesList - A list containing the properties of each job that is returned.

$sel:httpStatus:ListTopicsDetectionJobsResponse', listTopicsDetectionJobsResponse_httpStatus - The response's http status code.

UntagResource

data UntagResource Source #

See: newUntagResource smart constructor.

Constructors

UntagResource' Text [Text] 

Instances

Instances details
Eq UntagResource Source # 
Instance details

Defined in Amazonka.Comprehend.UntagResource

Read UntagResource Source # 
Instance details

Defined in Amazonka.Comprehend.UntagResource

Show UntagResource Source # 
Instance details

Defined in Amazonka.Comprehend.UntagResource

Generic UntagResource Source # 
Instance details

Defined in Amazonka.Comprehend.UntagResource

Associated Types

type Rep UntagResource :: Type -> Type #

NFData UntagResource Source # 
Instance details

Defined in Amazonka.Comprehend.UntagResource

Methods

rnf :: UntagResource -> () #

Hashable UntagResource Source # 
Instance details

Defined in Amazonka.Comprehend.UntagResource

ToJSON UntagResource Source # 
Instance details

Defined in Amazonka.Comprehend.UntagResource

AWSRequest UntagResource Source # 
Instance details

Defined in Amazonka.Comprehend.UntagResource

Associated Types

type AWSResponse UntagResource #

ToHeaders UntagResource Source # 
Instance details

Defined in Amazonka.Comprehend.UntagResource

ToPath UntagResource Source # 
Instance details

Defined in Amazonka.Comprehend.UntagResource

ToQuery UntagResource Source # 
Instance details

Defined in Amazonka.Comprehend.UntagResource

type Rep UntagResource Source # 
Instance details

Defined in Amazonka.Comprehend.UntagResource

type Rep UntagResource = D1 ('MetaData "UntagResource" "Amazonka.Comprehend.UntagResource" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "UntagResource'" 'PrefixI 'True) (S1 ('MetaSel ('Just "resourceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "tagKeys") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text])))
type AWSResponse UntagResource Source # 
Instance details

Defined in Amazonka.Comprehend.UntagResource

newUntagResource Source #

Create a value of UntagResource with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:resourceArn:UntagResource', untagResource_resourceArn - The Amazon Resource Name (ARN) of the given Amazon Comprehend resource from which you want to remove the tags.

$sel:tagKeys:UntagResource', untagResource_tagKeys - 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.

data UntagResourceResponse Source #

See: newUntagResourceResponse smart constructor.

Instances

Instances details
Eq UntagResourceResponse Source # 
Instance details

Defined in Amazonka.Comprehend.UntagResource

Read UntagResourceResponse Source # 
Instance details

Defined in Amazonka.Comprehend.UntagResource

Show UntagResourceResponse Source # 
Instance details

Defined in Amazonka.Comprehend.UntagResource

Generic UntagResourceResponse Source # 
Instance details

Defined in Amazonka.Comprehend.UntagResource

Associated Types

type Rep UntagResourceResponse :: Type -> Type #

NFData UntagResourceResponse Source # 
Instance details

Defined in Amazonka.Comprehend.UntagResource

Methods

rnf :: UntagResourceResponse -> () #

type Rep UntagResourceResponse Source # 
Instance details

Defined in Amazonka.Comprehend.UntagResource

type Rep UntagResourceResponse = D1 ('MetaData "UntagResourceResponse" "Amazonka.Comprehend.UntagResource" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "UntagResourceResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newUntagResourceResponse Source #

Create a value of UntagResourceResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:UntagResourceResponse', untagResourceResponse_httpStatus - The response's http status code.

BatchDetectDominantLanguage

data BatchDetectDominantLanguage Source #

See: newBatchDetectDominantLanguage smart constructor.

Instances

Instances details
Eq BatchDetectDominantLanguage Source # 
Instance details

Defined in Amazonka.Comprehend.BatchDetectDominantLanguage

Show BatchDetectDominantLanguage Source # 
Instance details

Defined in Amazonka.Comprehend.BatchDetectDominantLanguage

Generic BatchDetectDominantLanguage Source # 
Instance details

Defined in Amazonka.Comprehend.BatchDetectDominantLanguage

Associated Types

type Rep BatchDetectDominantLanguage :: Type -> Type #

NFData BatchDetectDominantLanguage Source # 
Instance details

Defined in Amazonka.Comprehend.BatchDetectDominantLanguage

Hashable BatchDetectDominantLanguage Source # 
Instance details

Defined in Amazonka.Comprehend.BatchDetectDominantLanguage

ToJSON BatchDetectDominantLanguage Source # 
Instance details

Defined in Amazonka.Comprehend.BatchDetectDominantLanguage

AWSRequest BatchDetectDominantLanguage Source # 
Instance details

Defined in Amazonka.Comprehend.BatchDetectDominantLanguage

ToHeaders BatchDetectDominantLanguage Source # 
Instance details

Defined in Amazonka.Comprehend.BatchDetectDominantLanguage

ToPath BatchDetectDominantLanguage Source # 
Instance details

Defined in Amazonka.Comprehend.BatchDetectDominantLanguage

ToQuery BatchDetectDominantLanguage Source # 
Instance details

Defined in Amazonka.Comprehend.BatchDetectDominantLanguage

type Rep BatchDetectDominantLanguage Source # 
Instance details

Defined in Amazonka.Comprehend.BatchDetectDominantLanguage

type Rep BatchDetectDominantLanguage = D1 ('MetaData "BatchDetectDominantLanguage" "Amazonka.Comprehend.BatchDetectDominantLanguage" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "BatchDetectDominantLanguage'" 'PrefixI 'True) (S1 ('MetaSel ('Just "textList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive [Sensitive Text]))))
type AWSResponse BatchDetectDominantLanguage Source # 
Instance details

Defined in Amazonka.Comprehend.BatchDetectDominantLanguage

newBatchDetectDominantLanguage :: BatchDetectDominantLanguage Source #

Create a value of BatchDetectDominantLanguage with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:textList:BatchDetectDominantLanguage', batchDetectDominantLanguage_textList - A list containing the text of the input documents. The list can contain a maximum of 25 documents. Each document should contain at least 20 characters and must contain fewer than 5,000 bytes of UTF-8 encoded characters.

data BatchDetectDominantLanguageResponse Source #

Instances

Instances details
Eq BatchDetectDominantLanguageResponse Source # 
Instance details

Defined in Amazonka.Comprehend.BatchDetectDominantLanguage

Show BatchDetectDominantLanguageResponse Source # 
Instance details

Defined in Amazonka.Comprehend.BatchDetectDominantLanguage

Generic BatchDetectDominantLanguageResponse Source # 
Instance details

Defined in Amazonka.Comprehend.BatchDetectDominantLanguage

NFData BatchDetectDominantLanguageResponse Source # 
Instance details

Defined in Amazonka.Comprehend.BatchDetectDominantLanguage

type Rep BatchDetectDominantLanguageResponse Source # 
Instance details

Defined in Amazonka.Comprehend.BatchDetectDominantLanguage

type Rep BatchDetectDominantLanguageResponse = D1 ('MetaData "BatchDetectDominantLanguageResponse" "Amazonka.Comprehend.BatchDetectDominantLanguage" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "BatchDetectDominantLanguageResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: (S1 ('MetaSel ('Just "resultList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [BatchDetectDominantLanguageItemResult]) :*: S1 ('MetaSel ('Just "errorList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [BatchItemError]))))

newBatchDetectDominantLanguageResponse Source #

Create a value of BatchDetectDominantLanguageResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:BatchDetectDominantLanguageResponse', batchDetectDominantLanguageResponse_httpStatus - The response's http status code.

$sel:resultList:BatchDetectDominantLanguageResponse', batchDetectDominantLanguageResponse_resultList - 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.

$sel:errorList:BatchDetectDominantLanguageResponse', batchDetectDominantLanguageResponse_errorList - 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.

StartDocumentClassificationJob

data StartDocumentClassificationJob Source #

See: newStartDocumentClassificationJob smart constructor.

Instances

Instances details
Eq StartDocumentClassificationJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartDocumentClassificationJob

Read StartDocumentClassificationJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartDocumentClassificationJob

Show StartDocumentClassificationJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartDocumentClassificationJob

Generic StartDocumentClassificationJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartDocumentClassificationJob

Associated Types

type Rep StartDocumentClassificationJob :: Type -> Type #

NFData StartDocumentClassificationJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartDocumentClassificationJob

Hashable StartDocumentClassificationJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartDocumentClassificationJob

ToJSON StartDocumentClassificationJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartDocumentClassificationJob

AWSRequest StartDocumentClassificationJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartDocumentClassificationJob

ToHeaders StartDocumentClassificationJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartDocumentClassificationJob

ToPath StartDocumentClassificationJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartDocumentClassificationJob

ToQuery StartDocumentClassificationJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartDocumentClassificationJob

type Rep StartDocumentClassificationJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartDocumentClassificationJob

type Rep StartDocumentClassificationJob = D1 ('MetaData "StartDocumentClassificationJob" "Amazonka.Comprehend.StartDocumentClassificationJob" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "StartDocumentClassificationJob'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "jobName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "vpcConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VpcConfig))) :*: (S1 ('MetaSel ('Just "volumeKmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "clientRequestToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :*: S1 ('MetaSel ('Just "documentClassifierArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "inputDataConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 InputDataConfig) :*: (S1 ('MetaSel ('Just "outputDataConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 OutputDataConfig) :*: S1 ('MetaSel ('Just "dataAccessRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))
type AWSResponse StartDocumentClassificationJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartDocumentClassificationJob

newStartDocumentClassificationJob Source #

Create a value of StartDocumentClassificationJob with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:jobName:StartDocumentClassificationJob', startDocumentClassificationJob_jobName - The identifier of the job.

$sel:vpcConfig:StartDocumentClassificationJob', startDocumentClassificationJob_vpcConfig - 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.

$sel:volumeKmsKeyId:StartDocumentClassificationJob', startDocumentClassificationJob_volumeKmsKeyId - ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:

  • KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
  • Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

$sel:clientRequestToken:StartDocumentClassificationJob', startDocumentClassificationJob_clientRequestToken - A unique identifier for the request. If you do not set the client request token, Amazon Comprehend generates one.

$sel:tags:StartDocumentClassificationJob', startDocumentClassificationJob_tags - Tags to be associated with the document classification job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.

$sel:documentClassifierArn:StartDocumentClassificationJob', startDocumentClassificationJob_documentClassifierArn - The Amazon Resource Name (ARN) of the document classifier to use to process the job.

$sel:inputDataConfig:StartDocumentClassificationJob', startDocumentClassificationJob_inputDataConfig - Specifies the format and location of the input data for the job.

$sel:outputDataConfig:StartDocumentClassificationJob', startDocumentClassificationJob_outputDataConfig - Specifies where to send the output files.

$sel:dataAccessRoleArn:StartDocumentClassificationJob', startDocumentClassificationJob_dataAccessRoleArn - The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.

data StartDocumentClassificationJobResponse Source #

Instances

Instances details
Eq StartDocumentClassificationJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StartDocumentClassificationJob

Read StartDocumentClassificationJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StartDocumentClassificationJob

Show StartDocumentClassificationJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StartDocumentClassificationJob

Generic StartDocumentClassificationJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StartDocumentClassificationJob

NFData StartDocumentClassificationJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StartDocumentClassificationJob

type Rep StartDocumentClassificationJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StartDocumentClassificationJob

type Rep StartDocumentClassificationJobResponse = D1 ('MetaData "StartDocumentClassificationJobResponse" "Amazonka.Comprehend.StartDocumentClassificationJob" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "StartDocumentClassificationJobResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "jobArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "jobStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobStatus)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newStartDocumentClassificationJobResponse Source #

Create a value of StartDocumentClassificationJobResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:jobId:StartDocumentClassificationJobResponse', startDocumentClassificationJobResponse_jobId - The identifier generated for the job. To get the status of the job, use this identifier with the operation.

$sel:jobArn:StartDocumentClassificationJobResponse', startDocumentClassificationJobResponse_jobArn - The Amazon Resource Name (ARN) of the document classification job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:

arn:<partition>:comprehend:<region>:<account-id>:document-classification-job/<job-id>

The following is an example job ARN:

arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab

$sel:jobStatus:StartDocumentClassificationJobResponse', startDocumentClassificationJobResponse_jobStatus - The status of the job:

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

$sel:httpStatus:StartDocumentClassificationJobResponse', startDocumentClassificationJobResponse_httpStatus - The response's http status code.

DetectKeyPhrases

data DetectKeyPhrases Source #

See: newDetectKeyPhrases smart constructor.

Instances

Instances details
Eq DetectKeyPhrases Source # 
Instance details

Defined in Amazonka.Comprehend.DetectKeyPhrases

Show DetectKeyPhrases Source # 
Instance details

Defined in Amazonka.Comprehend.DetectKeyPhrases

Generic DetectKeyPhrases Source # 
Instance details

Defined in Amazonka.Comprehend.DetectKeyPhrases

Associated Types

type Rep DetectKeyPhrases :: Type -> Type #

NFData DetectKeyPhrases Source # 
Instance details

Defined in Amazonka.Comprehend.DetectKeyPhrases

Methods

rnf :: DetectKeyPhrases -> () #

Hashable DetectKeyPhrases Source # 
Instance details

Defined in Amazonka.Comprehend.DetectKeyPhrases

ToJSON DetectKeyPhrases Source # 
Instance details

Defined in Amazonka.Comprehend.DetectKeyPhrases

AWSRequest DetectKeyPhrases Source # 
Instance details

Defined in Amazonka.Comprehend.DetectKeyPhrases

Associated Types

type AWSResponse DetectKeyPhrases #

ToHeaders DetectKeyPhrases Source # 
Instance details

Defined in Amazonka.Comprehend.DetectKeyPhrases

ToPath DetectKeyPhrases Source # 
Instance details

Defined in Amazonka.Comprehend.DetectKeyPhrases

ToQuery DetectKeyPhrases Source # 
Instance details

Defined in Amazonka.Comprehend.DetectKeyPhrases

type Rep DetectKeyPhrases Source # 
Instance details

Defined in Amazonka.Comprehend.DetectKeyPhrases

type Rep DetectKeyPhrases = D1 ('MetaData "DetectKeyPhrases" "Amazonka.Comprehend.DetectKeyPhrases" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "DetectKeyPhrases'" 'PrefixI 'True) (S1 ('MetaSel ('Just "text") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text)) :*: S1 ('MetaSel ('Just "languageCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 LanguageCode)))
type AWSResponse DetectKeyPhrases Source # 
Instance details

Defined in Amazonka.Comprehend.DetectKeyPhrases

newDetectKeyPhrases Source #

Create a value of DetectKeyPhrases with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:text:DetectKeyPhrases', detectKeyPhrases_text - A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded characters.

$sel:languageCode:DetectKeyPhrases', detectKeyPhrases_languageCode - The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.

data DetectKeyPhrasesResponse Source #

See: newDetectKeyPhrasesResponse smart constructor.

Instances

Instances details
Eq DetectKeyPhrasesResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DetectKeyPhrases

Show DetectKeyPhrasesResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DetectKeyPhrases

Generic DetectKeyPhrasesResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DetectKeyPhrases

Associated Types

type Rep DetectKeyPhrasesResponse :: Type -> Type #

NFData DetectKeyPhrasesResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DetectKeyPhrases

type Rep DetectKeyPhrasesResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DetectKeyPhrases

type Rep DetectKeyPhrasesResponse = D1 ('MetaData "DetectKeyPhrasesResponse" "Amazonka.Comprehend.DetectKeyPhrases" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "DetectKeyPhrasesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "keyPhrases") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [KeyPhrase])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDetectKeyPhrasesResponse Source #

Create a value of DetectKeyPhrasesResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:keyPhrases:DetectKeyPhrasesResponse', detectKeyPhrasesResponse_keyPhrases - 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.

$sel:httpStatus:DetectKeyPhrasesResponse', detectKeyPhrasesResponse_httpStatus - The response's http status code.

DetectSyntax

data DetectSyntax Source #

See: newDetectSyntax smart constructor.

Instances

Instances details
Eq DetectSyntax Source # 
Instance details

Defined in Amazonka.Comprehend.DetectSyntax

Show DetectSyntax Source # 
Instance details

Defined in Amazonka.Comprehend.DetectSyntax

Generic DetectSyntax Source # 
Instance details

Defined in Amazonka.Comprehend.DetectSyntax

Associated Types

type Rep DetectSyntax :: Type -> Type #

NFData DetectSyntax Source # 
Instance details

Defined in Amazonka.Comprehend.DetectSyntax

Methods

rnf :: DetectSyntax -> () #

Hashable DetectSyntax Source # 
Instance details

Defined in Amazonka.Comprehend.DetectSyntax

ToJSON DetectSyntax Source # 
Instance details

Defined in Amazonka.Comprehend.DetectSyntax

AWSRequest DetectSyntax Source # 
Instance details

Defined in Amazonka.Comprehend.DetectSyntax

Associated Types

type AWSResponse DetectSyntax #

ToHeaders DetectSyntax Source # 
Instance details

Defined in Amazonka.Comprehend.DetectSyntax

ToPath DetectSyntax Source # 
Instance details

Defined in Amazonka.Comprehend.DetectSyntax

ToQuery DetectSyntax Source # 
Instance details

Defined in Amazonka.Comprehend.DetectSyntax

type Rep DetectSyntax Source # 
Instance details

Defined in Amazonka.Comprehend.DetectSyntax

type Rep DetectSyntax = D1 ('MetaData "DetectSyntax" "Amazonka.Comprehend.DetectSyntax" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "DetectSyntax'" 'PrefixI 'True) (S1 ('MetaSel ('Just "text") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text)) :*: S1 ('MetaSel ('Just "languageCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SyntaxLanguageCode)))
type AWSResponse DetectSyntax Source # 
Instance details

Defined in Amazonka.Comprehend.DetectSyntax

newDetectSyntax Source #

Create a value of DetectSyntax with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:text:DetectSyntax', detectSyntax_text - A UTF-8 string. Each string must contain fewer that 5,000 bytes of UTF encoded characters.

$sel:languageCode:DetectSyntax', detectSyntax_languageCode - 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").

data DetectSyntaxResponse Source #

See: newDetectSyntaxResponse smart constructor.

Instances

Instances details
Eq DetectSyntaxResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DetectSyntax

Show DetectSyntaxResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DetectSyntax

Generic DetectSyntaxResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DetectSyntax

Associated Types

type Rep DetectSyntaxResponse :: Type -> Type #

NFData DetectSyntaxResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DetectSyntax

Methods

rnf :: DetectSyntaxResponse -> () #

type Rep DetectSyntaxResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DetectSyntax

type Rep DetectSyntaxResponse = D1 ('MetaData "DetectSyntaxResponse" "Amazonka.Comprehend.DetectSyntax" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "DetectSyntaxResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "syntaxTokens") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SyntaxToken])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDetectSyntaxResponse Source #

Create a value of DetectSyntaxResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:syntaxTokens:DetectSyntaxResponse', detectSyntaxResponse_syntaxTokens - 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 how-syntax.

$sel:httpStatus:DetectSyntaxResponse', detectSyntaxResponse_httpStatus - The response's http status code.

DescribeEndpoint

data DescribeEndpoint Source #

See: newDescribeEndpoint smart constructor.

Constructors

DescribeEndpoint' Text 

Instances

Instances details
Eq DescribeEndpoint Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeEndpoint

Read DescribeEndpoint Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeEndpoint

Show DescribeEndpoint Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeEndpoint

Generic DescribeEndpoint Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeEndpoint

Associated Types

type Rep DescribeEndpoint :: Type -> Type #

NFData DescribeEndpoint Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeEndpoint

Methods

rnf :: DescribeEndpoint -> () #

Hashable DescribeEndpoint Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeEndpoint

ToJSON DescribeEndpoint Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeEndpoint

AWSRequest DescribeEndpoint Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeEndpoint

Associated Types

type AWSResponse DescribeEndpoint #

ToHeaders DescribeEndpoint Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeEndpoint

ToPath DescribeEndpoint Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeEndpoint

ToQuery DescribeEndpoint Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeEndpoint

type Rep DescribeEndpoint Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeEndpoint

type Rep DescribeEndpoint = D1 ('MetaData "DescribeEndpoint" "Amazonka.Comprehend.DescribeEndpoint" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "DescribeEndpoint'" 'PrefixI 'True) (S1 ('MetaSel ('Just "endpointArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DescribeEndpoint Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeEndpoint

newDescribeEndpoint Source #

Create a value of DescribeEndpoint with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:endpointArn:DescribeEndpoint', describeEndpoint_endpointArn - The Amazon Resource Number (ARN) of the endpoint being described.

data DescribeEndpointResponse Source #

See: newDescribeEndpointResponse smart constructor.

Instances

Instances details
Eq DescribeEndpointResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeEndpoint

Read DescribeEndpointResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeEndpoint

Show DescribeEndpointResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeEndpoint

Generic DescribeEndpointResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeEndpoint

Associated Types

type Rep DescribeEndpointResponse :: Type -> Type #

NFData DescribeEndpointResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeEndpoint

type Rep DescribeEndpointResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeEndpoint

type Rep DescribeEndpointResponse = D1 ('MetaData "DescribeEndpointResponse" "Amazonka.Comprehend.DescribeEndpoint" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "DescribeEndpointResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "endpointProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EndpointProperties)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDescribeEndpointResponse Source #

Create a value of DescribeEndpointResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:endpointProperties:DescribeEndpointResponse', describeEndpointResponse_endpointProperties - Describes information associated with the specific endpoint.

$sel:httpStatus:DescribeEndpointResponse', describeEndpointResponse_httpStatus - The response's http status code.

ListSentimentDetectionJobs (Paginated)

data ListSentimentDetectionJobs Source #

See: newListSentimentDetectionJobs smart constructor.

Instances

Instances details
Eq ListSentimentDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListSentimentDetectionJobs

Read ListSentimentDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListSentimentDetectionJobs

Show ListSentimentDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListSentimentDetectionJobs

Generic ListSentimentDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListSentimentDetectionJobs

Associated Types

type Rep ListSentimentDetectionJobs :: Type -> Type #

NFData ListSentimentDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListSentimentDetectionJobs

Hashable ListSentimentDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListSentimentDetectionJobs

ToJSON ListSentimentDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListSentimentDetectionJobs

AWSPager ListSentimentDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListSentimentDetectionJobs

AWSRequest ListSentimentDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListSentimentDetectionJobs

ToHeaders ListSentimentDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListSentimentDetectionJobs

ToPath ListSentimentDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListSentimentDetectionJobs

ToQuery ListSentimentDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListSentimentDetectionJobs

type Rep ListSentimentDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListSentimentDetectionJobs

type Rep ListSentimentDetectionJobs = D1 ('MetaData "ListSentimentDetectionJobs" "Amazonka.Comprehend.ListSentimentDetectionJobs" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "ListSentimentDetectionJobs'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "filter'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SentimentDetectionJobFilter)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))))
type AWSResponse ListSentimentDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListSentimentDetectionJobs

newListSentimentDetectionJobs :: ListSentimentDetectionJobs Source #

Create a value of ListSentimentDetectionJobs with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:nextToken:ListSentimentDetectionJobs', listSentimentDetectionJobs_nextToken - Identifies the next page of results to return.

$sel:filter':ListSentimentDetectionJobs', listSentimentDetectionJobs_filter - 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.

$sel:maxResults:ListSentimentDetectionJobs', listSentimentDetectionJobs_maxResults - The maximum number of results to return in each page. The default is 100.

data ListSentimentDetectionJobsResponse Source #

Instances

Instances details
Eq ListSentimentDetectionJobsResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ListSentimentDetectionJobs

Read ListSentimentDetectionJobsResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ListSentimentDetectionJobs

Show ListSentimentDetectionJobsResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ListSentimentDetectionJobs

Generic ListSentimentDetectionJobsResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ListSentimentDetectionJobs

Associated Types

type Rep ListSentimentDetectionJobsResponse :: Type -> Type #

NFData ListSentimentDetectionJobsResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ListSentimentDetectionJobs

type Rep ListSentimentDetectionJobsResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ListSentimentDetectionJobs

type Rep ListSentimentDetectionJobsResponse = D1 ('MetaData "ListSentimentDetectionJobsResponse" "Amazonka.Comprehend.ListSentimentDetectionJobs" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "ListSentimentDetectionJobsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "sentimentDetectionJobPropertiesList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SentimentDetectionJobProperties])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListSentimentDetectionJobsResponse Source #

Create a value of ListSentimentDetectionJobsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:nextToken:ListSentimentDetectionJobs', listSentimentDetectionJobsResponse_nextToken - Identifies the next page of results to return.

$sel:sentimentDetectionJobPropertiesList:ListSentimentDetectionJobsResponse', listSentimentDetectionJobsResponse_sentimentDetectionJobPropertiesList - A list containing the properties of each job that is returned.

$sel:httpStatus:ListSentimentDetectionJobsResponse', listSentimentDetectionJobsResponse_httpStatus - The response's http status code.

DeleteDocumentClassifier

data DeleteDocumentClassifier Source #

See: newDeleteDocumentClassifier smart constructor.

Instances

Instances details
Eq DeleteDocumentClassifier Source # 
Instance details

Defined in Amazonka.Comprehend.DeleteDocumentClassifier

Read DeleteDocumentClassifier Source # 
Instance details

Defined in Amazonka.Comprehend.DeleteDocumentClassifier

Show DeleteDocumentClassifier Source # 
Instance details

Defined in Amazonka.Comprehend.DeleteDocumentClassifier

Generic DeleteDocumentClassifier Source # 
Instance details

Defined in Amazonka.Comprehend.DeleteDocumentClassifier

Associated Types

type Rep DeleteDocumentClassifier :: Type -> Type #

NFData DeleteDocumentClassifier Source # 
Instance details

Defined in Amazonka.Comprehend.DeleteDocumentClassifier

Hashable DeleteDocumentClassifier Source # 
Instance details

Defined in Amazonka.Comprehend.DeleteDocumentClassifier

ToJSON DeleteDocumentClassifier Source # 
Instance details

Defined in Amazonka.Comprehend.DeleteDocumentClassifier

AWSRequest DeleteDocumentClassifier Source # 
Instance details

Defined in Amazonka.Comprehend.DeleteDocumentClassifier

ToHeaders DeleteDocumentClassifier Source # 
Instance details

Defined in Amazonka.Comprehend.DeleteDocumentClassifier

ToPath DeleteDocumentClassifier Source # 
Instance details

Defined in Amazonka.Comprehend.DeleteDocumentClassifier

ToQuery DeleteDocumentClassifier Source # 
Instance details

Defined in Amazonka.Comprehend.DeleteDocumentClassifier

type Rep DeleteDocumentClassifier Source # 
Instance details

Defined in Amazonka.Comprehend.DeleteDocumentClassifier

type Rep DeleteDocumentClassifier = D1 ('MetaData "DeleteDocumentClassifier" "Amazonka.Comprehend.DeleteDocumentClassifier" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "DeleteDocumentClassifier'" 'PrefixI 'True) (S1 ('MetaSel ('Just "documentClassifierArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DeleteDocumentClassifier Source # 
Instance details

Defined in Amazonka.Comprehend.DeleteDocumentClassifier

newDeleteDocumentClassifier Source #

Create a value of DeleteDocumentClassifier with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:documentClassifierArn:DeleteDocumentClassifier', deleteDocumentClassifier_documentClassifierArn - The Amazon Resource Name (ARN) that identifies the document classifier.

data DeleteDocumentClassifierResponse Source #

See: newDeleteDocumentClassifierResponse smart constructor.

Instances

Instances details
Eq DeleteDocumentClassifierResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DeleteDocumentClassifier

Read DeleteDocumentClassifierResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DeleteDocumentClassifier

Show DeleteDocumentClassifierResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DeleteDocumentClassifier

Generic DeleteDocumentClassifierResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DeleteDocumentClassifier

Associated Types

type Rep DeleteDocumentClassifierResponse :: Type -> Type #

NFData DeleteDocumentClassifierResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DeleteDocumentClassifier

type Rep DeleteDocumentClassifierResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DeleteDocumentClassifier

type Rep DeleteDocumentClassifierResponse = D1 ('MetaData "DeleteDocumentClassifierResponse" "Amazonka.Comprehend.DeleteDocumentClassifier" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "DeleteDocumentClassifierResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDeleteDocumentClassifierResponse Source #

Create a value of DeleteDocumentClassifierResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:DeleteDocumentClassifierResponse', deleteDocumentClassifierResponse_httpStatus - The response's http status code.

ListDominantLanguageDetectionJobs (Paginated)

data ListDominantLanguageDetectionJobs Source #

See: newListDominantLanguageDetectionJobs smart constructor.

Instances

Instances details
Eq ListDominantLanguageDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListDominantLanguageDetectionJobs

Read ListDominantLanguageDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListDominantLanguageDetectionJobs

Show ListDominantLanguageDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListDominantLanguageDetectionJobs

Generic ListDominantLanguageDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListDominantLanguageDetectionJobs

Associated Types

type Rep ListDominantLanguageDetectionJobs :: Type -> Type #

NFData ListDominantLanguageDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListDominantLanguageDetectionJobs

Hashable ListDominantLanguageDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListDominantLanguageDetectionJobs

ToJSON ListDominantLanguageDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListDominantLanguageDetectionJobs

AWSPager ListDominantLanguageDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListDominantLanguageDetectionJobs

AWSRequest ListDominantLanguageDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListDominantLanguageDetectionJobs

ToHeaders ListDominantLanguageDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListDominantLanguageDetectionJobs

ToPath ListDominantLanguageDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListDominantLanguageDetectionJobs

ToQuery ListDominantLanguageDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListDominantLanguageDetectionJobs

type Rep ListDominantLanguageDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListDominantLanguageDetectionJobs

type Rep ListDominantLanguageDetectionJobs = D1 ('MetaData "ListDominantLanguageDetectionJobs" "Amazonka.Comprehend.ListDominantLanguageDetectionJobs" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "ListDominantLanguageDetectionJobs'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "filter'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DominantLanguageDetectionJobFilter)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))))
type AWSResponse ListDominantLanguageDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListDominantLanguageDetectionJobs

newListDominantLanguageDetectionJobs :: ListDominantLanguageDetectionJobs Source #

Create a value of ListDominantLanguageDetectionJobs with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:nextToken:ListDominantLanguageDetectionJobs', listDominantLanguageDetectionJobs_nextToken - Identifies the next page of results to return.

$sel:filter':ListDominantLanguageDetectionJobs', listDominantLanguageDetectionJobs_filter - 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.

$sel:maxResults:ListDominantLanguageDetectionJobs', listDominantLanguageDetectionJobs_maxResults - The maximum number of results to return in each page. The default is 100.

data ListDominantLanguageDetectionJobsResponse Source #

Instances

Instances details
Eq ListDominantLanguageDetectionJobsResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ListDominantLanguageDetectionJobs

Read ListDominantLanguageDetectionJobsResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ListDominantLanguageDetectionJobs

Show ListDominantLanguageDetectionJobsResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ListDominantLanguageDetectionJobs

Generic ListDominantLanguageDetectionJobsResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ListDominantLanguageDetectionJobs

NFData ListDominantLanguageDetectionJobsResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ListDominantLanguageDetectionJobs

type Rep ListDominantLanguageDetectionJobsResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ListDominantLanguageDetectionJobs

type Rep ListDominantLanguageDetectionJobsResponse = D1 ('MetaData "ListDominantLanguageDetectionJobsResponse" "Amazonka.Comprehend.ListDominantLanguageDetectionJobs" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "ListDominantLanguageDetectionJobsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "dominantLanguageDetectionJobPropertiesList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DominantLanguageDetectionJobProperties])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

StartKeyPhrasesDetectionJob

data StartKeyPhrasesDetectionJob Source #

See: newStartKeyPhrasesDetectionJob smart constructor.

Instances

Instances details
Eq StartKeyPhrasesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartKeyPhrasesDetectionJob

Read StartKeyPhrasesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartKeyPhrasesDetectionJob

Show StartKeyPhrasesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartKeyPhrasesDetectionJob

Generic StartKeyPhrasesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartKeyPhrasesDetectionJob

Associated Types

type Rep StartKeyPhrasesDetectionJob :: Type -> Type #

NFData StartKeyPhrasesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartKeyPhrasesDetectionJob

Hashable StartKeyPhrasesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartKeyPhrasesDetectionJob

ToJSON StartKeyPhrasesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartKeyPhrasesDetectionJob

AWSRequest StartKeyPhrasesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartKeyPhrasesDetectionJob

ToHeaders StartKeyPhrasesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartKeyPhrasesDetectionJob

ToPath StartKeyPhrasesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartKeyPhrasesDetectionJob

ToQuery StartKeyPhrasesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartKeyPhrasesDetectionJob

type Rep StartKeyPhrasesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartKeyPhrasesDetectionJob

type Rep StartKeyPhrasesDetectionJob = D1 ('MetaData "StartKeyPhrasesDetectionJob" "Amazonka.Comprehend.StartKeyPhrasesDetectionJob" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "StartKeyPhrasesDetectionJob'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "jobName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "vpcConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VpcConfig))) :*: (S1 ('MetaSel ('Just "volumeKmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "clientRequestToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :*: S1 ('MetaSel ('Just "inputDataConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 InputDataConfig)) :*: (S1 ('MetaSel ('Just "outputDataConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 OutputDataConfig) :*: (S1 ('MetaSel ('Just "dataAccessRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "languageCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 LanguageCode))))))
type AWSResponse StartKeyPhrasesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartKeyPhrasesDetectionJob

newStartKeyPhrasesDetectionJob Source #

Create a value of StartKeyPhrasesDetectionJob with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:jobName:StartKeyPhrasesDetectionJob', startKeyPhrasesDetectionJob_jobName - The identifier of the job.

$sel:vpcConfig:StartKeyPhrasesDetectionJob', startKeyPhrasesDetectionJob_vpcConfig - 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.

$sel:volumeKmsKeyId:StartKeyPhrasesDetectionJob', startKeyPhrasesDetectionJob_volumeKmsKeyId - ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:

  • KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
  • Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

$sel:clientRequestToken:StartKeyPhrasesDetectionJob', startKeyPhrasesDetectionJob_clientRequestToken - A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

$sel:tags:StartKeyPhrasesDetectionJob', startKeyPhrasesDetectionJob_tags - Tags to be associated with the key phrases detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.

$sel:inputDataConfig:StartKeyPhrasesDetectionJob', startKeyPhrasesDetectionJob_inputDataConfig - Specifies the format and location of the input data for the job.

$sel:outputDataConfig:StartKeyPhrasesDetectionJob', startKeyPhrasesDetectionJob_outputDataConfig - Specifies where to send the output files.

$sel:dataAccessRoleArn:StartKeyPhrasesDetectionJob', startKeyPhrasesDetectionJob_dataAccessRoleArn - The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions.

$sel:languageCode:StartKeyPhrasesDetectionJob', startKeyPhrasesDetectionJob_languageCode - The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.

data StartKeyPhrasesDetectionJobResponse Source #

Instances

Instances details
Eq StartKeyPhrasesDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StartKeyPhrasesDetectionJob

Read StartKeyPhrasesDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StartKeyPhrasesDetectionJob

Show StartKeyPhrasesDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StartKeyPhrasesDetectionJob

Generic StartKeyPhrasesDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StartKeyPhrasesDetectionJob

NFData StartKeyPhrasesDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StartKeyPhrasesDetectionJob

type Rep StartKeyPhrasesDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StartKeyPhrasesDetectionJob

type Rep StartKeyPhrasesDetectionJobResponse = D1 ('MetaData "StartKeyPhrasesDetectionJobResponse" "Amazonka.Comprehend.StartKeyPhrasesDetectionJob" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "StartKeyPhrasesDetectionJobResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "jobArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "jobStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobStatus)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newStartKeyPhrasesDetectionJobResponse Source #

Create a value of StartKeyPhrasesDetectionJobResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:jobId:StartKeyPhrasesDetectionJobResponse', startKeyPhrasesDetectionJobResponse_jobId - The identifier generated for the job. To get the status of a job, use this identifier with the operation.

$sel:jobArn:StartKeyPhrasesDetectionJobResponse', startKeyPhrasesDetectionJobResponse_jobArn - The Amazon Resource Name (ARN) of the key phrase detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:

arn:<partition>:comprehend:<region>:<account-id>:key-phrases-detection-job/<job-id>

The following is an example job ARN:

arn:aws:comprehend:us-west-2:111122223333:key-phrases-detection-job/1234abcd12ab34cd56ef1234567890ab

$sel:jobStatus:StartKeyPhrasesDetectionJobResponse', startKeyPhrasesDetectionJobResponse_jobStatus - The status of the job.

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

$sel:httpStatus:StartKeyPhrasesDetectionJobResponse', startKeyPhrasesDetectionJobResponse_httpStatus - The response's http status code.

ListDocumentClassifiers (Paginated)

data ListDocumentClassifiers Source #

See: newListDocumentClassifiers smart constructor.

Instances

Instances details
Eq ListDocumentClassifiers Source # 
Instance details

Defined in Amazonka.Comprehend.ListDocumentClassifiers

Read ListDocumentClassifiers Source # 
Instance details

Defined in Amazonka.Comprehend.ListDocumentClassifiers

Show ListDocumentClassifiers Source # 
Instance details

Defined in Amazonka.Comprehend.ListDocumentClassifiers

Generic ListDocumentClassifiers Source # 
Instance details

Defined in Amazonka.Comprehend.ListDocumentClassifiers

Associated Types

type Rep ListDocumentClassifiers :: Type -> Type #

NFData ListDocumentClassifiers Source # 
Instance details

Defined in Amazonka.Comprehend.ListDocumentClassifiers

Methods

rnf :: ListDocumentClassifiers -> () #

Hashable ListDocumentClassifiers Source # 
Instance details

Defined in Amazonka.Comprehend.ListDocumentClassifiers

ToJSON ListDocumentClassifiers Source # 
Instance details

Defined in Amazonka.Comprehend.ListDocumentClassifiers

AWSPager ListDocumentClassifiers Source # 
Instance details

Defined in Amazonka.Comprehend.ListDocumentClassifiers

AWSRequest ListDocumentClassifiers Source # 
Instance details

Defined in Amazonka.Comprehend.ListDocumentClassifiers

ToHeaders ListDocumentClassifiers Source # 
Instance details

Defined in Amazonka.Comprehend.ListDocumentClassifiers

ToPath ListDocumentClassifiers Source # 
Instance details

Defined in Amazonka.Comprehend.ListDocumentClassifiers

ToQuery ListDocumentClassifiers Source # 
Instance details

Defined in Amazonka.Comprehend.ListDocumentClassifiers

type Rep ListDocumentClassifiers Source # 
Instance details

Defined in Amazonka.Comprehend.ListDocumentClassifiers

type Rep ListDocumentClassifiers = D1 ('MetaData "ListDocumentClassifiers" "Amazonka.Comprehend.ListDocumentClassifiers" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "ListDocumentClassifiers'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "filter'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DocumentClassifierFilter)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))))
type AWSResponse ListDocumentClassifiers Source # 
Instance details

Defined in Amazonka.Comprehend.ListDocumentClassifiers

newListDocumentClassifiers :: ListDocumentClassifiers Source #

Create a value of ListDocumentClassifiers with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:nextToken:ListDocumentClassifiers', listDocumentClassifiers_nextToken - Identifies the next page of results to return.

$sel:filter':ListDocumentClassifiers', listDocumentClassifiers_filter - 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.

$sel:maxResults:ListDocumentClassifiers', listDocumentClassifiers_maxResults - The maximum number of results to return in each page. The default is 100.

data ListDocumentClassifiersResponse Source #

See: newListDocumentClassifiersResponse smart constructor.

Instances

Instances details
Eq ListDocumentClassifiersResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ListDocumentClassifiers

Show ListDocumentClassifiersResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ListDocumentClassifiers

Generic ListDocumentClassifiersResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ListDocumentClassifiers

Associated Types

type Rep ListDocumentClassifiersResponse :: Type -> Type #

NFData ListDocumentClassifiersResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ListDocumentClassifiers

type Rep ListDocumentClassifiersResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ListDocumentClassifiers

type Rep ListDocumentClassifiersResponse = D1 ('MetaData "ListDocumentClassifiersResponse" "Amazonka.Comprehend.ListDocumentClassifiers" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "ListDocumentClassifiersResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "documentClassifierPropertiesList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DocumentClassifierProperties])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListDocumentClassifiersResponse Source #

Create a value of ListDocumentClassifiersResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:nextToken:ListDocumentClassifiers', listDocumentClassifiersResponse_nextToken - Identifies the next page of results to return.

$sel:documentClassifierPropertiesList:ListDocumentClassifiersResponse', listDocumentClassifiersResponse_documentClassifierPropertiesList - A list containing the properties of each job returned.

$sel:httpStatus:ListDocumentClassifiersResponse', listDocumentClassifiersResponse_httpStatus - The response's http status code.

Types

AugmentedManifestsDocumentTypeFormat

newtype AugmentedManifestsDocumentTypeFormat Source #

Instances

Instances details
Eq AugmentedManifestsDocumentTypeFormat Source # 
Instance details

Defined in Amazonka.Comprehend.Types.AugmentedManifestsDocumentTypeFormat

Ord AugmentedManifestsDocumentTypeFormat Source # 
Instance details

Defined in Amazonka.Comprehend.Types.AugmentedManifestsDocumentTypeFormat

Read AugmentedManifestsDocumentTypeFormat Source # 
Instance details

Defined in Amazonka.Comprehend.Types.AugmentedManifestsDocumentTypeFormat

Show AugmentedManifestsDocumentTypeFormat Source # 
Instance details

Defined in Amazonka.Comprehend.Types.AugmentedManifestsDocumentTypeFormat

Generic AugmentedManifestsDocumentTypeFormat Source # 
Instance details

Defined in Amazonka.Comprehend.Types.AugmentedManifestsDocumentTypeFormat

NFData AugmentedManifestsDocumentTypeFormat Source # 
Instance details

Defined in Amazonka.Comprehend.Types.AugmentedManifestsDocumentTypeFormat

Hashable AugmentedManifestsDocumentTypeFormat Source # 
Instance details

Defined in Amazonka.Comprehend.Types.AugmentedManifestsDocumentTypeFormat

ToJSON AugmentedManifestsDocumentTypeFormat Source # 
Instance details

Defined in Amazonka.Comprehend.Types.AugmentedManifestsDocumentTypeFormat

ToJSONKey AugmentedManifestsDocumentTypeFormat Source # 
Instance details

Defined in Amazonka.Comprehend.Types.AugmentedManifestsDocumentTypeFormat

FromJSON AugmentedManifestsDocumentTypeFormat Source # 
Instance details

Defined in Amazonka.Comprehend.Types.AugmentedManifestsDocumentTypeFormat

FromJSONKey AugmentedManifestsDocumentTypeFormat Source # 
Instance details

Defined in Amazonka.Comprehend.Types.AugmentedManifestsDocumentTypeFormat

ToLog AugmentedManifestsDocumentTypeFormat Source # 
Instance details

Defined in Amazonka.Comprehend.Types.AugmentedManifestsDocumentTypeFormat

ToHeader AugmentedManifestsDocumentTypeFormat Source # 
Instance details

Defined in Amazonka.Comprehend.Types.AugmentedManifestsDocumentTypeFormat

ToQuery AugmentedManifestsDocumentTypeFormat Source # 
Instance details

Defined in Amazonka.Comprehend.Types.AugmentedManifestsDocumentTypeFormat

FromXML AugmentedManifestsDocumentTypeFormat Source # 
Instance details

Defined in Amazonka.Comprehend.Types.AugmentedManifestsDocumentTypeFormat

ToXML AugmentedManifestsDocumentTypeFormat Source # 
Instance details

Defined in Amazonka.Comprehend.Types.AugmentedManifestsDocumentTypeFormat

ToByteString AugmentedManifestsDocumentTypeFormat Source # 
Instance details

Defined in Amazonka.Comprehend.Types.AugmentedManifestsDocumentTypeFormat

FromText AugmentedManifestsDocumentTypeFormat Source # 
Instance details

Defined in Amazonka.Comprehend.Types.AugmentedManifestsDocumentTypeFormat

ToText AugmentedManifestsDocumentTypeFormat Source # 
Instance details

Defined in Amazonka.Comprehend.Types.AugmentedManifestsDocumentTypeFormat

type Rep AugmentedManifestsDocumentTypeFormat Source # 
Instance details

Defined in Amazonka.Comprehend.Types.AugmentedManifestsDocumentTypeFormat

type Rep AugmentedManifestsDocumentTypeFormat = D1 ('MetaData "AugmentedManifestsDocumentTypeFormat" "Amazonka.Comprehend.Types.AugmentedManifestsDocumentTypeFormat" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'True) (C1 ('MetaCons "AugmentedManifestsDocumentTypeFormat'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromAugmentedManifestsDocumentTypeFormat") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

DocumentClassifierDataFormat

newtype DocumentClassifierDataFormat Source #

Instances

Instances details
Eq DocumentClassifierDataFormat Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClassifierDataFormat

Ord DocumentClassifierDataFormat Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClassifierDataFormat

Read DocumentClassifierDataFormat Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClassifierDataFormat

Show DocumentClassifierDataFormat Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClassifierDataFormat

Generic DocumentClassifierDataFormat Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClassifierDataFormat

Associated Types

type Rep DocumentClassifierDataFormat :: Type -> Type #

NFData DocumentClassifierDataFormat Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClassifierDataFormat

Hashable DocumentClassifierDataFormat Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClassifierDataFormat

ToJSON DocumentClassifierDataFormat Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClassifierDataFormat

ToJSONKey DocumentClassifierDataFormat Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClassifierDataFormat

FromJSON DocumentClassifierDataFormat Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClassifierDataFormat

FromJSONKey DocumentClassifierDataFormat Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClassifierDataFormat

ToLog DocumentClassifierDataFormat Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClassifierDataFormat

ToHeader DocumentClassifierDataFormat Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClassifierDataFormat

ToQuery DocumentClassifierDataFormat Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClassifierDataFormat

FromXML DocumentClassifierDataFormat Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClassifierDataFormat

ToXML DocumentClassifierDataFormat Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClassifierDataFormat

ToByteString DocumentClassifierDataFormat Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClassifierDataFormat

FromText DocumentClassifierDataFormat Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClassifierDataFormat

ToText DocumentClassifierDataFormat Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClassifierDataFormat

type Rep DocumentClassifierDataFormat Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClassifierDataFormat

type Rep DocumentClassifierDataFormat = D1 ('MetaData "DocumentClassifierDataFormat" "Amazonka.Comprehend.Types.DocumentClassifierDataFormat" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'True) (C1 ('MetaCons "DocumentClassifierDataFormat'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromDocumentClassifierDataFormat") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

DocumentClassifierMode

newtype DocumentClassifierMode Source #

Instances

Instances details
Eq DocumentClassifierMode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClassifierMode

Ord DocumentClassifierMode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClassifierMode

Read DocumentClassifierMode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClassifierMode

Show DocumentClassifierMode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClassifierMode

Generic DocumentClassifierMode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClassifierMode

Associated Types

type Rep DocumentClassifierMode :: Type -> Type #

NFData DocumentClassifierMode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClassifierMode

Methods

rnf :: DocumentClassifierMode -> () #

Hashable DocumentClassifierMode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClassifierMode

ToJSON DocumentClassifierMode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClassifierMode

ToJSONKey DocumentClassifierMode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClassifierMode

FromJSON DocumentClassifierMode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClassifierMode

FromJSONKey DocumentClassifierMode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClassifierMode

ToLog DocumentClassifierMode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClassifierMode

ToHeader DocumentClassifierMode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClassifierMode

ToQuery DocumentClassifierMode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClassifierMode

FromXML DocumentClassifierMode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClassifierMode

ToXML DocumentClassifierMode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClassifierMode

ToByteString DocumentClassifierMode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClassifierMode

FromText DocumentClassifierMode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClassifierMode

ToText DocumentClassifierMode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClassifierMode

type Rep DocumentClassifierMode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClassifierMode

type Rep DocumentClassifierMode = D1 ('MetaData "DocumentClassifierMode" "Amazonka.Comprehend.Types.DocumentClassifierMode" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'True) (C1 ('MetaCons "DocumentClassifierMode'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromDocumentClassifierMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

DocumentReadAction

newtype DocumentReadAction Source #

Instances

Instances details
Eq DocumentReadAction Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentReadAction

Ord DocumentReadAction Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentReadAction

Read DocumentReadAction Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentReadAction

Show DocumentReadAction Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentReadAction

Generic DocumentReadAction Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentReadAction

Associated Types

type Rep DocumentReadAction :: Type -> Type #

NFData DocumentReadAction Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentReadAction

Methods

rnf :: DocumentReadAction -> () #

Hashable DocumentReadAction Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentReadAction

ToJSON DocumentReadAction Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentReadAction

ToJSONKey DocumentReadAction Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentReadAction

FromJSON DocumentReadAction Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentReadAction

FromJSONKey DocumentReadAction Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentReadAction

ToLog DocumentReadAction Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentReadAction

ToHeader DocumentReadAction Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentReadAction

ToQuery DocumentReadAction Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentReadAction

FromXML DocumentReadAction Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentReadAction

ToXML DocumentReadAction Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentReadAction

ToByteString DocumentReadAction Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentReadAction

FromText DocumentReadAction Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentReadAction

ToText DocumentReadAction Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentReadAction

type Rep DocumentReadAction Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentReadAction

type Rep DocumentReadAction = D1 ('MetaData "DocumentReadAction" "Amazonka.Comprehend.Types.DocumentReadAction" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'True) (C1 ('MetaCons "DocumentReadAction'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromDocumentReadAction") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

DocumentReadFeatureTypes

newtype DocumentReadFeatureTypes Source #

A list of the types of analyses to perform. This field specifies what feature types need to be extracted from the document where entity recognition is expected.

  • TABLES - Add TABLES to the list to return information about the tables that are detected in the input document.
  • FORMS - Add FORMS to return detected form data.

Instances

Instances details
Eq DocumentReadFeatureTypes Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentReadFeatureTypes

Ord DocumentReadFeatureTypes Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentReadFeatureTypes

Read DocumentReadFeatureTypes Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentReadFeatureTypes

Show DocumentReadFeatureTypes Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentReadFeatureTypes

Generic DocumentReadFeatureTypes Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentReadFeatureTypes

Associated Types

type Rep DocumentReadFeatureTypes :: Type -> Type #

NFData DocumentReadFeatureTypes Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentReadFeatureTypes

Hashable DocumentReadFeatureTypes Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentReadFeatureTypes

ToJSON DocumentReadFeatureTypes Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentReadFeatureTypes

ToJSONKey DocumentReadFeatureTypes Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentReadFeatureTypes

FromJSON DocumentReadFeatureTypes Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentReadFeatureTypes

FromJSONKey DocumentReadFeatureTypes Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentReadFeatureTypes

ToLog DocumentReadFeatureTypes Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentReadFeatureTypes

ToHeader DocumentReadFeatureTypes Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentReadFeatureTypes

ToQuery DocumentReadFeatureTypes Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentReadFeatureTypes

FromXML DocumentReadFeatureTypes Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentReadFeatureTypes

ToXML DocumentReadFeatureTypes Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentReadFeatureTypes

ToByteString DocumentReadFeatureTypes Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentReadFeatureTypes

FromText DocumentReadFeatureTypes Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentReadFeatureTypes

ToText DocumentReadFeatureTypes Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentReadFeatureTypes

type Rep DocumentReadFeatureTypes Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentReadFeatureTypes

type Rep DocumentReadFeatureTypes = D1 ('MetaData "DocumentReadFeatureTypes" "Amazonka.Comprehend.Types.DocumentReadFeatureTypes" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'True) (C1 ('MetaCons "DocumentReadFeatureTypes'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromDocumentReadFeatureTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

DocumentReadMode

newtype DocumentReadMode Source #

Instances

Instances details
Eq DocumentReadMode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentReadMode

Ord DocumentReadMode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentReadMode

Read DocumentReadMode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentReadMode

Show DocumentReadMode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentReadMode

Generic DocumentReadMode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentReadMode

Associated Types

type Rep DocumentReadMode :: Type -> Type #

NFData DocumentReadMode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentReadMode

Methods

rnf :: DocumentReadMode -> () #

Hashable DocumentReadMode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentReadMode

ToJSON DocumentReadMode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentReadMode

ToJSONKey DocumentReadMode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentReadMode

FromJSON DocumentReadMode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentReadMode

FromJSONKey DocumentReadMode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentReadMode

ToLog DocumentReadMode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentReadMode

ToHeader DocumentReadMode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentReadMode

ToQuery DocumentReadMode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentReadMode

FromXML DocumentReadMode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentReadMode

ToXML DocumentReadMode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentReadMode

ToByteString DocumentReadMode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentReadMode

FromText DocumentReadMode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentReadMode

ToText DocumentReadMode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentReadMode

type Rep DocumentReadMode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentReadMode

type Rep DocumentReadMode = D1 ('MetaData "DocumentReadMode" "Amazonka.Comprehend.Types.DocumentReadMode" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'True) (C1 ('MetaCons "DocumentReadMode'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromDocumentReadMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

EndpointStatus

newtype EndpointStatus Source #

Constructors

EndpointStatus' 

Instances

Instances details
Eq EndpointStatus Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EndpointStatus

Ord EndpointStatus Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EndpointStatus

Read EndpointStatus Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EndpointStatus

Show EndpointStatus Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EndpointStatus

Generic EndpointStatus Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EndpointStatus

Associated Types

type Rep EndpointStatus :: Type -> Type #

NFData EndpointStatus Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EndpointStatus

Methods

rnf :: EndpointStatus -> () #

Hashable EndpointStatus Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EndpointStatus

ToJSON EndpointStatus Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EndpointStatus

ToJSONKey EndpointStatus Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EndpointStatus

FromJSON EndpointStatus Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EndpointStatus

FromJSONKey EndpointStatus Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EndpointStatus

ToLog EndpointStatus Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EndpointStatus

ToHeader EndpointStatus Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EndpointStatus

ToQuery EndpointStatus Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EndpointStatus

FromXML EndpointStatus Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EndpointStatus

ToXML EndpointStatus Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EndpointStatus

Methods

toXML :: EndpointStatus -> XML #

ToByteString EndpointStatus Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EndpointStatus

FromText EndpointStatus Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EndpointStatus

ToText EndpointStatus Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EndpointStatus

type Rep EndpointStatus Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EndpointStatus

type Rep EndpointStatus = D1 ('MetaData "EndpointStatus" "Amazonka.Comprehend.Types.EndpointStatus" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'True) (C1 ('MetaCons "EndpointStatus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromEndpointStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

EntityRecognizerDataFormat

newtype EntityRecognizerDataFormat Source #

Instances

Instances details
Eq EntityRecognizerDataFormat Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerDataFormat

Ord EntityRecognizerDataFormat Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerDataFormat

Read EntityRecognizerDataFormat Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerDataFormat

Show EntityRecognizerDataFormat Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerDataFormat

Generic EntityRecognizerDataFormat Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerDataFormat

Associated Types

type Rep EntityRecognizerDataFormat :: Type -> Type #

NFData EntityRecognizerDataFormat Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerDataFormat

Hashable EntityRecognizerDataFormat Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerDataFormat

ToJSON EntityRecognizerDataFormat Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerDataFormat

ToJSONKey EntityRecognizerDataFormat Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerDataFormat

FromJSON EntityRecognizerDataFormat Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerDataFormat

FromJSONKey EntityRecognizerDataFormat Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerDataFormat

ToLog EntityRecognizerDataFormat Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerDataFormat

ToHeader EntityRecognizerDataFormat Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerDataFormat

ToQuery EntityRecognizerDataFormat Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerDataFormat

FromXML EntityRecognizerDataFormat Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerDataFormat

ToXML EntityRecognizerDataFormat Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerDataFormat

ToByteString EntityRecognizerDataFormat Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerDataFormat

FromText EntityRecognizerDataFormat Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerDataFormat

ToText EntityRecognizerDataFormat Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerDataFormat

type Rep EntityRecognizerDataFormat Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerDataFormat

type Rep EntityRecognizerDataFormat = D1 ('MetaData "EntityRecognizerDataFormat" "Amazonka.Comprehend.Types.EntityRecognizerDataFormat" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'True) (C1 ('MetaCons "EntityRecognizerDataFormat'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromEntityRecognizerDataFormat") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

EntityType

newtype EntityType Source #

Constructors

EntityType' 

Fields

Instances

Instances details
Eq EntityType Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityType

Ord EntityType Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityType

Read EntityType Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityType

Show EntityType Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityType

Generic EntityType Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityType

Associated Types

type Rep EntityType :: Type -> Type #

NFData EntityType Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityType

Methods

rnf :: EntityType -> () #

Hashable EntityType Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityType

ToJSON EntityType Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityType

ToJSONKey EntityType Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityType

FromJSON EntityType Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityType

FromJSONKey EntityType Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityType

ToLog EntityType Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityType

ToHeader EntityType Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityType

ToQuery EntityType Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityType

FromXML EntityType Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityType

ToXML EntityType Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityType

Methods

toXML :: EntityType -> XML #

ToByteString EntityType Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityType

FromText EntityType Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityType

ToText EntityType Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityType

Methods

toText :: EntityType -> Text #

type Rep EntityType Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityType

type Rep EntityType = D1 ('MetaData "EntityType" "Amazonka.Comprehend.Types.EntityType" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'True) (C1 ('MetaCons "EntityType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromEntityType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

InputFormat

newtype InputFormat Source #

Constructors

InputFormat' 

Instances

Instances details
Eq InputFormat Source # 
Instance details

Defined in Amazonka.Comprehend.Types.InputFormat

Ord InputFormat Source # 
Instance details

Defined in Amazonka.Comprehend.Types.InputFormat

Read InputFormat Source # 
Instance details

Defined in Amazonka.Comprehend.Types.InputFormat

Show InputFormat Source # 
Instance details

Defined in Amazonka.Comprehend.Types.InputFormat

Generic InputFormat Source # 
Instance details

Defined in Amazonka.Comprehend.Types.InputFormat

Associated Types

type Rep InputFormat :: Type -> Type #

NFData InputFormat Source # 
Instance details

Defined in Amazonka.Comprehend.Types.InputFormat

Methods

rnf :: InputFormat -> () #

Hashable InputFormat Source # 
Instance details

Defined in Amazonka.Comprehend.Types.InputFormat

ToJSON InputFormat Source # 
Instance details

Defined in Amazonka.Comprehend.Types.InputFormat

ToJSONKey InputFormat Source # 
Instance details

Defined in Amazonka.Comprehend.Types.InputFormat

FromJSON InputFormat Source # 
Instance details

Defined in Amazonka.Comprehend.Types.InputFormat

FromJSONKey InputFormat Source # 
Instance details

Defined in Amazonka.Comprehend.Types.InputFormat

ToLog InputFormat Source # 
Instance details

Defined in Amazonka.Comprehend.Types.InputFormat

ToHeader InputFormat Source # 
Instance details

Defined in Amazonka.Comprehend.Types.InputFormat

ToQuery InputFormat Source # 
Instance details

Defined in Amazonka.Comprehend.Types.InputFormat

FromXML InputFormat Source # 
Instance details

Defined in Amazonka.Comprehend.Types.InputFormat

ToXML InputFormat Source # 
Instance details

Defined in Amazonka.Comprehend.Types.InputFormat

Methods

toXML :: InputFormat -> XML #

ToByteString InputFormat Source # 
Instance details

Defined in Amazonka.Comprehend.Types.InputFormat

FromText InputFormat Source # 
Instance details

Defined in Amazonka.Comprehend.Types.InputFormat

ToText InputFormat Source # 
Instance details

Defined in Amazonka.Comprehend.Types.InputFormat

Methods

toText :: InputFormat -> Text #

type Rep InputFormat Source # 
Instance details

Defined in Amazonka.Comprehend.Types.InputFormat

type Rep InputFormat = D1 ('MetaData "InputFormat" "Amazonka.Comprehend.Types.InputFormat" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'True) (C1 ('MetaCons "InputFormat'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromInputFormat") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

JobStatus

newtype JobStatus Source #

Constructors

JobStatus' 

Fields

Instances

Instances details
Eq JobStatus Source # 
Instance details

Defined in Amazonka.Comprehend.Types.JobStatus

Ord JobStatus Source # 
Instance details

Defined in Amazonka.Comprehend.Types.JobStatus

Read JobStatus Source # 
Instance details

Defined in Amazonka.Comprehend.Types.JobStatus

Show JobStatus Source # 
Instance details

Defined in Amazonka.Comprehend.Types.JobStatus

Generic JobStatus Source # 
Instance details

Defined in Amazonka.Comprehend.Types.JobStatus

Associated Types

type Rep JobStatus :: Type -> Type #

NFData JobStatus Source # 
Instance details

Defined in Amazonka.Comprehend.Types.JobStatus

Methods

rnf :: JobStatus -> () #

Hashable JobStatus Source # 
Instance details

Defined in Amazonka.Comprehend.Types.JobStatus

ToJSON JobStatus Source # 
Instance details

Defined in Amazonka.Comprehend.Types.JobStatus

ToJSONKey JobStatus Source # 
Instance details

Defined in Amazonka.Comprehend.Types.JobStatus

FromJSON JobStatus Source # 
Instance details

Defined in Amazonka.Comprehend.Types.JobStatus

FromJSONKey JobStatus Source # 
Instance details

Defined in Amazonka.Comprehend.Types.JobStatus

ToLog JobStatus Source # 
Instance details

Defined in Amazonka.Comprehend.Types.JobStatus

ToHeader JobStatus Source # 
Instance details

Defined in Amazonka.Comprehend.Types.JobStatus

ToQuery JobStatus Source # 
Instance details

Defined in Amazonka.Comprehend.Types.JobStatus

FromXML JobStatus Source # 
Instance details

Defined in Amazonka.Comprehend.Types.JobStatus

ToXML JobStatus Source # 
Instance details

Defined in Amazonka.Comprehend.Types.JobStatus

Methods

toXML :: JobStatus -> XML #

ToByteString JobStatus Source # 
Instance details

Defined in Amazonka.Comprehend.Types.JobStatus

Methods

toBS :: JobStatus -> ByteString #

FromText JobStatus Source # 
Instance details

Defined in Amazonka.Comprehend.Types.JobStatus

ToText JobStatus Source # 
Instance details

Defined in Amazonka.Comprehend.Types.JobStatus

Methods

toText :: JobStatus -> Text #

type Rep JobStatus Source # 
Instance details

Defined in Amazonka.Comprehend.Types.JobStatus

type Rep JobStatus = D1 ('MetaData "JobStatus" "Amazonka.Comprehend.Types.JobStatus" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'True) (C1 ('MetaCons "JobStatus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromJobStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

LanguageCode

newtype LanguageCode Source #

Constructors

LanguageCode' 

Instances

Instances details
Eq LanguageCode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.LanguageCode

Ord LanguageCode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.LanguageCode

Read LanguageCode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.LanguageCode

Show LanguageCode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.LanguageCode

Generic LanguageCode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.LanguageCode

Associated Types

type Rep LanguageCode :: Type -> Type #

NFData LanguageCode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.LanguageCode

Methods

rnf :: LanguageCode -> () #

Hashable LanguageCode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.LanguageCode

ToJSON LanguageCode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.LanguageCode

ToJSONKey LanguageCode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.LanguageCode

FromJSON LanguageCode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.LanguageCode

FromJSONKey LanguageCode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.LanguageCode

ToLog LanguageCode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.LanguageCode

ToHeader LanguageCode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.LanguageCode

ToQuery LanguageCode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.LanguageCode

FromXML LanguageCode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.LanguageCode

ToXML LanguageCode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.LanguageCode

Methods

toXML :: LanguageCode -> XML #

ToByteString LanguageCode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.LanguageCode

FromText LanguageCode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.LanguageCode

ToText LanguageCode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.LanguageCode

Methods

toText :: LanguageCode -> Text #

type Rep LanguageCode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.LanguageCode

type Rep LanguageCode = D1 ('MetaData "LanguageCode" "Amazonka.Comprehend.Types.LanguageCode" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'True) (C1 ('MetaCons "LanguageCode'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromLanguageCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

ModelStatus

newtype ModelStatus Source #

Constructors

ModelStatus' 

Instances

Instances details
Eq ModelStatus Source # 
Instance details

Defined in Amazonka.Comprehend.Types.ModelStatus

Ord ModelStatus Source # 
Instance details

Defined in Amazonka.Comprehend.Types.ModelStatus

Read ModelStatus Source # 
Instance details

Defined in Amazonka.Comprehend.Types.ModelStatus

Show ModelStatus Source # 
Instance details

Defined in Amazonka.Comprehend.Types.ModelStatus

Generic ModelStatus Source # 
Instance details

Defined in Amazonka.Comprehend.Types.ModelStatus

Associated Types

type Rep ModelStatus :: Type -> Type #

NFData ModelStatus Source # 
Instance details

Defined in Amazonka.Comprehend.Types.ModelStatus

Methods

rnf :: ModelStatus -> () #

Hashable ModelStatus Source # 
Instance details

Defined in Amazonka.Comprehend.Types.ModelStatus

ToJSON ModelStatus Source # 
Instance details

Defined in Amazonka.Comprehend.Types.ModelStatus

ToJSONKey ModelStatus Source # 
Instance details

Defined in Amazonka.Comprehend.Types.ModelStatus

FromJSON ModelStatus Source # 
Instance details

Defined in Amazonka.Comprehend.Types.ModelStatus

FromJSONKey ModelStatus Source # 
Instance details

Defined in Amazonka.Comprehend.Types.ModelStatus

ToLog ModelStatus Source # 
Instance details

Defined in Amazonka.Comprehend.Types.ModelStatus

ToHeader ModelStatus Source # 
Instance details

Defined in Amazonka.Comprehend.Types.ModelStatus

ToQuery ModelStatus Source # 
Instance details

Defined in Amazonka.Comprehend.Types.ModelStatus

FromXML ModelStatus Source # 
Instance details

Defined in Amazonka.Comprehend.Types.ModelStatus

ToXML ModelStatus Source # 
Instance details

Defined in Amazonka.Comprehend.Types.ModelStatus

Methods

toXML :: ModelStatus -> XML #

ToByteString ModelStatus Source # 
Instance details

Defined in Amazonka.Comprehend.Types.ModelStatus

FromText ModelStatus Source # 
Instance details

Defined in Amazonka.Comprehend.Types.ModelStatus

ToText ModelStatus Source # 
Instance details

Defined in Amazonka.Comprehend.Types.ModelStatus

Methods

toText :: ModelStatus -> Text #

type Rep ModelStatus Source # 
Instance details

Defined in Amazonka.Comprehend.Types.ModelStatus

type Rep ModelStatus = D1 ('MetaData "ModelStatus" "Amazonka.Comprehend.Types.ModelStatus" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'True) (C1 ('MetaCons "ModelStatus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromModelStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

PartOfSpeechTagType

newtype PartOfSpeechTagType Source #

Instances

Instances details
Eq PartOfSpeechTagType Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PartOfSpeechTagType

Ord PartOfSpeechTagType Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PartOfSpeechTagType

Read PartOfSpeechTagType Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PartOfSpeechTagType

Show PartOfSpeechTagType Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PartOfSpeechTagType

Generic PartOfSpeechTagType Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PartOfSpeechTagType

Associated Types

type Rep PartOfSpeechTagType :: Type -> Type #

NFData PartOfSpeechTagType Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PartOfSpeechTagType

Methods

rnf :: PartOfSpeechTagType -> () #

Hashable PartOfSpeechTagType Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PartOfSpeechTagType

ToJSON PartOfSpeechTagType Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PartOfSpeechTagType

ToJSONKey PartOfSpeechTagType Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PartOfSpeechTagType

FromJSON PartOfSpeechTagType Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PartOfSpeechTagType

FromJSONKey PartOfSpeechTagType Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PartOfSpeechTagType

ToLog PartOfSpeechTagType Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PartOfSpeechTagType

ToHeader PartOfSpeechTagType Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PartOfSpeechTagType

ToQuery PartOfSpeechTagType Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PartOfSpeechTagType

FromXML PartOfSpeechTagType Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PartOfSpeechTagType

ToXML PartOfSpeechTagType Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PartOfSpeechTagType

ToByteString PartOfSpeechTagType Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PartOfSpeechTagType

FromText PartOfSpeechTagType Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PartOfSpeechTagType

ToText PartOfSpeechTagType Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PartOfSpeechTagType

type Rep PartOfSpeechTagType Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PartOfSpeechTagType

type Rep PartOfSpeechTagType = D1 ('MetaData "PartOfSpeechTagType" "Amazonka.Comprehend.Types.PartOfSpeechTagType" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'True) (C1 ('MetaCons "PartOfSpeechTagType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromPartOfSpeechTagType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

PiiEntitiesDetectionMaskMode

newtype PiiEntitiesDetectionMaskMode Source #

Instances

Instances details
Eq PiiEntitiesDetectionMaskMode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PiiEntitiesDetectionMaskMode

Ord PiiEntitiesDetectionMaskMode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PiiEntitiesDetectionMaskMode

Read PiiEntitiesDetectionMaskMode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PiiEntitiesDetectionMaskMode

Show PiiEntitiesDetectionMaskMode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PiiEntitiesDetectionMaskMode

Generic PiiEntitiesDetectionMaskMode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PiiEntitiesDetectionMaskMode

Associated Types

type Rep PiiEntitiesDetectionMaskMode :: Type -> Type #

NFData PiiEntitiesDetectionMaskMode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PiiEntitiesDetectionMaskMode

Hashable PiiEntitiesDetectionMaskMode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PiiEntitiesDetectionMaskMode

ToJSON PiiEntitiesDetectionMaskMode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PiiEntitiesDetectionMaskMode

ToJSONKey PiiEntitiesDetectionMaskMode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PiiEntitiesDetectionMaskMode

FromJSON PiiEntitiesDetectionMaskMode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PiiEntitiesDetectionMaskMode

FromJSONKey PiiEntitiesDetectionMaskMode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PiiEntitiesDetectionMaskMode

ToLog PiiEntitiesDetectionMaskMode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PiiEntitiesDetectionMaskMode

ToHeader PiiEntitiesDetectionMaskMode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PiiEntitiesDetectionMaskMode

ToQuery PiiEntitiesDetectionMaskMode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PiiEntitiesDetectionMaskMode

FromXML PiiEntitiesDetectionMaskMode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PiiEntitiesDetectionMaskMode

ToXML PiiEntitiesDetectionMaskMode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PiiEntitiesDetectionMaskMode

ToByteString PiiEntitiesDetectionMaskMode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PiiEntitiesDetectionMaskMode

FromText PiiEntitiesDetectionMaskMode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PiiEntitiesDetectionMaskMode

ToText PiiEntitiesDetectionMaskMode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PiiEntitiesDetectionMaskMode

type Rep PiiEntitiesDetectionMaskMode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PiiEntitiesDetectionMaskMode

type Rep PiiEntitiesDetectionMaskMode = D1 ('MetaData "PiiEntitiesDetectionMaskMode" "Amazonka.Comprehend.Types.PiiEntitiesDetectionMaskMode" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'True) (C1 ('MetaCons "PiiEntitiesDetectionMaskMode'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromPiiEntitiesDetectionMaskMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

PiiEntitiesDetectionMode

newtype PiiEntitiesDetectionMode Source #

Instances

Instances details
Eq PiiEntitiesDetectionMode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PiiEntitiesDetectionMode

Ord PiiEntitiesDetectionMode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PiiEntitiesDetectionMode

Read PiiEntitiesDetectionMode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PiiEntitiesDetectionMode

Show PiiEntitiesDetectionMode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PiiEntitiesDetectionMode

Generic PiiEntitiesDetectionMode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PiiEntitiesDetectionMode

Associated Types

type Rep PiiEntitiesDetectionMode :: Type -> Type #

NFData PiiEntitiesDetectionMode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PiiEntitiesDetectionMode

Hashable PiiEntitiesDetectionMode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PiiEntitiesDetectionMode

ToJSON PiiEntitiesDetectionMode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PiiEntitiesDetectionMode

ToJSONKey PiiEntitiesDetectionMode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PiiEntitiesDetectionMode

FromJSON PiiEntitiesDetectionMode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PiiEntitiesDetectionMode

FromJSONKey PiiEntitiesDetectionMode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PiiEntitiesDetectionMode

ToLog PiiEntitiesDetectionMode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PiiEntitiesDetectionMode

ToHeader PiiEntitiesDetectionMode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PiiEntitiesDetectionMode

ToQuery PiiEntitiesDetectionMode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PiiEntitiesDetectionMode

FromXML PiiEntitiesDetectionMode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PiiEntitiesDetectionMode

ToXML PiiEntitiesDetectionMode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PiiEntitiesDetectionMode

ToByteString PiiEntitiesDetectionMode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PiiEntitiesDetectionMode

FromText PiiEntitiesDetectionMode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PiiEntitiesDetectionMode

ToText PiiEntitiesDetectionMode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PiiEntitiesDetectionMode

type Rep PiiEntitiesDetectionMode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PiiEntitiesDetectionMode

type Rep PiiEntitiesDetectionMode = D1 ('MetaData "PiiEntitiesDetectionMode" "Amazonka.Comprehend.Types.PiiEntitiesDetectionMode" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'True) (C1 ('MetaCons "PiiEntitiesDetectionMode'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromPiiEntitiesDetectionMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

PiiEntityType

newtype PiiEntityType Source #

Constructors

PiiEntityType' 

Instances

Instances details
Eq PiiEntityType Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PiiEntityType

Ord PiiEntityType Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PiiEntityType

Read PiiEntityType Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PiiEntityType

Show PiiEntityType Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PiiEntityType

Generic PiiEntityType Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PiiEntityType

Associated Types

type Rep PiiEntityType :: Type -> Type #

NFData PiiEntityType Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PiiEntityType

Methods

rnf :: PiiEntityType -> () #

Hashable PiiEntityType Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PiiEntityType

ToJSON PiiEntityType Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PiiEntityType

ToJSONKey PiiEntityType Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PiiEntityType

FromJSON PiiEntityType Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PiiEntityType

FromJSONKey PiiEntityType Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PiiEntityType

ToLog PiiEntityType Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PiiEntityType

ToHeader PiiEntityType Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PiiEntityType

ToQuery PiiEntityType Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PiiEntityType

FromXML PiiEntityType Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PiiEntityType

ToXML PiiEntityType Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PiiEntityType

Methods

toXML :: PiiEntityType -> XML #

ToByteString PiiEntityType Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PiiEntityType

FromText PiiEntityType Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PiiEntityType

ToText PiiEntityType Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PiiEntityType

Methods

toText :: PiiEntityType -> Text #

type Rep PiiEntityType Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PiiEntityType

type Rep PiiEntityType = D1 ('MetaData "PiiEntityType" "Amazonka.Comprehend.Types.PiiEntityType" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'True) (C1 ('MetaCons "PiiEntityType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromPiiEntityType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

SentimentType

newtype SentimentType Source #

Constructors

SentimentType' 

Instances

Instances details
Eq SentimentType Source # 
Instance details

Defined in Amazonka.Comprehend.Types.SentimentType

Ord SentimentType Source # 
Instance details

Defined in Amazonka.Comprehend.Types.SentimentType

Read SentimentType Source # 
Instance details

Defined in Amazonka.Comprehend.Types.SentimentType

Show SentimentType Source # 
Instance details

Defined in Amazonka.Comprehend.Types.SentimentType

Generic SentimentType Source # 
Instance details

Defined in Amazonka.Comprehend.Types.SentimentType

Associated Types

type Rep SentimentType :: Type -> Type #

NFData SentimentType Source # 
Instance details

Defined in Amazonka.Comprehend.Types.SentimentType

Methods

rnf :: SentimentType -> () #

Hashable SentimentType Source # 
Instance details

Defined in Amazonka.Comprehend.Types.SentimentType

ToJSON SentimentType Source # 
Instance details

Defined in Amazonka.Comprehend.Types.SentimentType

ToJSONKey SentimentType Source # 
Instance details

Defined in Amazonka.Comprehend.Types.SentimentType

FromJSON SentimentType Source # 
Instance details

Defined in Amazonka.Comprehend.Types.SentimentType

FromJSONKey SentimentType Source # 
Instance details

Defined in Amazonka.Comprehend.Types.SentimentType

ToLog SentimentType Source # 
Instance details

Defined in Amazonka.Comprehend.Types.SentimentType

ToHeader SentimentType Source # 
Instance details

Defined in Amazonka.Comprehend.Types.SentimentType

ToQuery SentimentType Source # 
Instance details

Defined in Amazonka.Comprehend.Types.SentimentType

FromXML SentimentType Source # 
Instance details

Defined in Amazonka.Comprehend.Types.SentimentType

ToXML SentimentType Source # 
Instance details

Defined in Amazonka.Comprehend.Types.SentimentType

Methods

toXML :: SentimentType -> XML #

ToByteString SentimentType Source # 
Instance details

Defined in Amazonka.Comprehend.Types.SentimentType

FromText SentimentType Source # 
Instance details

Defined in Amazonka.Comprehend.Types.SentimentType

ToText SentimentType Source # 
Instance details

Defined in Amazonka.Comprehend.Types.SentimentType

Methods

toText :: SentimentType -> Text #

type Rep SentimentType Source # 
Instance details

Defined in Amazonka.Comprehend.Types.SentimentType

type Rep SentimentType = D1 ('MetaData "SentimentType" "Amazonka.Comprehend.Types.SentimentType" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'True) (C1 ('MetaCons "SentimentType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromSentimentType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

Split

newtype Split Source #

Constructors

Split' 

Fields

Bundled Patterns

pattern Split_TEST :: Split 
pattern Split_TRAIN :: Split 

Instances

Instances details
Eq Split Source # 
Instance details

Defined in Amazonka.Comprehend.Types.Split

Methods

(==) :: Split -> Split -> Bool #

(/=) :: Split -> Split -> Bool #

Ord Split Source # 
Instance details

Defined in Amazonka.Comprehend.Types.Split

Methods

compare :: Split -> Split -> Ordering #

(<) :: Split -> Split -> Bool #

(<=) :: Split -> Split -> Bool #

(>) :: Split -> Split -> Bool #

(>=) :: Split -> Split -> Bool #

max :: Split -> Split -> Split #

min :: Split -> Split -> Split #

Read Split Source # 
Instance details

Defined in Amazonka.Comprehend.Types.Split

Show Split Source # 
Instance details

Defined in Amazonka.Comprehend.Types.Split

Methods

showsPrec :: Int -> Split -> ShowS #

show :: Split -> String #

showList :: [Split] -> ShowS #

Generic Split Source # 
Instance details

Defined in Amazonka.Comprehend.Types.Split

Associated Types

type Rep Split :: Type -> Type #

Methods

from :: Split -> Rep Split x #

to :: Rep Split x -> Split #

NFData Split Source # 
Instance details

Defined in Amazonka.Comprehend.Types.Split

Methods

rnf :: Split -> () #

Hashable Split Source # 
Instance details

Defined in Amazonka.Comprehend.Types.Split

Methods

hashWithSalt :: Int -> Split -> Int #

hash :: Split -> Int #

ToJSON Split Source # 
Instance details

Defined in Amazonka.Comprehend.Types.Split

ToJSONKey Split Source # 
Instance details

Defined in Amazonka.Comprehend.Types.Split

FromJSON Split Source # 
Instance details

Defined in Amazonka.Comprehend.Types.Split

FromJSONKey Split Source # 
Instance details

Defined in Amazonka.Comprehend.Types.Split

ToLog Split Source # 
Instance details

Defined in Amazonka.Comprehend.Types.Split

ToHeader Split Source # 
Instance details

Defined in Amazonka.Comprehend.Types.Split

Methods

toHeader :: HeaderName -> Split -> [Header] #

ToQuery Split Source # 
Instance details

Defined in Amazonka.Comprehend.Types.Split

Methods

toQuery :: Split -> QueryString #

FromXML Split Source # 
Instance details

Defined in Amazonka.Comprehend.Types.Split

Methods

parseXML :: [Node] -> Either String Split #

ToXML Split Source # 
Instance details

Defined in Amazonka.Comprehend.Types.Split

Methods

toXML :: Split -> XML #

ToByteString Split Source # 
Instance details

Defined in Amazonka.Comprehend.Types.Split

Methods

toBS :: Split -> ByteString #

FromText Split Source # 
Instance details

Defined in Amazonka.Comprehend.Types.Split

ToText Split Source # 
Instance details

Defined in Amazonka.Comprehend.Types.Split

Methods

toText :: Split -> Text #

type Rep Split Source # 
Instance details

Defined in Amazonka.Comprehend.Types.Split

type Rep Split = D1 ('MetaData "Split" "Amazonka.Comprehend.Types.Split" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'True) (C1 ('MetaCons "Split'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromSplit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

SyntaxLanguageCode

newtype SyntaxLanguageCode Source #

Instances

Instances details
Eq SyntaxLanguageCode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.SyntaxLanguageCode

Ord SyntaxLanguageCode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.SyntaxLanguageCode

Read SyntaxLanguageCode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.SyntaxLanguageCode

Show SyntaxLanguageCode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.SyntaxLanguageCode

Generic SyntaxLanguageCode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.SyntaxLanguageCode

Associated Types

type Rep SyntaxLanguageCode :: Type -> Type #

NFData SyntaxLanguageCode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.SyntaxLanguageCode

Methods

rnf :: SyntaxLanguageCode -> () #

Hashable SyntaxLanguageCode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.SyntaxLanguageCode

ToJSON SyntaxLanguageCode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.SyntaxLanguageCode

ToJSONKey SyntaxLanguageCode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.SyntaxLanguageCode

FromJSON SyntaxLanguageCode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.SyntaxLanguageCode

FromJSONKey SyntaxLanguageCode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.SyntaxLanguageCode

ToLog SyntaxLanguageCode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.SyntaxLanguageCode

ToHeader SyntaxLanguageCode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.SyntaxLanguageCode

ToQuery SyntaxLanguageCode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.SyntaxLanguageCode

FromXML SyntaxLanguageCode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.SyntaxLanguageCode

ToXML SyntaxLanguageCode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.SyntaxLanguageCode

ToByteString SyntaxLanguageCode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.SyntaxLanguageCode

FromText SyntaxLanguageCode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.SyntaxLanguageCode

ToText SyntaxLanguageCode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.SyntaxLanguageCode

type Rep SyntaxLanguageCode Source # 
Instance details

Defined in Amazonka.Comprehend.Types.SyntaxLanguageCode

type Rep SyntaxLanguageCode = D1 ('MetaData "SyntaxLanguageCode" "Amazonka.Comprehend.Types.SyntaxLanguageCode" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'True) (C1 ('MetaCons "SyntaxLanguageCode'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromSyntaxLanguageCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

AugmentedManifestsListItem

data AugmentedManifestsListItem Source #

An augmented manifest file that provides training data for your custom model. An augmented manifest file is a labeled dataset that is produced by Amazon SageMaker Ground Truth.

See: newAugmentedManifestsListItem smart constructor.

Instances

Instances details
Eq AugmentedManifestsListItem Source # 
Instance details

Defined in Amazonka.Comprehend.Types.AugmentedManifestsListItem

Read AugmentedManifestsListItem Source # 
Instance details

Defined in Amazonka.Comprehend.Types.AugmentedManifestsListItem

Show AugmentedManifestsListItem Source # 
Instance details

Defined in Amazonka.Comprehend.Types.AugmentedManifestsListItem

Generic AugmentedManifestsListItem Source # 
Instance details

Defined in Amazonka.Comprehend.Types.AugmentedManifestsListItem

Associated Types

type Rep AugmentedManifestsListItem :: Type -> Type #

NFData AugmentedManifestsListItem Source # 
Instance details

Defined in Amazonka.Comprehend.Types.AugmentedManifestsListItem

Hashable AugmentedManifestsListItem Source # 
Instance details

Defined in Amazonka.Comprehend.Types.AugmentedManifestsListItem

ToJSON AugmentedManifestsListItem Source # 
Instance details

Defined in Amazonka.Comprehend.Types.AugmentedManifestsListItem

FromJSON AugmentedManifestsListItem Source # 
Instance details

Defined in Amazonka.Comprehend.Types.AugmentedManifestsListItem

type Rep AugmentedManifestsListItem Source # 
Instance details

Defined in Amazonka.Comprehend.Types.AugmentedManifestsListItem

type Rep AugmentedManifestsListItem = D1 ('MetaData "AugmentedManifestsListItem" "Amazonka.Comprehend.Types.AugmentedManifestsListItem" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "AugmentedManifestsListItem'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "sourceDocumentsS3Uri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "documentType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AugmentedManifestsDocumentTypeFormat)) :*: S1 ('MetaSel ('Just "split") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Split)))) :*: (S1 ('MetaSel ('Just "annotationDataS3Uri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "s3Uri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "attributeNames") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text])))))

newAugmentedManifestsListItem Source #

Create a value of AugmentedManifestsListItem with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:sourceDocumentsS3Uri:AugmentedManifestsListItem', augmentedManifestsListItem_sourceDocumentsS3Uri - The S3 prefix to the source files (PDFs) that are referred to in the augmented manifest file.

$sel:documentType:AugmentedManifestsListItem', augmentedManifestsListItem_documentType - The type of augmented manifest. PlainTextDocument or SemiStructuredDocument. If you don't specify, the default is PlainTextDocument.

  • PLAIN_TEXT_DOCUMENT A document type that represents any unicode text that is encoded in UTF-8.
  • SEMI_STRUCTURED_DOCUMENT A document type with positional and structural context, like a PDF. For training with Amazon Comprehend, only PDFs are supported. For inference, Amazon Comprehend support PDFs, DOCX and TXT.

$sel:split:AugmentedManifestsListItem', augmentedManifestsListItem_split - The purpose of the data you've provided in the augmented manifest. You can either train or test this data. If you don't specify, the default is train.

TRAIN - all of the documents in the manifest will be used for training. If no test documents are provided, Amazon Comprehend will automatically reserve a portion of the training documents for testing.

TEST - all of the documents in the manifest will be used for testing.

$sel:annotationDataS3Uri:AugmentedManifestsListItem', augmentedManifestsListItem_annotationDataS3Uri - The S3 prefix to the annotation files that are referred in the augmented manifest file.

$sel:s3Uri:AugmentedManifestsListItem', augmentedManifestsListItem_s3Uri - The Amazon S3 location of the augmented manifest file.

$sel:attributeNames:AugmentedManifestsListItem', augmentedManifestsListItem_attributeNames - The JSON attribute that contains the annotations for your training documents. The number of attribute names that you specify depends on whether your augmented manifest file is the output of a single labeling job or a chained labeling job.

If your file is the output of a single labeling job, specify the LabelAttributeName key that was used when the job was created in Ground Truth.

If your file is the output of a chained labeling job, specify the LabelAttributeName key for one or more jobs in the chain. Each LabelAttributeName key provides the annotations from an individual job.

BatchDetectDominantLanguageItemResult

data BatchDetectDominantLanguageItemResult Source #

The result of calling the operation. The operation returns one object for each document that is successfully processed by the operation.

See: newBatchDetectDominantLanguageItemResult smart constructor.

Instances

Instances details
Eq BatchDetectDominantLanguageItemResult Source # 
Instance details

Defined in Amazonka.Comprehend.Types.BatchDetectDominantLanguageItemResult

Read BatchDetectDominantLanguageItemResult Source # 
Instance details

Defined in Amazonka.Comprehend.Types.BatchDetectDominantLanguageItemResult

Show BatchDetectDominantLanguageItemResult Source # 
Instance details

Defined in Amazonka.Comprehend.Types.BatchDetectDominantLanguageItemResult

Generic BatchDetectDominantLanguageItemResult Source # 
Instance details

Defined in Amazonka.Comprehend.Types.BatchDetectDominantLanguageItemResult

NFData BatchDetectDominantLanguageItemResult Source # 
Instance details

Defined in Amazonka.Comprehend.Types.BatchDetectDominantLanguageItemResult

Hashable BatchDetectDominantLanguageItemResult Source # 
Instance details

Defined in Amazonka.Comprehend.Types.BatchDetectDominantLanguageItemResult

FromJSON BatchDetectDominantLanguageItemResult Source # 
Instance details

Defined in Amazonka.Comprehend.Types.BatchDetectDominantLanguageItemResult

type Rep BatchDetectDominantLanguageItemResult Source # 
Instance details

Defined in Amazonka.Comprehend.Types.BatchDetectDominantLanguageItemResult

type Rep BatchDetectDominantLanguageItemResult = D1 ('MetaData "BatchDetectDominantLanguageItemResult" "Amazonka.Comprehend.Types.BatchDetectDominantLanguageItemResult" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "BatchDetectDominantLanguageItemResult'" 'PrefixI 'True) (S1 ('MetaSel ('Just "languages") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DominantLanguage])) :*: S1 ('MetaSel ('Just "index") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))

newBatchDetectDominantLanguageItemResult :: BatchDetectDominantLanguageItemResult Source #

Create a value of BatchDetectDominantLanguageItemResult with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:languages:BatchDetectDominantLanguageItemResult', batchDetectDominantLanguageItemResult_languages - One or more DominantLanguage objects describing the dominant languages in the document.

$sel:index:BatchDetectDominantLanguageItemResult', batchDetectDominantLanguageItemResult_index - The zero-based index of the document in the input list.

BatchDetectEntitiesItemResult

data BatchDetectEntitiesItemResult Source #

The result of calling the operation. The operation returns one object for each document that is successfully processed by the operation.

See: newBatchDetectEntitiesItemResult smart constructor.

Instances

Instances details
Eq BatchDetectEntitiesItemResult Source # 
Instance details

Defined in Amazonka.Comprehend.Types.BatchDetectEntitiesItemResult

Read BatchDetectEntitiesItemResult Source # 
Instance details

Defined in Amazonka.Comprehend.Types.BatchDetectEntitiesItemResult

Show BatchDetectEntitiesItemResult Source # 
Instance details

Defined in Amazonka.Comprehend.Types.BatchDetectEntitiesItemResult

Generic BatchDetectEntitiesItemResult Source # 
Instance details

Defined in Amazonka.Comprehend.Types.BatchDetectEntitiesItemResult

Associated Types

type Rep BatchDetectEntitiesItemResult :: Type -> Type #

NFData BatchDetectEntitiesItemResult Source # 
Instance details

Defined in Amazonka.Comprehend.Types.BatchDetectEntitiesItemResult

Hashable BatchDetectEntitiesItemResult Source # 
Instance details

Defined in Amazonka.Comprehend.Types.BatchDetectEntitiesItemResult

FromJSON BatchDetectEntitiesItemResult Source # 
Instance details

Defined in Amazonka.Comprehend.Types.BatchDetectEntitiesItemResult

type Rep BatchDetectEntitiesItemResult Source # 
Instance details

Defined in Amazonka.Comprehend.Types.BatchDetectEntitiesItemResult

type Rep BatchDetectEntitiesItemResult = D1 ('MetaData "BatchDetectEntitiesItemResult" "Amazonka.Comprehend.Types.BatchDetectEntitiesItemResult" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "BatchDetectEntitiesItemResult'" 'PrefixI 'True) (S1 ('MetaSel ('Just "entities") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Entity])) :*: S1 ('MetaSel ('Just "index") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))

newBatchDetectEntitiesItemResult :: BatchDetectEntitiesItemResult Source #

Create a value of BatchDetectEntitiesItemResult with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:entities:BatchDetectEntitiesItemResult', batchDetectEntitiesItemResult_entities - One or more Entity objects, one for each entity detected in the document.

$sel:index:BatchDetectEntitiesItemResult', batchDetectEntitiesItemResult_index - The zero-based index of the document in the input list.

BatchDetectKeyPhrasesItemResult

data BatchDetectKeyPhrasesItemResult Source #

The result of calling the operation. The operation returns one object for each document that is successfully processed by the operation.

See: newBatchDetectKeyPhrasesItemResult smart constructor.

Instances

Instances details
Eq BatchDetectKeyPhrasesItemResult Source # 
Instance details

Defined in Amazonka.Comprehend.Types.BatchDetectKeyPhrasesItemResult

Read BatchDetectKeyPhrasesItemResult Source # 
Instance details

Defined in Amazonka.Comprehend.Types.BatchDetectKeyPhrasesItemResult

Show BatchDetectKeyPhrasesItemResult Source # 
Instance details

Defined in Amazonka.Comprehend.Types.BatchDetectKeyPhrasesItemResult

Generic BatchDetectKeyPhrasesItemResult Source # 
Instance details

Defined in Amazonka.Comprehend.Types.BatchDetectKeyPhrasesItemResult

Associated Types

type Rep BatchDetectKeyPhrasesItemResult :: Type -> Type #

NFData BatchDetectKeyPhrasesItemResult Source # 
Instance details

Defined in Amazonka.Comprehend.Types.BatchDetectKeyPhrasesItemResult

Hashable BatchDetectKeyPhrasesItemResult Source # 
Instance details

Defined in Amazonka.Comprehend.Types.BatchDetectKeyPhrasesItemResult

FromJSON BatchDetectKeyPhrasesItemResult Source # 
Instance details

Defined in Amazonka.Comprehend.Types.BatchDetectKeyPhrasesItemResult

type Rep BatchDetectKeyPhrasesItemResult Source # 
Instance details

Defined in Amazonka.Comprehend.Types.BatchDetectKeyPhrasesItemResult

type Rep BatchDetectKeyPhrasesItemResult = D1 ('MetaData "BatchDetectKeyPhrasesItemResult" "Amazonka.Comprehend.Types.BatchDetectKeyPhrasesItemResult" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "BatchDetectKeyPhrasesItemResult'" 'PrefixI 'True) (S1 ('MetaSel ('Just "index") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "keyPhrases") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [KeyPhrase]))))

newBatchDetectKeyPhrasesItemResult :: BatchDetectKeyPhrasesItemResult Source #

Create a value of BatchDetectKeyPhrasesItemResult with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:index:BatchDetectKeyPhrasesItemResult', batchDetectKeyPhrasesItemResult_index - The zero-based index of the document in the input list.

$sel:keyPhrases:BatchDetectKeyPhrasesItemResult', batchDetectKeyPhrasesItemResult_keyPhrases - One or more KeyPhrase objects, one for each key phrase detected in the document.

BatchDetectSentimentItemResult

data BatchDetectSentimentItemResult Source #

The result of calling the operation. The operation returns one object for each document that is successfully processed by the operation.

See: newBatchDetectSentimentItemResult smart constructor.

Instances

Instances details
Eq BatchDetectSentimentItemResult Source # 
Instance details

Defined in Amazonka.Comprehend.Types.BatchDetectSentimentItemResult

Read BatchDetectSentimentItemResult Source # 
Instance details

Defined in Amazonka.Comprehend.Types.BatchDetectSentimentItemResult

Show BatchDetectSentimentItemResult Source # 
Instance details

Defined in Amazonka.Comprehend.Types.BatchDetectSentimentItemResult

Generic BatchDetectSentimentItemResult Source # 
Instance details

Defined in Amazonka.Comprehend.Types.BatchDetectSentimentItemResult

Associated Types

type Rep BatchDetectSentimentItemResult :: Type -> Type #

NFData BatchDetectSentimentItemResult Source # 
Instance details

Defined in Amazonka.Comprehend.Types.BatchDetectSentimentItemResult

Hashable BatchDetectSentimentItemResult Source # 
Instance details

Defined in Amazonka.Comprehend.Types.BatchDetectSentimentItemResult

FromJSON BatchDetectSentimentItemResult Source # 
Instance details

Defined in Amazonka.Comprehend.Types.BatchDetectSentimentItemResult

type Rep BatchDetectSentimentItemResult Source # 
Instance details

Defined in Amazonka.Comprehend.Types.BatchDetectSentimentItemResult

type Rep BatchDetectSentimentItemResult = D1 ('MetaData "BatchDetectSentimentItemResult" "Amazonka.Comprehend.Types.BatchDetectSentimentItemResult" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "BatchDetectSentimentItemResult'" 'PrefixI 'True) (S1 ('MetaSel ('Just "sentiment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SentimentType)) :*: (S1 ('MetaSel ('Just "sentimentScore") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SentimentScore)) :*: S1 ('MetaSel ('Just "index") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))))

newBatchDetectSentimentItemResult :: BatchDetectSentimentItemResult Source #

Create a value of BatchDetectSentimentItemResult with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:sentiment:BatchDetectSentimentItemResult', batchDetectSentimentItemResult_sentiment - The sentiment detected in the document.

$sel:sentimentScore:BatchDetectSentimentItemResult', batchDetectSentimentItemResult_sentimentScore - The level of confidence that Amazon Comprehend has in the accuracy of its sentiment detection.

$sel:index:BatchDetectSentimentItemResult', batchDetectSentimentItemResult_index - The zero-based index of the document in the input list.

BatchDetectSyntaxItemResult

data BatchDetectSyntaxItemResult Source #

The result of calling the operation. The operation returns one object that is successfully processed by the operation.

See: newBatchDetectSyntaxItemResult smart constructor.

Instances

Instances details
Eq BatchDetectSyntaxItemResult Source # 
Instance details

Defined in Amazonka.Comprehend.Types.BatchDetectSyntaxItemResult

Read BatchDetectSyntaxItemResult Source # 
Instance details

Defined in Amazonka.Comprehend.Types.BatchDetectSyntaxItemResult

Show BatchDetectSyntaxItemResult Source # 
Instance details

Defined in Amazonka.Comprehend.Types.BatchDetectSyntaxItemResult

Generic BatchDetectSyntaxItemResult Source # 
Instance details

Defined in Amazonka.Comprehend.Types.BatchDetectSyntaxItemResult

Associated Types

type Rep BatchDetectSyntaxItemResult :: Type -> Type #

NFData BatchDetectSyntaxItemResult Source # 
Instance details

Defined in Amazonka.Comprehend.Types.BatchDetectSyntaxItemResult

Hashable BatchDetectSyntaxItemResult Source # 
Instance details

Defined in Amazonka.Comprehend.Types.BatchDetectSyntaxItemResult

FromJSON BatchDetectSyntaxItemResult Source # 
Instance details

Defined in Amazonka.Comprehend.Types.BatchDetectSyntaxItemResult

type Rep BatchDetectSyntaxItemResult Source # 
Instance details

Defined in Amazonka.Comprehend.Types.BatchDetectSyntaxItemResult

type Rep BatchDetectSyntaxItemResult = D1 ('MetaData "BatchDetectSyntaxItemResult" "Amazonka.Comprehend.Types.BatchDetectSyntaxItemResult" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "BatchDetectSyntaxItemResult'" 'PrefixI 'True) (S1 ('MetaSel ('Just "index") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "syntaxTokens") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SyntaxToken]))))

newBatchDetectSyntaxItemResult :: BatchDetectSyntaxItemResult Source #

Create a value of BatchDetectSyntaxItemResult with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:index:BatchDetectSyntaxItemResult', batchDetectSyntaxItemResult_index - The zero-based index of the document in the input list.

$sel:syntaxTokens:BatchDetectSyntaxItemResult', batchDetectSyntaxItemResult_syntaxTokens - The syntax tokens for the words in the document, one token for each word.

BatchItemError

data BatchItemError Source #

Describes an error that occurred while processing a document in a batch. The operation returns on BatchItemError object for each document that contained an error.

See: newBatchItemError smart constructor.

Instances

Instances details
Eq BatchItemError Source # 
Instance details

Defined in Amazonka.Comprehend.Types.BatchItemError

Read BatchItemError Source # 
Instance details

Defined in Amazonka.Comprehend.Types.BatchItemError

Show BatchItemError Source # 
Instance details

Defined in Amazonka.Comprehend.Types.BatchItemError

Generic BatchItemError Source # 
Instance details

Defined in Amazonka.Comprehend.Types.BatchItemError

Associated Types

type Rep BatchItemError :: Type -> Type #

NFData BatchItemError Source # 
Instance details

Defined in Amazonka.Comprehend.Types.BatchItemError

Methods

rnf :: BatchItemError -> () #

Hashable BatchItemError Source # 
Instance details

Defined in Amazonka.Comprehend.Types.BatchItemError

FromJSON BatchItemError Source # 
Instance details

Defined in Amazonka.Comprehend.Types.BatchItemError

type Rep BatchItemError Source # 
Instance details

Defined in Amazonka.Comprehend.Types.BatchItemError

type Rep BatchItemError = D1 ('MetaData "BatchItemError" "Amazonka.Comprehend.Types.BatchItemError" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "BatchItemError'" 'PrefixI 'True) (S1 ('MetaSel ('Just "errorCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "errorMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "index") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))))

newBatchItemError :: BatchItemError Source #

Create a value of BatchItemError with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:errorCode:BatchItemError', batchItemError_errorCode - The numeric error code of the error.

$sel:errorMessage:BatchItemError', batchItemError_errorMessage - A text description of the error.

$sel:index:BatchItemError', batchItemError_index - The zero-based index of the document in the input list.

ClassifierEvaluationMetrics

data ClassifierEvaluationMetrics Source #

Describes the result metrics for the test data associated with an documentation classifier.

See: newClassifierEvaluationMetrics smart constructor.

Instances

Instances details
Eq ClassifierEvaluationMetrics Source # 
Instance details

Defined in Amazonka.Comprehend.Types.ClassifierEvaluationMetrics

Read ClassifierEvaluationMetrics Source # 
Instance details

Defined in Amazonka.Comprehend.Types.ClassifierEvaluationMetrics

Show ClassifierEvaluationMetrics Source # 
Instance details

Defined in Amazonka.Comprehend.Types.ClassifierEvaluationMetrics

Generic ClassifierEvaluationMetrics Source # 
Instance details

Defined in Amazonka.Comprehend.Types.ClassifierEvaluationMetrics

Associated Types

type Rep ClassifierEvaluationMetrics :: Type -> Type #

NFData ClassifierEvaluationMetrics Source # 
Instance details

Defined in Amazonka.Comprehend.Types.ClassifierEvaluationMetrics

Hashable ClassifierEvaluationMetrics Source # 
Instance details

Defined in Amazonka.Comprehend.Types.ClassifierEvaluationMetrics

FromJSON ClassifierEvaluationMetrics Source # 
Instance details

Defined in Amazonka.Comprehend.Types.ClassifierEvaluationMetrics

type Rep ClassifierEvaluationMetrics Source # 
Instance details

Defined in Amazonka.Comprehend.Types.ClassifierEvaluationMetrics

type Rep ClassifierEvaluationMetrics = D1 ('MetaData "ClassifierEvaluationMetrics" "Amazonka.Comprehend.Types.ClassifierEvaluationMetrics" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "ClassifierEvaluationMetrics'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "microPrecision") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :*: S1 ('MetaSel ('Just "microF1Score") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double))) :*: (S1 ('MetaSel ('Just "recall") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :*: S1 ('MetaSel ('Just "precision") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)))) :*: ((S1 ('MetaSel ('Just "microRecall") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :*: S1 ('MetaSel ('Just "f1Score") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double))) :*: (S1 ('MetaSel ('Just "hammingLoss") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :*: S1 ('MetaSel ('Just "accuracy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double))))))

newClassifierEvaluationMetrics :: ClassifierEvaluationMetrics Source #

Create a value of ClassifierEvaluationMetrics with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:microPrecision:ClassifierEvaluationMetrics', classifierEvaluationMetrics_microPrecision - A measure of the usefulness of the recognizer results in the test data. High precision means that the recognizer returned substantially more relevant results than irrelevant ones. Unlike the Precision metric which comes from averaging the precision of all available labels, this is based on the overall score of all precision scores added together.

$sel:microF1Score:ClassifierEvaluationMetrics', classifierEvaluationMetrics_microF1Score - A measure of how accurate the classifier results are for the test data. It is a combination of the Micro Precision and Micro Recall values. The Micro F1Score is the harmonic mean of the two scores. The highest score is 1, and the worst score is 0.

$sel:recall:ClassifierEvaluationMetrics', classifierEvaluationMetrics_recall - A measure of how complete the classifier results are for the test data. High recall means that the classifier returned most of the relevant results.

$sel:precision:ClassifierEvaluationMetrics', classifierEvaluationMetrics_precision - A measure of the usefulness of the classifier results in the test data. High precision means that the classifier returned substantially more relevant results than irrelevant ones.

$sel:microRecall:ClassifierEvaluationMetrics', classifierEvaluationMetrics_microRecall - A measure of how complete the classifier results are for the test data. High recall means that the classifier returned most of the relevant results. Specifically, this indicates how many of the correct categories in the text that the model can predict. It is a percentage of correct categories in the text that can found. Instead of averaging the recall scores of all labels (as with Recall), micro Recall is based on the overall score of all recall scores added together.

$sel:f1Score:ClassifierEvaluationMetrics', classifierEvaluationMetrics_f1Score - A measure of how accurate the classifier results are for the test data. It is derived from the Precision and Recall values. The F1Score is the harmonic average of the two scores. The highest score is 1, and the worst score is 0.

$sel:hammingLoss:ClassifierEvaluationMetrics', classifierEvaluationMetrics_hammingLoss - Indicates the fraction of labels that are incorrectly predicted. Also seen as the fraction of wrong labels compared to the total number of labels. Scores closer to zero are better.

$sel:accuracy:ClassifierEvaluationMetrics', classifierEvaluationMetrics_accuracy - The fraction of the labels that were correct recognized. It is computed by dividing the number of labels in the test documents that were correctly recognized by the total number of labels in the test documents.

ClassifierMetadata

data ClassifierMetadata Source #

Provides information about a document classifier.

See: newClassifierMetadata smart constructor.

Instances

Instances details
Eq ClassifierMetadata Source # 
Instance details

Defined in Amazonka.Comprehend.Types.ClassifierMetadata

Show ClassifierMetadata Source # 
Instance details

Defined in Amazonka.Comprehend.Types.ClassifierMetadata

Generic ClassifierMetadata Source # 
Instance details

Defined in Amazonka.Comprehend.Types.ClassifierMetadata

Associated Types

type Rep ClassifierMetadata :: Type -> Type #

NFData ClassifierMetadata Source # 
Instance details

Defined in Amazonka.Comprehend.Types.ClassifierMetadata

Methods

rnf :: ClassifierMetadata -> () #

Hashable ClassifierMetadata Source # 
Instance details

Defined in Amazonka.Comprehend.Types.ClassifierMetadata

FromJSON ClassifierMetadata Source # 
Instance details

Defined in Amazonka.Comprehend.Types.ClassifierMetadata

type Rep ClassifierMetadata Source # 
Instance details

Defined in Amazonka.Comprehend.Types.ClassifierMetadata

type Rep ClassifierMetadata = D1 ('MetaData "ClassifierMetadata" "Amazonka.Comprehend.Types.ClassifierMetadata" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "ClassifierMetadata'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "numberOfLabels") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "evaluationMetrics") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ClassifierEvaluationMetrics))) :*: (S1 ('MetaSel ('Just "numberOfTrainedDocuments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "numberOfTestDocuments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))))

newClassifierMetadata :: ClassifierMetadata Source #

Create a value of ClassifierMetadata with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:numberOfLabels:ClassifierMetadata', classifierMetadata_numberOfLabels - The number of labels in the input data.

$sel:evaluationMetrics:ClassifierMetadata', classifierMetadata_evaluationMetrics - Describes the result metrics for the test data associated with an documentation classifier.

$sel:numberOfTrainedDocuments:ClassifierMetadata', classifierMetadata_numberOfTrainedDocuments - The number of documents in the input data that were used to train the classifier. Typically this is 80 to 90 percent of the input documents.

$sel:numberOfTestDocuments:ClassifierMetadata', classifierMetadata_numberOfTestDocuments - The number of documents in the input data that were used to test the classifier. Typically this is 10 to 20 percent of the input documents, up to 10,000 documents.

DocumentClass

data DocumentClass Source #

Specifies the class that categorizes the document being analyzed

See: newDocumentClass smart constructor.

Instances

Instances details
Eq DocumentClass Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClass

Read DocumentClass Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClass

Show DocumentClass Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClass

Generic DocumentClass Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClass

Associated Types

type Rep DocumentClass :: Type -> Type #

NFData DocumentClass Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClass

Methods

rnf :: DocumentClass -> () #

Hashable DocumentClass Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClass

FromJSON DocumentClass Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClass

type Rep DocumentClass Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClass

type Rep DocumentClass = D1 ('MetaData "DocumentClass" "Amazonka.Comprehend.Types.DocumentClass" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "DocumentClass'" 'PrefixI 'True) (S1 ('MetaSel ('Just "score") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newDocumentClass :: DocumentClass Source #

Create a value of DocumentClass with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:score:DocumentClass', documentClass_score - The confidence score that Amazon Comprehend has this class correctly attributed.

$sel:name:DocumentClass', documentClass_name - The name of the class.

DocumentClassificationJobFilter

data DocumentClassificationJobFilter Source #

Provides information for filtering a list of document classification jobs. For more information, see the operation. You can provide only one filter parameter in each request.

See: newDocumentClassificationJobFilter smart constructor.

Instances

Instances details
Eq DocumentClassificationJobFilter Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClassificationJobFilter

Read DocumentClassificationJobFilter Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClassificationJobFilter

Show DocumentClassificationJobFilter Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClassificationJobFilter

Generic DocumentClassificationJobFilter Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClassificationJobFilter

Associated Types

type Rep DocumentClassificationJobFilter :: Type -> Type #

NFData DocumentClassificationJobFilter Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClassificationJobFilter

Hashable DocumentClassificationJobFilter Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClassificationJobFilter

ToJSON DocumentClassificationJobFilter Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClassificationJobFilter

type Rep DocumentClassificationJobFilter Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClassificationJobFilter

type Rep DocumentClassificationJobFilter = D1 ('MetaData "DocumentClassificationJobFilter" "Amazonka.Comprehend.Types.DocumentClassificationJobFilter" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "DocumentClassificationJobFilter'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "submitTimeAfter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "submitTimeBefore") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :*: (S1 ('MetaSel ('Just "jobName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "jobStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobStatus)))))

newDocumentClassificationJobFilter :: DocumentClassificationJobFilter Source #

Create a value of DocumentClassificationJobFilter with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:submitTimeAfter:DocumentClassificationJobFilter', documentClassificationJobFilter_submitTimeAfter - Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted after the specified time. Jobs are returned in descending order, newest to oldest.

$sel:submitTimeBefore:DocumentClassificationJobFilter', documentClassificationJobFilter_submitTimeBefore - Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted before the specified time. Jobs are returned in ascending order, oldest to newest.

$sel:jobName:DocumentClassificationJobFilter', documentClassificationJobFilter_jobName - Filters on the name of the job.

$sel:jobStatus:DocumentClassificationJobFilter', documentClassificationJobFilter_jobStatus - Filters the list based on job status. Returns only jobs with the specified status.

DocumentClassificationJobProperties

data DocumentClassificationJobProperties Source #

Provides information about a document classification job.

See: newDocumentClassificationJobProperties smart constructor.

Instances

Instances details
Eq DocumentClassificationJobProperties Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClassificationJobProperties

Read DocumentClassificationJobProperties Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClassificationJobProperties

Show DocumentClassificationJobProperties Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClassificationJobProperties

Generic DocumentClassificationJobProperties Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClassificationJobProperties

NFData DocumentClassificationJobProperties Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClassificationJobProperties

Hashable DocumentClassificationJobProperties Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClassificationJobProperties

FromJSON DocumentClassificationJobProperties Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClassificationJobProperties

type Rep DocumentClassificationJobProperties Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClassificationJobProperties

type Rep DocumentClassificationJobProperties = D1 ('MetaData "DocumentClassificationJobProperties" "Amazonka.Comprehend.Types.DocumentClassificationJobProperties" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "DocumentClassificationJobProperties'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "jobArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "documentClassifierArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "jobName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "inputDataConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InputDataConfig)) :*: S1 ('MetaSel ('Just "vpcConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VpcConfig))))) :*: ((S1 ('MetaSel ('Just "volumeKmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "endTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "outputDataConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OutputDataConfig)))) :*: ((S1 ('MetaSel ('Just "dataAccessRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "jobStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobStatus))) :*: (S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "submitTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))))))

newDocumentClassificationJobProperties :: DocumentClassificationJobProperties Source #

Create a value of DocumentClassificationJobProperties with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:jobId:DocumentClassificationJobProperties', documentClassificationJobProperties_jobId - The identifier assigned to the document classification job.

$sel:jobArn:DocumentClassificationJobProperties', documentClassificationJobProperties_jobArn - The Amazon Resource Name (ARN) of the document classification job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:

arn:<partition>:comprehend:<region>:<account-id>:document-classification-job/<job-id>

The following is an example job ARN:

arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab

$sel:documentClassifierArn:DocumentClassificationJobProperties', documentClassificationJobProperties_documentClassifierArn - The Amazon Resource Name (ARN) that identifies the document classifier.

$sel:jobName:DocumentClassificationJobProperties', documentClassificationJobProperties_jobName - The name that you assigned to the document classification job.

$sel:inputDataConfig:DocumentClassificationJobProperties', documentClassificationJobProperties_inputDataConfig - The input data configuration that you supplied when you created the document classification job.

$sel:vpcConfig:DocumentClassificationJobProperties', documentClassificationJobProperties_vpcConfig - Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your document classification job. For more information, see Amazon VPC.

$sel:volumeKmsKeyId:DocumentClassificationJobProperties', documentClassificationJobProperties_volumeKmsKeyId - ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:

  • KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
  • Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

$sel:endTime:DocumentClassificationJobProperties', documentClassificationJobProperties_endTime - The time that the document classification job completed.

$sel:outputDataConfig:DocumentClassificationJobProperties', documentClassificationJobProperties_outputDataConfig - The output data configuration that you supplied when you created the document classification job.

$sel:dataAccessRoleArn:DocumentClassificationJobProperties', documentClassificationJobProperties_dataAccessRoleArn - The Amazon Resource Name (ARN) of the AWS identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.

$sel:jobStatus:DocumentClassificationJobProperties', documentClassificationJobProperties_jobStatus - The current status of the document classification job. If the status is FAILED, the Message field shows the reason for the failure.

$sel:message:DocumentClassificationJobProperties', documentClassificationJobProperties_message - A description of the status of the job.

$sel:submitTime:DocumentClassificationJobProperties', documentClassificationJobProperties_submitTime - The time that the document classification job was submitted for processing.

DocumentClassifierFilter

data DocumentClassifierFilter Source #

Provides information for filtering a list of document classifiers. You can only specify one filtering parameter in a request. For more information, see the operation.

See: newDocumentClassifierFilter smart constructor.

Instances

Instances details
Eq DocumentClassifierFilter Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClassifierFilter

Read DocumentClassifierFilter Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClassifierFilter

Show DocumentClassifierFilter Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClassifierFilter

Generic DocumentClassifierFilter Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClassifierFilter

Associated Types

type Rep DocumentClassifierFilter :: Type -> Type #

NFData DocumentClassifierFilter Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClassifierFilter

Hashable DocumentClassifierFilter Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClassifierFilter

ToJSON DocumentClassifierFilter Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClassifierFilter

type Rep DocumentClassifierFilter Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClassifierFilter

type Rep DocumentClassifierFilter = D1 ('MetaData "DocumentClassifierFilter" "Amazonka.Comprehend.Types.DocumentClassifierFilter" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "DocumentClassifierFilter'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ModelStatus)) :*: S1 ('MetaSel ('Just "submitTimeAfter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :*: (S1 ('MetaSel ('Just "submitTimeBefore") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "documentClassifierName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newDocumentClassifierFilter :: DocumentClassifierFilter Source #

Create a value of DocumentClassifierFilter with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:status:DocumentClassifierFilter', documentClassifierFilter_status - Filters the list of classifiers based on status.

$sel:submitTimeAfter:DocumentClassifierFilter', documentClassifierFilter_submitTimeAfter - Filters the list of classifiers based on the time that the classifier was submitted for processing. Returns only classifiers submitted after the specified time. Classifiers are returned in descending order, newest to oldest.

$sel:submitTimeBefore:DocumentClassifierFilter', documentClassifierFilter_submitTimeBefore - Filters the list of classifiers based on the time that the classifier was submitted for processing. Returns only classifiers submitted before the specified time. Classifiers are returned in ascending order, oldest to newest.

$sel:documentClassifierName:DocumentClassifierFilter', documentClassifierFilter_documentClassifierName - The name that you assigned to the document classifier

DocumentClassifierInputDataConfig

data DocumentClassifierInputDataConfig Source #

The input properties for training a document classifier.

For more information on how the input file is formatted, see how-document-classification-training-data.

See: newDocumentClassifierInputDataConfig smart constructor.

Instances

Instances details
Eq DocumentClassifierInputDataConfig Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClassifierInputDataConfig

Read DocumentClassifierInputDataConfig Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClassifierInputDataConfig

Show DocumentClassifierInputDataConfig Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClassifierInputDataConfig

Generic DocumentClassifierInputDataConfig Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClassifierInputDataConfig

Associated Types

type Rep DocumentClassifierInputDataConfig :: Type -> Type #

NFData DocumentClassifierInputDataConfig Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClassifierInputDataConfig

Hashable DocumentClassifierInputDataConfig Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClassifierInputDataConfig

ToJSON DocumentClassifierInputDataConfig Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClassifierInputDataConfig

FromJSON DocumentClassifierInputDataConfig Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClassifierInputDataConfig

type Rep DocumentClassifierInputDataConfig Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClassifierInputDataConfig

type Rep DocumentClassifierInputDataConfig = D1 ('MetaData "DocumentClassifierInputDataConfig" "Amazonka.Comprehend.Types.DocumentClassifierInputDataConfig" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "DocumentClassifierInputDataConfig'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "augmentedManifests") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [AugmentedManifestsListItem])) :*: S1 ('MetaSel ('Just "dataFormat") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DocumentClassifierDataFormat))) :*: (S1 ('MetaSel ('Just "labelDelimiter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "testS3Uri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "s3Uri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newDocumentClassifierInputDataConfig :: DocumentClassifierInputDataConfig Source #

Create a value of DocumentClassifierInputDataConfig with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:augmentedManifests:DocumentClassifierInputDataConfig', documentClassifierInputDataConfig_augmentedManifests - A list of augmented manifest files that provide training data for your custom model. An augmented manifest file is a labeled dataset that is produced by Amazon SageMaker Ground Truth.

This parameter is required if you set DataFormat to AUGMENTED_MANIFEST.

$sel:dataFormat:DocumentClassifierInputDataConfig', documentClassifierInputDataConfig_dataFormat - The format of your training data:

  • COMPREHEND_CSV: A two-column CSV file, where labels are provided in the first column, and documents are provided in the second. If you use this value, you must provide the S3Uri parameter in your request.
  • AUGMENTED_MANIFEST: A labeled dataset that is produced by Amazon SageMaker Ground Truth. This file is in JSON lines format. Each line is a complete JSON object that contains a training document and its associated labels.

    If you use this value, you must provide the AugmentedManifests parameter in your request.

If you don't specify a value, Amazon Comprehend uses COMPREHEND_CSV as the default.

$sel:labelDelimiter:DocumentClassifierInputDataConfig', documentClassifierInputDataConfig_labelDelimiter - Indicates the delimiter used to separate each label for training a multi-label classifier. The default delimiter between labels is a pipe (|). You can use a different character as a delimiter (if it's an allowed character) by specifying it under Delimiter for labels. If the training documents use a delimiter other than the default or the delimiter you specify, the labels on that line will be combined to make a single unique label, such as LABELLABELLABEL.

$sel:testS3Uri:DocumentClassifierInputDataConfig', documentClassifierInputDataConfig_testS3Uri - The Amazon S3 URI for the input data. The Amazon S3 bucket must be in the same AWS Region as the API endpoint that you are calling. The URI can point to a single input file or it can provide the prefix for a collection of input files.

$sel:s3Uri:DocumentClassifierInputDataConfig', documentClassifierInputDataConfig_s3Uri - The Amazon S3 URI for the input data. The S3 bucket must be in the same region as the API endpoint that you are calling. The URI can point to a single input file or it can provide the prefix for a collection of input files.

For example, if you use the URI S3://bucketName/prefix, if the prefix is a single file, Amazon Comprehend uses that file as input. If more than one file begins with the prefix, Amazon Comprehend uses all of them as input.

This parameter is required if you set DataFormat to COMPREHEND_CSV.

DocumentClassifierOutputDataConfig

data DocumentClassifierOutputDataConfig Source #

Provides output results configuration parameters for custom classifier jobs.

See: newDocumentClassifierOutputDataConfig smart constructor.

Instances

Instances details
Eq DocumentClassifierOutputDataConfig Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClassifierOutputDataConfig

Read DocumentClassifierOutputDataConfig Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClassifierOutputDataConfig

Show DocumentClassifierOutputDataConfig Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClassifierOutputDataConfig

Generic DocumentClassifierOutputDataConfig Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClassifierOutputDataConfig

Associated Types

type Rep DocumentClassifierOutputDataConfig :: Type -> Type #

NFData DocumentClassifierOutputDataConfig Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClassifierOutputDataConfig

Hashable DocumentClassifierOutputDataConfig Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClassifierOutputDataConfig

ToJSON DocumentClassifierOutputDataConfig Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClassifierOutputDataConfig

FromJSON DocumentClassifierOutputDataConfig Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClassifierOutputDataConfig

type Rep DocumentClassifierOutputDataConfig Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClassifierOutputDataConfig

type Rep DocumentClassifierOutputDataConfig = D1 ('MetaData "DocumentClassifierOutputDataConfig" "Amazonka.Comprehend.Types.DocumentClassifierOutputDataConfig" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "DocumentClassifierOutputDataConfig'" 'PrefixI 'True) (S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "s3Uri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newDocumentClassifierOutputDataConfig :: DocumentClassifierOutputDataConfig Source #

Create a value of DocumentClassifierOutputDataConfig with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:kmsKeyId:DocumentClassifierOutputDataConfig', documentClassifierOutputDataConfig_kmsKeyId - ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job. The KmsKeyId can be one of the following formats:

  • KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
  • Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
  • KMS Key Alias: "alias/ExampleAlias"
  • ARN of a KMS Key Alias: "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"

$sel:s3Uri:DocumentClassifierOutputDataConfig', documentClassifierOutputDataConfig_s3Uri - When you use the OutputDataConfig object while creating a custom classifier, you specify the Amazon S3 location where you want to write the confusion matrix. The URI must be in the same region as the API endpoint that you are calling. The location is used as the prefix for the actual location of this output file.

When the custom classifier job is finished, the service creates the output file in a directory specific to the job. The S3Uri field contains the location of the output file, called output.tar.gz. It is a compressed archive that contains the confusion matrix.

DocumentClassifierProperties

data DocumentClassifierProperties Source #

Provides information about a document classifier.

See: newDocumentClassifierProperties smart constructor.

Instances

Instances details
Eq DocumentClassifierProperties Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClassifierProperties

Show DocumentClassifierProperties Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClassifierProperties

Generic DocumentClassifierProperties Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClassifierProperties

Associated Types

type Rep DocumentClassifierProperties :: Type -> Type #

NFData DocumentClassifierProperties Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClassifierProperties

Hashable DocumentClassifierProperties Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClassifierProperties

FromJSON DocumentClassifierProperties Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClassifierProperties

type Rep DocumentClassifierProperties Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClassifierProperties

type Rep DocumentClassifierProperties = D1 ('MetaData "DocumentClassifierProperties" "Amazonka.Comprehend.Types.DocumentClassifierProperties" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "DocumentClassifierProperties'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ModelStatus)) :*: S1 ('MetaSel ('Just "languageCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LanguageCode))) :*: (S1 ('MetaSel ('Just "classifierMetadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive ClassifierMetadata))) :*: S1 ('MetaSel ('Just "trainingEndTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :*: ((S1 ('MetaSel ('Just "documentClassifierArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "versionName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "modelKmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "mode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DocumentClassifierMode))))) :*: (((S1 ('MetaSel ('Just "inputDataConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DocumentClassifierInputDataConfig)) :*: S1 ('MetaSel ('Just "vpcConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VpcConfig))) :*: (S1 ('MetaSel ('Just "volumeKmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "endTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :*: ((S1 ('MetaSel ('Just "outputDataConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DocumentClassifierOutputDataConfig)) :*: S1 ('MetaSel ('Just "trainingStartTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :*: (S1 ('MetaSel ('Just "dataAccessRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "submitTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))))))))

newDocumentClassifierProperties :: DocumentClassifierProperties Source #

Create a value of DocumentClassifierProperties with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:status:DocumentClassifierProperties', documentClassifierProperties_status - The status of the document classifier. If the status is TRAINED the classifier is ready to use. If the status is FAILED you can see additional information about why the classifier wasn't trained in the Message field.

$sel:languageCode:DocumentClassifierProperties', documentClassifierProperties_languageCode - The language code for the language of the documents that the classifier was trained on.

$sel:classifierMetadata:DocumentClassifierProperties', documentClassifierProperties_classifierMetadata - Information about the document classifier, including the number of documents used for training the classifier, the number of documents used for test the classifier, and an accuracy rating.

$sel:trainingEndTime:DocumentClassifierProperties', documentClassifierProperties_trainingEndTime - The time that training of the document classifier was completed. Indicates the time when the training completes on documentation classifiers. You are billed for the time interval between this time and the value of TrainingStartTime.

$sel:documentClassifierArn:DocumentClassifierProperties', documentClassifierProperties_documentClassifierArn - The Amazon Resource Name (ARN) that identifies the document classifier.

$sel:versionName:DocumentClassifierProperties', documentClassifierProperties_versionName - The version name that you assigned to the document classifier.

$sel:modelKmsKeyId:DocumentClassifierProperties', documentClassifierProperties_modelKmsKeyId - ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId can be either of the following formats:

  • KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
  • Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

$sel:mode:DocumentClassifierProperties', documentClassifierProperties_mode - Indicates the mode in which the specific classifier was trained. This also indicates the format of input documents and the format of the confusion matrix. Each classifier can only be trained in one mode and this cannot be changed once the classifier is trained.

$sel:inputDataConfig:DocumentClassifierProperties', documentClassifierProperties_inputDataConfig - The input data configuration that you supplied when you created the document classifier for training.

$sel:vpcConfig:DocumentClassifierProperties', documentClassifierProperties_vpcConfig - Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your custom classifier. For more information, see Amazon VPC.

$sel:volumeKmsKeyId:DocumentClassifierProperties', documentClassifierProperties_volumeKmsKeyId - ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:

  • KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
  • Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

$sel:endTime:DocumentClassifierProperties', documentClassifierProperties_endTime - The time that training the document classifier completed.

$sel:outputDataConfig:DocumentClassifierProperties', documentClassifierProperties_outputDataConfig - Provides output results configuration parameters for custom classifier jobs.

$sel:trainingStartTime:DocumentClassifierProperties', documentClassifierProperties_trainingStartTime - Indicates the time when the training starts on documentation classifiers. You are billed for the time interval between this time and the value of TrainingEndTime.

$sel:dataAccessRoleArn:DocumentClassifierProperties', documentClassifierProperties_dataAccessRoleArn - The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.

$sel:message:DocumentClassifierProperties', documentClassifierProperties_message - Additional information about the status of the classifier.

$sel:submitTime:DocumentClassifierProperties', documentClassifierProperties_submitTime - The time that the document classifier was submitted for training.

DocumentClassifierSummary

data DocumentClassifierSummary Source #

Describes information about a document classifier and its versions.

See: newDocumentClassifierSummary smart constructor.

Instances

Instances details
Eq DocumentClassifierSummary Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClassifierSummary

Read DocumentClassifierSummary Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClassifierSummary

Show DocumentClassifierSummary Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClassifierSummary

Generic DocumentClassifierSummary Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClassifierSummary

Associated Types

type Rep DocumentClassifierSummary :: Type -> Type #

NFData DocumentClassifierSummary Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClassifierSummary

Hashable DocumentClassifierSummary Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClassifierSummary

FromJSON DocumentClassifierSummary Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClassifierSummary

type Rep DocumentClassifierSummary Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClassifierSummary

type Rep DocumentClassifierSummary = D1 ('MetaData "DocumentClassifierSummary" "Amazonka.Comprehend.Types.DocumentClassifierSummary" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "DocumentClassifierSummary'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "latestVersionCreatedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "documentClassifierName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "latestVersionStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ModelStatus)) :*: (S1 ('MetaSel ('Just "numberOfVersions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "latestVersionName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newDocumentClassifierSummary :: DocumentClassifierSummary Source #

Create a value of DocumentClassifierSummary with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:latestVersionCreatedAt:DocumentClassifierSummary', documentClassifierSummary_latestVersionCreatedAt - The time that the latest document classifier version was submitted for processing.

$sel:documentClassifierName:DocumentClassifierSummary', documentClassifierSummary_documentClassifierName - The name that you assigned the document classifier.

$sel:latestVersionStatus:DocumentClassifierSummary', documentClassifierSummary_latestVersionStatus - Provides the status of the latest document classifier version.

$sel:numberOfVersions:DocumentClassifierSummary', documentClassifierSummary_numberOfVersions - The number of versions you created.

$sel:latestVersionName:DocumentClassifierSummary', documentClassifierSummary_latestVersionName - The version name you assigned to the latest document classifier version.

DocumentLabel

data DocumentLabel Source #

Specifies one of the label or labels that categorize the document being analyzed.

See: newDocumentLabel smart constructor.

Instances

Instances details
Eq DocumentLabel Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentLabel

Read DocumentLabel Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentLabel

Show DocumentLabel Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentLabel

Generic DocumentLabel Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentLabel

Associated Types

type Rep DocumentLabel :: Type -> Type #

NFData DocumentLabel Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentLabel

Methods

rnf :: DocumentLabel -> () #

Hashable DocumentLabel Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentLabel

FromJSON DocumentLabel Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentLabel

type Rep DocumentLabel Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentLabel

type Rep DocumentLabel = D1 ('MetaData "DocumentLabel" "Amazonka.Comprehend.Types.DocumentLabel" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "DocumentLabel'" 'PrefixI 'True) (S1 ('MetaSel ('Just "score") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newDocumentLabel :: DocumentLabel Source #

Create a value of DocumentLabel with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:score:DocumentLabel', documentLabel_score - The confidence score that Amazon Comprehend has this label correctly attributed.

$sel:name:DocumentLabel', documentLabel_name - The name of the label.

DocumentReaderConfig

data DocumentReaderConfig Source #

The input properties for a topic detection job.

See: newDocumentReaderConfig smart constructor.

Instances

Instances details
Eq DocumentReaderConfig Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentReaderConfig

Read DocumentReaderConfig Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentReaderConfig

Show DocumentReaderConfig Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentReaderConfig

Generic DocumentReaderConfig Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentReaderConfig

Associated Types

type Rep DocumentReaderConfig :: Type -> Type #

NFData DocumentReaderConfig Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentReaderConfig

Methods

rnf :: DocumentReaderConfig -> () #

Hashable DocumentReaderConfig Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentReaderConfig

ToJSON DocumentReaderConfig Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentReaderConfig

FromJSON DocumentReaderConfig Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentReaderConfig

type Rep DocumentReaderConfig Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentReaderConfig

type Rep DocumentReaderConfig = D1 ('MetaData "DocumentReaderConfig" "Amazonka.Comprehend.Types.DocumentReaderConfig" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "DocumentReaderConfig'" 'PrefixI 'True) (S1 ('MetaSel ('Just "featureTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DocumentReadFeatureTypes))) :*: (S1 ('MetaSel ('Just "documentReadMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DocumentReadMode)) :*: S1 ('MetaSel ('Just "documentReadAction") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DocumentReadAction))))

newDocumentReaderConfig Source #

Create a value of DocumentReaderConfig with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:featureTypes:DocumentReaderConfig', documentReaderConfig_featureTypes - Specifies how the text in an input file should be processed:

$sel:documentReadMode:DocumentReaderConfig', documentReaderConfig_documentReadMode - This enum field provides two values:

  • SERVICE_DEFAULT - use service defaults for Document reading. For Digital PDF it would mean using an internal parser instead of Textract APIs
  • FORCE_DOCUMENT_READ_ACTION - Always use specified action for DocumentReadAction, including Digital PDF.

$sel:documentReadAction:DocumentReaderConfig', documentReaderConfig_documentReadAction - This enum field will start with two values which will apply to PDFs:

  • TEXTRACT_DETECT_DOCUMENT_TEXT - The service calls DetectDocumentText for PDF documents per page.
  • TEXTRACT_ANALYZE_DOCUMENT - The service calls AnalyzeDocument for PDF documents per page.

DominantLanguage

data DominantLanguage Source #

Returns the code for the dominant language in the input text and the level of confidence that Amazon Comprehend has in the accuracy of the detection.

See: newDominantLanguage smart constructor.

Instances

Instances details
Eq DominantLanguage Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DominantLanguage

Read DominantLanguage Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DominantLanguage

Show DominantLanguage Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DominantLanguage

Generic DominantLanguage Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DominantLanguage

Associated Types

type Rep DominantLanguage :: Type -> Type #

NFData DominantLanguage Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DominantLanguage

Methods

rnf :: DominantLanguage -> () #

Hashable DominantLanguage Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DominantLanguage

FromJSON DominantLanguage Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DominantLanguage

type Rep DominantLanguage Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DominantLanguage

type Rep DominantLanguage = D1 ('MetaData "DominantLanguage" "Amazonka.Comprehend.Types.DominantLanguage" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "DominantLanguage'" 'PrefixI 'True) (S1 ('MetaSel ('Just "languageCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "score") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double))))

newDominantLanguage :: DominantLanguage Source #

Create a value of DominantLanguage with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:languageCode:DominantLanguage', dominantLanguage_languageCode - The RFC 5646 language code for the dominant language. For more information about RFC 5646, see Tags for Identifying Languages on the IETF Tools web site.

$sel:score:DominantLanguage', dominantLanguage_score - The level of confidence that Amazon Comprehend has in the accuracy of the detection.

DominantLanguageDetectionJobFilter

data DominantLanguageDetectionJobFilter Source #

Provides information for filtering a list of dominant language detection jobs. For more information, see the operation.

See: newDominantLanguageDetectionJobFilter smart constructor.

Instances

Instances details
Eq DominantLanguageDetectionJobFilter Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DominantLanguageDetectionJobFilter

Read DominantLanguageDetectionJobFilter Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DominantLanguageDetectionJobFilter

Show DominantLanguageDetectionJobFilter Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DominantLanguageDetectionJobFilter

Generic DominantLanguageDetectionJobFilter Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DominantLanguageDetectionJobFilter

Associated Types

type Rep DominantLanguageDetectionJobFilter :: Type -> Type #

NFData DominantLanguageDetectionJobFilter Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DominantLanguageDetectionJobFilter

Hashable DominantLanguageDetectionJobFilter Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DominantLanguageDetectionJobFilter

ToJSON DominantLanguageDetectionJobFilter Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DominantLanguageDetectionJobFilter

type Rep DominantLanguageDetectionJobFilter Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DominantLanguageDetectionJobFilter

type Rep DominantLanguageDetectionJobFilter = D1 ('MetaData "DominantLanguageDetectionJobFilter" "Amazonka.Comprehend.Types.DominantLanguageDetectionJobFilter" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "DominantLanguageDetectionJobFilter'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "submitTimeAfter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "submitTimeBefore") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :*: (S1 ('MetaSel ('Just "jobName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "jobStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobStatus)))))

newDominantLanguageDetectionJobFilter :: DominantLanguageDetectionJobFilter Source #

Create a value of DominantLanguageDetectionJobFilter with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:submitTimeAfter:DominantLanguageDetectionJobFilter', dominantLanguageDetectionJobFilter_submitTimeAfter - Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted after the specified time. Jobs are returned in descending order, newest to oldest.

$sel:submitTimeBefore:DominantLanguageDetectionJobFilter', dominantLanguageDetectionJobFilter_submitTimeBefore - Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted before the specified time. Jobs are returned in ascending order, oldest to newest.

$sel:jobName:DominantLanguageDetectionJobFilter', dominantLanguageDetectionJobFilter_jobName - Filters on the name of the job.

$sel:jobStatus:DominantLanguageDetectionJobFilter', dominantLanguageDetectionJobFilter_jobStatus - Filters the list of jobs based on job status. Returns only jobs with the specified status.

DominantLanguageDetectionJobProperties

data DominantLanguageDetectionJobProperties Source #

Provides information about a dominant language detection job.

See: newDominantLanguageDetectionJobProperties smart constructor.

Instances

Instances details
Eq DominantLanguageDetectionJobProperties Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DominantLanguageDetectionJobProperties

Read DominantLanguageDetectionJobProperties Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DominantLanguageDetectionJobProperties

Show DominantLanguageDetectionJobProperties Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DominantLanguageDetectionJobProperties

Generic DominantLanguageDetectionJobProperties Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DominantLanguageDetectionJobProperties

NFData DominantLanguageDetectionJobProperties Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DominantLanguageDetectionJobProperties

Hashable DominantLanguageDetectionJobProperties Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DominantLanguageDetectionJobProperties

FromJSON DominantLanguageDetectionJobProperties Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DominantLanguageDetectionJobProperties

type Rep DominantLanguageDetectionJobProperties Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DominantLanguageDetectionJobProperties

type Rep DominantLanguageDetectionJobProperties = D1 ('MetaData "DominantLanguageDetectionJobProperties" "Amazonka.Comprehend.Types.DominantLanguageDetectionJobProperties" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "DominantLanguageDetectionJobProperties'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "jobArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "jobName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "inputDataConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InputDataConfig)) :*: (S1 ('MetaSel ('Just "vpcConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VpcConfig)) :*: S1 ('MetaSel ('Just "volumeKmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "endTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "outputDataConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OutputDataConfig)) :*: S1 ('MetaSel ('Just "dataAccessRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "jobStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobStatus)) :*: (S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "submitTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))))))

newDominantLanguageDetectionJobProperties :: DominantLanguageDetectionJobProperties Source #

Create a value of DominantLanguageDetectionJobProperties with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:jobId:DominantLanguageDetectionJobProperties', dominantLanguageDetectionJobProperties_jobId - The identifier assigned to the dominant language detection job.

$sel:jobArn:DominantLanguageDetectionJobProperties', dominantLanguageDetectionJobProperties_jobArn - The Amazon Resource Name (ARN) of the dominant language detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:

arn:<partition>:comprehend:<region>:<account-id>:dominant-language-detection-job/<job-id>

The following is an example job ARN:

arn:aws:comprehend:us-west-2:111122223333:dominant-language-detection-job/1234abcd12ab34cd56ef1234567890ab

$sel:jobName:DominantLanguageDetectionJobProperties', dominantLanguageDetectionJobProperties_jobName - The name that you assigned to the dominant language detection job.

$sel:inputDataConfig:DominantLanguageDetectionJobProperties', dominantLanguageDetectionJobProperties_inputDataConfig - The input data configuration that you supplied when you created the dominant language detection job.

$sel:vpcConfig:DominantLanguageDetectionJobProperties', dominantLanguageDetectionJobProperties_vpcConfig - Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your dominant language detection job. For more information, see Amazon VPC.

$sel:volumeKmsKeyId:DominantLanguageDetectionJobProperties', dominantLanguageDetectionJobProperties_volumeKmsKeyId - ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:

  • KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
  • Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

$sel:endTime:DominantLanguageDetectionJobProperties', dominantLanguageDetectionJobProperties_endTime - The time that the dominant language detection job completed.

$sel:outputDataConfig:DominantLanguageDetectionJobProperties', dominantLanguageDetectionJobProperties_outputDataConfig - The output data configuration that you supplied when you created the dominant language detection job.

$sel:dataAccessRoleArn:DominantLanguageDetectionJobProperties', dominantLanguageDetectionJobProperties_dataAccessRoleArn - The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.

$sel:jobStatus:DominantLanguageDetectionJobProperties', dominantLanguageDetectionJobProperties_jobStatus - The current status of the dominant language detection job. If the status is FAILED, the Message field shows the reason for the failure.

$sel:message:DominantLanguageDetectionJobProperties', dominantLanguageDetectionJobProperties_message - A description for the status of a job.

$sel:submitTime:DominantLanguageDetectionJobProperties', dominantLanguageDetectionJobProperties_submitTime - The time that the dominant language detection job was submitted for processing.

EndpointFilter

data EndpointFilter Source #

The filter used to determine which endpoints are returned. You can filter jobs on their name, model, status, or the date and time that they were created. You can only set one filter at a time.

See: newEndpointFilter smart constructor.

Instances

Instances details
Eq EndpointFilter Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EndpointFilter

Read EndpointFilter Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EndpointFilter

Show EndpointFilter Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EndpointFilter

Generic EndpointFilter Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EndpointFilter

Associated Types

type Rep EndpointFilter :: Type -> Type #

NFData EndpointFilter Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EndpointFilter

Methods

rnf :: EndpointFilter -> () #

Hashable EndpointFilter Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EndpointFilter

ToJSON EndpointFilter Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EndpointFilter

type Rep EndpointFilter Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EndpointFilter

type Rep EndpointFilter = D1 ('MetaData "EndpointFilter" "Amazonka.Comprehend.Types.EndpointFilter" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "EndpointFilter'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EndpointStatus)) :*: S1 ('MetaSel ('Just "modelArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "creationTimeAfter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "creationTimeBefore") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))))

newEndpointFilter :: EndpointFilter Source #

Create a value of EndpointFilter with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:status:EndpointFilter', endpointFilter_status - Specifies the status of the endpoint being returned. Possible values are: Creating, Ready, Updating, Deleting, Failed.

$sel:modelArn:EndpointFilter', endpointFilter_modelArn - The Amazon Resource Number (ARN) of the model to which the endpoint is attached.

$sel:creationTimeAfter:EndpointFilter', endpointFilter_creationTimeAfter - Specifies a date after which the returned endpoint or endpoints were created.

$sel:creationTimeBefore:EndpointFilter', endpointFilter_creationTimeBefore - Specifies a date before which the returned endpoint or endpoints were created.

EndpointProperties

data EndpointProperties Source #

Specifies information about the specified endpoint.

See: newEndpointProperties smart constructor.

Instances

Instances details
Eq EndpointProperties Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EndpointProperties

Read EndpointProperties Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EndpointProperties

Show EndpointProperties Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EndpointProperties

Generic EndpointProperties Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EndpointProperties

Associated Types

type Rep EndpointProperties :: Type -> Type #

NFData EndpointProperties Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EndpointProperties

Methods

rnf :: EndpointProperties -> () #

Hashable EndpointProperties Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EndpointProperties

FromJSON EndpointProperties Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EndpointProperties

type Rep EndpointProperties Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EndpointProperties

type Rep EndpointProperties = D1 ('MetaData "EndpointProperties" "Amazonka.Comprehend.Types.EndpointProperties" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "EndpointProperties'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EndpointStatus))) :*: (S1 ('MetaSel ('Just "modelArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "desiredModelArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "lastModifiedTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))))) :*: ((S1 ('MetaSel ('Just "desiredInferenceUnits") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "currentInferenceUnits") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "dataAccessRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "desiredDataAccessRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "endpointArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

newEndpointProperties :: EndpointProperties Source #

Create a value of EndpointProperties with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:creationTime:EndpointProperties', endpointProperties_creationTime - The creation date and time of the endpoint.

$sel:status:EndpointProperties', endpointProperties_status - Specifies the status of the endpoint. Because the endpoint updates and creation are asynchronous, so customers will need to wait for the endpoint to be Ready status before making inference requests.

$sel:modelArn:EndpointProperties', endpointProperties_modelArn - The Amazon Resource Number (ARN) of the model to which the endpoint is attached.

$sel:desiredModelArn:EndpointProperties', endpointProperties_desiredModelArn - ARN of the new model to use for updating an existing endpoint. This ARN is going to be different from the model ARN when the update is in progress

$sel:lastModifiedTime:EndpointProperties', endpointProperties_lastModifiedTime - The date and time that the endpoint was last modified.

$sel:desiredInferenceUnits:EndpointProperties', endpointProperties_desiredInferenceUnits - 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.

$sel:currentInferenceUnits:EndpointProperties', endpointProperties_currentInferenceUnits - The number of inference units currently used by the model using this endpoint.

$sel:dataAccessRoleArn:EndpointProperties', endpointProperties_dataAccessRoleArn - The Amazon Resource Name (ARN) of the AWS identity and Access Management (IAM) role that grants Amazon Comprehend read access to trained custom models encrypted with a customer managed key (ModelKmsKeyId).

$sel:desiredDataAccessRoleArn:EndpointProperties', endpointProperties_desiredDataAccessRoleArn - Data access role ARN to use in case the new model is encrypted with a customer KMS key.

$sel:message:EndpointProperties', endpointProperties_message - Specifies a reason for failure in cases of Failed status.

$sel:endpointArn:EndpointProperties', endpointProperties_endpointArn - The Amazon Resource Number (ARN) of the endpoint.

EntitiesDetectionJobFilter

data EntitiesDetectionJobFilter Source #

Provides information for filtering a list of dominant language detection jobs. For more information, see the operation.

See: newEntitiesDetectionJobFilter smart constructor.

Instances

Instances details
Eq EntitiesDetectionJobFilter Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntitiesDetectionJobFilter

Read EntitiesDetectionJobFilter Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntitiesDetectionJobFilter

Show EntitiesDetectionJobFilter Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntitiesDetectionJobFilter

Generic EntitiesDetectionJobFilter Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntitiesDetectionJobFilter

Associated Types

type Rep EntitiesDetectionJobFilter :: Type -> Type #

NFData EntitiesDetectionJobFilter Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntitiesDetectionJobFilter

Hashable EntitiesDetectionJobFilter Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntitiesDetectionJobFilter

ToJSON EntitiesDetectionJobFilter Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntitiesDetectionJobFilter

type Rep EntitiesDetectionJobFilter Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntitiesDetectionJobFilter

type Rep EntitiesDetectionJobFilter = D1 ('MetaData "EntitiesDetectionJobFilter" "Amazonka.Comprehend.Types.EntitiesDetectionJobFilter" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "EntitiesDetectionJobFilter'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "submitTimeAfter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "submitTimeBefore") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :*: (S1 ('MetaSel ('Just "jobName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "jobStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobStatus)))))

newEntitiesDetectionJobFilter :: EntitiesDetectionJobFilter Source #

Create a value of EntitiesDetectionJobFilter with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:submitTimeAfter:EntitiesDetectionJobFilter', entitiesDetectionJobFilter_submitTimeAfter - Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted after the specified time. Jobs are returned in descending order, newest to oldest.

$sel:submitTimeBefore:EntitiesDetectionJobFilter', entitiesDetectionJobFilter_submitTimeBefore - Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted before the specified time. Jobs are returned in ascending order, oldest to newest.

$sel:jobName:EntitiesDetectionJobFilter', entitiesDetectionJobFilter_jobName - Filters on the name of the job.

$sel:jobStatus:EntitiesDetectionJobFilter', entitiesDetectionJobFilter_jobStatus - Filters the list of jobs based on job status. Returns only jobs with the specified status.

EntitiesDetectionJobProperties

data EntitiesDetectionJobProperties Source #

Provides information about an entities detection job.

See: newEntitiesDetectionJobProperties smart constructor.

Instances

Instances details
Eq EntitiesDetectionJobProperties Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntitiesDetectionJobProperties

Read EntitiesDetectionJobProperties Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntitiesDetectionJobProperties

Show EntitiesDetectionJobProperties Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntitiesDetectionJobProperties

Generic EntitiesDetectionJobProperties Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntitiesDetectionJobProperties

Associated Types

type Rep EntitiesDetectionJobProperties :: Type -> Type #

NFData EntitiesDetectionJobProperties Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntitiesDetectionJobProperties

Hashable EntitiesDetectionJobProperties Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntitiesDetectionJobProperties

FromJSON EntitiesDetectionJobProperties Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntitiesDetectionJobProperties

type Rep EntitiesDetectionJobProperties Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntitiesDetectionJobProperties

type Rep EntitiesDetectionJobProperties = D1 ('MetaData "EntitiesDetectionJobProperties" "Amazonka.Comprehend.Types.EntitiesDetectionJobProperties" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "EntitiesDetectionJobProperties'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "languageCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LanguageCode)) :*: (S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "jobArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "entityRecognizerArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "jobName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "inputDataConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InputDataConfig)) :*: S1 ('MetaSel ('Just "vpcConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VpcConfig))))) :*: ((S1 ('MetaSel ('Just "volumeKmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "endTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "outputDataConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OutputDataConfig)))) :*: ((S1 ('MetaSel ('Just "dataAccessRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "jobStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobStatus))) :*: (S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "submitTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))))))

newEntitiesDetectionJobProperties :: EntitiesDetectionJobProperties Source #

Create a value of EntitiesDetectionJobProperties with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:languageCode:EntitiesDetectionJobProperties', entitiesDetectionJobProperties_languageCode - The language code of the input documents.

$sel:jobId:EntitiesDetectionJobProperties', entitiesDetectionJobProperties_jobId - The identifier assigned to the entities detection job.

$sel:jobArn:EntitiesDetectionJobProperties', entitiesDetectionJobProperties_jobArn - The Amazon Resource Name (ARN) of the entities detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:

arn:<partition>:comprehend:<region>:<account-id>:entities-detection-job/<job-id>

The following is an example job ARN:

arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/1234abcd12ab34cd56ef1234567890ab

$sel:entityRecognizerArn:EntitiesDetectionJobProperties', entitiesDetectionJobProperties_entityRecognizerArn - The Amazon Resource Name (ARN) that identifies the entity recognizer.

$sel:jobName:EntitiesDetectionJobProperties', entitiesDetectionJobProperties_jobName - The name that you assigned the entities detection job.

$sel:inputDataConfig:EntitiesDetectionJobProperties', entitiesDetectionJobProperties_inputDataConfig - The input data configuration that you supplied when you created the entities detection job.

$sel:vpcConfig:EntitiesDetectionJobProperties', entitiesDetectionJobProperties_vpcConfig - Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your entity detection job. For more information, see Amazon VPC.

$sel:volumeKmsKeyId:EntitiesDetectionJobProperties', entitiesDetectionJobProperties_volumeKmsKeyId - ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:

  • KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
  • Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

$sel:endTime:EntitiesDetectionJobProperties', entitiesDetectionJobProperties_endTime - The time that the entities detection job completed

$sel:outputDataConfig:EntitiesDetectionJobProperties', entitiesDetectionJobProperties_outputDataConfig - The output data configuration that you supplied when you created the entities detection job.

$sel:dataAccessRoleArn:EntitiesDetectionJobProperties', entitiesDetectionJobProperties_dataAccessRoleArn - The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.

$sel:jobStatus:EntitiesDetectionJobProperties', entitiesDetectionJobProperties_jobStatus - The current status of the entities detection job. If the status is FAILED, the Message field shows the reason for the failure.

$sel:message:EntitiesDetectionJobProperties', entitiesDetectionJobProperties_message - A description of the status of a job.

$sel:submitTime:EntitiesDetectionJobProperties', entitiesDetectionJobProperties_submitTime - The time that the entities detection job was submitted for processing.

Entity

data Entity Source #

Provides information about an entity.

See: newEntity smart constructor.

Instances

Instances details
Eq Entity Source # 
Instance details

Defined in Amazonka.Comprehend.Types.Entity

Methods

(==) :: Entity -> Entity -> Bool #

(/=) :: Entity -> Entity -> Bool #

Read Entity Source # 
Instance details

Defined in Amazonka.Comprehend.Types.Entity

Show Entity Source # 
Instance details

Defined in Amazonka.Comprehend.Types.Entity

Generic Entity Source # 
Instance details

Defined in Amazonka.Comprehend.Types.Entity

Associated Types

type Rep Entity :: Type -> Type #

Methods

from :: Entity -> Rep Entity x #

to :: Rep Entity x -> Entity #

NFData Entity Source # 
Instance details

Defined in Amazonka.Comprehend.Types.Entity

Methods

rnf :: Entity -> () #

Hashable Entity Source # 
Instance details

Defined in Amazonka.Comprehend.Types.Entity

Methods

hashWithSalt :: Int -> Entity -> Int #

hash :: Entity -> Int #

FromJSON Entity Source # 
Instance details

Defined in Amazonka.Comprehend.Types.Entity

type Rep Entity Source # 
Instance details

Defined in Amazonka.Comprehend.Types.Entity

type Rep Entity = D1 ('MetaData "Entity" "Amazonka.Comprehend.Types.Entity" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "Entity'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "beginOffset") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "text") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "score") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :*: (S1 ('MetaSel ('Just "endOffset") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EntityType))))))

newEntity :: Entity Source #

Create a value of Entity with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:beginOffset:Entity', entity_beginOffset - A character offset in the input text that shows where the entity begins (the first character is at position 0). The offset returns the position of each UTF-8 code point in the string. A code point is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.

$sel:text:Entity', entity_text - The text of the entity.

$sel:score:Entity', entity_score - The level of confidence that Amazon Comprehend has in the accuracy of the detection.

$sel:endOffset:Entity', entity_endOffset - A character offset in the input text that shows where the entity ends. The offset returns the position of each UTF-8 code point in the string. A code point is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.

$sel:type':Entity', entity_type - The entity's type.

EntityLabel

data EntityLabel Source #

Specifies one of the label or labels that categorize the personally identifiable information (PII) entity being analyzed.

See: newEntityLabel smart constructor.

Instances

Instances details
Eq EntityLabel Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityLabel

Read EntityLabel Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityLabel

Show EntityLabel Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityLabel

Generic EntityLabel Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityLabel

Associated Types

type Rep EntityLabel :: Type -> Type #

NFData EntityLabel Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityLabel

Methods

rnf :: EntityLabel -> () #

Hashable EntityLabel Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityLabel

FromJSON EntityLabel Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityLabel

type Rep EntityLabel Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityLabel

type Rep EntityLabel = D1 ('MetaData "EntityLabel" "Amazonka.Comprehend.Types.EntityLabel" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "EntityLabel'" 'PrefixI 'True) (S1 ('MetaSel ('Just "score") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PiiEntityType))))

newEntityLabel :: EntityLabel Source #

Create a value of EntityLabel with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:score:EntityLabel', entityLabel_score - The level of confidence that Amazon Comprehend has in the accuracy of the detection.

$sel:name:EntityLabel', entityLabel_name - The name of the label.

EntityRecognizerAnnotations

data EntityRecognizerAnnotations Source #

Describes the annotations associated with a entity recognizer.

See: newEntityRecognizerAnnotations smart constructor.

Instances

Instances details
Eq EntityRecognizerAnnotations Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerAnnotations

Read EntityRecognizerAnnotations Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerAnnotations

Show EntityRecognizerAnnotations Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerAnnotations

Generic EntityRecognizerAnnotations Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerAnnotations

Associated Types

type Rep EntityRecognizerAnnotations :: Type -> Type #

NFData EntityRecognizerAnnotations Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerAnnotations

Hashable EntityRecognizerAnnotations Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerAnnotations

ToJSON EntityRecognizerAnnotations Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerAnnotations

FromJSON EntityRecognizerAnnotations Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerAnnotations

type Rep EntityRecognizerAnnotations Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerAnnotations

type Rep EntityRecognizerAnnotations = D1 ('MetaData "EntityRecognizerAnnotations" "Amazonka.Comprehend.Types.EntityRecognizerAnnotations" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "EntityRecognizerAnnotations'" 'PrefixI 'True) (S1 ('MetaSel ('Just "testS3Uri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "s3Uri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newEntityRecognizerAnnotations Source #

Create a value of EntityRecognizerAnnotations with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:testS3Uri:EntityRecognizerAnnotations', entityRecognizerAnnotations_testS3Uri - This specifies the Amazon S3 location where the test annotations for an entity recognizer are located. The URI must be in the same AWS Region as the API endpoint that you are calling.

$sel:s3Uri:EntityRecognizerAnnotations', entityRecognizerAnnotations_s3Uri - Specifies the Amazon S3 location where the annotations for an entity recognizer are located. The URI must be in the same region as the API endpoint that you are calling.

EntityRecognizerDocuments

data EntityRecognizerDocuments Source #

Describes the training documents submitted with an entity recognizer.

See: newEntityRecognizerDocuments smart constructor.

Instances

Instances details
Eq EntityRecognizerDocuments Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerDocuments

Read EntityRecognizerDocuments Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerDocuments

Show EntityRecognizerDocuments Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerDocuments

Generic EntityRecognizerDocuments Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerDocuments

Associated Types

type Rep EntityRecognizerDocuments :: Type -> Type #

NFData EntityRecognizerDocuments Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerDocuments

Hashable EntityRecognizerDocuments Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerDocuments

ToJSON EntityRecognizerDocuments Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerDocuments

FromJSON EntityRecognizerDocuments Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerDocuments

type Rep EntityRecognizerDocuments Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerDocuments

type Rep EntityRecognizerDocuments = D1 ('MetaData "EntityRecognizerDocuments" "Amazonka.Comprehend.Types.EntityRecognizerDocuments" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "EntityRecognizerDocuments'" 'PrefixI 'True) (S1 ('MetaSel ('Just "inputFormat") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InputFormat)) :*: (S1 ('MetaSel ('Just "testS3Uri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "s3Uri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newEntityRecognizerDocuments Source #

Create a value of EntityRecognizerDocuments with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:inputFormat:EntityRecognizerDocuments', entityRecognizerDocuments_inputFormat - Specifies how the text in an input file should be processed. This is optional, and the default is ONE_DOC_PER_LINE. ONE_DOC_PER_FILE - Each file is considered a separate document. Use this option when you are processing large documents, such as newspaper articles or scientific papers. ONE_DOC_PER_LINE - Each line in a file is considered a separate document. Use this option when you are processing many short documents, such as text messages.

$sel:testS3Uri:EntityRecognizerDocuments', entityRecognizerDocuments_testS3Uri - Specifies the Amazon S3 location where the test documents for an entity recognizer are located. The URI must be in the same AWS Region as the API endpoint that you are calling.

$sel:s3Uri:EntityRecognizerDocuments', entityRecognizerDocuments_s3Uri - Specifies the Amazon S3 location where the training documents for an entity recognizer are located. The URI must be in the same region as the API endpoint that you are calling.

EntityRecognizerEntityList

data EntityRecognizerEntityList Source #

Describes the entity recognizer submitted with an entity recognizer.

See: newEntityRecognizerEntityList smart constructor.

Instances

Instances details
Eq EntityRecognizerEntityList Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerEntityList

Read EntityRecognizerEntityList Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerEntityList

Show EntityRecognizerEntityList Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerEntityList

Generic EntityRecognizerEntityList Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerEntityList

Associated Types

type Rep EntityRecognizerEntityList :: Type -> Type #

NFData EntityRecognizerEntityList Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerEntityList

Hashable EntityRecognizerEntityList Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerEntityList

ToJSON EntityRecognizerEntityList Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerEntityList

FromJSON EntityRecognizerEntityList Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerEntityList

type Rep EntityRecognizerEntityList Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerEntityList

type Rep EntityRecognizerEntityList = D1 ('MetaData "EntityRecognizerEntityList" "Amazonka.Comprehend.Types.EntityRecognizerEntityList" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "EntityRecognizerEntityList'" 'PrefixI 'True) (S1 ('MetaSel ('Just "s3Uri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newEntityRecognizerEntityList Source #

Create a value of EntityRecognizerEntityList with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:s3Uri:EntityRecognizerEntityList', entityRecognizerEntityList_s3Uri - Specifies the Amazon S3 location where the entity list is located. The URI must be in the same region as the API endpoint that you are calling.

EntityRecognizerEvaluationMetrics

data EntityRecognizerEvaluationMetrics Source #

Detailed information about the accuracy of an entity recognizer.

See: newEntityRecognizerEvaluationMetrics smart constructor.

Instances

Instances details
Eq EntityRecognizerEvaluationMetrics Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerEvaluationMetrics

Read EntityRecognizerEvaluationMetrics Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerEvaluationMetrics

Show EntityRecognizerEvaluationMetrics Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerEvaluationMetrics

Generic EntityRecognizerEvaluationMetrics Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerEvaluationMetrics

Associated Types

type Rep EntityRecognizerEvaluationMetrics :: Type -> Type #

NFData EntityRecognizerEvaluationMetrics Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerEvaluationMetrics

Hashable EntityRecognizerEvaluationMetrics Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerEvaluationMetrics

FromJSON EntityRecognizerEvaluationMetrics Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerEvaluationMetrics

type Rep EntityRecognizerEvaluationMetrics Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerEvaluationMetrics

type Rep EntityRecognizerEvaluationMetrics = D1 ('MetaData "EntityRecognizerEvaluationMetrics" "Amazonka.Comprehend.Types.EntityRecognizerEvaluationMetrics" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "EntityRecognizerEvaluationMetrics'" 'PrefixI 'True) (S1 ('MetaSel ('Just "recall") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :*: (S1 ('MetaSel ('Just "precision") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :*: S1 ('MetaSel ('Just "f1Score") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)))))

newEntityRecognizerEvaluationMetrics :: EntityRecognizerEvaluationMetrics Source #

Create a value of EntityRecognizerEvaluationMetrics with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:recall:EntityRecognizerEvaluationMetrics', entityRecognizerEvaluationMetrics_recall - A measure of how complete the recognizer results are for the test data. High recall means that the recognizer returned most of the relevant results.

$sel:precision:EntityRecognizerEvaluationMetrics', entityRecognizerEvaluationMetrics_precision - A measure of the usefulness of the recognizer results in the test data. High precision means that the recognizer returned substantially more relevant results than irrelevant ones.

$sel:f1Score:EntityRecognizerEvaluationMetrics', entityRecognizerEvaluationMetrics_f1Score - A measure of how accurate the recognizer results are for the test data. It is derived from the Precision and Recall values. The F1Score is the harmonic average of the two scores. The highest score is 1, and the worst score is 0.

EntityRecognizerFilter

data EntityRecognizerFilter Source #

Provides information for filtering a list of entity recognizers. You can only specify one filtering parameter in a request. For more information, see the operation./>

See: newEntityRecognizerFilter smart constructor.

Instances

Instances details
Eq EntityRecognizerFilter Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerFilter

Read EntityRecognizerFilter Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerFilter

Show EntityRecognizerFilter Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerFilter

Generic EntityRecognizerFilter Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerFilter

Associated Types

type Rep EntityRecognizerFilter :: Type -> Type #

NFData EntityRecognizerFilter Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerFilter

Methods

rnf :: EntityRecognizerFilter -> () #

Hashable EntityRecognizerFilter Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerFilter

ToJSON EntityRecognizerFilter Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerFilter

type Rep EntityRecognizerFilter Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerFilter

type Rep EntityRecognizerFilter = D1 ('MetaData "EntityRecognizerFilter" "Amazonka.Comprehend.Types.EntityRecognizerFilter" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "EntityRecognizerFilter'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ModelStatus)) :*: S1 ('MetaSel ('Just "submitTimeAfter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :*: (S1 ('MetaSel ('Just "submitTimeBefore") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "recognizerName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newEntityRecognizerFilter :: EntityRecognizerFilter Source #

Create a value of EntityRecognizerFilter with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:status:EntityRecognizerFilter', entityRecognizerFilter_status - The status of an entity recognizer.

$sel:submitTimeAfter:EntityRecognizerFilter', entityRecognizerFilter_submitTimeAfter - Filters the list of entities based on the time that the list was submitted for processing. Returns only jobs submitted after the specified time. Jobs are returned in ascending order, oldest to newest.

$sel:submitTimeBefore:EntityRecognizerFilter', entityRecognizerFilter_submitTimeBefore - Filters the list of entities based on the time that the list was submitted for processing. Returns only jobs submitted before the specified time. Jobs are returned in descending order, newest to oldest.

$sel:recognizerName:EntityRecognizerFilter', entityRecognizerFilter_recognizerName - The name that you assigned the entity recognizer.

EntityRecognizerInputDataConfig

data EntityRecognizerInputDataConfig Source #

Specifies the format and location of the input data.

See: newEntityRecognizerInputDataConfig smart constructor.

Instances

Instances details
Eq EntityRecognizerInputDataConfig Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerInputDataConfig

Read EntityRecognizerInputDataConfig Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerInputDataConfig

Show EntityRecognizerInputDataConfig Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerInputDataConfig

Generic EntityRecognizerInputDataConfig Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerInputDataConfig

Associated Types

type Rep EntityRecognizerInputDataConfig :: Type -> Type #

NFData EntityRecognizerInputDataConfig Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerInputDataConfig

Hashable EntityRecognizerInputDataConfig Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerInputDataConfig

ToJSON EntityRecognizerInputDataConfig Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerInputDataConfig

FromJSON EntityRecognizerInputDataConfig Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerInputDataConfig

type Rep EntityRecognizerInputDataConfig Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerInputDataConfig

type Rep EntityRecognizerInputDataConfig = D1 ('MetaData "EntityRecognizerInputDataConfig" "Amazonka.Comprehend.Types.EntityRecognizerInputDataConfig" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "EntityRecognizerInputDataConfig'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "augmentedManifests") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [AugmentedManifestsListItem])) :*: (S1 ('MetaSel ('Just "annotations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EntityRecognizerAnnotations)) :*: S1 ('MetaSel ('Just "dataFormat") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EntityRecognizerDataFormat)))) :*: (S1 ('MetaSel ('Just "documents") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EntityRecognizerDocuments)) :*: (S1 ('MetaSel ('Just "entityList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EntityRecognizerEntityList)) :*: S1 ('MetaSel ('Just "entityTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [EntityTypesListItem])))))

newEntityRecognizerInputDataConfig :: EntityRecognizerInputDataConfig Source #

Create a value of EntityRecognizerInputDataConfig with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:augmentedManifests:EntityRecognizerInputDataConfig', entityRecognizerInputDataConfig_augmentedManifests - A list of augmented manifest files that provide training data for your custom model. An augmented manifest file is a labeled dataset that is produced by Amazon SageMaker Ground Truth.

This parameter is required if you set DataFormat to AUGMENTED_MANIFEST.

$sel:annotations:EntityRecognizerInputDataConfig', entityRecognizerInputDataConfig_annotations - The S3 location of the CSV file that annotates your training documents.

$sel:dataFormat:EntityRecognizerInputDataConfig', entityRecognizerInputDataConfig_dataFormat - The format of your training data:

  • COMPREHEND_CSV: A CSV file that supplements your training documents. The CSV file contains information about the custom entities that your trained model will detect. The required format of the file depends on whether you are providing annotations or an entity list.

    If you use this value, you must provide your CSV file by using either the Annotations or EntityList parameters. You must provide your training documents by using the Documents parameter.

  • AUGMENTED_MANIFEST: A labeled dataset that is produced by Amazon SageMaker Ground Truth. This file is in JSON lines format. Each line is a complete JSON object that contains a training document and its labels. Each label annotates a named entity in the training document.

    If you use this value, you must provide the AugmentedManifests parameter in your request.

If you don't specify a value, Amazon Comprehend uses COMPREHEND_CSV as the default.

$sel:documents:EntityRecognizerInputDataConfig', entityRecognizerInputDataConfig_documents - The S3 location of the folder that contains the training documents for your custom entity recognizer.

This parameter is required if you set DataFormat to COMPREHEND_CSV.

$sel:entityList:EntityRecognizerInputDataConfig', entityRecognizerInputDataConfig_entityList - The S3 location of the CSV file that has the entity list for your custom entity recognizer.

$sel:entityTypes:EntityRecognizerInputDataConfig', entityRecognizerInputDataConfig_entityTypes - The entity types in the labeled training data that Amazon Comprehend uses to train the custom entity recognizer. Any entity types that you don't specify are ignored.

A maximum of 25 entity types can be used at one time to train an entity recognizer. Entity types must not contain the following invalid characters: \n (line break), \\n (escaped line break), \r (carriage return), \\r (escaped carriage return), \t (tab), \\t (escaped tab), space, and , (comma).

EntityRecognizerMetadata

data EntityRecognizerMetadata Source #

Detailed information about an entity recognizer.

See: newEntityRecognizerMetadata smart constructor.

Instances

Instances details
Eq EntityRecognizerMetadata Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerMetadata

Show EntityRecognizerMetadata Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerMetadata

Generic EntityRecognizerMetadata Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerMetadata

Associated Types

type Rep EntityRecognizerMetadata :: Type -> Type #

NFData EntityRecognizerMetadata Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerMetadata

Hashable EntityRecognizerMetadata Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerMetadata

FromJSON EntityRecognizerMetadata Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerMetadata

type Rep EntityRecognizerMetadata Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerMetadata

type Rep EntityRecognizerMetadata = D1 ('MetaData "EntityRecognizerMetadata" "Amazonka.Comprehend.Types.EntityRecognizerMetadata" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "EntityRecognizerMetadata'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "entityTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [EntityRecognizerMetadataEntityTypesListItem])) :*: S1 ('MetaSel ('Just "evaluationMetrics") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EntityRecognizerEvaluationMetrics))) :*: (S1 ('MetaSel ('Just "numberOfTrainedDocuments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "numberOfTestDocuments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))))

newEntityRecognizerMetadata :: EntityRecognizerMetadata Source #

Create a value of EntityRecognizerMetadata with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:entityTypes:EntityRecognizerMetadata', entityRecognizerMetadata_entityTypes - Entity types from the metadata of an entity recognizer.

$sel:evaluationMetrics:EntityRecognizerMetadata', entityRecognizerMetadata_evaluationMetrics - Detailed information about the accuracy of an entity recognizer.

$sel:numberOfTrainedDocuments:EntityRecognizerMetadata', entityRecognizerMetadata_numberOfTrainedDocuments - The number of documents in the input data that were used to train the entity recognizer. Typically this is 80 to 90 percent of the input documents.

$sel:numberOfTestDocuments:EntityRecognizerMetadata', entityRecognizerMetadata_numberOfTestDocuments - The number of documents in the input data that were used to test the entity recognizer. Typically this is 10 to 20 percent of the input documents.

EntityRecognizerMetadataEntityTypesListItem

data EntityRecognizerMetadataEntityTypesListItem Source #

Individual item from the list of entity types in the metadata of an entity recognizer.

See: newEntityRecognizerMetadataEntityTypesListItem smart constructor.

Instances

Instances details
Eq EntityRecognizerMetadataEntityTypesListItem Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerMetadataEntityTypesListItem

Read EntityRecognizerMetadataEntityTypesListItem Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerMetadataEntityTypesListItem

Show EntityRecognizerMetadataEntityTypesListItem Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerMetadataEntityTypesListItem

Generic EntityRecognizerMetadataEntityTypesListItem Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerMetadataEntityTypesListItem

NFData EntityRecognizerMetadataEntityTypesListItem Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerMetadataEntityTypesListItem

Hashable EntityRecognizerMetadataEntityTypesListItem Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerMetadataEntityTypesListItem

FromJSON EntityRecognizerMetadataEntityTypesListItem Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerMetadataEntityTypesListItem

type Rep EntityRecognizerMetadataEntityTypesListItem Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerMetadataEntityTypesListItem

type Rep EntityRecognizerMetadataEntityTypesListItem = D1 ('MetaData "EntityRecognizerMetadataEntityTypesListItem" "Amazonka.Comprehend.Types.EntityRecognizerMetadataEntityTypesListItem" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "EntityRecognizerMetadataEntityTypesListItem'" 'PrefixI 'True) (S1 ('MetaSel ('Just "evaluationMetrics") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EntityTypesEvaluationMetrics)) :*: (S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "numberOfTrainMentions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))))

newEntityRecognizerMetadataEntityTypesListItem :: EntityRecognizerMetadataEntityTypesListItem Source #

Create a value of EntityRecognizerMetadataEntityTypesListItem with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:evaluationMetrics:EntityRecognizerMetadataEntityTypesListItem', entityRecognizerMetadataEntityTypesListItem_evaluationMetrics - Detailed information about the accuracy of the entity recognizer for a specific item on the list of entity types.

$sel:type':EntityRecognizerMetadataEntityTypesListItem', entityRecognizerMetadataEntityTypesListItem_type - Type of entity from the list of entity types in the metadata of an entity recognizer.

$sel:numberOfTrainMentions:EntityRecognizerMetadataEntityTypesListItem', entityRecognizerMetadataEntityTypesListItem_numberOfTrainMentions - Indicates the number of times the given entity type was seen in the training data.

EntityRecognizerProperties

data EntityRecognizerProperties Source #

Describes information about an entity recognizer.

See: newEntityRecognizerProperties smart constructor.

Instances

Instances details
Eq EntityRecognizerProperties Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerProperties

Show EntityRecognizerProperties Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerProperties

Generic EntityRecognizerProperties Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerProperties

Associated Types

type Rep EntityRecognizerProperties :: Type -> Type #

NFData EntityRecognizerProperties Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerProperties

Hashable EntityRecognizerProperties Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerProperties

FromJSON EntityRecognizerProperties Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerProperties

type Rep EntityRecognizerProperties Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerProperties

type Rep EntityRecognizerProperties = D1 ('MetaData "EntityRecognizerProperties" "Amazonka.Comprehend.Types.EntityRecognizerProperties" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "EntityRecognizerProperties'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ModelStatus)) :*: (S1 ('MetaSel ('Just "languageCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LanguageCode)) :*: S1 ('MetaSel ('Just "trainingEndTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :*: ((S1 ('MetaSel ('Just "versionName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "entityRecognizerArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "modelKmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "inputDataConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EntityRecognizerInputDataConfig))))) :*: (((S1 ('MetaSel ('Just "vpcConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VpcConfig)) :*: S1 ('MetaSel ('Just "volumeKmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "endTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "trainingStartTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :*: ((S1 ('MetaSel ('Just "dataAccessRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "recognizerMetadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive EntityRecognizerMetadata)))) :*: (S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "submitTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))))))

newEntityRecognizerProperties :: EntityRecognizerProperties Source #

Create a value of EntityRecognizerProperties with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:status:EntityRecognizerProperties', entityRecognizerProperties_status - Provides the status of the entity recognizer.

$sel:languageCode:EntityRecognizerProperties', entityRecognizerProperties_languageCode - The language of the input documents. All documents must be in the same language. Only English ("en") is currently supported.

$sel:trainingEndTime:EntityRecognizerProperties', entityRecognizerProperties_trainingEndTime - The time that training of the entity recognizer was completed.

$sel:versionName:EntityRecognizerProperties', entityRecognizerProperties_versionName - The version name you assigned to the entity recognizer.

$sel:entityRecognizerArn:EntityRecognizerProperties', entityRecognizerProperties_entityRecognizerArn - The Amazon Resource Name (ARN) that identifies the entity recognizer.

$sel:modelKmsKeyId:EntityRecognizerProperties', entityRecognizerProperties_modelKmsKeyId - ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId can be either of the following formats:

  • KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
  • Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

$sel:inputDataConfig:EntityRecognizerProperties', entityRecognizerProperties_inputDataConfig - The input data properties of an entity recognizer.

$sel:vpcConfig:EntityRecognizerProperties', entityRecognizerProperties_vpcConfig - Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your custom entity recognizer. For more information, see Amazon VPC.

$sel:volumeKmsKeyId:EntityRecognizerProperties', entityRecognizerProperties_volumeKmsKeyId - ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:

  • KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
  • Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

$sel:endTime:EntityRecognizerProperties', entityRecognizerProperties_endTime - The time that the recognizer creation completed.

$sel:trainingStartTime:EntityRecognizerProperties', entityRecognizerProperties_trainingStartTime - The time that training of the entity recognizer started.

$sel:dataAccessRoleArn:EntityRecognizerProperties', entityRecognizerProperties_dataAccessRoleArn - The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.

$sel:recognizerMetadata:EntityRecognizerProperties', entityRecognizerProperties_recognizerMetadata - Provides information about an entity recognizer.

$sel:message:EntityRecognizerProperties', entityRecognizerProperties_message - A description of the status of the recognizer.

$sel:submitTime:EntityRecognizerProperties', entityRecognizerProperties_submitTime - The time that the recognizer was submitted for processing.

EntityRecognizerSummary

data EntityRecognizerSummary Source #

Describes the information about an entity recognizer and its versions.

See: newEntityRecognizerSummary smart constructor.

Instances

Instances details
Eq EntityRecognizerSummary Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerSummary

Read EntityRecognizerSummary Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerSummary

Show EntityRecognizerSummary Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerSummary

Generic EntityRecognizerSummary Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerSummary

Associated Types

type Rep EntityRecognizerSummary :: Type -> Type #

NFData EntityRecognizerSummary Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerSummary

Methods

rnf :: EntityRecognizerSummary -> () #

Hashable EntityRecognizerSummary Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerSummary

FromJSON EntityRecognizerSummary Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerSummary

type Rep EntityRecognizerSummary Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerSummary

type Rep EntityRecognizerSummary = D1 ('MetaData "EntityRecognizerSummary" "Amazonka.Comprehend.Types.EntityRecognizerSummary" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "EntityRecognizerSummary'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "latestVersionCreatedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "latestVersionStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ModelStatus))) :*: (S1 ('MetaSel ('Just "numberOfVersions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "latestVersionName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "recognizerName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newEntityRecognizerSummary :: EntityRecognizerSummary Source #

Create a value of EntityRecognizerSummary with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:latestVersionCreatedAt:EntityRecognizerSummary', entityRecognizerSummary_latestVersionCreatedAt - The time that the latest entity recognizer version was submitted for processing.

$sel:latestVersionStatus:EntityRecognizerSummary', entityRecognizerSummary_latestVersionStatus - Provides the status of the latest entity recognizer version.

$sel:numberOfVersions:EntityRecognizerSummary', entityRecognizerSummary_numberOfVersions - The number of versions you created.

$sel:latestVersionName:EntityRecognizerSummary', entityRecognizerSummary_latestVersionName - The version name you assigned to the latest entity recognizer version.

$sel:recognizerName:EntityRecognizerSummary', entityRecognizerSummary_recognizerName - The name that you assigned the entity recognizer.

EntityTypesEvaluationMetrics

data EntityTypesEvaluationMetrics Source #

Detailed information about the accuracy of an entity recognizer for a specific entity type.

See: newEntityTypesEvaluationMetrics smart constructor.

Instances

Instances details
Eq EntityTypesEvaluationMetrics Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityTypesEvaluationMetrics

Read EntityTypesEvaluationMetrics Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityTypesEvaluationMetrics

Show EntityTypesEvaluationMetrics Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityTypesEvaluationMetrics

Generic EntityTypesEvaluationMetrics Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityTypesEvaluationMetrics

Associated Types

type Rep EntityTypesEvaluationMetrics :: Type -> Type #

NFData EntityTypesEvaluationMetrics Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityTypesEvaluationMetrics

Hashable EntityTypesEvaluationMetrics Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityTypesEvaluationMetrics

FromJSON EntityTypesEvaluationMetrics Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityTypesEvaluationMetrics

type Rep EntityTypesEvaluationMetrics Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityTypesEvaluationMetrics

type Rep EntityTypesEvaluationMetrics = D1 ('MetaData "EntityTypesEvaluationMetrics" "Amazonka.Comprehend.Types.EntityTypesEvaluationMetrics" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "EntityTypesEvaluationMetrics'" 'PrefixI 'True) (S1 ('MetaSel ('Just "recall") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :*: (S1 ('MetaSel ('Just "precision") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :*: S1 ('MetaSel ('Just "f1Score") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)))))

newEntityTypesEvaluationMetrics :: EntityTypesEvaluationMetrics Source #

Create a value of EntityTypesEvaluationMetrics with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:recall:EntityTypesEvaluationMetrics', entityTypesEvaluationMetrics_recall - A measure of how complete the recognizer results are for a specific entity type in the test data. High recall means that the recognizer returned most of the relevant results.

$sel:precision:EntityTypesEvaluationMetrics', entityTypesEvaluationMetrics_precision - A measure of the usefulness of the recognizer results for a specific entity type in the test data. High precision means that the recognizer returned substantially more relevant results than irrelevant ones.

$sel:f1Score:EntityTypesEvaluationMetrics', entityTypesEvaluationMetrics_f1Score - A measure of how accurate the recognizer results are for a specific entity type in the test data. It is derived from the Precision and Recall values. The F1Score is the harmonic average of the two scores. The highest score is 1, and the worst score is 0.

EntityTypesListItem

data EntityTypesListItem Source #

An entity type within a labeled training dataset that Amazon Comprehend uses to train a custom entity recognizer.

See: newEntityTypesListItem smart constructor.

Instances

Instances details
Eq EntityTypesListItem Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityTypesListItem

Read EntityTypesListItem Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityTypesListItem

Show EntityTypesListItem Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityTypesListItem

Generic EntityTypesListItem Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityTypesListItem

Associated Types

type Rep EntityTypesListItem :: Type -> Type #

NFData EntityTypesListItem Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityTypesListItem

Methods

rnf :: EntityTypesListItem -> () #

Hashable EntityTypesListItem Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityTypesListItem

ToJSON EntityTypesListItem Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityTypesListItem

FromJSON EntityTypesListItem Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityTypesListItem

type Rep EntityTypesListItem Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityTypesListItem

type Rep EntityTypesListItem = D1 ('MetaData "EntityTypesListItem" "Amazonka.Comprehend.Types.EntityTypesListItem" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "EntityTypesListItem'" 'PrefixI 'True) (S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newEntityTypesListItem Source #

Create a value of EntityTypesListItem with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:type':EntityTypesListItem', entityTypesListItem_type - An entity type within a labeled training dataset that Amazon Comprehend uses to train a custom entity recognizer.

Entity types must not contain the following invalid characters: \n (line break), \\n (escaped line break, \r (carriage return), \\r (escaped carriage return), \t (tab), \\t (escaped tab), space, and , (comma).

EventsDetectionJobFilter

data EventsDetectionJobFilter Source #

Provides information for filtering a list of event detection jobs.

See: newEventsDetectionJobFilter smart constructor.

Instances

Instances details
Eq EventsDetectionJobFilter Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EventsDetectionJobFilter

Read EventsDetectionJobFilter Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EventsDetectionJobFilter

Show EventsDetectionJobFilter Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EventsDetectionJobFilter

Generic EventsDetectionJobFilter Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EventsDetectionJobFilter

Associated Types

type Rep EventsDetectionJobFilter :: Type -> Type #

NFData EventsDetectionJobFilter Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EventsDetectionJobFilter

Hashable EventsDetectionJobFilter Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EventsDetectionJobFilter

ToJSON EventsDetectionJobFilter Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EventsDetectionJobFilter

type Rep EventsDetectionJobFilter Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EventsDetectionJobFilter

type Rep EventsDetectionJobFilter = D1 ('MetaData "EventsDetectionJobFilter" "Amazonka.Comprehend.Types.EventsDetectionJobFilter" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "EventsDetectionJobFilter'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "submitTimeAfter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "submitTimeBefore") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :*: (S1 ('MetaSel ('Just "jobName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "jobStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobStatus)))))

newEventsDetectionJobFilter :: EventsDetectionJobFilter Source #

Create a value of EventsDetectionJobFilter with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:submitTimeAfter:EventsDetectionJobFilter', eventsDetectionJobFilter_submitTimeAfter - Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted after the specified time. Jobs are returned in descending order, newest to oldest.

$sel:submitTimeBefore:EventsDetectionJobFilter', eventsDetectionJobFilter_submitTimeBefore - Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted before the specified time. Jobs are returned in ascending order, oldest to newest.

$sel:jobName:EventsDetectionJobFilter', eventsDetectionJobFilter_jobName - Filters on the name of the events detection job.

$sel:jobStatus:EventsDetectionJobFilter', eventsDetectionJobFilter_jobStatus - Filters the list of jobs based on job status. Returns only jobs with the specified status.

EventsDetectionJobProperties

data EventsDetectionJobProperties Source #

Provides information about an events detection job.

See: newEventsDetectionJobProperties smart constructor.

Instances

Instances details
Eq EventsDetectionJobProperties Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EventsDetectionJobProperties

Read EventsDetectionJobProperties Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EventsDetectionJobProperties

Show EventsDetectionJobProperties Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EventsDetectionJobProperties

Generic EventsDetectionJobProperties Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EventsDetectionJobProperties

Associated Types

type Rep EventsDetectionJobProperties :: Type -> Type #

NFData EventsDetectionJobProperties Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EventsDetectionJobProperties

Hashable EventsDetectionJobProperties Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EventsDetectionJobProperties

FromJSON EventsDetectionJobProperties Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EventsDetectionJobProperties

type Rep EventsDetectionJobProperties Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EventsDetectionJobProperties

type Rep EventsDetectionJobProperties = D1 ('MetaData "EventsDetectionJobProperties" "Amazonka.Comprehend.Types.EventsDetectionJobProperties" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "EventsDetectionJobProperties'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "languageCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LanguageCode)) :*: (S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "jobArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "jobName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "targetEventTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))) :*: S1 ('MetaSel ('Just "inputDataConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InputDataConfig))))) :*: ((S1 ('MetaSel ('Just "endTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "outputDataConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OutputDataConfig)) :*: S1 ('MetaSel ('Just "dataAccessRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "jobStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobStatus)) :*: (S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "submitTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))))))

newEventsDetectionJobProperties :: EventsDetectionJobProperties Source #

Create a value of EventsDetectionJobProperties with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:languageCode:EventsDetectionJobProperties', eventsDetectionJobProperties_languageCode - The language code of the input documents.

$sel:jobId:EventsDetectionJobProperties', eventsDetectionJobProperties_jobId - The identifier assigned to the events detection job.

$sel:jobArn:EventsDetectionJobProperties', eventsDetectionJobProperties_jobArn - The Amazon Resource Name (ARN) of the events detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:

arn:<partition>:comprehend:<region>:<account-id>:events-detection-job/<job-id>

The following is an example job ARN:

arn:aws:comprehend:us-west-2:111122223333:events-detection-job/1234abcd12ab34cd56ef1234567890ab

$sel:jobName:EventsDetectionJobProperties', eventsDetectionJobProperties_jobName - The name you assigned the events detection job.

$sel:targetEventTypes:EventsDetectionJobProperties', eventsDetectionJobProperties_targetEventTypes - The types of events that are detected by the job.

$sel:inputDataConfig:EventsDetectionJobProperties', eventsDetectionJobProperties_inputDataConfig - The input data configuration that you supplied when you created the events detection job.

$sel:endTime:EventsDetectionJobProperties', eventsDetectionJobProperties_endTime - The time that the events detection job completed.

$sel:outputDataConfig:EventsDetectionJobProperties', eventsDetectionJobProperties_outputDataConfig - The output data configuration that you supplied when you created the events detection job.

$sel:dataAccessRoleArn:EventsDetectionJobProperties', eventsDetectionJobProperties_dataAccessRoleArn - The Amazon Resource Name (ARN) of the AWS Identify and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.

$sel:jobStatus:EventsDetectionJobProperties', eventsDetectionJobProperties_jobStatus - The current status of the events detection job.

$sel:message:EventsDetectionJobProperties', eventsDetectionJobProperties_message - A description of the status of the events detection job.

$sel:submitTime:EventsDetectionJobProperties', eventsDetectionJobProperties_submitTime - The time that the events detection job was submitted for processing.

InputDataConfig

data InputDataConfig Source #

The input properties for an inference job.

See: newInputDataConfig smart constructor.

Instances

Instances details
Eq InputDataConfig Source # 
Instance details

Defined in Amazonka.Comprehend.Types.InputDataConfig

Read InputDataConfig Source # 
Instance details

Defined in Amazonka.Comprehend.Types.InputDataConfig

Show InputDataConfig Source # 
Instance details

Defined in Amazonka.Comprehend.Types.InputDataConfig

Generic InputDataConfig Source # 
Instance details

Defined in Amazonka.Comprehend.Types.InputDataConfig

Associated Types

type Rep InputDataConfig :: Type -> Type #

NFData InputDataConfig Source # 
Instance details

Defined in Amazonka.Comprehend.Types.InputDataConfig

Methods

rnf :: InputDataConfig -> () #

Hashable InputDataConfig Source # 
Instance details

Defined in Amazonka.Comprehend.Types.InputDataConfig

ToJSON InputDataConfig Source # 
Instance details

Defined in Amazonka.Comprehend.Types.InputDataConfig

FromJSON InputDataConfig Source # 
Instance details

Defined in Amazonka.Comprehend.Types.InputDataConfig

type Rep InputDataConfig Source # 
Instance details

Defined in Amazonka.Comprehend.Types.InputDataConfig

type Rep InputDataConfig = D1 ('MetaData "InputDataConfig" "Amazonka.Comprehend.Types.InputDataConfig" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "InputDataConfig'" 'PrefixI 'True) (S1 ('MetaSel ('Just "documentReaderConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DocumentReaderConfig)) :*: (S1 ('MetaSel ('Just "inputFormat") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InputFormat)) :*: S1 ('MetaSel ('Just "s3Uri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newInputDataConfig Source #

Create a value of InputDataConfig with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:documentReaderConfig:InputDataConfig', inputDataConfig_documentReaderConfig - The document reader config field applies only for InputDataConfig of StartEntitiesDetectionJob.

Use DocumentReaderConfig to provide specifications about how you want your inference documents read. Currently it applies for PDF documents in StartEntitiesDetectionJob custom inference.

$sel:inputFormat:InputDataConfig', inputDataConfig_inputFormat - Specifies how the text in an input file should be processed:

  • ONE_DOC_PER_FILE - Each file is considered a separate document. Use this option when you are processing large documents, such as newspaper articles or scientific papers.
  • ONE_DOC_PER_LINE - Each line in a file is considered a separate document. Use this option when you are processing many short documents, such as text messages.

$sel:s3Uri:InputDataConfig', inputDataConfig_s3Uri - The Amazon S3 URI for the input data. The URI must be in same region as the API endpoint that you are calling. The URI can point to a single input file or it can provide the prefix for a collection of data files.

For example, if you use the URI S3://bucketName/prefix, if the prefix is a single file, Amazon Comprehend uses that file as input. If more than one file begins with the prefix, Amazon Comprehend uses all of them as input.

KeyPhrase

data KeyPhrase Source #

Describes a key noun phrase.

See: newKeyPhrase smart constructor.

Instances

Instances details
Eq KeyPhrase Source # 
Instance details

Defined in Amazonka.Comprehend.Types.KeyPhrase

Read KeyPhrase Source # 
Instance details

Defined in Amazonka.Comprehend.Types.KeyPhrase

Show KeyPhrase Source # 
Instance details

Defined in Amazonka.Comprehend.Types.KeyPhrase

Generic KeyPhrase Source # 
Instance details

Defined in Amazonka.Comprehend.Types.KeyPhrase

Associated Types

type Rep KeyPhrase :: Type -> Type #

NFData KeyPhrase Source # 
Instance details

Defined in Amazonka.Comprehend.Types.KeyPhrase

Methods

rnf :: KeyPhrase -> () #

Hashable KeyPhrase Source # 
Instance details

Defined in Amazonka.Comprehend.Types.KeyPhrase

FromJSON KeyPhrase Source # 
Instance details

Defined in Amazonka.Comprehend.Types.KeyPhrase

type Rep KeyPhrase Source # 
Instance details

Defined in Amazonka.Comprehend.Types.KeyPhrase

type Rep KeyPhrase = D1 ('MetaData "KeyPhrase" "Amazonka.Comprehend.Types.KeyPhrase" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "KeyPhrase'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "beginOffset") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "text") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "score") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :*: S1 ('MetaSel ('Just "endOffset") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))))

newKeyPhrase :: KeyPhrase Source #

Create a value of KeyPhrase with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:beginOffset:KeyPhrase', keyPhrase_beginOffset - A character offset in the input text that shows where the key phrase begins (the first character is at position 0). The offset returns the position of each UTF-8 code point in the string. A code point is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.

$sel:text:KeyPhrase', keyPhrase_text - The text of a key noun phrase.

$sel:score:KeyPhrase', keyPhrase_score - The level of confidence that Amazon Comprehend has in the accuracy of the detection.

$sel:endOffset:KeyPhrase', keyPhrase_endOffset - A character offset in the input text where the key phrase ends. The offset returns the position of each UTF-8 code point in the string. A code point is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.

KeyPhrasesDetectionJobFilter

data KeyPhrasesDetectionJobFilter Source #

Provides information for filtering a list of dominant language detection jobs. For more information, see the operation.

See: newKeyPhrasesDetectionJobFilter smart constructor.

Instances

Instances details
Eq KeyPhrasesDetectionJobFilter Source # 
Instance details

Defined in Amazonka.Comprehend.Types.KeyPhrasesDetectionJobFilter

Read KeyPhrasesDetectionJobFilter Source # 
Instance details

Defined in Amazonka.Comprehend.Types.KeyPhrasesDetectionJobFilter

Show KeyPhrasesDetectionJobFilter Source # 
Instance details

Defined in Amazonka.Comprehend.Types.KeyPhrasesDetectionJobFilter

Generic KeyPhrasesDetectionJobFilter Source # 
Instance details

Defined in Amazonka.Comprehend.Types.KeyPhrasesDetectionJobFilter

Associated Types

type Rep KeyPhrasesDetectionJobFilter :: Type -> Type #

NFData KeyPhrasesDetectionJobFilter Source # 
Instance details

Defined in Amazonka.Comprehend.Types.KeyPhrasesDetectionJobFilter

Hashable KeyPhrasesDetectionJobFilter Source # 
Instance details

Defined in Amazonka.Comprehend.Types.KeyPhrasesDetectionJobFilter

ToJSON KeyPhrasesDetectionJobFilter Source # 
Instance details

Defined in Amazonka.Comprehend.Types.KeyPhrasesDetectionJobFilter

type Rep KeyPhrasesDetectionJobFilter Source # 
Instance details

Defined in Amazonka.Comprehend.Types.KeyPhrasesDetectionJobFilter

type Rep KeyPhrasesDetectionJobFilter = D1 ('MetaData "KeyPhrasesDetectionJobFilter" "Amazonka.Comprehend.Types.KeyPhrasesDetectionJobFilter" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "KeyPhrasesDetectionJobFilter'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "submitTimeAfter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "submitTimeBefore") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :*: (S1 ('MetaSel ('Just "jobName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "jobStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobStatus)))))

newKeyPhrasesDetectionJobFilter :: KeyPhrasesDetectionJobFilter Source #

Create a value of KeyPhrasesDetectionJobFilter with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:submitTimeAfter:KeyPhrasesDetectionJobFilter', keyPhrasesDetectionJobFilter_submitTimeAfter - Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted after the specified time. Jobs are returned in descending order, newest to oldest.

$sel:submitTimeBefore:KeyPhrasesDetectionJobFilter', keyPhrasesDetectionJobFilter_submitTimeBefore - Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted before the specified time. Jobs are returned in ascending order, oldest to newest.

$sel:jobName:KeyPhrasesDetectionJobFilter', keyPhrasesDetectionJobFilter_jobName - Filters on the name of the job.

$sel:jobStatus:KeyPhrasesDetectionJobFilter', keyPhrasesDetectionJobFilter_jobStatus - Filters the list of jobs based on job status. Returns only jobs with the specified status.

KeyPhrasesDetectionJobProperties

data KeyPhrasesDetectionJobProperties Source #

Provides information about a key phrases detection job.

See: newKeyPhrasesDetectionJobProperties smart constructor.

Instances

Instances details
Eq KeyPhrasesDetectionJobProperties Source # 
Instance details

Defined in Amazonka.Comprehend.Types.KeyPhrasesDetectionJobProperties

Read KeyPhrasesDetectionJobProperties Source # 
Instance details

Defined in Amazonka.Comprehend.Types.KeyPhrasesDetectionJobProperties

Show KeyPhrasesDetectionJobProperties Source # 
Instance details

Defined in Amazonka.Comprehend.Types.KeyPhrasesDetectionJobProperties

Generic KeyPhrasesDetectionJobProperties Source # 
Instance details

Defined in Amazonka.Comprehend.Types.KeyPhrasesDetectionJobProperties

Associated Types

type Rep KeyPhrasesDetectionJobProperties :: Type -> Type #

NFData KeyPhrasesDetectionJobProperties Source # 
Instance details

Defined in Amazonka.Comprehend.Types.KeyPhrasesDetectionJobProperties

Hashable KeyPhrasesDetectionJobProperties Source # 
Instance details

Defined in Amazonka.Comprehend.Types.KeyPhrasesDetectionJobProperties

FromJSON KeyPhrasesDetectionJobProperties Source # 
Instance details

Defined in Amazonka.Comprehend.Types.KeyPhrasesDetectionJobProperties

type Rep KeyPhrasesDetectionJobProperties Source # 
Instance details

Defined in Amazonka.Comprehend.Types.KeyPhrasesDetectionJobProperties

type Rep KeyPhrasesDetectionJobProperties = D1 ('MetaData "KeyPhrasesDetectionJobProperties" "Amazonka.Comprehend.Types.KeyPhrasesDetectionJobProperties" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "KeyPhrasesDetectionJobProperties'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "languageCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LanguageCode)) :*: (S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "jobArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "jobName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "inputDataConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InputDataConfig)) :*: S1 ('MetaSel ('Just "vpcConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VpcConfig))))) :*: ((S1 ('MetaSel ('Just "volumeKmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "endTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "outputDataConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OutputDataConfig)))) :*: ((S1 ('MetaSel ('Just "dataAccessRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "jobStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobStatus))) :*: (S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "submitTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))))))

newKeyPhrasesDetectionJobProperties :: KeyPhrasesDetectionJobProperties Source #

Create a value of KeyPhrasesDetectionJobProperties with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:languageCode:KeyPhrasesDetectionJobProperties', keyPhrasesDetectionJobProperties_languageCode - The language code of the input documents.

$sel:jobId:KeyPhrasesDetectionJobProperties', keyPhrasesDetectionJobProperties_jobId - The identifier assigned to the key phrases detection job.

$sel:jobArn:KeyPhrasesDetectionJobProperties', keyPhrasesDetectionJobProperties_jobArn - The Amazon Resource Name (ARN) of the key phrases detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:

arn:<partition>:comprehend:<region>:<account-id>:key-phrases-detection-job/<job-id>

The following is an example job ARN:

arn:aws:comprehend:us-west-2:111122223333:key-phrases-detection-job/1234abcd12ab34cd56ef1234567890ab

$sel:jobName:KeyPhrasesDetectionJobProperties', keyPhrasesDetectionJobProperties_jobName - The name that you assigned the key phrases detection job.

$sel:inputDataConfig:KeyPhrasesDetectionJobProperties', keyPhrasesDetectionJobProperties_inputDataConfig - The input data configuration that you supplied when you created the key phrases detection job.

$sel:vpcConfig:KeyPhrasesDetectionJobProperties', keyPhrasesDetectionJobProperties_vpcConfig - Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your key phrases detection job. For more information, see Amazon VPC.

$sel:volumeKmsKeyId:KeyPhrasesDetectionJobProperties', keyPhrasesDetectionJobProperties_volumeKmsKeyId - ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:

  • KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
  • Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

$sel:endTime:KeyPhrasesDetectionJobProperties', keyPhrasesDetectionJobProperties_endTime - The time that the key phrases detection job completed.

$sel:outputDataConfig:KeyPhrasesDetectionJobProperties', keyPhrasesDetectionJobProperties_outputDataConfig - The output data configuration that you supplied when you created the key phrases detection job.

$sel:dataAccessRoleArn:KeyPhrasesDetectionJobProperties', keyPhrasesDetectionJobProperties_dataAccessRoleArn - The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.

$sel:jobStatus:KeyPhrasesDetectionJobProperties', keyPhrasesDetectionJobProperties_jobStatus - The current status of the key phrases detection job. If the status is FAILED, the Message field shows the reason for the failure.

$sel:message:KeyPhrasesDetectionJobProperties', keyPhrasesDetectionJobProperties_message - A description of the status of a job.

$sel:submitTime:KeyPhrasesDetectionJobProperties', keyPhrasesDetectionJobProperties_submitTime - The time that the key phrases detection job was submitted for processing.

OutputDataConfig

data OutputDataConfig Source #

Provides configuration parameters for the output of topic detection jobs.

See: newOutputDataConfig smart constructor.

Instances

Instances details
Eq OutputDataConfig Source # 
Instance details

Defined in Amazonka.Comprehend.Types.OutputDataConfig

Read OutputDataConfig Source # 
Instance details

Defined in Amazonka.Comprehend.Types.OutputDataConfig

Show OutputDataConfig Source # 
Instance details

Defined in Amazonka.Comprehend.Types.OutputDataConfig

Generic OutputDataConfig Source # 
Instance details

Defined in Amazonka.Comprehend.Types.OutputDataConfig

Associated Types

type Rep OutputDataConfig :: Type -> Type #

NFData OutputDataConfig Source # 
Instance details

Defined in Amazonka.Comprehend.Types.OutputDataConfig

Methods

rnf :: OutputDataConfig -> () #

Hashable OutputDataConfig Source # 
Instance details

Defined in Amazonka.Comprehend.Types.OutputDataConfig

ToJSON OutputDataConfig Source # 
Instance details

Defined in Amazonka.Comprehend.Types.OutputDataConfig

FromJSON OutputDataConfig Source # 
Instance details

Defined in Amazonka.Comprehend.Types.OutputDataConfig

type Rep OutputDataConfig Source # 
Instance details

Defined in Amazonka.Comprehend.Types.OutputDataConfig

type Rep OutputDataConfig = D1 ('MetaData "OutputDataConfig" "Amazonka.Comprehend.Types.OutputDataConfig" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "OutputDataConfig'" 'PrefixI 'True) (S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "s3Uri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newOutputDataConfig Source #

Create a value of OutputDataConfig with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:kmsKeyId:OutputDataConfig', outputDataConfig_kmsKeyId - ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job. The KmsKeyId can be one of the following formats:

  • KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
  • Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
  • KMS Key Alias: "alias/ExampleAlias"
  • ARN of a KMS Key Alias: "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"

$sel:s3Uri:OutputDataConfig', outputDataConfig_s3Uri - When you use the OutputDataConfig object with asynchronous operations, you specify the Amazon S3 location where you want to write the output data. The URI must be in the same region as the API endpoint that you are calling. The location is used as the prefix for the actual location of the output file.

When the topic detection job is finished, the service creates an output file in a directory specific to the job. The S3Uri field contains the location of the output file, called output.tar.gz. It is a compressed archive that contains the ouput of the operation.

PartOfSpeechTag

data PartOfSpeechTag Source #

Identifies the part of speech represented by the token and gives the confidence that Amazon Comprehend has that the part of speech was correctly identified. For more information about the parts of speech that Amazon Comprehend can identify, see how-syntax.

See: newPartOfSpeechTag smart constructor.

Instances

Instances details
Eq PartOfSpeechTag Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PartOfSpeechTag

Read PartOfSpeechTag Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PartOfSpeechTag

Show PartOfSpeechTag Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PartOfSpeechTag

Generic PartOfSpeechTag Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PartOfSpeechTag

Associated Types

type Rep PartOfSpeechTag :: Type -> Type #

NFData PartOfSpeechTag Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PartOfSpeechTag

Methods

rnf :: PartOfSpeechTag -> () #

Hashable PartOfSpeechTag Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PartOfSpeechTag

FromJSON PartOfSpeechTag Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PartOfSpeechTag

type Rep PartOfSpeechTag Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PartOfSpeechTag

type Rep PartOfSpeechTag = D1 ('MetaData "PartOfSpeechTag" "Amazonka.Comprehend.Types.PartOfSpeechTag" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "PartOfSpeechTag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "tag") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PartOfSpeechTagType)) :*: S1 ('MetaSel ('Just "score") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double))))

newPartOfSpeechTag :: PartOfSpeechTag Source #

Create a value of PartOfSpeechTag with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:tag:PartOfSpeechTag', partOfSpeechTag_tag - Identifies the part of speech that the token represents.

$sel:score:PartOfSpeechTag', partOfSpeechTag_score - The confidence that Amazon Comprehend has that the part of speech was correctly identified.

PiiEntitiesDetectionJobFilter

data PiiEntitiesDetectionJobFilter Source #

Provides information for filtering a list of PII entity detection jobs.

See: newPiiEntitiesDetectionJobFilter smart constructor.

Instances

Instances details
Eq PiiEntitiesDetectionJobFilter Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PiiEntitiesDetectionJobFilter

Read PiiEntitiesDetectionJobFilter Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PiiEntitiesDetectionJobFilter

Show PiiEntitiesDetectionJobFilter Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PiiEntitiesDetectionJobFilter

Generic PiiEntitiesDetectionJobFilter Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PiiEntitiesDetectionJobFilter

Associated Types

type Rep PiiEntitiesDetectionJobFilter :: Type -> Type #

NFData PiiEntitiesDetectionJobFilter Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PiiEntitiesDetectionJobFilter

Hashable PiiEntitiesDetectionJobFilter Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PiiEntitiesDetectionJobFilter

ToJSON PiiEntitiesDetectionJobFilter Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PiiEntitiesDetectionJobFilter

type Rep PiiEntitiesDetectionJobFilter Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PiiEntitiesDetectionJobFilter

type Rep PiiEntitiesDetectionJobFilter = D1 ('MetaData "PiiEntitiesDetectionJobFilter" "Amazonka.Comprehend.Types.PiiEntitiesDetectionJobFilter" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "PiiEntitiesDetectionJobFilter'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "submitTimeAfter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "submitTimeBefore") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :*: (S1 ('MetaSel ('Just "jobName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "jobStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobStatus)))))

newPiiEntitiesDetectionJobFilter :: PiiEntitiesDetectionJobFilter Source #

Create a value of PiiEntitiesDetectionJobFilter with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:submitTimeAfter:PiiEntitiesDetectionJobFilter', piiEntitiesDetectionJobFilter_submitTimeAfter - Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted after the specified time. Jobs are returned in descending order, newest to oldest.

$sel:submitTimeBefore:PiiEntitiesDetectionJobFilter', piiEntitiesDetectionJobFilter_submitTimeBefore - Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted before the specified time. Jobs are returned in ascending order, oldest to newest.

$sel:jobName:PiiEntitiesDetectionJobFilter', piiEntitiesDetectionJobFilter_jobName - Filters on the name of the job.

$sel:jobStatus:PiiEntitiesDetectionJobFilter', piiEntitiesDetectionJobFilter_jobStatus - Filters the list of jobs based on job status. Returns only jobs with the specified status.

PiiEntitiesDetectionJobProperties

data PiiEntitiesDetectionJobProperties Source #

Provides information about a PII entities detection job.

See: newPiiEntitiesDetectionJobProperties smart constructor.

Instances

Instances details
Eq PiiEntitiesDetectionJobProperties Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PiiEntitiesDetectionJobProperties

Read PiiEntitiesDetectionJobProperties Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PiiEntitiesDetectionJobProperties

Show PiiEntitiesDetectionJobProperties Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PiiEntitiesDetectionJobProperties

Generic PiiEntitiesDetectionJobProperties Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PiiEntitiesDetectionJobProperties

Associated Types

type Rep PiiEntitiesDetectionJobProperties :: Type -> Type #

NFData PiiEntitiesDetectionJobProperties Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PiiEntitiesDetectionJobProperties

Hashable PiiEntitiesDetectionJobProperties Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PiiEntitiesDetectionJobProperties

FromJSON PiiEntitiesDetectionJobProperties Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PiiEntitiesDetectionJobProperties

type Rep PiiEntitiesDetectionJobProperties Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PiiEntitiesDetectionJobProperties

type Rep PiiEntitiesDetectionJobProperties = D1 ('MetaData "PiiEntitiesDetectionJobProperties" "Amazonka.Comprehend.Types.PiiEntitiesDetectionJobProperties" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "PiiEntitiesDetectionJobProperties'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "languageCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LanguageCode)) :*: (S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "jobArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "jobName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "mode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PiiEntitiesDetectionMode)) :*: S1 ('MetaSel ('Just "inputDataConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InputDataConfig))))) :*: ((S1 ('MetaSel ('Just "redactionConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RedactionConfig)) :*: (S1 ('MetaSel ('Just "endTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "outputDataConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PiiOutputDataConfig)))) :*: ((S1 ('MetaSel ('Just "dataAccessRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "jobStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobStatus))) :*: (S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "submitTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))))))

newPiiEntitiesDetectionJobProperties :: PiiEntitiesDetectionJobProperties Source #

Create a value of PiiEntitiesDetectionJobProperties with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:languageCode:PiiEntitiesDetectionJobProperties', piiEntitiesDetectionJobProperties_languageCode - The language code of the input documents

$sel:jobId:PiiEntitiesDetectionJobProperties', piiEntitiesDetectionJobProperties_jobId - The identifier assigned to the PII entities detection job.

$sel:jobArn:PiiEntitiesDetectionJobProperties', piiEntitiesDetectionJobProperties_jobArn - The Amazon Resource Name (ARN) of the PII entities detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:

arn:<partition>:comprehend:<region>:<account-id>:pii-entities-detection-job/<job-id>

The following is an example job ARN:

arn:aws:comprehend:us-west-2:111122223333:pii-entities-detection-job/1234abcd12ab34cd56ef1234567890ab

$sel:jobName:PiiEntitiesDetectionJobProperties', piiEntitiesDetectionJobProperties_jobName - The name that you assigned the PII entities detection job.

$sel:mode:PiiEntitiesDetectionJobProperties', piiEntitiesDetectionJobProperties_mode - Specifies whether the output provides the locations (offsets) of PII entities or a file in which PII entities are redacted.

$sel:inputDataConfig:PiiEntitiesDetectionJobProperties', piiEntitiesDetectionJobProperties_inputDataConfig - The input properties for a PII entities detection job.

$sel:redactionConfig:PiiEntitiesDetectionJobProperties', piiEntitiesDetectionJobProperties_redactionConfig - 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.

$sel:endTime:PiiEntitiesDetectionJobProperties', piiEntitiesDetectionJobProperties_endTime - The time that the PII entities detection job completed.

$sel:outputDataConfig:PiiEntitiesDetectionJobProperties', piiEntitiesDetectionJobProperties_outputDataConfig - The output data configuration that you supplied when you created the PII entities detection job.

$sel:dataAccessRoleArn:PiiEntitiesDetectionJobProperties', piiEntitiesDetectionJobProperties_dataAccessRoleArn - The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.

$sel:jobStatus:PiiEntitiesDetectionJobProperties', piiEntitiesDetectionJobProperties_jobStatus - The current status of the PII entities detection job. If the status is FAILED, the Message field shows the reason for the failure.

$sel:message:PiiEntitiesDetectionJobProperties', piiEntitiesDetectionJobProperties_message - A description of the status of a job.

$sel:submitTime:PiiEntitiesDetectionJobProperties', piiEntitiesDetectionJobProperties_submitTime - The time that the PII entities detection job was submitted for processing.

PiiEntity

data PiiEntity Source #

Provides information about a PII entity.

See: newPiiEntity smart constructor.

Instances

Instances details
Eq PiiEntity Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PiiEntity

Read PiiEntity Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PiiEntity

Show PiiEntity Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PiiEntity

Generic PiiEntity Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PiiEntity

Associated Types

type Rep PiiEntity :: Type -> Type #

NFData PiiEntity Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PiiEntity

Methods

rnf :: PiiEntity -> () #

Hashable PiiEntity Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PiiEntity

FromJSON PiiEntity Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PiiEntity

type Rep PiiEntity Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PiiEntity

type Rep PiiEntity = D1 ('MetaData "PiiEntity" "Amazonka.Comprehend.Types.PiiEntity" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "PiiEntity'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "beginOffset") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "score") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double))) :*: (S1 ('MetaSel ('Just "endOffset") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PiiEntityType)))))

newPiiEntity :: PiiEntity Source #

Create a value of PiiEntity with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:beginOffset:PiiEntity', piiEntity_beginOffset - A character offset in the input text that shows where the PII entity begins (the first character is at position 0). The offset returns the position of each UTF-8 code point in the string. A code point is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.

$sel:score:PiiEntity', piiEntity_score - The level of confidence that Amazon Comprehend has in the accuracy of the detection.

$sel:endOffset:PiiEntity', piiEntity_endOffset - A character offset in the input text that shows where the PII entity ends. The offset returns the position of each UTF-8 code point in the string. A code point is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.

$sel:type':PiiEntity', piiEntity_type - The entity's type.

PiiOutputDataConfig

data PiiOutputDataConfig Source #

Provides configuration parameters for the output of PII entity detection jobs.

See: newPiiOutputDataConfig smart constructor.

Instances

Instances details
Eq PiiOutputDataConfig Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PiiOutputDataConfig

Read PiiOutputDataConfig Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PiiOutputDataConfig

Show PiiOutputDataConfig Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PiiOutputDataConfig

Generic PiiOutputDataConfig Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PiiOutputDataConfig

Associated Types

type Rep PiiOutputDataConfig :: Type -> Type #

NFData PiiOutputDataConfig Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PiiOutputDataConfig

Methods

rnf :: PiiOutputDataConfig -> () #

Hashable PiiOutputDataConfig Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PiiOutputDataConfig

FromJSON PiiOutputDataConfig Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PiiOutputDataConfig

type Rep PiiOutputDataConfig Source # 
Instance details

Defined in Amazonka.Comprehend.Types.PiiOutputDataConfig

type Rep PiiOutputDataConfig = D1 ('MetaData "PiiOutputDataConfig" "Amazonka.Comprehend.Types.PiiOutputDataConfig" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "PiiOutputDataConfig'" 'PrefixI 'True) (S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "s3Uri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newPiiOutputDataConfig Source #

Create a value of PiiOutputDataConfig with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:kmsKeyId:PiiOutputDataConfig', piiOutputDataConfig_kmsKeyId - ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job.

$sel:s3Uri:PiiOutputDataConfig', piiOutputDataConfig_s3Uri - When you use the PiiOutputDataConfig object with asynchronous operations, you specify the Amazon S3 location where you want to write the output data.

RedactionConfig

data RedactionConfig Source #

Provides configuration parameters for PII entity redaction.

See: newRedactionConfig smart constructor.

Instances

Instances details
Eq RedactionConfig Source # 
Instance details

Defined in Amazonka.Comprehend.Types.RedactionConfig

Read RedactionConfig Source # 
Instance details

Defined in Amazonka.Comprehend.Types.RedactionConfig

Show RedactionConfig Source # 
Instance details

Defined in Amazonka.Comprehend.Types.RedactionConfig

Generic RedactionConfig Source # 
Instance details

Defined in Amazonka.Comprehend.Types.RedactionConfig

Associated Types

type Rep RedactionConfig :: Type -> Type #

NFData RedactionConfig Source # 
Instance details

Defined in Amazonka.Comprehend.Types.RedactionConfig

Methods

rnf :: RedactionConfig -> () #

Hashable RedactionConfig Source # 
Instance details

Defined in Amazonka.Comprehend.Types.RedactionConfig

ToJSON RedactionConfig Source # 
Instance details

Defined in Amazonka.Comprehend.Types.RedactionConfig

FromJSON RedactionConfig Source # 
Instance details

Defined in Amazonka.Comprehend.Types.RedactionConfig

type Rep RedactionConfig Source # 
Instance details

Defined in Amazonka.Comprehend.Types.RedactionConfig

type Rep RedactionConfig = D1 ('MetaData "RedactionConfig" "Amazonka.Comprehend.Types.RedactionConfig" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "RedactionConfig'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maskCharacter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "maskMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PiiEntitiesDetectionMaskMode)) :*: S1 ('MetaSel ('Just "piiEntityTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PiiEntityType])))))

newRedactionConfig :: RedactionConfig Source #

Create a value of RedactionConfig with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:maskCharacter:RedactionConfig', redactionConfig_maskCharacter - A character that replaces each character in the redacted PII entity.

$sel:maskMode:RedactionConfig', redactionConfig_maskMode - Specifies whether the PII entity is redacted with the mask character or the entity type.

$sel:piiEntityTypes:RedactionConfig', redactionConfig_piiEntityTypes - An array of the types of PII entities that Amazon Comprehend detects in the input text for your request.

SentimentDetectionJobFilter

data SentimentDetectionJobFilter Source #

Provides information for filtering a list of dominant language detection jobs. For more information, see the operation.

See: newSentimentDetectionJobFilter smart constructor.

Instances

Instances details
Eq SentimentDetectionJobFilter Source # 
Instance details

Defined in Amazonka.Comprehend.Types.SentimentDetectionJobFilter

Read SentimentDetectionJobFilter Source # 
Instance details

Defined in Amazonka.Comprehend.Types.SentimentDetectionJobFilter

Show SentimentDetectionJobFilter Source # 
Instance details

Defined in Amazonka.Comprehend.Types.SentimentDetectionJobFilter

Generic SentimentDetectionJobFilter Source # 
Instance details

Defined in Amazonka.Comprehend.Types.SentimentDetectionJobFilter

Associated Types

type Rep SentimentDetectionJobFilter :: Type -> Type #

NFData SentimentDetectionJobFilter Source # 
Instance details

Defined in Amazonka.Comprehend.Types.SentimentDetectionJobFilter

Hashable SentimentDetectionJobFilter Source # 
Instance details

Defined in Amazonka.Comprehend.Types.SentimentDetectionJobFilter

ToJSON SentimentDetectionJobFilter Source # 
Instance details

Defined in Amazonka.Comprehend.Types.SentimentDetectionJobFilter

type Rep SentimentDetectionJobFilter Source # 
Instance details

Defined in Amazonka.Comprehend.Types.SentimentDetectionJobFilter

type Rep SentimentDetectionJobFilter = D1 ('MetaData "SentimentDetectionJobFilter" "Amazonka.Comprehend.Types.SentimentDetectionJobFilter" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "SentimentDetectionJobFilter'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "submitTimeAfter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "submitTimeBefore") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :*: (S1 ('MetaSel ('Just "jobName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "jobStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobStatus)))))

newSentimentDetectionJobFilter :: SentimentDetectionJobFilter Source #

Create a value of SentimentDetectionJobFilter with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:submitTimeAfter:SentimentDetectionJobFilter', sentimentDetectionJobFilter_submitTimeAfter - Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted after the specified time. Jobs are returned in descending order, newest to oldest.

$sel:submitTimeBefore:SentimentDetectionJobFilter', sentimentDetectionJobFilter_submitTimeBefore - Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted before the specified time. Jobs are returned in ascending order, oldest to newest.

$sel:jobName:SentimentDetectionJobFilter', sentimentDetectionJobFilter_jobName - Filters on the name of the job.

$sel:jobStatus:SentimentDetectionJobFilter', sentimentDetectionJobFilter_jobStatus - Filters the list of jobs based on job status. Returns only jobs with the specified status.

SentimentDetectionJobProperties

data SentimentDetectionJobProperties Source #

Provides information about a sentiment detection job.

See: newSentimentDetectionJobProperties smart constructor.

Instances

Instances details
Eq SentimentDetectionJobProperties Source # 
Instance details

Defined in Amazonka.Comprehend.Types.SentimentDetectionJobProperties

Read SentimentDetectionJobProperties Source # 
Instance details

Defined in Amazonka.Comprehend.Types.SentimentDetectionJobProperties

Show SentimentDetectionJobProperties Source # 
Instance details

Defined in Amazonka.Comprehend.Types.SentimentDetectionJobProperties

Generic SentimentDetectionJobProperties Source # 
Instance details

Defined in Amazonka.Comprehend.Types.SentimentDetectionJobProperties

Associated Types

type Rep SentimentDetectionJobProperties :: Type -> Type #

NFData SentimentDetectionJobProperties Source # 
Instance details

Defined in Amazonka.Comprehend.Types.SentimentDetectionJobProperties

Hashable SentimentDetectionJobProperties Source # 
Instance details

Defined in Amazonka.Comprehend.Types.SentimentDetectionJobProperties

FromJSON SentimentDetectionJobProperties Source # 
Instance details

Defined in Amazonka.Comprehend.Types.SentimentDetectionJobProperties

type Rep SentimentDetectionJobProperties Source # 
Instance details

Defined in Amazonka.Comprehend.Types.SentimentDetectionJobProperties

type Rep SentimentDetectionJobProperties = D1 ('MetaData "SentimentDetectionJobProperties" "Amazonka.Comprehend.Types.SentimentDetectionJobProperties" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "SentimentDetectionJobProperties'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "languageCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LanguageCode)) :*: (S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "jobArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "jobName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "inputDataConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InputDataConfig)) :*: S1 ('MetaSel ('Just "vpcConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VpcConfig))))) :*: ((S1 ('MetaSel ('Just "volumeKmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "endTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "outputDataConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OutputDataConfig)))) :*: ((S1 ('MetaSel ('Just "dataAccessRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "jobStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobStatus))) :*: (S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "submitTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))))))

newSentimentDetectionJobProperties :: SentimentDetectionJobProperties Source #

Create a value of SentimentDetectionJobProperties with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:languageCode:SentimentDetectionJobProperties', sentimentDetectionJobProperties_languageCode - The language code of the input documents.

$sel:jobId:SentimentDetectionJobProperties', sentimentDetectionJobProperties_jobId - The identifier assigned to the sentiment detection job.

$sel:jobArn:SentimentDetectionJobProperties', sentimentDetectionJobProperties_jobArn - The Amazon Resource Name (ARN) of the sentiment detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:

arn:<partition>:comprehend:<region>:<account-id>:sentiment-detection-job/<job-id>

The following is an example job ARN:

arn:aws:comprehend:us-west-2:111122223333:sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab

$sel:jobName:SentimentDetectionJobProperties', sentimentDetectionJobProperties_jobName - The name that you assigned to the sentiment detection job

$sel:inputDataConfig:SentimentDetectionJobProperties', sentimentDetectionJobProperties_inputDataConfig - The input data configuration that you supplied when you created the sentiment detection job.

$sel:vpcConfig:SentimentDetectionJobProperties', sentimentDetectionJobProperties_vpcConfig - Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your sentiment detection job. For more information, see Amazon VPC.

$sel:volumeKmsKeyId:SentimentDetectionJobProperties', sentimentDetectionJobProperties_volumeKmsKeyId - ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:

  • KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
  • Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

$sel:endTime:SentimentDetectionJobProperties', sentimentDetectionJobProperties_endTime - The time that the sentiment detection job ended.

$sel:outputDataConfig:SentimentDetectionJobProperties', sentimentDetectionJobProperties_outputDataConfig - The output data configuration that you supplied when you created the sentiment detection job.

$sel:dataAccessRoleArn:SentimentDetectionJobProperties', sentimentDetectionJobProperties_dataAccessRoleArn - The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.

$sel:jobStatus:SentimentDetectionJobProperties', sentimentDetectionJobProperties_jobStatus - The current status of the sentiment detection job. If the status is FAILED, the Messages field shows the reason for the failure.

$sel:message:SentimentDetectionJobProperties', sentimentDetectionJobProperties_message - A description of the status of a job.

$sel:submitTime:SentimentDetectionJobProperties', sentimentDetectionJobProperties_submitTime - The time that the sentiment detection job was submitted for processing.

SentimentScore

data SentimentScore Source #

Describes the level of confidence that Amazon Comprehend has in the accuracy of its detection of sentiments.

See: newSentimentScore smart constructor.

Instances

Instances details
Eq SentimentScore Source # 
Instance details

Defined in Amazonka.Comprehend.Types.SentimentScore

Read SentimentScore Source # 
Instance details

Defined in Amazonka.Comprehend.Types.SentimentScore

Show SentimentScore Source # 
Instance details

Defined in Amazonka.Comprehend.Types.SentimentScore

Generic SentimentScore Source # 
Instance details

Defined in Amazonka.Comprehend.Types.SentimentScore

Associated Types

type Rep SentimentScore :: Type -> Type #

NFData SentimentScore Source # 
Instance details

Defined in Amazonka.Comprehend.Types.SentimentScore

Methods

rnf :: SentimentScore -> () #

Hashable SentimentScore Source # 
Instance details

Defined in Amazonka.Comprehend.Types.SentimentScore

FromJSON SentimentScore Source # 
Instance details

Defined in Amazonka.Comprehend.Types.SentimentScore

type Rep SentimentScore Source # 
Instance details

Defined in Amazonka.Comprehend.Types.SentimentScore

type Rep SentimentScore = D1 ('MetaData "SentimentScore" "Amazonka.Comprehend.Types.SentimentScore" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "SentimentScore'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "mixed") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :*: S1 ('MetaSel ('Just "negative") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double))) :*: (S1 ('MetaSel ('Just "neutral") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :*: S1 ('MetaSel ('Just "positive") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)))))

newSentimentScore :: SentimentScore Source #

Create a value of SentimentScore with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:mixed:SentimentScore', sentimentScore_mixed - The level of confidence that Amazon Comprehend has in the accuracy of its detection of the MIXED sentiment.

$sel:negative:SentimentScore', sentimentScore_negative - The level of confidence that Amazon Comprehend has in the accuracy of its detection of the NEGATIVE sentiment.

$sel:neutral:SentimentScore', sentimentScore_neutral - The level of confidence that Amazon Comprehend has in the accuracy of its detection of the NEUTRAL sentiment.

$sel:positive:SentimentScore', sentimentScore_positive - The level of confidence that Amazon Comprehend has in the accuracy of its detection of the POSITIVE sentiment.

SyntaxToken

data SyntaxToken Source #

Represents a work in the input text that was recognized and assigned a part of speech. There is one syntax token record for each word in the source text.

See: newSyntaxToken smart constructor.

Instances

Instances details
Eq SyntaxToken Source # 
Instance details

Defined in Amazonka.Comprehend.Types.SyntaxToken

Read SyntaxToken Source # 
Instance details

Defined in Amazonka.Comprehend.Types.SyntaxToken

Show SyntaxToken Source # 
Instance details

Defined in Amazonka.Comprehend.Types.SyntaxToken

Generic SyntaxToken Source # 
Instance details

Defined in Amazonka.Comprehend.Types.SyntaxToken

Associated Types

type Rep SyntaxToken :: Type -> Type #

NFData SyntaxToken Source # 
Instance details

Defined in Amazonka.Comprehend.Types.SyntaxToken

Methods

rnf :: SyntaxToken -> () #

Hashable SyntaxToken Source # 
Instance details

Defined in Amazonka.Comprehend.Types.SyntaxToken

FromJSON SyntaxToken Source # 
Instance details

Defined in Amazonka.Comprehend.Types.SyntaxToken

type Rep SyntaxToken Source # 
Instance details

Defined in Amazonka.Comprehend.Types.SyntaxToken

type Rep SyntaxToken = D1 ('MetaData "SyntaxToken" "Amazonka.Comprehend.Types.SyntaxToken" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "SyntaxToken'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "beginOffset") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "text") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "tokenId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "endOffset") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "partOfSpeech") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PartOfSpeechTag))))))

newSyntaxToken :: SyntaxToken Source #

Create a value of SyntaxToken with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:beginOffset:SyntaxToken', syntaxToken_beginOffset - The zero-based offset from the beginning of the source text to the first character in the word.

$sel:text:SyntaxToken', syntaxToken_text - The word that was recognized in the source text.

$sel:tokenId:SyntaxToken', syntaxToken_tokenId - A unique identifier for a token.

$sel:endOffset:SyntaxToken', syntaxToken_endOffset - The zero-based offset from the beginning of the source text to the last character in the word.

$sel:partOfSpeech:SyntaxToken', syntaxToken_partOfSpeech - Provides the part of speech label and the confidence level that Amazon Comprehend has that the part of speech was correctly identified. For more information, see how-syntax.

Tag

data Tag Source #

A key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with the key-value pair ‘Department’:’Sales’ might be added to a resource to indicate its use by a particular department.

See: newTag smart constructor.

Constructors

Tag' (Maybe Text) Text 

Instances

Instances details
Eq Tag Source # 
Instance details

Defined in Amazonka.Comprehend.Types.Tag

Methods

(==) :: Tag -> Tag -> Bool #

(/=) :: Tag -> Tag -> Bool #

Read Tag Source # 
Instance details

Defined in Amazonka.Comprehend.Types.Tag

Show Tag Source # 
Instance details

Defined in Amazonka.Comprehend.Types.Tag

Methods

showsPrec :: Int -> Tag -> ShowS #

show :: Tag -> String #

showList :: [Tag] -> ShowS #

Generic Tag Source # 
Instance details

Defined in Amazonka.Comprehend.Types.Tag

Associated Types

type Rep Tag :: Type -> Type #

Methods

from :: Tag -> Rep Tag x #

to :: Rep Tag x -> Tag #

NFData Tag Source # 
Instance details

Defined in Amazonka.Comprehend.Types.Tag

Methods

rnf :: Tag -> () #

Hashable Tag Source # 
Instance details

Defined in Amazonka.Comprehend.Types.Tag

Methods

hashWithSalt :: Int -> Tag -> Int #

hash :: Tag -> Int #

ToJSON Tag Source # 
Instance details

Defined in Amazonka.Comprehend.Types.Tag

FromJSON Tag Source # 
Instance details

Defined in Amazonka.Comprehend.Types.Tag

type Rep Tag Source # 
Instance details

Defined in Amazonka.Comprehend.Types.Tag

type Rep Tag = D1 ('MetaData "Tag" "Amazonka.Comprehend.Types.Tag" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newTag Source #

Arguments

:: Text

$sel:key:Tag'

-> Tag 

Create a value of Tag with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:value:Tag', tag_value - The second part of a key-value pair that forms a tag associated with a given resource. For instance, if you want to show which resources are used by which departments, you might use “Department” as the initial (key) portion of the pair, with a value of “sales” to indicate the sales department.

$sel:key:Tag', tag_key - The initial part of a key-value pair that forms a tag associated with a given resource. For instance, if you want to show which resources are used by which departments, you might use “Department” as the key portion of the pair, with multiple possible values such as “sales,” “legal,” and “administration.”

TopicsDetectionJobFilter

data TopicsDetectionJobFilter Source #

Provides information for filtering topic detection jobs. For more information, see .

See: newTopicsDetectionJobFilter smart constructor.

Instances

Instances details
Eq TopicsDetectionJobFilter Source # 
Instance details

Defined in Amazonka.Comprehend.Types.TopicsDetectionJobFilter

Read TopicsDetectionJobFilter Source # 
Instance details

Defined in Amazonka.Comprehend.Types.TopicsDetectionJobFilter

Show TopicsDetectionJobFilter Source # 
Instance details

Defined in Amazonka.Comprehend.Types.TopicsDetectionJobFilter

Generic TopicsDetectionJobFilter Source # 
Instance details

Defined in Amazonka.Comprehend.Types.TopicsDetectionJobFilter

Associated Types

type Rep TopicsDetectionJobFilter :: Type -> Type #

NFData TopicsDetectionJobFilter Source # 
Instance details

Defined in Amazonka.Comprehend.Types.TopicsDetectionJobFilter

Hashable TopicsDetectionJobFilter Source # 
Instance details

Defined in Amazonka.Comprehend.Types.TopicsDetectionJobFilter

ToJSON TopicsDetectionJobFilter Source # 
Instance details

Defined in Amazonka.Comprehend.Types.TopicsDetectionJobFilter

type Rep TopicsDetectionJobFilter Source # 
Instance details

Defined in Amazonka.Comprehend.Types.TopicsDetectionJobFilter

type Rep TopicsDetectionJobFilter = D1 ('MetaData "TopicsDetectionJobFilter" "Amazonka.Comprehend.Types.TopicsDetectionJobFilter" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "TopicsDetectionJobFilter'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "submitTimeAfter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "submitTimeBefore") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :*: (S1 ('MetaSel ('Just "jobName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "jobStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobStatus)))))

newTopicsDetectionJobFilter :: TopicsDetectionJobFilter Source #

Create a value of TopicsDetectionJobFilter with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:submitTimeAfter:TopicsDetectionJobFilter', topicsDetectionJobFilter_submitTimeAfter - Filters the list of jobs based on the time that the job was submitted for processing. Only returns jobs submitted after the specified time. Jobs are returned in ascending order, oldest to newest.

$sel:submitTimeBefore:TopicsDetectionJobFilter', topicsDetectionJobFilter_submitTimeBefore - Filters the list of jobs based on the time that the job was submitted for processing. Only returns jobs submitted before the specified time. Jobs are returned in descending order, newest to oldest.

$sel:jobName:TopicsDetectionJobFilter', topicsDetectionJobFilter_jobName -

$sel:jobStatus:TopicsDetectionJobFilter', topicsDetectionJobFilter_jobStatus - Filters the list of topic detection jobs based on job status. Returns only jobs with the specified status.

TopicsDetectionJobProperties

data TopicsDetectionJobProperties Source #

Provides information about a topic detection job.

See: newTopicsDetectionJobProperties smart constructor.

Instances

Instances details
Eq TopicsDetectionJobProperties Source # 
Instance details

Defined in Amazonka.Comprehend.Types.TopicsDetectionJobProperties

Read TopicsDetectionJobProperties Source # 
Instance details

Defined in Amazonka.Comprehend.Types.TopicsDetectionJobProperties

Show TopicsDetectionJobProperties Source # 
Instance details

Defined in Amazonka.Comprehend.Types.TopicsDetectionJobProperties

Generic TopicsDetectionJobProperties Source # 
Instance details

Defined in Amazonka.Comprehend.Types.TopicsDetectionJobProperties

Associated Types

type Rep TopicsDetectionJobProperties :: Type -> Type #

NFData TopicsDetectionJobProperties Source # 
Instance details

Defined in Amazonka.Comprehend.Types.TopicsDetectionJobProperties

Hashable TopicsDetectionJobProperties Source # 
Instance details

Defined in Amazonka.Comprehend.Types.TopicsDetectionJobProperties

FromJSON TopicsDetectionJobProperties Source # 
Instance details

Defined in Amazonka.Comprehend.Types.TopicsDetectionJobProperties

type Rep TopicsDetectionJobProperties Source # 
Instance details

Defined in Amazonka.Comprehend.Types.TopicsDetectionJobProperties

type Rep TopicsDetectionJobProperties = D1 ('MetaData "TopicsDetectionJobProperties" "Amazonka.Comprehend.Types.TopicsDetectionJobProperties" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "TopicsDetectionJobProperties'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "jobArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "jobName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "inputDataConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InputDataConfig)) :*: (S1 ('MetaSel ('Just "vpcConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VpcConfig)) :*: S1 ('MetaSel ('Just "volumeKmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "endTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "outputDataConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OutputDataConfig)) :*: S1 ('MetaSel ('Just "dataAccessRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "numberOfTopics") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "jobStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobStatus))) :*: (S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "submitTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))))))

newTopicsDetectionJobProperties :: TopicsDetectionJobProperties Source #

Create a value of TopicsDetectionJobProperties with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:jobId:TopicsDetectionJobProperties', topicsDetectionJobProperties_jobId - The identifier assigned to the topic detection job.

$sel:jobArn:TopicsDetectionJobProperties', topicsDetectionJobProperties_jobArn - The Amazon Resource Name (ARN) of the topics detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:

arn:<partition>:comprehend:<region>:<account-id>:topics-detection-job/<job-id>

The following is an example job ARN:

arn:aws:comprehend:us-west-2:111122223333:topics-detection-job/1234abcd12ab34cd56ef1234567890ab

$sel:jobName:TopicsDetectionJobProperties', topicsDetectionJobProperties_jobName - The name of the topic detection job.

$sel:inputDataConfig:TopicsDetectionJobProperties', topicsDetectionJobProperties_inputDataConfig - The input data configuration supplied when you created the topic detection job.

$sel:vpcConfig:TopicsDetectionJobProperties', topicsDetectionJobProperties_vpcConfig - Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your topic detection job. For more information, see Amazon VPC.

$sel:volumeKmsKeyId:TopicsDetectionJobProperties', topicsDetectionJobProperties_volumeKmsKeyId - ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:

  • KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
  • Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

$sel:endTime:TopicsDetectionJobProperties', topicsDetectionJobProperties_endTime - The time that the topic detection job was completed.

$sel:outputDataConfig:TopicsDetectionJobProperties', topicsDetectionJobProperties_outputDataConfig - The output data configuration supplied when you created the topic detection job.

$sel:dataAccessRoleArn:TopicsDetectionJobProperties', topicsDetectionJobProperties_dataAccessRoleArn - The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your job data.

$sel:numberOfTopics:TopicsDetectionJobProperties', topicsDetectionJobProperties_numberOfTopics - The number of topics to detect supplied when you created the topic detection job. The default is 10.

$sel:jobStatus:TopicsDetectionJobProperties', topicsDetectionJobProperties_jobStatus - The current status of the topic detection job. If the status is Failed, the reason for the failure is shown in the Message field.

$sel:message:TopicsDetectionJobProperties', topicsDetectionJobProperties_message - A description for the status of a job.

$sel:submitTime:TopicsDetectionJobProperties', topicsDetectionJobProperties_submitTime - The time that the topic detection job was submitted for processing.

VpcConfig

data VpcConfig Source #

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.

See: newVpcConfig smart constructor.

Instances

Instances details
Eq VpcConfig Source # 
Instance details

Defined in Amazonka.Comprehend.Types.VpcConfig

Read VpcConfig Source # 
Instance details

Defined in Amazonka.Comprehend.Types.VpcConfig

Show VpcConfig Source # 
Instance details

Defined in Amazonka.Comprehend.Types.VpcConfig

Generic VpcConfig Source # 
Instance details

Defined in Amazonka.Comprehend.Types.VpcConfig

Associated Types

type Rep VpcConfig :: Type -> Type #

NFData VpcConfig Source # 
Instance details

Defined in Amazonka.Comprehend.Types.VpcConfig

Methods

rnf :: VpcConfig -> () #

Hashable VpcConfig Source # 
Instance details

Defined in Amazonka.Comprehend.Types.VpcConfig

ToJSON VpcConfig Source # 
Instance details

Defined in Amazonka.Comprehend.Types.VpcConfig

FromJSON VpcConfig Source # 
Instance details

Defined in Amazonka.Comprehend.Types.VpcConfig

type Rep VpcConfig Source # 
Instance details

Defined in Amazonka.Comprehend.Types.VpcConfig

type Rep VpcConfig = D1 ('MetaData "VpcConfig" "Amazonka.Comprehend.Types.VpcConfig" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "VpcConfig'" 'PrefixI 'True) (S1 ('MetaSel ('Just "securityGroupIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty Text)) :*: S1 ('MetaSel ('Just "subnets") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty Text))))

newVpcConfig Source #

Create a value of VpcConfig with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:securityGroupIds:VpcConfig', vpcConfig_securityGroupIds - The ID number for a security group on an instance of your private VPC. Security groups on your VPC function serve as a virtual firewall to control inbound and outbound traffic and provides security for the resources that you’ll be accessing on the VPC. This ID number is preceded by "sg-", for instance: "sg-03b388029b0a285ea". For more information, see Security Groups for your VPC.

$sel:subnets:VpcConfig', vpcConfig_subnets - The ID for each subnet being used in your private VPC. This subnet is a subset of the a range of IPv4 addresses used by the VPC and is specific to a given availability zone in the VPC’s region. This ID number is preceded by "subnet-", for instance: "subnet-04ccf456919e69055". For more information, see VPCs and Subnets.