Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ListRetainedMessagesCommand

Lists summary information about the retained messages stored for the account.

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.

To get the message payload of a retained message, call GetRetainedMessage with the topic name of the retained message.

Requires permission to access the ListRetainedMessages action.

For more information about messaging costs, see Amazon Web Services IoT Core pricing - Messaging.

example

Use a bare-bones client and the command you need to make an API call.

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 command = new ListRetainedMessagesCommand(input);
const response = await client.send(command);
see

ListRetainedMessagesCommandInput for command's input shape.

see

ListRetainedMessagesCommandOutput for command's response shape.

see

config for IoTDataPlaneClient's config shape.

Hierarchy

Implements

Index

Constructors

Properties

Constructors

constructor

Properties

Readonly input

input: ListRetainedMessagesCommandInput

Readonly middlewareStack