Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Textract.StartDocumentTextDetection

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Starts the asynchronous detection of text in a document. Amazon Textract can detect lines of text and the words that make up a line of text.

StartDocumentTextDetection can analyze text in documents that are in JPEG, PNG, TIFF, and PDF format. The documents are stored in an Amazon S3 bucket. Use DocumentLocation to specify the bucket name and file name of the document.

StartTextDetection returns a job identifier (JobId) that you use to get the results of the operation. When text detection is finished, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that you specify in NotificationChannel. To get the results of the text detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetDocumentTextDetection, and pass the job identifier (JobId) from the initial call to StartDocumentTextDetection.

For more information, see Document Text Detection.

Synopsis

Creating a Request

data StartDocumentTextDetection Source #

See: newStartDocumentTextDetection smart constructor.

Constructors

StartDocumentTextDetection'

Fields

clientRequestToken :: Maybe Text
The idempotent token that's used to identify the start request. If you use the same token with multiple StartDocumentTextDetection requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidentally started more than once. For more information, see Calling Amazon Textract Asynchronous Operations.
jobTag :: Maybe Text
An identifier that you specify that's included in the completion notification published to the Amazon SNS topic. For example, you can use JobTag to identify the type of document that the completion notification corresponds to (such as a tax form or a receipt).
kmsKeyId :: Maybe Text
The KMS key used to encrypt the inference results. This can be in either Key ID or Key Alias format. When a KMS key is provided, the KMS key will be used for server-side encryption of the objects in the customer bucket. When this parameter is not enabled, the result will be encrypted server side,using SSE-S3.
notificationChannel :: Maybe NotificationChannel
The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the operation to.
outputConfig :: Maybe OutputConfig
Sets if the output will go to a customer defined bucket. By default Amazon Textract will save the results internally to be accessed with the GetDocumentTextDetection operation.
documentLocation :: DocumentLocation
The location of the document to be processed.

Instances

Instances details

ToJSON StartDocumentTextDetection Source #
Instance details Defined in Amazonka.Textract.StartDocumentTextDetection Methods toJSON :: StartDocumentTextDetection -> Value # toEncoding :: StartDocumentTextDetection -> Encoding # toJSONList :: [StartDocumentTextDetection] -> Value # toEncodingList :: [StartDocumentTextDetection] -> Encoding #
ToHeaders StartDocumentTextDetection Source #
Instance details Defined in Amazonka.Textract.StartDocumentTextDetection Methods toHeaders :: StartDocumentTextDetection -> [Header] #
ToPath StartDocumentTextDetection Source #
Instance details Defined in Amazonka.Textract.StartDocumentTextDetection Methods toPath :: StartDocumentTextDetection -> ByteString #
ToQuery StartDocumentTextDetection Source #
Instance details Defined in Amazonka.Textract.StartDocumentTextDetection Methods toQuery :: StartDocumentTextDetection -> QueryString #
AWSRequest StartDocumentTextDetection Source #
Instance details Defined in Amazonka.Textract.StartDocumentTextDetection Associated Types type AWSResponse StartDocumentTextDetection # Methods request :: (Service -> Service) -> StartDocumentTextDetection -> Request StartDocumentTextDetection # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy StartDocumentTextDetection -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse StartDocumentTextDetection))) #
Generic StartDocumentTextDetection Source #
Instance details Defined in Amazonka.Textract.StartDocumentTextDetection Associated Types type Rep StartDocumentTextDetection :: Type -> Type # Methods from :: StartDocumentTextDetection -> Rep StartDocumentTextDetection x # to :: Rep StartDocumentTextDetection x -> StartDocumentTextDetection #
Read StartDocumentTextDetection Source #
Instance details Defined in Amazonka.Textract.StartDocumentTextDetection Methods readsPrec :: Int -> ReadS StartDocumentTextDetection # readList :: ReadS [StartDocumentTextDetection] # readPrec :: ReadPrec StartDocumentTextDetection # readListPrec :: ReadPrec [StartDocumentTextDetection] #
Show StartDocumentTextDetection Source #
Instance details Defined in Amazonka.Textract.StartDocumentTextDetection Methods showsPrec :: Int -> StartDocumentTextDetection -> ShowS # show :: StartDocumentTextDetection -> String # showList :: [StartDocumentTextDetection] -> ShowS #
NFData StartDocumentTextDetection Source #
Instance details Defined in Amazonka.Textract.StartDocumentTextDetection Methods rnf :: StartDocumentTextDetection -> () #
Eq StartDocumentTextDetection Source #
Instance details Defined in Amazonka.Textract.StartDocumentTextDetection Methods (==) :: StartDocumentTextDetection -> StartDocumentTextDetection -> Bool # (/=) :: StartDocumentTextDetection -> StartDocumentTextDetection -> Bool #
Hashable StartDocumentTextDetection Source #
Instance details Defined in Amazonka.Textract.StartDocumentTextDetection Methods hashWithSalt :: Int -> StartDocumentTextDetection -> Int # hash :: StartDocumentTextDetection -> Int #
type AWSResponse StartDocumentTextDetection Source #
Instance details Defined in Amazonka.Textract.StartDocumentTextDetection type AWSResponse StartDocumentTextDetection = StartDocumentTextDetectionResponse
type Rep StartDocumentTextDetection Source #
Instance details Defined in Amazonka.Textract.StartDocumentTextDetection type Rep StartDocumentTextDetection = D1 ('MetaData "StartDocumentTextDetection" "Amazonka.Textract.StartDocumentTextDetection" "amazonka-textract-2.0-6i5mJlqzS4xCepXxXFK6UK" 'False) (C1 ('MetaCons "StartDocumentTextDetection'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "clientRequestToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "jobTag") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "notificationChannel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe NotificationChannel)) :: (S1 ('MetaSel ('Just "outputConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OutputConfig)) :*: S1 ('MetaSel ('Just "documentLocation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DocumentLocation)))))

