mq/aws.sdk.kotlin.services.mq/MqClient

MqClient

Amazon MQ is a managed message broker service for Apache ActiveMQ and RabbitMQ 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.

Types

Builder

class Builder : AbstractSdkClientBuilder<MqClient.Config, MqClient.Config.Builder, MqClient>

Companion

object Companion : AbstractAwsSdkClientFactory<MqClient.Config, MqClient.Config.Builder, MqClient, MqClient.Builder>

Config

class Config : AwsSdkClientConfig, CredentialsProviderConfig, HttpAuthConfig, HttpClientConfig, HttpEngineConfig, IdempotencyTokenConfig, RetryClientConfig, RetryStrategyClientConfig, SdkClientConfig, TelemetryConfig

Properties

config

abstract override val config: MqClient.Config

MqClient's configuration

Functions

createBroker

abstract suspend fun createBroker(input: CreateBrokerRequest): CreateBrokerResponse

Creates a broker. Note: This API is asynchronous.

createConfiguration

abstract suspend fun createConfiguration(input: CreateConfigurationRequest): CreateConfigurationResponse

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

createTags

abstract suspend fun createTags(input: CreateTagsRequest): CreateTagsResponse

Add a tag to a resource.

createUser

abstract suspend fun createUser(input: CreateUserRequest): CreateUserResponse

Creates an ActiveMQ user.

deleteBroker

abstract suspend fun deleteBroker(input: DeleteBrokerRequest): DeleteBrokerResponse

Deletes a broker. Note: This API is asynchronous.

deleteConfiguration

abstract suspend fun deleteConfiguration(input: DeleteConfigurationRequest): DeleteConfigurationResponse

Deletes the specified configuration.

deleteTags

abstract suspend fun deleteTags(input: DeleteTagsRequest): DeleteTagsResponse

Removes a tag from a resource.

deleteUser

abstract suspend fun deleteUser(input: DeleteUserRequest): DeleteUserResponse

Deletes an ActiveMQ user.

describeBroker

abstract suspend fun describeBroker(input: DescribeBrokerRequest): DescribeBrokerResponse

Returns information about the specified broker.

describeBrokerEngineTypes

abstract suspend fun describeBrokerEngineTypes(input: DescribeBrokerEngineTypesRequest = DescribeBrokerEngineTypesRequest { }): DescribeBrokerEngineTypesResponse

Describe available engine types and versions.

describeBrokerInstanceOptions

abstract suspend fun describeBrokerInstanceOptions(input: DescribeBrokerInstanceOptionsRequest = DescribeBrokerInstanceOptionsRequest { }): DescribeBrokerInstanceOptionsResponse

Describe available broker instance options.

describeConfiguration

abstract suspend fun describeConfiguration(input: DescribeConfigurationRequest): DescribeConfigurationResponse

Returns information about the specified configuration.

describeConfigurationRevision

abstract suspend fun describeConfigurationRevision(input: DescribeConfigurationRevisionRequest): DescribeConfigurationRevisionResponse

Returns the specified configuration revision for the specified configuration.

describeUser

abstract suspend fun describeUser(input: DescribeUserRequest): DescribeUserResponse

Returns information about an ActiveMQ user.

listBrokers

abstract suspend fun listBrokers(input: ListBrokersRequest = ListBrokersRequest { }): ListBrokersResponse

Returns a list of all brokers.

listConfigurationRevisions

abstract suspend fun listConfigurationRevisions(input: ListConfigurationRevisionsRequest): ListConfigurationRevisionsResponse

Returns a list of all revisions for the specified configuration.

listConfigurations

abstract suspend fun listConfigurations(input: ListConfigurationsRequest = ListConfigurationsRequest { }): ListConfigurationsResponse

Returns a list of all configurations.

listTags

abstract suspend fun listTags(input: ListTagsRequest): ListTagsResponse

Lists tags for a resource.

listUsers

abstract suspend fun listUsers(input: ListUsersRequest): ListUsersResponse

Returns a list of all ActiveMQ users.

promote

abstract suspend fun promote(input: PromoteRequest): PromoteResponse

Promotes a data replication replica broker to the primary broker role.

rebootBroker

abstract suspend fun rebootBroker(input: RebootBrokerRequest): RebootBrokerResponse

Reboots a broker. Note: This API is asynchronous.

updateBroker

abstract suspend fun updateBroker(input: UpdateBrokerRequest): UpdateBrokerResponse

Adds a pending configuration change to a broker.

updateConfiguration

abstract suspend fun updateConfiguration(input: UpdateConfigurationRequest): UpdateConfigurationResponse

Updates the specified configuration.

updateUser

abstract suspend fun updateUser(input: UpdateUserRequest): UpdateUserResponse

Updates the information for an ActiveMQ user.

Inherited functions

expect abstract fun close()

createBroker

inline suspend fun MqClient.createBroker(crossinline block: CreateBrokerRequest.Builder.() -> Unit): CreateBrokerResponse

Creates a broker. Note: This API is asynchronous.

createConfiguration

