MQ

public struct MQ

Client object for interacting with AWS MQ service.

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.

Member variables

client
Undocumented
Declaration
Swift

public let client: AWSClient

Initialization


                    
                    
                    init(accessKeyId:secretAccessKey:sessionToken:region:endpoint:middlewares:eventLoopGroupProvider:)

Initialize the MQ client

Declaration

Swift

public init(accessKeyId: String? = nil, secretAccessKey: String? = nil, sessionToken: String? = nil, region: AWSSDKSwiftCore.Region? = nil, endpoint: String? = nil, middlewares: [AWSServiceMiddleware] = [], eventLoopGroupProvider: AWSClient.EventLoopGroupProvider = .useAWSClientShared)

Parameters

`accessKeyId`	Public access key provided by AWS
`secretAccessKey`	Private access key provided by AWS
`sessionToken`	Token provided by STS.AssumeRole() which allows access to another AWS account
`region`	Region of server you want to communicate with
`endpoint`	Custom endpoint URL to use instead of standard AWS servers
`middlewares`	Array of middlewares to apply to requests and responses
`eventLoopGroupProvider`	EventLoopGroup to use. Use `useAWSClientShared` if the client shall manage its own EventLoopGroup.

API Calls


                    
                    
                    createBroker(_:)

Creates a broker. Note: This API is asynchronous.

Declaration

Swift

public func createBroker(_ input: CreateBrokerRequest) -> EventLoopFuture<CreateBrokerResponse>

createConfiguration(_:)
Creates a new configuration for the specified configuration name. Amazon MQ uses the default configuration (the engine type and version).
Declaration
Swift

public func createConfiguration(_ input: CreateConfigurationRequest) -> EventLoopFuture<CreateConfigurationResponse>


                    
                    
                    createTags(_:)

Add a tag to a resource.

Declaration

Swift

@discardableResult
public func createTags(_ input: CreateTagsRequest) -> EventLoopFuture<Void>


                    
                    
                    createUser(_:)

Creates an ActiveMQ user.

Declaration

Swift

public func createUser(_ input: CreateUserRequest) -> EventLoopFuture<CreateUserResponse>


                    
                    
                    deleteBroker(_:)

Deletes a broker. Note: This API is asynchronous.

Declaration

Swift

public func deleteBroker(_ input: DeleteBrokerRequest) -> EventLoopFuture<DeleteBrokerResponse>


                    
                    
                    deleteTags(_:)

Removes a tag from a resource.

Declaration

Swift

@discardableResult
public func deleteTags(_ input: DeleteTagsRequest) -> EventLoopFuture<Void>


                    
                    
                    deleteUser(_:)

Deletes an ActiveMQ user.

Declaration

Swift

public func deleteUser(_ input: DeleteUserRequest) -> EventLoopFuture<DeleteUserResponse>


                    
                    
                    describeBroker(_:)

Returns information about the specified broker.

Declaration

Swift

public func describeBroker(_ input: DescribeBrokerRequest) -> EventLoopFuture<DescribeBrokerResponse>


                    
                    
                    describeBrokerEngineTypes(_:)

Describe available engine types and versions.

Declaration

Swift

public func describeBrokerEngineTypes(_ input: DescribeBrokerEngineTypesRequest) -> EventLoopFuture<DescribeBrokerEngineTypesResponse>


                    
                    
                    describeBrokerInstanceOptions(_:)

Describe available broker instance options.

Declaration

Swift

public func describeBrokerInstanceOptions(_ input: DescribeBrokerInstanceOptionsRequest) -> EventLoopFuture<DescribeBrokerInstanceOptionsResponse>


                    
                    
                    describeConfiguration(_:)

Returns information about the specified configuration.

Declaration

Swift

public func describeConfiguration(_ input: DescribeConfigurationRequest) -> EventLoopFuture<DescribeConfigurationResponse>


                    
                    
                    describeConfigurationRevision(_:)

