/
DeleteMembersCommand.ts
185 lines (174 loc) · 6.51 KB
/
DeleteMembersCommand.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
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
// smithy-typescript generated code
import { EndpointParameterInstructions, getEndpointPlugin } from "@smithy/middleware-endpoint";
import { getSerdePlugin } from "@smithy/middleware-serde";
import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@smithy/protocol-http";
import { Command as $Command } from "@smithy/smithy-client";
import {
FinalizeHandlerArguments,
Handler,
HandlerExecutionContext,
HttpHandlerOptions as __HttpHandlerOptions,
MetadataBearer as __MetadataBearer,
MiddlewareStack,
SerdeContext as __SerdeContext,
} from "@smithy/types";
import { DeleteMembersRequest, DeleteMembersResponse } from "../models/models_2";
import { de_DeleteMembersCommand, se_DeleteMembersCommand } from "../protocols/Aws_restJson1";
import { SecurityHubClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SecurityHubClient";
/**
* @public
*/
export { __MetadataBearer, $Command };
/**
* @public
*
* The input for {@link DeleteMembersCommand}.
*/
export interface DeleteMembersCommandInput extends DeleteMembersRequest {}
/**
* @public
*
* The output of {@link DeleteMembersCommand}.
*/
export interface DeleteMembersCommandOutput extends DeleteMembersResponse, __MetadataBearer {}
/**
* @public
* <p>Deletes the specified member accounts from Security Hub.</p>
* <p>You can invoke this API only to delete accounts that became members through invitation. You can't invoke this
* API to delete accounts that belong to an Organizations organization.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
* import { SecurityHubClient, DeleteMembersCommand } from "@aws-sdk/client-securityhub"; // ES Modules import
* // const { SecurityHubClient, DeleteMembersCommand } = require("@aws-sdk/client-securityhub"); // CommonJS import
* const client = new SecurityHubClient(config);
* const input = { // DeleteMembersRequest
* AccountIds: [ // AccountIdList // required
* "STRING_VALUE",
* ],
* };
* const command = new DeleteMembersCommand(input);
* const response = await client.send(command);
* // { // DeleteMembersResponse
* // UnprocessedAccounts: [ // ResultList
* // { // Result
* // AccountId: "STRING_VALUE",
* // ProcessingResult: "STRING_VALUE",
* // },
* // ],
* // };
*
* ```
*
* @param DeleteMembersCommandInput - {@link DeleteMembersCommandInput}
* @returns {@link DeleteMembersCommandOutput}
* @see {@link DeleteMembersCommandInput} for command's `input` shape.
* @see {@link DeleteMembersCommandOutput} for command's `response` shape.
* @see {@link SecurityHubClientResolvedConfig | config} for SecurityHubClient's `config` shape.
*
* @throws {@link InternalException} (server fault)
* <p>Internal server error.</p>
*
* @throws {@link InvalidAccessException} (client fault)
* <p>The account doesn't have permission to perform this action.</p>
*
* @throws {@link InvalidInputException} (client fault)
* <p>The request was rejected because you supplied an invalid or out-of-range value for an
* input parameter.</p>
*
* @throws {@link LimitExceededException} (client fault)
* <p>The request was rejected because it attempted to create resources beyond the current Amazon Web Services
* account or throttling limits. The error code describes the limit exceeded.</p>
*
* @throws {@link ResourceNotFoundException} (client fault)
* <p>The request was rejected because we can't find the specified resource.</p>
*
* @throws {@link SecurityHubServiceException}
* <p>Base exception class for all service exceptions from SecurityHub service.</p>
*
* @example To delete a member account
* ```javascript
* // The following example deletes the specified member account from Security Hub. This operation can be used to delete member accounts that are part of an organization or that were invited manually.
* const input = {
* "AccountIds": [
* "123456789111",
* "123456789222"
* ]
* };
* const command = new DeleteMembersCommand(input);
* const response = await client.send(command);
* /* response ==
* {
* "UnprocessedAccounts": []
* }
* *\/
* // example id: to-delete-a-member-account-1675883040513
* ```
*
*/
export class DeleteMembersCommand extends $Command<
DeleteMembersCommandInput,
DeleteMembersCommandOutput,
SecurityHubClientResolvedConfig
> {
// 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: DeleteMembersCommandInput) {
// Start section: command_constructor
super();
// End section: command_constructor
}
/**
* @internal
*/
resolveMiddleware(
clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
configuration: SecurityHubClientResolvedConfig,
options?: __HttpHandlerOptions
): Handler<DeleteMembersCommandInput, DeleteMembersCommandOutput> {
this.middlewareStack.use(getSerdePlugin(configuration, this.serialize, this.deserialize));
this.middlewareStack.use(getEndpointPlugin(configuration, DeleteMembersCommand.getEndpointParameterInstructions()));
const stack = clientStack.concat(this.middlewareStack);
const { logger } = configuration;
const clientName = "SecurityHubClient";
const commandName = "DeleteMembersCommand";
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: DeleteMembersCommandInput, context: __SerdeContext): Promise<__HttpRequest> {
return se_DeleteMembersCommand(input, context);
}
/**
* @internal
*/
private deserialize(output: __HttpResponse, context: __SerdeContext): Promise<DeleteMembersCommandOutput> {
return de_DeleteMembersCommand(output, context);
}
// Start section: command_body_extra
// End section: command_body_extra
}