Aws::Textract::Model::StartDocumentTextDetectionRequest Class Reference

#include <StartDocumentTextDetectionRequest.h>

Inheritance diagram for Aws::Textract::Model::StartDocumentTextDetectionRequest:

Public Member Functions

AWS_TEXTRACT_API StartDocumentTextDetectionRequest ()=default

 

virtual const char * GetServiceRequestName () const override

 

AWS_TEXTRACT_API Aws::String SerializePayload () const override

 

AWS_TEXTRACT_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override

 

const DocumentLocation & GetDocumentLocation () const

 

bool DocumentLocationHasBeenSet () const

 

template<typename DocumentLocationT = DocumentLocation>

void SetDocumentLocation (DocumentLocationT &&value)

 

template<typename DocumentLocationT = DocumentLocation>

StartDocumentTextDetectionRequest & WithDocumentLocation (DocumentLocationT &&value)

 

const Aws::String & GetClientRequestToken () const

 

bool ClientRequestTokenHasBeenSet () const

 

template<typename ClientRequestTokenT = Aws::String>

void SetClientRequestToken (ClientRequestTokenT &&value)

 

template<typename ClientRequestTokenT = Aws::String>

StartDocumentTextDetectionRequest & WithClientRequestToken (ClientRequestTokenT &&value)

 

const Aws::String & GetJobTag () const

 

bool JobTagHasBeenSet () const

 

template<typename JobTagT = Aws::String>

void SetJobTag (JobTagT &&value)

 

template<typename JobTagT = Aws::String>

StartDocumentTextDetectionRequest & WithJobTag (JobTagT &&value)

 

const NotificationChannel & GetNotificationChannel () const

 

bool NotificationChannelHasBeenSet () const

 

template<typename NotificationChannelT = NotificationChannel>

void SetNotificationChannel (NotificationChannelT &&value)

 

template<typename NotificationChannelT = NotificationChannel>

StartDocumentTextDetectionRequest & WithNotificationChannel (NotificationChannelT &&value)

 

const OutputConfig & GetOutputConfig () const

 

bool OutputConfigHasBeenSet () const

 

template<typename OutputConfigT = OutputConfig>

void SetOutputConfig (OutputConfigT &&value)

 

template<typename OutputConfigT = OutputConfig>

StartDocumentTextDetectionRequest & WithOutputConfig (OutputConfigT &&value)

 

const Aws::String & GetKMSKeyId () const

 

bool KMSKeyIdHasBeenSet () const

 

template<typename KMSKeyIdT = Aws::String>

void SetKMSKeyId (KMSKeyIdT &&value)

 

template<typename KMSKeyIdT = Aws::String>

StartDocumentTextDetectionRequest & WithKMSKeyId (KMSKeyIdT &&value)

 

Public Member Functions inherited from Aws::Textract::TextractRequest

virtual ~TextractRequest ()

 

void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const

 

Aws::Http::HeaderValueCollection GetHeaders () const override

 

Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest

 AmazonSerializableWebServiceRequest ()

 

virtual ~AmazonSerializableWebServiceRequest ()

 

std::shared_ptr< Aws::IOStream > GetBody () const override

 

Public Member Functions inherited from Aws::AmazonWebServiceRequest

 AmazonWebServiceRequest ()

 

virtual ~AmazonWebServiceRequest ()=default

 

virtual const Aws::Http::HeaderValueCollection & GetAdditionalCustomHeaders () const

 

virtual void SetAdditionalCustomHeaderValue (const Aws::String &headerName, const Aws::String &headerValue)

 

virtual void AddQueryStringParameters (Aws::Http::URI &uri) const

 

virtual void PutToPresignedUrl (Aws::Http::URI &uri) const

 

virtual bool IsStreaming () const

 

virtual bool IsEventStreamRequest () const

 

virtual bool HasEventStreamResponse () const

 

virtual bool SignBody () const

 

virtual bool HasEmbeddedError (Aws::IOStream &body, const Aws::Http::HeaderValueCollection &header) const

 

virtual bool IsChunked () const

 

virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)

 

virtual const RequestSignedHandler & GetRequestSignedHandler () const

 

const Aws::IOStreamFactory & GetResponseStreamFactory () const

 

void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)

 

virtual const Aws::Http::HeadersReceivedEventHandler & GetHeadersReceivedEventHandler () const

 

virtual const Aws::Http::DataReceivedEventHandler & GetDataReceivedEventHandler () const

 

virtual const Aws::Http::DataSentEventHandler & GetDataSentEventHandler () const

 

virtual const Aws::Http::ContinueRequestHandler & GetContinueRequestHandler () const

 

virtual const RequestRetryHandler & GetRequestRetryHandler () const

 

virtual bool ShouldComputeContentMd5 () const

 

virtual bool ShouldValidateResponseChecksum () const

 

virtual Aws::Vector< Aws::String > GetResponseChecksumAlgorithmNames () const

 

virtual Aws::String GetChecksumAlgorithmName () const

 

virtual void SetServiceSpecificParameters (const std::shared_ptr< Http::ServiceSpecificParameters > &serviceSpecificParameters) const

 