newStartDocumentTextDetection Source #

Arguments

:: DocumentLocation	`$sel:documentLocation:StartDocumentTextDetection'`
-> StartDocumentTextDetection

Create a value of StartDocumentTextDetection 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:clientRequestToken:StartDocumentTextDetection', startDocumentTextDetection_clientRequestToken - The idempotent token that's used to identify the start request. If you use the same token with multiple StartDocumentTextDetection requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidentally started more than once. For more information, see Calling Amazon Textract Asynchronous Operations.

$sel:jobTag:StartDocumentTextDetection', startDocumentTextDetection_jobTag - An identifier that you specify that's included in the completion notification published to the Amazon SNS topic. For example, you can use JobTag to identify the type of document that the completion notification corresponds to (such as a tax form or a receipt).

$sel:kmsKeyId:StartDocumentTextDetection', startDocumentTextDetection_kmsKeyId - The KMS key used to encrypt the inference results. This can be in either Key ID or Key Alias format. When a KMS key is provided, the KMS key will be used for server-side encryption of the objects in the customer bucket. When this parameter is not enabled, the result will be encrypted server side,using SSE-S3.

$sel:notificationChannel:StartDocumentTextDetection', startDocumentTextDetection_notificationChannel - The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the operation to.

$sel:outputConfig:StartDocumentTextDetection', startDocumentTextDetection_outputConfig - Sets if the output will go to a customer defined bucket. By default Amazon Textract will save the results internally to be accessed with the GetDocumentTextDetection operation.

$sel:documentLocation:StartDocumentTextDetection', startDocumentTextDetection_documentLocation - The location of the document to be processed.

Request Lenses

startDocumentTextDetection_clientRequestToken :: Lens' StartDocumentTextDetection (Maybe Text) Source #

The idempotent token that's used to identify the start request. If you use the same token with multiple StartDocumentTextDetection requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidentally started more than once. For more information, see Calling Amazon Textract Asynchronous Operations.

startDocumentTextDetection_jobTag :: Lens' StartDocumentTextDetection (Maybe Text) Source #

An identifier that you specify that's included in the completion notification published to the Amazon SNS topic. For example, you can use JobTag to identify the type of document that the completion notification corresponds to (such as a tax form or a receipt).

startDocumentTextDetection_kmsKeyId :: Lens' StartDocumentTextDetection (Maybe Text) Source #

The KMS key used to encrypt the inference results. This can be in either Key ID or Key Alias format. When a KMS key is provided, the KMS key will be used for server-side encryption of the objects in the customer bucket. When this parameter is not enabled, the result will be encrypted server side,using SSE-S3.

