@aws-sdk/client-cloudtrail-data 3.296.0 → 3.298.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.
@@ -4,7 +4,6 @@ exports.PutAuditEventsCommand = void 0;
4
4
  const middleware_endpoint_1 = require("@aws-sdk/middleware-endpoint");
5
5
  const middleware_serde_1 = require("@aws-sdk/middleware-serde");
6
6
  const smithy_client_1 = require("@aws-sdk/smithy-client");
7
- const models_0_1 = require("../models/models_0");
8
7
  const Aws_restJson1_1 = require("../protocols/Aws_restJson1");
9
8
  class PutAuditEventsCommand extends smithy_client_1.Command {
10
9
  static getEndpointParameterInstructions() {
@@ -30,8 +29,8 @@ class PutAuditEventsCommand extends smithy_client_1.Command {
30
29
  logger,
31
30
  clientName,
32
31
  commandName,
33
- inputFilterSensitiveLog: models_0_1.PutAuditEventsRequestFilterSensitiveLog,
34
- outputFilterSensitiveLog: models_0_1.PutAuditEventsResponseFilterSensitiveLog,
32
+ inputFilterSensitiveLog: (_) => _,
33
+ outputFilterSensitiveLog: (_) => _,
35
34
  };
36
35
  const { requestHandler } = configuration;
37
36
  return stack.resolve((request) => requestHandler.handle(request.request, options || {}), handlerExecutionContext);
@@ -1,6 +1,6 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.PutAuditEventsResponseFilterSensitiveLog = exports.ResultErrorEntryFilterSensitiveLog = exports.PutAuditEventsRequestFilterSensitiveLog = exports.AuditEventResultEntryFilterSensitiveLog = exports.AuditEventFilterSensitiveLog = exports.UnsupportedOperationException = exports.InvalidChannelARN = exports.DuplicatedAuditEventId = exports.ChannelUnsupportedSchema = exports.ChannelNotFound = exports.ChannelInsufficientPermission = void 0;
3
+ exports.UnsupportedOperationException = exports.InvalidChannelARN = exports.DuplicatedAuditEventId = exports.ChannelUnsupportedSchema = exports.ChannelNotFound = exports.ChannelInsufficientPermission = void 0;
4
4
  const CloudTrailDataServiceException_1 = require("./CloudTrailDataServiceException");
5
5
  class ChannelInsufficientPermission extends CloudTrailDataServiceException_1.CloudTrailDataServiceException {
6
6
  constructor(opts) {
@@ -80,23 +80,3 @@ class UnsupportedOperationException extends CloudTrailDataServiceException_1.Clo
80
80
  }
81
81
  }
82
82
  exports.UnsupportedOperationException = UnsupportedOperationException;
83
- const AuditEventFilterSensitiveLog = (obj) => ({
84
- ...obj,
85
- });
86
- exports.AuditEventFilterSensitiveLog = AuditEventFilterSensitiveLog;
87
- const AuditEventResultEntryFilterSensitiveLog = (obj) => ({
88
- ...obj,
89
- });
90
- exports.AuditEventResultEntryFilterSensitiveLog = AuditEventResultEntryFilterSensitiveLog;
91
- const PutAuditEventsRequestFilterSensitiveLog = (obj) => ({
92
- ...obj,
93
- });
94
- exports.PutAuditEventsRequestFilterSensitiveLog = PutAuditEventsRequestFilterSensitiveLog;
95
- const ResultErrorEntryFilterSensitiveLog = (obj) => ({
96
- ...obj,
97
- });
98
- exports.ResultErrorEntryFilterSensitiveLog = ResultErrorEntryFilterSensitiveLog;
99
- const PutAuditEventsResponseFilterSensitiveLog = (obj) => ({
100
- ...obj,
101
- });
102
- exports.PutAuditEventsResponseFilterSensitiveLog = PutAuditEventsResponseFilterSensitiveLog;
@@ -1,7 +1,6 @@
1
1
  import { getEndpointPlugin } from "@aws-sdk/middleware-endpoint";
2
2
  import { getSerdePlugin } from "@aws-sdk/middleware-serde";
3
3
  import { Command as $Command } from "@aws-sdk/smithy-client";
4
- import { PutAuditEventsRequestFilterSensitiveLog, PutAuditEventsResponseFilterSensitiveLog, } from "../models/models_0";
5
4
  import { deserializeAws_restJson1PutAuditEventsCommand, serializeAws_restJson1PutAuditEventsCommand, } from "../protocols/Aws_restJson1";
6
5
  export class PutAuditEventsCommand extends $Command {
7
6
  static getEndpointParameterInstructions() {
@@ -27,8 +26,8 @@ export class PutAuditEventsCommand extends $Command {
27
26
  logger,
28
27
  clientName,
29
28
  commandName,
30
- inputFilterSensitiveLog: PutAuditEventsRequestFilterSensitiveLog,
31
- outputFilterSensitiveLog: PutAuditEventsResponseFilterSensitiveLog,
29
+ inputFilterSensitiveLog: (_) => _,
30
+ outputFilterSensitiveLog: (_) => _,
32
31
  };
33
32
  const { requestHandler } = configuration;
34
33
  return stack.resolve((request) => requestHandler.handle(request.request, options || {}), handlerExecutionContext);
@@ -71,18 +71,3 @@ export class UnsupportedOperationException extends __BaseException {
71
71
  Object.setPrototypeOf(this, UnsupportedOperationException.prototype);
72
72
  }
73
73
  }
74
- export const AuditEventFilterSensitiveLog = (obj) => ({
75
- ...obj,
76
- });
77
- export const AuditEventResultEntryFilterSensitiveLog = (obj) => ({
78
- ...obj,
79
- });
80
- export const PutAuditEventsRequestFilterSensitiveLog = (obj) => ({
81
- ...obj,
82
- });
83
- export const ResultErrorEntryFilterSensitiveLog = (obj) => ({
84
- ...obj,
85
- });
86
- export const PutAuditEventsResponseFilterSensitiveLog = (obj) => ({
87
- ...obj,
88
- });
@@ -2,6 +2,7 @@ import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types";
2
2
  import { CloudTrailDataClient } from "./CloudTrailDataClient";
3
3
  import { PutAuditEventsCommandInput, PutAuditEventsCommandOutput } from "./commands/PutAuditEventsCommand";
4
4
  /**
5
+ * @public
5
6
  * <p>The CloudTrail Data Service lets you ingest events into CloudTrail from any source in your
6
7
  * hybrid environments, such as in-house or SaaS applications hosted on-premises or in the cloud,
7
8
  * virtual machines, or containers. You can store, access, analyze, troubleshoot and take action on
@@ -11,6 +12,7 @@ import { PutAuditEventsCommandInput, PutAuditEventsCommandOutput } from "./comma
11
12
  */
12
13
  export declare class CloudTrailData extends CloudTrailDataClient {
13
14
  /**
15
+ * @public
14
16
  * <p>Ingests your application events into CloudTrail Lake. A required parameter,
15
17
  * <code>auditEvents</code>, accepts the JSON records (also called
16
18
  * <i>payload</i>) of events that you want CloudTrail to ingest. You
@@ -9,15 +9,24 @@ import { Client as __Client, DefaultsMode as __DefaultsMode, SmithyConfiguration
9
9
  import { BodyLengthCalculator as __BodyLengthCalculator, ChecksumConstructor as __ChecksumConstructor, Credentials as __Credentials, Decoder as __Decoder, Encoder as __Encoder, HashConstructor as __HashConstructor, HttpHandlerOptions as __HttpHandlerOptions, Logger as __Logger, Provider as __Provider, Provider, StreamCollector as __StreamCollector, UrlParser as __UrlParser, UserAgent as __UserAgent } from "@aws-sdk/types";
10
10
  import { PutAuditEventsCommandInput, PutAuditEventsCommandOutput } from "./commands/PutAuditEventsCommand";
11
11
  import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
12
+ /**
13
+ * @public
14
+ */
12
15
  export type ServiceInputTypes = PutAuditEventsCommandInput;
16
+ /**
17
+ * @public
18
+ */
13
19
  export type ServiceOutputTypes = PutAuditEventsCommandOutput;
20
+ /**
21
+ * @public
22
+ */
14
23
  export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
15
24
  /**
16
25
  * The HTTP handler to use. Fetch in browser and Https in Nodejs.
17
26
  */
18
27
  requestHandler?: __HttpHandler;
19
28
  /**
20
- * A constructor for a class implementing the {@link __Checksum} interface
29
+ * A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
21
30
  * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
22
31
  * @internal
23
32
  */
@@ -107,23 +116,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
107
116
  */
108
117
  logger?: __Logger;
109
118
  /**
110
- * The {@link __DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
119
+ * The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
111
120
  */
112
121
  defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
113
122
  }
123
+ /**
124
+ * @public
125
+ */
114
126
  type CloudTrailDataClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
115
127
  /**
116
- * The configuration interface of CloudTrailDataClient class constructor that set the region, credentials and other options.
128
+ * @public
129
+ *
130
+ * The configuration interface of CloudTrailDataClient class constructor that set the region, credentials and other options.
117
131
  */
118
132
  export interface CloudTrailDataClientConfig extends CloudTrailDataClientConfigType {
119
133
  }
134
+ /**
135
+ * @public
136
+ */
120
137
  type CloudTrailDataClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
121
138
  /**
122
- * The resolved configuration interface of CloudTrailDataClient class. This is resolved and normalized from the {@link CloudTrailDataClientConfig | constructor configuration interface}.
139
+ * @public
140
+ *
141
+ * The resolved configuration interface of CloudTrailDataClient class. This is resolved and normalized from the {@link CloudTrailDataClientConfig | constructor configuration interface}.
123
142
  */
124
143
  export interface CloudTrailDataClientResolvedConfig extends CloudTrailDataClientResolvedConfigType {
125
144
  }
126
145
  /**
146
+ * @public
127
147
  * <p>The CloudTrail Data Service lets you ingest events into CloudTrail from any source in your
128
148
  * hybrid environments, such as in-house or SaaS applications hosted on-premises or in the cloud,
129
149
  * virtual machines, or containers. You can store, access, analyze, troubleshoot and take action on
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CloudTrailDataClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudTrailDataClient";
5
5
  import { PutAuditEventsRequest, PutAuditEventsResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link PutAuditEventsCommand}.
8
10
  */
9
11
  export interface PutAuditEventsCommandInput extends PutAuditEventsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link PutAuditEventsCommand}.
13
17
  */
14
18
  export interface PutAuditEventsCommandOutput extends PutAuditEventsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Ingests your application events into CloudTrail Lake. A required parameter,
18
23
  * <code>auditEvents</code>, accepts the JSON records (also called
19
24
  * <i>payload</i>) of events that you want CloudTrail to ingest. You
@@ -29,6 +34,8 @@ export interface PutAuditEventsCommandOutput extends PutAuditEventsResponse, __M
29
34
  * const response = await client.send(command);
30
35
  * ```
31
36
  *
37
+ * @param PutAuditEventsCommandInput - {@link PutAuditEventsCommandInput}
38
+ * @returns {@link PutAuditEventsCommandOutput}
32
39
  * @see {@link PutAuditEventsCommandInput} for command's `input` shape.
33
40
  * @see {@link PutAuditEventsCommandOutput} for command's `response` shape.
34
41
  * @see {@link CloudTrailDataClientResolvedConfig | config} for CloudTrailDataClient's `config` shape.
@@ -57,11 +64,20 @@ export interface PutAuditEventsCommandOutput extends PutAuditEventsResponse, __M
57
64
  export declare class PutAuditEventsCommand extends $Command<PutAuditEventsCommandInput, PutAuditEventsCommandOutput, CloudTrailDataClientResolvedConfig> {
58
65
  readonly input: PutAuditEventsCommandInput;
59
66
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
67
+ /**
68
+ * @public
69
+ */
60
70
  constructor(input: PutAuditEventsCommandInput);
61
71
  /**
62
72
  * @internal
63
73
  */
64
74
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CloudTrailDataClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutAuditEventsCommandInput, PutAuditEventsCommandOutput>;
75
+ /**
76
+ * @internal
77
+ */
65
78
  private serialize;
79
+ /**
80
+ * @internal
81
+ */
66
82
  private deserialize;
67
83
  }
@@ -1,5 +1,7 @@
1
1
  import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@aws-sdk/smithy-client";
2
2
  /**
3
+ * @public
4
+ *
3
5
  * Base exception class for all service exceptions from CloudTrailData service.
4
6
  */
5
7
  export declare class CloudTrailDataServiceException extends __ServiceException {
@@ -1,6 +1,7 @@
1
1
  import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
2
2
  import { CloudTrailDataServiceException as __BaseException } from "./CloudTrailDataServiceException";
3
3
  /**
4
+ * @public
4
5
  * <p>An event from a source outside of Amazon Web Services that you want CloudTrail
5
6
  * to log.</p>
6
7
  */
@@ -24,6 +25,7 @@ export interface AuditEvent {
24
25
  eventDataChecksum?: string;
25
26
  }
26
27
  /**
28
+ * @public
27
29
  * <p>A response that includes successful and failed event results.</p>
28
30
  */
29
31
  export interface AuditEventResultEntry {
@@ -37,6 +39,7 @@ export interface AuditEventResultEntry {
37
39
  eventID: string | undefined;
38
40
  }
39
41
  /**
42
+ * @public
40
43
  * <p>The caller's account ID must be the same as the channel owner's account ID.</p>
41
44
  */
42
45
  export declare class ChannelInsufficientPermission extends __BaseException {
@@ -48,6 +51,7 @@ export declare class ChannelInsufficientPermission extends __BaseException {
48
51
  constructor(opts: __ExceptionOptionType<ChannelInsufficientPermission, __BaseException>);
49
52
  }
50
53
  /**
54
+ * @public
51
55
  * <p>The channel could not be found.</p>
52
56
  */
53
57
  export declare class ChannelNotFound extends __BaseException {
@@ -59,6 +63,7 @@ export declare class ChannelNotFound extends __BaseException {
59
63
  constructor(opts: __ExceptionOptionType<ChannelNotFound, __BaseException>);
60
64
  }
61
65
  /**
66
+ * @public
62
67
  * <p>The schema type of the event is not supported.</p>
63
68
  */
64
69
  export declare class ChannelUnsupportedSchema extends __BaseException {
@@ -70,6 +75,7 @@ export declare class ChannelUnsupportedSchema extends __BaseException {
70
75
  constructor(opts: __ExceptionOptionType<ChannelUnsupportedSchema, __BaseException>);
71
76
  }
72
77
  /**
78
+ * @public
73
79
  * <p>Two or more entries in the request have the same event ID.</p>
74
80
  */
75
81
  export declare class DuplicatedAuditEventId extends __BaseException {
@@ -81,6 +87,7 @@ export declare class DuplicatedAuditEventId extends __BaseException {
81
87
  constructor(opts: __ExceptionOptionType<DuplicatedAuditEventId, __BaseException>);
82
88
  }
83
89
  /**
90
+ * @public
84
91
  * <p>The specified channel ARN is not a valid
85
92
  * channel ARN.</p>
86
93
  */
@@ -92,6 +99,9 @@ export declare class InvalidChannelARN extends __BaseException {
92
99
  */
93
100
  constructor(opts: __ExceptionOptionType<InvalidChannelARN, __BaseException>);
94
101
  }
102
+ /**
103
+ * @public
104
+ */
95
105
  export interface PutAuditEventsRequest {
96
106
  /**
97
107
  * <p>The JSON payload of events that you want to ingest. You can also point to the JSON event
@@ -110,6 +120,7 @@ export interface PutAuditEventsRequest {
110
120
  externalId?: string;
111
121
  }
112
122
  /**
123
+ * @public
113
124
  * <p>Includes the error code and error message for events that could not be ingested by CloudTrail.</p>
114
125
  */
115
126
  export interface ResultErrorEntry {
@@ -128,6 +139,9 @@ export interface ResultErrorEntry {
128
139
  */
129
140
  errorMessage: string | undefined;
130
141
  }
142
+ /**
143
+ * @public
144
+ */
131
145
  export interface PutAuditEventsResponse {
132
146
  /**
133
147
  * <p>Lists events in the provided event payload that were successfully ingested
@@ -142,6 +156,7 @@ export interface PutAuditEventsResponse {
142
156
  failed: ResultErrorEntry[] | undefined;
143
157
  }
144
158
  /**
159
+ * @public
145
160
  * <p>The operation requested is not supported in this region or account.</p>
146
161
  */
147
162
  export declare class UnsupportedOperationException extends __BaseException {
@@ -152,23 +167,3 @@ export declare class UnsupportedOperationException extends __BaseException {
152
167
  */
153
168
  constructor(opts: __ExceptionOptionType<UnsupportedOperationException, __BaseException>);
154
169
  }
155
- /**
156
- * @internal
157
- */
158
- export declare const AuditEventFilterSensitiveLog: (obj: AuditEvent) => any;
159
- /**
160
- * @internal
161
- */
162
- export declare const AuditEventResultEntryFilterSensitiveLog: (obj: AuditEventResultEntry) => any;
163
- /**
164
- * @internal
165
- */
166
- export declare const PutAuditEventsRequestFilterSensitiveLog: (obj: PutAuditEventsRequest) => any;
167
- /**
168
- * @internal
169
- */
170
- export declare const ResultErrorEntryFilterSensitiveLog: (obj: ResultErrorEntry) => any;
171
- /**
172
- * @internal
173
- */
174
- export declare const PutAuditEventsResponseFilterSensitiveLog: (obj: PutAuditEventsResponse) => any;
@@ -61,16 +61,3 @@ export declare class UnsupportedOperationException extends __BaseException {
61
61
  opts: __ExceptionOptionType<UnsupportedOperationException, __BaseException>
62
62
  );
63
63
  }
64
- export declare const AuditEventFilterSensitiveLog: (obj: AuditEvent) => any;
65
- export declare const AuditEventResultEntryFilterSensitiveLog: (
66
- obj: AuditEventResultEntry
67
- ) => any;
68
- export declare const PutAuditEventsRequestFilterSensitiveLog: (
69
- obj: PutAuditEventsRequest
70
- ) => any;
71
- export declare const ResultErrorEntryFilterSensitiveLog: (
72
- obj: ResultErrorEntry
73
- ) => any;
74
- export declare const PutAuditEventsResponseFilterSensitiveLog: (
75
- obj: PutAuditEventsResponse
76
- ) => any;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-cloudtrail-data",
3
3
  "description": "AWS SDK for JavaScript Cloudtrail Data Client for Node.js, Browser and React Native",
4
- "version": "3.296.0",
4
+ "version": "3.298.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -11,6 +11,7 @@
11
11
  "build:types": "tsc -p tsconfig.types.json",
12
12
  "build:types:downlevel": "downlevel-dts dist-types dist-types/ts3.4",
13
13
  "clean": "rimraf ./dist-* && rimraf *.tsbuildinfo",
14
+ "extract:docs": "api-extractor run --local",
14
15
  "generate:client": "node ../../scripts/generate-clients/single-service --solo cloudtrail-data"
15
16
  },
16
17
  "main": "./dist-cjs/index.js",
@@ -20,9 +21,9 @@
20
21
  "dependencies": {
21
22
  "@aws-crypto/sha256-browser": "3.0.0",
22
23
  "@aws-crypto/sha256-js": "3.0.0",
23
- "@aws-sdk/client-sts": "3.296.0",
24
+ "@aws-sdk/client-sts": "3.298.0",
24
25
  "@aws-sdk/config-resolver": "3.296.0",
25
- "@aws-sdk/credential-provider-node": "3.296.0",
26
+ "@aws-sdk/credential-provider-node": "3.298.0",
26
27
  "@aws-sdk/fetch-http-handler": "3.296.0",
27
28
  "@aws-sdk/hash-node": "3.296.0",
28
29
  "@aws-sdk/invalid-dependency": "3.296.0",