HTTP Status Code 200: OK.
" }, "errors": [ { "shape": "BadRequestException", "documentation": "HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
" }, { "shape": "UnauthorizedException", "documentation": "HTTP Status Code 401: Unauthorized request. The provided credentials couldn't be validated.
" }, { "shape": "InternalServerErrorException", "documentation": "HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
" }, { "shape": "ConflictException", "documentation": "HTTP Status Code 409: Conflict. This broker name already exists. Retry your request with another name.
" }, { "shape": "ForbiddenException", "documentation": "HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
" } ], "documentation": "Creates a broker. Note: This API is asynchronous.
To create a broker, you must either use the AmazonMQFullAccess IAM policy or include the following EC2 permissions in your IAM policy.
ec2:CreateNetworkInterface
This permission is required to allow Amazon MQ to create an elastic network interface (ENI) on behalf of your account.
ec2:CreateNetworkInterfacePermission
This permission is required to attach the ENI to the broker instance.
ec2:DeleteNetworkInterface
ec2:DeleteNetworkInterfacePermission
ec2:DetachNetworkInterface
ec2:DescribeInternetGateways
ec2:DescribeNetworkInterfaces
ec2:DescribeNetworkInterfacePermissions
ec2:DescribeRouteTables
ec2:DescribeSecurityGroups
ec2:DescribeSubnets
ec2:DescribeVpcs
For more information, see Create an IAM User and Get Your Amazon Web Services Credentials and Never Modify or Delete the Amazon MQ Elastic Network Interface in the Amazon MQ Developer Guide.
" }, "CreateConfiguration": { "name": "CreateConfiguration", "http": { "method": "POST", "requestUri": "/v1/configurations", "responseCode": 200 }, "input": { "shape": "CreateConfigurationRequest" }, "output": { "shape": "CreateConfigurationResponse", "documentation": "HTTP Status Code 200: OK.
" }, "errors": [ { "shape": "BadRequestException", "documentation": "HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
" }, { "shape": "InternalServerErrorException", "documentation": "HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
" }, { "shape": "ConflictException", "documentation": "HTTP Status Code 409: Conflict. This broker name already exists. Retry your request with another name.
" }, { "shape": "ForbiddenException", "documentation": "HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
" } ], "documentation": "Creates a new configuration for the specified configuration name. Amazon MQ uses the default configuration (the engine type and version).
" }, "CreateTags": { "name": "CreateTags", "http": { "method": "POST", "requestUri": "/v1/tags/{resource-arn}", "responseCode": 204 }, "input": { "shape": "CreateTagsRequest" }, "errors": [ { "shape": "NotFoundException", "documentation": "HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.
" }, { "shape": "BadRequestException", "documentation": "HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
" }, { "shape": "InternalServerErrorException", "documentation": "HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
" }, { "shape": "ForbiddenException", "documentation": "HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
" } ], "documentation": "Add a tag to a resource.
" }, "CreateUser": { "name": "CreateUser", "http": { "method": "POST", "requestUri": "/v1/brokers/{broker-id}/users/{username}", "responseCode": 200 }, "input": { "shape": "CreateUserRequest" }, "output": { "shape": "CreateUserResponse", "documentation": "HTTP Status Code 200: OK.
" }, "errors": [ { "shape": "NotFoundException", "documentation": "HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.
" }, { "shape": "BadRequestException", "documentation": "HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
" }, { "shape": "InternalServerErrorException", "documentation": "HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
" }, { "shape": "ConflictException", "documentation": "HTTP Status Code 409: Conflict. This broker name already exists. Retry your request with another name.
" }, { "shape": "ForbiddenException", "documentation": "HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
" } ], "documentation": "Creates an ActiveMQ user.
Do not add personally identifiable information (PII) or other confidential or sensitive information in broker usernames. Broker usernames are accessible to other Amazon Web Services services, including CloudWatch Logs. Broker usernames are not intended to be used for private or sensitive data.
HTTP Status Code 200: OK.
" }, "errors": [ { "shape": "NotFoundException", "documentation": "HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.
" }, { "shape": "BadRequestException", "documentation": "HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
" }, { "shape": "InternalServerErrorException", "documentation": "HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
" }, { "shape": "ForbiddenException", "documentation": "HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
" } ], "documentation": "Deletes a broker. Note: This API is asynchronous.
" }, "DeleteTags": { "name": "DeleteTags", "http": { "method": "DELETE", "requestUri": "/v1/tags/{resource-arn}", "responseCode": 204 }, "input": { "shape": "DeleteTagsRequest" }, "errors": [ { "shape": "NotFoundException", "documentation": "HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.
" }, { "shape": "BadRequestException", "documentation": "HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
" }, { "shape": "InternalServerErrorException", "documentation": "HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
" }, { "shape": "ForbiddenException", "documentation": "HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
" } ], "documentation": "Removes a tag from a resource.
" }, "DeleteUser": { "name": "DeleteUser", "http": { "method": "DELETE", "requestUri": "/v1/brokers/{broker-id}/users/{username}", "responseCode": 200 }, "input": { "shape": "DeleteUserRequest" }, "output": { "shape": "DeleteUserResponse", "documentation": "HTTP Status Code 200: OK.
" }, "errors": [ { "shape": "NotFoundException", "documentation": "HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.
" }, { "shape": "BadRequestException", "documentation": "HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
" }, { "shape": "InternalServerErrorException", "documentation": "HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
" }, { "shape": "ForbiddenException", "documentation": "HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
" } ], "documentation": "Deletes an ActiveMQ user.
" }, "DescribeBroker": { "name": "DescribeBroker", "http": { "method": "GET", "requestUri": "/v1/brokers/{broker-id}", "responseCode": 200 }, "input": { "shape": "DescribeBrokerRequest" }, "output": { "shape": "DescribeBrokerResponse", "documentation": "HTTP Status Code 200: OK.
" }, "errors": [ { "shape": "NotFoundException", "documentation": "HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.
" }, { "shape": "BadRequestException", "documentation": "HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
" }, { "shape": "InternalServerErrorException", "documentation": "HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
" }, { "shape": "ForbiddenException", "documentation": "HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
" } ], "documentation": "Returns information about the specified broker.
" }, "DescribeBrokerEngineTypes": { "name": "DescribeBrokerEngineTypes", "http": { "method": "GET", "requestUri": "/v1/broker-engine-types", "responseCode": 200 }, "input": { "shape": "DescribeBrokerEngineTypesRequest" }, "output": { "shape": "DescribeBrokerEngineTypesResponse", "documentation": "HTTP Status Code 200: OK.
" }, "errors": [ { "shape": "BadRequestException", "documentation": "HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
" }, { "shape": "InternalServerErrorException", "documentation": "HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
" }, { "shape": "ForbiddenException", "documentation": "HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
" } ], "documentation": "Describe available engine types and versions.
" }, "DescribeBrokerInstanceOptions": { "name": "DescribeBrokerInstanceOptions", "http": { "method": "GET", "requestUri": "/v1/broker-instance-options", "responseCode": 200 }, "input": { "shape": "DescribeBrokerInstanceOptionsRequest" }, "output": { "shape": "DescribeBrokerInstanceOptionsResponse", "documentation": "HTTP Status Code 200: OK.
" }, "errors": [ { "shape": "BadRequestException", "documentation": "HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
" }, { "shape": "InternalServerErrorException", "documentation": "HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
" }, { "shape": "ForbiddenException", "documentation": "HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
" } ], "documentation": "Describe available broker instance options.
" }, "DescribeConfiguration": { "name": "DescribeConfiguration", "http": { "method": "GET", "requestUri": "/v1/configurations/{configuration-id}", "responseCode": 200 }, "input": { "shape": "DescribeConfigurationRequest" }, "output": { "shape": "DescribeConfigurationResponse", "documentation": "HTTP Status Code 200: OK.
" }, "errors": [ { "shape": "NotFoundException", "documentation": "HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.
" }, { "shape": "BadRequestException", "documentation": "HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
" }, { "shape": "InternalServerErrorException", "documentation": "HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
" }, { "shape": "ForbiddenException", "documentation": "HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
" } ], "documentation": "Returns information about the specified configuration.
" }, "DescribeConfigurationRevision": { "name": "DescribeConfigurationRevision", "http": { "method": "GET", "requestUri": "/v1/configurations/{configuration-id}/revisions/{configuration-revision}", "responseCode": 200 }, "input": { "shape": "DescribeConfigurationRevisionRequest" }, "output": { "shape": "DescribeConfigurationRevisionResponse", "documentation": "HTTP Status Code 200: OK.
" }, "errors": [ { "shape": "NotFoundException", "documentation": "HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.
" }, { "shape": "BadRequestException", "documentation": "HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
" }, { "shape": "InternalServerErrorException", "documentation": "HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
" }, { "shape": "ForbiddenException", "documentation": "HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
" } ], "documentation": "Returns the specified configuration revision for the specified configuration.
" }, "DescribeUser": { "name": "DescribeUser", "http": { "method": "GET", "requestUri": "/v1/brokers/{broker-id}/users/{username}", "responseCode": 200 }, "input": { "shape": "DescribeUserRequest" }, "output": { "shape": "DescribeUserResponse", "documentation": "HTTP Status Code 200: OK.
" }, "errors": [ { "shape": "NotFoundException", "documentation": "HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.
" }, { "shape": "BadRequestException", "documentation": "HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
" }, { "shape": "InternalServerErrorException", "documentation": "HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
" }, { "shape": "ForbiddenException", "documentation": "HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
" } ], "documentation": "Returns information about an ActiveMQ user.
" }, "ListBrokers": { "name": "ListBrokers", "http": { "method": "GET", "requestUri": "/v1/brokers", "responseCode": 200 }, "input": { "shape": "ListBrokersRequest" }, "output": { "shape": "ListBrokersResponse", "documentation": "HTTP Status Code 200: OK.
" }, "errors": [ { "shape": "BadRequestException", "documentation": "HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
" }, { "shape": "InternalServerErrorException", "documentation": "HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
" }, { "shape": "ForbiddenException", "documentation": "HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
" } ], "documentation": "Returns a list of all brokers.
" }, "ListConfigurationRevisions": { "name": "ListConfigurationRevisions", "http": { "method": "GET", "requestUri": "/v1/configurations/{configuration-id}/revisions", "responseCode": 200 }, "input": { "shape": "ListConfigurationRevisionsRequest" }, "output": { "shape": "ListConfigurationRevisionsResponse", "documentation": "HTTP Status Code 200: OK.
" }, "errors": [ { "shape": "NotFoundException", "documentation": "HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.
" }, { "shape": "BadRequestException", "documentation": "HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
" }, { "shape": "InternalServerErrorException", "documentation": "HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
" }, { "shape": "ForbiddenException", "documentation": "HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
" } ], "documentation": "Returns a list of all revisions for the specified configuration.
" }, "ListConfigurations": { "name": "ListConfigurations", "http": { "method": "GET", "requestUri": "/v1/configurations", "responseCode": 200 }, "input": { "shape": "ListConfigurationsRequest" }, "output": { "shape": "ListConfigurationsResponse", "documentation": "HTTP Status Code 200: OK.
" }, "errors": [ { "shape": "BadRequestException", "documentation": "HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
" }, { "shape": "InternalServerErrorException", "documentation": "HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
" }, { "shape": "ForbiddenException", "documentation": "HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
" } ], "documentation": "Returns a list of all configurations.
" }, "ListTags": { "name": "ListTags", "http": { "method": "GET", "requestUri": "/v1/tags/{resource-arn}", "responseCode": 200 }, "input": { "shape": "ListTagsRequest" }, "output": { "shape": "ListTagsResponse", "documentation": "HTTP Status Code 200: OK.
" }, "errors": [ { "shape": "NotFoundException", "documentation": "HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.
" }, { "shape": "BadRequestException", "documentation": "HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
" }, { "shape": "InternalServerErrorException", "documentation": "HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
" }, { "shape": "ForbiddenException", "documentation": "HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
" } ], "documentation": "Lists tags for a resource.
" }, "ListUsers": { "name": "ListUsers", "http": { "method": "GET", "requestUri": "/v1/brokers/{broker-id}/users", "responseCode": 200 }, "input": { "shape": "ListUsersRequest" }, "output": { "shape": "ListUsersResponse", "documentation": "HTTP Status Code 200: OK.
" }, "errors": [ { "shape": "NotFoundException", "documentation": "HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.
" }, { "shape": "BadRequestException", "documentation": "HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
" }, { "shape": "InternalServerErrorException", "documentation": "HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
" }, { "shape": "ForbiddenException", "documentation": "HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
" } ], "documentation": "Returns a list of all ActiveMQ users.
" }, "Promote": { "name": "Promote", "http": { "method": "POST", "requestUri": "/v1/brokers/{broker-id}/promote", "responseCode": 200 }, "input": { "shape": "PromoteRequest" }, "output": { "shape": "PromoteResponse", "documentation": "HTTP Status Code 200: OK.
" }, "errors": [ { "shape": "NotFoundException", "documentation": "HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.
" }, { "shape": "BadRequestException", "documentation": "HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
" }, { "shape": "InternalServerErrorException", "documentation": "HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
" }, { "shape": "ForbiddenException", "documentation": "HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
" } ], "documentation": "Promotes a data replication replica broker to the primary broker role.
" }, "RebootBroker": { "name": "RebootBroker", "http": { "method": "POST", "requestUri": "/v1/brokers/{broker-id}/reboot", "responseCode": 200 }, "input": { "shape": "RebootBrokerRequest" }, "output": { "shape": "RebootBrokerResponse", "documentation": "HTTP Status Code 200: OK.
" }, "errors": [ { "shape": "NotFoundException", "documentation": "HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.
" }, { "shape": "BadRequestException", "documentation": "HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
" }, { "shape": "InternalServerErrorException", "documentation": "HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
" }, { "shape": "ForbiddenException", "documentation": "HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
" } ], "documentation": "Reboots a broker. Note: This API is asynchronous.
" }, "UpdateBroker": { "name": "UpdateBroker", "http": { "method": "PUT", "requestUri": "/v1/brokers/{broker-id}", "responseCode": 200 }, "input": { "shape": "UpdateBrokerRequest" }, "output": { "shape": "UpdateBrokerResponse", "documentation": "HTTP Status Code 200: OK.
" }, "errors": [ { "shape": "NotFoundException", "documentation": "HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.
" }, { "shape": "BadRequestException", "documentation": "HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
" }, { "shape": "InternalServerErrorException", "documentation": "HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
" }, { "shape": "ConflictException", "documentation": "HTTP Status Code 409: Conflict. This broker name already exists. Retry your request with another name.
" }, { "shape": "ForbiddenException", "documentation": "HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
" } ], "documentation": "Adds a pending configuration change to a broker.
" }, "UpdateConfiguration": { "name": "UpdateConfiguration", "http": { "method": "PUT", "requestUri": "/v1/configurations/{configuration-id}", "responseCode": 200 }, "input": { "shape": "UpdateConfigurationRequest" }, "output": { "shape": "UpdateConfigurationResponse", "documentation": "HTTP Status Code 200: OK.
" }, "errors": [ { "shape": "NotFoundException", "documentation": "HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.
" }, { "shape": "BadRequestException", "documentation": "HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
" }, { "shape": "InternalServerErrorException", "documentation": "HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
" }, { "shape": "ConflictException", "documentation": "HTTP Status Code 409: Conflict. This broker name already exists. Retry your request with another name.
" }, { "shape": "ForbiddenException", "documentation": "HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
" } ], "documentation": "Updates the specified configuration.
" }, "UpdateUser": { "name": "UpdateUser", "http": { "method": "PUT", "requestUri": "/v1/brokers/{broker-id}/users/{username}", "responseCode": 200 }, "input": { "shape": "UpdateUserRequest" }, "output": { "shape": "UpdateUserResponse", "documentation": "HTTP Status Code 200: OK.
" }, "errors": [ { "shape": "NotFoundException", "documentation": "HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.
" }, { "shape": "BadRequestException", "documentation": "HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
" }, { "shape": "InternalServerErrorException", "documentation": "HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
" }, { "shape": "ConflictException", "documentation": "HTTP Status Code 409: Conflict. This broker name already exists. Retry your request with another name.
" }, { "shape": "ForbiddenException", "documentation": "HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
" } ], "documentation": "Updates the information for an ActiveMQ user.
" } }, "shapes": { "ActionRequired": { "type": "structure", "members": { "ActionRequiredCode": { "shape": "__string", "locationName": "actionRequiredCode", "documentation": "The code you can use to find instructions on the action required to resolve your broker issue.
" }, "ActionRequiredInfo": { "shape": "__string", "locationName": "actionRequiredInfo", "documentation": "Information about the action required to resolve your broker issue.
" } }, "documentation": "Action required for a broker.
" }, "AuthenticationStrategy": { "type": "string", "documentation": "Optional. The authentication strategy used to secure the broker. The default is SIMPLE.
", "enum": [ "SIMPLE", "LDAP" ] }, "AvailabilityZone": { "type": "structure", "members": { "Name": { "shape": "__string", "locationName": "name", "documentation": "Id for the availability zone.
" } }, "documentation": "Name of the availability zone.
" }, "BrokerEngineType": { "type": "structure", "members": { "EngineType": { "shape": "EngineType", "locationName": "engineType", "documentation": "The broker's engine type.
" }, "EngineVersions": { "shape": "__listOfEngineVersion", "locationName": "engineVersions", "documentation": "The list of engine versions.
" } }, "documentation": "Types of broker engines.
" }, "BrokerInstance": { "type": "structure", "members": { "ConsoleURL": { "shape": "__string", "locationName": "consoleURL", "documentation": "The brokers web console URL.
" }, "Endpoints": { "shape": "__listOf__string", "locationName": "endpoints", "documentation": "The broker's wire-level protocol endpoints.
" }, "IpAddress": { "shape": "__string", "locationName": "ipAddress", "documentation": "The IP address of the Elastic Network Interface (ENI) attached to the broker. Does not apply to RabbitMQ brokers.
" } }, "documentation": "Returns information about all brokers.
" }, "BrokerInstanceOption": { "type": "structure", "members": { "AvailabilityZones": { "shape": "__listOfAvailabilityZone", "locationName": "availabilityZones", "documentation": "The list of available az.
" }, "EngineType": { "shape": "EngineType", "locationName": "engineType", "documentation": "The broker's engine type.
" }, "HostInstanceType": { "shape": "__string", "locationName": "hostInstanceType", "documentation": "The broker's instance type.
" }, "StorageType": { "shape": "BrokerStorageType", "locationName": "storageType", "documentation": "The broker's storage type.
" }, "SupportedDeploymentModes": { "shape": "__listOfDeploymentMode", "locationName": "supportedDeploymentModes", "documentation": "The list of supported deployment modes.
" }, "SupportedEngineVersions": { "shape": "__listOf__string", "locationName": "supportedEngineVersions", "documentation": "The list of supported engine versions.
" } }, "documentation": "Option for host instance type.
" }, "BrokerState": { "type": "string", "documentation": "The broker's status.
", "enum": [ "CREATION_IN_PROGRESS", "CREATION_FAILED", "DELETION_IN_PROGRESS", "RUNNING", "REBOOT_IN_PROGRESS", "CRITICAL_ACTION_REQUIRED", "REPLICA" ] }, "BrokerStorageType": { "type": "string", "documentation": "The broker's storage type.
EFS is not supported for RabbitMQ engine type.
The broker's Amazon Resource Name (ARN).
" }, "BrokerId": { "shape": "__string", "locationName": "brokerId", "documentation": "The unique ID that Amazon MQ generates for the broker.
" }, "BrokerName": { "shape": "__string", "locationName": "brokerName", "documentation": "The broker's name. This value is unique in your Amazon Web Services account, 1-50 characters long, and containing only letters, numbers, dashes, and underscores, and must not contain white spaces, brackets, wildcard characters, or special characters.
" }, "BrokerState": { "shape": "BrokerState", "locationName": "brokerState", "documentation": "The broker's status.
" }, "Created": { "shape": "__timestampIso8601", "locationName": "created", "documentation": "The time when the broker was created.
" }, "DeploymentMode": { "shape": "DeploymentMode", "locationName": "deploymentMode", "documentation": "The broker's deployment mode.
" }, "EngineType": { "shape": "EngineType", "locationName": "engineType", "documentation": "The type of broker engine.
" }, "HostInstanceType": { "shape": "__string", "locationName": "hostInstanceType", "documentation": "The broker's instance type.
" } }, "documentation": "Returns information about all brokers.
", "required": [ "DeploymentMode", "EngineType" ] }, "ChangeType": { "type": "string", "documentation": "The type of change pending for the ActiveMQ user.
", "enum": [ "CREATE", "UPDATE", "DELETE" ] }, "Configuration": { "type": "structure", "members": { "Arn": { "shape": "__string", "locationName": "arn", "documentation": "Required. The ARN of the configuration.
" }, "AuthenticationStrategy": { "shape": "AuthenticationStrategy", "locationName": "authenticationStrategy", "documentation": "Optional. The authentication strategy associated with the configuration. The default is SIMPLE.
" }, "Created": { "shape": "__timestampIso8601", "locationName": "created", "documentation": "Required. The date and time of the configuration revision.
" }, "Description": { "shape": "__string", "locationName": "description", "documentation": "Required. The description of the configuration.
" }, "EngineType": { "shape": "EngineType", "locationName": "engineType", "documentation": "Required. The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.
" }, "EngineVersion": { "shape": "__string", "locationName": "engineVersion", "documentation": "The broker engine version. Defaults to the latest available version for the specified broker engine type. For a list of supported engine versions, see the ActiveMQ version management and the RabbitMQ version management sections in the Amazon MQ Developer Guide.
" }, "Id": { "shape": "__string", "locationName": "id", "documentation": "Required. The unique ID that Amazon MQ generates for the configuration.
" }, "LatestRevision": { "shape": "ConfigurationRevision", "locationName": "latestRevision", "documentation": "Required. The latest revision of the configuration.
" }, "Name": { "shape": "__string", "locationName": "name", "documentation": "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": { "shape": "__mapOf__string", "locationName": "tags", "documentation": "The list of all tags associated with this configuration.
" } }, "documentation": "Returns information about all configurations.
", "required": [ "Description", "EngineVersion", "LatestRevision", "AuthenticationStrategy", "EngineType", "Id", "Arn", "Name", "Created" ] }, "ConfigurationId": { "type": "structure", "members": { "Id": { "shape": "__string", "locationName": "id", "documentation": "Required. The unique ID that Amazon MQ generates for the configuration.
" }, "Revision": { "shape": "__integer", "locationName": "revision", "documentation": "The revision number of the configuration.
" } }, "documentation": "A list of information about the configuration.
", "required": [ "Id" ] }, "ConfigurationRevision": { "type": "structure", "members": { "Created": { "shape": "__timestampIso8601", "locationName": "created", "documentation": "Required. The date and time of the configuration revision.
" }, "Description": { "shape": "__string", "locationName": "description", "documentation": "The description of the configuration revision.
" }, "Revision": { "shape": "__integer", "locationName": "revision", "documentation": "Required. The revision number of the configuration.
" } }, "documentation": "Returns information about the specified configuration revision.
", "required": [ "Revision", "Created" ] }, "Configurations": { "type": "structure", "members": { "Current": { "shape": "ConfigurationId", "locationName": "current", "documentation": "The broker's current configuration.
" }, "History": { "shape": "__listOfConfigurationId", "locationName": "history", "documentation": "The history of configurations applied to the broker.
" }, "Pending": { "shape": "ConfigurationId", "locationName": "pending", "documentation": "The broker's pending configuration.
" } }, "documentation": "Broker configuration information
" }, "CreateBrokerRequest": { "type": "structure", "members": { "AuthenticationStrategy": { "shape": "AuthenticationStrategy", "locationName": "authenticationStrategy", "documentation": "Optional. The authentication strategy used to secure the broker. The default is SIMPLE.
" }, "AutoMinorVersionUpgrade": { "shape": "__boolean", "locationName": "autoMinorVersionUpgrade", "documentation": "Enables automatic upgrades to new patch versions for brokers as new versions are released and supported by Amazon MQ. Automatic upgrades occur during the scheduled maintenance window or after a manual broker reboot. Set to true by default, if no value is specified.
Must be set to true for ActiveMQ brokers version 5.18 and above and for RabbitMQ brokers version 3.13 and above.
Required. The broker's name. This value must be unique in your Amazon Web Services account, 1-50 characters long, must contain only letters, numbers, dashes, and underscores, and must not contain white spaces, brackets, wildcard characters, or special characters.
Do not add personally identifiable information (PII) or other confidential or sensitive information in broker names. Broker names are accessible to other Amazon Web Services services, including CloudWatch Logs. Broker names are not intended to be used for private or sensitive data.
A list of information about the configuration.
" }, "CreatorRequestId": { "shape": "__string", "locationName": "creatorRequestId", "documentation": "The unique ID that the requester receives for the created broker. Amazon MQ passes your ID with the API action.
We recommend using a Universally Unique Identifier (UUID) for the creatorRequestId. You may omit the creatorRequestId if your application doesn't require idempotency.
Required. The broker's deployment mode.
" }, "EncryptionOptions": { "shape": "EncryptionOptions", "locationName": "encryptionOptions", "documentation": "Encryption options for the broker.
" }, "EngineType": { "shape": "EngineType", "locationName": "engineType", "documentation": "Required. The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.
" }, "EngineVersion": { "shape": "__string", "locationName": "engineVersion", "documentation": "The broker engine version. Defaults to the latest available version for the specified broker engine type. For more information, see the ActiveMQ version management and the RabbitMQ version management sections in the Amazon MQ Developer Guide.
" }, "HostInstanceType": { "shape": "__string", "locationName": "hostInstanceType", "documentation": "Required. The broker's instance type.
" }, "LdapServerMetadata": { "shape": "LdapServerMetadataInput", "locationName": "ldapServerMetadata", "documentation": "Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker. Does not apply to RabbitMQ brokers.
" }, "Logs": { "shape": "Logs", "locationName": "logs", "documentation": "Enables Amazon CloudWatch logging for brokers.
" }, "MaintenanceWindowStartTime": { "shape": "WeeklyStartTime", "locationName": "maintenanceWindowStartTime", "documentation": "The parameters that determine the WeeklyStartTime.
" }, "PubliclyAccessible": { "shape": "__boolean", "locationName": "publiclyAccessible", "documentation": "Enables connections from applications outside of the VPC that hosts the broker's subnets. Set to false by default, if no value is provided.
" }, "SecurityGroups": { "shape": "__listOf__string", "locationName": "securityGroups", "documentation": "The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.
" }, "StorageType": { "shape": "BrokerStorageType", "locationName": "storageType", "documentation": "The broker's storage type.
" }, "SubnetIds": { "shape": "__listOf__string", "locationName": "subnetIds", "documentation": "The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones. If you specify more than one subnet, the subnets must be in different Availability Zones. Amazon MQ will not be able to create VPC endpoints for your broker with multiple subnets in the same Availability Zone. A SINGLE_INSTANCE deployment requires one subnet (for example, the default subnet). An ACTIVE_STANDBY_MULTI_AZ Amazon MQ for ActiveMQ deployment requires two subnets. A CLUSTER_MULTI_AZ Amazon MQ for RabbitMQ deployment has no subnet requirements when deployed with public accessibility. Deployment without public accessibility requires at least one subnet.
If you specify subnets in a shared VPC for a RabbitMQ broker, the associated VPC to which the specified subnets belong must be owned by your Amazon Web Services account. Amazon MQ will not be able to create VPC endpoints in VPCs that are not owned by your Amazon Web Services account.
Create tags when creating the broker.
" }, "Users": { "shape": "__listOfUser", "locationName": "users", "documentation": "The list of broker users (persons or applications) who can access queues and topics. For Amazon MQ for RabbitMQ brokers, one and only one administrative user is accepted and created when a broker is first provisioned. All subsequent broker users are created by making RabbitMQ API calls directly to brokers or via the RabbitMQ web console.
" }, "DataReplicationMode": { "shape": "DataReplicationMode", "locationName": "dataReplicationMode", "documentation": "Defines whether this broker is a part of a data replication pair.
" }, "DataReplicationPrimaryBrokerArn": { "shape": "__string", "locationName": "dataReplicationPrimaryBrokerArn", "documentation": "The Amazon Resource Name (ARN) of the primary broker that is used to replicate data from in a data replication pair, and is applied to the replica broker. Must be set when dataReplicationMode is set to CRDR.
" } }, "documentation": "Creates a broker using the specified properties.
", "required": [ "HostInstanceType", "Users", "BrokerName", "DeploymentMode", "EngineType", "PubliclyAccessible" ] }, "CreateBrokerResponse": { "type": "structure", "members": { "BrokerArn": { "shape": "__string", "locationName": "brokerArn", "documentation": "The broker's Amazon Resource Name (ARN).
" }, "BrokerId": { "shape": "__string", "locationName": "brokerId", "documentation": "The unique ID that Amazon MQ generates for the broker.
" } } }, "CreateConfigurationRequest": { "type": "structure", "members": { "AuthenticationStrategy": { "shape": "AuthenticationStrategy", "locationName": "authenticationStrategy", "documentation": "Optional. The authentication strategy associated with the configuration. The default is SIMPLE.
" }, "EngineType": { "shape": "EngineType", "locationName": "engineType", "documentation": "Required. The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.
" }, "EngineVersion": { "shape": "__string", "locationName": "engineVersion", "documentation": "The broker engine version. Defaults to the latest available version for the specified broker engine type. For more information, see the ActiveMQ version management and the RabbitMQ version management sections in the Amazon MQ Developer Guide.
" }, "Name": { "shape": "__string", "locationName": "name", "documentation": "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": { "shape": "__mapOf__string", "locationName": "tags", "documentation": "Create tags when creating the configuration.
" } }, "documentation": "Creates a new configuration for the specified configuration name. Amazon MQ uses the default configuration (the engine type and version).
", "required": [ "EngineType", "Name" ] }, "CreateConfigurationResponse": { "type": "structure", "members": { "Arn": { "shape": "__string", "locationName": "arn", "documentation": "Required. The Amazon Resource Name (ARN) of the configuration.
" }, "AuthenticationStrategy": { "shape": "AuthenticationStrategy", "locationName": "authenticationStrategy", "documentation": "Optional. The authentication strategy associated with the configuration. The default is SIMPLE.
" }, "Created": { "shape": "__timestampIso8601", "locationName": "created", "documentation": "Required. The date and time of the configuration.
" }, "Id": { "shape": "__string", "locationName": "id", "documentation": "Required. The unique ID that Amazon MQ generates for the configuration.
" }, "LatestRevision": { "shape": "ConfigurationRevision", "locationName": "latestRevision", "documentation": "The latest revision of the configuration.
" }, "Name": { "shape": "__string", "locationName": "name", "documentation": "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.
" } } }, "CreateTagsRequest": { "type": "structure", "members": { "ResourceArn": { "shape": "__string", "location": "uri", "locationName": "resource-arn", "documentation": "The Amazon Resource Name (ARN) of the resource tag.
" }, "Tags": { "shape": "__mapOf__string", "locationName": "tags", "documentation": "The key-value pair for the resource tag.
" } }, "documentation": "A map of the key-value pairs for the resource tag.
", "required": [ "ResourceArn" ] }, "CreateUserRequest": { "type": "structure", "members": { "BrokerId": { "shape": "__string", "location": "uri", "locationName": "broker-id", "documentation": "The unique ID that Amazon MQ generates for the broker.
" }, "ConsoleAccess": { "shape": "__boolean", "locationName": "consoleAccess", "documentation": "Enables access to the ActiveMQ Web Console for the ActiveMQ user.
" }, "Groups": { "shape": "__listOf__string", "locationName": "groups", "documentation": "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": { "shape": "__string", "locationName": "password", "documentation": "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, colons, or equal signs (,:=).
" }, "Username": { "shape": "__string", "location": "uri", "locationName": "username", "documentation": "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.
" }, "ReplicationUser": { "shape": "__boolean", "locationName": "replicationUser", "documentation": "Defines if this user is intended for CRDR replication purposes.
" } }, "documentation": "Creates a new ActiveMQ user.
", "required": [ "Username", "BrokerId", "Password" ] }, "CreateUserResponse": { "type": "structure", "members": {} }, "DataReplicationCounterpart": { "type": "structure", "members": { "BrokerId": { "shape": "__string", "locationName": "brokerId", "documentation": "Required. The unique broker id generated by Amazon MQ.
" }, "Region": { "shape": "__string", "locationName": "region", "documentation": "Required. The region of the broker.
" } }, "documentation": "Specifies a broker in a data replication pair.
", "required": [ "BrokerId", "Region" ] }, "DataReplicationMetadataOutput": { "type": "structure", "members": { "DataReplicationCounterpart": { "shape": "DataReplicationCounterpart", "locationName": "dataReplicationCounterpart", "documentation": "Describes the replica/primary broker. Only returned if this broker is currently set as a primary or replica in the broker's dataReplicationRole property.
" }, "DataReplicationRole": { "shape": "__string", "locationName": "dataReplicationRole", "documentation": "Defines the role of this broker in a data replication pair. When a replica broker is promoted to primary, this role is interchanged.
" } }, "documentation": "The replication details of the data replication-enabled broker. Only returned if dataReplicationMode or pendingDataReplicationMode is set to CRDR.
", "required": [ "DataReplicationRole" ] }, "DataReplicationMode": { "type": "string", "documentation": "Specifies whether a broker is a part of a data replication pair.
", "enum": [ "NONE", "CRDR" ] }, "DayOfWeek": { "type": "string", "enum": [ "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY" ] }, "DeleteBrokerRequest": { "type": "structure", "members": { "BrokerId": { "shape": "__string", "location": "uri", "locationName": "broker-id", "documentation": "The unique ID that Amazon MQ generates for the broker.
" } }, "required": [ "BrokerId" ] }, "DeleteBrokerResponse": { "type": "structure", "members": { "BrokerId": { "shape": "__string", "locationName": "brokerId", "documentation": "The unique ID that Amazon MQ generates for the broker.
" } } }, "DeleteTagsRequest": { "type": "structure", "members": { "ResourceArn": { "shape": "__string", "location": "uri", "locationName": "resource-arn", "documentation": "The Amazon Resource Name (ARN) of the resource tag.
" }, "TagKeys": { "shape": "__listOf__string", "location": "querystring", "locationName": "tagKeys", "documentation": "An array of tag keys to delete
" } }, "required": [ "TagKeys", "ResourceArn" ] }, "DeleteUserRequest": { "type": "structure", "members": { "BrokerId": { "shape": "__string", "location": "uri", "locationName": "broker-id", "documentation": "The unique ID that Amazon MQ generates for the broker.
" }, "Username": { "shape": "__string", "location": "uri", "locationName": "username", "documentation": "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.
" } }, "required": [ "Username", "BrokerId" ] }, "DeleteUserResponse": { "type": "structure", "members": {} }, "DeploymentMode": { "type": "string", "documentation": "The broker's deployment mode.
", "enum": [ "SINGLE_INSTANCE", "ACTIVE_STANDBY_MULTI_AZ", "CLUSTER_MULTI_AZ" ] }, "DescribeBrokerEngineTypesRequest": { "type": "structure", "members": { "EngineType": { "shape": "__string", "location": "querystring", "locationName": "engineType", "documentation": "Filter response by engine type.
" }, "MaxResults": { "shape": "MaxResults", "location": "querystring", "locationName": "maxResults", "documentation": "The maximum number of brokers that Amazon MQ can return per page (20 by default). This value must be an integer from 5 to 100.
" }, "NextToken": { "shape": "__string", "location": "querystring", "locationName": "nextToken", "documentation": "The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.
" } } }, "DescribeBrokerEngineTypesResponse": { "type": "structure", "members": { "BrokerEngineTypes": { "shape": "__listOfBrokerEngineType", "locationName": "brokerEngineTypes", "documentation": "List of available engine types and versions.
" }, "MaxResults": { "shape": "__integerMin5Max100", "locationName": "maxResults", "documentation": "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": { "shape": "__string", "locationName": "nextToken", "documentation": "The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.
" } } }, "DescribeBrokerInstanceOptionsRequest": { "type": "structure", "members": { "EngineType": { "shape": "__string", "location": "querystring", "locationName": "engineType", "documentation": "Filter response by engine type.
" }, "HostInstanceType": { "shape": "__string", "location": "querystring", "locationName": "hostInstanceType", "documentation": "Filter response by host instance type.
" }, "MaxResults": { "shape": "MaxResults", "location": "querystring", "locationName": "maxResults", "documentation": "The maximum number of brokers that Amazon MQ can return per page (20 by default). This value must be an integer from 5 to 100.
" }, "NextToken": { "shape": "__string", "location": "querystring", "locationName": "nextToken", "documentation": "The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.
" }, "StorageType": { "shape": "__string", "location": "querystring", "locationName": "storageType", "documentation": "Filter response by storage type.
" } } }, "DescribeBrokerInstanceOptionsResponse": { "type": "structure", "members": { "BrokerInstanceOptions": { "shape": "__listOfBrokerInstanceOption", "locationName": "brokerInstanceOptions", "documentation": "List of available broker instance options.
" }, "MaxResults": { "shape": "__integerMin5Max100", "locationName": "maxResults", "documentation": "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": { "shape": "__string", "locationName": "nextToken", "documentation": "The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.
" } } }, "DescribeBrokerRequest": { "type": "structure", "members": { "BrokerId": { "shape": "__string", "location": "uri", "locationName": "broker-id", "documentation": "The unique ID that Amazon MQ generates for the broker.
" } }, "required": [ "BrokerId" ] }, "DescribeBrokerResponse": { "type": "structure", "members": { "ActionsRequired": { "shape": "__listOfActionRequired", "locationName": "actionsRequired", "documentation": "Actions required for a broker.
" }, "AuthenticationStrategy": { "shape": "AuthenticationStrategy", "locationName": "authenticationStrategy", "documentation": "The authentication strategy used to secure the broker. The default is SIMPLE.
" }, "AutoMinorVersionUpgrade": { "shape": "__boolean", "locationName": "autoMinorVersionUpgrade", "documentation": "Enables automatic upgrades to new patch versions for brokers as new versions are released and supported by Amazon MQ. Automatic upgrades occur during the scheduled maintenance window or after a manual broker reboot.
" }, "BrokerArn": { "shape": "__string", "locationName": "brokerArn", "documentation": "The broker's Amazon Resource Name (ARN).
" }, "BrokerId": { "shape": "__string", "locationName": "brokerId", "documentation": "The unique ID that Amazon MQ generates for the broker.
" }, "BrokerInstances": { "shape": "__listOfBrokerInstance", "locationName": "brokerInstances", "documentation": "A list of information about allocated brokers.
" }, "BrokerName": { "shape": "__string", "locationName": "brokerName", "documentation": "The broker's name. This value must be unique in your Amazon Web Services account account, 1-50 characters long, must contain only letters, numbers, dashes, and underscores, and must not contain white spaces, brackets, wildcard characters, or special characters.
" }, "BrokerState": { "shape": "BrokerState", "locationName": "brokerState", "documentation": "The broker's status.
" }, "Configurations": { "shape": "Configurations", "locationName": "configurations", "documentation": "The list of all revisions for the specified configuration.
" }, "Created": { "shape": "__timestampIso8601", "locationName": "created", "documentation": "The time when the broker was created.
" }, "DeploymentMode": { "shape": "DeploymentMode", "locationName": "deploymentMode", "documentation": "The broker's deployment mode.
" }, "EncryptionOptions": { "shape": "EncryptionOptions", "locationName": "encryptionOptions", "documentation": "Encryption options for the broker.
" }, "EngineType": { "shape": "EngineType", "locationName": "engineType", "documentation": "The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.
" }, "EngineVersion": { "shape": "__string", "locationName": "engineVersion", "documentation": "The broker engine version. For more information, see the ActiveMQ version management and the RabbitMQ version management sections in the Amazon MQ Developer Guide.
" }, "HostInstanceType": { "shape": "__string", "locationName": "hostInstanceType", "documentation": "The broker's instance type.
" }, "LdapServerMetadata": { "shape": "LdapServerMetadataOutput", "locationName": "ldapServerMetadata", "documentation": "The metadata of the LDAP server used to authenticate and authorize connections to the broker.
" }, "Logs": { "shape": "LogsSummary", "locationName": "logs", "documentation": "The list of information about logs currently enabled and pending to be deployed for the specified broker.
" }, "MaintenanceWindowStartTime": { "shape": "WeeklyStartTime", "locationName": "maintenanceWindowStartTime", "documentation": "The parameters that determine the WeeklyStartTime.
" }, "PendingAuthenticationStrategy": { "shape": "AuthenticationStrategy", "locationName": "pendingAuthenticationStrategy", "documentation": "The authentication strategy that will be applied when the broker is rebooted. The default is SIMPLE.
" }, "PendingEngineVersion": { "shape": "__string", "locationName": "pendingEngineVersion", "documentation": "The broker engine version to upgrade to. For more information, see the ActiveMQ version management and the RabbitMQ version management sections in the Amazon MQ Developer Guide.
" }, "PendingHostInstanceType": { "shape": "__string", "locationName": "pendingHostInstanceType", "documentation": "The broker's host instance type to upgrade to. For a list of supported instance types, see Broker instance types.
" }, "PendingLdapServerMetadata": { "shape": "LdapServerMetadataOutput", "locationName": "pendingLdapServerMetadata", "documentation": "The metadata of the LDAP server that will be used to authenticate and authorize connections to the broker after it is rebooted.
" }, "PendingSecurityGroups": { "shape": "__listOf__string", "locationName": "pendingSecurityGroups", "documentation": "The list of pending security groups to authorize connections to brokers.
" }, "PubliclyAccessible": { "shape": "__boolean", "locationName": "publiclyAccessible", "documentation": "Enables connections from applications outside of the VPC that hosts the broker's subnets.
" }, "SecurityGroups": { "shape": "__listOf__string", "locationName": "securityGroups", "documentation": "The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.
" }, "StorageType": { "shape": "BrokerStorageType", "locationName": "storageType", "documentation": "The broker's storage type.
" }, "SubnetIds": { "shape": "__listOf__string", "locationName": "subnetIds", "documentation": "The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones.
" }, "Tags": { "shape": "__mapOf__string", "locationName": "tags", "documentation": "The list of all tags associated with this broker.
" }, "Users": { "shape": "__listOfUserSummary", "locationName": "users", "documentation": "The list of all broker usernames for the specified broker.
" }, "DataReplicationMetadata": { "shape": "DataReplicationMetadataOutput", "locationName": "dataReplicationMetadata", "documentation": "The replication details of the data replication-enabled broker. Only returned if dataReplicationMode is set to CRDR.
" }, "DataReplicationMode": { "shape": "DataReplicationMode", "locationName": "dataReplicationMode", "documentation": "Describes whether this broker is a part of a data replication pair.
" }, "PendingDataReplicationMetadata": { "shape": "DataReplicationMetadataOutput", "locationName": "pendingDataReplicationMetadata", "documentation": "The pending replication details of the data replication-enabled broker. Only returned if pendingDataReplicationMode is set to CRDR.
" }, "PendingDataReplicationMode": { "shape": "DataReplicationMode", "locationName": "pendingDataReplicationMode", "documentation": "Describes whether this broker will be a part of a data replication pair after reboot.
" } } }, "DescribeConfigurationRequest": { "type": "structure", "members": { "ConfigurationId": { "shape": "__string", "location": "uri", "locationName": "configuration-id", "documentation": "The unique ID that Amazon MQ generates for the configuration.
" } }, "required": [ "ConfigurationId" ] }, "DescribeConfigurationResponse": { "type": "structure", "members": { "Arn": { "shape": "__string", "locationName": "arn", "documentation": "Required. The ARN of the configuration.
" }, "AuthenticationStrategy": { "shape": "AuthenticationStrategy", "locationName": "authenticationStrategy", "documentation": "Optional. The authentication strategy associated with the configuration. The default is SIMPLE.
" }, "Created": { "shape": "__timestampIso8601", "locationName": "created", "documentation": "Required. The date and time of the configuration revision.
" }, "Description": { "shape": "__string", "locationName": "description", "documentation": "Required. The description of the configuration.
" }, "EngineType": { "shape": "EngineType", "locationName": "engineType", "documentation": "Required. The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.
" }, "EngineVersion": { "shape": "__string", "locationName": "engineVersion", "documentation": "The broker engine version. Defaults to the latest available version for the specified broker engine type. For a list of supported engine versions, see the ActiveMQ version management and the RabbitMQ version management sections in the Amazon MQ Developer Guide.
" }, "Id": { "shape": "__string", "locationName": "id", "documentation": "Required. The unique ID that Amazon MQ generates for the configuration.
" }, "LatestRevision": { "shape": "ConfigurationRevision", "locationName": "latestRevision", "documentation": "Required. The latest revision of the configuration.
" }, "Name": { "shape": "__string", "locationName": "name", "documentation": "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": { "shape": "__mapOf__string", "locationName": "tags", "documentation": "The list of all tags associated with this configuration.
" } } }, "DescribeConfigurationRevisionRequest": { "type": "structure", "members": { "ConfigurationId": { "shape": "__string", "location": "uri", "locationName": "configuration-id", "documentation": "The unique ID that Amazon MQ generates for the configuration.
" }, "ConfigurationRevision": { "shape": "__string", "location": "uri", "locationName": "configuration-revision", "documentation": "The revision of the configuration.
" } }, "required": [ "ConfigurationRevision", "ConfigurationId" ] }, "DescribeConfigurationRevisionResponse": { "type": "structure", "members": { "ConfigurationId": { "shape": "__string", "locationName": "configurationId", "documentation": "Required. The unique ID that Amazon MQ generates for the configuration.
" }, "Created": { "shape": "__timestampIso8601", "locationName": "created", "documentation": "Required. The date and time of the configuration.
" }, "Data": { "shape": "__string", "locationName": "data", "documentation": "Amazon MQ for ActiveMQ: the base64-encoded XML configuration. Amazon MQ for RabbitMQ: base64-encoded Cuttlefish.
" }, "Description": { "shape": "__string", "locationName": "description", "documentation": "The description of the configuration.
" } } }, "DescribeUserRequest": { "type": "structure", "members": { "BrokerId": { "shape": "__string", "location": "uri", "locationName": "broker-id", "documentation": "The unique ID that Amazon MQ generates for the broker.
" }, "Username": { "shape": "__string", "location": "uri", "locationName": "username", "documentation": "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.
" } }, "required": [ "Username", "BrokerId" ] }, "DescribeUserResponse": { "type": "structure", "members": { "BrokerId": { "shape": "__string", "locationName": "brokerId", "documentation": "Required. The unique ID that Amazon MQ generates for the broker.
" }, "ConsoleAccess": { "shape": "__boolean", "locationName": "consoleAccess", "documentation": "Enables access to the the ActiveMQ Web Console for the ActiveMQ user.
" }, "Groups": { "shape": "__listOf__string", "locationName": "groups", "documentation": "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": { "shape": "UserPendingChanges", "locationName": "pending", "documentation": "The status of the changes pending for the ActiveMQ user.
" }, "Username": { "shape": "__string", "locationName": "username", "documentation": "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.
" }, "ReplicationUser": { "shape": "__boolean", "locationName": "replicationUser", "documentation": "Describes whether the user is intended for data replication
" } } }, "EncryptionOptions": { "type": "structure", "members": { "KmsKeyId": { "shape": "__string", "locationName": "kmsKeyId", "documentation": "The customer master key (CMK) to use for the A KMS (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": { "shape": "__boolean", "locationName": "useAwsOwnedKey", "documentation": "Enables the use of an Amazon Web Services owned CMK using KMS (KMS). Set to true by default, if no value is provided, for example, for RabbitMQ brokers.
" } }, "documentation": "Encryption options for the broker.
", "required": [ "UseAwsOwnedKey" ] }, "EngineType": { "type": "string", "documentation": "The type of broker engine. Amazon MQ supports ActiveMQ and RabbitMQ.
", "enum": [ "ACTIVEMQ", "RABBITMQ" ] }, "EngineVersion": { "type": "structure", "members": { "Name": { "shape": "__string", "locationName": "name", "documentation": "Id for the version.
" } }, "documentation": "Id of the engine version.
" }, "LdapServerMetadataInput": { "type": "structure", "members": { "Hosts": { "shape": "__listOf__string", "locationName": "hosts", "documentation": "Specifies the location of the LDAP server such as Directory Service for Microsoft Active Directory. Optional failover server.
" }, "RoleBase": { "shape": "__string", "locationName": "roleBase", "documentation": "The distinguished name of the node in the directory information tree (DIT) to search for roles or groups. For example, ou=group, ou=corp, dc=corp,\n dc=example, dc=com.
" }, "RoleName": { "shape": "__string", "locationName": "roleName", "documentation": "Specifies the LDAP attribute that identifies the group name attribute in the object returned from the group membership query.
" }, "RoleSearchMatching": { "shape": "__string", "locationName": "roleSearchMatching", "documentation": "The LDAP search filter used to find roles within the roleBase. The distinguished name of the user matched by userSearchMatching is substituted into the {0} placeholder in the search filter. The client's username is substituted into the {1} placeholder. For example, if you set this option to (member=uid={1})for the user janedoe, the search filter becomes (member=uid=janedoe) after string substitution. It matches all role entries that have a member attribute equal to uid=janedoe under the subtree selected by the roleBase.
" }, "RoleSearchSubtree": { "shape": "__boolean", "locationName": "roleSearchSubtree", "documentation": "The directory search scope for the role. If set to true, scope is to search the entire subtree.
" }, "ServiceAccountPassword": { "shape": "__string", "locationName": "serviceAccountPassword", "documentation": "Service account password. A service account is an account in your LDAP server that has access to initiate a connection. For example, cn=admin,dc=corp, dc=example,\n dc=com.
" }, "ServiceAccountUsername": { "shape": "__string", "locationName": "serviceAccountUsername", "documentation": "Service account username. A service account is an account in your LDAP server that has access to initiate a connection. For example, cn=admin,dc=corp, dc=example,\n dc=com.
" }, "UserBase": { "shape": "__string", "locationName": "userBase", "documentation": "Select a particular subtree of the directory information tree (DIT) to search for user entries. The subtree is specified by a DN, which specifies the base node of the subtree. For example, by setting this option to ou=Users,ou=corp, dc=corp,\n dc=example, dc=com, the search for user entries is restricted to the subtree beneath ou=Users, ou=corp, dc=corp, dc=example, dc=com.
" }, "UserRoleName": { "shape": "__string", "locationName": "userRoleName", "documentation": "Specifies the name of the LDAP attribute for the user group membership.
" }, "UserSearchMatching": { "shape": "__string", "locationName": "userSearchMatching", "documentation": "The LDAP search filter used to find users within the userBase. The client's username is substituted into the {0} placeholder in the search filter. For example, if this option is set to (uid={0}) and the received username is janedoe, the search filter becomes (uid=janedoe) after string substitution. It will result in matching an entry like uid=janedoe, ou=Users,ou=corp, dc=corp, dc=example,\n dc=com.
" }, "UserSearchSubtree": { "shape": "__boolean", "locationName": "userSearchSubtree", "documentation": "The directory search scope for the user. If set to true, scope is to search the entire subtree.
" } }, "documentation": "Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker.
Does not apply to RabbitMQ brokers.
Specifies the location of the LDAP server such as Directory Service for Microsoft Active Directory. Optional failover server.
" }, "RoleBase": { "shape": "__string", "locationName": "roleBase", "documentation": "The distinguished name of the node in the directory information tree (DIT) to search for roles or groups. For example, ou=group, ou=corp, dc=corp,\n dc=example, dc=com.
" }, "RoleName": { "shape": "__string", "locationName": "roleName", "documentation": "Specifies the LDAP attribute that identifies the group name attribute in the object returned from the group membership query.
" }, "RoleSearchMatching": { "shape": "__string", "locationName": "roleSearchMatching", "documentation": "The LDAP search filter used to find roles within the roleBase. The distinguished name of the user matched by userSearchMatching is substituted into the {0} placeholder in the search filter. The client's username is substituted into the {1} placeholder. For example, if you set this option to (member=uid={1})for the user janedoe, the search filter becomes (member=uid=janedoe) after string substitution. It matches all role entries that have a member attribute equal to uid=janedoe under the subtree selected by the roleBase.
" }, "RoleSearchSubtree": { "shape": "__boolean", "locationName": "roleSearchSubtree", "documentation": "The directory search scope for the role. If set to true, scope is to search the entire subtree.
" }, "ServiceAccountUsername": { "shape": "__string", "locationName": "serviceAccountUsername", "documentation": "Service account username. A service account is an account in your LDAP server that has access to initiate a connection. For example, cn=admin,dc=corp, dc=example,\n dc=com.
" }, "UserBase": { "shape": "__string", "locationName": "userBase", "documentation": "Select a particular subtree of the directory information tree (DIT) to search for user entries. The subtree is specified by a DN, which specifies the base node of the subtree. For example, by setting this option to ou=Users,ou=corp, dc=corp,\n dc=example, dc=com, the search for user entries is restricted to the subtree beneath ou=Users, ou=corp, dc=corp, dc=example, dc=com.
" }, "UserRoleName": { "shape": "__string", "locationName": "userRoleName", "documentation": "Specifies the name of the LDAP attribute for the user group membership.
" }, "UserSearchMatching": { "shape": "__string", "locationName": "userSearchMatching", "documentation": "The LDAP search filter used to find users within the userBase. The client's username is substituted into the {0} placeholder in the search filter. For example, if this option is set to (uid={0}) and the received username is janedoe, the search filter becomes (uid=janedoe) after string substitution. It will result in matching an entry like uid=janedoe, ou=Users,ou=corp, dc=corp, dc=example,\n dc=com.
" }, "UserSearchSubtree": { "shape": "__boolean", "locationName": "userSearchSubtree", "documentation": "The directory search scope for the user. If set to true, scope is to search the entire subtree.
" } }, "documentation": "Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker.
", "required": [ "Hosts", "UserSearchMatching", "UserBase", "RoleSearchMatching", "ServiceAccountUsername", "RoleBase" ] }, "ListBrokersRequest": { "type": "structure", "members": { "MaxResults": { "shape": "MaxResults", "location": "querystring", "locationName": "maxResults", "documentation": "The maximum number of brokers that Amazon MQ can return per page (20 by default). This value must be an integer from 5 to 100.
" }, "NextToken": { "shape": "__string", "location": "querystring", "locationName": "nextToken", "documentation": "The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.
" } } }, "ListBrokersResponse": { "type": "structure", "members": { "BrokerSummaries": { "shape": "__listOfBrokerSummary", "locationName": "brokerSummaries", "documentation": "A list of information about all brokers.
" }, "NextToken": { "shape": "__string", "locationName": "nextToken", "documentation": "The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.
" } } }, "ListConfigurationRevisionsRequest": { "type": "structure", "members": { "ConfigurationId": { "shape": "__string", "location": "uri", "locationName": "configuration-id", "documentation": "The unique ID that Amazon MQ generates for the configuration.
" }, "MaxResults": { "shape": "MaxResults", "location": "querystring", "locationName": "maxResults", "documentation": "The maximum number of brokers that Amazon MQ can return per page (20 by default). This value must be an integer from 5 to 100.
" }, "NextToken": { "shape": "__string", "location": "querystring", "locationName": "nextToken", "documentation": "The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.
" } }, "required": [ "ConfigurationId" ] }, "ListConfigurationRevisionsResponse": { "type": "structure", "members": { "ConfigurationId": { "shape": "__string", "locationName": "configurationId", "documentation": "The unique ID that Amazon MQ generates for the configuration.
" }, "MaxResults": { "shape": "__integer", "locationName": "maxResults", "documentation": "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": { "shape": "__string", "locationName": "nextToken", "documentation": "The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.
" }, "Revisions": { "shape": "__listOfConfigurationRevision", "locationName": "revisions", "documentation": "The list of all revisions for the specified configuration.
" } } }, "ListConfigurationsRequest": { "type": "structure", "members": { "MaxResults": { "shape": "MaxResults", "location": "querystring", "locationName": "maxResults", "documentation": "The maximum number of brokers that Amazon MQ can return per page (20 by default). This value must be an integer from 5 to 100.
" }, "NextToken": { "shape": "__string", "location": "querystring", "locationName": "nextToken", "documentation": "The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.
" } } }, "ListConfigurationsResponse": { "type": "structure", "members": { "Configurations": { "shape": "__listOfConfiguration", "locationName": "configurations", "documentation": "The list of all revisions for the specified configuration.
" }, "MaxResults": { "shape": "__integer", "locationName": "maxResults", "documentation": "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": { "shape": "__string", "locationName": "nextToken", "documentation": "The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.
" } } }, "ListTagsRequest": { "type": "structure", "members": { "ResourceArn": { "shape": "__string", "location": "uri", "locationName": "resource-arn", "documentation": "The Amazon Resource Name (ARN) of the resource tag.
" } }, "required": [ "ResourceArn" ] }, "ListTagsResponse": { "type": "structure", "members": { "Tags": { "shape": "__mapOf__string", "locationName": "tags", "documentation": "The key-value pair for the resource tag.
" } } }, "ListUsersRequest": { "type": "structure", "members": { "BrokerId": { "shape": "__string", "location": "uri", "locationName": "broker-id", "documentation": "The unique ID that Amazon MQ generates for the broker.
" }, "MaxResults": { "shape": "MaxResults", "location": "querystring", "locationName": "maxResults", "documentation": "The maximum number of brokers that Amazon MQ can return per page (20 by default). This value must be an integer from 5 to 100.
" }, "NextToken": { "shape": "__string", "location": "querystring", "locationName": "nextToken", "documentation": "The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.
" } }, "required": [ "BrokerId" ] }, "ListUsersResponse": { "type": "structure", "members": { "BrokerId": { "shape": "__string", "locationName": "brokerId", "documentation": "Required. The unique ID that Amazon MQ generates for the broker.
" }, "MaxResults": { "shape": "__integerMin5Max100", "locationName": "maxResults", "documentation": "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": { "shape": "__string", "locationName": "nextToken", "documentation": "The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.
" }, "Users": { "shape": "__listOfUserSummary", "locationName": "users", "documentation": "Required. The list of all ActiveMQ usernames for the specified broker. Does not apply to RabbitMQ brokers.
" } } }, "Logs": { "type": "structure", "members": { "Audit": { "shape": "__boolean", "locationName": "audit", "documentation": "Enables audit logging. Every user management action made using JMX or the ActiveMQ Web Console is logged. Does not apply to RabbitMQ brokers.
" }, "General": { "shape": "__boolean", "locationName": "general", "documentation": "Enables general logging.
" } }, "documentation": "The list of information about logs to be enabled for the specified broker.
" }, "LogsSummary": { "type": "structure", "members": { "Audit": { "shape": "__boolean", "locationName": "audit", "documentation": "Enables audit logging. Every user management action made using JMX or the ActiveMQ Web Console is logged.
" }, "AuditLogGroup": { "shape": "__string", "locationName": "auditLogGroup", "documentation": "The location of the CloudWatch Logs log group where audit logs are sent.
" }, "General": { "shape": "__boolean", "locationName": "general", "documentation": "Enables general logging.
" }, "GeneralLogGroup": { "shape": "__string", "locationName": "generalLogGroup", "documentation": "The location of the CloudWatch Logs log group where general logs are sent.
" }, "Pending": { "shape": "PendingLogs", "locationName": "pending", "documentation": "The list of information about logs pending to be deployed for the specified broker.
" } }, "documentation": "The list of information about logs currently enabled and pending to be deployed for the specified broker.
", "required": [ "GeneralLogGroup", "General" ] }, "MaxResults": { "type": "integer", "min": 1, "max": 100 }, "PendingLogs": { "type": "structure", "members": { "Audit": { "shape": "__boolean", "locationName": "audit", "documentation": "Enables audit logging. Every user management action made using JMX or the ActiveMQ Web Console is logged.
" }, "General": { "shape": "__boolean", "locationName": "general", "documentation": "Enables general logging.
" } }, "documentation": "The list of information about logs to be enabled for the specified broker.
" }, "PromoteMode": { "type": "string", "documentation": "The Promote mode requested.
", "enum": [ "SWITCHOVER", "FAILOVER" ] }, "PromoteRequest": { "type": "structure", "members": { "BrokerId": { "shape": "__string", "location": "uri", "locationName": "broker-id", "documentation": "The unique ID that Amazon MQ generates for the broker.
" }, "Mode": { "shape": "PromoteMode", "locationName": "mode", "documentation": "The Promote mode requested. Note: Valid values for the parameter are SWITCHOVER, FAILOVER.
" } }, "documentation": "Promotes a data replication replica broker to the primary broker role.
", "required": [ "BrokerId", "Mode" ] }, "PromoteResponse": { "type": "structure", "members": { "BrokerId": { "shape": "__string", "locationName": "brokerId", "documentation": "The unique ID that Amazon MQ generates for the broker.
" } } }, "RebootBrokerRequest": { "type": "structure", "members": { "BrokerId": { "shape": "__string", "location": "uri", "locationName": "broker-id", "documentation": "The unique ID that Amazon MQ generates for the broker.
" } }, "required": [ "BrokerId" ] }, "RebootBrokerResponse": { "type": "structure", "members": {} }, "SanitizationWarning": { "type": "structure", "members": { "AttributeName": { "shape": "__string", "locationName": "attributeName", "documentation": "The name of the configuration attribute that has been sanitized.
" }, "ElementName": { "shape": "__string", "locationName": "elementName", "documentation": "The name of the configuration element that has been sanitized.
" }, "Reason": { "shape": "SanitizationWarningReason", "locationName": "reason", "documentation": "The reason for which the configuration elements or attributes were sanitized.
" } }, "documentation": "Returns information about the configuration element or attribute that was sanitized in the configuration.
", "required": [ "Reason" ] }, "SanitizationWarningReason": { "type": "string", "documentation": "The reason for which the configuration elements or attributes were sanitized.
", "enum": [ "DISALLOWED_ELEMENT_REMOVED", "DISALLOWED_ATTRIBUTE_REMOVED", "INVALID_ATTRIBUTE_VALUE_REMOVED" ] }, "UpdateBrokerRequest": { "type": "structure", "members": { "AuthenticationStrategy": { "shape": "AuthenticationStrategy", "locationName": "authenticationStrategy", "documentation": "Optional. The authentication strategy used to secure the broker. The default is SIMPLE.
" }, "AutoMinorVersionUpgrade": { "shape": "__boolean", "locationName": "autoMinorVersionUpgrade", "documentation": "Enables automatic upgrades to new patch versions for brokers as new versions are released and supported by Amazon MQ. Automatic upgrades occur during the scheduled maintenance window or after a manual broker reboot.
Must be set to true for ActiveMQ brokers version 5.18 and above and for RabbitMQ brokers version 3.13 and above.
The unique ID that Amazon MQ generates for the broker.
" }, "Configuration": { "shape": "ConfigurationId", "locationName": "configuration", "documentation": "A list of information about the configuration.
" }, "EngineVersion": { "shape": "__string", "locationName": "engineVersion", "documentation": "The broker engine version. For more information, see the ActiveMQ version management and the RabbitMQ version management sections in the Amazon MQ Developer Guide.
When upgrading to ActiveMQ version 5.18 and above or RabbitMQ version 3.13 and above, you must have autoMinorVersionUpgrade set to true for the broker.
The broker's host instance type to upgrade to. For a list of supported instance types, see Broker instance types.
" }, "LdapServerMetadata": { "shape": "LdapServerMetadataInput", "locationName": "ldapServerMetadata", "documentation": "Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker. Does not apply to RabbitMQ brokers.
" }, "Logs": { "shape": "Logs", "locationName": "logs", "documentation": "Enables Amazon CloudWatch logging for brokers.
" }, "MaintenanceWindowStartTime": { "shape": "WeeklyStartTime", "locationName": "maintenanceWindowStartTime", "documentation": "The parameters that determine the WeeklyStartTime.
" }, "SecurityGroups": { "shape": "__listOf__string", "locationName": "securityGroups", "documentation": "The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers.
" }, "DataReplicationMode": { "shape": "DataReplicationMode", "locationName": "dataReplicationMode", "documentation": "Defines whether this broker is a part of a data replication pair.
" } }, "documentation": "Updates the broker using the specified properties.
", "required": [ "BrokerId" ] }, "UpdateBrokerResponse": { "type": "structure", "members": { "AuthenticationStrategy": { "shape": "AuthenticationStrategy", "locationName": "authenticationStrategy", "documentation": "Optional. The authentication strategy used to secure the broker. The default is SIMPLE.
" }, "AutoMinorVersionUpgrade": { "shape": "__boolean", "locationName": "autoMinorVersionUpgrade", "documentation": "Enables automatic upgrades to new patch versions for brokers as new versions are released and supported by Amazon MQ. Automatic upgrades occur during the scheduled maintenance window or after a manual broker reboot.
" }, "BrokerId": { "shape": "__string", "locationName": "brokerId", "documentation": "Required. The unique ID that Amazon MQ generates for the broker.
" }, "Configuration": { "shape": "ConfigurationId", "locationName": "configuration", "documentation": "The ID of the updated configuration.
" }, "EngineVersion": { "shape": "__string", "locationName": "engineVersion", "documentation": "The broker engine version to upgrade to. For more information, see the ActiveMQ version management and the RabbitMQ version management sections in the Amazon MQ Developer Guide.
" }, "HostInstanceType": { "shape": "__string", "locationName": "hostInstanceType", "documentation": "The broker's host instance type to upgrade to. For a list of supported instance types, see Broker instance types.
" }, "LdapServerMetadata": { "shape": "LdapServerMetadataOutput", "locationName": "ldapServerMetadata", "documentation": "Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker. Does not apply to RabbitMQ brokers.
" }, "Logs": { "shape": "Logs", "locationName": "logs", "documentation": "The list of information about logs to be enabled for the specified broker.
" }, "MaintenanceWindowStartTime": { "shape": "WeeklyStartTime", "locationName": "maintenanceWindowStartTime", "documentation": "The parameters that determine the WeeklyStartTime.
" }, "SecurityGroups": { "shape": "__listOf__string", "locationName": "securityGroups", "documentation": "The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers.
" }, "DataReplicationMetadata": { "shape": "DataReplicationMetadataOutput", "locationName": "dataReplicationMetadata", "documentation": "The replication details of the data replication-enabled broker. Only returned if dataReplicationMode is set to CRDR.
" }, "DataReplicationMode": { "shape": "DataReplicationMode", "locationName": "dataReplicationMode", "documentation": "Describes whether this broker is a part of a data replication pair.
" }, "PendingDataReplicationMetadata": { "shape": "DataReplicationMetadataOutput", "locationName": "pendingDataReplicationMetadata", "documentation": "The pending replication details of the data replication-enabled broker. Only returned if pendingDataReplicationMode is set to CRDR.
" }, "PendingDataReplicationMode": { "shape": "DataReplicationMode", "locationName": "pendingDataReplicationMode", "documentation": "Describes whether this broker will be a part of a data replication pair after reboot.
" } } }, "UpdateConfigurationRequest": { "type": "structure", "members": { "ConfigurationId": { "shape": "__string", "location": "uri", "locationName": "configuration-id", "documentation": "The unique ID that Amazon MQ generates for the configuration.
" }, "Data": { "shape": "__string", "locationName": "data", "documentation": "Amazon MQ for Active MQ: The base64-encoded XML configuration. Amazon MQ for RabbitMQ: the base64-encoded Cuttlefish configuration.
" }, "Description": { "shape": "__string", "locationName": "description", "documentation": "The description of the configuration.
" } }, "documentation": "Updates the specified configuration.
", "required": [ "ConfigurationId", "Data" ] }, "UpdateConfigurationResponse": { "type": "structure", "members": { "Arn": { "shape": "__string", "locationName": "arn", "documentation": "The Amazon Resource Name (ARN) of the configuration.
" }, "Created": { "shape": "__timestampIso8601", "locationName": "created", "documentation": "Required. The date and time of the configuration.
" }, "Id": { "shape": "__string", "locationName": "id", "documentation": "The unique ID that Amazon MQ generates for the configuration.
" }, "LatestRevision": { "shape": "ConfigurationRevision", "locationName": "latestRevision", "documentation": "The latest revision of the configuration.
" }, "Name": { "shape": "__string", "locationName": "name", "documentation": "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": { "shape": "__listOfSanitizationWarning", "locationName": "warnings", "documentation": "The list of the first 20 warnings about the configuration elements or attributes that were sanitized.
" } } }, "UpdateUserRequest": { "type": "structure", "members": { "BrokerId": { "shape": "__string", "location": "uri", "locationName": "broker-id", "documentation": "The unique ID that Amazon MQ generates for the broker.
" }, "ConsoleAccess": { "shape": "__boolean", "locationName": "consoleAccess", "documentation": "Enables access to the the ActiveMQ Web Console for the ActiveMQ user.
" }, "Groups": { "shape": "__listOf__string", "locationName": "groups", "documentation": "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": { "shape": "__string", "locationName": "password", "documentation": "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, colons, or equal signs (,:=).
" }, "Username": { "shape": "__string", "location": "uri", "locationName": "username", "documentation": "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.
" }, "ReplicationUser": { "shape": "__boolean", "locationName": "replicationUser", "documentation": "Defines whether the user is intended for data replication.
" } }, "documentation": "Updates the information for an ActiveMQ user.
", "required": [ "Username", "BrokerId" ] }, "UpdateUserResponse": { "type": "structure", "members": {} }, "User": { "type": "structure", "members": { "ConsoleAccess": { "shape": "__boolean", "locationName": "consoleAccess", "documentation": "Enables access to the ActiveMQ Web Console for the ActiveMQ user. Does not apply to RabbitMQ brokers.
" }, "Groups": { "shape": "__listOf__string", "locationName": "groups", "documentation": "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. Does not apply to RabbitMQ brokers.
" }, "Password": { "shape": "__string", "locationName": "password", "documentation": "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, colons, or equal signs (,:=).
" }, "Username": { "shape": "__string", "locationName": "username", "documentation": "The username of the broker user. The following restrictions apply to broker usernames:
For Amazon MQ for ActiveMQ brokers, this value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.
para>For Amazon MQ for RabbitMQ brokers, this value can contain only alphanumeric characters, dashes, periods, underscores (- . _). This value must not contain a tilde (~) character. Amazon MQ prohibts using guest as a valid usename. This value must be 2-100 characters long.
Do not add personally identifiable information (PII) or other confidential or sensitive information in broker usernames. Broker usernames are accessible to other Amazon Web Services services, including CloudWatch Logs. Broker usernames are not intended to be used for private or sensitive data.
Defines if this user is intended for CRDR replication purposes.
" } }, "documentation": "A user associated with the broker. For Amazon MQ for RabbitMQ brokers, one and only one administrative user is accepted and created when a broker is first provisioned. All subsequent broker users are created by making RabbitMQ API calls directly to brokers or via the RabbitMQ web console.
", "required": [ "Username", "Password" ] }, "UserPendingChanges": { "type": "structure", "members": { "ConsoleAccess": { "shape": "__boolean", "locationName": "consoleAccess", "documentation": "Enables access to the the ActiveMQ Web Console for the ActiveMQ user.
" }, "Groups": { "shape": "__listOf__string", "locationName": "groups", "documentation": "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": { "shape": "ChangeType", "locationName": "pendingChange", "documentation": "Required. The type of change pending for the ActiveMQ user.
" } }, "documentation": "Returns information about the status of the changes pending for the ActiveMQ user.
", "required": [ "PendingChange" ] }, "UserSummary": { "type": "structure", "members": { "PendingChange": { "shape": "ChangeType", "locationName": "pendingChange", "documentation": "The type of change pending for the broker user.
" }, "Username": { "shape": "__string", "locationName": "username", "documentation": "Required. The username of the broker user. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.
" } }, "documentation": "Returns a list of all broker users. Does not apply to RabbitMQ brokers.
", "required": [ "Username" ] }, "WeeklyStartTime": { "type": "structure", "members": { "DayOfWeek": { "shape": "DayOfWeek", "locationName": "dayOfWeek", "documentation": "Required. The day of the week.
" }, "TimeOfDay": { "shape": "__string", "locationName": "timeOfDay", "documentation": "Required. The time, in 24-hour format.
" }, "TimeZone": { "shape": "__string", "locationName": "timeZone", "documentation": "The time zone, UTC by default, in either the Country/City format, or the UTC offset format.
" } }, "documentation": "The scheduled time period relative to UTC during which Amazon MQ begins to apply pending updates or patches to the broker.
", "required": [ "TimeOfDay", "DayOfWeek" ] }, "__boolean": { "type": "boolean" }, "__integer": { "type": "integer" }, "__integerMin5Max100": { "type": "integer", "min": 5, "max": 100 }, "__listOfActionRequired": { "type": "list", "member": { "shape": "ActionRequired" } }, "__listOfAvailabilityZone": { "type": "list", "member": { "shape": "AvailabilityZone" } }, "__listOfBrokerEngineType": { "type": "list", "member": { "shape": "BrokerEngineType" } }, "__listOfBrokerInstance": { "type": "list", "member": { "shape": "BrokerInstance" } }, "__listOfBrokerInstanceOption": { "type": "list", "member": { "shape": "BrokerInstanceOption" } }, "__listOfBrokerSummary": { "type": "list", "member": { "shape": "BrokerSummary" } }, "__listOfConfiguration": { "type": "list", "member": { "shape": "Configuration" } }, "__listOfConfigurationId": { "type": "list", "member": { "shape": "ConfigurationId" } }, "__listOfConfigurationRevision": { "type": "list", "member": { "shape": "ConfigurationRevision" } }, "__listOfDeploymentMode": { "type": "list", "member": { "shape": "DeploymentMode" } }, "__listOfEngineVersion": { "type": "list", "member": { "shape": "EngineVersion" } }, "__listOfSanitizationWarning": { "type": "list", "member": { "shape": "SanitizationWarning" } }, "__listOfUser": { "type": "list", "member": { "shape": "User" } }, "__listOfUserSummary": { "type": "list", "member": { "shape": "UserSummary" } }, "__listOf__string": { "type": "list", "member": { "shape": "__string" } }, "__mapOf__string": { "type": "map", "key": { "shape": "__string" }, "value": { "shape": "__string" } }, "__string": { "type": "string" }, "__timestampIso8601": { "type": "timestamp", "timestampFormat": "iso8601" } }, "documentation": "Amazon MQ is a managed message broker service for Apache ActiveMQ and RabbitMQ that makes it easy to set up and operate message brokers in the cloud. A message broker allows software applications and components to communicate using various programming languages, operating systems, and formal messaging protocols.
" }