Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(client-textract): This release adds support for classifying and …
…splitting lending documents by type, and extracting information by using the Analyze Lending APIs. This release also includes support for summarized information of the processed lending document package, in addition to per document results.
- Loading branch information
awstools
committed
Nov 28, 2022
1 parent
0ac256b
commit be0312b
Showing
11 changed files
with
2,535 additions
and
154 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
124 changes: 124 additions & 0 deletions
124
clients/client-textract/src/commands/GetLendingAnalysisCommand.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,124 @@ | ||
| // smithy-typescript generated code | ||
| import { EndpointParameterInstructions, getEndpointPlugin } from "@aws-sdk/middleware-endpoint"; | ||
| import { getSerdePlugin } from "@aws-sdk/middleware-serde"; | ||
| import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@aws-sdk/protocol-http"; | ||
| import { Command as $Command } from "@aws-sdk/smithy-client"; | ||
| import { | ||
| FinalizeHandlerArguments, | ||
| Handler, | ||
| HandlerExecutionContext, | ||
| HttpHandlerOptions as __HttpHandlerOptions, | ||
| MetadataBearer as __MetadataBearer, | ||
| MiddlewareStack, | ||
| SerdeContext as __SerdeContext, | ||
| } from "@aws-sdk/types"; | ||
|
|
||
| import { | ||
| GetLendingAnalysisRequest, | ||
| GetLendingAnalysisRequestFilterSensitiveLog, | ||
| GetLendingAnalysisResponse, | ||
| GetLendingAnalysisResponseFilterSensitiveLog, | ||
| } from "../models/models_0"; | ||
| import { | ||
| deserializeAws_json1_1GetLendingAnalysisCommand, | ||
| serializeAws_json1_1GetLendingAnalysisCommand, | ||
| } from "../protocols/Aws_json1_1"; | ||
| import { ServiceInputTypes, ServiceOutputTypes, TextractClientResolvedConfig } from "../TextractClient"; | ||
|
|
||
| export interface GetLendingAnalysisCommandInput extends GetLendingAnalysisRequest {} | ||
| export interface GetLendingAnalysisCommandOutput extends GetLendingAnalysisResponse, __MetadataBearer {} | ||
|
|
||
| /** | ||
| * <p>Gets the results for an Amazon Textract asynchronous operation that analyzes text in a | ||
| * lending document. </p> | ||
| * <p>You start asynchronous text analysis by calling <code>StartLendingAnalysis</code>, | ||
| * which returns a job identifier (<code>JobId</code>). 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 | ||
| * <code>StartLendingAnalysis</code>. </p> | ||
| * <p>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 (<code>JobId</code>) from the initial call to | ||
| * <code>StartLendingAnalysis</code>.</p> | ||
| * @example | ||
| * Use a bare-bones client and the command you need to make an API call. | ||
| * ```javascript | ||
| * import { TextractClient, GetLendingAnalysisCommand } from "@aws-sdk/client-textract"; // ES Modules import | ||
| * // const { TextractClient, GetLendingAnalysisCommand } = require("@aws-sdk/client-textract"); // CommonJS import | ||
| * const client = new TextractClient(config); | ||
| * const command = new GetLendingAnalysisCommand(input); | ||
| * const response = await client.send(command); | ||
| * ``` | ||
| * | ||
| * @see {@link GetLendingAnalysisCommandInput} for command's `input` shape. | ||
| * @see {@link GetLendingAnalysisCommandOutput} for command's `response` shape. | ||
| * @see {@link TextractClientResolvedConfig | config} for TextractClient's `config` shape. | ||
| * | ||
| */ | ||
| export class GetLendingAnalysisCommand extends $Command< | ||
| GetLendingAnalysisCommandInput, | ||
| GetLendingAnalysisCommandOutput, | ||
| TextractClientResolvedConfig | ||
| > { | ||
| // Start section: command_properties | ||
| // End section: command_properties | ||
|
|
||
| public static getEndpointParameterInstructions(): EndpointParameterInstructions { | ||
| return { | ||
| UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, | ||
| Endpoint: { type: "builtInParams", name: "endpoint" }, | ||
| Region: { type: "builtInParams", name: "region" }, | ||
| UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, | ||
| }; | ||
| } | ||
|
|
||
| constructor(readonly input: GetLendingAnalysisCommandInput) { | ||
| // Start section: command_constructor | ||
| super(); | ||
| // End section: command_constructor | ||
| } | ||
|
|
||
| /** | ||
| * @internal | ||
| */ | ||
| resolveMiddleware( | ||
| clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, | ||
| configuration: TextractClientResolvedConfig, | ||
| options?: __HttpHandlerOptions | ||
| ): Handler<GetLendingAnalysisCommandInput, GetLendingAnalysisCommandOutput> { | ||
| this.middlewareStack.use(getSerdePlugin(configuration, this.serialize, this.deserialize)); | ||
| this.middlewareStack.use( | ||
| getEndpointPlugin(configuration, GetLendingAnalysisCommand.getEndpointParameterInstructions()) | ||
| ); | ||
|
|
||
| const stack = clientStack.concat(this.middlewareStack); | ||
|
|
||
| const { logger } = configuration; | ||
| const clientName = "TextractClient"; | ||
| const commandName = "GetLendingAnalysisCommand"; | ||
| const handlerExecutionContext: HandlerExecutionContext = { | ||
| logger, | ||
| clientName, | ||
| commandName, | ||
| inputFilterSensitiveLog: GetLendingAnalysisRequestFilterSensitiveLog, | ||
| outputFilterSensitiveLog: GetLendingAnalysisResponseFilterSensitiveLog, | ||
| }; | ||
| const { requestHandler } = configuration; | ||
| return stack.resolve( | ||
| (request: FinalizeHandlerArguments<any>) => | ||
| requestHandler.handle(request.request as __HttpRequest, options || {}), | ||
| handlerExecutionContext | ||
| ); | ||
| } | ||
|
|
||
| private serialize(input: GetLendingAnalysisCommandInput, context: __SerdeContext): Promise<__HttpRequest> { | ||
| return serializeAws_json1_1GetLendingAnalysisCommand(input, context); | ||
| } | ||
|
|
||
| private deserialize(output: __HttpResponse, context: __SerdeContext): Promise<GetLendingAnalysisCommandOutput> { | ||
| return deserializeAws_json1_1GetLendingAnalysisCommand(output, context); | ||
| } | ||
|
|
||
| // Start section: command_body_extra | ||
| // End section: command_body_extra | ||
| } |
Oops, something went wrong.