@aws-sdk/client-cloudtrail 3.693.0 → 3.698.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +48 -0
- package/dist-cjs/index.js +346 -44
- package/dist-es/CloudTrail.js +12 -0
- package/dist-es/commands/CreateDashboardCommand.js +22 -0
- package/dist-es/commands/DeleteDashboardCommand.js +22 -0
- package/dist-es/commands/GetDashboardCommand.js +22 -0
- package/dist-es/commands/ListDashboardsCommand.js +22 -0
- package/dist-es/commands/StartDashboardRefreshCommand.js +22 -0
- package/dist-es/commands/UpdateDashboardCommand.js +22 -0
- package/dist-es/commands/index.js +6 -0
- package/dist-es/models/models_0.js +58 -26
- package/dist-es/protocols/Aws_json1_1.js +160 -7
- package/dist-types/CloudTrail.d.ts +43 -0
- package/dist-types/CloudTrailClient.d.ts +8 -2
- package/dist-types/commands/AddTagsCommand.d.ts +4 -2
- package/dist-types/commands/CancelQueryCommand.d.ts +2 -0
- package/dist-types/commands/CreateChannelCommand.d.ts +1 -1
- package/dist-types/commands/CreateDashboardCommand.d.ts +189 -0
- package/dist-types/commands/CreateEventDataStoreCommand.d.ts +5 -1
- package/dist-types/commands/CreateTrailCommand.d.ts +6 -2
- package/dist-types/commands/DeleteDashboardCommand.d.ts +83 -0
- package/dist-types/commands/DeleteResourcePolicyCommand.d.ts +16 -3
- package/dist-types/commands/DeleteTrailCommand.d.ts +2 -0
- package/dist-types/commands/DescribeQueryCommand.d.ts +7 -3
- package/dist-types/commands/DescribeTrailsCommand.d.ts +2 -0
- package/dist-types/commands/GenerateQueryCommand.d.ts +1 -0
- package/dist-types/commands/GetDashboardCommand.d.ts +106 -0
- package/dist-types/commands/GetEventSelectorsCommand.d.ts +2 -0
- package/dist-types/commands/GetInsightSelectorsCommand.d.ts +2 -0
- package/dist-types/commands/GetQueryResultsCommand.d.ts +6 -1
- package/dist-types/commands/GetResourcePolicyCommand.d.ts +11 -3
- package/dist-types/commands/GetTrailCommand.d.ts +2 -0
- package/dist-types/commands/GetTrailStatusCommand.d.ts +2 -0
- package/dist-types/commands/ListDashboardsCommand.d.ts +85 -0
- package/dist-types/commands/ListTagsCommand.d.ts +3 -1
- package/dist-types/commands/PutEventSelectorsCommand.d.ts +2 -0
- package/dist-types/commands/PutInsightSelectorsCommand.d.ts +7 -1
- package/dist-types/commands/PutResourcePolicyCommand.d.ts +17 -21
- package/dist-types/commands/RemoveTagsCommand.d.ts +3 -1
- package/dist-types/commands/StartDashboardRefreshCommand.d.ts +98 -0
- package/dist-types/commands/StartImportCommand.d.ts +5 -1
- package/dist-types/commands/StartLoggingCommand.d.ts +2 -0
- package/dist-types/commands/StartQueryCommand.d.ts +7 -1
- package/dist-types/commands/StopLoggingCommand.d.ts +2 -0
- package/dist-types/commands/UpdateDashboardCommand.d.ts +164 -0
- package/dist-types/commands/UpdateEventDataStoreCommand.d.ts +5 -1
- package/dist-types/commands/UpdateTrailCommand.d.ts +7 -1
- package/dist-types/commands/index.d.ts +6 -0
- package/dist-types/models/models_0.d.ts +823 -116
- package/dist-types/protocols/Aws_json1_1.d.ts +54 -0
- package/dist-types/ts3.4/CloudTrail.d.ts +103 -0
- package/dist-types/ts3.4/CloudTrailClient.d.ts +36 -0
- package/dist-types/ts3.4/commands/CreateDashboardCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/DeleteDashboardCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/GetDashboardCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/ListDashboardsCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/StartDashboardRefreshCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/UpdateDashboardCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/index.d.ts +6 -0
- package/dist-types/ts3.4/models/models_0.d.ts +156 -19
- package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +72 -0
- package/package.json +35 -35
|
@@ -0,0 +1,189 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { CloudTrailClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudTrailClient";
|
|
4
|
+
import { CreateDashboardRequest, CreateDashboardResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link CreateDashboardCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface CreateDashboardCommandInput extends CreateDashboardRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link CreateDashboardCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface CreateDashboardCommandOutput extends CreateDashboardResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const CreateDashboardCommand_base: {
|
|
25
|
+
new (input: CreateDashboardCommandInput): import("@smithy/smithy-client").CommandImpl<CreateDashboardCommandInput, CreateDashboardCommandOutput, CloudTrailClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: CreateDashboardCommandInput): import("@smithy/smithy-client").CommandImpl<CreateDashboardCommandInput, CreateDashboardCommandOutput, CloudTrailClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>
|
|
31
|
+
* Creates a custom dashboard or the Highlights dashboard.
|
|
32
|
+
* </p>
|
|
33
|
+
* <ul>
|
|
34
|
+
* <li>
|
|
35
|
+
* <p>
|
|
36
|
+
* <b>Custom dashboards</b> - Custom dashboards allow you to query
|
|
37
|
+
* events in any event data store type. You can add up to 10 widgets to a custom dashboard. You can manually refresh a custom dashboard, or you can set a refresh schedule.</p>
|
|
38
|
+
* </li>
|
|
39
|
+
* <li>
|
|
40
|
+
* <p>
|
|
41
|
+
* <b>Highlights dashboard</b> - You can create
|
|
42
|
+
* the Highlights dashboard to see a summary of key user activities and API usage across all your event data stores.
|
|
43
|
+
* CloudTrail Lake manages the Highlights dashboard and refreshes the dashboard every 6 hours. To create the Highlights dashboard, you must set and enable a refresh schedule.</p>
|
|
44
|
+
* </li>
|
|
45
|
+
* </ul>
|
|
46
|
+
* <p>
|
|
47
|
+
* CloudTrail runs queries to populate the dashboard's widgets during a manual or scheduled refresh. CloudTrail must be granted permissions to run the <code>StartQuery</code> operation on your behalf. To provide permissions, run the <code>PutResourcePolicy</code> operation to attach a resource-based policy to each event data store. For more information,
|
|
48
|
+
* see <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/security_iam_resource-based-policy-examples.html#security_iam_resource-based-policy-examples-eds-dashboard">Example: Allow CloudTrail to run queries to populate a dashboard</a> in the <i>CloudTrail User Guide</i>.
|
|
49
|
+
* </p>
|
|
50
|
+
* <p>
|
|
51
|
+
* To set a refresh schedule, CloudTrail must be granted permissions to run the <code>StartDashboardRefresh</code> operation to refresh the dashboard on your behalf. To provide permissions, run the <code>PutResourcePolicy</code> operation to attach a resource-based policy to the dashboard. For more information,
|
|
52
|
+
* see <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/security_iam_resource-based-policy-examples.html#security_iam_resource-based-policy-examples-dashboards">
|
|
53
|
+
* Resource-based policy example for a dashboard</a> in the <i>CloudTrail User Guide</i>.
|
|
54
|
+
* </p>
|
|
55
|
+
* <p>For more information about dashboards, see <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/lake-dashboard.html">CloudTrail Lake dashboards</a> in the <i>CloudTrail User Guide</i>.</p>
|
|
56
|
+
* @example
|
|
57
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
58
|
+
* ```javascript
|
|
59
|
+
* import { CloudTrailClient, CreateDashboardCommand } from "@aws-sdk/client-cloudtrail"; // ES Modules import
|
|
60
|
+
* // const { CloudTrailClient, CreateDashboardCommand } = require("@aws-sdk/client-cloudtrail"); // CommonJS import
|
|
61
|
+
* const client = new CloudTrailClient(config);
|
|
62
|
+
* const input = { // CreateDashboardRequest
|
|
63
|
+
* Name: "STRING_VALUE", // required
|
|
64
|
+
* RefreshSchedule: { // RefreshSchedule
|
|
65
|
+
* Frequency: { // RefreshScheduleFrequency
|
|
66
|
+
* Unit: "HOURS" || "DAYS",
|
|
67
|
+
* Value: Number("int"),
|
|
68
|
+
* },
|
|
69
|
+
* Status: "ENABLED" || "DISABLED",
|
|
70
|
+
* TimeOfDay: "STRING_VALUE",
|
|
71
|
+
* },
|
|
72
|
+
* TagsList: [ // TagsList
|
|
73
|
+
* { // Tag
|
|
74
|
+
* Key: "STRING_VALUE", // required
|
|
75
|
+
* Value: "STRING_VALUE",
|
|
76
|
+
* },
|
|
77
|
+
* ],
|
|
78
|
+
* TerminationProtectionEnabled: true || false,
|
|
79
|
+
* Widgets: [ // RequestWidgetList
|
|
80
|
+
* { // RequestWidget
|
|
81
|
+
* QueryStatement: "STRING_VALUE", // required
|
|
82
|
+
* QueryParameters: [ // QueryParameters
|
|
83
|
+
* "STRING_VALUE",
|
|
84
|
+
* ],
|
|
85
|
+
* ViewProperties: { // ViewPropertiesMap // required
|
|
86
|
+
* "<keys>": "STRING_VALUE",
|
|
87
|
+
* },
|
|
88
|
+
* },
|
|
89
|
+
* ],
|
|
90
|
+
* };
|
|
91
|
+
* const command = new CreateDashboardCommand(input);
|
|
92
|
+
* const response = await client.send(command);
|
|
93
|
+
* // { // CreateDashboardResponse
|
|
94
|
+
* // DashboardArn: "STRING_VALUE",
|
|
95
|
+
* // Name: "STRING_VALUE",
|
|
96
|
+
* // Type: "MANAGED" || "CUSTOM",
|
|
97
|
+
* // Widgets: [ // WidgetList
|
|
98
|
+
* // { // Widget
|
|
99
|
+
* // QueryAlias: "STRING_VALUE",
|
|
100
|
+
* // QueryStatement: "STRING_VALUE",
|
|
101
|
+
* // QueryParameters: [ // QueryParameters
|
|
102
|
+
* // "STRING_VALUE",
|
|
103
|
+
* // ],
|
|
104
|
+
* // ViewProperties: { // ViewPropertiesMap
|
|
105
|
+
* // "<keys>": "STRING_VALUE",
|
|
106
|
+
* // },
|
|
107
|
+
* // },
|
|
108
|
+
* // ],
|
|
109
|
+
* // TagsList: [ // TagsList
|
|
110
|
+
* // { // Tag
|
|
111
|
+
* // Key: "STRING_VALUE", // required
|
|
112
|
+
* // Value: "STRING_VALUE",
|
|
113
|
+
* // },
|
|
114
|
+
* // ],
|
|
115
|
+
* // RefreshSchedule: { // RefreshSchedule
|
|
116
|
+
* // Frequency: { // RefreshScheduleFrequency
|
|
117
|
+
* // Unit: "HOURS" || "DAYS",
|
|
118
|
+
* // Value: Number("int"),
|
|
119
|
+
* // },
|
|
120
|
+
* // Status: "ENABLED" || "DISABLED",
|
|
121
|
+
* // TimeOfDay: "STRING_VALUE",
|
|
122
|
+
* // },
|
|
123
|
+
* // TerminationProtectionEnabled: true || false,
|
|
124
|
+
* // };
|
|
125
|
+
*
|
|
126
|
+
* ```
|
|
127
|
+
*
|
|
128
|
+
* @param CreateDashboardCommandInput - {@link CreateDashboardCommandInput}
|
|
129
|
+
* @returns {@link CreateDashboardCommandOutput}
|
|
130
|
+
* @see {@link CreateDashboardCommandInput} for command's `input` shape.
|
|
131
|
+
* @see {@link CreateDashboardCommandOutput} for command's `response` shape.
|
|
132
|
+
* @see {@link CloudTrailClientResolvedConfig | config} for CloudTrailClient's `config` shape.
|
|
133
|
+
*
|
|
134
|
+
* @throws {@link ConflictException} (client fault)
|
|
135
|
+
* <p>This exception is thrown when the specified resource is not ready for an operation. This
|
|
136
|
+
* can occur when you try to run an operation on a resource before CloudTrail has time
|
|
137
|
+
* to fully load the resource, or because another operation is modifying the resource. If this exception occurs, wait a few minutes, and then try the
|
|
138
|
+
* operation again.</p>
|
|
139
|
+
*
|
|
140
|
+
* @throws {@link EventDataStoreNotFoundException} (client fault)
|
|
141
|
+
* <p>The specified event data store was not found.</p>
|
|
142
|
+
*
|
|
143
|
+
* @throws {@link InactiveEventDataStoreException} (client fault)
|
|
144
|
+
* <p>The event data store is inactive.</p>
|
|
145
|
+
*
|
|
146
|
+
* @throws {@link InsufficientEncryptionPolicyException} (client fault)
|
|
147
|
+
* <p>For the <code>CreateTrail</code>
|
|
148
|
+
* <code>PutInsightSelectors</code>, <code>UpdateTrail</code>, <code>StartQuery</code>, and <code>StartImport</code> operations, this exception is thrown
|
|
149
|
+
* when the policy on the S3 bucket or KMS key does
|
|
150
|
+
* not have sufficient permissions for the operation.</p>
|
|
151
|
+
* <p>For all other operations, this exception is thrown when the policy for the KMS key does
|
|
152
|
+
* not have sufficient permissions for the operation.</p>
|
|
153
|
+
*
|
|
154
|
+
* @throws {@link InvalidQueryStatementException} (client fault)
|
|
155
|
+
* <p>The query that was submitted has validation errors, or uses incorrect syntax or
|
|
156
|
+
* unsupported keywords. For more information about writing a query, see <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-create-edit-query.html">Create or edit a query</a> in the <i>CloudTrail User
|
|
157
|
+
* Guide</i>.</p>
|
|
158
|
+
*
|
|
159
|
+
* @throws {@link InvalidTagParameterException} (client fault)
|
|
160
|
+
* <p>This exception is thrown when the specified tag key or values are not valid. It can also
|
|
161
|
+
* occur if there are duplicate tags or too many tags on the resource.</p>
|
|
162
|
+
*
|
|
163
|
+
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
164
|
+
* <p>
|
|
165
|
+
* This exception is thrown when the quota is exceeded. For information about CloudTrail quotas, see <a href="https://docs.aws.amazon.com/general/latest/gr/ct.html#limits_cloudtrail">Service quotas</a>
|
|
166
|
+
* in the <i>Amazon Web Services General Reference</i>.
|
|
167
|
+
* </p>
|
|
168
|
+
*
|
|
169
|
+
* @throws {@link UnsupportedOperationException} (client fault)
|
|
170
|
+
* <p>This exception is thrown when the requested operation is not supported.</p>
|
|
171
|
+
*
|
|
172
|
+
* @throws {@link CloudTrailServiceException}
|
|
173
|
+
* <p>Base exception class for all service exceptions from CloudTrail service.</p>
|
|
174
|
+
*
|
|
175
|
+
* @public
|
|
176
|
+
*/
|
|
177
|
+
export declare class CreateDashboardCommand extends CreateDashboardCommand_base {
|
|
178
|
+
/** @internal type navigation helper, not in runtime. */
|
|
179
|
+
protected static __types: {
|
|
180
|
+
api: {
|
|
181
|
+
input: CreateDashboardRequest;
|
|
182
|
+
output: CreateDashboardResponse;
|
|
183
|
+
};
|
|
184
|
+
sdk: {
|
|
185
|
+
input: CreateDashboardCommandInput;
|
|
186
|
+
output: CreateDashboardCommandOutput;
|
|
187
|
+
};
|
|
188
|
+
};
|
|
189
|
+
}
|
|
@@ -153,7 +153,11 @@ declare const CreateEventDataStoreCommand_base: {
|
|
|
153
153
|
* organization resource in a required service.</p>
|
|
154
154
|
*
|
|
155
155
|
* @throws {@link InsufficientEncryptionPolicyException} (client fault)
|
|
156
|
-
* <p>
|
|
156
|
+
* <p>For the <code>CreateTrail</code>
|
|
157
|
+
* <code>PutInsightSelectors</code>, <code>UpdateTrail</code>, <code>StartQuery</code>, and <code>StartImport</code> operations, this exception is thrown
|
|
158
|
+
* when the policy on the S3 bucket or KMS key does
|
|
159
|
+
* not have sufficient permissions for the operation.</p>
|
|
160
|
+
* <p>For all other operations, this exception is thrown when the policy for the KMS key does
|
|
157
161
|
* not have sufficient permissions for the operation.</p>
|
|
158
162
|
*
|
|
159
163
|
* @throws {@link InvalidEventSelectorsException} (client fault)
|
|
@@ -103,7 +103,11 @@ declare const CreateTrailCommand_base: {
|
|
|
103
103
|
* organization resource in a required service.</p>
|
|
104
104
|
*
|
|
105
105
|
* @throws {@link InsufficientEncryptionPolicyException} (client fault)
|
|
106
|
-
* <p>
|
|
106
|
+
* <p>For the <code>CreateTrail</code>
|
|
107
|
+
* <code>PutInsightSelectors</code>, <code>UpdateTrail</code>, <code>StartQuery</code>, and <code>StartImport</code> operations, this exception is thrown
|
|
108
|
+
* when the policy on the S3 bucket or KMS key does
|
|
109
|
+
* not have sufficient permissions for the operation.</p>
|
|
110
|
+
* <p>For all other operations, this exception is thrown when the policy for the KMS key does
|
|
107
111
|
* not have sufficient permissions for the operation.</p>
|
|
108
112
|
*
|
|
109
113
|
* @throws {@link InsufficientS3BucketPolicyException} (client fault)
|
|
@@ -207,7 +211,7 @@ declare const CreateTrailCommand_base: {
|
|
|
207
211
|
* <p>This exception is thrown when the specified S3 bucket does not exist.</p>
|
|
208
212
|
*
|
|
209
213
|
* @throws {@link TagsLimitExceededException} (client fault)
|
|
210
|
-
* <p>The number of tags per trail, event data store, or channel has exceeded the permitted amount. Currently, the limit is
|
|
214
|
+
* <p>The number of tags per trail, event data store, dashboard, or channel has exceeded the permitted amount. Currently, the limit is
|
|
211
215
|
* 50.</p>
|
|
212
216
|
*
|
|
213
217
|
* @throws {@link ThrottlingException} (client fault)
|
|
@@ -0,0 +1,83 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { CloudTrailClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudTrailClient";
|
|
4
|
+
import { DeleteDashboardRequest, DeleteDashboardResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link DeleteDashboardCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface DeleteDashboardCommandInput extends DeleteDashboardRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link DeleteDashboardCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface DeleteDashboardCommandOutput extends DeleteDashboardResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const DeleteDashboardCommand_base: {
|
|
25
|
+
new (input: DeleteDashboardCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteDashboardCommandInput, DeleteDashboardCommandOutput, CloudTrailClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: DeleteDashboardCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteDashboardCommandInput, DeleteDashboardCommandOutput, CloudTrailClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>
|
|
31
|
+
* Deletes the specified dashboard. You cannot delete a dashboard that has termination protection enabled.
|
|
32
|
+
* </p>
|
|
33
|
+
* @example
|
|
34
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
35
|
+
* ```javascript
|
|
36
|
+
* import { CloudTrailClient, DeleteDashboardCommand } from "@aws-sdk/client-cloudtrail"; // ES Modules import
|
|
37
|
+
* // const { CloudTrailClient, DeleteDashboardCommand } = require("@aws-sdk/client-cloudtrail"); // CommonJS import
|
|
38
|
+
* const client = new CloudTrailClient(config);
|
|
39
|
+
* const input = { // DeleteDashboardRequest
|
|
40
|
+
* DashboardId: "STRING_VALUE", // required
|
|
41
|
+
* };
|
|
42
|
+
* const command = new DeleteDashboardCommand(input);
|
|
43
|
+
* const response = await client.send(command);
|
|
44
|
+
* // {};
|
|
45
|
+
*
|
|
46
|
+
* ```
|
|
47
|
+
*
|
|
48
|
+
* @param DeleteDashboardCommandInput - {@link DeleteDashboardCommandInput}
|
|
49
|
+
* @returns {@link DeleteDashboardCommandOutput}
|
|
50
|
+
* @see {@link DeleteDashboardCommandInput} for command's `input` shape.
|
|
51
|
+
* @see {@link DeleteDashboardCommandOutput} for command's `response` shape.
|
|
52
|
+
* @see {@link CloudTrailClientResolvedConfig | config} for CloudTrailClient's `config` shape.
|
|
53
|
+
*
|
|
54
|
+
* @throws {@link ConflictException} (client fault)
|
|
55
|
+
* <p>This exception is thrown when the specified resource is not ready for an operation. This
|
|
56
|
+
* can occur when you try to run an operation on a resource before CloudTrail has time
|
|
57
|
+
* to fully load the resource, or because another operation is modifying the resource. If this exception occurs, wait a few minutes, and then try the
|
|
58
|
+
* operation again.</p>
|
|
59
|
+
*
|
|
60
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
61
|
+
* <p>This exception is thrown when the specified resource is not found.</p>
|
|
62
|
+
*
|
|
63
|
+
* @throws {@link UnsupportedOperationException} (client fault)
|
|
64
|
+
* <p>This exception is thrown when the requested operation is not supported.</p>
|
|
65
|
+
*
|
|
66
|
+
* @throws {@link CloudTrailServiceException}
|
|
67
|
+
* <p>Base exception class for all service exceptions from CloudTrail service.</p>
|
|
68
|
+
*
|
|
69
|
+
* @public
|
|
70
|
+
*/
|
|
71
|
+
export declare class DeleteDashboardCommand extends DeleteDashboardCommand_base {
|
|
72
|
+
/** @internal type navigation helper, not in runtime. */
|
|
73
|
+
protected static __types: {
|
|
74
|
+
api: {
|
|
75
|
+
input: DeleteDashboardRequest;
|
|
76
|
+
output: {};
|
|
77
|
+
};
|
|
78
|
+
sdk: {
|
|
79
|
+
input: DeleteDashboardCommandInput;
|
|
80
|
+
output: DeleteDashboardCommandOutput;
|
|
81
|
+
};
|
|
82
|
+
};
|
|
83
|
+
}
|
|
@@ -28,7 +28,7 @@ declare const DeleteResourcePolicyCommand_base: {
|
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
30
|
* <p>
|
|
31
|
-
* Deletes the resource-based policy attached to the CloudTrail channel.
|
|
31
|
+
* Deletes the resource-based policy attached to the CloudTrail event data store, dashboard, or channel.
|
|
32
32
|
* </p>
|
|
33
33
|
* @example
|
|
34
34
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -51,14 +51,27 @@ declare const DeleteResourcePolicyCommand_base: {
|
|
|
51
51
|
* @see {@link DeleteResourcePolicyCommandOutput} for command's `response` shape.
|
|
52
52
|
* @see {@link CloudTrailClientResolvedConfig | config} for CloudTrailClient's `config` shape.
|
|
53
53
|
*
|
|
54
|
+
* @throws {@link ConflictException} (client fault)
|
|
55
|
+
* <p>This exception is thrown when the specified resource is not ready for an operation. This
|
|
56
|
+
* can occur when you try to run an operation on a resource before CloudTrail has time
|
|
57
|
+
* to fully load the resource, or because another operation is modifying the resource. If this exception occurs, wait a few minutes, and then try the
|
|
58
|
+
* operation again.</p>
|
|
59
|
+
*
|
|
54
60
|
* @throws {@link OperationNotPermittedException} (client fault)
|
|
55
61
|
* <p>This exception is thrown when the requested operation is not permitted.</p>
|
|
56
62
|
*
|
|
57
63
|
* @throws {@link ResourceARNNotValidException} (client fault)
|
|
58
64
|
* <p>
|
|
59
|
-
* This exception is thrown when the provided resource does not exist, or the ARN format of the resource is not valid.
|
|
60
|
-
* <code>arn:aws:cloudtrail:us-east-2:123456789012:channel/MyChannel</code>.
|
|
65
|
+
* This exception is thrown when the provided resource does not exist, or the ARN format of the resource is not valid.
|
|
61
66
|
* </p>
|
|
67
|
+
* <p>The following is the format of an event data store ARN:
|
|
68
|
+
* <code>arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE</code>
|
|
69
|
+
* </p>
|
|
70
|
+
* <p>The following is the format of a dashboard ARN: <code>arn:aws:cloudtrail:us-east-1:123456789012:dashboard/exampleDash</code>
|
|
71
|
+
* </p>
|
|
72
|
+
* <p>The following is the format of a channel ARN:
|
|
73
|
+
* <code>arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890</code>
|
|
74
|
+
* </p>
|
|
62
75
|
*
|
|
63
76
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
64
77
|
* <p>This exception is thrown when the specified resource is not found.</p>
|
|
@@ -58,6 +58,8 @@ declare const DeleteTrailCommand_base: {
|
|
|
58
58
|
* <p>The following is the format of an event data store ARN:
|
|
59
59
|
* <code>arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE</code>
|
|
60
60
|
* </p>
|
|
61
|
+
* <p>The following is the format of a dashboard ARN: <code>arn:aws:cloudtrail:us-east-1:123456789012:dashboard/exampleDash</code>
|
|
62
|
+
* </p>
|
|
61
63
|
* <p>The following is the format of a channel ARN:
|
|
62
64
|
* <code>arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890</code>
|
|
63
65
|
* </p>
|
|
@@ -30,9 +30,10 @@ declare const DescribeQueryCommand_base: {
|
|
|
30
30
|
* <p>Returns metadata about a query, including query run time in milliseconds, number of
|
|
31
31
|
* events scanned and matched, and query status. If the query results were delivered to an S3 bucket,
|
|
32
32
|
* the response also provides the S3 URI and the delivery status.</p>
|
|
33
|
-
* <p>You must specify either
|
|
34
|
-
*
|
|
35
|
-
*
|
|
33
|
+
* <p>You must specify either <code>QueryId</code> or <code>QueryAlias</code>. Specifying the <code>QueryAlias</code> parameter
|
|
34
|
+
* returns information about the last query run for the alias. You can provide
|
|
35
|
+
* <code>RefreshId</code> along with <code>QueryAlias</code> to view the query results
|
|
36
|
+
* of a dashboard query for the specified <code>RefreshId</code>.</p>
|
|
36
37
|
* @example
|
|
37
38
|
* Use a bare-bones client and the command you need to make an API call.
|
|
38
39
|
* ```javascript
|
|
@@ -43,6 +44,8 @@ declare const DescribeQueryCommand_base: {
|
|
|
43
44
|
* EventDataStore: "STRING_VALUE",
|
|
44
45
|
* QueryId: "STRING_VALUE",
|
|
45
46
|
* QueryAlias: "STRING_VALUE",
|
|
47
|
+
* RefreshId: "STRING_VALUE",
|
|
48
|
+
* EventDataStoreOwnerAccountId: "STRING_VALUE",
|
|
46
49
|
* };
|
|
47
50
|
* const command = new DescribeQueryCommand(input);
|
|
48
51
|
* const response = await client.send(command);
|
|
@@ -61,6 +64,7 @@ declare const DescribeQueryCommand_base: {
|
|
|
61
64
|
* // DeliveryS3Uri: "STRING_VALUE",
|
|
62
65
|
* // DeliveryStatus: "SUCCESS" || "FAILED" || "FAILED_SIGNING_FILE" || "PENDING" || "RESOURCE_NOT_FOUND" || "ACCESS_DENIED" || "ACCESS_DENIED_SIGNING_FILE" || "CANCELLED" || "UNKNOWN",
|
|
63
66
|
* // Prompt: "STRING_VALUE",
|
|
67
|
+
* // EventDataStoreOwnerAccountId: "STRING_VALUE",
|
|
64
68
|
* // };
|
|
65
69
|
*
|
|
66
70
|
* ```
|
|
@@ -81,6 +81,8 @@ declare const DescribeTrailsCommand_base: {
|
|
|
81
81
|
* <p>The following is the format of an event data store ARN:
|
|
82
82
|
* <code>arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE</code>
|
|
83
83
|
* </p>
|
|
84
|
+
* <p>The following is the format of a dashboard ARN: <code>arn:aws:cloudtrail:us-east-1:123456789012:dashboard/exampleDash</code>
|
|
85
|
+
* </p>
|
|
84
86
|
* <p>The following is the format of a channel ARN:
|
|
85
87
|
* <code>arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890</code>
|
|
86
88
|
* </p>
|
|
@@ -0,0 +1,106 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { CloudTrailClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudTrailClient";
|
|
4
|
+
import { GetDashboardRequest, GetDashboardResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GetDashboardCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetDashboardCommandInput extends GetDashboardRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetDashboardCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetDashboardCommandOutput extends GetDashboardResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const GetDashboardCommand_base: {
|
|
25
|
+
new (input: GetDashboardCommandInput): import("@smithy/smithy-client").CommandImpl<GetDashboardCommandInput, GetDashboardCommandOutput, CloudTrailClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: GetDashboardCommandInput): import("@smithy/smithy-client").CommandImpl<GetDashboardCommandInput, GetDashboardCommandOutput, CloudTrailClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>
|
|
31
|
+
* Returns the specified dashboard.
|
|
32
|
+
* </p>
|
|
33
|
+
* @example
|
|
34
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
35
|
+
* ```javascript
|
|
36
|
+
* import { CloudTrailClient, GetDashboardCommand } from "@aws-sdk/client-cloudtrail"; // ES Modules import
|
|
37
|
+
* // const { CloudTrailClient, GetDashboardCommand } = require("@aws-sdk/client-cloudtrail"); // CommonJS import
|
|
38
|
+
* const client = new CloudTrailClient(config);
|
|
39
|
+
* const input = { // GetDashboardRequest
|
|
40
|
+
* DashboardId: "STRING_VALUE", // required
|
|
41
|
+
* };
|
|
42
|
+
* const command = new GetDashboardCommand(input);
|
|
43
|
+
* const response = await client.send(command);
|
|
44
|
+
* // { // GetDashboardResponse
|
|
45
|
+
* // DashboardArn: "STRING_VALUE",
|
|
46
|
+
* // Type: "MANAGED" || "CUSTOM",
|
|
47
|
+
* // Status: "CREATING" || "CREATED" || "UPDATING" || "UPDATED" || "DELETING",
|
|
48
|
+
* // Widgets: [ // WidgetList
|
|
49
|
+
* // { // Widget
|
|
50
|
+
* // QueryAlias: "STRING_VALUE",
|
|
51
|
+
* // QueryStatement: "STRING_VALUE",
|
|
52
|
+
* // QueryParameters: [ // QueryParameters
|
|
53
|
+
* // "STRING_VALUE",
|
|
54
|
+
* // ],
|
|
55
|
+
* // ViewProperties: { // ViewPropertiesMap
|
|
56
|
+
* // "<keys>": "STRING_VALUE",
|
|
57
|
+
* // },
|
|
58
|
+
* // },
|
|
59
|
+
* // ],
|
|
60
|
+
* // RefreshSchedule: { // RefreshSchedule
|
|
61
|
+
* // Frequency: { // RefreshScheduleFrequency
|
|
62
|
+
* // Unit: "HOURS" || "DAYS",
|
|
63
|
+
* // Value: Number("int"),
|
|
64
|
+
* // },
|
|
65
|
+
* // Status: "ENABLED" || "DISABLED",
|
|
66
|
+
* // TimeOfDay: "STRING_VALUE",
|
|
67
|
+
* // },
|
|
68
|
+
* // CreatedTimestamp: new Date("TIMESTAMP"),
|
|
69
|
+
* // UpdatedTimestamp: new Date("TIMESTAMP"),
|
|
70
|
+
* // LastRefreshId: "STRING_VALUE",
|
|
71
|
+
* // LastRefreshFailureReason: "STRING_VALUE",
|
|
72
|
+
* // TerminationProtectionEnabled: true || false,
|
|
73
|
+
* // };
|
|
74
|
+
*
|
|
75
|
+
* ```
|
|
76
|
+
*
|
|
77
|
+
* @param GetDashboardCommandInput - {@link GetDashboardCommandInput}
|
|
78
|
+
* @returns {@link GetDashboardCommandOutput}
|
|
79
|
+
* @see {@link GetDashboardCommandInput} for command's `input` shape.
|
|
80
|
+
* @see {@link GetDashboardCommandOutput} for command's `response` shape.
|
|
81
|
+
* @see {@link CloudTrailClientResolvedConfig | config} for CloudTrailClient's `config` shape.
|
|
82
|
+
*
|
|
83
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
84
|
+
* <p>This exception is thrown when the specified resource is not found.</p>
|
|
85
|
+
*
|
|
86
|
+
* @throws {@link UnsupportedOperationException} (client fault)
|
|
87
|
+
* <p>This exception is thrown when the requested operation is not supported.</p>
|
|
88
|
+
*
|
|
89
|
+
* @throws {@link CloudTrailServiceException}
|
|
90
|
+
* <p>Base exception class for all service exceptions from CloudTrail service.</p>
|
|
91
|
+
*
|
|
92
|
+
* @public
|
|
93
|
+
*/
|
|
94
|
+
export declare class GetDashboardCommand extends GetDashboardCommand_base {
|
|
95
|
+
/** @internal type navigation helper, not in runtime. */
|
|
96
|
+
protected static __types: {
|
|
97
|
+
api: {
|
|
98
|
+
input: GetDashboardRequest;
|
|
99
|
+
output: GetDashboardResponse;
|
|
100
|
+
};
|
|
101
|
+
sdk: {
|
|
102
|
+
input: GetDashboardCommandInput;
|
|
103
|
+
output: GetDashboardCommandOutput;
|
|
104
|
+
};
|
|
105
|
+
};
|
|
106
|
+
}
|
|
@@ -138,6 +138,8 @@ declare const GetEventSelectorsCommand_base: {
|
|
|
138
138
|
* <p>The following is the format of an event data store ARN:
|
|
139
139
|
* <code>arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE</code>
|
|
140
140
|
* </p>
|
|
141
|
+
* <p>The following is the format of a dashboard ARN: <code>arn:aws:cloudtrail:us-east-1:123456789012:dashboard/exampleDash</code>
|
|
142
|
+
* </p>
|
|
141
143
|
* <p>The following is the format of a channel ARN:
|
|
142
144
|
* <code>arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890</code>
|
|
143
145
|
* </p>
|
|
@@ -74,6 +74,8 @@ declare const GetInsightSelectorsCommand_base: {
|
|
|
74
74
|
* <p>The following is the format of an event data store ARN:
|
|
75
75
|
* <code>arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE</code>
|
|
76
76
|
* </p>
|
|
77
|
+
* <p>The following is the format of a dashboard ARN: <code>arn:aws:cloudtrail:us-east-1:123456789012:dashboard/exampleDash</code>
|
|
78
|
+
* </p>
|
|
77
79
|
* <p>The following is the format of a channel ARN:
|
|
78
80
|
* <code>arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890</code>
|
|
79
81
|
* </p>
|
|
@@ -40,6 +40,7 @@ declare const GetQueryResultsCommand_base: {
|
|
|
40
40
|
* QueryId: "STRING_VALUE", // required
|
|
41
41
|
* NextToken: "STRING_VALUE",
|
|
42
42
|
* MaxQueryResults: Number("int"),
|
|
43
|
+
* EventDataStoreOwnerAccountId: "STRING_VALUE",
|
|
43
44
|
* };
|
|
44
45
|
* const command = new GetQueryResultsCommand(input);
|
|
45
46
|
* const response = await client.send(command);
|
|
@@ -80,7 +81,11 @@ declare const GetQueryResultsCommand_base: {
|
|
|
80
81
|
* <p>The event data store is inactive.</p>
|
|
81
82
|
*
|
|
82
83
|
* @throws {@link InsufficientEncryptionPolicyException} (client fault)
|
|
83
|
-
* <p>
|
|
84
|
+
* <p>For the <code>CreateTrail</code>
|
|
85
|
+
* <code>PutInsightSelectors</code>, <code>UpdateTrail</code>, <code>StartQuery</code>, and <code>StartImport</code> operations, this exception is thrown
|
|
86
|
+
* when the policy on the S3 bucket or KMS key does
|
|
87
|
+
* not have sufficient permissions for the operation.</p>
|
|
88
|
+
* <p>For all other operations, this exception is thrown when the policy for the KMS key does
|
|
84
89
|
* not have sufficient permissions for the operation.</p>
|
|
85
90
|
*
|
|
86
91
|
* @throws {@link InvalidMaxResultsException} (client fault)
|
|
@@ -28,7 +28,7 @@ declare const GetResourcePolicyCommand_base: {
|
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
30
|
* <p>
|
|
31
|
-
* Retrieves the JSON text of the resource-based policy document attached to the CloudTrail channel.
|
|
31
|
+
* Retrieves the JSON text of the resource-based policy document attached to the CloudTrail event data store, dashboard, or channel.
|
|
32
32
|
* </p>
|
|
33
33
|
* @example
|
|
34
34
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -44,6 +44,7 @@ declare const GetResourcePolicyCommand_base: {
|
|
|
44
44
|
* // { // GetResourcePolicyResponse
|
|
45
45
|
* // ResourceArn: "STRING_VALUE",
|
|
46
46
|
* // ResourcePolicy: "STRING_VALUE",
|
|
47
|
+
* // DelegatedAdminResourcePolicy: "STRING_VALUE",
|
|
47
48
|
* // };
|
|
48
49
|
*
|
|
49
50
|
* ```
|
|
@@ -59,9 +60,16 @@ declare const GetResourcePolicyCommand_base: {
|
|
|
59
60
|
*
|
|
60
61
|
* @throws {@link ResourceARNNotValidException} (client fault)
|
|
61
62
|
* <p>
|
|
62
|
-
* This exception is thrown when the provided resource does not exist, or the ARN format of the resource is not valid.
|
|
63
|
-
* <code>arn:aws:cloudtrail:us-east-2:123456789012:channel/MyChannel</code>.
|
|
63
|
+
* This exception is thrown when the provided resource does not exist, or the ARN format of the resource is not valid.
|
|
64
64
|
* </p>
|
|
65
|
+
* <p>The following is the format of an event data store ARN:
|
|
66
|
+
* <code>arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE</code>
|
|
67
|
+
* </p>
|
|
68
|
+
* <p>The following is the format of a dashboard ARN: <code>arn:aws:cloudtrail:us-east-1:123456789012:dashboard/exampleDash</code>
|
|
69
|
+
* </p>
|
|
70
|
+
* <p>The following is the format of a channel ARN:
|
|
71
|
+
* <code>arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890</code>
|
|
72
|
+
* </p>
|
|
65
73
|
*
|
|
66
74
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
67
75
|
* <p>This exception is thrown when the specified resource is not found.</p>
|
|
@@ -75,6 +75,8 @@ declare const GetTrailCommand_base: {
|
|
|
75
75
|
* <p>The following is the format of an event data store ARN:
|
|
76
76
|
* <code>arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE</code>
|
|
77
77
|
* </p>
|
|
78
|
+
* <p>The following is the format of a dashboard ARN: <code>arn:aws:cloudtrail:us-east-1:123456789012:dashboard/exampleDash</code>
|
|
79
|
+
* </p>
|
|
78
80
|
* <p>The following is the format of a channel ARN:
|
|
79
81
|
* <code>arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890</code>
|
|
80
82
|
* </p>
|
|
@@ -78,6 +78,8 @@ declare const GetTrailStatusCommand_base: {
|
|
|
78
78
|
* <p>The following is the format of an event data store ARN:
|
|
79
79
|
* <code>arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE</code>
|
|
80
80
|
* </p>
|
|
81
|
+
* <p>The following is the format of a dashboard ARN: <code>arn:aws:cloudtrail:us-east-1:123456789012:dashboard/exampleDash</code>
|
|
82
|
+
* </p>
|
|
81
83
|
* <p>The following is the format of a channel ARN:
|
|
82
84
|
* <code>arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890</code>
|
|
83
85
|
* </p>
|