virtual std::shared_ptr< Http::ServiceSpecificParameters > GetServiceSpecificParameters () const

 

virtual EndpointParameters GetEndpointContextParams () const

 

virtual Aws::Client::CompressionAlgorithm GetSelectedCompressionAlgorithm (Aws::Client::RequestCompressionConfig) const

 

void AddUserAgentFeature (Aws::Client::UserAgentFeature feature) const

 

Aws::Set< Aws::Client::UserAgentFeature > GetUserAgentFeatures () const

 

virtual bool RequestChecksumRequired () const

 

virtual void SetHeadersReceivedEventHandler (const Aws::Http::HeadersReceivedEventHandler &headersReceivedEventHandler)

 

virtual void SetHeadersReceivedEventHandler (Aws::Http::HeadersReceivedEventHandler &&headersReceivedEventHandler)

 

virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)

 

virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)

 

virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)

 

virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)

 

virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)

 

virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)

 

virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)

 

virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)

 

virtual void SetHeadersReceivedEventHandler (const Aws::Http::HeadersReceivedEventHandler &headersReceivedEventHandler)

 

virtual void SetHeadersReceivedEventHandler (Aws::Http::HeadersReceivedEventHandler &&headersReceivedEventHandler)

 

virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)

 

virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)

 

virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)

 

virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)

 

virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)

 

virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)

 

virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)

 

virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)

 

Additional Inherited Members

Public Types inherited from Aws::Textract::TextractRequest

using EndpointParameter = Aws::Endpoint::EndpointParameter

 

using EndpointParameters = Aws::Endpoint::EndpointParameters

 

Public Types inherited from Aws::AmazonWebServiceRequest

typedef Aws::Vector< Aws::Endpoint::EndpointParameter > EndpointParameters

 

Protected Member Functions inherited from Aws::AmazonWebServiceRequest

virtual void DumpBodyToUrl (Aws::Http::URI &uri) const

 

Protected Attributes inherited from Aws::AmazonWebServiceRequest

Aws::Http::HeaderValueCollection m_additionalCustomHeaders

 

Detailed Description

Definition at line 24 of file StartDocumentTextDetectionRequest.h.

Constructor & Destructor Documentation

StartDocumentTextDetectionRequest()

AWS_TEXTRACT_API Aws::Textract::Model::StartDocumentTextDetectionRequest::StartDocumentTextDetectionRequest ( )

default

Member Function Documentation

ClientRequestTokenHasBeenSet()

bool Aws::Textract::Model::StartDocumentTextDetectionRequest::ClientRequestTokenHasBeenSet ( ) const

inline

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.

Definition at line 63 of file StartDocumentTextDetectionRequest.h.

DocumentLocationHasBeenSet()

bool Aws::Textract::Model::StartDocumentTextDetectionRequest::DocumentLocationHasBeenSet ( ) const

inline

The location of the document to be processed.

Definition at line 45 of file StartDocumentTextDetectionRequest.h.

GetClientRequestToken()

const Aws::String & Aws::Textract::Model::StartDocumentTextDetectionRequest::GetClientRequestToken ( ) const

inline

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.

Definition at line 62 of file StartDocumentTextDetectionRequest.h.

GetDocumentLocation()

const DocumentLocation & Aws::Textract::Model::StartDocumentTextDetectionRequest::GetDocumentLocation ( ) const

inline

The location of the document to be processed.

Definition at line 44 of file StartDocumentTextDetectionRequest.h.

GetJobTag()

const Aws::String & Aws::Textract::Model::StartDocumentTextDetectionRequest::GetJobTag ( ) const

inline

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).

Definition at line 77 of file StartDocumentTextDetectionRequest.h.

GetKMSKeyId()

const Aws::String & Aws::Textract::Model::StartDocumentTextDetectionRequest::GetKMSKeyId ( ) const

inline

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.

Definition at line 120 of file StartDocumentTextDetectionRequest.h.

GetNotificationChannel()

const NotificationChannel & Aws::Textract::Model::StartDocumentTextDetectionRequest::GetNotificationChannel ( ) const

inline

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

Definition at line 90 of file StartDocumentTextDetectionRequest.h.

GetOutputConfig()

const OutputConfig & Aws::Textract::Model::StartDocumentTextDetectionRequest::GetOutputConfig ( ) const

inline

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.

Definition at line 104 of file StartDocumentTextDetectionRequest.h.

GetRequestSpecificHeaders()

AWS_TEXTRACT_API Aws::Http::HeaderValueCollection Aws::Textract::Model::StartDocumentTextDetectionRequest::GetRequestSpecificHeaders ( ) const

overridevirtual

Reimplemented from Aws::Textract::TextractRequest.

GetServiceRequestName()

virtual const char * Aws::Textract::Model::StartDocumentTextDetectionRequest::GetServiceRequestName ( ) const

inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 33 of file StartDocumentTextDetectionRequest.h.

JobTagHasBeenSet()

bool Aws::Textract::Model::StartDocumentTextDetectionRequest::JobTagHasBeenSet ( ) const

