Aws::Textract::TextractClient Class Reference

#include <TextractClient.h>

Inheritance diagram for Aws::Textract::TextractClient:

Public Types

typedef Aws::Client::AWSJsonClient BASECLASS

 

typedef TextractClientConfiguration ClientConfigurationType

 

typedef TextractEndpointProvider EndpointProviderType

 

Public Types inherited from Aws::Client::AWSJsonClient

typedef AWSClient BASECLASS

 

Public Member Functions

 TextractClient (const Aws::Textract::TextractClientConfiguration &clientConfiguration=Aws::Textract::TextractClientConfiguration(), std::shared_ptr< TextractEndpointProviderBase > endpointProvider=nullptr)

 

 TextractClient (const Aws::Auth::AWSCredentials &credentials, std::shared_ptr< TextractEndpointProviderBase > endpointProvider=nullptr, const Aws::Textract::TextractClientConfiguration &clientConfiguration=Aws::Textract::TextractClientConfiguration())

 

 TextractClient (const std::shared_ptr< Aws::Auth::AWSCredentialsProvider > &credentialsProvider, std::shared_ptr< TextractEndpointProviderBase > endpointProvider=nullptr, const Aws::Textract::TextractClientConfiguration &clientConfiguration=Aws::Textract::TextractClientConfiguration())

 

 TextractClient (const Aws::Client::ClientConfiguration &clientConfiguration)

 

 TextractClient (const Aws::Auth::AWSCredentials &credentials, const Aws::Client::ClientConfiguration &clientConfiguration)

 

 TextractClient (const std::shared_ptr< Aws::Auth::AWSCredentialsProvider > &credentialsProvider, const Aws::Client::ClientConfiguration &clientConfiguration)

 

virtual ~TextractClient ()

 

virtual Model::AnalyzeDocumentOutcome AnalyzeDocument (const Model::AnalyzeDocumentRequest &request) const

 

template<typename AnalyzeDocumentRequestT = Model::AnalyzeDocumentRequest>

Model::AnalyzeDocumentOutcomeCallable AnalyzeDocumentCallable (const AnalyzeDocumentRequestT &request) const

 

template<typename AnalyzeDocumentRequestT = Model::AnalyzeDocumentRequest>

