/
ListRetainedMessagesCommand.ts
178 lines (167 loc) · 6.93 KB
/
ListRetainedMessagesCommand.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
// 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 { IoTDataPlaneClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTDataPlaneClient";
import { ListRetainedMessagesRequest, ListRetainedMessagesResponse } from "../models/models_0";
import { de_ListRetainedMessagesCommand, se_ListRetainedMessagesCommand } from "../protocols/Aws_restJson1";
/**
* @public
*/
export { __MetadataBearer, $Command };
/**
* @public
*
* The input for {@link ListRetainedMessagesCommand}.
*/
export interface ListRetainedMessagesCommandInput extends ListRetainedMessagesRequest {}
/**
* @public
*
* The output of {@link ListRetainedMessagesCommand}.
*/
export interface ListRetainedMessagesCommandOutput extends ListRetainedMessagesResponse, __MetadataBearer {}
/**
* @public
* <p>Lists summary information about the retained messages stored for the account.</p>
* <p>This action returns only the topic names of the retained messages. It doesn't
* return any message payloads. Although this action doesn't return a message payload,
* it can still incur messaging costs.</p>
* <p>To get the message payload of a retained message, call
* <a href="https://docs.aws.amazon.com/iot/latest/apireference/API_iotdata_GetRetainedMessage.html">GetRetainedMessage</a>
* with the topic name of the retained message.</p>
* <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiotfleethubfordevicemanagement.html#awsiotfleethubfordevicemanagement-actions-as-permissions">ListRetainedMessages</a> action.</p>
* <p>For more information about messaging costs, see <a href="http://aws.amazon.com/iot-core/pricing/#Messaging">Amazon Web Services IoT Core
* pricing - Messaging</a>.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
* import { IoTDataPlaneClient, ListRetainedMessagesCommand } from "@aws-sdk/client-iot-data-plane"; // ES Modules import
* // const { IoTDataPlaneClient, ListRetainedMessagesCommand } = require("@aws-sdk/client-iot-data-plane"); // CommonJS import
* const client = new IoTDataPlaneClient(config);
* const input = { // ListRetainedMessagesRequest
* nextToken: "STRING_VALUE",
* maxResults: Number("int"),
* };
* const command = new ListRetainedMessagesCommand(input);
* const response = await client.send(command);
* // { // ListRetainedMessagesResponse
* // retainedTopics: [ // RetainedMessageList
* // { // RetainedMessageSummary
* // topic: "STRING_VALUE",
* // payloadSize: Number("long"),
* // qos: Number("int"),
* // lastModifiedTime: Number("long"),
* // },
* // ],
* // nextToken: "STRING_VALUE",
* // };
*
* ```
*
* @param ListRetainedMessagesCommandInput - {@link ListRetainedMessagesCommandInput}
* @returns {@link ListRetainedMessagesCommandOutput}
* @see {@link ListRetainedMessagesCommandInput} for command's `input` shape.
* @see {@link ListRetainedMessagesCommandOutput} for command's `response` shape.
* @see {@link IoTDataPlaneClientResolvedConfig | config} for IoTDataPlaneClient's `config` shape.
*
* @throws {@link InternalFailureException} (server fault)
* <p>An unexpected error has occurred.</p>
*
* @throws {@link InvalidRequestException} (client fault)
* <p>The request is not valid.</p>
*
* @throws {@link MethodNotAllowedException} (client fault)
* <p>The specified combination of HTTP verb and URI is not supported.</p>
*
* @throws {@link ServiceUnavailableException} (server fault)
* <p>The service is temporarily unavailable.</p>
*
* @throws {@link ThrottlingException} (client fault)
* <p>The rate exceeds the limit.</p>
*
* @throws {@link UnauthorizedException} (client fault)
* <p>You are not authorized to perform this operation.</p>
*
* @throws {@link IoTDataPlaneServiceException}
* <p>Base exception class for all service exceptions from IoTDataPlane service.</p>
*
*/
export class ListRetainedMessagesCommand extends $Command<
ListRetainedMessagesCommandInput,
ListRetainedMessagesCommandOutput,
IoTDataPlaneClientResolvedConfig
> {
// 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: ListRetainedMessagesCommandInput) {
// Start section: command_constructor
super();
// End section: command_constructor
}
/**
* @internal
*/
resolveMiddleware(
clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
configuration: IoTDataPlaneClientResolvedConfig,
options?: __HttpHandlerOptions
): Handler<ListRetainedMessagesCommandInput, ListRetainedMessagesCommandOutput> {
this.middlewareStack.use(getSerdePlugin(configuration, this.serialize, this.deserialize));
this.middlewareStack.use(
getEndpointPlugin(configuration, ListRetainedMessagesCommand.getEndpointParameterInstructions())
);
const stack = clientStack.concat(this.middlewareStack);
const { logger } = configuration;
const clientName = "IoTDataPlaneClient";
const commandName = "ListRetainedMessagesCommand";
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: ListRetainedMessagesCommandInput, context: __SerdeContext): Promise<__HttpRequest> {
return se_ListRetainedMessagesCommand(input, context);
}
/**
* @internal
*/
private deserialize(output: __HttpResponse, context: __SerdeContext): Promise<ListRetainedMessagesCommandOutput> {
return de_ListRetainedMessagesCommand(output, context);
}
// Start section: command_body_extra
// End section: command_body_extra
}