/
StopPiiEntitiesDetectionJobCommand.ts
146 lines (135 loc) · 5.28 KB
/
StopPiiEntitiesDetectionJobCommand.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
// 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 { ComprehendClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ComprehendClient";
import { StopPiiEntitiesDetectionJobRequest, StopPiiEntitiesDetectionJobResponse } from "../models/models_1";
import { de_StopPiiEntitiesDetectionJobCommand, se_StopPiiEntitiesDetectionJobCommand } from "../protocols/Aws_json1_1";
/**
* @public
*
* The input for {@link StopPiiEntitiesDetectionJobCommand}.
*/
export interface StopPiiEntitiesDetectionJobCommandInput extends StopPiiEntitiesDetectionJobRequest {}
/**
* @public
*
* The output of {@link StopPiiEntitiesDetectionJobCommand}.
*/
export interface StopPiiEntitiesDetectionJobCommandOutput
extends StopPiiEntitiesDetectionJobResponse,
__MetadataBearer {}
/**
* @public
* <p>Stops a PII entities detection job in progress.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
* import { ComprehendClient, StopPiiEntitiesDetectionJobCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
* // const { ComprehendClient, StopPiiEntitiesDetectionJobCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
* const client = new ComprehendClient(config);
* const input = { // StopPiiEntitiesDetectionJobRequest
* JobId: "STRING_VALUE", // required
* };
* const command = new StopPiiEntitiesDetectionJobCommand(input);
* const response = await client.send(command);
* ```
*
* @param StopPiiEntitiesDetectionJobCommandInput - {@link StopPiiEntitiesDetectionJobCommandInput}
* @returns {@link StopPiiEntitiesDetectionJobCommandOutput}
* @see {@link StopPiiEntitiesDetectionJobCommandInput} for command's `input` shape.
* @see {@link StopPiiEntitiesDetectionJobCommandOutput} for command's `response` shape.
* @see {@link ComprehendClientResolvedConfig | config} for ComprehendClient's `config` shape.
*
* @throws {@link InternalServerException} (server fault)
* <p>An internal server error occurred. Retry your request.</p>
*
* @throws {@link InvalidRequestException} (client fault)
* <p>The request is invalid.</p>
*
* @throws {@link JobNotFoundException} (client fault)
* <p>The specified job was not found. Check the job ID and try again.</p>
*
*
*/
export class StopPiiEntitiesDetectionJobCommand extends $Command<
StopPiiEntitiesDetectionJobCommandInput,
StopPiiEntitiesDetectionJobCommandOutput,
ComprehendClientResolvedConfig
> {
// 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" },
};
}
/**
* @public
*/
constructor(readonly input: StopPiiEntitiesDetectionJobCommandInput) {
// Start section: command_constructor
super();
// End section: command_constructor
}
/**
* @internal
*/
resolveMiddleware(
clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
configuration: ComprehendClientResolvedConfig,
options?: __HttpHandlerOptions
): Handler<StopPiiEntitiesDetectionJobCommandInput, StopPiiEntitiesDetectionJobCommandOutput> {
this.middlewareStack.use(getSerdePlugin(configuration, this.serialize, this.deserialize));
this.middlewareStack.use(
getEndpointPlugin(configuration, StopPiiEntitiesDetectionJobCommand.getEndpointParameterInstructions())
);
const stack = clientStack.concat(this.middlewareStack);
const { logger } = configuration;
const clientName = "ComprehendClient";
const commandName = "StopPiiEntitiesDetectionJobCommand";
const handlerExecutionContext: HandlerExecutionContext = {
logger,
clientName,
commandName,
inputFilterSensitiveLog: (_: any) => _,
outputFilterSensitiveLog: (_: any) => _,
};
const { requestHandler } = configuration;
return stack.resolve(
(request: FinalizeHandlerArguments<any>) =>
requestHandler.handle(request.request as __HttpRequest, options || {}),
handlerExecutionContext
);
}
/**
* @internal
*/
private serialize(input: StopPiiEntitiesDetectionJobCommandInput, context: __SerdeContext): Promise<__HttpRequest> {
return se_StopPiiEntitiesDetectionJobCommand(input, context);
}
/**
* @internal
*/
private deserialize(
output: __HttpResponse,
context: __SerdeContext
): Promise<StopPiiEntitiesDetectionJobCommandOutput> {
return de_StopPiiEntitiesDetectionJobCommand(output, context);
}
// Start section: command_body_extra
// End section: command_body_extra
}