@aws-sdk/client-firehose 3.36.0 → 3.39.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 (51) hide show
  1. package/CHANGELOG.md +42 -0
  2. package/dist-cjs/Firehose.js +0 -6
  3. package/dist-cjs/FirehoseClient.js +0 -11
  4. package/dist-cjs/commands/CreateDeliveryStreamCommand.js +0 -92
  5. package/dist-cjs/commands/DeleteDeliveryStreamCommand.js +0 -33
  6. package/dist-cjs/commands/DescribeDeliveryStreamCommand.js +0 -30
  7. package/dist-cjs/commands/ListDeliveryStreamsCommand.js +0 -31
  8. package/dist-cjs/commands/ListTagsForDeliveryStreamCommand.js +0 -25
  9. package/dist-cjs/commands/PutRecordBatchCommand.js +0 -74
  10. package/dist-cjs/commands/PutRecordCommand.js +0 -55
  11. package/dist-cjs/commands/StartDeliveryStreamEncryptionCommand.js +0 -59
  12. package/dist-cjs/commands/StopDeliveryStreamEncryptionCommand.js +0 -43
  13. package/dist-cjs/commands/TagDeliveryStreamCommand.js +0 -32
  14. package/dist-cjs/commands/UntagDeliveryStreamCommand.js +0 -27
  15. package/dist-cjs/commands/UpdateDestinationCommand.js +0 -47
  16. package/dist-cjs/commands/index.js +15 -0
  17. package/dist-cjs/endpoints.js +6 -1
  18. package/dist-cjs/index.js +3 -14
  19. package/dist-cjs/models/models_0.js +0 -291
  20. package/dist-cjs/protocols/Aws_json1_1.js +0 -5
  21. package/dist-cjs/runtimeConfig.browser.js +1 -5
  22. package/dist-cjs/runtimeConfig.js +1 -5
  23. package/dist-cjs/runtimeConfig.native.js +0 -3
  24. package/dist-cjs/runtimeConfig.shared.js +0 -3
  25. package/dist-es/commands/index.js +12 -0
  26. package/dist-es/endpoints.js +6 -1
  27. package/dist-es/index.js +3 -14
  28. package/dist-types/commands/index.d.ts +12 -0
  29. package/dist-types/index.d.ts +3 -14
  30. package/dist-types/ts3.4/Firehose.d.ts +13 -302
  31. package/dist-types/ts3.4/FirehoseClient.d.ts +24 -92
  32. package/dist-types/ts3.4/commands/CreateDeliveryStreamCommand.d.ts +2 -88
  33. package/dist-types/ts3.4/commands/DeleteDeliveryStreamCommand.d.ts +2 -29
  34. package/dist-types/ts3.4/commands/DescribeDeliveryStreamCommand.d.ts +2 -26
  35. package/dist-types/ts3.4/commands/ListDeliveryStreamsCommand.d.ts +2 -27
  36. package/dist-types/ts3.4/commands/ListTagsForDeliveryStreamCommand.d.ts +2 -21
  37. package/dist-types/ts3.4/commands/PutRecordBatchCommand.d.ts +2 -70
  38. package/dist-types/ts3.4/commands/PutRecordCommand.d.ts +2 -51
  39. package/dist-types/ts3.4/commands/StartDeliveryStreamEncryptionCommand.d.ts +2 -55
  40. package/dist-types/ts3.4/commands/StopDeliveryStreamEncryptionCommand.d.ts +2 -39
  41. package/dist-types/ts3.4/commands/TagDeliveryStreamCommand.d.ts +2 -28
  42. package/dist-types/ts3.4/commands/UntagDeliveryStreamCommand.d.ts +2 -23
  43. package/dist-types/ts3.4/commands/UpdateDestinationCommand.d.ts +2 -43
  44. package/dist-types/ts3.4/commands/index.d.ts +12 -0
  45. package/dist-types/ts3.4/index.d.ts +3 -14
  46. package/dist-types/ts3.4/models/models_0.d.ts +540 -2345
  47. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +1 -3
  48. package/dist-types/ts3.4/runtimeConfig.d.ts +1 -3
  49. package/dist-types/ts3.4/runtimeConfig.native.d.ts +1 -3
  50. package/dist-types/ts3.4/runtimeConfig.shared.d.ts +1 -3
  51. package/package.json +32 -32
package/CHANGELOG.md CHANGED
@@ -3,6 +3,48 @@
3
3
  All notable changes to this project will be documented in this file.
4
4
  See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
5
5
 
