AmazonMQ 2017-11-27
- Client: Aws\MQ\MQClient
- Service ID: mq
- Version: 2017-11-27
This page describes the parameters and results for the operations of the AmazonMQ (2017-11-27), and shows how to use the Aws\MQ\MQClient object to call the described operations. This documentation is specific to the 2017-11-27 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName'), where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */).
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */).
- CreateBroker ( array $params = [] )
Creates a broker.
- CreateConfiguration ( array $params = [] )
Creates a new configuration for the specified configuration name.
- CreateTags ( array $params = [] )
Add a tag to a resource.
- CreateUser ( array $params = [] )
Creates an ActiveMQ user.
- DeleteBroker ( array $params = [] )
Deletes a broker.
- DeleteTags ( array $params = [] )
Removes a tag from a resource.
- DeleteUser ( array $params = [] )
Deletes an ActiveMQ user.
- DescribeBroker ( array $params = [] )
Returns information about the specified broker.
- DescribeBrokerEngineTypes ( array $params = [] )
Describe available engine types and versions.
- DescribeBrokerInstanceOptions ( array $params = [] )
Describe available broker instance options.
- DescribeConfiguration ( array $params = [] )
Returns information about the specified configuration.
- DescribeConfigurationRevision ( array $params = [] )
Returns the specified configuration revision for the specified configuration.
- DescribeUser ( array $params = [] )
Returns information about an ActiveMQ user.
- ListBrokers ( array $params = [] )
Returns a list of all brokers.
- ListConfigurationRevisions ( array $params = [] )
Returns a list of all revisions for the specified configuration.
- ListConfigurations ( array $params = [] )
Returns a list of all configurations.
- ListTags ( array $params = [] )
Lists tags for a resource.
- ListUsers ( array $params = [] )
Returns a list of all ActiveMQ users.
- RebootBroker ( array $params = [] )
Reboots a broker.
- UpdateBroker ( array $params = [] )
Adds a pending configuration change to a broker.
- UpdateConfiguration ( array $params = [] )
Updates the specified configuration.
- UpdateUser ( array $params = [] )
Updates the information for an ActiveMQ user.
Operations
CreateBroker
$result = $client->createBroker([/* ... */]); $promise = $client->createBrokerAsync([/* ... */]);
Creates a broker. Note: This API is asynchronous.
Parameter Syntax
$result = $client->createBroker([
'AutoMinorVersionUpgrade' => true || false,
'BrokerName' => '<string>',
'Configuration' => [
'Id' => '<string>',
'Revision' => <integer>,
],
'CreatorRequestId' => '<string>',
'DeploymentMode' => 'SINGLE_INSTANCE|ACTIVE_STANDBY_MULTI_AZ',
'EncryptionOptions' => [
'KmsKeyId' => '<string>',
'UseAwsOwnedKey' => true || false, // REQUIRED
],
'EngineType' => 'ACTIVEMQ',
'EngineVersion' => '<string>',
'HostInstanceType' => '<string>',
'Logs' => [
'Audit' => true || false,
'General' => true || false,
],
'MaintenanceWindowStartTime' => [
'DayOfWeek' => 'MONDAY|TUESDAY|WEDNESDAY|THURSDAY|FRIDAY|SATURDAY|SUNDAY',
'TimeOfDay' => '<string>',
'TimeZone' => '<string>',
],
'PubliclyAccessible' => true || false,
'SecurityGroups' => ['<string>', ...],
'SubnetIds' => ['<string>', ...],
'Tags' => ['<string>', ...],
'Users' => [
[
'ConsoleAccess' => true || false,
'Groups' => ['<string>', ...],
'Password' => '<string>',
'Username' => '<string>',
],
// ...
],
]);
Parameter Details
Members
- AutoMinorVersionUpgrade
-
- Type: boolean
- BrokerName
-
- Type: string
- Configuration
-
- Type: ConfigurationId structure
A list of information about the configuration. - CreatorRequestId
-
- Type: string
- DeploymentMode
-
- Type: string
The deployment mode of the broker. - EncryptionOptions
-
- Type: EncryptionOptions structure
Encryption options for the broker. - EngineType
-
- Type: string
The type of broker engine. Note: Currently, Amazon MQ supports only ActiveMQ. - EngineVersion
-
- Type: string
- HostInstanceType
-
- Type: string
- Logs
-
- Type: Logs structure
The list of information about logs to be enabled for the specified broker. - MaintenanceWindowStartTime
-
- Type: WeeklyStartTime structure
The scheduled time period relative to UTC during which Amazon MQ begins to apply pending updates or patches to the broker. - PubliclyAccessible
-
- Type: boolean
- SecurityGroups
-
- Type: Array of strings
- SubnetIds
-
- Type: Array of strings
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
- Users
-
- Type: Array of User structures
Result Syntax
[
'BrokerArn' => '<string>',
'BrokerId' => '<string>',
]
Result Details
Errors
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
CreateConfiguration
$result = $client->createConfiguration([/* ... */]); $promise = $client->createConfigurationAsync([/* ... */]);
Creates a new configuration for the specified configuration name. Amazon MQ uses the default configuration (the engine type and version).
Parameter Syntax
$result = $client->createConfiguration([
'EngineType' => 'ACTIVEMQ',
'EngineVersion' => '<string>',
'Name' => '<string>',
'Tags' => ['<string>', ...],
]);
Parameter Details
Members
Result Syntax
[
'Arn' => '<string>',
'Created' => <DateTime>,
'Id' => '<string>',
'LatestRevision' => [
'Created' => <DateTime>,
'Description' => '<string>',
'Revision' => <integer>,
],
'Name' => '<string>',
]
Result Details
Members
- Arn
-
- Type: string
- Created
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- Id
-
- Type: string
- LatestRevision
-
- Type: ConfigurationRevision structure
Returns information about the specified configuration revision. - Name
-
- Type: string
Errors
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
CreateTags
$result = $client->createTags([/* ... */]); $promise = $client->createTagsAsync([/* ... */]);
Add a tag to a resource.
Parameter Syntax
$result = $client->createTags([
'ResourceArn' => '<string>', // REQUIRED
'Tags' => ['<string>', ...],
]);
Parameter Details
Members
Result Syntax
[]
Result Details
The results for this operation are always empty.
Errors
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
CreateUser
$result = $client->createUser([/* ... */]); $promise = $client->createUserAsync([/* ... */]);
Creates an ActiveMQ user.
Parameter Syntax
$result = $client->createUser([
'BrokerId' => '<string>', // REQUIRED
'ConsoleAccess' => true || false,
'Groups' => ['<string>', ...],
'Password' => '<string>',
'Username' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
The results for this operation are always empty.
Errors
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
DeleteBroker
$result = $client->deleteBroker([/* ... */]); $promise = $client->deleteBrokerAsync([/* ... */]);
Deletes a broker. Note: This API is asynchronous.
Parameter Syntax
$result = $client->deleteBroker([
'BrokerId' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'BrokerId' => '<string>',
]
Result Details
Errors
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
DeleteTags
$result = $client->deleteTags([/* ... */]); $promise = $client->deleteTagsAsync([/* ... */]);
Removes a tag from a resource.
Parameter Syntax
$result = $client->deleteTags([
'ResourceArn' => '<string>', // REQUIRED
'TagKeys' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Result Syntax
[]
Result Details
The results for this operation are always empty.
Errors
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
DeleteUser
$result = $client->deleteUser([/* ... */]); $promise = $client->deleteUserAsync([/* ... */]);
Deletes an ActiveMQ user.
Parameter Syntax
$result = $client->deleteUser([
'BrokerId' => '<string>', // REQUIRED
'Username' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[]
Result Details
The results for this operation are always empty.
Errors
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
DescribeBroker
$result = $client->describeBroker([/* ... */]); $promise = $client->describeBrokerAsync([/* ... */]);
Returns information about the specified broker.
Parameter Syntax
$result = $client->describeBroker([
'BrokerId' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'AutoMinorVersionUpgrade' => true || false,
'BrokerArn' => '<string>',
'BrokerId' => '<string>',
'BrokerInstances' => [
[
'ConsoleURL' => '<string>',
'Endpoints' => ['<string>', ...],
'IpAddress' => '<string>',
],
// ...
],
'BrokerName' => '<string>',
'BrokerState' => 'CREATION_IN_PROGRESS|CREATION_FAILED|DELETION_IN_PROGRESS|RUNNING|REBOOT_IN_PROGRESS',
'Configurations' => [
'Current' => [
'Id' => '<string>',
'Revision' => <integer>,
],
'History' => [
[
'Id' => '<string>',
'Revision' => <integer>,
],
// ...
],
'Pending' => [
'Id' => '<string>',
'Revision' => <integer>,
],
],
'Created' => <DateTime>,
'DeploymentMode' => 'SINGLE_INSTANCE|ACTIVE_STANDBY_MULTI_AZ',
'EncryptionOptions' => [
'KmsKeyId' => '<string>',
'UseAwsOwnedKey' => true || false,
],
'EngineType' => 'ACTIVEMQ',
'EngineVersion' => '<string>',
'HostInstanceType' => '<string>',
'Logs' => [
'Audit' => true || false,
'AuditLogGroup' => '<string>',
'General' => true || false,
'GeneralLogGroup' => '<string>',
'Pending' => [
'Audit' => true || false,
'General' => true || false,
],
],
'MaintenanceWindowStartTime' => [
'DayOfWeek' => 'MONDAY|TUESDAY|WEDNESDAY|THURSDAY|FRIDAY|SATURDAY|SUNDAY',
'TimeOfDay' => '<string>',
'TimeZone' => '<string>',
],
'PendingEngineVersion' => '<string>',
'PendingHostInstanceType' => '<string>',
'PendingSecurityGroups' => ['<string>', ...],
'PubliclyAccessible' => true || false,
'SecurityGroups' => ['<string>', ...],
'SubnetIds' => ['<string>', ...],
'Tags' => ['<string>', ...],
'Users' => [
[
'PendingChange' => 'CREATE|UPDATE|DELETE',
'Username' => '<string>',
],
// ...
],
]
Result Details
Members
- AutoMinorVersionUpgrade
-
- Type: boolean
- BrokerArn
-
- Type: string
- BrokerId
-
- Type: string
- BrokerInstances
-
- Type: Array of BrokerInstance structures
- BrokerName
-
- Type: string
- BrokerState
-
- Type: string
The status of the broker. - Configurations
-
- Type: Configurations structure
Broker configuration information - Created
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- DeploymentMode
-
- Type: string
The deployment mode of the broker. - EncryptionOptions
-
- Type: EncryptionOptions structure
Encryption options for the broker. - EngineType
-
- Type: string
The type of broker engine. Note: Currently, Amazon MQ supports only ActiveMQ. - EngineVersion
-
- Type: string
- HostInstanceType
-
- Type: string
- Logs
-
- Type: LogsSummary structure
The list of information about logs currently enabled and pending to be deployed for the specified broker. - MaintenanceWindowStartTime
-
- Type: WeeklyStartTime structure
The scheduled time period relative to UTC during which Amazon MQ begins to apply pending updates or patches to the broker. - PendingEngineVersion
-
- Type: string
- PendingHostInstanceType
-
- Type: string
- PendingSecurityGroups
-
- Type: Array of strings
- PubliclyAccessible
-
- Type: boolean
- SecurityGroups
-
- Type: Array of strings
- SubnetIds
-
- Type: Array of strings
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
- Users
-
- Type: Array of UserSummary structures
Errors
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
DescribeBrokerEngineTypes
$result = $client->describeBrokerEngineTypes([/* ... */]); $promise = $client->describeBrokerEngineTypesAsync([/* ... */]);
Describe available engine types and versions.
Parameter Syntax
$result = $client->describeBrokerEngineTypes([
'EngineType' => '<string>',
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Result Syntax
[
'BrokerEngineTypes' => [
[
'EngineType' => 'ACTIVEMQ',
'EngineVersions' => [
[
'Name' => '<string>',
],
// ...
],
],
// ...
],
'MaxResults' => <integer>,
'NextToken' => '<string>',
]
Result Details
Members
- BrokerEngineTypes
-
- Type: Array of BrokerEngineType structures
- MaxResults
-
- Type: int
- NextToken
-
- Type: string
Errors
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
DescribeBrokerInstanceOptions
$result = $client->describeBrokerInstanceOptions([/* ... */]); $promise = $client->describeBrokerInstanceOptionsAsync([/* ... */]);
Describe available broker instance options.
Parameter Syntax
$result = $client->describeBrokerInstanceOptions([
'EngineType' => '<string>',
'HostInstanceType' => '<string>',
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'BrokerInstanceOptions' => [
[
'AvailabilityZones' => [
[
'Name' => '<string>',
],
// ...
],
'EngineType' => 'ACTIVEMQ',
'HostInstanceType' => '<string>',
'SupportedEngineVersions' => ['<string>', ...],
],
// ...
],
'MaxResults' => <integer>,
'NextToken' => '<string>',
]
Result Details
Members
- BrokerInstanceOptions
-
- Type: Array of BrokerInstanceOption structures
- MaxResults
-
- Type: int
- NextToken
-
- Type: string
Errors
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
DescribeConfiguration
$result = $client->describeConfiguration([/* ... */]); $promise = $client->describeConfigurationAsync([/* ... */]);
Returns information about the specified configuration.
Parameter Syntax
$result = $client->describeConfiguration([
'ConfigurationId' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'Arn' => '<string>',
'Created' => <DateTime>,
'Description' => '<string>',
'EngineType' => 'ACTIVEMQ',
'EngineVersion' => '<string>',
'Id' => '<string>',
'LatestRevision' => [
'Created' => <DateTime>,
'Description' => '<string>',
'Revision' => <integer>,
],
'Name' => '<string>',
'Tags' => ['<string>', ...],
]
Result Details
Members
- Arn
-
- Type: string
- Created
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- Description
-
- Type: string
- EngineType
-
- Type: string
The type of broker engine. Note: Currently, Amazon MQ supports only ActiveMQ. - EngineVersion
-
- Type: string
- Id
-
- Type: string
- LatestRevision
-
- Type: ConfigurationRevision structure
Returns information about the specified configuration revision. - Name
-
- Type: string
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Errors
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
DescribeConfigurationRevision
$result = $client->describeConfigurationRevision([/* ... */]); $promise = $client->describeConfigurationRevisionAsync([/* ... */]);
Returns the specified configuration revision for the specified configuration.
Parameter Syntax
$result = $client->describeConfigurationRevision([
'ConfigurationId' => '<string>', // REQUIRED
'ConfigurationRevision' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'ConfigurationId' => '<string>',
'Created' => <DateTime>,
'Data' => '<string>',
'Description' => '<string>',
]
Result Details
Members
Errors
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
DescribeUser
$result = $client->describeUser([/* ... */]); $promise = $client->describeUserAsync([/* ... */]);
Returns information about an ActiveMQ user.
Parameter Syntax
$result = $client->describeUser([
'BrokerId' => '<string>', // REQUIRED
'Username' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'BrokerId' => '<string>',
'ConsoleAccess' => true || false,
'Groups' => ['<string>', ...],
'Pending' => [
'ConsoleAccess' => true || false,
'Groups' => ['<string>', ...],
'PendingChange' => 'CREATE|UPDATE|DELETE',
],
'Username' => '<string>',
]
Result Details
Members
- BrokerId
-
- Type: string
- ConsoleAccess
-
- Type: boolean
- Groups
-
- Type: Array of strings
- Pending
-
- Type: UserPendingChanges structure
Returns information about the status of the changes pending for the ActiveMQ user. - Username
-
- Type: string
Errors
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
ListBrokers
$result = $client->listBrokers([/* ... */]); $promise = $client->listBrokersAsync([/* ... */]);
Returns a list of all brokers.
Parameter Syntax
$result = $client->listBrokers([
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Result Syntax
[
'BrokerSummaries' => [
[
'BrokerArn' => '<string>',
'BrokerId' => '<string>',
'BrokerName' => '<string>',
'BrokerState' => 'CREATION_IN_PROGRESS|CREATION_FAILED|DELETION_IN_PROGRESS|RUNNING|REBOOT_IN_PROGRESS',
'Created' => <DateTime>,
'DeploymentMode' => 'SINGLE_INSTANCE|ACTIVE_STANDBY_MULTI_AZ',
'HostInstanceType' => '<string>',
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- BrokerSummaries
-
- Type: Array of BrokerSummary structures
- NextToken
-
- Type: string
Errors
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
ListConfigurationRevisions
$result = $client->listConfigurationRevisions([/* ... */]); $promise = $client->listConfigurationRevisionsAsync([/* ... */]);
Returns a list of all revisions for the specified configuration.
Parameter Syntax
$result = $client->listConfigurationRevisions([
'ConfigurationId' => '<string>', // REQUIRED
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Result Syntax
[
'ConfigurationId' => '<string>',
'MaxResults' => <integer>,
'NextToken' => '<string>',
'Revisions' => [
[
'Created' => <DateTime>,
'Description' => '<string>',
'Revision' => <integer>,
],
// ...
],
]
Result Details
Members
- ConfigurationId
-
- Type: string
- MaxResults
-
- Type: int
- NextToken
-
- Type: string
- Revisions
-
- Type: Array of ConfigurationRevision structures
Errors
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
ListConfigurations
$result = $client->listConfigurations([/* ... */]); $promise = $client->listConfigurationsAsync([/* ... */]);
Returns a list of all configurations.
Parameter Syntax
$result = $client->listConfigurations([
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Result Syntax
[
'Configurations' => [
[
'Arn' => '<string>',
'Created' => <DateTime>,
'Description' => '<string>',
'EngineType' => 'ACTIVEMQ',
'EngineVersion' => '<string>',
'Id' => '<string>',
'LatestRevision' => [
'Created' => <DateTime>,
'Description' => '<string>',
'Revision' => <integer>,
],
'Name' => '<string>',
'Tags' => ['<string>', ...],
],
// ...
],
'MaxResults' => <integer>,
'NextToken' => '<string>',
]
Result Details
Members
- Configurations
-
- Type: Array of Configuration structures
- MaxResults
-
- Type: int
- NextToken
-
- Type: string
Errors
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
ListTags
$result = $client->listTags([/* ... */]); $promise = $client->listTagsAsync([/* ... */]);
Lists tags for a resource.
Parameter Syntax
$result = $client->listTags([
'ResourceArn' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'Tags' => ['<string>', ...],
]
Result Details
Errors
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
ListUsers
$result = $client->listUsers([/* ... */]); $promise = $client->listUsersAsync([/* ... */]);
Returns a list of all ActiveMQ users.
Parameter Syntax
$result = $client->listUsers([
'BrokerId' => '<string>', // REQUIRED
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Result Syntax
[
'BrokerId' => '<string>',
'MaxResults' => <integer>,
'NextToken' => '<string>',
'Users' => [
[
'PendingChange' => 'CREATE|UPDATE|DELETE',
'Username' => '<string>',
],
// ...
],
]
Result Details
Members
- BrokerId
-
- Type: string
- MaxResults
-
- Type: int
- NextToken
-
- Type: string
- Users
-
- Type: Array of UserSummary structures
Errors
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
RebootBroker
$result = $client->rebootBroker([/* ... */]); $promise = $client->rebootBrokerAsync([/* ... */]);
Reboots a broker. Note: This API is asynchronous.
Parameter Syntax
$result = $client->rebootBroker([
'BrokerId' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[]
Result Details
The results for this operation are always empty.
Errors
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
UpdateBroker
$result = $client->updateBroker([/* ... */]); $promise = $client->updateBrokerAsync([/* ... */]);
Adds a pending configuration change to a broker.
Parameter Syntax
$result = $client->updateBroker([
'AutoMinorVersionUpgrade' => true || false,
'BrokerId' => '<string>', // REQUIRED
'Configuration' => [
'Id' => '<string>',
'Revision' => <integer>,
],
'EngineVersion' => '<string>',
'HostInstanceType' => '<string>',
'Logs' => [
'Audit' => true || false,
'General' => true || false,
],
'SecurityGroups' => ['<string>', ...],
]);
Parameter Details
Members
- AutoMinorVersionUpgrade
-
- Type: boolean
- BrokerId
-
- Required: Yes
- Type: string
- Configuration
-
- Type: ConfigurationId structure
A list of information about the configuration. - EngineVersion
-
- Type: string
- HostInstanceType
-
- Type: string
- Logs
-
- Type: Logs structure
The list of information about logs to be enabled for the specified broker. - SecurityGroups
-
- Type: Array of strings
Result Syntax
[
'AutoMinorVersionUpgrade' => true || false,
'BrokerId' => '<string>',
'Configuration' => [
'Id' => '<string>',
'Revision' => <integer>,
],
'EngineVersion' => '<string>',
'HostInstanceType' => '<string>',
'Logs' => [
'Audit' => true || false,
'General' => true || false,
],
'SecurityGroups' => ['<string>', ...],
]
Result Details
Members
- AutoMinorVersionUpgrade
-
- Type: boolean
- BrokerId
-
- Type: string
- Configuration
-
- Type: ConfigurationId structure
A list of information about the configuration. - EngineVersion
-
- Type: string
- HostInstanceType
-
- Type: string
- Logs
-
- Type: Logs structure
The list of information about logs to be enabled for the specified broker. - SecurityGroups
-
- Type: Array of strings
Errors
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
UpdateConfiguration
$result = $client->updateConfiguration([/* ... */]); $promise = $client->updateConfigurationAsync([/* ... */]);
Updates the specified configuration.
Parameter Syntax
$result = $client->updateConfiguration([
'ConfigurationId' => '<string>', // REQUIRED
'Data' => '<string>',
'Description' => '<string>',
]);
Parameter Details
Result Syntax
[
'Arn' => '<string>',
'Created' => <DateTime>,
'Id' => '<string>',
'LatestRevision' => [
'Created' => <DateTime>,
'Description' => '<string>',
'Revision' => <integer>,
],
'Name' => '<string>',
'Warnings' => [
[
'AttributeName' => '<string>',
'ElementName' => '<string>',
'Reason' => 'DISALLOWED_ELEMENT_REMOVED|DISALLOWED_ATTRIBUTE_REMOVED|INVALID_ATTRIBUTE_VALUE_REMOVED',
],
// ...
],
]
Result Details
Members
- Arn
-
- Type: string
- Created
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- Id
-
- Type: string
- LatestRevision
-
- Type: ConfigurationRevision structure
Returns information about the specified configuration revision. - Name
-
- Type: string
- Warnings
-
- Type: Array of SanitizationWarning structures
Errors
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
UpdateUser
$result = $client->updateUser([/* ... */]); $promise = $client->updateUserAsync([/* ... */]);
Updates the information for an ActiveMQ user.
Parameter Syntax
$result = $client->updateUser([
'BrokerId' => '<string>', // REQUIRED
'ConsoleAccess' => true || false,
'Groups' => ['<string>', ...],
'Password' => '<string>',
'Username' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
The results for this operation are always empty.
Errors
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
Shapes
AvailabilityZone
BadRequestException
Description
Returns information about an error.
Members
BrokerEngineType
Description
Types of broker engines.
Members
- EngineType
-
- Type: string
The type of broker engine. - EngineVersions
-
- Type: Array of EngineVersion structures
The list of engine versions.
BrokerEngineTypeOutput
Description
Returns a list of broker engine type.
Members
- BrokerEngineTypes
-
- Type: Array of BrokerEngineType structures
List of available engine types and versions. - MaxResults
-
- Type: int
Required. The maximum number of engine types that can be returned per page (20 by default). This value must be an integer from 5 to 100. - NextToken
-
- Type: string
The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.
BrokerInstance
Description
Returns information about all brokers.
Members
BrokerInstanceOption
Description
Option for host instance type.
Members
- AvailabilityZones
-
- Type: Array of AvailabilityZone structures
The list of available az. - EngineType
-
- Type: string
The type of broker engine. - HostInstanceType
-
- Type: string
The type of broker instance. - SupportedEngineVersions
-
- Type: Array of strings
The list of supported engine versions.
BrokerInstanceOptionsOutput
Description
Returns a list of broker instance options.
Members
- BrokerInstanceOptions
-
- Type: Array of BrokerInstanceOption structures
List of available broker instance options. - MaxResults
-
- Type: int
Required. The maximum number of instance options that can be returned per page (20 by default). This value must be an integer from 5 to 100. - NextToken
-
- Type: string
The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.
BrokerSummary
Description
The Amazon Resource Name (ARN) of the broker.
Members
- BrokerArn
-
- Type: string
The Amazon Resource Name (ARN) of the broker. - BrokerId
-
- Type: string
The unique ID that Amazon MQ generates for the broker. - BrokerName
-
- Type: string
The name of the broker. This value must be unique in your AWS account, 1-50 characters long, must contain only letters, numbers, dashes, and underscores, and must not contain whitespaces, brackets, wildcard characters, or special characters. - BrokerState
-
- Type: string
The status of the broker. - Created
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time when the broker was created. - DeploymentMode
-
- Type: string
Required. The deployment mode of the broker. - HostInstanceType
-
- Type: string
The broker's instance type.
Configuration
Description
Returns information about all configurations.
Members
- Arn
-
- Type: string
Required. The ARN of the configuration. - Created
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Required. The date and time of the configuration revision. - Description
-
- Type: string
Required. The description of the configuration. - EngineType
-
- Type: string
Required. The type of broker engine. Note: Currently, Amazon MQ supports only ACTIVEMQ. - EngineVersion
-
- Type: string
Required. The version of the broker engine. For a list of supported engine versions, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html - Id
-
- Type: string
Required. The unique ID that Amazon MQ generates for the configuration. - LatestRevision
-
- Type: ConfigurationRevision structure
Required. The latest revision of the configuration. - Name
-
- Type: string
Required. The name of the configuration. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 1-150 characters long. - Tags
-
- Type: Associative array of custom strings keys (__string) to strings
The list of all tags associated with this configuration.
ConfigurationId
Description
A list of information about the configuration.
Members
ConfigurationRevision
Description
Returns information about the specified configuration revision.
Members
Configurations
Description
Broker configuration information
Members
- Current
-
- Type: ConfigurationId structure
The current configuration of the broker. - History
-
- Type: Array of ConfigurationId structures
The history of configurations applied to the broker. - Pending
-
- Type: ConfigurationId structure
The pending configuration of the broker.
ConflictException
Description
Returns information about an error.
Members
CreateBrokerInput
Description
Required. The time period during which Amazon MQ applies pending updates or patches to the broker.
Members
- AutoMinorVersionUpgrade
-
- Type: boolean
Required. Enables automatic upgrades to new minor versions for brokers, as Apache releases the versions. The automatic upgrades occur during the maintenance window of the broker or after a manual broker reboot. - BrokerName
-
- Type: string
Required. The name of the broker. This value must be unique in your AWS account, 1-50 characters long, must contain only letters, numbers, dashes, and underscores, and must not contain whitespaces, brackets, wildcard characters, or special characters. - Configuration
-
- Type: ConfigurationId structure
A list of information about the configuration. - CreatorRequestId
-
- Type: string
The unique ID that the requester receives for the created broker. Amazon MQ passes your ID with the API action. Note: We recommend using a Universally Unique Identifier (UUID) for the creatorRequestId. You may omit the creatorRequestId if your application doesn't require idempotency. - DeploymentMode
-
- Type: string
Required. The deployment mode of the broker. - EncryptionOptions
-
- Type: EncryptionOptions structure
Encryption options for the broker. - EngineType
-
- Type: string
Required. The type of broker engine. Note: Currently, Amazon MQ supports only ACTIVEMQ. - EngineVersion
-
- Type: string
Required. The version of the broker engine. For a list of supported engine versions, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html - HostInstanceType
-
- Type: string
Required. The broker's instance type. - Logs
-
- Type: Logs structure
Enables Amazon CloudWatch logging for brokers. - MaintenanceWindowStartTime
-
- Type: WeeklyStartTime structure
The parameters that determine the WeeklyStartTime. - PubliclyAccessible
-
- Type: boolean
Required. Enables connections from applications outside of the VPC that hosts the broker's subnets. - SecurityGroups
-
- Type: Array of strings
The list of security groups (1 minimum, 5 maximum) that authorize connections to brokers. - SubnetIds
-
- Type: Array of strings
The list of groups (2 maximum) that define which subnets and IP ranges the broker can use from different Availability Zones. A SINGLE_INSTANCE deployment requires one subnet (for example, the default subnet). An ACTIVE_STANDBY_MULTI_AZ deployment requires two subnets. - Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Create tags when creating the broker. - Users
-
- Type: Array of User structures
Required. The list of ActiveMQ users (persons or applications) who can access queues and topics. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.
CreateBrokerOutput
Description
Returns information about the created broker.
Members
CreateConfigurationInput
Description
Creates a new configuration for the specified configuration name. Amazon MQ uses the default configuration (the engine type and version).
Members
- EngineType
-
- Type: string
Required. The type of broker engine. Note: Currently, Amazon MQ supports only ACTIVEMQ. - EngineVersion
-
- Type: string
Required. The version of the broker engine. For a list of supported engine versions, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html - Name
-
- Type: string
Required. The name of the configuration. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 1-150 characters long. - Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Create tags when creating the configuration.
CreateConfigurationOutput
Description
Returns information about the created configuration.
Members
- Arn
-
- Type: string
Required. The Amazon Resource Name (ARN) of the configuration. - Created
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Required. The date and time of the configuration. - Id
-
- Type: string
Required. The unique ID that Amazon MQ generates for the configuration. - LatestRevision
-
- Type: ConfigurationRevision structure
The latest revision of the configuration. - Name
-
- Type: string
Required. The name of the configuration. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 1-150 characters long.
CreateUserInput
Description
Creates a new ActiveMQ user.
Members
- ConsoleAccess
-
- Type: boolean
Enables access to the the ActiveMQ Web Console for the ActiveMQ user. - Groups
-
- Type: Array of strings
The list of groups (20 maximum) to which the ActiveMQ user belongs. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long. - Password
-
- Type: string
Required. The password of the user. This value must be at least 12 characters long, must contain at least 4 unique characters, and must not contain commas.
DeleteBrokerOutput
Description
Returns information about the deleted broker.
Members
DescribeBrokerOutput
Description
The version of the broker engine. For a list of supported engine versions, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html
Members
- AutoMinorVersionUpgrade
-
- Type: boolean
Required. Enables automatic upgrades to new minor versions for brokers, as Apache releases the versions. The automatic upgrades occur during the maintenance window of the broker or after a manual broker reboot. - BrokerArn
-
- Type: string
The Amazon Resource Name (ARN) of the broker. - BrokerId
-
- Type: string
The unique ID that Amazon MQ generates for the broker. - BrokerInstances
-
- Type: Array of BrokerInstance structures
A list of information about allocated brokers. - BrokerName
-
- Type: string
The name of the broker. This value must be unique in your AWS account, 1-50 characters long, must contain only letters, numbers, dashes, and underscores, and must not contain whitespaces, brackets, wildcard characters, or special characters. - BrokerState
-
- Type: string
The status of the broker. - Configurations
-
- Type: Configurations structure
The list of all revisions for the specified configuration. - Created
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time when the broker was created. - DeploymentMode
-
- Type: string
Required. The deployment mode of the broker. - EncryptionOptions
-
- Type: EncryptionOptions structure
Encryption options for the broker. - EngineType
-
- Type: string
Required. The type of broker engine. Note: Currently, Amazon MQ supports only ACTIVEMQ. - EngineVersion
-
- Type: string
The version of the broker engine. For a list of supported engine versions, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html - HostInstanceType
-
- Type: string
The broker's instance type. - Logs
-
- Type: LogsSummary structure
The list of information about logs currently enabled and pending to be deployed for the specified broker. - MaintenanceWindowStartTime
-
- Type: WeeklyStartTime structure
The parameters that determine the WeeklyStartTime. - PendingEngineVersion
-
- Type: string
The version of the broker engine to upgrade to. For a list of supported engine versions, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html - PendingHostInstanceType
-
- Type: string
The host instance type of the broker to upgrade to. For a list of supported instance types, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide//broker.html#broker-instance-types - PendingSecurityGroups
-
- Type: Array of strings
The list of pending security groups to authorize connections to brokers. - PubliclyAccessible
-
- Type: boolean
Required. Enables connections from applications outside of the VPC that hosts the broker's subnets. - SecurityGroups
-
- Type: Array of strings
The list of security groups (1 minimum, 5 maximum) that authorize connections to brokers. - SubnetIds
-
- Type: Array of strings
The list of groups (2 maximum) that define which subnets and IP ranges the broker can use from different Availability Zones. A SINGLE_INSTANCE deployment requires one subnet (for example, the default subnet). An ACTIVE_STANDBY_MULTI_AZ deployment requires two subnets. - Tags
-
- Type: Associative array of custom strings keys (__string) to strings
The list of all tags associated with this broker. - Users
-
- Type: Array of UserSummary structures
The list of all ActiveMQ usernames for the specified broker.
DescribeConfigurationRevisionOutput
Description
Returns the specified configuration revision for the specified configuration.
Members
- ConfigurationId
-
- Type: string
Required. The unique ID that Amazon MQ generates for the configuration. - Created
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Required. The date and time of the configuration. - Data
-
- Type: string
Required. The base64-encoded XML configuration. - Description
-
- Type: string
The description of the configuration.
DescribeUserOutput
Description
Returns information about an ActiveMQ user.
Members
- BrokerId
-
- Type: string
Required. The unique ID that Amazon MQ generates for the broker. - ConsoleAccess
-
- Type: boolean
Enables access to the the ActiveMQ Web Console for the ActiveMQ user. - Groups
-
- Type: Array of strings
The list of groups (20 maximum) to which the ActiveMQ user belongs. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long. - Pending
-
- Type: UserPendingChanges structure
The status of the changes pending for the ActiveMQ user. - Username
-
- Type: string
Required. The username of the ActiveMQ user. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.
EncryptionOptions
Description
Encryption options for the broker.
Members
- KmsKeyId
-
- Type: string
The customer master key (CMK) to use for the AWS Key Management Service (KMS). This key is used to encrypt your data at rest. If not provided, Amazon MQ will use a default CMK to encrypt your data. - UseAwsOwnedKey
-
- Required: Yes
- Type: boolean
Enables the use of an AWS owned CMK using AWS Key Management Service (KMS).
EngineVersion
Error
Description
Returns information about an error.
Members
ForbiddenException
Description
Returns information about an error.
Members
InternalServerErrorException
Description
Returns information about an error.
Members
ListBrokersOutput
Description
A list of information about all brokers.
Members
- BrokerSummaries
-
- Type: Array of BrokerSummary structures
A list of information about all brokers. - NextToken
-
- Type: string
The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.
ListConfigurationRevisionsOutput
Description
Returns a list of all revisions for the specified configuration.
Members
- ConfigurationId
-
- Type: string
The unique ID that Amazon MQ generates for the configuration. - MaxResults
-
- Type: int
The maximum number of configuration revisions that can be returned per page (20 by default). This value must be an integer from 5 to 100. - NextToken
-
- Type: string
The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty. - Revisions
-
- Type: Array of ConfigurationRevision structures
The list of all revisions for the specified configuration.
ListConfigurationsOutput
Description
Returns a list of all configurations.
Members
- Configurations
-
- Type: Array of Configuration structures
The list of all revisions for the specified configuration. - MaxResults
-
- Type: int
The maximum number of configurations that Amazon MQ can return per page (20 by default). This value must be an integer from 5 to 100. - NextToken
-
- Type: string
The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.
ListUsersOutput
Description
Returns a list of all ActiveMQ users.
Members
- BrokerId
-
- Type: string
Required. The unique ID that Amazon MQ generates for the broker. - MaxResults
-
- Type: int
Required. The maximum number of ActiveMQ users that can be returned per page (20 by default). This value must be an integer from 5 to 100. - NextToken
-
- Type: string
The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty. - Users
-
- Type: Array of UserSummary structures
Required. The list of all ActiveMQ usernames for the specified broker.
Logs
Description
The list of information about logs to be enabled for the specified broker.
Members
LogsSummary
Description
The list of information about logs currently enabled and pending to be deployed for the specified broker.
Members
- Audit
-
- Type: boolean
Enables audit logging. Every user management action made using JMX or the ActiveMQ Web Console is logged. - AuditLogGroup
-
- Type: string
The location of the CloudWatch Logs log group where audit logs are sent. - General
-
- Type: boolean
Enables general logging. - GeneralLogGroup
-
- Type: string
The location of the CloudWatch Logs log group where general logs are sent. - Pending
-
- Type: PendingLogs structure
The list of information about logs pending to be deployed for the specified broker.
NotFoundException
Description
Returns information about an error.
Members
PendingLogs
Description
The list of information about logs to be enabled for the specified broker.
Members
SanitizationWarning
Description
Returns information about the XML element or attribute that was sanitized in the configuration.
Members
Tags
Description
A map of the key-value pairs for the resource tag.
Members
UnauthorizedException
Description
Returns information about an error.
Members
UpdateBrokerInput
Description
Updates the broker using the specified properties.
Members
- AutoMinorVersionUpgrade
-
- Type: boolean
Enables automatic upgrades to new minor versions for brokers, as Apache releases the versions. The automatic upgrades occur during the maintenance window of the broker or after a manual broker reboot. - Configuration
-
- Type: ConfigurationId structure
A list of information about the configuration. - EngineVersion
-
- Type: string
The version of the broker engine. For a list of supported engine versions, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html - HostInstanceType
-
- Type: string
The host instance type of the broker to upgrade to. For a list of supported instance types, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide//broker.html#broker-instance-types - Logs
-
- Type: Logs structure
Enables Amazon CloudWatch logging for brokers. - SecurityGroups
-
- Type: Array of strings
The list of security groups (1 minimum, 5 maximum) that authorize connections to brokers.
UpdateBrokerOutput
Description
Returns information about the updated broker.
Members
- AutoMinorVersionUpgrade
-
- Type: boolean
The new value of automatic upgrades to new minor version for brokers. - BrokerId
-
- Type: string
Required. The unique ID that Amazon MQ generates for the broker. - Configuration
-
- Type: ConfigurationId structure
The ID of the updated configuration. - EngineVersion
-
- Type: string
The version of the broker engine to upgrade to. For a list of supported engine versions, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html - HostInstanceType
-
- Type: string
The host instance type of the broker to upgrade to. For a list of supported instance types, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide//broker.html#broker-instance-types - Logs
-
- Type: Logs structure
The list of information about logs to be enabled for the specified broker. - SecurityGroups
-
- Type: Array of strings
The list of security groups (1 minimum, 5 maximum) that authorize connections to brokers.
UpdateConfigurationInput
Description
Updates the specified configuration.
Members
UpdateConfigurationOutput
Description
Returns information about the updated configuration.
Members
- Arn
-
- Type: string
Required. The Amazon Resource Name (ARN) of the configuration. - Created
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Required. The date and time of the configuration. - Id
-
- Type: string
Required. The unique ID that Amazon MQ generates for the configuration. - LatestRevision
-
- Type: ConfigurationRevision structure
The latest revision of the configuration. - Name
-
- Type: string
Required. The name of the configuration. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 1-150 characters long. - Warnings
-
- Type: Array of SanitizationWarning structures
The list of the first 20 warnings about the configuration XML elements or attributes that were sanitized.
UpdateUserInput
Description
Updates the information for an ActiveMQ user.
Members
- ConsoleAccess
-
- Type: boolean
Enables access to the the ActiveMQ Web Console for the ActiveMQ user. - Groups
-
- Type: Array of strings
The list of groups (20 maximum) to which the ActiveMQ user belongs. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long. - Password
-
- Type: string
The password of the user. This value must be at least 12 characters long, must contain at least 4 unique characters, and must not contain commas.
User
Description
An ActiveMQ user associated with the broker.
Members
- ConsoleAccess
-
- Type: boolean
Enables access to the the ActiveMQ Web Console for the ActiveMQ user. - Groups
-
- Type: Array of strings
The list of groups (20 maximum) to which the ActiveMQ user belongs. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long. - Password
-
- Type: string
Required. The password of the ActiveMQ user. This value must be at least 12 characters long, must contain at least 4 unique characters, and must not contain commas. - Username
-
- Type: string
Required. The username of the ActiveMQ user. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.
UserPendingChanges
Description
Returns information about the status of the changes pending for the ActiveMQ user.
Members
- ConsoleAccess
-
- Type: boolean
Enables access to the the ActiveMQ Web Console for the ActiveMQ user. - Groups
-
- Type: Array of strings
The list of groups (20 maximum) to which the ActiveMQ user belongs. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long. - PendingChange
-
- Type: string
Required. The type of change pending for the ActiveMQ user.
UserSummary
Description
Returns a list of all ActiveMQ users.
Members
WeeklyStartTime
Description
The scheduled time period relative to UTC during which Amazon MQ begins to apply pending updates or patches to the broker.
