mirror of https://github.com/ansible/ansible.git
You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
115 lines
3.8 KiB
Python
115 lines
3.8 KiB
Python
#!/usr/bin/python
|
|
# Copyright (c) 2017 Ansible Project
|
|
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
|
|
|
from __future__ import (absolute_import, division, print_function)
|
|
__metaclass__ = type
|
|
|
|
ANSIBLE_METADATA = {
|
|
'metadata_version': '1.1',
|
|
'status': ['preview'],
|
|
'supported_by': 'community'
|
|
}
|
|
|
|
DOCUMENTATION = '''
|
|
---
|
|
module: aws_caller_info
|
|
short_description: Get information about the user and account being used to make AWS calls.
|
|
description:
|
|
- This module returns information about the account and user / role from which the AWS access tokens originate.
|
|
- The primary use of this is to get the account id for templating into ARNs or similar to avoid needing to specify this information in inventory.
|
|
- This module was called C(aws_caller_facts) before Ansible 2.9. The usage did not change.
|
|
version_added: "2.6"
|
|
|
|
author:
|
|
- Ed Costello (@orthanc)
|
|
- Stijn Dubrul (@sdubrul)
|
|
|
|
requirements: [ 'botocore', 'boto3' ]
|
|
extends_documentation_fragment:
|
|
- aws
|
|
- ec2
|
|
'''
|
|
|
|
EXAMPLES = '''
|
|
# Note: These examples do not set authentication details, see the AWS Guide for details.
|
|
|
|
- name: Get the current caller identity information
|
|
aws_caller_info:
|
|
register: caller_info
|
|
'''
|
|
|
|
RETURN = '''
|
|
account:
|
|
description: The account id the access credentials are associated with.
|
|
returned: success
|
|
type: str
|
|
sample: "123456789012"
|
|
account_alias:
|
|
description: The account alias the access credentials are associated with.
|
|
returned: when caller has the iam:ListAccountAliases permission
|
|
type: str
|
|
sample: "acme-production"
|
|
arn:
|
|
description: The arn identifying the user the credentials are associated with.
|
|
returned: success
|
|
type: str
|
|
sample: arn:aws:sts::123456789012:federated-user/my-federated-user-name
|
|
user_id:
|
|
description: |
|
|
The user id the access credentials are associated with. Note that this may not correspond to
|
|
anything you can look up in the case of roles or federated identities.
|
|
returned: success
|
|
type: str
|
|
sample: 123456789012:my-federated-user-name
|
|
'''
|
|
|
|
from ansible.module_utils.aws.core import AnsibleAWSModule
|
|
from ansible.module_utils.ec2 import camel_dict_to_snake_dict
|
|
|
|
try:
|
|
from botocore.exceptions import BotoCoreError, ClientError
|
|
except ImportError:
|
|
pass # caught by AnsibleAWSModule
|
|
|
|
|
|
def main():
|
|
module = AnsibleAWSModule(
|
|
argument_spec={},
|
|
supports_check_mode=True,
|
|
)
|
|
if module._name == 'aws_caller_facts':
|
|
module.deprecate("The 'aws_caller_facts' module has been renamed to 'aws_caller_info'", version='2.13')
|
|
|
|
client = module.client('sts')
|
|
|
|
try:
|
|
caller_info = client.get_caller_identity()
|
|
caller_info.pop('ResponseMetadata', None)
|
|
except (BotoCoreError, ClientError) as e:
|
|
module.fail_json_aws(e, msg='Failed to retrieve caller identity')
|
|
|
|
iam_client = module.client('iam')
|
|
|
|
try:
|
|
# Although a list is returned by list_account_aliases AWS supports maximum one alias per account.
|
|
# If an alias is defined it will be returned otherwise a blank string is filled in as account_alias.
|
|
# see https://docs.aws.amazon.com/cli/latest/reference/iam/list-account-aliases.html#output
|
|
response = iam_client.list_account_aliases()
|
|
if response and response['AccountAliases']:
|
|
caller_info['account_alias'] = response['AccountAliases'][0]
|
|
else:
|
|
caller_info['account_alias'] = ''
|
|
except (BotoCoreError, ClientError) as e:
|
|
# The iam:ListAccountAliases permission is required for this operation to succeed.
|
|
# Lacking this permission is handled gracefully by not returning the account_alias.
|
|
pass
|
|
|
|
module.exit_json(
|
|
changed=False,
|
|
**camel_dict_to_snake_dict(caller_info))
|
|
|
|
|
|
if __name__ == '__main__':
|
|
main()
|