community / community.aws / 4.3.0 / module / iam_user_info Gather IAM user(s) facts in AWS | "added in version" 1.0.0 of community.aws" Authors: Constantin Bugneac (@Constantin07), Abhijeet Kasurde (@Akasurde)community.aws.iam_user_info (4.3.0) — module
Install with ansible-galaxy collection install community.aws:==4.3.0
collections: - name: community.aws version: 4.3.0
This module can be used to gather IAM user(s) facts in AWS.
# Note: These examples do not set authentication details, see the AWS Guide for details. # Gather facts about "test" user. - name: Get IAM user info community.aws.iam_user_info: name: "test"
# Gather facts about all users in the "dev" group. - name: Get IAM user info community.aws.iam_user_info: group: "dev"
# Gather facts about all users with "/division_abc/subdivision_xyz/" path. - name: Get IAM user info community.aws.iam_user_info: path: "/division_abc/subdivision_xyz/"
name: description: - The name of the IAM user to look for. required: false type: str path: default: / description: - The path to the IAM user. Mutually exclusive with C(group). - If specified, then would get all user names whose path starts with user provided value. required: false type: str group: description: - The group name name of the IAM user to look for. Mutually exclusive with C(path). required: false type: str region: aliases: - aws_region - ec2_region description: - The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION environment variable, if any, is used. See U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region) type: str ec2_url: aliases: - aws_endpoint_url - endpoint_url description: - Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used. type: str profile: aliases: - aws_profile description: - Uses a boto profile. Only works with boto >= 2.24.0. - Using I(profile) will override I(aws_access_key), I(aws_secret_key) and I(security_token) and support for passing them at the same time as I(profile) has been deprecated. - I(aws_access_key), I(aws_secret_key) and I(security_token) will be made mutually exclusive with I(profile) after 2022-06-01. type: str aws_config: description: - A dictionary to modify the botocore configuration. - Parameters can be found at U(https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config). - Only the 'user_agent' key is used for boto modules. See U(http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto) for more boto configuration. type: dict aws_ca_bundle: description: - The location of a CA Bundle to use when validating SSL certificates. - Only used for boto3 based modules. - 'Note: The CA Bundle is read ''module'' side and may need to be explicitly copied from the controller if not run locally.' type: path aws_access_key: aliases: - ec2_access_key - access_key description: - AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used. - If I(profile) is set this parameter is ignored. - Passing the I(aws_access_key) and I(profile) options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. type: str aws_secret_key: aliases: - ec2_secret_key - secret_key description: - AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used. - If I(profile) is set this parameter is ignored. - Passing the I(aws_secret_key) and I(profile) options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. type: str security_token: aliases: - aws_security_token - access_token description: - AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used. - If I(profile) is set this parameter is ignored. - Passing the I(security_token) and I(profile) options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. type: str validate_certs: default: true description: - When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0. type: bool debug_botocore_endpoint_logs: default: 'no' description: - Use a botocore.endpoint logger to parse the unique (rather than total) "resource:action" API calls made during a task, outputing the set to the resource_actions key in the task results. Use the aws_resource_action callback to output to total list made during a playbook. The ANSIBLE_DEBUG_BOTOCORE_LOGS environment variable may also be used. type: bool
iam_users: contains: arn: description: the ARN of the user returned: if user exists sample: arn:aws:iam::156360693172:user/dev/test_user type: str create_date: description: the datetime user was created returned: if user exists sample: '2016-05-24T12:24:59+00:00' type: str password_last_used: description: the last datetime the password was used by user returned: if password was used at least once sample: '2016-05-25T13:39:11+00:00' type: str path: description: the path to user returned: if user exists sample: /dev/ type: str tags: description: User tags. returned: if user exists sample: '{"Env": "Prod"}' type: dict user_id: description: the unique user id returned: if user exists sample: AIDUIOOCQKTUGI6QJLGH2 type: str user_name: description: the user name returned: if user exists sample: test_user type: str description: list of maching iam users returned: success type: complex