Example #1
0
        /// <summary>
        /// Lists summary information about the retained messages stored for the account.
        ///
        ///
        /// <para>
        /// 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.
        /// </para>
        ///
        /// <para>
        /// To get the message payload of a retained message, call <a href="https://docs.aws.amazon.com/iot/latest/developerguide/API_iotdata_GetRetainedMessage.html">GetRetainedMessage</a>
        /// with the topic name of the retained message.
        /// </para>
        ///
        /// <para>
        /// Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiotfleethubfordevicemanagement.html#awsiotfleethubfordevicemanagement-actions-as-permissions">ListRetainedMessages</a>
        /// action.
        /// </para>
        ///
        /// <para>
        /// For more information about messaging costs, see <a href="http://aws.amazon.com/iot-core/pricing/#Messaging">Amazon
        /// Web Services IoT Core pricing - Messaging</a>.
        /// </para>
        /// </summary>
        /// <param name="request">Container for the necessary parameters to execute the ListRetainedMessages service method.</param>
        ///
        /// <returns>The response from the ListRetainedMessages service method, as returned by IotData.</returns>
        /// <exception cref="Amazon.IotData.Model.InternalFailureException">
        /// An unexpected error has occurred.
        /// </exception>
        /// <exception cref="Amazon.IotData.Model.InvalidRequestException">
        /// The request is not valid.
        /// </exception>
        /// <exception cref="Amazon.IotData.Model.MethodNotAllowedException">
        /// The specified combination of HTTP verb and URI is not supported.
        /// </exception>
        /// <exception cref="Amazon.IotData.Model.ServiceUnavailableException">
        /// The service is temporarily unavailable.
        /// </exception>
        /// <exception cref="Amazon.IotData.Model.ThrottlingException">
        /// The rate exceeds the limit.
        /// </exception>
        /// <exception cref="Amazon.IotData.Model.UnauthorizedException">
        /// You are not authorized to perform this operation.
        /// </exception>
        /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/iot-data-2015-05-28/ListRetainedMessages">REST API Reference for ListRetainedMessages Operation</seealso>
        public virtual ListRetainedMessagesResponse ListRetainedMessages(ListRetainedMessagesRequest request)
        {
            var options = new InvokeOptions();

            options.RequestMarshaller    = ListRetainedMessagesRequestMarshaller.Instance;
            options.ResponseUnmarshaller = ListRetainedMessagesResponseUnmarshaller.Instance;

            return(Invoke <ListRetainedMessagesResponse>(request, options));
        }
Example #2
0
        /// <summary>
        /// Initiates the asynchronous execution of the ListRetainedMessages operation.
        /// </summary>
        ///
        /// <param name="request">Container for the necessary parameters to execute the ListRetainedMessages operation on AmazonIotDataClient.</param>
        /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param>
        /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
        ///          procedure using the AsyncState property.</param>
        ///
        /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListRetainedMessages
        ///         operation.</returns>
        /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/iot-data-2015-05-28/ListRetainedMessages">REST API Reference for ListRetainedMessages Operation</seealso>
        public virtual IAsyncResult BeginListRetainedMessages(ListRetainedMessagesRequest request, AsyncCallback callback, object state)
        {
            var options = new InvokeOptions();

            options.RequestMarshaller    = ListRetainedMessagesRequestMarshaller.Instance;
            options.ResponseUnmarshaller = ListRetainedMessagesResponseUnmarshaller.Instance;

            return(BeginInvoke(request, options, callback, state));
        }
Example #3
0
        /// <summary>
        /// Lists summary information about the retained messages stored for the account.
        ///
        ///
        /// <para>
        /// 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.
        /// </para>
        ///
        /// <para>
        /// To get the message payload of a retained message, call <a href="https://docs.aws.amazon.com/iot/latest/developerguide/API_iotdata_GetRetainedMessage.html">GetRetainedMessage</a>
        /// with the topic name of the retained message.
        /// </para>
        ///
        /// <para>
        /// Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiotfleethubfordevicemanagement.html#awsiotfleethubfordevicemanagement-actions-as-permissions">ListRetainedMessages</a>
        /// action.
        /// </para>
        ///
        /// <para>
        /// For more information about messaging costs, see <a href="http://aws.amazon.com/iot-core/pricing/#Messaging">IoT
        /// Core pricing - Messaging</a>.
        /// </para>
        /// </summary>
        /// <param name="request">Container for the necessary parameters to execute the ListRetainedMessages service method.</param>
        /// <param name="cancellationToken">
        ///     A cancellation token that can be used by other objects or threads to receive notice of cancellation.
        /// </param>
        ///
        /// <returns>The response from the ListRetainedMessages service method, as returned by IotData.</returns>
        /// <exception cref="Amazon.IotData.Model.InternalFailureException">
        /// An unexpected error has occurred.
        /// </exception>
        /// <exception cref="Amazon.IotData.Model.InvalidRequestException">
        /// The request is not valid.
        /// </exception>
        /// <exception cref="Amazon.IotData.Model.MethodNotAllowedException">
        /// The specified combination of HTTP verb and URI is not supported.
        /// </exception>
        /// <exception cref="Amazon.IotData.Model.ServiceUnavailableException">
        /// The service is temporarily unavailable.
        /// </exception>
        /// <exception cref="Amazon.IotData.Model.ThrottlingException">
        /// The rate exceeds the limit.
        /// </exception>
        /// <exception cref="Amazon.IotData.Model.UnauthorizedException">
        /// You are not authorized to perform this operation.
        /// </exception>
        /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/iot-data-2015-05-28/ListRetainedMessages">REST API Reference for ListRetainedMessages Operation</seealso>
        public virtual Task <ListRetainedMessagesResponse> ListRetainedMessagesAsync(ListRetainedMessagesRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
        {
            var options = new InvokeOptions();

            options.RequestMarshaller    = ListRetainedMessagesRequestMarshaller.Instance;
            options.ResponseUnmarshaller = ListRetainedMessagesResponseUnmarshaller.Instance;

            return(InvokeAsync <ListRetainedMessagesResponse>(request, options, cancellationToken));
        }