@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.
Files changed (62) hide show
  1. package/README.md +48 -0
  2. package/dist-cjs/index.js +346 -44
  3. package/dist-es/CloudTrail.js +12 -0
  4. package/dist-es/commands/CreateDashboardCommand.js +22 -0
  5. package/dist-es/commands/DeleteDashboardCommand.js +22 -0
  6. package/dist-es/commands/GetDashboardCommand.js +22 -0
  7. package/dist-es/commands/ListDashboardsCommand.js +22 -0
  8. package/dist-es/commands/StartDashboardRefreshCommand.js +22 -0
  9. package/dist-es/commands/UpdateDashboardCommand.js +22 -0
  10. package/dist-es/commands/index.js +6 -0
  11. package/dist-es/models/models_0.js +58 -26
  12. package/dist-es/protocols/Aws_json1_1.js +160 -7
  13. package/dist-types/CloudTrail.d.ts +43 -0
  14. package/dist-types/CloudTrailClient.d.ts +8 -2
  15. package/dist-types/commands/AddTagsCommand.d.ts +4 -2
  16. package/dist-types/commands/CancelQueryCommand.d.ts +2 -0
  17. package/dist-types/commands/CreateChannelCommand.d.ts +1 -1
  18. package/dist-types/commands/CreateDashboardCommand.d.ts +189 -0
  19. package/dist-types/commands/CreateEventDataStoreCommand.d.ts +5 -1
  20. package/dist-types/commands/CreateTrailCommand.d.ts +6 -2
  21. package/dist-types/commands/DeleteDashboardCommand.d.ts +83 -0
  22. package/dist-types/commands/DeleteResourcePolicyCommand.d.ts +16 -3
  23. package/dist-types/commands/DeleteTrailCommand.d.ts +2 -0
  24. package/dist-types/commands/DescribeQueryCommand.d.ts +7 -3
  25. package/dist-types/commands/DescribeTrailsCommand.d.ts +2 -0
  26. package/dist-types/commands/GenerateQueryCommand.d.ts +1 -0
  27. package/dist-types/commands/GetDashboardCommand.d.ts +106 -0
  28. package/dist-types/commands/GetEventSelectorsCommand.d.ts +2 -0
  29. package/dist-types/commands/GetInsightSelectorsCommand.d.ts +2 -0
  30. package/dist-types/commands/GetQueryResultsCommand.d.ts +6 -1
  31. package/dist-types/commands/GetResourcePolicyCommand.d.ts +11 -3
  32. package/dist-types/commands/GetTrailCommand.d.ts +2 -0
  33. package/dist-types/commands/GetTrailStatusCommand.d.ts +2 -0
  34. package/dist-types/commands/ListDashboardsCommand.d.ts +85 -0
  35. package/dist-types/commands/ListTagsCommand.d.ts +3 -1
  36. package/dist-types/commands/PutEventSelectorsCommand.d.ts +2 -0
  37. package/dist-types/commands/PutInsightSelectorsCommand.d.ts +7 -1
  38. package/dist-types/commands/PutResourcePolicyCommand.d.ts +17 -21
  39. package/dist-types/commands/RemoveTagsCommand.d.ts +3 -1
  40. package/dist-types/commands/StartDashboardRefreshCommand.d.ts +98 -0
  41. package/dist-types/commands/StartImportCommand.d.ts +5 -1
  42. package/dist-types/commands/StartLoggingCommand.d.ts +2 -0
  43. package/dist-types/commands/StartQueryCommand.d.ts +7 -1
  44. package/dist-types/commands/StopLoggingCommand.d.ts +2 -0
  45. package/dist-types/commands/UpdateDashboardCommand.d.ts +164 -0
  46. package/dist-types/commands/UpdateEventDataStoreCommand.d.ts +5 -1
  47. package/dist-types/commands/UpdateTrailCommand.d.ts +7 -1
  48. package/dist-types/commands/index.d.ts +6 -0
  49. package/dist-types/models/models_0.d.ts +823 -116
  50. package/dist-types/protocols/Aws_json1_1.d.ts +54 -0
  51. package/dist-types/ts3.4/CloudTrail.d.ts +103 -0
  52. package/dist-types/ts3.4/CloudTrailClient.d.ts +36 -0
  53. package/dist-types/ts3.4/commands/CreateDashboardCommand.d.ts +50 -0
  54. package/dist-types/ts3.4/commands/DeleteDashboardCommand.d.ts +50 -0
  55. package/dist-types/ts3.4/commands/GetDashboardCommand.d.ts +47 -0
  56. package/dist-types/ts3.4/commands/ListDashboardsCommand.d.ts +50 -0
  57. package/dist-types/ts3.4/commands/StartDashboardRefreshCommand.d.ts +51 -0
  58. package/dist-types/ts3.4/commands/UpdateDashboardCommand.d.ts +50 -0
  59. package/dist-types/ts3.4/commands/index.d.ts +6 -0
  60. package/dist-types/ts3.4/models/models_0.d.ts +156 -19
  61. package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +72 -0
  62. package/package.json +35 -35
@@ -0,0 +1,85 @@
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 { ListDashboardsRequest, ListDashboardsResponse } from "../models/models_0";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link ListDashboardsCommand}.
14
+ */
15
+ export interface ListDashboardsCommandInput extends ListDashboardsRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link ListDashboardsCommand}.
21
+ */
22
+ export interface ListDashboardsCommandOutput extends ListDashboardsResponse, __MetadataBearer {
23
+ }
24
+ declare const ListDashboardsCommand_base: {
25
+ new (input: ListDashboardsCommandInput): import("@smithy/smithy-client").CommandImpl<ListDashboardsCommandInput, ListDashboardsCommandOutput, CloudTrailClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (...[input]: [] | [ListDashboardsCommandInput]): import("@smithy/smithy-client").CommandImpl<ListDashboardsCommandInput, ListDashboardsCommandOutput, CloudTrailClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>
31
+ * Returns information about all dashboards in the account, in the current Region.
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, ListDashboardsCommand } from "@aws-sdk/client-cloudtrail"; // ES Modules import
37
+ * // const { CloudTrailClient, ListDashboardsCommand } = require("@aws-sdk/client-cloudtrail"); // CommonJS import
38
+ * const client = new CloudTrailClient(config);
39
+ * const input = { // ListDashboardsRequest
40
+ * NamePrefix: "STRING_VALUE",
41
+ * Type: "MANAGED" || "CUSTOM",
42
+ * NextToken: "STRING_VALUE",
43
+ * MaxResults: Number("int"),
44
+ * };
45
+ * const command = new ListDashboardsCommand(input);
46
+ * const response = await client.send(command);
47
+ * // { // ListDashboardsResponse
48
+ * // Dashboards: [ // Dashboards
49
+ * // { // DashboardDetail
50
+ * // DashboardArn: "STRING_VALUE",
51
+ * // Type: "MANAGED" || "CUSTOM",
52
+ * // },
53
+ * // ],
54
+ * // NextToken: "STRING_VALUE",
55
+ * // };
56
+ *
57
+ * ```
58
+ *
59
+ * @param ListDashboardsCommandInput - {@link ListDashboardsCommandInput}
60
+ * @returns {@link ListDashboardsCommandOutput}
61
+ * @see {@link ListDashboardsCommandInput} for command's `input` shape.
62
+ * @see {@link ListDashboardsCommandOutput} for command's `response` shape.
63
+ * @see {@link CloudTrailClientResolvedConfig | config} for CloudTrailClient's `config` shape.
64
+ *
65
+ * @throws {@link UnsupportedOperationException} (client fault)
66
+ * <p>This exception is thrown when the requested operation is not supported.</p>
67
+ *
68
+ * @throws {@link CloudTrailServiceException}
69
+ * <p>Base exception class for all service exceptions from CloudTrail service.</p>
70
+ *
71
+ * @public
72
+ */
73
+ export declare class ListDashboardsCommand extends ListDashboardsCommand_base {
74
+ /** @internal type navigation helper, not in runtime. */
75
+ protected static __types: {
76
+ api: {
77
+ input: ListDashboardsRequest;
78
+ output: ListDashboardsResponse;
79
+ };
80
+ sdk: {
81
+ input: ListDashboardsCommandInput;
82
+ output: ListDashboardsCommandOutput;
83
+ };
84
+ };
85
+ }
@@ -27,7 +27,7 @@ declare const ListTagsCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Lists the tags for the specified trails, event data stores, or channels in the current Region.</p>
30
+ * <p>Lists the tags for the specified trails, event data stores, dashboards, or channels in the current Region.</p>
31
31
  * @example
32
32
  * Use a bare-bones client and the command you need to make an API call.
33
33
  * ```javascript
