Container for the parameters to the ListRetainedMessages operation. 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.
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.IotData.AmazonIotDataRequest
Amazon.IotData.Model.ListRetainedMessagesRequest
Namespace: Amazon.IotData.Model
Assembly: AWSSDK.IotData.dll
Version: 3.x.y.z
Syntax
public class ListRetainedMessagesRequest : AmazonIotDataRequest IAmazonWebServiceRequest
The ListRetainedMessagesRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
ListRetainedMessagesRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
MaxResults | System.Int32 |
Gets and sets the property MaxResults. The maximum number of results to return at one time. |
|
|
NextToken | System.String |
Gets and sets the property NextToken.
To retrieve the next set of results, the |
Version Information
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer, 3.5