/
ListStreamsCommand.ts
183 lines (172 loc) · 7.08 KB
/
ListStreamsCommand.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
// smithy-typescript generated code
import { EndpointParameterInstructions, getEndpointPlugin } from "@aws-sdk/middleware-endpoint";
import { getSerdePlugin } from "@aws-sdk/middleware-serde";
import { Command as $Command } from "@aws-sdk/smithy-client";
import {
FinalizeHandlerArguments,
Handler,
HandlerExecutionContext,
HttpHandlerOptions as __HttpHandlerOptions,
MetadataBearer as __MetadataBearer,
MiddlewareStack,
} from "@aws-sdk/types";
import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@smithy/protocol-http";
import { SerdeContext as __SerdeContext } from "@smithy/types";
import { KinesisClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KinesisClient";
import { ListStreamsInput, ListStreamsOutput } from "../models/models_0";
import { de_ListStreamsCommand, se_ListStreamsCommand } from "../protocols/Aws_json1_1";
/**
* @public
*/
export { __MetadataBearer, $Command };
/**
* @public
*
* The input for {@link ListStreamsCommand}.
*/
export interface ListStreamsCommandInput extends ListStreamsInput {}
/**
* @public
*
* The output of {@link ListStreamsCommand}.
*/
export interface ListStreamsCommandOutput extends ListStreamsOutput, __MetadataBearer {}
/**
* @public
* <p>Lists your Kinesis data streams.</p>
* <p>The number of streams may be too large to return from a single call to
* <code>ListStreams</code>. You can limit the number of returned streams using the
* <code>Limit</code> parameter. If you do not specify a value for the
* <code>Limit</code> parameter, Kinesis Data Streams uses the default limit, which is
* currently 100.</p>
* <p>You can detect if there are more streams available to list by using the
* <code>HasMoreStreams</code> flag from the returned output. If there are more streams
* available, you can request more streams by using the name of the last stream returned by
* the <code>ListStreams</code> request in the <code>ExclusiveStartStreamName</code>
* parameter in a subsequent request to <code>ListStreams</code>. The group of stream names
* returned by the subsequent request is then added to the list. You can continue this
* process until all the stream names have been collected in the list. </p>
* <p>
* <a>ListStreams</a> has a limit of five transactions per second per
* account.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
* import { KinesisClient, ListStreamsCommand } from "@aws-sdk/client-kinesis"; // ES Modules import
* // const { KinesisClient, ListStreamsCommand } = require("@aws-sdk/client-kinesis"); // CommonJS import
* const client = new KinesisClient(config);
* const input = { // ListStreamsInput
* Limit: Number("int"),
* ExclusiveStartStreamName: "STRING_VALUE",
* NextToken: "STRING_VALUE",
* };
* const command = new ListStreamsCommand(input);
* const response = await client.send(command);
* // { // ListStreamsOutput
* // StreamNames: [ // StreamNameList // required
* // "STRING_VALUE",
* // ],
* // HasMoreStreams: true || false, // required
* // NextToken: "STRING_VALUE",
* // StreamSummaries: [ // StreamSummaryList
* // { // StreamSummary
* // StreamName: "STRING_VALUE", // required
* // StreamARN: "STRING_VALUE", // required
* // StreamStatus: "CREATING" || "DELETING" || "ACTIVE" || "UPDATING", // required
* // StreamModeDetails: { // StreamModeDetails
* // StreamMode: "PROVISIONED" || "ON_DEMAND", // required
* // },
* // StreamCreationTimestamp: new Date("TIMESTAMP"),
* // },
* // ],
* // };
*
* ```
*
* @param ListStreamsCommandInput - {@link ListStreamsCommandInput}
* @returns {@link ListStreamsCommandOutput}
* @see {@link ListStreamsCommandInput} for command's `input` shape.
* @see {@link ListStreamsCommandOutput} for command's `response` shape.
* @see {@link KinesisClientResolvedConfig | config} for KinesisClient's `config` shape.
*
* @throws {@link ExpiredNextTokenException} (client fault)
* <p>The pagination token passed to the operation is expired.</p>
*
* @throws {@link InvalidArgumentException} (client fault)
* <p>A specified parameter exceeds its restrictions, is not supported, or can't be used.
* For more information, see the returned message.</p>
*
* @throws {@link LimitExceededException} (client fault)
* <p>The requested resource exceeds the maximum number allowed, or the number of concurrent
* stream requests exceeds the maximum number allowed. </p>
*
* @throws {@link KinesisServiceException}
* <p>Base exception class for all service exceptions from Kinesis service.</p>
*
*/
export class ListStreamsCommand extends $Command<
ListStreamsCommandInput,
ListStreamsCommandOutput,
KinesisClientResolvedConfig
> {
// Start section: command_properties
// End section: command_properties
public static getEndpointParameterInstructions(): EndpointParameterInstructions {
return {
UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" },
Endpoint: { type: "builtInParams", name: "endpoint" },
Region: { type: "builtInParams", name: "region" },
UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" },
};
}
/**
* @public
*/
constructor(readonly input: ListStreamsCommandInput) {
// Start section: command_constructor
super();
// End section: command_constructor
}
/**
* @internal
*/
resolveMiddleware(
clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
configuration: KinesisClientResolvedConfig,
options?: __HttpHandlerOptions
): Handler<ListStreamsCommandInput, ListStreamsCommandOutput> {
this.middlewareStack.use(getSerdePlugin(configuration, this.serialize, this.deserialize));
this.middlewareStack.use(getEndpointPlugin(configuration, ListStreamsCommand.getEndpointParameterInstructions()));
const stack = clientStack.concat(this.middlewareStack);
const { logger } = configuration;
const clientName = "KinesisClient";
const commandName = "ListStreamsCommand";
const handlerExecutionContext: HandlerExecutionContext = {
logger,
clientName,
commandName,
inputFilterSensitiveLog: (_: any) => _,
outputFilterSensitiveLog: (_: any) => _,
};
const { requestHandler } = configuration;
return stack.resolve(
(request: FinalizeHandlerArguments<any>) =>
requestHandler.handle(request.request as __HttpRequest, options || {}),
handlerExecutionContext
);
}
/**
* @internal
*/
private serialize(input: ListStreamsCommandInput, context: __SerdeContext): Promise<__HttpRequest> {
return se_ListStreamsCommand(input, context);
}
/**
* @internal
*/
private deserialize(output: __HttpResponse, context: __SerdeContext): Promise<ListStreamsCommandOutput> {
return de_ListStreamsCommand(output, context);
}
// Start section: command_body_extra
// End section: command_body_extra
}