AWS SDK Version 3 for .NET
API Reference

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.

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to GetRetainedMessageAsync.

Namespace: Amazon.IotData
Assembly: AWSSDK.IotData.dll
Version: 3.x.y.z

Syntax

C#
public virtual GetRetainedMessageResponse GetRetainedMessage(
         GetRetainedMessageRequest request
)

Parameters

request
Type: Amazon.IotData.Model.GetRetainedMessageRequest

Container for the necessary parameters to execute the GetRetainedMessage service method.

Return Value


The response from the GetRetainedMessage service method, as returned by IotData.

Exceptions

ExceptionCondition
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.

Version Information

.NET Framework:
Supported in: 4.5 and newer, 3.5

See Also