Options
All
  • Public
  • Public/Protected
  • All
Menu

Class GetRetainedMessageCommand

Gets the details of a single retained message for the specified topic.

This action returns the message payload of the retained message, which can incur messaging costs. To list only the topic names of the retained messages, call ListRetainedMessages.

Requires permission to access the GetRetainedMessage 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, GetRetainedMessageCommand } from "@aws-sdk/client-iot-data-plane"; // ES Modules import
// const { IoTDataPlaneClient, GetRetainedMessageCommand } = require("@aws-sdk/client-iot-data-plane"); // CommonJS import
const client = new IoTDataPlaneClient(config);
const command = new GetRetainedMessageCommand(input);
const response = await client.send(command);
see

GetRetainedMessageCommandInput for command's input shape.

see

GetRetainedMessageCommandOutput for command's response shape.

see

config for IoTDataPlaneClient's config shape.

Hierarchy

Implements

Index

Constructors

constructor

Properties

Readonly input

input: GetRetainedMessageCommandInput

Readonly middlewareStack

Methods

Static getEndpointParameterInstructions