/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include #include namespace Aws { namespace Textract { namespace Model { /** */ class StartExpenseAnalysisRequest : public TextractRequest { public: AWS_TEXTRACT_API StartExpenseAnalysisRequest(); // Service request name is the Operation name which will send this request out, // each operation should has unique request name, so that we can get operation's name from this request. // Note: this is not true for response, multiple operations may have the same response name, // so we can not get operation's name from response. inline virtual const char* GetServiceRequestName() const override { return "StartExpenseAnalysis"; } AWS_TEXTRACT_API Aws::String SerializePayload() const override; AWS_TEXTRACT_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; /** *

The location of the document to be processed.

*/ inline const DocumentLocation& GetDocumentLocation() const{ return m_documentLocation; } /** *

The location of the document to be processed.

*/ inline bool DocumentLocationHasBeenSet() const { return m_documentLocationHasBeenSet; } /** *

The location of the document to be processed.

*/ inline void SetDocumentLocation(const DocumentLocation& value) { m_documentLocationHasBeenSet = true; m_documentLocation = value; } /** *

The location of the document to be processed.

*/ inline void SetDocumentLocation(DocumentLocation&& value) { m_documentLocationHasBeenSet = true; m_documentLocation = std::move(value); } /** *

The location of the document to be processed.

*/ inline StartExpenseAnalysisRequest& WithDocumentLocation(const DocumentLocation& value) { SetDocumentLocation(value); return *this;} /** *

The location of the document to be processed.

*/ inline StartExpenseAnalysisRequest& WithDocumentLocation(DocumentLocation&& value) { SetDocumentLocation(std::move(value)); return *this;} /** *

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

*/ inline const Aws::String& GetClientRequestToken() const{ return m_clientRequestToken; } /** *

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

*/ inline bool ClientRequestTokenHasBeenSet() const { return m_clientRequestTokenHasBeenSet; } /** *

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

*/ inline void SetClientRequestToken(const Aws::String& value) { m_clientRequestTokenHasBeenSet = true; m_clientRequestToken = value; } /** *

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

*/ inline void SetClientRequestToken(Aws::String&& value) { m_clientRequestTokenHasBeenSet = true; m_clientRequestToken = std::move(value); } /** *

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

*/ inline void SetClientRequestToken(const char* value) { m_clientRequestTokenHasBeenSet = true; m_clientRequestToken.assign(value); } /** *

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

*/ inline StartExpenseAnalysisRequest& WithClientRequestToken(const Aws::String& value) { SetClientRequestToken(value); return *this;} /** *

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

*/ inline StartExpenseAnalysisRequest& WithClientRequestToken(Aws::String&& value) { SetClientRequestToken(std::move(value)); return *this;} /** *

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

*/ inline StartExpenseAnalysisRequest& WithClientRequestToken(const char* value) { SetClientRequestToken(value); return *this;} /** *

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

*/ inline const Aws::String& GetJobTag() const{ return m_jobTag; } /** *

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

*/ inline bool JobTagHasBeenSet() const { return m_jobTagHasBeenSet; } /** *

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

*/ inline void SetJobTag(const Aws::String& value) { m_jobTagHasBeenSet = true; m_jobTag = value; } /** *

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

*/ inline void SetJobTag(Aws::String&& value) { m_jobTagHasBeenSet = true; m_jobTag = std::move(value); } /** *

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

*/ inline void SetJobTag(const char* value) { m_jobTagHasBeenSet = true; m_jobTag.assign(value); } /** *

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

*/ inline StartExpenseAnalysisRequest& WithJobTag(const Aws::String& value) { SetJobTag(value); return *this;} /** *

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

*/ inline StartExpenseAnalysisRequest& WithJobTag(Aws::String&& value) { SetJobTag(std::move(value)); return *this;} /** *

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

*/ inline StartExpenseAnalysisRequest& WithJobTag(const char* value) { SetJobTag(value); return *this;} /** *

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

*/ inline const NotificationChannel& GetNotificationChannel() const{ return m_notificationChannel; } /** *

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

*/ inline bool NotificationChannelHasBeenSet() const { return m_notificationChannelHasBeenSet; } /** *

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

*/ inline void SetNotificationChannel(const NotificationChannel& value) { m_notificationChannelHasBeenSet = true; m_notificationChannel = value; } /** *

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

*/ inline void SetNotificationChannel(NotificationChannel&& value) { m_notificationChannelHasBeenSet = true; m_notificationChannel = std::move(value); } /** *

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

*/ inline StartExpenseAnalysisRequest& WithNotificationChannel(const NotificationChannel& value) { SetNotificationChannel(value); return *this;} /** *

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

*/ inline StartExpenseAnalysisRequest& WithNotificationChannel(NotificationChannel&& value) { SetNotificationChannel(std::move(value)); return *this;} /** *

Sets if the output will go to a customer defined bucket. By default, Amazon * Textract will save the results internally to be accessed by the * GetExpenseAnalysis operation.

*/ inline const OutputConfig& GetOutputConfig() const{ return m_outputConfig; } /** *

Sets if the output will go to a customer defined bucket. By default, Amazon * Textract will save the results internally to be accessed by the * GetExpenseAnalysis operation.

*/ inline bool OutputConfigHasBeenSet() const { return m_outputConfigHasBeenSet; } /** *

Sets if the output will go to a customer defined bucket. By default, Amazon * Textract will save the results internally to be accessed by the * GetExpenseAnalysis operation.

*/ inline void SetOutputConfig(const OutputConfig& value) { m_outputConfigHasBeenSet = true; m_outputConfig = value; } /** *

Sets if the output will go to a customer defined bucket. By default, Amazon * Textract will save the results internally to be accessed by the * GetExpenseAnalysis operation.

*/ inline void SetOutputConfig(OutputConfig&& value) { m_outputConfigHasBeenSet = true; m_outputConfig = std::move(value); } /** *

Sets if the output will go to a customer defined bucket. By default, Amazon * Textract will save the results internally to be accessed by the * GetExpenseAnalysis operation.

*/ inline StartExpenseAnalysisRequest& WithOutputConfig(const OutputConfig& value) { SetOutputConfig(value); return *this;} /** *

Sets if the output will go to a customer defined bucket. By default, Amazon * Textract will save the results internally to be accessed by the * GetExpenseAnalysis operation.

*/ inline StartExpenseAnalysisRequest& WithOutputConfig(OutputConfig&& value) { SetOutputConfig(std::move(value)); return *this;} /** *

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.

*/ inline const Aws::String& GetKMSKeyId() const{ return m_kMSKeyId; } /** *

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

*/ inline bool KMSKeyIdHasBeenSet() const { return m_kMSKeyIdHasBeenSet; } /** *

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.

*/ inline void SetKMSKeyId(const Aws::String& value) { m_kMSKeyIdHasBeenSet = true; m_kMSKeyId = value; } /** *

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.

*/ inline void SetKMSKeyId(Aws::String&& value) { m_kMSKeyIdHasBeenSet = true; m_kMSKeyId = std::move(value); } /** *

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.

*/ inline void SetKMSKeyId(const char* value) { m_kMSKeyIdHasBeenSet = true; m_kMSKeyId.assign(value); } /** *

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.

*/ inline StartExpenseAnalysisRequest& WithKMSKeyId(const Aws::String& value) { SetKMSKeyId(value); return *this;} /** *

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.

*/ inline StartExpenseAnalysisRequest& WithKMSKeyId(Aws::String&& value) { SetKMSKeyId(std::move(value)); return *this;} /** *

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.

*/ inline StartExpenseAnalysisRequest& WithKMSKeyId(const char* value) { SetKMSKeyId(value); return *this;} private: DocumentLocation m_documentLocation; bool m_documentLocationHasBeenSet = false; Aws::String m_clientRequestToken; bool m_clientRequestTokenHasBeenSet = false; Aws::String m_jobTag; bool m_jobTagHasBeenSet = false; NotificationChannel m_notificationChannel; bool m_notificationChannelHasBeenSet = false; OutputConfig m_outputConfig; bool m_outputConfigHasBeenSet = false; Aws::String m_kMSKeyId; bool m_kMSKeyIdHasBeenSet = false; }; } // namespace Model } // namespace Textract } // namespace Aws