list-configurations¶
Description¶
Returns a list of all configurations.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
list-configurations
[--max-results <value>]
[--next-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
Options¶
--max-results (integer)
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.
--next-token (string)
The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
See ‘aws help’ for descriptions of global parameters.
Output¶
Configurations -> (list)
The list of all revisions for the specified configuration.
(structure)
Returns information about all configurations.
Arn -> (string)
Required. The ARN of the configuration.
AuthenticationStrategy -> (string)
Optional. The authentication strategy associated with the configuration. The default is SIMPLE.
Created -> (timestamp)
Required. The date and time of the configuration revision.
Description -> (string)
Required. The description of the configuration.
EngineType -> (string)
Required. The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.
EngineVersion -> (string)
Required. The broker engine’s version. For a list of supported engine versions, see, Supported engines .
Id -> (string)
Required. The unique ID that Amazon MQ generates for the configuration.
LatestRevision -> (structure)
Required. The latest revision of the configuration.
Created -> (timestamp)
Required. The date and time of the configuration revision.
Description -> (string)
The description of the configuration revision.
Revision -> (integer)
Required. The revision number of the configuration.
Name -> (string)
Required. The name of the configuration. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 1-150 characters long.
Tags -> (map)
The list of all tags associated with this configuration.
key -> (string)
value -> (string)
MaxResults -> (integer)
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 -> (string)
The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.