AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
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.
This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginGetRetainedMessage and EndGetRetainedMessage.
Namespace: Amazon.IotData
Assembly: AWSSDK.IotData.dll
Version: 3.x.y.z
public abstract Task<GetRetainedMessageResponse> GetRetainedMessageAsync( GetRetainedMessageRequest request, CancellationToken cancellationToken )
Container for the necessary parameters to execute the GetRetainedMessage service method.
A cancellation token that can be used by other objects or threads to receive notice of cancellation.
| Exception | Condition |
|---|---|
| InternalFailureException | An unexpected error has occurred. |
| InvalidRequestException | The request is not valid. |
| MethodNotAllowedException | The specified combination of HTTP verb and URI is not supported. |
| ResourceNotFoundException | The specified resource does not exist. |
| ServiceUnavailableException | The service is temporarily unavailable. |
| ThrottlingException | The rate exceeds the limit. |
| UnauthorizedException | You are not authorized to perform this operation. |
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer