ec2_vol_info now returns attachment_set dict wrapped in a list

[bradmacpherson]

Summary

When retrieving EC2 volume info, each volume's attachment_set dict is now being returned as a list containing that dict:

        {
             "attachment_set": [
                 {
                     "attach_time": "2021-09-28T19:27:49+00:00",
                     "delete_on_termination": false,
                     "device": "/dev/sdf",
                     "instance_id": "i-0c52a5600a4612cf6",
                     "status": "attached"
                 }
             ],
             "create_time": "2021-09-28T19:27:50.149000+00:00",
             "encrypted": true,
             "id": "vol-01796edb351564fda",
             "iops": 405,
             "region": "us-east-1",
             "size": 135,
             "snapshot_id": "snap-0dc5141ce65add8be",
             "status": "in-use",
             "tags": {
                 "Name": "sierratstue1-db",
                 "Patch Group": "Group 2"
             },
             "type": "gp2",
             "zone": "us-east-1a"
         },

Should be this:

        {
             "attachment_set": {
                 "attach_time": "2021-09-28T19:27:49+00:00",
                 "delete_on_termination": false,
                 "device": "/dev/sdf",
                 "instance_id": "i-0c52a5600a4612cf6",
                 "status": "attached"
             },
             "create_time": "2021-09-28T19:27:50.149000+00:00",
             "encrypted": true,
             "id": "vol-01796edb351564fda",
             "iops": 405,
             "region": "us-east-1",
             "size": 135,
             "snapshot_id": "snap-0dc5141ce65add8be",
             "status": "in-use",
             "tags": {
                 "Name": "sierratstue1-db",
                 "Patch Group": "Group 2"
             },
             "type": "gp2",
             "zone": "us-east-1a"
         },

Issue Type

Bug Report

Component Name

ec2_vol_info

Ansible Version

#16 1.185 ansible 2.10.2
#16 1.185   config file = None
#16 1.185   configured module search path = ['/root/.ansible/plugins/modules', '/usr/share/ansible/plugins/modules']
#16 1.185   ansible python module location = /usr/lib/python3.7/site-packages/ansible
#16 1.185   executable location = /usr/lib/python-exec/python3.7/ansible
#16 1.185   python version = 3.7.9 (default, Dec  8 2020, 22:03:16) [GCC 9.3.0]

Collection Versions

#16 1.994 # /root/.ansible/collections/ansible_collections
#16 1.994 Collection        Version
#16 1.994 ----------------- -------
#16 1.994 amazon.aws        1.5.0  
#16 1.994 ansible.netcommon 1.5.0  
#16 1.995 community.general 3.2.0 

AWS SDK versions

#16 2.419 Name: boto
#16 2.419 Version: 2.49.0
#16 2.420 Summary: Amazon Web Services Library
#16 2.420 Home-page: https://github.com/boto/boto/
#16 2.420 Author: Mitch Garnaat
#16 2.420 Author-email: [email protected]
#16 2.420 License: MIT
#16 2.421 Location: /usr/lib/python3.7/site-packages
#16 2.421 Requires: 
#16 2.421 Required-by: 
#16 2.422 ---
#16 2.423 Name: boto3
#16 2.423 Version: 1.14.59
#16 2.423 Summary: The AWS SDK for Python
#16 2.423 Home-page: https://github.com/boto/boto3
#16 2.424 Author: Amazon Web Services
#16 2.424 Author-email: UNKNOWN
#16 2.425 License: Apache License 2.0
#16 2.425 Location: /usr/lib/python3.7/site-packages
#16 2.425 Requires: 
#16 2.425 Required-by: 
#16 2.426 ---
#16 2.427 Name: botocore
#16 2.427 Version: 1.17.59
#16 2.427 Summary: Low-level, data-driven core of boto 3.
#16 2.427 Home-page: https://github.com/boto/botocore
#16 2.428 Author: Amazon Web Services
#16 2.428 Author-email: UNKNOWN
#16 2.428 License: Apache License 2.0
#16 2.428 Location: /usr/lib/python3.7/site-packages
#16 2.429 Requires: jmespath, docutils, python-dateutil, urllib3
#16 2.429 Required-by: s3transfer

Configuration

No response

OS / Environment

Built on Gentoo Linux

Steps to Reproduce

- name: "Gather already-attached volume facts"
  local_action:
    module: amazon.aws.ec2_vol_info
    region: "{{ ec2_region }}"
    filters:
      attachment.instance-id: "{{ ec2_vm_id }}"
  register: _volume_facts

Expected Results

I would expect a data structure like this:

        {
             "attachment_set": {
                 "attach_time": "2021-09-28T19:27:49+00:00",
                 "delete_on_termination": false,
                 "device": "/dev/sdf",
                 "instance_id": "i-0c52a5600a4612cf6",
                 "status": "attached"
             },
             "create_time": "2021-09-28T19:27:50.149000+00:00",
             "encrypted": true,
             "id": "vol-01796edb351564fda",
             "iops": 405,
             "region": "us-east-1",
             "size": 135,
             "snapshot_id": "snap-0dc5141ce65add8be",
             "status": "in-use",
             "tags": {
                 "Name": "sierratstue1-db",
                 "Patch Group": "Group 2"
             },
             "type": "gp2",
             "zone": "us-east-1a"
         },

Actual Results

        {
             "attachment_set": [
                 {
                     "attach_time": "2021-09-28T19:27:49+00:00",
                     "delete_on_termination": false,
                     "device": "/dev/sdf",
                     "instance_id": "i-0c52a5600a4612cf6",
                     "status": "attached"
                 }
             ],
             "create_time": "2021-09-28T19:27:50.149000+00:00",
             "encrypted": true,
             "id": "vol-01796edb351564fda",
             "iops": 405,
             "region": "us-east-1",
             "size": 135,
             "snapshot_id": "snap-0dc5141ce65add8be",
             "status": "in-use",
             "tags": {
                 "Name": "sierratstue1-db",
                 "Patch Group": "Group 2"
             },
             "type": "gp2",
             "zone": "us-east-1a"
         },

Code of Conduct

• I agree to follow the Ansible Code of Conduct

[ansibullbot]

Files identified in the description:

• [plugins/modules/ec2_vol_info.py](https://github.com/['ansible-collections/amazon.aws', 'ansible-collections/community.aws', 'ansible-collections/community.vmware']/blob/main/plugins/modules/ec2_vol_info.py)

If these files are inaccurate, please update the component name section of the description or use the !component bot command.

click here for bot help

[ansibullbot]

cc @jillr @s-hertel @tremble @wimnat
click here for bot help

[tremble]

Hi @bradmacpherson,

Thanks for this report. This change was introduced in version 2.0.0 to support multi-attachment disks. While it's documented in the changelog as a 'breaking change', we forgot to update the module documentation.

https://github.com/ansible-collections/amazon.aws/blob/main/CHANGELOG.rst#breaking-changes-porting-guide