openapi-directory

Version:

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

github.com/httptoolkit/openapi-directory-js

1 lines • 129 kB

JSON

{"openapi":"3.0.0","info":{"version":"2017-11-27","x-release":"v4","title":"AmazonMQ","description":"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.","x-logo":{"url":"https://twitter.com/awscloud/profile_image?size=original","backgroundColor":"#FFFFFF"},"termsOfService":"https://aws.amazon.com/service-terms/","contact":{"name":"Mike Ralphson","email":"mike.ralphson@gmail.com","url":"https://github.com/mermade/aws2openapi","x-twitter":"PermittedSoc"},"license":{"name":"Apache 2.0 License","url":"http://www.apache.org/licenses/"},"x-providerName":"amazonaws.com","x-serviceName":"mq","x-aws-signingName":"mq","x-origin":[{"contentType":"application/json","url":"https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/mq-2017-11-27.normal.json","converter":{"url":"https://github.com/mermade/aws2openapi","version":"1.0.0"},"x-apisguru-driver":"external"}],"x-apiClientRegistration":{"url":"https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct"},"x-apisguru-categories":["cloud"],"x-preferred":true},"externalDocs":{"description":"Amazon Web Services documentation","url":"https://docs.aws.amazon.com/mq/"},"servers":[{"url":"http://mq.{region}.amazonaws.com","variables":{"region":{"description":"The AWS region","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1"}},"description":"The AmazonMQ multi-region endpoint"},{"url":"https://mq.{region}.amazonaws.com","variables":{"region":{"description":"The AWS region","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1"}},"description":"The AmazonMQ multi-region endpoint"},{"url":"http://mq.{region}.amazonaws.com.cn","variables":{"region":{"description":"The AWS region","enum":["cn-north-1","cn-northwest-1"],"default":"cn-north-1"}},"description":"The AmazonMQ endpoint for China (Beijing) and China (Ningxia)"},{"url":"https://mq.{region}.amazonaws.com.cn","variables":{"region":{"description":"The AWS region","enum":["cn-north-1","cn-northwest-1"],"default":"cn-north-1"}},"description":"The AmazonMQ endpoint for China (Beijing) and China (Ningxia)"}],"x-hasEquivalentPaths":true,"paths":{"/v1/brokers":{"post":{"operationId":"CreateBroker","description":"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. <ul><li>ec2:CreateNetworkInterface This permission is required to allow Amazon MQ to create an elastic network interface (ENI) on behalf of your account.</li> <li>ec2:CreateNetworkInterfacePermission This permission is required to attach the ENI to the broker instance.</li> <li>ec2:DeleteNetworkInterface</li> <li>ec2:DeleteNetworkInterfacePermission</li> <li>ec2:DetachNetworkInterface</li> <li>ec2:DescribeInternetGateways</li> <li>ec2:DescribeNetworkInterfaces</li> <li>ec2:DescribeNetworkInterfacePermissions</li> <li>ec2:DescribeRouteTables</li> <li>ec2:DescribeSecurityGroups</li> <li>ec2:DescribeSubnets</li> <li>ec2:DescribeVpcs</li></ul> For more information, see <a href=\"https://docs.aws.amazon.com//amazon-mq/latest/developer-guide/amazon-mq-setting-up.html#create-iam-user\">Create an IAM User and Get Your Amazon Web Services Credentials</a> and <a href=\"https://docs.aws.amazon.com//amazon-mq/latest/developer-guide/connecting-to-amazon-mq.html#never-modify-delete-elastic-network-interface\">Never Modify or Delete the Amazon MQ Elastic Network Interface</a> in the Amazon MQ Developer Guide.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBrokerResponse"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"482":{"description":"InternalServerErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorException"}}}},"483":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"484":{"description":"ForbiddenException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenException"}}}}},"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["autoMinorVersionUpgrade","brokerName","deploymentMode","engineType","engineVersion","hostInstanceType","publiclyAccessible","users"],"properties":{"authenticationStrategy":{"description":"Optional. The authentication strategy used to secure the broker. The default is SIMPLE.","type":"string","enum":["SIMPLE","LDAP"]},"autoMinorVersionUpgrade":{"description":"Enables automatic upgrades to new minor versions for brokers, as new versions are released and supported by Amazon MQ. Automatic upgrades occur during the scheduled maintenance window of the broker or after a manual broker reboot. Set to true by default, if no value is specified.","type":"boolean"},"brokerName":{"description":"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. <important>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.</important>","type":"string"},"configuration":{"description":"A list of information about the configuration.","type":"object","properties":{"Id":{"allOf":[{"$ref":"#/components/schemas/__string"},{"xml":{"name":"id"},"description":"Required. The unique ID that Amazon MQ generates for the configuration."}]},"Revision":{"allOf":[{"$ref":"#/components/schemas/__integer"},{"xml":{"name":"revision"},"description":"The revision number of the configuration."}]}}},"creatorRequestId":{"description":"The unique ID that the requester receives for the created broker. Amazon MQ passes your ID with the API action. <note>We recommend using a Universally Unique Identifier (UUID) for the creatorRequestId. You may omit the creatorRequestId if your application doesn't require idempotency.</note>","type":"string"},"deploymentMode":{"description":"The broker's deployment mode.","type":"string","enum":["SINGLE_INSTANCE","ACTIVE_STANDBY_MULTI_AZ","CLUSTER_MULTI_AZ"]},"encryptionOptions":{"description":"Encryption options for the broker.","type":"object","properties":{"KmsKeyId":{"allOf":[{"$ref":"#/components/schemas/__string"},{"xml":{"name":"kmsKeyId"},"description":"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":{"allOf":[{"$ref":"#/components/schemas/__boolean"},{"xml":{"name":"useAwsOwnedKey"},"description":"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."}]}}},"engineType":{"description":"The type of broker engine. Amazon MQ supports ActiveMQ and RabbitMQ.","type":"string","enum":["ACTIVEMQ","RABBITMQ"]},"engineVersion":{"description":"Required. The broker engine's version. For a list of supported engine versions, see <a href=\"https://docs.aws.amazon.com//amazon-mq/latest/developer-guide/broker-engine.html\">Supported engines</a>.","type":"string"},"hostInstanceType":{"description":"Required. The broker's instance type.","type":"string"},"ldapServerMetadata":{"description":"Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker. <important>Does not apply to RabbitMQ brokers.</important>","type":"object","properties":{"Hosts":{"allOf":[{"$ref":"#/components/schemas/__listOf__string"},{"xml":{"name":"hosts"},"description":"Specifies the location of the LDAP server such as Directory Service for Microsoft Active Directory. Optional failover server."}]},"RoleBase":{"allOf":[{"$ref":"#/components/schemas/__string"},{"xml":{"name":"roleBase"},"description":"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":{"allOf":[{"$ref":"#/components/schemas/__string"},{"xml":{"name":"roleName"},"description":"Specifies the LDAP attribute that identifies the group name attribute in the object returned from the group membership query."}]},"RoleSearchMatching":{"allOf":[{"$ref":"#/components/schemas/__string"},{"xml":{"name":"roleSearchMatching"},"description":"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":{"allOf":[{"$ref":"#/components/schemas/__boolean"},{"xml":{"name":"roleSearchSubtree"},"description":"The directory search scope for the role. If set to true, scope is to search the entire subtree."}]},"ServiceAccountPassword":{"allOf":[{"$ref":"#/components/schemas/__string"},{"xml":{"name":"serviceAccountPassword"},"description":"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":{"allOf":[{"$ref":"#/components/schemas/__string"},{"xml":{"name":"serviceAccountUsername"},"description":"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":{"allOf":[{"$ref":"#/components/schemas/__string"},{"xml":{"name":"userBase"},"description":"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":{"allOf":[{"$ref":"#/components/schemas/__string"},{"xml":{"name":"userRoleName"},"description":"Specifies the name of the LDAP attribute for the user group membership."}]},"UserSearchMatching":{"allOf":[{"$ref":"#/components/schemas/__string"},{"xml":{"name":"userSearchMatching"},"description":"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":{"allOf":[{"$ref":"#/components/schemas/__boolean"},{"xml":{"name":"userSearchSubtree"},"description":"The directory search scope for the user. If set to true, scope is to search the entire subtree."}]}}},"logs":{"description":"The list of information about logs to be enabled for the specified broker.","type":"object","properties":{"Audit":{"allOf":[{"$ref":"#/components/schemas/__boolean"},{"xml":{"name":"audit"},"description":"Enables audit logging. Every user management action made using JMX or the ActiveMQ Web Console is logged. Does not apply to RabbitMQ brokers."}]},"General":{"allOf":[{"$ref":"#/components/schemas/__boolean"},{"xml":{"name":"general"},"description":"Enables general logging."}]}}},"maintenanceWindowStartTime":{"description":"The scheduled time period relative to UTC during which Amazon MQ begins to apply pending updates or patches to the broker.","type":"object","properties":{"DayOfWeek":{"allOf":[{"$ref":"#/components/schemas/DayOfWeek"},{"xml":{"name":"dayOfWeek"},"description":"Required. The day of the week."}]},"TimeOfDay":{"allOf":[{"$ref":"#/components/schemas/__string"},{"xml":{"name":"timeOfDay"},"description":"Required. The time, in 24-hour format."}]},"TimeZone":{"allOf":[{"$ref":"#/components/schemas/__string"},{"xml":{"name":"timeZone"},"description":"The time zone, UTC by default, in either the Country/City format, or the UTC offset format."}]}}},"publiclyAccessible":{"description":"Enables connections from applications outside of the VPC that hosts the broker's subnets. Set to false by default, if no value is provided.","type":"boolean"},"securityGroups":{"description":"The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.","type":"array","items":{"$ref":"#/components/schemas/__string"}},"storageType":{"description":"The broker's storage type. <important>EFS is not supported for RabbitMQ engine type.</important>","type":"string","enum":["EBS","EFS"]},"subnetIds":{"description":"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. <important>If you specify subnets in a <a href=\"https://docs.aws.amazon.com/vpc/latest/userguide/vpc-sharing.html\">shared VPC</a> 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.</important>","type":"array","items":{"$ref":"#/components/schemas/__string"}},"tags":{"description":"Create tags when creating the broker.","type":"object","additionalProperties":{"$ref":"#/components/schemas/__string"}},"users":{"description":"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.","type":"array","items":{"$ref":"#/components/schemas/User"}},"dataReplicationMode":{"description":"Specifies whether a broker is a part of a data replication pair.","type":"string","enum":["NONE","CRDR"]},"dataReplicationPrimaryBrokerArn":{"description":"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.","type":"string"}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"ListBrokers","description":"Returns a list of all brokers.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListBrokersResponse"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"InternalServerErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorException"}}}},"482":{"description":"ForbiddenException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenException"}}}}},"parameters":[{"name":"maxResults","in":"query","required":false,"description":"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.","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"nextToken","in":"query","required":false,"description":"The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.","schema":{"type":"string"}},{"name":"MaxResults","in":"query","schema":{"type":"string"},"description":"Pagination limit","required":false},{"name":"NextToken","in":"query","schema":{"type":"string"},"description":"Pagination token","required":false}]}},"/v1/configurations":{"post":{"operationId":"CreateConfiguration","description":"Creates a new configuration for the specified configuration name. Amazon MQ uses the default configuration (the engine type and version).","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateConfigurationResponse"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"InternalServerErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorException"}}}},"482":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"483":{"description":"ForbiddenException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenException"}}}}},"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["engineType","engineVersion","name"],"properties":{"authenticationStrategy":{"description":"Optional. The authentication strategy used to secure the broker. The default is SIMPLE.","type":"string","enum":["SIMPLE","LDAP"]},"engineType":{"description":"The type of broker engine. Amazon MQ supports ActiveMQ and RabbitMQ.","type":"string","enum":["ACTIVEMQ","RABBITMQ"]},"engineVersion":{"description":"Required. The broker engine's version. For a list of supported engine versions, see <a href=\"https://docs.aws.amazon.com//amazon-mq/latest/developer-guide/broker-engine.html\">Supported engines</a>.","type":"string"},"name":{"description":"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.","type":"string"},"tags":{"description":"Create tags when creating the configuration.","type":"object","additionalProperties":{"$ref":"#/components/schemas/__string"}}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"ListConfigurations","description":"Returns a list of all configurations.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListConfigurationsResponse"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"InternalServerErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorException"}}}},"482":{"description":"ForbiddenException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenException"}}}}},"parameters":[{"name":"maxResults","in":"query","required":false,"description":"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.","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"nextToken","in":"query","required":false,"description":"The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.","schema":{"type":"string"}}]}},"/v1/tags/{resource-arn}":{"post":{"operationId":"CreateTags","description":"Add a tag to a resource.","responses":{"204":{"description":"Success"},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"482":{"description":"InternalServerErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorException"}}}},"483":{"description":"ForbiddenException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenException"}}}}},"parameters":[{"name":"resource-arn","in":"path","required":true,"description":"The Amazon Resource Name (ARN) of the resource tag.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"tags":{"description":"The key-value pair for the resource tag.","type":"object","additionalProperties":{"$ref":"#/components/schemas/__string"}}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"ListTags","description":"Lists tags for a resource.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListTagsResponse"}}}},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"482":{"description":"InternalServerErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorException"}}}},"483":{"description":"ForbiddenException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenException"}}}}},"parameters":[{"name":"resource-arn","in":"path","required":true,"description":"The Amazon Resource Name (ARN) of the resource tag.","schema":{"type":"string"}}]}},"/v1/brokers/{broker-id}/users/{username}":{"post":{"operationId":"CreateUser","description":"Creates an ActiveMQ user. <important>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.</important>","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateUserResponse"}}}},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"482":{"description":"InternalServerErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorException"}}}},"483":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"484":{"description":"ForbiddenException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenException"}}}}},"parameters":[{"name":"broker-id","in":"path","required":true,"description":"The unique ID that Amazon MQ generates for the broker.","schema":{"type":"string"}},{"name":"username","in":"path","required":true,"description":"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.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["password"],"properties":{"consoleAccess":{"description":"Enables access to the ActiveMQ Web Console for the ActiveMQ user.","type":"boolean"},"groups":{"description":"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.","type":"array","items":{"$ref":"#/components/schemas/__string"}},"password":{"description":"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 (,:=).","type":"string"},"replicationUser":{"description":"Defines if this user is intended for CRDR replication purposes.","type":"boolean"}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"delete":{"operationId":"DeleteUser","description":"Deletes an ActiveMQ user.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteUserResponse"}}}},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"482":{"description":"InternalServerErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorException"}}}},"483":{"description":"ForbiddenException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenException"}}}}},"parameters":[{"name":"broker-id","in":"path","required":true,"description":"The unique ID that Amazon MQ generates for the broker.","schema":{"type":"string"}},{"name":"username","in":"path","required":true,"description":"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.","schema":{"type":"string"}}]},"get":{"operationId":"DescribeUser","description":"Returns information about an ActiveMQ user.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DescribeUserResponse"}}}},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"482":{"description":"InternalServerErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorException"}}}},"483":{"description":"ForbiddenException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenException"}}}}},"parameters":[{"name":"broker-id","in":"path","required":true,"description":"The unique ID that Amazon MQ generates for the broker.","schema":{"type":"string"}},{"name":"username","in":"path","required":true,"description":"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.","schema":{"type":"string"}}]},"put":{"operationId":"UpdateUser","description":"Updates the information for an ActiveMQ user.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUserResponse"}}}},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"482":{"description":"InternalServerErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorException"}}}},"483":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"484":{"description":"ForbiddenException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenException"}}}}},"parameters":[{"name":"broker-id","in":"path","required":true,"description":"The unique ID that Amazon MQ generates for the broker.","schema":{"type":"string"}},{"name":"username","in":"path","required":true,"description":"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.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"consoleAccess":{"description":"Enables access to the the ActiveMQ Web Console for the ActiveMQ user.","type":"boolean"},"groups":{"description":"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.","type":"array","items":{"$ref":"#/components/schemas/__string"}},"password":{"description":"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 (,:=).","type":"string"},"replicationUser":{"description":"Defines whether the user is intended for data replication.","type":"boolean"}}}}}}}},"/v1/brokers/{broker-id}":{"delete":{"operationId":"DeleteBroker","description":"Deletes a broker. Note: This API is asynchronous.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteBrokerResponse"}}}},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"482":{"description":"InternalServerErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorException"}}}},"483":{"description":"ForbiddenException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenException"}}}}},"parameters":[{"name":"broker-id","in":"path","required":true,"description":"The unique ID that Amazon MQ generates for the broker.","schema":{"type":"string"}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"DescribeBroker","description":"Returns information about the specified broker.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DescribeBrokerResponse"}}}},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"482":{"description":"InternalServerErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorException"}}}},"483":{"description":"ForbiddenException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenException"}}}}},"parameters":[{"name":"broker-id","in":"path","required":true,"description":"The unique ID that Amazon MQ generates for the broker.","schema":{"type":"string"}}]},"put":{"operationId":"UpdateBroker","description":"Adds a pending configuration change to a broker.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBrokerResponse"}}}},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"482":{"description":"InternalServerErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorException"}}}},"483":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"484":{"description":"ForbiddenException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenException"}}}}},"parameters":[{"name":"broker-id","in":"path","required":true,"description":"The unique ID that Amazon MQ generates for the broker.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"authenticationStrategy":{"description":"Optional. The authentication strategy used to secure the broker. The default is SIMPLE.","type":"string","enum":["SIMPLE","LDAP"]},"autoMinorVersionUpgrade":{"description":"Enables automatic upgrades to new minor versions for brokers, as new versions are released and supported by Amazon MQ. Automatic upgrades occur during the scheduled maintenance window of the broker or after a manual broker reboot.","type":"boolean"},"configuration":{"description":"A list of information about the configuration.","type":"object","properties":{"Id":{"allOf":[{"$ref":"#/components/schemas/__string"},{"xml":{"name":"id"},"description":"Required. The unique ID that Amazon MQ generates for the configuration."}]},"Revision":{"allOf":[{"$ref":"#/components/schemas/__integer"},{"xml":{"name":"revision"},"description":"The revision number of the configuration."}]}}},"engineVersion":{"description":"The broker engine version. For a list of supported engine versions, see <a href=\"https://docs.aws.amazon.com//amazon-mq/latest/developer-guide/broker-engine.html\">Supported engines</a>.","type":"string"},"hostInstanceType":{"description":"The broker's host instance type to upgrade to. For a list of supported instance types, see <a href=\"https://docs.aws.amazon.com//amazon-mq/latest/developer-guide/broker.html#broker-instance-types\">Broker instance types</a>.","type":"string"},"ldapServerMetadata":{"description":"Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker. <important>Does not apply to RabbitMQ brokers.</important>","type":"object","properties":{"Hosts":{"allOf":[{"$ref":"#/components/schemas/__listOf__string"},{"xml":{"name":"hosts"},"description":"Specifies the location of the LDAP server such as Directory Service for Microsoft Active Directory. Optional failover server."}]},"RoleBase":{"allOf":[{"$ref":"#/components/schemas/__string"},{"xml":{"name":"roleBase"},"description":"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":{"allOf":[{"$ref":"#/components/schemas/__string"},{"xml":{"name":"roleName"},"description":"Specifies the LDAP attribute that identifies the group name attribute in the object returned from the group membership query."}]},"RoleSearchMatching":{"allOf":[{"$ref":"#/components/schemas/__string"},{"xml":{"name":"roleSearchMatching"},"description":"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":{"allOf":[{"$ref":"#/components/schemas/__boolean"},{"xml":{"name":"roleSearchSubtree"},"description":"The directory search scope for the role. If set to true, scope is to search the entire subtree."}]},"ServiceAccountPassword":{"allOf":[{"$ref":"#/components/schemas/__string"},{"xml":{"name":"serviceAccountPassword"},"description":"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":{"allOf":[{"$ref":"#/components/schemas/__string"},{"xml":{"name":"serviceAccountUsername"},"description":"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":{"allOf":[{"$ref":"#/components/schemas/__string"},{"xml":{"name":"userBase"},"description":"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":{"allOf":[{"$ref":"#/components/schemas/__string"},{"xml":{"name":"userRoleName"},"description":"Specifies the name of the LDAP attribute for the user group membership."}]},"UserSearchMatching":{"allOf":[{"$ref":"#/components/schemas/__string"},{"xml":{"name":"userSearchMatching"},"description":"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":{"allOf":[{"$ref":"#/components/schemas/__boolean"},{"xml":{"name":"userSearchSubtree"},"description":"The directory search scope for the user. If set to true, scope is to search the entire subtree."}]}}},"logs":{"description":"The list of information about logs to be enabled for the specified broker.","type":"object","properties":{"Audit":{"allOf":[{"$ref":"#/components/schemas/__boolean"},{"xml":{"name":"audit"},"description":"Enables audit logging. Every user management action made using JMX or the ActiveMQ Web Console is logged. Does not apply to RabbitMQ brokers."}]},"General":{"allOf":[{"$ref":"#/components/schemas/__boolean"},{"xml":{"name":"general"},"description":"Enables general logging."}]}}},"maintenanceWindowStartTime":{"description":"The scheduled time period relative to UTC during which Amazon MQ begins to apply pending updates or patches to the broker.","type":"object","properties":{"DayOfWeek":{"allOf":[{"$ref":"#/components/schemas/DayOfWeek"},{"xml":{"name":"dayOfWeek"},"description":"Required. The day of the week."}]},"TimeOfDay":{"allOf":[{"$ref":"#/components/schemas/__string"},{"xml":{"name":"timeOfDay"},"description":"Required. The time, in 24-hour format."}]},"TimeZone":{"allOf":[{"$ref":"#/components/schemas/__string"},{"xml":{"name":"timeZone"},"description":"The time zone, UTC by default, in either the Country/City format, or the UTC offset format."}]}}},"securityGroups":{"description":"The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers.","type":"array","items":{"$ref":"#/components/schemas/__string"}},"dataReplicationMode":{"description":"Specifies whether a broker is a part of a data replication pair.","type":"string","enum":["NONE","CRDR"]}}}}}}}},"/v1/tags/{resource-arn}#tagKeys":{"delete":{"operationId":"DeleteTags","description":"Removes a tag from a resource.","responses":{"204":{"description":"Success"},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"482":{"description":"InternalServerErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorException"}}}},"483":{"description":"ForbiddenException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenException"}}}}},"parameters":[{"name":"resource-arn","in":"path","required":true,"description":"The Amazon Resource Name (ARN) of the resource tag.","schema":{"type":"string"}},{"name":"tagKeys","in":"query","required":true,"description":"An array of tag keys to delete","schema":{"type":"array","items":{"$ref":"#/components/schemas/__string"}}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/v1/broker-engine-types":{"get":{"operationId":"DescribeBrokerEngineTypes","description":"Describe available engine types and versions.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DescribeBrokerEngineTypesResponse"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"InternalServerErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorException"}}}},"482":{"description":"ForbiddenException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenException"}}}}},"parameters":[{"name":"engineType","in":"query","required":false,"description":"Filter response by engine type.","schema":{"type":"string"}},{"name":"maxResults","in":"query","required":false,"description":"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.","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"nextToken","in":"query","required":false,"description":"The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.","schema":{"type":"string"}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/v1/broker-instance-options":{"get":{"operationId":"DescribeBrokerInstanceOptions","description":"Describe available broker instance options.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DescribeBrokerInstanceOptionsResponse"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"InternalServerErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorException"}}}},"482":{"description":"ForbiddenException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenException"}}}}},"parameters":[{"name":"engineType","in":"query","required":false,"description":"Filter response by engine type.","schema":{"type":"string"}},{"name":"hostInstanceType","in":"query","required":false,"description":"Filter response by host instance type.","schema":{"type":"string"}},{"name":"maxResults","in":"query","required":false,"description":"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.","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"nextToken","in":"query","required":false,"description":"The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.","schema":{"type":"string"}},{"name":"storageType","in":"query","required":false,"description":"Filter response by storage type.","schema":{"type":"string"}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/v1/configurations/{configuration-id}":{"get":{"operationId":"DescribeConfiguration","description":"Returns information about the specified configuration.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DescribeConfigurationResponse"}}}},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"482":{"description":"InternalServerErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorException"}}}},"483":{"description":"ForbiddenException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenException"}}}}},"parameters":[{"name":"configuration-id","in":"path","required":true,"description":"The unique ID that Amazon MQ generates for the configuration.","schema":{"type":"string"}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"put":{"operationId":"UpdateConfiguration","description":"Updates the specified configuration.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateConfigurationResponse"}}}},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"482":{"description":"InternalServerErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorException"}}}},"483":{"description":"Co