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.

Implementation for accessing MQ Amazon MQ is a managed message broker service for Apache ActiveMQ that makes it easy to set up and operate message brokers in the cloud. A message broker allows software applications and components to communicate using various programming languages, operating systems, and formal messaging protocols.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonServiceClient
    Amazon.MQ.AmazonMQClient

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

Syntax

C#
public class AmazonMQClient : AmazonServiceClient
         IAmazonMQ, IAmazonService, IDisposable

The AmazonMQClient type exposes the following members

Constructors

NameDescription
Public Method AmazonMQClient()

Constructs AmazonMQClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonMQClient(RegionEndpoint)

Constructs AmazonMQClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonMQClient(AmazonMQConfig)

Constructs AmazonMQClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonMQClient(AWSCredentials)

Constructs AmazonMQClient with AWS Credentials

Public Method AmazonMQClient(AWSCredentials, RegionEndpoint)

Constructs AmazonMQClient with AWS Credentials

Public Method AmazonMQClient(AWSCredentials, AmazonMQConfig)

Constructs AmazonMQClient with AWS Credentials and an AmazonMQClient Configuration object.

Public Method AmazonMQClient(string, string)

Constructs AmazonMQClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonMQClient(string, string, RegionEndpoint)

Constructs AmazonMQClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonMQClient(string, string, AmazonMQConfig)

Constructs AmazonMQClient with AWS Access Key ID, AWS Secret Key and an AmazonMQClient Configuration object.

Public Method AmazonMQClient(string, string, string)

Constructs AmazonMQClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonMQClient(string, string, string, RegionEndpoint)

Constructs AmazonMQClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonMQClient(string, string, string, AmazonMQConfig)

Constructs AmazonMQClient with AWS Access Key ID, AWS Secret Key and an AmazonMQClient Configuration object.

Properties

NameTypeDescription
Public Property Config Amazon.Runtime.IClientConfig Inherited from Amazon.Runtime.AmazonServiceClient.

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

NameDescription
Public Method CreateBroker(CreateBrokerRequest)

Creates a broker. Note: This API is asynchronous.

Public Method CreateBrokerAsync(CreateBrokerRequest, CancellationToken)

Initiates the asynchronous execution of the CreateBroker operation.

Public Method CreateConfiguration(CreateConfigurationRequest)

Creates a new configuration for the specified configuration name. Amazon MQ uses the default configuration (the engine type and version).

Public Method CreateConfigurationAsync(CreateConfigurationRequest, CancellationToken)

Initiates the asynchronous execution of the CreateConfiguration operation.

Public Method CreateUser(CreateUserRequest)

Creates an ActiveMQ user.

Public Method CreateUserAsync(CreateUserRequest, CancellationToken)

Initiates the asynchronous execution of the CreateUser operation.

Public Method DeleteBroker(DeleteBrokerRequest)

Deletes a broker. Note: This API is asynchronous.

Public Method DeleteBrokerAsync(DeleteBrokerRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteBroker operation.

Public Method DeleteUser(DeleteUserRequest)

Deletes an ActiveMQ user.

Public Method DeleteUserAsync(DeleteUserRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteUser operation.

Public Method DescribeBroker(DescribeBrokerRequest)

Returns information about the specified broker.

Public Method DescribeBrokerAsync(DescribeBrokerRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeBroker operation.

Public Method DescribeConfiguration(DescribeConfigurationRequest)

Returns information about the specified configuration.

Public Method DescribeConfigurationAsync(DescribeConfigurationRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeConfiguration operation.

Public Method DescribeConfigurationRevision(DescribeConfigurationRevisionRequest)

Returns the specified configuration revision for the specified configuration.

Public Method DescribeConfigurationRevisionAsync(DescribeConfigurationRevisionRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeConfigurationRevision operation.

Public Method DescribeUser(DescribeUserRequest)

Returns information about an ActiveMQ user.

Public Method DescribeUserAsync(DescribeUserRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeUser operation.

Public Method Dispose() Inherited from Amazon.Runtime.AmazonServiceClient.
Public Method ListBrokers(ListBrokersRequest)

Returns a list of all brokers.

Public Method ListBrokersAsync(ListBrokersRequest, CancellationToken)

Initiates the asynchronous execution of the ListBrokers operation.

Public Method ListConfigurationRevisions(ListConfigurationRevisionsRequest)

Returns a list of all revisions for the specified configuration.

Public Method ListConfigurationRevisionsAsync(ListConfigurationRevisionsRequest, CancellationToken)

Initiates the asynchronous execution of the ListConfigurationRevisions operation.

Public Method ListConfigurations(ListConfigurationsRequest)

Returns a list of all configurations.

Public Method ListConfigurationsAsync(ListConfigurationsRequest, CancellationToken)

Initiates the asynchronous execution of the ListConfigurations operation.

Public Method ListUsers(ListUsersRequest)

Returns a list of all ActiveMQ users.

Public Method ListUsersAsync(ListUsersRequest, CancellationToken)

Initiates the asynchronous execution of the ListUsers operation.

Public Method RebootBroker(RebootBrokerRequest)

Reboots a broker. Note: This API is asynchronous.

Public Method RebootBrokerAsync(RebootBrokerRequest, CancellationToken)

Initiates the asynchronous execution of the RebootBroker operation.

Public Method UpdateBroker(UpdateBrokerRequest)

Adds a pending configuration change to a broker.

Public Method UpdateBrokerAsync(UpdateBrokerRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateBroker operation.

Public Method UpdateConfiguration(UpdateConfigurationRequest)

Updates the specified configuration.

Public Method UpdateConfigurationAsync(UpdateConfigurationRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateConfiguration operation.

Public Method UpdateUser(UpdateUserRequest)

Updates the information for an ActiveMQ user.

Public Method UpdateUserAsync(UpdateUserRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateUser operation.

Events

NameDescription
Event AfterResponseEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event BeforeRequestEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event ExceptionEvent Inherited from Amazon.Runtime.AmazonServiceClient.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms