5.0.0 • Published 7 years ago
@datafire/amazonaws_mq v5.0.0
@datafire/amazonaws_mq
Client library for AmazonMQ
Installation and Usage
npm install --save @datafire/amazonaws_mq
let amazonaws_mq = require('@datafire/amazonaws_mq').create({
accessKeyId: "",
secretAccessKey: "",
region: ""
});
amazonaws_mq.ListBrokers({}).then(data => {
console.log(data);
});
Description
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.
Actions
ListBrokers
amazonaws_mq.ListBrokers({}, context)
Input
- input
object
Output
- output ListBrokersResponse
CreateBroker
amazonaws_mq.CreateBroker({}, context)
Input
- input
object
- AutoMinorVersionUpgrade __boolean
- BrokerName __string
- Configuration ConfigurationId
- CreatorRequestId __string
- DeploymentMode DeploymentMode
- EngineType EngineType
- EngineVersion __string
- HostInstanceType __string
- MaintenanceWindowStartTime WeeklyStartTime
- PubliclyAccessible __boolean
- SecurityGroups ListOf__string
- SubnetIds ListOf__string
- Users ListOfUser
Output
- output CreateBrokerResponse
DeleteBroker
amazonaws_mq.DeleteBroker({
"broker-id": ""
}, context)
Input
- input
object
- broker-id required
string
- broker-id required
Output
- output DeleteBrokerResponse
DescribeBroker
amazonaws_mq.DescribeBroker({
"broker-id": ""
}, context)
Input
- input
object
- broker-id required
string
- broker-id required
Output
- output DescribeBrokerResponse
UpdateBroker
amazonaws_mq.UpdateBroker({
"broker-id": ""
}, context)
Input
- input
object
- broker-id required
string
- Configuration ConfigurationId
- broker-id required
Output
- output UpdateBrokerResponse
RebootBroker
amazonaws_mq.RebootBroker({
"broker-id": ""
}, context)
Input
- input
object
- broker-id required
string
- broker-id required
Output
- output RebootBrokerResponse
ListUsers
amazonaws_mq.ListUsers({
"broker-id": ""
}, context)
Input
- input
object
- broker-id required
string
- broker-id required
Output
- output ListUsersResponse
DeleteUser
amazonaws_mq.DeleteUser({
"broker-id": "",
"username": ""
}, context)
Input
- input
object
- broker-id required
string
- username required
string
- broker-id required
Output
- output DeleteUserResponse
DescribeUser
amazonaws_mq.DescribeUser({
"broker-id": "",
"username": ""
}, context)
Input
- input
object
- broker-id required
string
- username required
string
- broker-id required
Output
- output DescribeUserResponse
CreateUser
amazonaws_mq.CreateUser({
"broker-id": "",
"username": ""
}, context)
Input
- input
object
- broker-id required
string
- username required
string
- ConsoleAccess __boolean
- Groups ListOf__string
- Password __string
- broker-id required
Output
- output CreateUserResponse
UpdateUser
amazonaws_mq.UpdateUser({
"broker-id": "",
"username": ""
}, context)
Input
- input
object
- broker-id required
string
- username required
string
- ConsoleAccess __boolean
- Groups ListOf__string
- Password __string
- broker-id required
Output
- output UpdateUserResponse
ListConfigurations
amazonaws_mq.ListConfigurations({}, context)
Input
- input
object
Output
- output ListConfigurationsResponse
CreateConfiguration
amazonaws_mq.CreateConfiguration({}, context)
Input
- input
object
- EngineType EngineType
- EngineVersion __string
- Name __string
Output
- output CreateConfigurationResponse
DescribeConfiguration
amazonaws_mq.DescribeConfiguration({
"configuration-id": ""
}, context)
Input
- input
object
- configuration-id required
string
- configuration-id required
Output
UpdateConfiguration
amazonaws_mq.UpdateConfiguration({
"configuration-id": ""
}, context)
Input
Output
- output UpdateConfigurationResponse
ListConfigurationRevisions
amazonaws_mq.ListConfigurationRevisions({
"configuration-id": ""
}, context)
Input
- input
object
- configuration-id required
string
- configuration-id required
Output
DescribeConfigurationRevision
amazonaws_mq.DescribeConfigurationRevision({
"configuration-id": "",
"configuration-revision": ""
}, context)
Input
- input
object
- configuration-id required
string
- configuration-revision required
string
- configuration-id required
Output
Definitions
BadRequestException
- BadRequestException
object
: Returns information about an error.
BrokerInstance
- BrokerInstance
object
: Returns information about all brokers.- ConsoleURL __string
- Endpoints ListOf__string
BrokerState
- BrokerState
string
(values: CREATION_IN_PROGRESS, CREATION_FAILED, DELETION_IN_PROGRESS, RUNNING, REBOOT_IN_PROGRESS): The status of the broker. Possible values: CREATION_IN_PROGRESS, CREATION_FAILED, DELETION_IN_PROGRESS, RUNNING, REBOOT_IN_PROGRESS
BrokerSummary
- BrokerSummary
object
: The Amazon Resource Name (ARN) of the broker.- BrokerArn __string
- BrokerId __string
- BrokerName __string
- BrokerState BrokerState
- DeploymentMode DeploymentMode
- HostInstanceType __string
ChangeType
- ChangeType
string
(values: CREATE, UPDATE, DELETE): The type of change pending for the ActiveMQ user. Possible values: CREATE, UPDATE, DELETE
Configuration
- Configuration
object
: Returns information about all configurations.- Arn __string
- Description __string
- EngineType EngineType
- EngineVersion __string
- Id __string
- LatestRevision ConfigurationRevision
- Name __string
ConfigurationId
ConfigurationRevision
- ConfigurationRevision
object
: Returns information about the specified configuration revision.
Configurations
- Configurations
object
: Broker configuration information- Current ConfigurationId
- History ListOfConfigurationId
- Pending ConfigurationId
ConflictException
- ConflictException
object
: Returns information about an error.
CreateBrokerInput
- CreateBrokerInput
object
: Required. The time period during which Amazon MQ applies pending updates or patches to the broker.- AutoMinorVersionUpgrade __boolean
- BrokerName __string
- Configuration ConfigurationId
- CreatorRequestId __string
- DeploymentMode DeploymentMode
- EngineType EngineType
- EngineVersion __string
- HostInstanceType __string
- MaintenanceWindowStartTime WeeklyStartTime
- PubliclyAccessible __boolean
- SecurityGroups ListOf__string
- SubnetIds ListOf__string
- Users ListOfUser
CreateBrokerOutput
- CreateBrokerOutput
object
: Returns information about the created broker.
CreateBrokerRequest
- CreateBrokerRequest
object
: Creates a broker using the specified properties.- AutoMinorVersionUpgrade __boolean
- BrokerName __string
- Configuration ConfigurationId
- CreatorRequestId __string
- DeploymentMode DeploymentMode
- EngineType EngineType
- EngineVersion __string
- HostInstanceType __string
- MaintenanceWindowStartTime WeeklyStartTime
- PubliclyAccessible __boolean
- SecurityGroups ListOf__string
- SubnetIds ListOf__string
- Users ListOfUser
CreateBrokerResponse
CreateConfigurationInput
- CreateConfigurationInput
object
: Creates a new configuration for the specified configuration name. Amazon MQ uses the default configuration (the engine type and version). Note: If the configuration name already exists, Amazon MQ doesn't create a configuration.- EngineType EngineType
- EngineVersion __string
- Name __string
CreateConfigurationOutput
- CreateConfigurationOutput
object
: Returns information about the created configuration.- Arn __string
- Id __string
- LatestRevision ConfigurationRevision
- Name __string
CreateConfigurationRequest
- CreateConfigurationRequest
object
: Creates a new configuration for the specified configuration name. Amazon MQ uses the default configuration (the engine type and version). Note: If the configuration name already exists, Amazon MQ doesn't create a configuration.- EngineType EngineType
- EngineVersion __string
- Name __string
CreateConfigurationResponse
- CreateConfigurationResponse
object
- Arn __string
- Id __string
- LatestRevision ConfigurationRevision
- Name __string
CreateUserInput
- CreateUserInput
object
: Creates a new ActiveMQ user.- ConsoleAccess __boolean
- Groups ListOf__string
- Password __string
CreateUserRequest
- CreateUserRequest
object
: Creates a new ActiveMQ user.- ConsoleAccess __boolean
- Groups ListOf__string
- Password __string
CreateUserResponse
- CreateUserResponse
object
DayOfWeek
- DayOfWeek
string
(values: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY)
DeleteBrokerOutput
- DeleteBrokerOutput
object
: Returns information about the deleted broker.- BrokerId __string
DeleteBrokerRequest
- DeleteBrokerRequest
object
DeleteBrokerResponse
- DeleteBrokerResponse
object
- BrokerId __string
DeleteUserRequest
- DeleteUserRequest
object
DeleteUserResponse
- DeleteUserResponse
object
DeploymentMode
- DeploymentMode
string
(values: SINGLE_INSTANCE, ACTIVE_STANDBY_MULTI_AZ): The deployment mode of the broker. Possible values: SINGLE_INSTANCE, ACTIVE_STANDBY_MULTI_AZ SINGLE_INSTANCE creates a single-instance broker in a single Availability Zone. ACTIVE_STANDBY_MULTI_AZ creates an active/standby broker for high availability.
DescribeBrokerOutput
- DescribeBrokerOutput
object
: The version of the broker engine. Note: Currently, Amazon MQ supports only 5.15.0.- AutoMinorVersionUpgrade __boolean
- BrokerArn __string
- BrokerId __string
- BrokerInstances ListOfBrokerInstance
- BrokerName __string
- BrokerState BrokerState
- Configurations Configurations
- DeploymentMode DeploymentMode
- EngineType EngineType
- EngineVersion __string
- HostInstanceType __string
- MaintenanceWindowStartTime WeeklyStartTime
- PubliclyAccessible __boolean
- SecurityGroups ListOf__string
- SubnetIds ListOf__string
- Users ListOfUserSummary
DescribeBrokerRequest
- DescribeBrokerRequest
object
DescribeBrokerResponse
- DescribeBrokerResponse
object
- AutoMinorVersionUpgrade __boolean
- BrokerArn __string
- BrokerId __string
- BrokerInstances ListOfBrokerInstance
- BrokerName __string
- BrokerState BrokerState
- Configurations Configurations
- DeploymentMode DeploymentMode
- EngineType EngineType
- EngineVersion __string
- HostInstanceType __string
- MaintenanceWindowStartTime WeeklyStartTime
- PubliclyAccessible __boolean
- SecurityGroups ListOf__string
- SubnetIds ListOf__string
- Users ListOfUserSummary
DescribeConfigurationRequest
- DescribeConfigurationRequest
object
DescribeConfigurationResponse
- DescribeConfigurationResponse
object
- Arn __string
- Description __string
- EngineType EngineType
- EngineVersion __string
- Id __string
- LatestRevision ConfigurationRevision
- Name __string
DescribeConfigurationRevisionOutput
- DescribeConfigurationRevisionOutput
object
: Returns the specified configuration revision for the specified configuration.
DescribeConfigurationRevisionRequest
- DescribeConfigurationRevisionRequest
object
DescribeConfigurationRevisionResponse
- DescribeConfigurationRevisionResponse
object
DescribeUserOutput
- DescribeUserOutput
object
: Returns information about an ActiveMQ user.- BrokerId __string
- ConsoleAccess __boolean
- Groups ListOf__string
- Pending UserPendingChanges
- Username __string
DescribeUserRequest
- DescribeUserRequest
object
DescribeUserResponse
- DescribeUserResponse
object
- BrokerId __string
- ConsoleAccess __boolean
- Groups ListOf__string
- Pending UserPendingChanges
- Username __string
EngineType
- EngineType
string
(values: ACTIVEMQ): The type of broker engine. Note: Currently, Amazon MQ supports only ActiveMQ.
Error
ForbiddenException
- ForbiddenException
object
: Returns information about an error.
InternalServerErrorException
- InternalServerErrorException
object
: Returns information about an error.
ListBrokersOutput
- ListBrokersOutput
object
: A list of information about all brokers.- BrokerSummaries ListOfBrokerSummary
- NextToken __string
ListBrokersRequest
- ListBrokersRequest
object
ListBrokersResponse
- ListBrokersResponse
object
- BrokerSummaries ListOfBrokerSummary
- NextToken __string
ListConfigurationRevisionsOutput
- ListConfigurationRevisionsOutput
object
: Returns a list of all revisions for the specified configuration.- ConfigurationId __string
- MaxResults __integer
- NextToken __string
- Revisions ListOfConfigurationRevision
ListConfigurationRevisionsRequest
- ListConfigurationRevisionsRequest
object
ListConfigurationRevisionsResponse
- ListConfigurationRevisionsResponse
object
- ConfigurationId __string
- MaxResults __integer
- NextToken __string
- Revisions ListOfConfigurationRevision
ListConfigurationsOutput
- ListConfigurationsOutput
object
: Returns a list of all configurations.- Configurations ListOfConfiguration
- MaxResults __integer
- NextToken __string
ListConfigurationsRequest
- ListConfigurationsRequest
object
ListConfigurationsResponse
- ListConfigurationsResponse
object
- Configurations ListOfConfiguration
- MaxResults __integer
- NextToken __string
ListOfBrokerInstance
- ListOfBrokerInstance
array
- items BrokerInstance
ListOfBrokerSummary
- ListOfBrokerSummary
array
- items BrokerSummary
ListOfConfiguration
- ListOfConfiguration
array
- items Configuration
ListOfConfigurationId
- ListOfConfigurationId
array
- items ConfigurationId
ListOfConfigurationRevision
- ListOfConfigurationRevision
array
- items ConfigurationRevision
ListOfSanitizationWarning
- ListOfSanitizationWarning
array
- items SanitizationWarning
ListOfUser
- ListOfUser
array
- items User
ListOfUserSummary
- ListOfUserSummary
array
- items UserSummary
ListOf__string
- ListOf__string
array
- items __string
ListUsersOutput
- ListUsersOutput
object
: Returns a list of all ActiveMQ users.- BrokerId __string
- MaxResults __integer
- NextToken __string
- Users ListOfUserSummary
ListUsersRequest
- ListUsersRequest
object
ListUsersResponse
- ListUsersResponse
object
- BrokerId __string
- MaxResults __integer
- NextToken __string
- Users ListOfUserSummary
MaxResults
- MaxResults
integer
NotFoundException
- NotFoundException
object
: Returns information about an error.
RebootBrokerRequest
- RebootBrokerRequest
object
RebootBrokerResponse
- RebootBrokerResponse
object
SanitizationWarning
- SanitizationWarning
object
: Returns information about the XML element or attribute that was sanitized in the configuration.- AttributeName __string
- ElementName __string
- Reason SanitizationWarningReason
SanitizationWarningReason
- SanitizationWarningReason
string
(values: DISALLOWED_ELEMENT_REMOVED, DISALLOWED_ATTRIBUTE_REMOVED, INVALID_ATTRIBUTE_VALUE_REMOVED): The reason for which the XML elements or attributes were sanitized. Possible values: DISALLOWED_ELEMENT_REMOVED, DISALLOWED_ATTRIBUTE_REMOVED, INVALID_ATTRIBUTE_VALUE_REMOVED DISALLOWED_ELEMENT_REMOVED shows that the provided element isn't allowed and has been removed. DISALLOWED_ATTRIBUTE_REMOVED shows that the provided attribute isn't allowed and has been removed. INVALID_ATTRIBUTE_VALUE_REMOVED shows that the provided value for the attribute isn't allowed and has been removed.
UnauthorizedException
- UnauthorizedException
object
: Returns information about an error.
UpdateBrokerInput
- UpdateBrokerInput
object
: Updates the broker using the specified properties.- Configuration ConfigurationId
UpdateBrokerOutput
- UpdateBrokerOutput
object
: Returns information about the updated broker.- BrokerId __string
- Configuration ConfigurationId
UpdateBrokerRequest
- UpdateBrokerRequest
object
: Updates the broker using the specified properties.- Configuration ConfigurationId
UpdateBrokerResponse
- UpdateBrokerResponse
object
- BrokerId __string
- Configuration ConfigurationId
UpdateConfigurationInput
- UpdateConfigurationInput
object
: Updates the specified configuration.
UpdateConfigurationOutput
- UpdateConfigurationOutput
object
: Returns information about the updated configuration.- Arn __string
- Id __string
- LatestRevision ConfigurationRevision
- Name __string
- Warnings ListOfSanitizationWarning
UpdateConfigurationRequest
- UpdateConfigurationRequest
object
: Updates the specified configuration.
UpdateConfigurationResponse
- UpdateConfigurationResponse
object
- Arn __string
- Id __string
- LatestRevision ConfigurationRevision
- Name __string
- Warnings ListOfSanitizationWarning
UpdateUserInput
- UpdateUserInput
object
: Updates the information for an ActiveMQ user.- ConsoleAccess __boolean
- Groups ListOf__string
- Password __string
UpdateUserRequest
- UpdateUserRequest
object
: Updates the information for an ActiveMQ user.- ConsoleAccess __boolean
- Groups ListOf__string
- Password __string
UpdateUserResponse
- UpdateUserResponse
object
User
- User
object
: An ActiveMQ user associated with the broker.- ConsoleAccess __boolean
- Groups ListOf__string
- Password __string
- Username __string
UserPendingChanges
- UserPendingChanges
object
: Returns information about the status of the changes pending for the ActiveMQ user.- ConsoleAccess __boolean
- Groups ListOf__string
- PendingChange ChangeType
UserSummary
- UserSummary
object
: Returns a list of all ActiveMQ users.- PendingChange ChangeType
- Username __string
WeeklyStartTime
- WeeklyStartTime
object
: The scheduled time period relative to UTC during which Amazon MQ begins to apply pending updates or patches to the broker.
__boolean
- __boolean
boolean
__double
- __double
number
__integer
- __integer
integer
__string
- __string
string
__timestamp
- __timestamp
string