inline suspend fun MqClient.createConfiguration(crossinline block: CreateConfigurationRequest.Builder.() -> Unit): CreateConfigurationResponse

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

createTags

inline suspend fun MqClient.createTags(crossinline block: CreateTagsRequest.Builder.() -> Unit): CreateTagsResponse

Add a tag to a resource.

createUser

inline suspend fun MqClient.createUser(crossinline block: CreateUserRequest.Builder.() -> Unit): CreateUserResponse

Creates an ActiveMQ user.

deleteBroker

inline suspend fun MqClient.deleteBroker(crossinline block: DeleteBrokerRequest.Builder.() -> Unit): DeleteBrokerResponse

Deletes a broker. Note: This API is asynchronous.

deleteConfiguration

inline suspend fun MqClient.deleteConfiguration(crossinline block: DeleteConfigurationRequest.Builder.() -> Unit): DeleteConfigurationResponse

Deletes the specified configuration.

deleteTags

inline suspend fun MqClient.deleteTags(crossinline block: DeleteTagsRequest.Builder.() -> Unit): DeleteTagsResponse

Removes a tag from a resource.

deleteUser

inline suspend fun MqClient.deleteUser(crossinline block: DeleteUserRequest.Builder.() -> Unit): DeleteUserResponse

Deletes an ActiveMQ user.

describeBroker

inline suspend fun MqClient.describeBroker(crossinline block: DescribeBrokerRequest.Builder.() -> Unit): DescribeBrokerResponse

Returns information about the specified broker.

describeBrokerEngineTypes

inline suspend fun MqClient.describeBrokerEngineTypes(crossinline block: DescribeBrokerEngineTypesRequest.Builder.() -> Unit): DescribeBrokerEngineTypesResponse

Describe available engine types and versions.

describeBrokerInstanceOptions

inline suspend fun MqClient.describeBrokerInstanceOptions(crossinline block: DescribeBrokerInstanceOptionsRequest.Builder.() -> Unit): DescribeBrokerInstanceOptionsResponse

Describe available broker instance options.

describeConfiguration

inline suspend fun MqClient.describeConfiguration(crossinline block: DescribeConfigurationRequest.Builder.() -> Unit): DescribeConfigurationResponse

Returns information about the specified configuration.

describeConfigurationRevision

inline suspend fun MqClient.describeConfigurationRevision(crossinline block: DescribeConfigurationRevisionRequest.Builder.() -> Unit): DescribeConfigurationRevisionResponse

Returns the specified configuration revision for the specified configuration.

describeUser

inline suspend fun MqClient.describeUser(crossinline block: DescribeUserRequest.Builder.() -> Unit): DescribeUserResponse

Returns information about an ActiveMQ user.

listBrokers

inline suspend fun MqClient.listBrokers(crossinline block: ListBrokersRequest.Builder.() -> Unit): ListBrokersResponse

Returns a list of all brokers.

listBrokersPaginated

fun MqClient.listBrokersPaginated(initialRequest: ListBrokersRequest = ListBrokersRequest { }): Flow<ListBrokersResponse>

fun MqClient.listBrokersPaginated(block: ListBrokersRequest.Builder.() -> Unit): Flow<ListBrokersResponse>

Paginate over ListBrokersResponse results.

listConfigurationRevisions

inline suspend fun MqClient.listConfigurationRevisions(crossinline block: ListConfigurationRevisionsRequest.Builder.() -> Unit): ListConfigurationRevisionsResponse

Returns a list of all revisions for the specified configuration.

listConfigurations

inline suspend fun MqClient.listConfigurations(crossinline block: ListConfigurationsRequest.Builder.() -> Unit): ListConfigurationsResponse

Returns a list of all configurations.

listTags

inline suspend fun MqClient.listTags(crossinline block: ListTagsRequest.Builder.() -> Unit): ListTagsResponse

Lists tags for a resource.

listUsers

inline suspend fun MqClient.listUsers(crossinline block: ListUsersRequest.Builder.() -> Unit): ListUsersResponse

Returns a list of all ActiveMQ users.

promote

inline suspend fun MqClient.promote(crossinline block: PromoteRequest.Builder.() -> Unit): PromoteResponse

Promotes a data replication replica broker to the primary broker role.

rebootBroker

inline suspend fun MqClient.rebootBroker(crossinline block: RebootBrokerRequest.Builder.() -> Unit): RebootBrokerResponse

Reboots a broker. Note: This API is asynchronous.

updateBroker

inline suspend fun MqClient.updateBroker(crossinline block: UpdateBrokerRequest.Builder.() -> Unit): UpdateBrokerResponse

Adds a pending configuration change to a broker.

updateConfiguration

inline suspend fun MqClient.updateConfiguration(crossinline block: UpdateConfigurationRequest.Builder.() -> Unit): UpdateConfigurationResponse

Updates the specified configuration.

updateUser

inline suspend fun MqClient.updateUser(crossinline block: UpdateUserRequest.Builder.() -> Unit): UpdateUserResponse

Updates the information for an ActiveMQ user.

withConfig

fun MqClient.withConfig(block: MqClient.Config.Builder.() -> Unit): MqClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.