startDocumentTextDetection_notificationChannel :: Lens' StartDocumentTextDetection (Maybe NotificationChannel) Source #

The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the operation to.

startDocumentTextDetection_outputConfig :: Lens' StartDocumentTextDetection (Maybe OutputConfig) Source #

Sets if the output will go to a customer defined bucket. By default Amazon Textract will save the results internally to be accessed with the GetDocumentTextDetection operation.

startDocumentTextDetection_documentLocation :: Lens' StartDocumentTextDetection DocumentLocation Source #

The location of the document to be processed.

Destructuring the Response

data StartDocumentTextDetectionResponse Source #

See: newStartDocumentTextDetectionResponse smart constructor.

Constructors

StartDocumentTextDetectionResponse'
Fields jobId :: Maybe Text The identifier of the text detection job for the document. Use `JobId` to identify the job in a subsequent call to `GetDocumentTextDetection`. A `JobId` value is only valid for 7 days. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic StartDocumentTextDetectionResponse Source #
Instance details Defined in Amazonka.Textract.StartDocumentTextDetection Associated Types type Rep StartDocumentTextDetectionResponse :: Type -> Type # Methods from :: StartDocumentTextDetectionResponse -> Rep StartDocumentTextDetectionResponse x # to :: Rep StartDocumentTextDetectionResponse x -> StartDocumentTextDetectionResponse #
Read StartDocumentTextDetectionResponse Source #
Instance details Defined in Amazonka.Textract.StartDocumentTextDetection Methods readsPrec :: Int -> ReadS StartDocumentTextDetectionResponse # readList :: ReadS [StartDocumentTextDetectionResponse] # readPrec :: ReadPrec StartDocumentTextDetectionResponse # readListPrec :: ReadPrec [StartDocumentTextDetectionResponse] #
Show StartDocumentTextDetectionResponse Source #
Instance details Defined in Amazonka.Textract.StartDocumentTextDetection Methods showsPrec :: Int -> StartDocumentTextDetectionResponse -> ShowS # show :: StartDocumentTextDetectionResponse -> String # showList :: [StartDocumentTextDetectionResponse] -> ShowS #
NFData StartDocumentTextDetectionResponse Source #
Instance details Defined in Amazonka.Textract.StartDocumentTextDetection Methods rnf :: StartDocumentTextDetectionResponse -> () #
Eq StartDocumentTextDetectionResponse Source #
Instance details Defined in Amazonka.Textract.StartDocumentTextDetection Methods (==) :: StartDocumentTextDetectionResponse -> StartDocumentTextDetectionResponse -> Bool # (/=) :: StartDocumentTextDetectionResponse -> StartDocumentTextDetectionResponse -> Bool #
type Rep StartDocumentTextDetectionResponse Source #
Instance details Defined in Amazonka.Textract.StartDocumentTextDetection type Rep StartDocumentTextDetectionResponse = D1 ('MetaData "StartDocumentTextDetectionResponse" "Amazonka.Textract.StartDocumentTextDetection" "amazonka-textract-2.0-6i5mJlqzS4xCepXxXFK6UK" 'False) (C1 ('MetaCons "StartDocumentTextDetectionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newStartDocumentTextDetectionResponse Source #

Arguments

:: Int	`$sel:httpStatus:StartDocumentTextDetectionResponse'`
-> StartDocumentTextDetectionResponse

Create a value of StartDocumentTextDetectionResponse 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:StartDocumentTextDetectionResponse', startDocumentTextDetectionResponse_jobId - The identifier of the text detection job for the document. Use JobId to identify the job in a subsequent call to GetDocumentTextDetection. A JobId value is only valid for 7 days.

$sel:httpStatus:StartDocumentTextDetectionResponse', startDocumentTextDetectionResponse_httpStatus - The response's http status code.

Response Lenses

startDocumentTextDetectionResponse_jobId :: Lens' StartDocumentTextDetectionResponse (Maybe Text) Source #

The identifier of the text detection job for the document. Use JobId to identify the job in a subsequent call to GetDocumentTextDetection. A JobId value is only valid for 7 days.

startDocumentTextDetectionResponse_httpStatus :: Lens' StartDocumentTextDetectionResponse Int Source #

The response's http status code.