Returns the specified configuration revision for the specified configuration.

Declaration

Swift

public func describeConfigurationRevision(_ input: DescribeConfigurationRevisionRequest) -> EventLoopFuture<DescribeConfigurationRevisionResponse>


                    
                    
                    describeUser(_:)

Returns information about an ActiveMQ user.

Declaration

Swift

public func describeUser(_ input: DescribeUserRequest) -> EventLoopFuture<DescribeUserResponse>


                    
                    
                    listBrokers(_:)

Returns a list of all brokers.

Declaration

Swift

public func listBrokers(_ input: ListBrokersRequest) -> EventLoopFuture<ListBrokersResponse>


                    
                    
                    listConfigurationRevisions(_:)

Returns a list of all revisions for the specified configuration.

Declaration

Swift

public func listConfigurationRevisions(_ input: ListConfigurationRevisionsRequest) -> EventLoopFuture<ListConfigurationRevisionsResponse>


                    
                    
                    listConfigurations(_:)

Returns a list of all configurations.

Declaration

Swift

public func listConfigurations(_ input: ListConfigurationsRequest) -> EventLoopFuture<ListConfigurationsResponse>


                    
                    
                    listTags(_:)

Lists tags for a resource.

Declaration

Swift

public func listTags(_ input: ListTagsRequest) -> EventLoopFuture<ListTagsResponse>


                    
                    
                    listUsers(_:)

Returns a list of all ActiveMQ users.

Declaration

Swift

public func listUsers(_ input: ListUsersRequest) -> EventLoopFuture<ListUsersResponse>


                    
                    
                    rebootBroker(_:)

Reboots a broker. Note: This API is asynchronous.

Declaration

Swift

public func rebootBroker(_ input: RebootBrokerRequest) -> EventLoopFuture<RebootBrokerResponse>


                    
                    
                    updateBroker(_:)

Adds a pending configuration change to a broker.

Declaration

Swift

public func updateBroker(_ input: UpdateBrokerRequest) -> EventLoopFuture<UpdateBrokerResponse>


                    
                    
                    updateConfiguration(_:)

Updates the specified configuration.

Declaration

Swift

public func updateConfiguration(_ input: UpdateConfigurationRequest) -> EventLoopFuture<UpdateConfigurationResponse>


                    
                    
                    updateUser(_:)

Updates the information for an ActiveMQ user.

Declaration

Swift

public func updateUser(_ input: UpdateUserRequest) -> EventLoopFuture<UpdateUserResponse>

Paginators


                    
                    
                    listBrokersPaginator(_:onPage:)

Returns a list of all brokers.

Declaration

Swift