inline

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).

Definition at line 78 of file StartDocumentTextDetectionRequest.h.

KMSKeyIdHasBeenSet()

bool Aws::Textract::Model::StartDocumentTextDetectionRequest::KMSKeyIdHasBeenSet ( ) const

inline

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.

Definition at line 121 of file StartDocumentTextDetectionRequest.h.

NotificationChannelHasBeenSet()

bool Aws::Textract::Model::StartDocumentTextDetectionRequest::NotificationChannelHasBeenSet ( ) const

inline

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

Definition at line 91 of file StartDocumentTextDetectionRequest.h.

OutputConfigHasBeenSet()

bool Aws::Textract::Model::StartDocumentTextDetectionRequest::OutputConfigHasBeenSet ( ) const

inline

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.

Definition at line 105 of file StartDocumentTextDetectionRequest.h.

SerializePayload()

AWS_TEXTRACT_API Aws::String Aws::Textract::Model::StartDocumentTextDetectionRequest::SerializePayload ( ) const

overridevirtual

Implements Aws::AmazonSerializableWebServiceRequest.

SetClientRequestToken()

template<typename ClientRequestTokenT = Aws::String>

void Aws::Textract::Model::StartDocumentTextDetectionRequest::SetClientRequestToken ( ClientRequestTokenT &&  value)

inline

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.

Definition at line 65 of file StartDocumentTextDetectionRequest.h.

SetDocumentLocation()

template<typename DocumentLocationT = DocumentLocation>

void Aws::Textract::Model::StartDocumentTextDetectionRequest::SetDocumentLocation ( DocumentLocationT &&  value)

inline

The location of the document to be processed.

Definition at line 47 of file StartDocumentTextDetectionRequest.h.

SetJobTag()

template<typename JobTagT = Aws::String>

void Aws::Textract::Model::StartDocumentTextDetectionRequest::SetJobTag ( JobTagT &&  value)

inline

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).

Definition at line 80 of file StartDocumentTextDetectionRequest.h.

SetKMSKeyId()

template<typename KMSKeyIdT = Aws::String>

void Aws::Textract::Model::StartDocumentTextDetectionRequest::SetKMSKeyId ( KMSKeyIdT &&  value)

inline

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.

Definition at line 123 of file StartDocumentTextDetectionRequest.h.

SetNotificationChannel()

template<typename NotificationChannelT = NotificationChannel>

void Aws::Textract::Model::StartDocumentTextDetectionRequest::SetNotificationChannel ( NotificationChannelT &&  value)

inline

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

Definition at line 93 of file StartDocumentTextDetectionRequest.h.

SetOutputConfig()

template<typename OutputConfigT = OutputConfig>

void Aws::Textract::Model::StartDocumentTextDetectionRequest::SetOutputConfig ( OutputConfigT &&  value)

inline

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.

Definition at line 107 of file StartDocumentTextDetectionRequest.h.

WithClientRequestToken()

template<typename ClientRequestTokenT = Aws::String>

StartDocumentTextDetectionRequest & Aws::Textract::Model::StartDocumentTextDetectionRequest::WithClientRequestToken ( ClientRequestTokenT &&  value)

inline

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.

Definition at line 67 of file StartDocumentTextDetectionRequest.h.

WithDocumentLocation()

template<typename DocumentLocationT = DocumentLocation>

StartDocumentTextDetectionRequest & Aws::Textract::Model::StartDocumentTextDetectionRequest::WithDocumentLocation ( DocumentLocationT &&  value)

inline

The location of the document to be processed.

Definition at line 49 of file StartDocumentTextDetectionRequest.h.

WithJobTag()

template<typename JobTagT = Aws::String>

StartDocumentTextDetectionRequest & Aws::Textract::Model::StartDocumentTextDetectionRequest::WithJobTag ( JobTagT &&  value)

inline

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).

Definition at line 82 of file StartDocumentTextDetectionRequest.h.

WithKMSKeyId()

template<typename KMSKeyIdT = Aws::String>

StartDocumentTextDetectionRequest & Aws::Textract::Model::StartDocumentTextDetectionRequest::WithKMSKeyId ( KMSKeyIdT &&  value)

inline

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.

Definition at line 125 of file StartDocumentTextDetectionRequest.h.

WithNotificationChannel()

template<typename NotificationChannelT = NotificationChannel>

StartDocumentTextDetectionRequest & Aws::Textract::Model::StartDocumentTextDetectionRequest::WithNotificationChannel ( NotificationChannelT &&  value)

inline

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

Definition at line 95 of file StartDocumentTextDetectionRequest.h.

WithOutputConfig()

template<typename OutputConfigT = OutputConfig>

StartDocumentTextDetectionRequest & Aws::Textract::Model::StartDocumentTextDetectionRequest::WithOutputConfig ( OutputConfigT &&  value)

inline

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.

Definition at line 109 of file StartDocumentTextDetectionRequest.h.

---

The documentation for this class was generated from the following file:

• generated/src/aws-cpp-sdk-textract/include/aws/textract/model/StartDocumentTextDetectionRequest.h