-
Notifications
You must be signed in to change notification settings - Fork 548
/
CreateArchiveRuleCommand.ts
179 lines (168 loc) · 6.29 KB
/
CreateArchiveRuleCommand.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
// 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 { AccessAnalyzerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AccessAnalyzerClient";
import { CreateArchiveRuleRequest } from "../models/models_0";
import { de_CreateArchiveRuleCommand, se_CreateArchiveRuleCommand } from "../protocols/Aws_restJson1";
/**
* @public
*/
export { __MetadataBearer, $Command };
/**
* @public
*
* The input for {@link CreateArchiveRuleCommand}.
*/
export interface CreateArchiveRuleCommandInput extends CreateArchiveRuleRequest {}
/**
* @public
*
* The output of {@link CreateArchiveRuleCommand}.
*/
export interface CreateArchiveRuleCommandOutput extends __MetadataBearer {}
/**
* @public
* <p>Creates an archive rule for the specified analyzer. Archive rules automatically archive
* new findings that meet the criteria you define when you create the rule.</p>
* <p>To learn about filter keys that you can use to create an archive rule, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-reference-filter-keys.html">IAM Access Analyzer filter keys</a> in the <b>IAM User Guide</b>.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
* import { AccessAnalyzerClient, CreateArchiveRuleCommand } from "@aws-sdk/client-accessanalyzer"; // ES Modules import
* // const { AccessAnalyzerClient, CreateArchiveRuleCommand } = require("@aws-sdk/client-accessanalyzer"); // CommonJS import
* const client = new AccessAnalyzerClient(config);
* const input = { // CreateArchiveRuleRequest
* analyzerName: "STRING_VALUE", // required
* ruleName: "STRING_VALUE", // required
* filter: { // FilterCriteriaMap // required
* "<keys>": { // Criterion
* eq: [ // ValueList
* "STRING_VALUE",
* ],
* neq: [
* "STRING_VALUE",
* ],
* contains: [
* "STRING_VALUE",
* ],
* exists: true || false,
* },
* },
* clientToken: "STRING_VALUE",
* };
* const command = new CreateArchiveRuleCommand(input);
* const response = await client.send(command);
* // {};
*
* ```
*
* @param CreateArchiveRuleCommandInput - {@link CreateArchiveRuleCommandInput}
* @returns {@link CreateArchiveRuleCommandOutput}
* @see {@link CreateArchiveRuleCommandInput} for command's `input` shape.
* @see {@link CreateArchiveRuleCommandOutput} for command's `response` shape.
* @see {@link AccessAnalyzerClientResolvedConfig | config} for AccessAnalyzerClient's `config` shape.
*
* @throws {@link AccessDeniedException} (client fault)
* <p>You do not have sufficient access to perform this action.</p>
*
* @throws {@link ConflictException} (client fault)
* <p>A conflict exception error.</p>
*
* @throws {@link InternalServerException} (server fault)
* <p>Internal server error.</p>
*
* @throws {@link ResourceNotFoundException} (client fault)
* <p>The specified resource could not be found.</p>
*
* @throws {@link ServiceQuotaExceededException} (client fault)
* <p>Service quote met error.</p>
*
* @throws {@link ThrottlingException} (client fault)
* <p>Throttling limit exceeded error.</p>
*
* @throws {@link ValidationException} (client fault)
* <p>Validation exception error.</p>
*
* @throws {@link AccessAnalyzerServiceException}
* <p>Base exception class for all service exceptions from AccessAnalyzer service.</p>
*
*/
export class CreateArchiveRuleCommand extends $Command<
CreateArchiveRuleCommandInput,
CreateArchiveRuleCommandOutput,
AccessAnalyzerClientResolvedConfig
> {
// 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: CreateArchiveRuleCommandInput) {
// Start section: command_constructor
super();
// End section: command_constructor
}
/**
* @internal
*/
resolveMiddleware(
clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
configuration: AccessAnalyzerClientResolvedConfig,
options?: __HttpHandlerOptions
): Handler<CreateArchiveRuleCommandInput, CreateArchiveRuleCommandOutput> {
this.middlewareStack.use(getSerdePlugin(configuration, this.serialize, this.deserialize));
this.middlewareStack.use(
getEndpointPlugin(configuration, CreateArchiveRuleCommand.getEndpointParameterInstructions())
);
const stack = clientStack.concat(this.middlewareStack);
const { logger } = configuration;
const clientName = "AccessAnalyzerClient";
const commandName = "CreateArchiveRuleCommand";
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: CreateArchiveRuleCommandInput, context: __SerdeContext): Promise<__HttpRequest> {
return se_CreateArchiveRuleCommand(input, context);
}
/**
* @internal
*/
private deserialize(output: __HttpResponse, context: __SerdeContext): Promise<CreateArchiveRuleCommandOutput> {
return de_CreateArchiveRuleCommand(output, context);
}
// Start section: command_body_extra
// End section: command_body_extra
}