mq_user_info
List users of an Amazon MQ broker
Collection: community.aws
Full Name: community.aws.mq_user_info
Synopsis
List users of an Amazon MQ broker
Parameters
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| access_key | str | |||
| as_dict | bool | false | ||
| aws_ca_bundle | path | |||
| aws_config | dict | |||
| broker_id | str | yes | ||
| debug_botocore_endpoint_logs | bool | false | ||
| endpoint_url | str | |||
| max_results | int | 100 | ||
| profile | str | |||
| region | str | |||
| secret_key | str | |||
| session_token | str | |||
| skip_pending_create | bool | false | ||
| skip_pending_delete | bool | false | ||
| validate_certs | bool | true |
Example
yaml
- name: get all users as list - relying on environment for API credentials
community.aws.mq_user_info:
broker_id: "aws-mq-broker-id"
max_results: 50
register: result
- name: get users as dict - explicitly specifying all credentials
community.aws.mq_user_info:
broker_id: "aws-mq-broker-id"
register: result
- name: get list of users to decide which may need to be deleted
community.aws.mq_user_info:
broker_id: "aws-mq-broker-id"
skip_pending_delete: true
- name: get list of users to decide which may need to be created
community.aws.mq_user_info:
broker_id: "aws-mq-broker-id"
skip_pending_create: true