@@ -76,6 +76,8 @@ declare const ListTagsCommand_base: {
76
76
  * <p>The following is the format of an event data store ARN:
77
77
  * <code>arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE</code>
78
78
  * </p>
79
+ * <p>The following is the format of a dashboard ARN: <code>arn:aws:cloudtrail:us-east-1:123456789012:dashboard/exampleDash</code>
80
+ * </p>
79
81
  * <p>The following is the format of a channel ARN:
80
82
  * <code>arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890</code>
81
83
  * </p>
@@ -208,6 +208,8 @@ declare const PutEventSelectorsCommand_base: {
208
208
  * <p>The following is the format of an event data store ARN:
209
209
  * <code>arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE</code>
210
210
  * </p>
211
+ * <p>The following is the format of a dashboard ARN: <code>arn:aws:cloudtrail:us-east-1:123456789012:dashboard/exampleDash</code>
212
+ * </p>
211
213
  * <p>The following is the format of a channel ARN:
212
214
  * <code>arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890</code>
213
215
  * </p>
@@ -87,12 +87,18 @@ declare const PutInsightSelectorsCommand_base: {
87
87
  * <p>The following is the format of an event data store ARN:
88
88
  * <code>arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE</code>
89
89
  * </p>
90
+ * <p>The following is the format of a dashboard ARN: <code>arn:aws:cloudtrail:us-east-1:123456789012:dashboard/exampleDash</code>
91
+ * </p>
90
92
  * <p>The following is the format of a channel ARN:
91
93
  * <code>arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890</code>
92
94
  * </p>
93
95
  *
94
96
  * @throws {@link InsufficientEncryptionPolicyException} (client fault)
95
- * <p>This exception is thrown when the policy on the S3 bucket or KMS key does
97
+ * <p>For the <code>CreateTrail</code>
98
+ * <code>PutInsightSelectors</code>, <code>UpdateTrail</code>, <code>StartQuery</code>, and <code>StartImport</code> operations, this exception is thrown
99
+ * when the policy on the S3 bucket or KMS key does
100
+ * not have sufficient permissions for the operation.</p>
101
+ * <p>For all other operations, this exception is thrown when the policy for the KMS key does
96
102
  * not have sufficient permissions for the operation.</p>
97
103
  *
98
104
  * @throws {@link InsufficientS3BucketPolicyException} (client fault)
@@ -28,7 +28,7 @@ declare const PutResourcePolicyCommand_base: {
28
28
  };
29
29
  /**
30
30
  * <p>
31
- * Attaches a resource-based permission policy to a CloudTrail channel that is used for an integration with an event source outside of Amazon Web Services. For more information about resource-based policies, see
31
+ * Attaches a resource-based permission policy to a CloudTrail event data store, dashboard, or channel. For more information about resource-based policies, see
32
32
  * <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/security_iam_resource-based-policy-examples.html">CloudTrail resource-based policy examples</a>
33
33
  * in the <i>CloudTrail User Guide</i>.
34
34
  * </p>
@@ -47,6 +47,7 @@ declare const PutResourcePolicyCommand_base: {
47
47
  * // { // PutResourcePolicyResponse
48
48
  * // ResourceArn: "STRING_VALUE",
49
49
  * // ResourcePolicy: "STRING_VALUE",
50
+ * // DelegatedAdminResourcePolicy: "STRING_VALUE",
50
51
  * // };
51
52
  *
52
53
  * ```
@@ -57,14 +58,27 @@ declare const PutResourcePolicyCommand_base: {
57
58
  * @see {@link PutResourcePolicyCommandOutput} for command's `response` shape.
58
59
  * @see {@link CloudTrailClientResolvedConfig | config} for CloudTrailClient's `config` shape.
59
60
  *
61
+ * @throws {@link ConflictException} (client fault)
62
+ * <p>This exception is thrown when the specified resource is not ready for an operation. This
63
+ * can occur when you try to run an operation on a resource before CloudTrail has time
64
+ * 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
65
+ * operation again.</p>
66
+ *
60
67
  * @throws {@link OperationNotPermittedException} (client fault)
61
68
  * <p>This exception is thrown when the requested operation is not permitted.</p>
62
69
  *
63
70
  * @throws {@link ResourceARNNotValidException} (client fault)
64
71
  * <p>
65
- * This exception is thrown when the provided resource does not exist, or the ARN format of the resource is not valid. The following is the valid format for a resource ARN:
66
- * <code>arn:aws:cloudtrail:us-east-2:123456789012:channel/MyChannel</code>.
72
+ * This exception is thrown when the provided resource does not exist, or the ARN format of the resource is not valid.
67
73
  * </p>
74
+ * <p>The following is the format of an event data store ARN:
75
+ * <code>arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE</code>
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>
79
+ * <p>The following is the format of a channel ARN:
80
+ * <code>arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890</code>
81
+ * </p>
68
82
  *
69
83
  * @throws {@link ResourceNotFoundException} (client fault)
70
84
  * <p>This exception is thrown when the specified resource is not found.</p>
@@ -73,24 +87,6 @@ declare const PutResourcePolicyCommand_base: {
73
87
  * <p>
74
88
  * This exception is thrown when the resouce-based policy has syntax errors, or contains a principal that is not valid.
75
89
  * </p>
76
- * <p>The following are requirements for the resource policy:</p>
77
- * <ul>
78
- * <li>
79
- * <p>
80
- * Contains only one action: cloudtrail-data:PutAuditEvents
81
- * </p>
82
- * </li>
83
- * <li>
84
- * <p>
85
- * Contains at least one statement. The policy can have a maximum of 20 statements.
86
- * </p>
87
- * </li>
88
- * <li>
89
- * <p>
90
- * Each statement contains at least one principal. A statement can have a maximum of 50 principals.
91
- * </p>
92
- * </li>
93
- * </ul>
94
90
  *
95
91
  * @throws {@link ResourceTypeNotSupportedException} (client fault)
96
92
  * <p>This exception is thrown when the specified resource type is not supported by CloudTrail.</p>
@@ -27,7 +27,7 @@ declare const RemoveTagsCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Removes the specified tags from a trail, event data store, or channel.</p>
30
+ * <p>Removes the specified tags from a trail, event data store, dashboard, or channel.</p>
31
31
  * @example
32
32
  * Use a bare-bones client and the command you need to make an API call.
33
33
  * ```javascript
@@ -69,6 +69,8 @@ declare const RemoveTagsCommand_base: {
69
69
  * <p>The following is the format of an event data store ARN:
70
70
  * <code>arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE</code>
71
71
  * </p>
72
+ * <p>The following is the format of a dashboard ARN: <code>arn:aws:cloudtrail:us-east-1:123456789012:dashboard/exampleDash</code>
73
+ * </p>
72
74
  * <p>The following is the format of a channel ARN:
73
75
  * <code>arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890</code>
74
76
  * </p>
@@ -0,0 +1,98 @@
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 { StartDashboardRefreshRequest, StartDashboardRefreshResponse } from "../models/models_0";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link StartDashboardRefreshCommand}.
14
+ */
15
+ export interface StartDashboardRefreshCommandInput extends StartDashboardRefreshRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link StartDashboardRefreshCommand}.
21
+ */
22
+ export interface StartDashboardRefreshCommandOutput extends StartDashboardRefreshResponse, __MetadataBearer {
23
+ }
24
+ declare const StartDashboardRefreshCommand_base: {
25
+ new (input: StartDashboardRefreshCommandInput): import("@smithy/smithy-client").CommandImpl<StartDashboardRefreshCommandInput, StartDashboardRefreshCommandOutput, CloudTrailClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: StartDashboardRefreshCommandInput): import("@smithy/smithy-client").CommandImpl<StartDashboardRefreshCommandInput, StartDashboardRefreshCommandOutput, CloudTrailClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>
31
+ * Starts a refresh of the specified dashboard.
32
+ * </p>
33
+ * <p>
34
+ * Each time a dashboard is refreshed, CloudTrail runs queries to populate the dashboard's widgets. 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,
35
+ * 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>.
36
+ * </p>
37
+ * @example
38
+ * Use a bare-bones client and the command you need to make an API call.
39
+ * ```javascript
40
+ * import { CloudTrailClient, StartDashboardRefreshCommand } from "@aws-sdk/client-cloudtrail"; // ES Modules import
41
+ * // const { CloudTrailClient, StartDashboardRefreshCommand } = require("@aws-sdk/client-cloudtrail"); // CommonJS import
42
+ * const client = new CloudTrailClient(config);
43
+ * const input = { // StartDashboardRefreshRequest
44
+ * DashboardId: "STRING_VALUE", // required
45
+ * QueryParameterValues: { // QueryParameterValues
46
+ * "<keys>": "STRING_VALUE",
47
+ * },
48
+ * };
49
+ * const command = new StartDashboardRefreshCommand(input);
50
+ * const response = await client.send(command);
51
+ * // { // StartDashboardRefreshResponse
52
+ * // RefreshId: "STRING_VALUE",
53
+ * // };
54
+ *
55
+ * ```
56
+ *
57
+ * @param StartDashboardRefreshCommandInput - {@link StartDashboardRefreshCommandInput}
58
+ * @returns {@link StartDashboardRefreshCommandOutput}
59
+ * @see {@link StartDashboardRefreshCommandInput} for command's `input` shape.
60
+ * @see {@link StartDashboardRefreshCommandOutput} for command's `response` shape.
61
+ * @see {@link CloudTrailClientResolvedConfig | config} for CloudTrailClient's `config` shape.
62
+ *
63
+ * @throws {@link EventDataStoreNotFoundException} (client fault)
64
+ * <p>The specified event data store was not found.</p>
65
+ *
66
+ * @throws {@link InactiveEventDataStoreException} (client fault)
67
+ * <p>The event data store is inactive.</p>
68
+ *
69
+ * @throws {@link ResourceNotFoundException} (client fault)
70
+ * <p>This exception is thrown when the specified resource is not found.</p>
71
+ *
72
+ * @throws {@link ServiceQuotaExceededException} (client fault)
73
+ * <p>
74
+ * 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>
75
+ * in the <i>Amazon Web Services General Reference</i>.
76
+ * </p>
77
+ *
78
+ * @throws {@link UnsupportedOperationException} (client fault)
79
+ * <p>This exception is thrown when the requested operation is not supported.</p>
80
+ *
81
+ * @throws {@link CloudTrailServiceException}
82
+ * <p>Base exception class for all service exceptions from CloudTrail service.</p>
83
+ *
84
+ * @public
85
+ */
86
+ export declare class StartDashboardRefreshCommand extends StartDashboardRefreshCommand_base {
87
+ /** @internal type navigation helper, not in runtime. */
88
+ protected static __types: {
89
+ api: {
90
+ input: StartDashboardRefreshRequest;
91
+ output: StartDashboardRefreshResponse;
92
+ };
93
+ sdk: {
94
+ input: StartDashboardRefreshCommandInput;
95
+ output: StartDashboardRefreshCommandOutput;
96
+ };
97
+ };
98
+ }
@@ -112,7 +112,11 @@ declare const StartImportCommand_base: {
112
112
  * <p>The event data store is inactive.</p>
113
113
  *
114
114
  * @throws {@link InsufficientEncryptionPolicyException} (client fault)
115
- * <p>This exception is thrown when the policy on the S3 bucket or KMS key does
115
+ * <p>For the <code>CreateTrail</code>
116
+ * <code>PutInsightSelectors</code>, <code>UpdateTrail</code>, <code>StartQuery</code>, and <code>StartImport</code> operations, this exception is thrown
117
+ * when the policy on the S3 bucket or KMS key does
118
+ * not have sufficient permissions for the operation.</p>
119
+ * <p>For all other operations, this exception is thrown when the policy for the KMS key does
116
120
  * not have sufficient permissions for the operation.</p>
117
121
  *
118
122
  * @throws {@link InvalidEventDataStoreCategoryException} (client fault)
@@ -59,6 +59,8 @@ declare const StartLoggingCommand_base: {
59
59
  * <p>The following is the format of an event data store ARN:
60
60
  * <code>arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE</code>
61
61
  * </p>
62
+ * <p>The following is the format of a dashboard ARN: <code>arn:aws:cloudtrail:us-east-1:123456789012:dashboard/exampleDash</code>
63
+ * </p>
62
64
  * <p>The following is the format of a channel ARN:
63
65
  * <code>arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890</code>
64
66
  * </p>
@@ -47,11 +47,13 @@ declare const StartQueryCommand_base: {
47
47
  * QueryParameters: [ // QueryParameters
48
48
  * "STRING_VALUE",
49
49
  * ],
50
+ * EventDataStoreOwnerAccountId: "STRING_VALUE",
50
51
  * };
51
52
  * const command = new StartQueryCommand(input);
52
53
  * const response = await client.send(command);
53
54
  * // { // StartQueryResponse
54
55
  * // QueryId: "STRING_VALUE",
56
+ * // EventDataStoreOwnerAccountId: "STRING_VALUE",
55
57
  * // };
56
58
  *
57
59
  * ```
@@ -73,7 +75,11 @@ declare const StartQueryCommand_base: {
73
75
  * <p>The event data store is inactive.</p>
74
76
  *
75
77
  * @throws {@link InsufficientEncryptionPolicyException} (client fault)
76
- * <p>This exception is thrown when the policy on the S3 bucket or KMS key does
78
+ * <p>For the <code>CreateTrail</code>
79
+ * <code>PutInsightSelectors</code>, <code>UpdateTrail</code>, <code>StartQuery</code>, and <code>StartImport</code> operations, this exception is thrown
80
+ * when the policy on the S3 bucket or KMS key does
81
+ * not have sufficient permissions for the operation.</p>
82
+ * <p>For all other operations, this exception is thrown when the policy for the KMS key does
77
83
  * not have sufficient permissions for the operation.</p>
78
84
  *
79
85
  * @throws {@link InsufficientS3BucketPolicyException} (client fault)
@@ -62,6 +62,8 @@ declare const StopLoggingCommand_base: {
62
62
  * <p>The following is the format of an event data store ARN:
63
63
  * <code>arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE</code>
64
64
  * </p>
65
+ * <p>The following is the format of a dashboard ARN: <code>arn:aws:cloudtrail:us-east-1:123456789012:dashboard/exampleDash</code>
66
+ * </p>
65
67
  * <p>The following is the format of a channel ARN:
66
68
  * <code>arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890</code>
67
69
  * </p>
@@ -0,0 +1,164 @@
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 { UpdateDashboardRequest, UpdateDashboardResponse } from "../models/models_0";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link UpdateDashboardCommand}.
14
+ */
15
+ export interface UpdateDashboardCommandInput extends UpdateDashboardRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link UpdateDashboardCommand}.
21
+ */
22
+ export interface UpdateDashboardCommandOutput extends UpdateDashboardResponse, __MetadataBearer {
23
+ }
24
+ declare const UpdateDashboardCommand_base: {
25
+ new (input: UpdateDashboardCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateDashboardCommandInput, UpdateDashboardCommandOutput, CloudTrailClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: UpdateDashboardCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateDashboardCommandInput, UpdateDashboardCommandOutput, CloudTrailClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>
31
+ * Updates the specified dashboard.
32
+ * </p>
33
+ * <p>
34
+ * 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,
35
+ * 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">
36
+ * Resource-based policy example for a dashboard</a> in the <i>CloudTrail User Guide</i>.
37
+ * </p>
38
+ * <p>
39
+ * 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,
40
+ * 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>.
41
+ * </p>
42
+ * @example
43
+ * Use a bare-bones client and the command you need to make an API call.
44
+ * ```javascript
45
+ * import { CloudTrailClient, UpdateDashboardCommand } from "@aws-sdk/client-cloudtrail"; // ES Modules import
46
+ * // const { CloudTrailClient, UpdateDashboardCommand } = require("@aws-sdk/client-cloudtrail"); // CommonJS import
47
+ * const client = new CloudTrailClient(config);
48
+ * const input = { // UpdateDashboardRequest
49
+ * DashboardId: "STRING_VALUE", // required
50
+ * Widgets: [ // RequestWidgetList
51
+ * { // RequestWidget
52
+ * QueryStatement: "STRING_VALUE", // required
53
+ * QueryParameters: [ // QueryParameters
54
+ * "STRING_VALUE",
55
+ * ],
56
+ * ViewProperties: { // ViewPropertiesMap // required
57
+ * "<keys>": "STRING_VALUE",
58
+ * },
59
+ * },
60
+ * ],
61
+ * RefreshSchedule: { // RefreshSchedule
62
+ * Frequency: { // RefreshScheduleFrequency
63
+ * Unit: "HOURS" || "DAYS",
64
+ * Value: Number("int"),
65
+ * },
66
+ * Status: "ENABLED" || "DISABLED",
67
+ * TimeOfDay: "STRING_VALUE",
68
+ * },
69
+ * TerminationProtectionEnabled: true || false,
70
+ * };
71
+ * const command = new UpdateDashboardCommand(input);
72
+ * const response = await client.send(command);
73
+ * // { // UpdateDashboardResponse
74
+ * // DashboardArn: "STRING_VALUE",
75
+ * // Name: "STRING_VALUE",
76
+ * // Type: "MANAGED" || "CUSTOM",
77
+ * // Widgets: [ // WidgetList
78
+ * // { // Widget
79
+ * // QueryAlias: "STRING_VALUE",
80
+ * // QueryStatement: "STRING_VALUE",
81
+ * // QueryParameters: [ // QueryParameters
82
+ * // "STRING_VALUE",
83
+ * // ],
84
+ * // ViewProperties: { // ViewPropertiesMap
85
+ * // "<keys>": "STRING_VALUE",
86
+ * // },
87
+ * // },
88
+ * // ],
89
+ * // RefreshSchedule: { // RefreshSchedule
90
+ * // Frequency: { // RefreshScheduleFrequency
91
+ * // Unit: "HOURS" || "DAYS",
92
+ * // Value: Number("int"),
93
+ * // },
94
+ * // Status: "ENABLED" || "DISABLED",
95
+ * // TimeOfDay: "STRING_VALUE",
96
+ * // },
97
+ * // TerminationProtectionEnabled: true || false,
98
+ * // CreatedTimestamp: new Date("TIMESTAMP"),
99
+ * // UpdatedTimestamp: new Date("TIMESTAMP"),
100
+ * // };
101
+ *
102
+ * ```
103
+ *
104
+ * @param UpdateDashboardCommandInput - {@link UpdateDashboardCommandInput}
105
+ * @returns {@link UpdateDashboardCommandOutput}
106
+ * @see {@link UpdateDashboardCommandInput} for command's `input` shape.
107
+ * @see {@link UpdateDashboardCommandOutput} for command's `response` shape.
108
+ * @see {@link CloudTrailClientResolvedConfig | config} for CloudTrailClient's `config` shape.
109
+ *
110
+ * @throws {@link ConflictException} (client fault)
111
+ * <p>This exception is thrown when the specified resource is not ready for an operation. This
112
+ * can occur when you try to run an operation on a resource before CloudTrail has time
113
+ * 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
114
+ * operation again.</p>
115
+ *
116
+ * @throws {@link EventDataStoreNotFoundException} (client fault)
117
+ * <p>The specified event data store was not found.</p>
118
+ *
119
+ * @throws {@link InactiveEventDataStoreException} (client fault)
120
+ * <p>The event data store is inactive.</p>
121
+ *
122
+ * @throws {@link InsufficientEncryptionPolicyException} (client fault)
123
+ * <p>For the <code>CreateTrail</code>
124
+ * <code>PutInsightSelectors</code>, <code>UpdateTrail</code>, <code>StartQuery</code>, and <code>StartImport</code> operations, this exception is thrown
125
+ * when the policy on the S3 bucket or KMS key does
126
+ * not have sufficient permissions for the operation.</p>
127
+ * <p>For all other operations, this exception is thrown when the policy for the KMS key does
128
+ * not have sufficient permissions for the operation.</p>
129
+ *
130
+ * @throws {@link InvalidQueryStatementException} (client fault)
131
+ * <p>The query that was submitted has validation errors, or uses incorrect syntax or
132
+ * 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
133
+ * Guide</i>.</p>
134
+ *
135
+ * @throws {@link ResourceNotFoundException} (client fault)
136
+ * <p>This exception is thrown when the specified resource is not found.</p>
137
+ *
138
+ * @throws {@link ServiceQuotaExceededException} (client fault)
139
+ * <p>
140
+ * 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>
141
+ * in the <i>Amazon Web Services General Reference</i>.
142
+ * </p>
143
+ *
144
+ * @throws {@link UnsupportedOperationException} (client fault)
145
+ * <p>This exception is thrown when the requested operation is not supported.</p>
146
+ *
147
+ * @throws {@link CloudTrailServiceException}
148
+ * <p>Base exception class for all service exceptions from CloudTrail service.</p>
149
+ *
150
+ * @public
151
+ */
152
+ export declare class UpdateDashboardCommand extends UpdateDashboardCommand_base {
153
+ /** @internal type navigation helper, not in runtime. */
154
+ protected static __types: {
155
+ api: {
156
+ input: UpdateDashboardRequest;
157
+ output: UpdateDashboardResponse;
158
+ };
159
+ sdk: {
160
+ input: UpdateDashboardCommandInput;
161
+ output: UpdateDashboardCommandOutput;
162
+ };
163
+ };
164
+ }
@@ -157,7 +157,11 @@ declare const UpdateEventDataStoreCommand_base: {
157
157
  * organization resource in a required service.</p>
158
158
  *
159
159
  * @throws {@link InsufficientEncryptionPolicyException} (client fault)
160
- * <p>This exception is thrown when the policy on the S3 bucket or KMS key does
160
+ * <p>For the <code>CreateTrail</code>
161
+ * <code>PutInsightSelectors</code>, <code>UpdateTrail</code>, <code>StartQuery</code>, and <code>StartImport</code> operations, this exception is thrown
162
+ * when the policy on the S3 bucket or KMS key does
163
+ * not have sufficient permissions for the operation.</p>
164
+ * <p>For all other operations, this exception is thrown when the policy for the KMS key does
161
165
  * not have sufficient permissions for the operation.</p>
162
166
  *
163
167
  * @throws {@link InvalidEventSelectorsException} (client fault)
@@ -88,6 +88,8 @@ declare const UpdateTrailCommand_base: {
88
88
  * <p>The following is the format of an event data store ARN:
89
89
  * <code>arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE</code>
90
90
  * </p>
91
+ * <p>The following is the format of a dashboard ARN: <code>arn:aws:cloudtrail:us-east-1:123456789012:dashboard/exampleDash</code>
92
+ * </p>
91
93
  * <p>The following is the format of a channel ARN:
92
94
  * <code>arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890</code>
93
95
  * </p>
@@ -112,7 +114,11 @@ declare const UpdateTrailCommand_base: {
112
114
  * organization resource in a required service.</p>
113
115
  *
114
116
  * @throws {@link InsufficientEncryptionPolicyException} (client fault)
115
- * <p>This exception is thrown when the policy on the S3 bucket or KMS key does
117
+ * <p>For the <code>CreateTrail</code>
118
+ * <code>PutInsightSelectors</code>, <code>UpdateTrail</code>, <code>StartQuery</code>, and <code>StartImport</code> operations, this exception is thrown
119
+ * when the policy on the S3 bucket or KMS key does
120
+ * not have sufficient permissions for the operation.</p>
121
+ * <p>For all other operations, this exception is thrown when the policy for the KMS key does
116
122
  * not have sufficient permissions for the operation.</p>
117
123
  *
118
124
  * @throws {@link InsufficientS3BucketPolicyException} (client fault)
@@ -1,9 +1,11 @@
1
1
  export * from "./AddTagsCommand";
2
2
  export * from "./CancelQueryCommand";
3
3
  export * from "./CreateChannelCommand";
4
+ export * from "./CreateDashboardCommand";
4
5
  export * from "./CreateEventDataStoreCommand";
5
6
  export * from "./CreateTrailCommand";
6
7
  export * from "./DeleteChannelCommand";
8
+ export * from "./DeleteDashboardCommand";
7
9
  export * from "./DeleteEventDataStoreCommand";
8
10
  export * from "./DeleteResourcePolicyCommand";
9
11
  export * from "./DeleteTrailCommand";
@@ -14,6 +16,7 @@ export * from "./DisableFederationCommand";
14
16
  export * from "./EnableFederationCommand";
15
17
  export * from "./GenerateQueryCommand";
16
18
  export * from "./GetChannelCommand";
19
+ export * from "./GetDashboardCommand";
17
20
  export * from "./GetEventDataStoreCommand";
18
21
  export * from "./GetEventSelectorsCommand";
19
22
  export * from "./GetImportCommand";
@@ -23,6 +26,7 @@ export * from "./GetResourcePolicyCommand";
23
26
  export * from "./GetTrailCommand";
24
27
  export * from "./GetTrailStatusCommand";
25
28
  export * from "./ListChannelsCommand";
29
+ export * from "./ListDashboardsCommand";
26
30
  export * from "./ListEventDataStoresCommand";
27
31
  export * from "./ListImportFailuresCommand";
28
32
  export * from "./ListImportsCommand";
@@ -38,6 +42,7 @@ export * from "./PutResourcePolicyCommand";
38
42
  export * from "./RegisterOrganizationDelegatedAdminCommand";
39
43
  export * from "./RemoveTagsCommand";
40
44
  export * from "./RestoreEventDataStoreCommand";
45
+ export * from "./StartDashboardRefreshCommand";
41
46
  export * from "./StartEventDataStoreIngestionCommand";
42
47
  export * from "./StartImportCommand";
43
48
  export * from "./StartLoggingCommand";
@@ -46,5 +51,6 @@ export * from "./StopEventDataStoreIngestionCommand";
46
51
  export * from "./StopImportCommand";
47
52
  export * from "./StopLoggingCommand";
48
53
  export * from "./UpdateChannelCommand";
54
+ export * from "./UpdateDashboardCommand";
49
55
  export * from "./UpdateEventDataStoreCommand";
50
56
  export * from "./UpdateTrailCommand";