void AnalyzeDocumentAsync (const AnalyzeDocumentRequestT &request, const AnalyzeDocumentResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::AnalyzeExpenseOutcome AnalyzeExpense (const Model::AnalyzeExpenseRequest &request) const

 

template<typename AnalyzeExpenseRequestT = Model::AnalyzeExpenseRequest>

Model::AnalyzeExpenseOutcomeCallable AnalyzeExpenseCallable (const AnalyzeExpenseRequestT &request) const

 

template<typename AnalyzeExpenseRequestT = Model::AnalyzeExpenseRequest>

void AnalyzeExpenseAsync (const AnalyzeExpenseRequestT &request, const AnalyzeExpenseResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::AnalyzeIDOutcome AnalyzeID (const Model::AnalyzeIDRequest &request) const

 

template<typename AnalyzeIDRequestT = Model::AnalyzeIDRequest>

Model::AnalyzeIDOutcomeCallable AnalyzeIDCallable (const AnalyzeIDRequestT &request) const

 

template<typename AnalyzeIDRequestT = Model::AnalyzeIDRequest>

void AnalyzeIDAsync (const AnalyzeIDRequestT &request, const AnalyzeIDResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::CreateAdapterOutcome CreateAdapter (const Model::CreateAdapterRequest &request) const

 

template<typename CreateAdapterRequestT = Model::CreateAdapterRequest>

Model::CreateAdapterOutcomeCallable CreateAdapterCallable (const CreateAdapterRequestT &request) const

 

template<typename CreateAdapterRequestT = Model::CreateAdapterRequest>

void CreateAdapterAsync (const CreateAdapterRequestT &request, const CreateAdapterResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::CreateAdapterVersionOutcome CreateAdapterVersion (const Model::CreateAdapterVersionRequest &request) const

 

template<typename CreateAdapterVersionRequestT = Model::CreateAdapterVersionRequest>

Model::CreateAdapterVersionOutcomeCallable CreateAdapterVersionCallable (const CreateAdapterVersionRequestT &request) const

 

template<typename CreateAdapterVersionRequestT = Model::CreateAdapterVersionRequest>

void CreateAdapterVersionAsync (const CreateAdapterVersionRequestT &request, const CreateAdapterVersionResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::DeleteAdapterOutcome DeleteAdapter (const Model::DeleteAdapterRequest &request) const

 

template<typename DeleteAdapterRequestT = Model::DeleteAdapterRequest>

Model::DeleteAdapterOutcomeCallable DeleteAdapterCallable (const DeleteAdapterRequestT &request) const

 

template<typename DeleteAdapterRequestT = Model::DeleteAdapterRequest>

void DeleteAdapterAsync (const DeleteAdapterRequestT &request, const DeleteAdapterResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::DeleteAdapterVersionOutcome DeleteAdapterVersion (const Model::DeleteAdapterVersionRequest &request) const

 

template<typename DeleteAdapterVersionRequestT = Model::DeleteAdapterVersionRequest>

Model::DeleteAdapterVersionOutcomeCallable DeleteAdapterVersionCallable (const DeleteAdapterVersionRequestT &request) const

 

template<typename DeleteAdapterVersionRequestT = Model::DeleteAdapterVersionRequest>

void DeleteAdapterVersionAsync (const DeleteAdapterVersionRequestT &request, const DeleteAdapterVersionResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::DetectDocumentTextOutcome DetectDocumentText (const Model::DetectDocumentTextRequest &request) const

 

template<typename DetectDocumentTextRequestT = Model::DetectDocumentTextRequest>

Model::DetectDocumentTextOutcomeCallable DetectDocumentTextCallable (const DetectDocumentTextRequestT &request) const

 

template<typename DetectDocumentTextRequestT = Model::DetectDocumentTextRequest>

void DetectDocumentTextAsync (const DetectDocumentTextRequestT &request, const DetectDocumentTextResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::GetAdapterOutcome GetAdapter (const Model::GetAdapterRequest &request) const

 

template<typename GetAdapterRequestT = Model::GetAdapterRequest>

Model::GetAdapterOutcomeCallable GetAdapterCallable (const GetAdapterRequestT &request) const

 

template<typename GetAdapterRequestT = Model::GetAdapterRequest>

void GetAdapterAsync (const GetAdapterRequestT &request, const GetAdapterResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::GetAdapterVersionOutcome GetAdapterVersion (const Model::GetAdapterVersionRequest &request) const

 

template<typename GetAdapterVersionRequestT = Model::GetAdapterVersionRequest>

Model::GetAdapterVersionOutcomeCallable GetAdapterVersionCallable (const GetAdapterVersionRequestT &request) const

 

template<typename GetAdapterVersionRequestT = Model::GetAdapterVersionRequest>

void GetAdapterVersionAsync (const GetAdapterVersionRequestT &request, const GetAdapterVersionResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::GetDocumentAnalysisOutcome GetDocumentAnalysis (const Model::GetDocumentAnalysisRequest &request) const

 

template<typename GetDocumentAnalysisRequestT = Model::GetDocumentAnalysisRequest>

Model::GetDocumentAnalysisOutcomeCallable GetDocumentAnalysisCallable (const GetDocumentAnalysisRequestT &request) const

 

template<typename GetDocumentAnalysisRequestT = Model::GetDocumentAnalysisRequest>

void GetDocumentAnalysisAsync (const GetDocumentAnalysisRequestT &request, const GetDocumentAnalysisResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::GetDocumentTextDetectionOutcome GetDocumentTextDetection (const Model::GetDocumentTextDetectionRequest &request) const

 

template<typename GetDocumentTextDetectionRequestT = Model::GetDocumentTextDetectionRequest>

Model::GetDocumentTextDetectionOutcomeCallable GetDocumentTextDetectionCallable (const GetDocumentTextDetectionRequestT &request) const

 

template<typename GetDocumentTextDetectionRequestT = Model::GetDocumentTextDetectionRequest>

void GetDocumentTextDetectionAsync (const GetDocumentTextDetectionRequestT &request, const GetDocumentTextDetectionResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::GetExpenseAnalysisOutcome GetExpenseAnalysis (const Model::GetExpenseAnalysisRequest &request) const

 

template<typename GetExpenseAnalysisRequestT = Model::GetExpenseAnalysisRequest>

Model::GetExpenseAnalysisOutcomeCallable GetExpenseAnalysisCallable (const GetExpenseAnalysisRequestT &request) const

 

template<typename GetExpenseAnalysisRequestT = Model::GetExpenseAnalysisRequest>

void GetExpenseAnalysisAsync (const GetExpenseAnalysisRequestT &request, const GetExpenseAnalysisResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::GetLendingAnalysisOutcome GetLendingAnalysis (const Model::GetLendingAnalysisRequest &request) const

 

template<typename GetLendingAnalysisRequestT = Model::GetLendingAnalysisRequest>

Model::GetLendingAnalysisOutcomeCallable GetLendingAnalysisCallable (const GetLendingAnalysisRequestT &request) const

 

template<typename GetLendingAnalysisRequestT = Model::GetLendingAnalysisRequest>

void GetLendingAnalysisAsync (const GetLendingAnalysisRequestT &request, const GetLendingAnalysisResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::GetLendingAnalysisSummaryOutcome GetLendingAnalysisSummary (const Model::GetLendingAnalysisSummaryRequest &request) const

 

template<typename GetLendingAnalysisSummaryRequestT = Model::GetLendingAnalysisSummaryRequest>

Model::GetLendingAnalysisSummaryOutcomeCallable GetLendingAnalysisSummaryCallable (const GetLendingAnalysisSummaryRequestT &request) const

 

template<typename GetLendingAnalysisSummaryRequestT = Model::GetLendingAnalysisSummaryRequest>

void GetLendingAnalysisSummaryAsync (const GetLendingAnalysisSummaryRequestT &request, const GetLendingAnalysisSummaryResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::ListAdapterVersionsOutcome ListAdapterVersions (const Model::ListAdapterVersionsRequest &request={}) const

 

template<typename ListAdapterVersionsRequestT = Model::ListAdapterVersionsRequest>

Model::ListAdapterVersionsOutcomeCallable ListAdapterVersionsCallable (const ListAdapterVersionsRequestT &request={}) const

 

template<typename ListAdapterVersionsRequestT = Model::ListAdapterVersionsRequest>

void ListAdapterVersionsAsync (const ListAdapterVersionsResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr, const ListAdapterVersionsRequestT &request={}) const

 

virtual Model::ListAdaptersOutcome ListAdapters (const Model::ListAdaptersRequest &request={}) const

 

template<typename ListAdaptersRequestT = Model::ListAdaptersRequest>

Model::ListAdaptersOutcomeCallable ListAdaptersCallable (const ListAdaptersRequestT &request={}) const

 

template<typename ListAdaptersRequestT = Model::ListAdaptersRequest>

void ListAdaptersAsync (const ListAdaptersResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr, const ListAdaptersRequestT &request={}) const

 

virtual Model::ListTagsForResourceOutcome ListTagsForResource (const Model::ListTagsForResourceRequest &request) const

 

template<typename ListTagsForResourceRequestT = Model::ListTagsForResourceRequest>

Model::ListTagsForResourceOutcomeCallable ListTagsForResourceCallable (const ListTagsForResourceRequestT &request) const

 

template<typename ListTagsForResourceRequestT = Model::ListTagsForResourceRequest>

void ListTagsForResourceAsync (const ListTagsForResourceRequestT &request, const ListTagsForResourceResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::StartDocumentAnalysisOutcome StartDocumentAnalysis (const Model::StartDocumentAnalysisRequest &request) const

 

template<typename StartDocumentAnalysisRequestT = Model::StartDocumentAnalysisRequest>

Model::StartDocumentAnalysisOutcomeCallable StartDocumentAnalysisCallable (const StartDocumentAnalysisRequestT &request) const

 

template<typename StartDocumentAnalysisRequestT = Model::StartDocumentAnalysisRequest>

void StartDocumentAnalysisAsync (const StartDocumentAnalysisRequestT &request, const StartDocumentAnalysisResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::StartDocumentTextDetectionOutcome StartDocumentTextDetection (const Model::StartDocumentTextDetectionRequest &request) const

 

template<typename StartDocumentTextDetectionRequestT = Model::StartDocumentTextDetectionRequest>

Model::StartDocumentTextDetectionOutcomeCallable StartDocumentTextDetectionCallable (const StartDocumentTextDetectionRequestT &request) const

 

template<typename StartDocumentTextDetectionRequestT = Model::StartDocumentTextDetectionRequest>

void StartDocumentTextDetectionAsync (const StartDocumentTextDetectionRequestT &request, const StartDocumentTextDetectionResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::StartExpenseAnalysisOutcome StartExpenseAnalysis (const Model::StartExpenseAnalysisRequest &request) const

 

template<typename StartExpenseAnalysisRequestT = Model::StartExpenseAnalysisRequest>

Model::StartExpenseAnalysisOutcomeCallable StartExpenseAnalysisCallable (const StartExpenseAnalysisRequestT &request) const

 

template<typename StartExpenseAnalysisRequestT = Model::StartExpenseAnalysisRequest>

void StartExpenseAnalysisAsync (const StartExpenseAnalysisRequestT &request, const StartExpenseAnalysisResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::StartLendingAnalysisOutcome StartLendingAnalysis (const Model::StartLendingAnalysisRequest &request) const

 

template<typename StartLendingAnalysisRequestT = Model::StartLendingAnalysisRequest>

Model::StartLendingAnalysisOutcomeCallable StartLendingAnalysisCallable (const StartLendingAnalysisRequestT &request) const

 

template<typename StartLendingAnalysisRequestT = Model::StartLendingAnalysisRequest>

void StartLendingAnalysisAsync (const StartLendingAnalysisRequestT &request, const StartLendingAnalysisResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::TagResourceOutcome TagResource (const Model::TagResourceRequest &request) const

 

template<typename TagResourceRequestT = Model::TagResourceRequest>

Model::TagResourceOutcomeCallable TagResourceCallable (const TagResourceRequestT &request) const

 

template<typename TagResourceRequestT = Model::TagResourceRequest>

void TagResourceAsync (const TagResourceRequestT &request, const TagResourceResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::UntagResourceOutcome UntagResource (const Model::UntagResourceRequest &request) const

 

template<typename UntagResourceRequestT = Model::UntagResourceRequest>

Model::UntagResourceOutcomeCallable UntagResourceCallable (const UntagResourceRequestT &request) const

 

template<typename UntagResourceRequestT = Model::UntagResourceRequest>

void UntagResourceAsync (const UntagResourceRequestT &request, const UntagResourceResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::UpdateAdapterOutcome UpdateAdapter (const Model::UpdateAdapterRequest &request) const

 

template<typename UpdateAdapterRequestT = Model::UpdateAdapterRequest>

Model::UpdateAdapterOutcomeCallable UpdateAdapterCallable (const UpdateAdapterRequestT &request) const

 

template<typename UpdateAdapterRequestT = Model::UpdateAdapterRequest>

void UpdateAdapterAsync (const UpdateAdapterRequestT &request, const UpdateAdapterResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

void OverrideEndpoint (const Aws::String &endpoint)

 

std::shared_ptr< TextractEndpointProviderBase > & accessEndpointProvider ()

 

Public Member Functions inherited from Aws::Client::AWSJsonClient

 AWSJsonClient (const Aws::Client::ClientConfiguration &configuration, const std::shared_ptr< Aws::Client::AWSAuthSigner > &signer, const std::shared_ptr< AWSErrorMarshaller > &errorMarshaller)

 

 AWSJsonClient (const Aws::Client::ClientConfiguration &configuration, const std::shared_ptr< Aws::Auth::AWSAuthSignerProvider > &signerProvider, const std::shared_ptr< AWSErrorMarshaller > &errorMarshaller)

 

virtual ~AWSJsonClient ()=default

 

Public Member Functions inherited from Aws::Client::AWSClient

 AWSClient (const Aws::Client::ClientConfiguration &configuration, const std::shared_ptr< Aws::Client::AWSAuthSigner > &signer, const std::shared_ptr< AWSErrorMarshaller > &errorMarshaller)

 

 AWSClient (const Aws::Client::ClientConfiguration &configuration, const std::shared_ptr< Aws::Auth::AWSAuthSignerProvider > &signerProvider, const std::shared_ptr< AWSErrorMarshaller > &errorMarshaller)

 

virtual ~AWSClient ()

 

Aws::String GeneratePresignedUrl (const Aws::Http::URI &uri, Aws::Http::HttpMethod method, long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={})

 

Aws::String GeneratePresignedUrl (const Aws::Http::URI &uri, Aws::Http::HttpMethod method, const Aws::Http::HeaderValueCollection &customizedHeaders, long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={})

 

Aws::String GeneratePresignedUrl (const Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={}) const

 

Aws::String GeneratePresignedUrl (const Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const Aws::Http::HeaderValueCollection &customizedHeaders, long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={})

 

Aws::String GeneratePresignedUrl (const Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const char *serviceName, long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={}) const

 

Aws::String GeneratePresignedUrl (const Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const char *serviceName, const Aws::Http::HeaderValueCollection &customizedHeaders, long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={})

 

Aws::String GeneratePresignedUrl (const Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const char *serviceName, const char *signerName, long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={}) const

 

Aws::String GeneratePresignedUrl (const Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const char *serviceName, const char *signerName, const Aws::Http::HeaderValueCollection &customizedHeaders, long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={})

 

Aws::String GeneratePresignedUrl (const Aws::Endpoint::AWSEndpoint &endpoint, Aws::Http::HttpMethod method=Http::HttpMethod::HTTP_POST, const Aws::Http::HeaderValueCollection &customizedHeaders={}, uint64_t expirationInSeconds=0, const char *signerName=Aws::Auth::SIGV4_SIGNER, const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={})

 

Aws::String GeneratePresignedUrl (const Aws::AmazonWebServiceRequest &request, const Aws::Http::URI &uri, Aws::Http::HttpMethod method, const Aws::Http::QueryStringParameterCollection &extraParams=Aws::Http::QueryStringParameterCollection(), long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={}) const

 

Aws::String GeneratePresignedUrl (const Aws::AmazonWebServiceRequest &request, const Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const char *serviceName, const char *signerName, const Aws::Http::QueryStringParameterCollection &extraParams=Aws::Http::QueryStringParameterCollection(), long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={}) const

 

Aws::String GeneratePresignedUrl (const Aws::AmazonWebServiceRequest &request, const Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const char *serviceName, const Aws::Http::QueryStringParameterCollection &extraParams=Aws::Http::QueryStringParameterCollection(), long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={}) const

 

Aws::String GeneratePresignedUrl (const Aws::AmazonWebServiceRequest &request, const Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const Aws::Http::QueryStringParameterCollection &extraParams=Aws::Http::QueryStringParameterCollection(), long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={}) const

 

const std::shared_ptr< Aws::Http::HttpClient > & GetHttpClient () const

 

void DisableRequestProcessing ()

 

void EnableRequestProcessing ()

 

virtual const char * GetServiceClientName () const

 

virtual void SetServiceClientName (const Aws::String &name)

 

void AppendToUserAgent (const Aws::String &valueToAppend)

 

Public Member Functions inherited from Aws::Client::ClientWithAsyncTemplateMethods< TextractClient >

 ClientWithAsyncTemplateMethods ()

 

 ClientWithAsyncTemplateMethods (const ClientWithAsyncTemplateMethods &other)

 

ClientWithAsyncTemplateMethods & operator= (const ClientWithAsyncTemplateMethods &other)

 

virtual ~ClientWithAsyncTemplateMethods ()

 

void SubmitAsync (OperationFuncT operationFunc, const RequestT &request, const HandlerT &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

void SubmitAsync (OperationFuncT operationFunc, RequestT &request, const HandlerT &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

void SubmitAsync (OperationFuncT operationFunc, const HandlerT &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

auto SubmitCallable (OperationFuncT operationFunc, const RequestT &request) const -> std::future< decltype((static_cast< const AwsServiceClientT * >(nullptr) -> *operationFunc)(request))>

 

auto SubmitCallable (OperationFuncT operationFunc, RequestT &request) const -> std::future< decltype((static_cast< const AwsServiceClientT * >(nullptr) -> *operationFunc)(request))>

 

auto SubmitCallable (OperationFuncT operationFunc) const -> std::future< decltype((static_cast< const AwsServiceClientT * >(nullptr) -> *operationFunc)())>

 

Static Public Member Functions

static const char * GetServiceName ()

 

static const char * GetAllocationTag ()

 

Static Public Member Functions inherited from Aws::Client::ClientWithAsyncTemplateMethods< TextractClient >

static void ShutdownSdkClient (void *pThis, int64_t timeoutMs=-1)

 

Friends

class Aws::Client::ClientWithAsyncTemplateMethods< TextractClient >

 

Additional Inherited Members

Protected Member Functions inherited from Aws::Client::AWSJsonClient

virtual AWSError< CoreErrors > BuildAWSError (const std::shared_ptr< Aws::Http::HttpResponse > &response) const override

 

JsonOutcome MakeRequest (const Aws::AmazonWebServiceRequest &request, const Aws::Endpoint::AWSEndpoint &endpoint, Http::HttpMethod method=Http::HttpMethod::HTTP_POST, const char *signerName=Aws::Auth::SIGV4_SIGNER, const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const

 

JsonOutcome MakeRequest (const Aws::Endpoint::AWSEndpoint &endpoint, Http::HttpMethod method=Http::HttpMethod::HTTP_POST, const char *signerName=Aws::Auth::SIGV4_SIGNER, const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const

 

JsonOutcome MakeRequest (const Aws::Http::URI &uri, const Aws::AmazonWebServiceRequest &request, Http::HttpMethod method=Http::HttpMethod::HTTP_POST, const char *signerName=Aws::Auth::SIGV4_SIGNER, const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const

 

JsonOutcome MakeRequest (const Aws::Http::URI &uri, Http::HttpMethod method=Http::HttpMethod::HTTP_POST, const char *signerName=Aws::Auth::SIGV4_SIGNER, const char *requestName="", const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const

 

JsonOutcome MakeEventStreamRequest (std::shared_ptr< Aws::Http::HttpRequest > &request) const

 

Protected Member Functions inherited from Aws::Client::AWSClient

HttpResponseOutcome AttemptExhaustively (const Aws::Http::URI &uri, const Aws::AmazonWebServiceRequest &request, Http::HttpMethod httpMethod, const char *signerName, const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const

 

HttpResponseOutcome AttemptExhaustively (const Aws::Http::URI &uri, Http::HttpMethod httpMethod, const char *signerName, const char *requestName="", const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const

 

HttpResponseOutcome AttemptOneRequest (const std::shared_ptr< Http::HttpRequest > &httpRequest, const Aws::AmazonWebServiceRequest &request, const char *signerName, const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const

 

HttpResponseOutcome AttemptOneRequest (const std::shared_ptr< Http::HttpRequest > &httpRequest, const char *signerName, const char *requestName="", const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const

 

StreamOutcome MakeRequestWithUnparsedResponse (const Aws::Http::URI &uri, const Aws::AmazonWebServiceRequest &request, Http::HttpMethod method=Http::HttpMethod::HTTP_POST, const char *signerName=Aws::Auth::SIGV4_SIGNER, const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const

 

StreamOutcome MakeRequestWithUnparsedResponse (const Aws::Http::URI &uri, Http::HttpMethod method=Http::HttpMethod::HTTP_POST, const char *signerName=Aws::Auth::SIGV4_SIGNER, const char *requestName="", const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const

 

StreamOutcome MakeRequestWithUnparsedResponse (const Aws::AmazonWebServiceRequest &request, const Aws::Endpoint::AWSEndpoint &endpoint, Http::HttpMethod method=Http::HttpMethod::HTTP_POST, const char *signerName=Aws::Auth::SIGV4_SIGNER, const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const

 

virtual void BuildHttpRequest (const Aws::AmazonWebServiceRequest &request, const std::shared_ptr< Aws::Http::HttpRequest > &httpRequest) const

 

const std::shared_ptr< AWSErrorMarshaller > & GetErrorMarshaller () const

 

Aws::Client::AWSAuthSigner * GetSignerByName (const char *name) const

 

std::shared_ptr< Auth::AWSCredentialsProvider > GetCredentialsProvider () const

 

std::shared_ptr< Aws::Http::HttpRequest > BuildAndSignHttpRequest (const Aws::Http::URI &uri, const Aws::AmazonWebServiceRequest &request, Http::HttpMethod method, const char *signerName) const

 

std::shared_ptr< Aws::Http::HttpResponse > MakeHttpRequest (std::shared_ptr< Aws::Http::HttpRequest > &request) const

 

Static Protected Member Functions inherited from Aws::Client::AWSClient

static void AppendRecursionDetectionHeader (std::shared_ptr< Aws::Http::HttpRequest > ioRequest)

 

static CoreErrors GuessBodylessErrorType (Aws::Http::HttpResponseCode responseCode)

 

static bool DoesResponseGenerateError (const std::shared_ptr< Aws::Http::HttpResponse > &response)

 

Protected Attributes inherited from Aws::Client::AWSClient

Aws::String m_region

 

std::shared_ptr< smithy::components::tracing::TelemetryProvider > m_telemetryProvider

 

std::shared_ptr< Aws::Auth::AWSAuthSignerProvider > m_signerProvider

 

Protected Attributes inherited from Aws::Client::ClientWithAsyncTemplateMethods< TextractClient >

std::atomic< bool > m_isInitialized

 

std::atomic< size_t > m_operationsProcessed

 

std::condition_variable m_shutdownSignal

 

std::mutex m_shutdownMutex

 

Detailed Description

Amazon Textract detects and analyzes text in documents and converts it into machine-readable text. This is the API reference documentation for Amazon Textract.

Definition at line 23 of file TextractClient.h.

Member Typedef Documentation

BASECLASS

typedef Aws::Client::AWSJsonClient Aws::Textract::TextractClient::BASECLASS

Definition at line 26 of file TextractClient.h.

ClientConfigurationType

typedef TextractClientConfiguration Aws::Textract::TextractClient::ClientConfigurationType

Definition at line 30 of file TextractClient.h.

EndpointProviderType

typedef TextractEndpointProvider Aws::Textract::TextractClient::EndpointProviderType

Definition at line 31 of file TextractClient.h.

Constructor & Destructor Documentation

TextractClient() [1/6]

Aws::Textract::TextractClient::TextractClient ( const Aws::Textract::TextractClientConfiguration &  clientConfiguration = Aws::Textract::TextractClientConfiguration(),

std::shared_ptr< TextractEndpointProviderBase >  endpointProvider = nullptr 

)

Initializes client to use DefaultCredentialProviderChain, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.

TextractClient() [2/6]

Aws::Textract::TextractClient::TextractClient ( const Aws::Auth::AWSCredentials &  credentials,

std::shared_ptr< TextractEndpointProviderBase >  endpointProvider = nullptr,

const Aws::Textract::TextractClientConfiguration &  clientConfiguration = Aws::Textract::TextractClientConfiguration() 

)

Initializes client to use SimpleAWSCredentialsProvider, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.

TextractClient() [3/6]

Aws::Textract::TextractClient::TextractClient ( const std::shared_ptr< Aws::Auth::AWSCredentialsProvider > &  credentialsProvider,

std::shared_ptr< TextractEndpointProviderBase >  endpointProvider = nullptr,

const Aws::Textract::TextractClientConfiguration &  clientConfiguration = Aws::Textract::TextractClientConfiguration() 

)

Initializes client to use specified credentials provider with specified client config. If http client factory is not supplied, the default http client factory will be used

TextractClient() [4/6]

Aws::Textract::TextractClient::TextractClient ( const Aws::Client::ClientConfiguration &  clientConfiguration)

Initializes client to use DefaultCredentialProviderChain, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.

TextractClient() [5/6]

Aws::Textract::TextractClient::TextractClient ( const Aws::Auth::AWSCredentials &  credentials,

const Aws::Client::ClientConfiguration &  clientConfiguration 

)

Initializes client to use SimpleAWSCredentialsProvider, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.

TextractClient() [6/6]

Aws::Textract::TextractClient::TextractClient ( const std::shared_ptr< Aws::Auth::AWSCredentialsProvider > &  credentialsProvider,

const Aws::Client::ClientConfiguration &  clientConfiguration 

)

Initializes client to use specified credentials provider with specified client config. If http client factory is not supplied, the default http client factory will be used

~TextractClient()

virtual Aws::Textract::TextractClient::~TextractClient ( )

virtual

Member Function Documentation

accessEndpointProvider()

std::shared_ptr< TextractEndpointProviderBase > & Aws::Textract::TextractClient::accessEndpointProvider ( )

AnalyzeDocument()

virtual Model::AnalyzeDocumentOutcome Aws::Textract::TextractClient::AnalyzeDocument ( const Model::AnalyzeDocumentRequest &  request) const

virtual

Analyzes an input document for relationships between detected items.

The types of information returned are as follows:

• Form data (key-value pairs). The related information is returned in two Block objects, each of type KEY_VALUE_SET: a KEY Block object and a VALUE Block object. For example, Name: Ana Silva Carolina contains a key and value. Name: is the key. Ana Silva Carolina is the value.

• Table and table cell data. A TABLE Block object contains information about a detected table. A CELL Block object is returned for each cell in a table.

• Lines and words of text. A LINE Block object contains one or more WORD Block objects. All lines and words that are detected in the document are returned (including text that doesn't have a relationship with the value of FeatureTypes).

• Signatures. A SIGNATURE Block object contains the location information of a signature in a document. If used in conjunction with forms or tables, a signature can be given a Key-Value pairing or be detected in the cell of a table.

• Query. A QUERY Block object contains the query text, alias and link to the associated Query results block object.

• Query Result. A QUERY_RESULT Block object contains the answer to the query and an ID that connects it to the query asked. This Block also contains a confidence score.

Selection elements such as check boxes and option buttons (radio buttons) can be detected in form data and in tables. A SELECTION_ELEMENT Block object contains information about a selection element, including the selection status.

You can choose which type of analysis to perform by specifying the FeatureTypes list.

The output is returned in a list of Block objects.

AnalyzeDocument is a synchronous operation. To analyze documents asynchronously, use StartDocumentAnalysis.

For more information, see Document Text Analysis.

See Also:

AWS API Reference

AnalyzeDocumentAsync()

template<typename AnalyzeDocumentRequestT = Model::AnalyzeDocumentRequest>

void Aws::Textract::TextractClient::AnalyzeDocumentAsync ( const AnalyzeDocumentRequestT &  request,

const AnalyzeDocumentResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for AnalyzeDocument that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 131 of file TextractClient.h.

AnalyzeDocumentCallable()

template<typename AnalyzeDocumentRequestT = Model::AnalyzeDocumentRequest>

Model::AnalyzeDocumentOutcomeCallable Aws::Textract::TextractClient::AnalyzeDocumentCallable ( const AnalyzeDocumentRequestT &  request) const

inline

A Callable wrapper for AnalyzeDocument that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 122 of file TextractClient.h.

AnalyzeExpense()

virtual Model::AnalyzeExpenseOutcome Aws::Textract::TextractClient::AnalyzeExpense ( const Model::AnalyzeExpenseRequest &  request) const

virtual

AnalyzeExpense synchronously analyzes an input document for financially related relationships between text.

Information is returned as ExpenseDocuments and seperated as follows:

• LineItemGroups- A data set containing LineItems which store information about the lines of text, such as an item purchased and its price on a receipt.

• SummaryFields- Contains all other information a receipt, such as header information or the vendors name.

See Also:

AWS API Reference

AnalyzeExpenseAsync()

template<typename AnalyzeExpenseRequestT = Model::AnalyzeExpenseRequest>

void Aws::Textract::TextractClient::AnalyzeExpenseAsync ( const AnalyzeExpenseRequestT &  request,

const AnalyzeExpenseResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for AnalyzeExpense that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 163 of file TextractClient.h.

AnalyzeExpenseCallable()

template<typename AnalyzeExpenseRequestT = Model::AnalyzeExpenseRequest>

Model::AnalyzeExpenseOutcomeCallable Aws::Textract::TextractClient::AnalyzeExpenseCallable ( const AnalyzeExpenseRequestT &  request) const

inline

A Callable wrapper for AnalyzeExpense that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 154 of file TextractClient.h.

AnalyzeID()

virtual Model::AnalyzeIDOutcome Aws::Textract::TextractClient::AnalyzeID ( const Model::AnalyzeIDRequest &  request) const

virtual

Analyzes identity documents for relevant information. This information is extracted and returned as IdentityDocumentFields, which records both the normalized field and value of the extracted text. Unlike other Amazon Textract operations, AnalyzeID doesn't return any Geometry data.

See Also:

AWS API Reference

AnalyzeIDAsync()

template<typename AnalyzeIDRequestT = Model::AnalyzeIDRequest>

void Aws::Textract::TextractClient::AnalyzeIDAsync ( const AnalyzeIDRequestT &  request,

const AnalyzeIDResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for AnalyzeID that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 192 of file TextractClient.h.

AnalyzeIDCallable()

template<typename AnalyzeIDRequestT = Model::AnalyzeIDRequest>

Model::AnalyzeIDOutcomeCallable Aws::Textract::TextractClient::AnalyzeIDCallable ( const AnalyzeIDRequestT &  request) const

inline

A Callable wrapper for AnalyzeID that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 183 of file TextractClient.h.

CreateAdapter()

virtual Model::CreateAdapterOutcome Aws::Textract::TextractClient::CreateAdapter ( const Model::CreateAdapterRequest &  request) const

virtual

Creates an adapter, which can be fine-tuned for enhanced performance on user provided documents. Takes an AdapterName and FeatureType. Currently the only supported feature type is QUERIES. You can also provide a Description, Tags, and a ClientRequestToken. You can choose whether or not the adapter should be AutoUpdated with the AutoUpdate argument. By default, AutoUpdate is set to DISABLED.

See Also:

AWS API Reference

CreateAdapterAsync()

template<typename CreateAdapterRequestT = Model::CreateAdapterRequest>

void Aws::Textract::TextractClient::CreateAdapterAsync ( const CreateAdapterRequestT &  request,

const CreateAdapterResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for CreateAdapter that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 222 of file TextractClient.h.

CreateAdapterCallable()

template<typename CreateAdapterRequestT = Model::CreateAdapterRequest>

Model::CreateAdapterOutcomeCallable Aws::Textract::TextractClient::CreateAdapterCallable ( const CreateAdapterRequestT &  request) const

inline

A Callable wrapper for CreateAdapter that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 213 of file TextractClient.h.

CreateAdapterVersion()

virtual Model::CreateAdapterVersionOutcome Aws::Textract::TextractClient::CreateAdapterVersion ( const Model::CreateAdapterVersionRequest &  request) const

virtual

Creates a new version of an adapter. Operates on a provided AdapterId and a specified dataset provided via the DatasetConfig argument. Requires that you specify an Amazon S3 bucket with the OutputConfig argument. You can provide an optional KMSKeyId, an optional ClientRequestToken, and optional tags.

See Also:

AWS API Reference

CreateAdapterVersionAsync()

template<typename CreateAdapterVersionRequestT = Model::CreateAdapterVersionRequest>

void Aws::Textract::TextractClient::CreateAdapterVersionAsync ( const CreateAdapterVersionRequestT &  request,

const CreateAdapterVersionResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for CreateAdapterVersion that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 251 of file TextractClient.h.

CreateAdapterVersionCallable()

template<typename CreateAdapterVersionRequestT = Model::CreateAdapterVersionRequest>

Model::CreateAdapterVersionOutcomeCallable Aws::Textract::TextractClient::CreateAdapterVersionCallable ( const CreateAdapterVersionRequestT &  request) const

inline

A Callable wrapper for CreateAdapterVersion that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 242 of file TextractClient.h.

DeleteAdapter()

virtual Model::DeleteAdapterOutcome Aws::Textract::TextractClient::DeleteAdapter ( const Model::DeleteAdapterRequest &  request) const

virtual

Deletes an Amazon Textract adapter. Takes an AdapterId and deletes the adapter specified by the ID.

See Also:

AWS API Reference

DeleteAdapterAsync()

template<typename DeleteAdapterRequestT = Model::DeleteAdapterRequest>

void Aws::Textract::TextractClient::DeleteAdapterAsync ( const DeleteAdapterRequestT &  request,

const DeleteAdapterResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for DeleteAdapter that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 277 of file TextractClient.h.

DeleteAdapterCallable()

template<typename DeleteAdapterRequestT = Model::DeleteAdapterRequest>

Model::DeleteAdapterOutcomeCallable Aws::Textract::TextractClient::DeleteAdapterCallable ( const DeleteAdapterRequestT &  request) const

inline

A Callable wrapper for DeleteAdapter that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 268 of file TextractClient.h.

DeleteAdapterVersion()

virtual Model::DeleteAdapterVersionOutcome Aws::Textract::TextractClient::DeleteAdapterVersion ( const Model::DeleteAdapterVersionRequest &  request) const

virtual

Deletes an Amazon Textract adapter version. Requires that you specify both an AdapterId and a AdapterVersion. Deletes the adapter version specified by the AdapterId and the AdapterVersion.

See Also:

AWS API Reference

DeleteAdapterVersionAsync()

template<typename DeleteAdapterVersionRequestT = Model::DeleteAdapterVersionRequest>

void Aws::Textract::TextractClient::DeleteAdapterVersionAsync ( const DeleteAdapterVersionRequestT &  request,

const DeleteAdapterVersionResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for DeleteAdapterVersion that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 304 of file TextractClient.h.

DeleteAdapterVersionCallable()

template<typename DeleteAdapterVersionRequestT = Model::DeleteAdapterVersionRequest>

Model::DeleteAdapterVersionOutcomeCallable Aws::Textract::TextractClient::DeleteAdapterVersionCallable ( const DeleteAdapterVersionRequestT &  request) const

inline

A Callable wrapper for DeleteAdapterVersion that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 295 of file TextractClient.h.

DetectDocumentText()

virtual Model::DetectDocumentTextOutcome Aws::Textract::TextractClient::DetectDocumentText ( const Model::DetectDocumentTextRequest &  request) const

virtual

Detects text in the input document. Amazon Textract can detect lines of text and the words that make up a line of text. The input document must be in one of the following image formats: JPEG, PNG, PDF, or TIFF. DetectDocumentText returns the detected text in an array of Block objects.

Each document page has as an associated Block of type PAGE. Each PAGE Block object is the parent of LINE Block objects that represent the lines of detected text on a page. A LINE Block object is a parent for each word that makes up the line. Words are represented by Block objects of type WORD.

DetectDocumentText is a synchronous operation. To analyze documents asynchronously, use StartDocumentTextDetection.

For more information, see Document Text Detection.

See Also:

AWS API Reference

DetectDocumentTextAsync()

template<typename DetectDocumentTextRequestT = Model::DetectDocumentTextRequest>

void Aws::Textract::TextractClient::DetectDocumentTextAsync ( const DetectDocumentTextRequestT &  request,

const DetectDocumentTextResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for DetectDocumentText that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 342 of file TextractClient.h.

DetectDocumentTextCallable()

template<typename DetectDocumentTextRequestT = Model::DetectDocumentTextRequest>

Model::DetectDocumentTextOutcomeCallable Aws::Textract::TextractClient::DetectDocumentTextCallable ( const DetectDocumentTextRequestT &  request) const

inline

A Callable wrapper for DetectDocumentText that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 333 of file TextractClient.h.

GetAdapter()

virtual Model::GetAdapterOutcome Aws::Textract::TextractClient::GetAdapter ( const Model::GetAdapterRequest &  request) const

virtual

Gets configuration information for an adapter specified by an AdapterId, returning information on AdapterName, Description, CreationTime, AutoUpdate status, and FeatureTypes.

See Also:

AWS API Reference

GetAdapterAsync()

template<typename GetAdapterRequestT = Model::GetAdapterRequest>

void Aws::Textract::TextractClient::GetAdapterAsync ( const GetAdapterRequestT &  request,

const GetAdapterResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for GetAdapter that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 369 of file TextractClient.h.

GetAdapterCallable()

template<typename GetAdapterRequestT = Model::GetAdapterRequest>

Model::GetAdapterOutcomeCallable Aws::Textract::TextractClient::GetAdapterCallable ( const GetAdapterRequestT &  request) const

inline

A Callable wrapper for GetAdapter that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 360 of file TextractClient.h.

GetAdapterVersion()

virtual Model::GetAdapterVersionOutcome Aws::Textract::TextractClient::GetAdapterVersion ( const Model::GetAdapterVersionRequest &  request) const

virtual

Gets configuration information for the specified adapter version, including: AdapterId, AdapterVersion, FeatureTypes, Status, StatusMessage, DatasetConfig, KMSKeyId, OutputConfig, Tags and EvaluationMetrics.

See Also:

AWS API Reference

GetAdapterVersionAsync()

template<typename GetAdapterVersionRequestT = Model::GetAdapterVersionRequest>

void Aws::Textract::TextractClient::GetAdapterVersionAsync ( const GetAdapterVersionRequestT &  request,

const GetAdapterVersionResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for GetAdapterVersion that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 397 of file TextractClient.h.

GetAdapterVersionCallable()

template<typename GetAdapterVersionRequestT = Model::GetAdapterVersionRequest>

Model::GetAdapterVersionOutcomeCallable Aws::Textract::TextractClient::GetAdapterVersionCallable ( const GetAdapterVersionRequestT &  request) const

inline

A Callable wrapper for GetAdapterVersion that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 388 of file TextractClient.h.

GetAllocationTag()

static const char * Aws::Textract::TextractClient::GetAllocationTag ( )

static

GetDocumentAnalysis()

virtual Model::GetDocumentAnalysisOutcome Aws::Textract::TextractClient::GetDocumentAnalysis ( const Model::GetDocumentAnalysisRequest &  request) const

virtual

Gets the results for an Amazon Textract asynchronous operation that analyzes text in a document.

You start asynchronous text analysis by calling StartDocumentAnalysis, which returns a job identifier (JobId). When the text analysis operation finishes, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that's registered in the initial call to StartDocumentAnalysis. 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 GetDocumentAnalysis, and pass the job identifier (JobId) from the initial call to StartDocumentAnalysis.

GetDocumentAnalysis returns an array of Block objects. The following types of information are returned:

• Form data (key-value pairs). The related information is returned in two Block objects, each of type KEY_VALUE_SET: a KEY Block object and a VALUE Block object. For example, Name: Ana Silva Carolina contains a key and value. Name: is the key. Ana Silva Carolina is the value.

• Table and table cell data. A TABLE Block object contains information about a detected table. A CELL Block object is returned for each cell in a table.

• Lines and words of text. A LINE Block object contains one or more WORD Block objects. All lines and words that are detected in the document are returned (including text that doesn't have a relationship with the value of the StartDocumentAnalysis FeatureTypes input parameter).

• Query. A QUERY Block object contains the query text, alias and link to the associated Query results block object.

• Query Results. A QUERY_RESULT Block object contains the answer to the query and an ID that connects it to the query asked. This Block also contains a confidence score.

While processing a document with queries, look out for INVALID_REQUEST_PARAMETERS output. This indicates that either the per page query limit has been exceeded or that the operation is trying to query a page in the document which doesn’t exist.

Selection elements such as check boxes and option buttons (radio buttons) can be detected in form data and in tables. A SELECTION_ELEMENT Block object contains information about a selection element, including the selection status.

Use the MaxResults parameter to limit the number of blocks that are returned. If there are more results than specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetDocumentAnalysis, and populate the NextToken request parameter with the token value that's returned from the previous call to GetDocumentAnalysis.

For more information, see Document Text Analysis.

See Also:

AWS API Reference

GetDocumentAnalysisAsync()

template<typename GetDocumentAnalysisRequestT = Model::GetDocumentAnalysisRequest>

void Aws::Textract::TextractClient::GetDocumentAnalysisAsync ( const GetDocumentAnalysisRequestT &  request,

const GetDocumentAnalysisResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for GetDocumentAnalysis that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 466 of file TextractClient.h.

GetDocumentAnalysisCallable()

template<typename GetDocumentAnalysisRequestT = Model::GetDocumentAnalysisRequest>

Model::GetDocumentAnalysisOutcomeCallable Aws::Textract::TextractClient::GetDocumentAnalysisCallable ( const GetDocumentAnalysisRequestT &  request) const

inline

A Callable wrapper for GetDocumentAnalysis that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 457 of file TextractClient.h.

GetDocumentTextDetection()

virtual Model::GetDocumentTextDetectionOutcome Aws::Textract::TextractClient::GetDocumentTextDetection ( const Model::GetDocumentTextDetectionRequest &  request) const

virtual

Gets the results for an Amazon Textract asynchronous operation that detects text in a document. Amazon Textract can detect lines of text and the words that make up a line of text.

You start asynchronous text detection by calling StartDocumentTextDetection, which returns a job identifier (JobId). When the text detection operation finishes, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that's registered in the initial call to StartDocumentTextDetection. 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.

GetDocumentTextDetection returns an array of Block objects.

Each document page has as an associated Block of type PAGE. Each PAGE Block object is the parent of LINE Block objects that represent the lines of detected text on a page. A LINE Block object is a parent for each word that makes up the line. Words are represented by Block objects of type WORD.

Use the MaxResults parameter to limit the number of blocks that are returned. If there are more results than specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetDocumentTextDetection, and populate the NextToken request parameter with the token value that's returned from the previous call to GetDocumentTextDetection.

For more information, see Document Text Detection.

See Also:

AWS API Reference

GetDocumentTextDetectionAsync()

template<typename GetDocumentTextDetectionRequestT = Model::GetDocumentTextDetectionRequest>

void Aws::Textract::TextractClient::GetDocumentTextDetectionAsync ( const GetDocumentTextDetectionRequestT &  request,

const GetDocumentTextDetectionResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for GetDocumentTextDetection that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 518 of file TextractClient.h.

GetDocumentTextDetectionCallable()

template<typename GetDocumentTextDetectionRequestT = Model::GetDocumentTextDetectionRequest>

Model::GetDocumentTextDetectionOutcomeCallable Aws::Textract::TextractClient::GetDocumentTextDetectionCallable ( const GetDocumentTextDetectionRequestT &  request) const

inline

A Callable wrapper for GetDocumentTextDetection that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 509 of file TextractClient.h.

GetExpenseAnalysis()

virtual Model::GetExpenseAnalysisOutcome Aws::Textract::TextractClient::GetExpenseAnalysis ( const Model::GetExpenseAnalysisRequest &  request) const

virtual

Gets the results for an Amazon Textract asynchronous operation that analyzes invoices and receipts. Amazon Textract finds contact information, items purchased, and vendor name, from input invoices and receipts.

You start asynchronous invoice/receipt analysis by calling StartExpenseAnalysis, which returns a job identifier (JobId). Upon completion of the invoice/receipt analysis, Amazon Textract publishes the completion status to the Amazon Simple Notification Service (Amazon SNS) topic. This topic must be registered in the initial call to StartExpenseAnalysis. To get the results of the invoice/receipt analysis operation, first ensure that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetExpenseAnalysis, and pass the job identifier (JobId) from the initial call to StartExpenseAnalysis.

Use the MaxResults parameter to limit the number of blocks that are returned. If there are more results than specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetExpenseAnalysis, and populate the NextToken request parameter with the token value that's returned from the previous call to GetExpenseAnalysis.

For more information, see Analyzing Invoices and Receipts.

See Also:

AWS API Reference

GetExpenseAnalysisAsync()

template<typename GetExpenseAnalysisRequestT = Model::GetExpenseAnalysisRequest>

void Aws::Textract::TextractClient::GetExpenseAnalysisAsync ( const GetExpenseAnalysisRequestT &  request,

const GetExpenseAnalysisResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for GetExpenseAnalysis that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 564 of file TextractClient.h.

GetExpenseAnalysisCallable()

template<typename GetExpenseAnalysisRequestT = Model::GetExpenseAnalysisRequest>

Model::GetExpenseAnalysisOutcomeCallable Aws::Textract::TextractClient::GetExpenseAnalysisCallable ( const GetExpenseAnalysisRequestT &  request) const

inline

A Callable wrapper for GetExpenseAnalysis that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 555 of file TextractClient.h.

GetLendingAnalysis()

virtual Model::GetLendingAnalysisOutcome Aws::Textract::TextractClient::GetLendingAnalysis ( const Model::GetLendingAnalysisRequest &  request) const

virtual

Gets the results for an Amazon Textract asynchronous operation that analyzes text in a lending document.

You start asynchronous text analysis by calling StartLendingAnalysis, which returns a job identifier (JobId). When the text analysis operation finishes, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that's registered in the initial call to StartLendingAnalysis.

To get the results of the text analysis operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetLendingAnalysis, and pass the job identifier (JobId) from the initial call to StartLendingAnalysis.

See Also:

AWS API Reference

GetLendingAnalysisAsync()

template<typename GetLendingAnalysisRequestT = Model::GetLendingAnalysisRequest>

void Aws::Textract::TextractClient::GetLendingAnalysisAsync ( const GetLendingAnalysisRequestT &  request,

const GetLendingAnalysisResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for GetLendingAnalysis that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 599 of file TextractClient.h.

GetLendingAnalysisCallable()

template<typename GetLendingAnalysisRequestT = Model::GetLendingAnalysisRequest>

Model::GetLendingAnalysisOutcomeCallable Aws::Textract::TextractClient::GetLendingAnalysisCallable ( const GetLendingAnalysisRequestT &  request) const

inline

A Callable wrapper for GetLendingAnalysis that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 590 of file TextractClient.h.

GetLendingAnalysisSummary()

virtual Model::GetLendingAnalysisSummaryOutcome Aws::Textract::TextractClient::GetLendingAnalysisSummary ( const Model::GetLendingAnalysisSummaryRequest &  request) const

virtual

Gets summarized results for the StartLendingAnalysis operation, which analyzes text in a lending document. The returned summary consists of information about documents grouped together by a common document type. Information like detected signatures, page numbers, and split documents is returned with respect to the type of grouped document.

You start asynchronous text analysis by calling StartLendingAnalysis, which returns a job identifier (JobId). When the text analysis operation finishes, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that's registered in the initial call to StartLendingAnalysis.

To get the results of the text analysis operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetLendingAnalysisSummary, and pass the job identifier (JobId) from the initial call to StartLendingAnalysis.

See Also:

AWS API Reference

GetLendingAnalysisSummaryAsync()

template<typename GetLendingAnalysisSummaryRequestT = Model::GetLendingAnalysisSummaryRequest>

void Aws::Textract::TextractClient::GetLendingAnalysisSummaryAsync ( const GetLendingAnalysisSummaryRequestT &  request,

const GetLendingAnalysisSummaryResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for GetLendingAnalysisSummary that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 637 of file TextractClient.h.

GetLendingAnalysisSummaryCallable()

template<typename GetLendingAnalysisSummaryRequestT = Model::GetLendingAnalysisSummaryRequest>

Model::GetLendingAnalysisSummaryOutcomeCallable Aws::Textract::TextractClient::GetLendingAnalysisSummaryCallable ( const GetLendingAnalysisSummaryRequestT &  request) const

inline

A Callable wrapper for GetLendingAnalysisSummary that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 628 of file TextractClient.h.

GetServiceName()

static const char * Aws::Textract::TextractClient::GetServiceName ( )

static

ListAdapters()

virtual Model::ListAdaptersOutcome Aws::Textract::TextractClient::ListAdapters ( const Model::ListAdaptersRequest &  request = {}) const

virtual

Lists all adapters that match the specified filtration criteria.

See Also:

AWS API Reference

ListAdaptersAsync()

template<typename ListAdaptersRequestT = Model::ListAdaptersRequest>

void Aws::Textract::TextractClient::ListAdaptersAsync ( const ListAdaptersResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr,

const ListAdaptersRequestT &  request = {} 

) const

inline

An Async wrapper for ListAdapters that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 689 of file TextractClient.h.

ListAdaptersCallable()

template<typename ListAdaptersRequestT = Model::ListAdaptersRequest>

Model::ListAdaptersOutcomeCallable Aws::Textract::TextractClient::ListAdaptersCallable ( const ListAdaptersRequestT &  request = {}) const

inline

A Callable wrapper for ListAdapters that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 680 of file TextractClient.h.

ListAdapterVersions()

virtual Model::ListAdapterVersionsOutcome Aws::Textract::TextractClient::ListAdapterVersions ( const Model::ListAdapterVersionsRequest &  request = {}) const

virtual

List all version of an adapter that meet the specified filtration criteria.

See Also:

AWS API Reference

ListAdapterVersionsAsync()

template<typename ListAdapterVersionsRequestT = Model::ListAdapterVersionsRequest>

void Aws::Textract::TextractClient::ListAdapterVersionsAsync ( const ListAdapterVersionsResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr,

const ListAdapterVersionsRequestT &  request = {} 

) const

inline

An Async wrapper for ListAdapterVersions that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 663 of file TextractClient.h.

ListAdapterVersionsCallable()

template<typename ListAdapterVersionsRequestT = Model::ListAdapterVersionsRequest>

Model::ListAdapterVersionsOutcomeCallable Aws::Textract::TextractClient::ListAdapterVersionsCallable ( const ListAdapterVersionsRequestT &  request = {}) const

inline

A Callable wrapper for ListAdapterVersions that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 654 of file TextractClient.h.

ListTagsForResource()

virtual Model::ListTagsForResourceOutcome Aws::Textract::TextractClient::ListTagsForResource ( const Model::ListTagsForResourceRequest &  request) const

virtual

Lists all tags for an Amazon Textract resource.

See Also:

AWS API Reference

ListTagsForResourceAsync()

template<typename ListTagsForResourceRequestT = Model::ListTagsForResourceRequest>

void Aws::Textract::TextractClient::ListTagsForResourceAsync ( const ListTagsForResourceRequestT &  request,

const ListTagsForResourceResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for ListTagsForResource that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 714 of file TextractClient.h.

ListTagsForResourceCallable()

template<typename ListTagsForResourceRequestT = Model::ListTagsForResourceRequest>

Model::ListTagsForResourceOutcomeCallable Aws::Textract::TextractClient::ListTagsForResourceCallable ( const ListTagsForResourceRequestT &  request) const

inline

A Callable wrapper for ListTagsForResource that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 705 of file TextractClient.h.

OverrideEndpoint()

void Aws::Textract::TextractClient::OverrideEndpoint ( const Aws::String &  endpoint)

StartDocumentAnalysis()

virtual Model::StartDocumentAnalysisOutcome Aws::Textract::TextractClient::StartDocumentAnalysis ( const Model::StartDocumentAnalysisRequest &  request) const

virtual

Starts the asynchronous analysis of an input document for relationships between detected items such as key-value pairs, tables, and selection elements.

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

StartDocumentAnalysis returns a job identifier (JobId) that you use to get the results of the operation. When text analysis 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 analysis operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetDocumentAnalysis, and pass the job identifier (JobId) from the initial call to StartDocumentAnalysis.

For more information, see Document Text Analysis.

See Also:

AWS API Reference

StartDocumentAnalysisAsync()

template<typename StartDocumentAnalysisRequestT = Model::StartDocumentAnalysisRequest>

void Aws::Textract::TextractClient::StartDocumentAnalysisAsync ( const StartDocumentAnalysisRequestT &  request,

const StartDocumentAnalysisResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for StartDocumentAnalysis that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 755 of file TextractClient.h.

StartDocumentAnalysisCallable()

template<typename StartDocumentAnalysisRequestT = Model::StartDocumentAnalysisRequest>

Model::StartDocumentAnalysisOutcomeCallable Aws::Textract::TextractClient::StartDocumentAnalysisCallable ( const StartDocumentAnalysisRequestT &  request) const

inline

A Callable wrapper for StartDocumentAnalysis that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 746 of file TextractClient.h.

StartDocumentTextDetection()

virtual Model::StartDocumentTextDetectionOutcome Aws::Textract::TextractClient::StartDocumentTextDetection ( const Model::StartDocumentTextDetectionRequest &  request) const

virtual

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.

See Also:

AWS API Reference

StartDocumentTextDetectionAsync()

template<typename StartDocumentTextDetectionRequestT = Model::StartDocumentTextDetectionRequest>

void Aws::Textract::TextractClient::StartDocumentTextDetectionAsync ( const StartDocumentTextDetectionRequestT &  request,

const StartDocumentTextDetectionResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for StartDocumentTextDetection that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 795 of file TextractClient.h.

StartDocumentTextDetectionCallable()

template<typename StartDocumentTextDetectionRequestT = Model::StartDocumentTextDetectionRequest>

Model::StartDocumentTextDetectionOutcomeCallable Aws::Textract::TextractClient::StartDocumentTextDetectionCallable ( const StartDocumentTextDetectionRequestT &  request) const

inline

A Callable wrapper for StartDocumentTextDetection that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 786 of file TextractClient.h.

StartExpenseAnalysis()

virtual Model::StartExpenseAnalysisOutcome Aws::Textract::TextractClient::StartExpenseAnalysis ( const Model::StartExpenseAnalysisRequest &  request) const

virtual

Starts the asynchronous analysis of invoices or receipts for data like contact information, items purchased, and vendor names.

StartExpenseAnalysis can analyze text in documents that are in JPEG, PNG, and PDF format. The documents must be stored in an Amazon S3 bucket. Use the DocumentLocation parameter to specify the name of your S3 bucket and the name of the document in that bucket.

StartExpenseAnalysis returns a job identifier (JobId) that you will provide to GetExpenseAnalysis to retrieve the results of the operation. When the analysis of the input invoices/receipts is finished, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that you provide to the NotificationChannel. To obtain the results of the invoice and receipt analysis operation, ensure that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetExpenseAnalysis, and pass the job identifier (JobId) that was returned by your call to StartExpenseAnalysis.

For more information, see Analyzing Invoices and Receipts.

See Also:

AWS API Reference

StartExpenseAnalysisAsync()

template<typename StartExpenseAnalysisRequestT = Model::StartExpenseAnalysisRequest>

void Aws::Textract::TextractClient::StartExpenseAnalysisAsync ( const StartExpenseAnalysisRequestT &  request,

const StartExpenseAnalysisResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for StartExpenseAnalysis that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 837 of file TextractClient.h.

StartExpenseAnalysisCallable()

template<typename StartExpenseAnalysisRequestT = Model::StartExpenseAnalysisRequest>

Model::StartExpenseAnalysisOutcomeCallable Aws::Textract::TextractClient::StartExpenseAnalysisCallable ( const StartExpenseAnalysisRequestT &  request) const

inline

A Callable wrapper for StartExpenseAnalysis that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 828 of file TextractClient.h.

StartLendingAnalysis()

virtual Model::StartLendingAnalysisOutcome Aws::Textract::TextractClient::StartLendingAnalysis ( const Model::StartLendingAnalysisRequest &  request) const

virtual

Starts the classification and analysis of an input document. StartLendingAnalysis initiates the classification and analysis of a packet of lending documents. StartLendingAnalysis operates on a document file located in an Amazon S3 bucket.

StartLendingAnalysis can analyze text in documents that are in one of the following formats: JPEG, PNG, TIFF, PDF. Use DocumentLocation to specify the bucket name and the file name of the document.

StartLendingAnalysis returns a job identifier (JobId) that you use to get the results of the operation. When the text analysis 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 analysis operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If the status is SUCCEEDED you can call either GetLendingAnalysis or GetLendingAnalysisSummary and provide the JobId to obtain the results of the analysis.

If using OutputConfig to specify an Amazon S3 bucket, the output will be contained within the specified prefix in a directory labeled with the job-id. In the directory there are 3 sub-directories:

• detailedResponse (contains the GetLendingAnalysis response)

• summaryResponse (for the GetLendingAnalysisSummary response)

• splitDocuments (documents split across logical boundaries)

See Also:

AWS API Reference

StartLendingAnalysisAsync()

template<typename StartLendingAnalysisRequestT = Model::StartLendingAnalysisRequest>

void Aws::Textract::TextractClient::StartLendingAnalysisAsync ( const StartLendingAnalysisRequestT &  request,

const StartLendingAnalysisResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for StartLendingAnalysis that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 884 of file TextractClient.h.

StartLendingAnalysisCallable()

template<typename StartLendingAnalysisRequestT = Model::StartLendingAnalysisRequest>

Model::StartLendingAnalysisOutcomeCallable Aws::Textract::TextractClient::StartLendingAnalysisCallable ( const StartLendingAnalysisRequestT &  request) const

inline

A Callable wrapper for StartLendingAnalysis that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 875 of file TextractClient.h.

TagResource()

virtual Model::TagResourceOutcome Aws::Textract::TextractClient::TagResource ( const Model::TagResourceRequest &  request) const

virtual

Adds one or more tags to the specified resource.

See Also:

AWS API Reference

TagResourceAsync()

template<typename TagResourceRequestT = Model::TagResourceRequest>

void Aws::Textract::TextractClient::TagResourceAsync ( const TagResourceRequestT &  request,

const TagResourceResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for TagResource that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 910 of file TextractClient.h.

TagResourceCallable()

template<typename TagResourceRequestT = Model::TagResourceRequest>

Model::TagResourceOutcomeCallable Aws::Textract::TextractClient::TagResourceCallable ( const TagResourceRequestT &  request) const

inline

A Callable wrapper for TagResource that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 901 of file TextractClient.h.

UntagResource()

virtual Model::UntagResourceOutcome Aws::Textract::TextractClient::UntagResource ( const Model::UntagResourceRequest &  request) const

virtual

Removes any tags with the specified keys from the specified resource.

See Also:

AWS API Reference

UntagResourceAsync()

template<typename UntagResourceRequestT = Model::UntagResourceRequest>

void Aws::Textract::TextractClient::UntagResourceAsync ( const UntagResourceRequestT &  request,

const UntagResourceResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for UntagResource that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 936 of file TextractClient.h.

UntagResourceCallable()

template<typename UntagResourceRequestT = Model::UntagResourceRequest>

Model::UntagResourceOutcomeCallable Aws::Textract::TextractClient::UntagResourceCallable ( const UntagResourceRequestT &  request) const

inline

A Callable wrapper for UntagResource that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 927 of file TextractClient.h.

UpdateAdapter()

virtual Model::UpdateAdapterOutcome Aws::Textract::TextractClient::UpdateAdapter ( const Model::UpdateAdapterRequest &  request) const

virtual

Update the configuration for an adapter. FeatureTypes configurations cannot be updated. At least one new parameter must be specified as an argument.

See Also:

AWS API Reference

UpdateAdapterAsync()

template<typename UpdateAdapterRequestT = Model::UpdateAdapterRequest>

void Aws::Textract::TextractClient::UpdateAdapterAsync ( const UpdateAdapterRequestT &  request,

const UpdateAdapterResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for UpdateAdapter that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 963 of file TextractClient.h.

UpdateAdapterCallable()

template<typename UpdateAdapterRequestT = Model::UpdateAdapterRequest>

Model::UpdateAdapterOutcomeCallable Aws::Textract::TextractClient::UpdateAdapterCallable ( const UpdateAdapterRequestT &  request) const

inline

A Callable wrapper for UpdateAdapter that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 954 of file TextractClient.h.

Friends And Related Symbol Documentation

Aws::Client::ClientWithAsyncTemplateMethods< TextractClient >

friend class Aws::Client::ClientWithAsyncTemplateMethods< TextractClient >

friend

Definition at line 970 of file TextractClient.h.

---

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

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