5.0.0 • Published 7 years ago

@datafire/amazonaws_mq v5.0.0

Weekly downloads
2
License
MIT
Repository
github
Last release
7 years ago

@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

CreateBroker

amazonaws_mq.CreateBroker({}, context)

Input

Output

DeleteBroker

amazonaws_mq.DeleteBroker({
  "broker-id": ""
}, context)

Input

  • input object
    • broker-id required string

Output

DescribeBroker

amazonaws_mq.DescribeBroker({
  "broker-id": ""
}, context)

Input

  • input object
    • broker-id required string

Output

UpdateBroker

amazonaws_mq.UpdateBroker({
  "broker-id": ""
}, context)

Input

Output

RebootBroker

amazonaws_mq.RebootBroker({
  "broker-id": ""
}, context)

Input

  • input object
    • broker-id required string

Output

ListUsers

amazonaws_mq.ListUsers({
  "broker-id": ""
}, context)

Input

  • input object
    • broker-id required string

Output

DeleteUser

amazonaws_mq.DeleteUser({
  "broker-id": "",
  "username": ""
}, context)

Input

  • input object
    • broker-id required string
    • username required string

Output

DescribeUser

amazonaws_mq.DescribeUser({
  "broker-id": "",
  "username": ""
}, context)

Input

  • input object
    • broker-id required string
    • username required string

Output

CreateUser

amazonaws_mq.CreateUser({
  "broker-id": "",
  "username": ""
}, context)

Input

Output

UpdateUser

amazonaws_mq.UpdateUser({
  "broker-id": "",
  "username": ""
}, context)

Input

Output

ListConfigurations

amazonaws_mq.ListConfigurations({}, context)

Input

  • input object

Output

CreateConfiguration

amazonaws_mq.CreateConfiguration({}, context)

Input

Output

DescribeConfiguration

amazonaws_mq.DescribeConfiguration({
  "configuration-id": ""
}, context)

Input

  • input object
    • configuration-id required string

Output

UpdateConfiguration

amazonaws_mq.UpdateConfiguration({
  "configuration-id": ""
}, context)

Input

Output

ListConfigurationRevisions

amazonaws_mq.ListConfigurationRevisions({
  "configuration-id": ""
}, context)

Input

  • input object
    • configuration-id required string

Output

DescribeConfigurationRevision

amazonaws_mq.DescribeConfigurationRevision({
  "configuration-id": "",
  "configuration-revision": ""
}, context)

Input

  • input object
    • configuration-id required string
    • configuration-revision required string

Output

Definitions

BadRequestException

  • BadRequestException object: Returns information about an error.

BrokerInstance

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

ChangeType

  • ChangeType string (values: CREATE, UPDATE, DELETE): The type of change pending for the ActiveMQ user. Possible values: CREATE, UPDATE, DELETE

Configuration

ConfigurationId

  • ConfigurationId object: A list of information about the configuration.

ConfigurationRevision

  • ConfigurationRevision object: Returns information about the specified configuration revision.

Configurations

ConflictException

  • ConflictException object: Returns information about an error.

CreateBrokerInput

CreateBrokerOutput

  • CreateBrokerOutput object: Returns information about the created broker.

CreateBrokerRequest

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.

CreateConfigurationOutput

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.

CreateConfigurationResponse

CreateUserInput

CreateUserRequest

CreateUserResponse

  • CreateUserResponse object

DayOfWeek

  • DayOfWeek string (values: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY)

DeleteBrokerOutput

  • DeleteBrokerOutput object: Returns information about the deleted broker.

DeleteBrokerRequest

  • DeleteBrokerRequest object

DeleteBrokerResponse

  • DeleteBrokerResponse object

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

DescribeBrokerRequest

  • DescribeBrokerRequest object

DescribeBrokerResponse

DescribeConfigurationRequest

  • DescribeConfigurationRequest object

DescribeConfigurationResponse

DescribeConfigurationRevisionOutput

  • DescribeConfigurationRevisionOutput object: Returns the specified configuration revision for the specified configuration.

DescribeConfigurationRevisionRequest

  • DescribeConfigurationRevisionRequest object

DescribeConfigurationRevisionResponse

DescribeUserOutput

DescribeUserRequest

  • DescribeUserRequest object

DescribeUserResponse

EngineType

  • EngineType string (values: ACTIVEMQ): The type of broker engine. Note: Currently, Amazon MQ supports only ActiveMQ.

Error

  • Error object: Returns information about an error.

ForbiddenException

  • ForbiddenException object: Returns information about an error.

InternalServerErrorException

  • InternalServerErrorException object: Returns information about an error.

ListBrokersOutput

ListBrokersRequest

  • ListBrokersRequest object

ListBrokersResponse

ListConfigurationRevisionsOutput

ListConfigurationRevisionsRequest

  • ListConfigurationRevisionsRequest object

ListConfigurationRevisionsResponse

ListConfigurationsOutput

ListConfigurationsRequest

  • ListConfigurationsRequest object

ListConfigurationsResponse

ListOfBrokerInstance

ListOfBrokerSummary

ListOfConfiguration

ListOfConfigurationId

ListOfConfigurationRevision

ListOfSanitizationWarning

ListOfUser

  • ListOfUser array

ListOfUserSummary

ListOf__string

ListUsersOutput

ListUsersRequest

  • ListUsersRequest object

ListUsersResponse

MaxResults

  • MaxResults integer

NotFoundException

  • NotFoundException object: Returns information about an error.

RebootBrokerRequest

  • RebootBrokerRequest object

RebootBrokerResponse

  • RebootBrokerResponse object

SanitizationWarning

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.

UpdateBrokerOutput

  • UpdateBrokerOutput object: Returns information about the updated broker.

UpdateBrokerRequest

  • UpdateBrokerRequest object: Updates the broker using the specified properties.

UpdateBrokerResponse

UpdateConfigurationInput

  • UpdateConfigurationInput object: Updates the specified configuration.

UpdateConfigurationOutput

UpdateConfigurationRequest

  • UpdateConfigurationRequest object: Updates the specified configuration.

UpdateConfigurationResponse

UpdateUserInput

UpdateUserRequest

UpdateUserResponse

  • UpdateUserResponse object

User

UserPendingChanges

  • UserPendingChanges object: Returns information about the status of the changes pending for the ActiveMQ user.

UserSummary

  • UserSummary object: Returns a list of all ActiveMQ users.

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