6
+ # [3.39.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.38.0...v3.39.0) (2021-10-29)
7
+
8
+ **Note:** Version bump only for package @aws-sdk/client-firehose
9
+
10
+
11
+
12
+
13
+
14
+ # [3.38.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.37.0...v3.38.0) (2021-10-22)
15
+
16
+
17
+ ### Features
18
+
19
+ * **client-documentation-generator:** rename package ([#2916](https://github.com/aws/aws-sdk-js-v3/issues/2916)) ([1a80bfd](https://github.com/aws/aws-sdk-js-v3/commit/1a80bfd2dfc583001ddb4a21b6432eaaad699aa7))
20
+ * **clients:** export folder from index.ts ([#2912](https://github.com/aws/aws-sdk-js-v3/issues/2912)) ([183b46d](https://github.com/aws/aws-sdk-js-v3/commit/183b46dde7f5613128038bf1c076f3c0b693203b))
21
+
22
+
23
+
24
+
25
+
26
+ # [3.37.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.36.1...v3.37.0) (2021-10-15)
27
+
28
+
29
+ ### Features
30
+
31
+ * **clients:** update clients as of 10/15/2021 ([#2902](https://github.com/aws/aws-sdk-js-v3/issues/2902)) ([2730b54](https://github.com/aws/aws-sdk-js-v3/commit/2730b5424377944a5a2ad5e1ad7d3ca4135dae1c))
32
+
33
+
34
+
35
+
36
+
37
+ ## [3.36.1](https://github.com/aws/aws-sdk-js-v3/compare/v3.36.0...v3.36.1) (2021-10-12)
38
+
39
+
40
+ ### Bug Fixes
41
+
42
+ * **clients:** emitDeclarationOnly in tsconfig.types.json ([#2893](https://github.com/aws/aws-sdk-js-v3/issues/2893)) ([6dc3d56](https://github.com/aws/aws-sdk-js-v3/commit/6dc3d56c20809c90cbdc4dd48627eeebc64af99d))
43
+
44
+
45
+
46
+
47
+
6
48
  # [3.36.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.35.0...v3.36.0) (2021-10-08)
7
49
 
8
50
 
@@ -14,12 +14,6 @@ const TagDeliveryStreamCommand_1 = require("./commands/TagDeliveryStreamCommand"
14
14
  const UntagDeliveryStreamCommand_1 = require("./commands/UntagDeliveryStreamCommand");
15
15
  const UpdateDestinationCommand_1 = require("./commands/UpdateDestinationCommand");
16
16
  const FirehoseClient_1 = require("./FirehoseClient");
17
- /**
18
- * <fullname>Amazon Kinesis Data Firehose API Reference</fullname>
19
- * <p>Amazon Kinesis Data Firehose is a fully managed service that delivers real-time
20
- * streaming data to destinations such as Amazon Simple Storage Service (Amazon S3), Amazon
21
- * Elasticsearch Service (Amazon ES), Amazon Redshift, and Splunk.</p>
22
- */
23
17
  class Firehose extends FirehoseClient_1.FirehoseClient {
24
18
  createDeliveryStream(args, optionsOrCb, cb) {
25
19
  const command = new CreateDeliveryStreamCommand_1.CreateDeliveryStreamCommand(args);
@@ -10,12 +10,6 @@ const middleware_signing_1 = require("@aws-sdk/middleware-signing");
10
10
  const middleware_user_agent_1 = require("@aws-sdk/middleware-user-agent");
11
11
  const smithy_client_1 = require("@aws-sdk/smithy-client");
12
12
  const runtimeConfig_1 = require("./runtimeConfig");
13
- /**
14
- * <fullname>Amazon Kinesis Data Firehose API Reference</fullname>
15
- * <p>Amazon Kinesis Data Firehose is a fully managed service that delivers real-time
16
- * streaming data to destinations such as Amazon Simple Storage Service (Amazon S3), Amazon
17
- * Elasticsearch Service (Amazon ES), Amazon Redshift, and Splunk.</p>
18
- */
19
13
  class FirehoseClient extends smithy_client_1.Client {
20
14
  constructor(configuration) {
21
15
  const _config_0 = runtimeConfig_1.getRuntimeConfig(configuration);
@@ -34,11 +28,6 @@ class FirehoseClient extends smithy_client_1.Client {
34
28
  this.middlewareStack.use(middleware_signing_1.getAwsAuthPlugin(this.config));
35
29
  this.middlewareStack.use(middleware_user_agent_1.getUserAgentPlugin(this.config));
36
30
  }
37
- /**
38
- * Destroy underlying resources, like sockets. It's usually not necessary to do this.
39
- * However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
40
- * Otherwise, sockets might stay open for quite a long time before the server terminates them.
41
- */
42
31
  destroy() {
43
32
  super.destroy();
44
33
  }
@@ -5,103 +5,11 @@ const middleware_serde_1 = require("@aws-sdk/middleware-serde");
5
5
  const smithy_client_1 = require("@aws-sdk/smithy-client");
6
6
  const models_0_1 = require("../models/models_0");
7
7
  const Aws_json1_1_1 = require("../protocols/Aws_json1_1");
8
- /**
9
- * <p>Creates a Kinesis Data Firehose delivery stream.</p>
10
- *
11
- * <p>By default, you can create up to 50 delivery streams per AWS Region.</p>
12
- * <p>This is an asynchronous operation that immediately returns. The initial status of the
13
- * delivery stream is <code>CREATING</code>. After the delivery stream is created, its status
14
- * is <code>ACTIVE</code> and it now accepts data. If the delivery stream creation fails, the
15
- * status transitions to <code>CREATING_FAILED</code>. Attempts to send data to a delivery
16
- * stream that is not in the <code>ACTIVE</code> state cause an exception. To check the state
17
- * of a delivery stream, use <a>DescribeDeliveryStream</a>.</p>
18
- * <p>If the status of a delivery stream is <code>CREATING_FAILED</code>, this status
19
- * doesn't change, and you can't invoke <code>CreateDeliveryStream</code> again on it.
20
- * However, you can invoke the <a>DeleteDeliveryStream</a> operation to delete
21
- * it.</p>
22
- * <p>A Kinesis Data Firehose delivery stream can be configured to receive records directly
23
- * from providers using <a>PutRecord</a> or <a>PutRecordBatch</a>, or it
24
- * can be configured to use an existing Kinesis stream as its source. To specify a Kinesis
25
- * data stream as input, set the <code>DeliveryStreamType</code> parameter to
26
- * <code>KinesisStreamAsSource</code>, and provide the Kinesis stream Amazon Resource Name
27
- * (ARN) and role ARN in the <code>KinesisStreamSourceConfiguration</code>
28
- * parameter.</p>
29
- * <p>To create a delivery stream with server-side encryption (SSE) enabled, include <a>DeliveryStreamEncryptionConfigurationInput</a> in your request. This is
30
- * optional. You can also invoke <a>StartDeliveryStreamEncryption</a> to turn on
31
- * SSE for an existing delivery stream that doesn't have SSE enabled.</p>
32
- * <p>A delivery stream is configured with a single destination: Amazon S3, Amazon ES,
33
- * Amazon Redshift, or Splunk. You must specify only one of the following destination
34
- * configuration parameters: <code>ExtendedS3DestinationConfiguration</code>,
35
- * <code>S3DestinationConfiguration</code>,
36
- * <code>ElasticsearchDestinationConfiguration</code>,
37
- * <code>RedshiftDestinationConfiguration</code>, or
38
- * <code>SplunkDestinationConfiguration</code>.</p>
39
- * <p>When you specify <code>S3DestinationConfiguration</code>, you can also provide the
40
- * following optional values: BufferingHints, <code>EncryptionConfiguration</code>, and
41
- * <code>CompressionFormat</code>. By default, if no <code>BufferingHints</code> value is
42
- * provided, Kinesis Data Firehose buffers data up to 5 MB or for 5 minutes, whichever
43
- * condition is satisfied first. <code>BufferingHints</code> is a hint, so there are some
44
- * cases where the service cannot adhere to these conditions strictly. For example, record
45
- * boundaries might be such that the size is a little over or under the configured buffering
46
- * size. By default, no encryption is performed. We strongly recommend that you enable
47
- * encryption to ensure secure data storage in Amazon S3.</p>
48
- *
49
- * <p>A few notes about Amazon Redshift as a destination:</p>
50
- * <ul>
51
- * <li>
52
- * <p>An Amazon Redshift destination requires an S3 bucket as intermediate location.
53
- * Kinesis Data Firehose first delivers data to Amazon S3 and then uses
54
- * <code>COPY</code> syntax to load data into an Amazon Redshift table. This is
55
- * specified in the <code>RedshiftDestinationConfiguration.S3Configuration</code>
56
- * parameter.</p>
57
- *
58
- * </li>
59
- * <li>
60
- * <p>The compression formats <code>SNAPPY</code> or <code>ZIP</code> cannot be
61
- * specified in <code>RedshiftDestinationConfiguration.S3Configuration</code> because
62
- * the Amazon Redshift <code>COPY</code> operation that reads from the S3 bucket doesn't
63
- * support these compression formats.</p>
64
- * </li>
65
- * <li>
66
- * <p>We strongly recommend that you use the user name and password you provide
67
- * exclusively with Kinesis Data Firehose, and that the permissions for the account are
68
- * restricted for Amazon Redshift <code>INSERT</code> permissions.</p>
69
- *
70
- * </li>
71
- * </ul>
72
- * <p>Kinesis Data Firehose assumes the IAM role that is configured as part of the
73
- * destination. The role should allow the Kinesis Data Firehose principal to assume the role,
74
- * and the role should have permissions that allow the service to deliver the data. For more
75
- * information, see <a href="https://docs.aws.amazon.com/firehose/latest/dev/controlling-access.html#using-iam-s3">Grant Kinesis Data
76
- * Firehose Access to an Amazon S3 Destination</a> in the <i>Amazon Kinesis Data
77
- * Firehose Developer Guide</i>.</p>
78
- * @example
79
- * Use a bare-bones client and the command you need to make an API call.
80
- * ```javascript
81
- * import { FirehoseClient, CreateDeliveryStreamCommand } from "@aws-sdk/client-firehose"; // ES Modules import
82
- * // const { FirehoseClient, CreateDeliveryStreamCommand } = require("@aws-sdk/client-firehose"); // CommonJS import
83
- * const client = new FirehoseClient(config);
84
- * const command = new CreateDeliveryStreamCommand(input);
85
- * const response = await client.send(command);
86
- * ```
87
- *
88
- * @see {@link CreateDeliveryStreamCommandInput} for command's `input` shape.
89
- * @see {@link CreateDeliveryStreamCommandOutput} for command's `response` shape.
90
- * @see {@link FirehoseClientResolvedConfig | config} for command's `input` shape.
91
- *
92
- */
93
8
  class CreateDeliveryStreamCommand extends smithy_client_1.Command {
94
- // Start section: command_properties
95
- // End section: command_properties
96
9
  constructor(input) {
97
- // Start section: command_constructor
98
10
  super();
99
11
  this.input = input;
100
- // End section: command_constructor
101
12
  }
102
- /**
103
- * @internal
104
- */
105
13
  resolveMiddleware(clientStack, configuration, options) {
106
14
  this.middlewareStack.use(middleware_serde_1.getSerdePlugin(configuration, this.serialize, this.deserialize));
107
15
  const stack = clientStack.concat(this.middlewareStack);
@@ -5,44 +5,11 @@ const middleware_serde_1 = require("@aws-sdk/middleware-serde");
5
5
  const smithy_client_1 = require("@aws-sdk/smithy-client");
6
6
  const models_0_1 = require("../models/models_0");
7
7
  const Aws_json1_1_1 = require("../protocols/Aws_json1_1");
8
- /**
9
- * <p>Deletes a delivery stream and its data.</p>
10
- * <p>To check the state of a delivery stream, use <a>DescribeDeliveryStream</a>. You can delete a delivery stream only if it is in one of the following states:
11
- * <code>ACTIVE</code>, <code>DELETING</code>, <code>CREATING_FAILED</code>, or
12
- * <code>DELETING_FAILED</code>. You can't delete a delivery stream that is in the
13
- * <code>CREATING</code> state. While the deletion request is in process, the delivery
14
- * stream is in the <code>DELETING</code> state.</p>
15
- * <p>While the delivery stream is in the <code>DELETING</code> state, the service might
16
- * continue to accept records, but it doesn't make any guarantees with respect to delivering
17
- * the data. Therefore, as a best practice, first stop any applications that are sending
18
- * records before you delete a delivery stream.</p>
19
- * @example
20
- * Use a bare-bones client and the command you need to make an API call.
21
- * ```javascript
22
- * import { FirehoseClient, DeleteDeliveryStreamCommand } from "@aws-sdk/client-firehose"; // ES Modules import
23
- * // const { FirehoseClient, DeleteDeliveryStreamCommand } = require("@aws-sdk/client-firehose"); // CommonJS import
24
- * const client = new FirehoseClient(config);
25
- * const command = new DeleteDeliveryStreamCommand(input);
26
- * const response = await client.send(command);
27
- * ```
28
- *
29
- * @see {@link DeleteDeliveryStreamCommandInput} for command's `input` shape.
30
- * @see {@link DeleteDeliveryStreamCommandOutput} for command's `response` shape.
31
- * @see {@link FirehoseClientResolvedConfig | config} for command's `input` shape.
32
- *
33
- */
34
8
  class DeleteDeliveryStreamCommand extends smithy_client_1.Command {
35
- // Start section: command_properties
36
- // End section: command_properties
37
9
  constructor(input) {
38
- // Start section: command_constructor
39
10
  super();
40
11
  this.input = input;
41
- // End section: command_constructor
42
12
  }
43
- /**
44
- * @internal
45
- */
46
13
  resolveMiddleware(clientStack, configuration, options) {
47
14
  this.middlewareStack.use(middleware_serde_1.getSerdePlugin(configuration, this.serialize, this.deserialize));
48
15
  const stack = clientStack.concat(this.middlewareStack);
@@ -5,41 +5,11 @@ const middleware_serde_1 = require("@aws-sdk/middleware-serde");
5
5
  const smithy_client_1 = require("@aws-sdk/smithy-client");
6
6
  const models_0_1 = require("../models/models_0");
7
7
  const Aws_json1_1_1 = require("../protocols/Aws_json1_1");
8
- /**
9
- * <p>Describes the specified delivery stream and its status. For example, after your
10
- * delivery stream is created, call <code>DescribeDeliveryStream</code> to see whether the
11
- * delivery stream is <code>ACTIVE</code> and therefore ready for data to be sent to it. </p>
12
- * <p>If the status of a delivery stream is <code>CREATING_FAILED</code>, this status
13
- * doesn't change, and you can't invoke <a>CreateDeliveryStream</a> again on it.
14
- * However, you can invoke the <a>DeleteDeliveryStream</a> operation to delete it.
15
- * If the status is <code>DELETING_FAILED</code>, you can force deletion by invoking <a>DeleteDeliveryStream</a> again but with <a>DeleteDeliveryStreamInput$AllowForceDelete</a> set to true.</p>
16
- * @example
17
- * Use a bare-bones client and the command you need to make an API call.
18
- * ```javascript
19
- * import { FirehoseClient, DescribeDeliveryStreamCommand } from "@aws-sdk/client-firehose"; // ES Modules import
20
- * // const { FirehoseClient, DescribeDeliveryStreamCommand } = require("@aws-sdk/client-firehose"); // CommonJS import
21
- * const client = new FirehoseClient(config);
22
- * const command = new DescribeDeliveryStreamCommand(input);
23
- * const response = await client.send(command);
24
- * ```
25
- *
26
- * @see {@link DescribeDeliveryStreamCommandInput} for command's `input` shape.
27
- * @see {@link DescribeDeliveryStreamCommandOutput} for command's `response` shape.
28
- * @see {@link FirehoseClientResolvedConfig | config} for command's `input` shape.
29
- *
30
- */
31
8
  class DescribeDeliveryStreamCommand extends smithy_client_1.Command {
32
- // Start section: command_properties
33
- // End section: command_properties
34
9
  constructor(input) {
35
- // Start section: command_constructor
36
10
  super();
37
11
  this.input = input;
38
- // End section: command_constructor
39
12
  }
40
- /**
41
- * @internal
42
- */
43
13
  resolveMiddleware(clientStack, configuration, options) {
44
14
  this.middlewareStack.use(middleware_serde_1.getSerdePlugin(configuration, this.serialize, this.deserialize));
45
15
  const stack = clientStack.concat(this.middlewareStack);
@@ -5,42 +5,11 @@ const middleware_serde_1 = require("@aws-sdk/middleware-serde");
5
5
  const smithy_client_1 = require("@aws-sdk/smithy-client");
6
6
  const models_0_1 = require("../models/models_0");
7
7
  const Aws_json1_1_1 = require("../protocols/Aws_json1_1");
8
- /**
9
- * <p>Lists your delivery streams in alphabetical order of their names.</p>
10
- * <p>The number of delivery streams might be too large to return using a single call to
11
- * <code>ListDeliveryStreams</code>. You can limit the number of delivery streams returned,
12
- * using the <code>Limit</code> parameter. To determine whether there are more delivery
13
- * streams to list, check the value of <code>HasMoreDeliveryStreams</code> in the output. If
14
- * there are more delivery streams to list, you can request them by calling this operation
15
- * again and setting the <code>ExclusiveStartDeliveryStreamName</code> parameter to the name
16
- * of the last delivery stream returned in the last call.</p>
17
- * @example
18
- * Use a bare-bones client and the command you need to make an API call.
19
- * ```javascript
20
- * import { FirehoseClient, ListDeliveryStreamsCommand } from "@aws-sdk/client-firehose"; // ES Modules import
21
- * // const { FirehoseClient, ListDeliveryStreamsCommand } = require("@aws-sdk/client-firehose"); // CommonJS import
22
- * const client = new FirehoseClient(config);
23
- * const command = new ListDeliveryStreamsCommand(input);
24
- * const response = await client.send(command);
25
- * ```
26
- *
27
- * @see {@link ListDeliveryStreamsCommandInput} for command's `input` shape.
28
- * @see {@link ListDeliveryStreamsCommandOutput} for command's `response` shape.
29
- * @see {@link FirehoseClientResolvedConfig | config} for command's `input` shape.
30
- *
31
- */
32
8
  class ListDeliveryStreamsCommand extends smithy_client_1.Command {
33
- // Start section: command_properties
34
- // End section: command_properties
35
9
  constructor(input) {
36
- // Start section: command_constructor
37
10
  super();
38
11
  this.input = input;
39
- // End section: command_constructor
40
12
  }
41
- /**
42
- * @internal
43
- */
44
13
  resolveMiddleware(clientStack, configuration, options) {
45
14
  this.middlewareStack.use(middleware_serde_1.getSerdePlugin(configuration, this.serialize, this.deserialize));
46
15
  const stack = clientStack.concat(this.middlewareStack);
@@ -5,36 +5,11 @@ const middleware_serde_1 = require("@aws-sdk/middleware-serde");
5
5
  const smithy_client_1 = require("@aws-sdk/smithy-client");
6
6
  const models_0_1 = require("../models/models_0");
7
7
  const Aws_json1_1_1 = require("../protocols/Aws_json1_1");
8
- /**
9
- * <p>Lists the tags for the specified delivery stream. This operation has a limit of five
10
- * transactions per second per account. </p>
11
- * @example
12
- * Use a bare-bones client and the command you need to make an API call.
13
- * ```javascript
14
- * import { FirehoseClient, ListTagsForDeliveryStreamCommand } from "@aws-sdk/client-firehose"; // ES Modules import
15
- * // const { FirehoseClient, ListTagsForDeliveryStreamCommand } = require("@aws-sdk/client-firehose"); // CommonJS import
16
- * const client = new FirehoseClient(config);
17
- * const command = new ListTagsForDeliveryStreamCommand(input);
18
- * const response = await client.send(command);
19
- * ```
20
- *
21
- * @see {@link ListTagsForDeliveryStreamCommandInput} for command's `input` shape.
22
- * @see {@link ListTagsForDeliveryStreamCommandOutput} for command's `response` shape.
23
- * @see {@link FirehoseClientResolvedConfig | config} for command's `input` shape.
24
- *
25
- */
26
8
  class ListTagsForDeliveryStreamCommand extends smithy_client_1.Command {
27
- // Start section: command_properties
28
- // End section: command_properties
29
9
  constructor(input) {
30
- // Start section: command_constructor
31
10
  super();
32
11
  this.input = input;
33
- // End section: command_constructor
34
12
  }
35
- /**
36
- * @internal
37
- */
38
13
  resolveMiddleware(clientStack, configuration, options) {
39
14
  this.middlewareStack.use(middleware_serde_1.getSerdePlugin(configuration, this.serialize, this.deserialize));
40
15
  const stack = clientStack.concat(this.middlewareStack);
@@ -5,85 +5,11 @@ const middleware_serde_1 = require("@aws-sdk/middleware-serde");
5
5
  const smithy_client_1 = require("@aws-sdk/smithy-client");
6
6
  const models_0_1 = require("../models/models_0");
7
7
  const Aws_json1_1_1 = require("../protocols/Aws_json1_1");
8
- /**
9
- * <p>Writes multiple data records into a delivery stream in a single call, which can
10
- * achieve higher throughput per producer than when writing single records. To write single
11
- * data records into a delivery stream, use <a>PutRecord</a>. Applications using
12
- * these operations are referred to as producers.</p>
13
- * <p>For information about service quota, see <a href="https://docs.aws.amazon.com/firehose/latest/dev/limits.html">Amazon Kinesis Data Firehose
14
- * Quota</a>.</p>
15
- * <p>Each <a>PutRecordBatch</a> request supports up to 500 records. Each record
16
- * in the request can be as large as 1,000 KB (before base64 encoding), up to a limit of 4 MB
17
- * for the entire request. These limits cannot be changed.</p>
18
- * <p>You must specify the name of the delivery stream and the data record when using <a>PutRecord</a>. The data record consists of a data blob that can be up to 1,000
19
- * KB in size, and any kind of data. For example, it could be a segment from a log file,
20
- * geographic location data, website clickstream data, and so on.</p>
21
- * <p>Kinesis Data Firehose buffers records before delivering them to the destination. To
22
- * disambiguate the data blobs at the destination, a common solution is to use delimiters in
23
- * the data, such as a newline (<code>\n</code>) or some other character unique within the
24
- * data. This allows the consumer application to parse individual data items when reading the
25
- * data from the destination.</p>
26
- * <p>The <a>PutRecordBatch</a> response includes a count of failed records,
27
- * <code>FailedPutCount</code>, and an array of responses, <code>RequestResponses</code>.
28
- * Even if the <a>PutRecordBatch</a> call succeeds, the value of
29
- * <code>FailedPutCount</code> may be greater than 0, indicating that there are records for
30
- * which the operation didn't succeed. Each entry in the <code>RequestResponses</code> array
31
- * provides additional information about the processed record. It directly correlates with a
32
- * record in the request array using the same ordering, from the top to the bottom. The
33
- * response array always includes the same number of records as the request array.
34
- * <code>RequestResponses</code> includes both successfully and unsuccessfully processed
35
- * records. Kinesis Data Firehose tries to process all records in each <a>PutRecordBatch</a> request. A single record failure does not stop the processing
36
- * of subsequent records. </p>
37
- * <p>A successfully processed record includes a <code>RecordId</code> value, which is
38
- * unique for the record. An unsuccessfully processed record includes <code>ErrorCode</code>
39
- * and <code>ErrorMessage</code> values. <code>ErrorCode</code> reflects the type of error,
40
- * and is one of the following values: <code>ServiceUnavailableException</code> or
41
- * <code>InternalFailure</code>. <code>ErrorMessage</code> provides more detailed
42
- * information about the error.</p>
43
- * <p>If there is an internal server error or a timeout, the write might have completed or
44
- * it might have failed. If <code>FailedPutCount</code> is greater than 0, retry the request,
45
- * resending only those records that might have failed processing. This minimizes the possible
46
- * duplicate records and also reduces the total bytes sent (and corresponding charges). We
47
- * recommend that you handle any duplicates at the destination.</p>
48
- * <p>If <a>PutRecordBatch</a> throws <code>ServiceUnavailableException</code>,
49
- * back off and retry. If the exception persists, it is possible that the throughput limits
50
- * have been exceeded for the delivery stream.</p>
51
- *
52
- * <p>Data records sent to Kinesis Data Firehose are stored for 24 hours from the time they
53
- * are added to a delivery stream as it attempts to send the records to the destination. If
54
- * the destination is unreachable for more than 24 hours, the data is no longer
55
- * available.</p>
56
- * <important>
57
- * <p>Don't concatenate two or more base64 strings to form the data fields of your records.
58
- * Instead, concatenate the raw data, then perform base64 encoding.</p>
59
- * </important>
60
- * @example
61
- * Use a bare-bones client and the command you need to make an API call.
62
- * ```javascript
63
- * import { FirehoseClient, PutRecordBatchCommand } from "@aws-sdk/client-firehose"; // ES Modules import
64
- * // const { FirehoseClient, PutRecordBatchCommand } = require("@aws-sdk/client-firehose"); // CommonJS import
65
- * const client = new FirehoseClient(config);
66
- * const command = new PutRecordBatchCommand(input);
67
- * const response = await client.send(command);
68
- * ```
69
- *
70
- * @see {@link PutRecordBatchCommandInput} for command's `input` shape.
71
- * @see {@link PutRecordBatchCommandOutput} for command's `response` shape.
72
- * @see {@link FirehoseClientResolvedConfig | config} for command's `input` shape.
73
- *
74
- */
75
8
  class PutRecordBatchCommand extends smithy_client_1.Command {
76
- // Start section: command_properties
77
- // End section: command_properties
78
9
  constructor(input) {
79
- // Start section: command_constructor
80
10
  super();
81
11
  this.input = input;
82
- // End section: command_constructor
83
12
  }
84
- /**
85
- * @internal
86
- */
87
13
  resolveMiddleware(clientStack, configuration, options) {
88
14
  this.middlewareStack.use(middleware_serde_1.getSerdePlugin(configuration, this.serialize, this.deserialize));
89
15
  const stack = clientStack.concat(this.middlewareStack);
@@ -5,66 +5,11 @@ const middleware_serde_1 = require("@aws-sdk/middleware-serde");
5
5
  const smithy_client_1 = require("@aws-sdk/smithy-client");
6
6
  const models_0_1 = require("../models/models_0");
7
7
  const Aws_json1_1_1 = require("../protocols/Aws_json1_1");
8
- /**
9
- * <p>Writes a single data record into an Amazon Kinesis Data Firehose delivery stream. To
10
- * write multiple data records into a delivery stream, use <a>PutRecordBatch</a>.
11
- * Applications using these operations are referred to as producers.</p>
12
- * <p>By default, each delivery stream can take in up to 2,000 transactions per second,
13
- * 5,000 records per second, or 5 MB per second. If you use <a>PutRecord</a> and
14
- * <a>PutRecordBatch</a>, the limits are an aggregate across these two
15
- * operations for each delivery stream. For more information about limits and how to request
16
- * an increase, see <a href="https://docs.aws.amazon.com/firehose/latest/dev/limits.html">Amazon
17
- * Kinesis Data Firehose Limits</a>. </p>
18
- * <p>You must specify the name of the delivery stream and the data record when using <a>PutRecord</a>. The data record consists of a data blob that can be up to 1,000
19
- * KiB in size, and any kind of data. For example, it can be a segment from a log file,
20
- * geographic location data, website clickstream data, and so on.</p>
21
- * <p>Kinesis Data Firehose buffers records before delivering them to the destination. To
22
- * disambiguate the data blobs at the destination, a common solution is to use delimiters in
23
- * the data, such as a newline (<code>\n</code>) or some other character unique within the
24
- * data. This allows the consumer application to parse individual data items when reading the
25
- * data from the destination.</p>
26
- * <p>The <code>PutRecord</code> operation returns a <code>RecordId</code>, which is a
27
- * unique string assigned to each record. Producer applications can use this ID for purposes
28
- * such as auditability and investigation.</p>
29
- * <p>If the <code>PutRecord</code> operation throws a
30
- * <code>ServiceUnavailableException</code>, back off and retry. If the exception persists,
31
- * it is possible that the throughput limits have been exceeded for the delivery stream. </p>
32
- * <p>Data records sent to Kinesis Data Firehose are stored for 24 hours from the time they
33
- * are added to a delivery stream as it tries to send the records to the destination. If the
34
- * destination is unreachable for more than 24 hours, the data is no longer
35
- * available.</p>
36
- *
37
- * <important>
38
- * <p>Don't concatenate two or more base64 strings to form the data fields of your records.
39
- * Instead, concatenate the raw data, then perform base64 encoding.</p>
40
- * </important>
41
- * @example
42
- * Use a bare-bones client and the command you need to make an API call.
43
- * ```javascript
44
- * import { FirehoseClient, PutRecordCommand } from "@aws-sdk/client-firehose"; // ES Modules import
45
- * // const { FirehoseClient, PutRecordCommand } = require("@aws-sdk/client-firehose"); // CommonJS import
46
- * const client = new FirehoseClient(config);
47
- * const command = new PutRecordCommand(input);
48
- * const response = await client.send(command);
49
- * ```
50
- *
51
- * @see {@link PutRecordCommandInput} for command's `input` shape.
52
- * @see {@link PutRecordCommandOutput} for command's `response` shape.
53
- * @see {@link FirehoseClientResolvedConfig | config} for command's `input` shape.
54
- *
55
- */
56
8
  class PutRecordCommand extends smithy_client_1.Command {
57
- // Start section: command_properties
58
- // End section: command_properties
59
9
  constructor(input) {
60
- // Start section: command_constructor
61
10
  super();
62
11
  this.input = input;
63
- // End section: command_constructor
64
12
  }
65
- /**
66
- * @internal
67
- */
68
13
  resolveMiddleware(clientStack, configuration, options) {
69
14
  this.middlewareStack.use(middleware_serde_1.getSerdePlugin(configuration, this.serialize, this.deserialize));
70
15
  const stack = clientStack.concat(this.middlewareStack);
@@ -5,70 +5,11 @@ const middleware_serde_1 = require("@aws-sdk/middleware-serde");
5
5
  const smithy_client_1 = require("@aws-sdk/smithy-client");
6
6
  const models_0_1 = require("../models/models_0");
7
7
  const Aws_json1_1_1 = require("../protocols/Aws_json1_1");
8
- /**
9
- * <p>Enables server-side encryption (SSE) for the delivery stream. </p>
10
- * <p>This operation is asynchronous. It returns immediately. When you invoke it, Kinesis Data
11
- * Firehose first sets the encryption status of the stream to <code>ENABLING</code>, and then
12
- * to <code>ENABLED</code>. The encryption status of a delivery stream is the
13
- * <code>Status</code> property in <a>DeliveryStreamEncryptionConfiguration</a>.
14
- * If the operation fails, the encryption status changes to <code>ENABLING_FAILED</code>. You
15
- * can continue to read and write data to your delivery stream while the encryption status is
16
- * <code>ENABLING</code>, but the data is not encrypted. It can take up to 5 seconds after
17
- * the encryption status changes to <code>ENABLED</code> before all records written to the
18
- * delivery stream are encrypted. To find out whether a record or a batch of records was
19
- * encrypted, check the response elements <a>PutRecordOutput$Encrypted</a> and
20
- * <a>PutRecordBatchOutput$Encrypted</a>, respectively.</p>
21
- * <p>To check the encryption status of a delivery stream, use <a>DescribeDeliveryStream</a>.</p>
22
- * <p>Even if encryption is currently enabled for a delivery stream, you can still invoke this
23
- * operation on it to change the ARN of the CMK or both its type and ARN. If you invoke this
24
- * method to change the CMK, and the old CMK is of type <code>CUSTOMER_MANAGED_CMK</code>,
25
- * Kinesis Data Firehose schedules the grant it had on the old CMK for retirement. If the new
26
- * CMK is of type <code>CUSTOMER_MANAGED_CMK</code>, Kinesis Data Firehose creates a grant
27
- * that enables it to use the new CMK to encrypt and decrypt data and to manage the
28
- * grant.</p>
29
- * <p>If a delivery stream already has encryption enabled and then you invoke this operation
30
- * to change the ARN of the CMK or both its type and ARN and you get
31
- * <code>ENABLING_FAILED</code>, this only means that the attempt to change the CMK failed.
32
- * In this case, encryption remains enabled with the old CMK.</p>
33
- * <p>If the encryption status of your delivery stream is <code>ENABLING_FAILED</code>, you
34
- * can invoke this operation again with a valid CMK. The CMK must be enabled and the key
35
- * policy mustn't explicitly deny the permission for Kinesis Data Firehose to invoke KMS
36
- * encrypt and decrypt operations.</p>
37
- * <p>You can enable SSE for a delivery stream only if it's a delivery stream that uses
38
- * <code>DirectPut</code> as its source. </p>
39
- * <p>The <code>StartDeliveryStreamEncryption</code> and
40
- * <code>StopDeliveryStreamEncryption</code> operations have a combined limit of 25 calls
41
- * per delivery stream per 24 hours. For example, you reach the limit if you call
42
- * <code>StartDeliveryStreamEncryption</code> 13 times and
43
- * <code>StopDeliveryStreamEncryption</code> 12 times for the same delivery stream in a
44
- * 24-hour period.</p>
45
- * @example
46
- * Use a bare-bones client and the command you need to make an API call.
47
- * ```javascript
48
- * import { FirehoseClient, StartDeliveryStreamEncryptionCommand } from "@aws-sdk/client-firehose"; // ES Modules import
49
- * // const { FirehoseClient, StartDeliveryStreamEncryptionCommand } = require("@aws-sdk/client-firehose"); // CommonJS import
50
- * const client = new FirehoseClient(config);
51
- * const command = new StartDeliveryStreamEncryptionCommand(input);
52
- * const response = await client.send(command);
53
- * ```
54
- *
55
- * @see {@link StartDeliveryStreamEncryptionCommandInput} for command's `input` shape.
56
- * @see {@link StartDeliveryStreamEncryptionCommandOutput} for command's `response` shape.
57
- * @see {@link FirehoseClientResolvedConfig | config} for command's `input` shape.
58
- *
59
- */
60
8
  class StartDeliveryStreamEncryptionCommand extends smithy_client_1.Command {
61
- // Start section: command_properties
62
- // End section: command_properties
63
9
  constructor(input) {
64
- // Start section: command_constructor
65
10
  super();
66
11
  this.input = input;
67
- // End section: command_constructor
68
12
  }
69
- /**
70
- * @internal
71
- */
72
13
  resolveMiddleware(clientStack, configuration, options) {
73
14
  this.middlewareStack.use(middleware_serde_1.getSerdePlugin(configuration, this.serialize, this.deserialize));
74
15
  const stack = clientStack.concat(this.middlewareStack);