public func listBrokersPaginator(_ input: ListBrokersRequest, onPage: @escaping (ListBrokersResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>

Shapes


                    
                    
                    ListBrokersRequest

Undocumented

Declaration

Swift

public struct ListBrokersRequest : AWSShape

extension MQ.ListBrokersRequest: AWSPaginateStringToken

AvailabilityZone
Undocumented
See more
Declaration
Swift

public struct AvailabilityZone : AWSShape
BrokerEngineType
Undocumented
See more
Declaration
Swift

public struct BrokerEngineType : AWSShape
BrokerInstance
Undocumented
See more
Declaration
Swift

public struct BrokerInstance : AWSShape
BrokerInstanceOption
Undocumented
See more
Declaration
Swift

public struct BrokerInstanceOption : AWSShape
BrokerSummary
Undocumented
See more
Declaration
Swift

public struct BrokerSummary : AWSShape
Configuration
Undocumented
See more
Declaration
Swift

public struct Configuration : AWSShape
ConfigurationId
Undocumented
See more
Declaration
Swift

public struct ConfigurationId : AWSShape
ConfigurationRevision
Undocumented
See more
Declaration
Swift

public struct ConfigurationRevision : AWSShape
Configurations
Undocumented
See more
Declaration
Swift

public struct Configurations : AWSShape
CreateBrokerRequest
Undocumented
See more
Declaration
Swift

public struct CreateBrokerRequest : AWSShape
CreateBrokerResponse
Undocumented
See more
Declaration
Swift

public struct CreateBrokerResponse : AWSShape
CreateConfigurationRequest
Undocumented
See more
Declaration
Swift

public struct CreateConfigurationRequest : AWSShape
CreateConfigurationResponse
Undocumented
See more
Declaration
Swift

public struct CreateConfigurationResponse : AWSShape
CreateTagsRequest
Undocumented
See more
Declaration
Swift

public struct CreateTagsRequest : AWSShape
CreateUserRequest
Undocumented
See more
Declaration
Swift

public struct CreateUserRequest : AWSShape
CreateUserResponse
Undocumented
See more
Declaration
Swift

public struct CreateUserResponse : AWSShape
DeleteBrokerRequest
Undocumented
See more
Declaration
Swift

public struct DeleteBrokerRequest : AWSShape
DeleteBrokerResponse
Undocumented
See more
Declaration
Swift

public struct DeleteBrokerResponse : AWSShape
DeleteTagsRequest
Undocumented
See more
Declaration
Swift

public struct DeleteTagsRequest : AWSShape
DeleteUserRequest
Undocumented
See more
Declaration
Swift

public struct DeleteUserRequest : AWSShape
DeleteUserResponse
Undocumented
See more
Declaration
Swift

public struct DeleteUserResponse : AWSShape
DescribeBrokerEngineTypesRequest
Undocumented
See more
Declaration
Swift

public struct DescribeBrokerEngineTypesRequest : AWSShape
DescribeBrokerEngineTypesResponse
Undocumented
See more
Declaration
Swift

public struct DescribeBrokerEngineTypesResponse : AWSShape
DescribeBrokerInstanceOptionsRequest
Undocumented
See more
Declaration
Swift

public struct DescribeBrokerInstanceOptionsRequest : AWSShape
DescribeBrokerInstanceOptionsResponse
Undocumented
See more
Declaration
Swift

public struct DescribeBrokerInstanceOptionsResponse : AWSShape
DescribeBrokerRequest
Undocumented
See more
Declaration
Swift

public struct DescribeBrokerRequest : AWSShape
DescribeBrokerResponse
Undocumented
See more
Declaration
Swift

public struct DescribeBrokerResponse : AWSShape
DescribeConfigurationRequest
Undocumented
See more
Declaration
Swift

public struct DescribeConfigurationRequest : AWSShape
DescribeConfigurationResponse
Undocumented
See more
Declaration
Swift

public struct DescribeConfigurationResponse : AWSShape
DescribeConfigurationRevisionRequest
Undocumented
See more
Declaration
Swift

public struct DescribeConfigurationRevisionRequest : AWSShape
DescribeConfigurationRevisionResponse
Undocumented
See more
Declaration
Swift

public struct DescribeConfigurationRevisionResponse : AWSShape
DescribeUserRequest
Undocumented
See more
Declaration
Swift

public struct DescribeUserRequest : AWSShape
DescribeUserResponse
Undocumented
See more
Declaration
Swift

public struct DescribeUserResponse : AWSShape
EncryptionOptions
Undocumented
See more
Declaration
Swift

public struct EncryptionOptions : AWSShape
EngineVersion
Undocumented
See more
Declaration
Swift

public struct EngineVersion : AWSShape
LdapServerMetadataInput
Undocumented
See more
Declaration
Swift

public struct LdapServerMetadataInput : AWSShape
LdapServerMetadataOutput
Undocumented
See more
Declaration
Swift

public struct LdapServerMetadataOutput : AWSShape
ListBrokersResponse
Undocumented
See more
Declaration
Swift

public struct ListBrokersResponse : AWSShape
ListConfigurationRevisionsRequest
Undocumented
See more
Declaration
Swift

public struct ListConfigurationRevisionsRequest : AWSShape
ListConfigurationRevisionsResponse
Undocumented
See more
Declaration
Swift

public struct ListConfigurationRevisionsResponse : AWSShape
ListConfigurationsRequest
Undocumented
See more
Declaration
Swift

public struct ListConfigurationsRequest : AWSShape
ListConfigurationsResponse
Undocumented
See more
Declaration
Swift

public struct ListConfigurationsResponse : AWSShape
ListTagsRequest
Undocumented
See more
Declaration
Swift

public struct ListTagsRequest : AWSShape
ListTagsResponse
Undocumented
See more
Declaration
Swift

public struct ListTagsResponse : AWSShape
ListUsersRequest
Undocumented
See more
Declaration
Swift

public struct ListUsersRequest : AWSShape
ListUsersResponse
Undocumented
See more
Declaration
Swift

public struct ListUsersResponse : AWSShape
Logs
Undocumented
See more
Declaration
Swift

public struct Logs : AWSShape
LogsSummary
Undocumented
See more
Declaration
Swift

public struct LogsSummary : AWSShape
PendingLogs
Undocumented
See more
Declaration
Swift

public struct PendingLogs : AWSShape
RebootBrokerRequest
Undocumented
See more
Declaration
Swift

public struct RebootBrokerRequest : AWSShape
RebootBrokerResponse
Undocumented
See more
Declaration
Swift

public struct RebootBrokerResponse : AWSShape
SanitizationWarning
Undocumented
See more
Declaration
Swift

public struct SanitizationWarning : AWSShape
UpdateBrokerRequest
Undocumented
See more
Declaration
Swift

public struct UpdateBrokerRequest : AWSShape
UpdateBrokerResponse
Undocumented
See more
Declaration
Swift

public struct UpdateBrokerResponse : AWSShape
UpdateConfigurationRequest
Undocumented
See more
Declaration
Swift

public struct UpdateConfigurationRequest : AWSShape
UpdateConfigurationResponse
Undocumented
See more
Declaration
Swift

public struct UpdateConfigurationResponse : AWSShape
UpdateUserRequest
Undocumented
See more
Declaration
Swift

public struct UpdateUserRequest : AWSShape
UpdateUserResponse
Undocumented
See more
Declaration
Swift

public struct UpdateUserResponse : AWSShape
User
Undocumented
See more
Declaration
Swift

public struct User : AWSShape
UserPendingChanges
Undocumented
See more
Declaration
Swift

public struct UserPendingChanges : AWSShape
UserSummary
Undocumented
See more
Declaration
Swift

public struct UserSummary : AWSShape
WeeklyStartTime
Undocumented
See more
Declaration
Swift

public struct WeeklyStartTime : AWSShape

Enums


                    
                    
                    AuthenticationStrategy

Undocumented

Declaration

Swift

public enum AuthenticationStrategy : String, CustomStringConvertible, Codable


                    
                    
                    BrokerState

Undocumented

Declaration

Swift

public enum BrokerState : String, CustomStringConvertible, Codable


                    
                    
                    BrokerStorageType

Undocumented

Declaration

Swift

public enum BrokerStorageType : String, CustomStringConvertible, Codable


                    
                    
                    ChangeType

Undocumented

Declaration

Swift

public enum ChangeType : String, CustomStringConvertible, Codable


                    
                    
                    DayOfWeek

Undocumented

Declaration

Swift

public enum DayOfWeek : String, CustomStringConvertible, Codable


                    
                    
                    DeploymentMode

Undocumented

Declaration

Swift

public enum DeploymentMode : String, CustomStringConvertible, Codable


                    
                    
                    EngineType

Undocumented

Declaration

Swift

public enum EngineType : String, CustomStringConvertible, Codable


                    
                    
                    SanitizationWarningReason

Undocumented

Declaration

Swift

public enum SanitizationWarningReason : String, CustomStringConvertible, Codable