amazon.aws.ec2_import_image_info module – Gather information about import virtual machine tasks
Note
This module is part of the amazon.aws collection (version 8.2.1).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install amazon.aws
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: amazon.aws.ec2_import_image_info
.
New in amazon.aws 7.0.0
Synopsis
Displays details about an import virtual machine tasks that are already created.
Requirements
The below requirements are needed on the host that executes this module.
python >= 3.6
boto3 >= 1.26.0
botocore >= 1.29.0
Parameters
Parameter |
Comments |
---|---|
AWS access key ID. See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. The The aws_access_key and profile options are mutually exclusive. The aws_access_key_id alias was added in release 5.1.0 for consistency with the AWS botocore SDK. The ec2_access_key alias has been deprecated and will be removed in a release after 2024-12-01. Support for the |
|
The location of a CA Bundle to use when validating SSL certificates. The |
|
A dictionary to modify the botocore configuration. Parameters can be found in the AWS documentation https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. |
|
Use a The Choices:
|
|
URL to connect to instead of the default AWS endpoints. While this can be used to connection to other AWS-compatible services the amazon.aws and community.aws collections are only tested against AWS. The The ec2_url and s3_url aliases have been deprecated and will be removed in a release after 2024-12-01. Support for the |
|
A dict of filters to apply. Each dict item consists of a filter key and a filter value. See https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeImportImageTasks.html for possible filters. |
|
The IDs of the import image tasks. |
|
A named AWS profile to use for authentication. See the AWS documentation for more information about named profiles https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. The The profile option is mutually exclusive with the aws_access_key, aws_secret_key and security_token options. |
|
The AWS region to use. For global services such as IAM, Route53 and CloudFront, region is ignored. The See the Amazon AWS documentation for more information http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region. The Support for the |
|
AWS secret access key. See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. The The secret_key and profile options are mutually exclusive. The aws_secret_access_key alias was added in release 5.1.0 for consistency with the AWS botocore SDK. The ec2_secret_key alias has been deprecated and will be removed in a release after 2024-12-01. Support for the |
|
AWS STS session token for use with temporary credentials. See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. The The security_token and profile options are mutually exclusive. Aliases aws_session_token and session_token were added in release 3.2.0, with the parameter being renamed from security_token to session_token in release 6.0.0. The security_token, aws_security_token, and access_token aliases have been deprecated and will be removed in a release after 2024-12-01. Support for the |
|
When set to Setting validate_certs=false is strongly discouraged, as an alternative, consider setting aws_ca_bundle instead. Choices:
|
Notes
Note
Caution: For modules, environment variables and configuration files are read from the Ansible ‘host’ context and not the ‘controller’ context. As such, files may need to be explicitly copied to the ‘host’. For lookup and connection plugins, environment variables and configuration files are read from the Ansible ‘controller’ context and not the ‘host’ context.
The AWS SDK (boto3) that Ansible uses may also read defaults for credentials and other settings, such as the region, from its configuration files in the Ansible ‘host’ context (typically
~/.aws/credentials
). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.
Examples
# Note: These examples do not set authentication details, see the AWS Guide for details.
- name: Check status of import image
amazon.aws.ec2_import_image_info:
filters:
- Name: "tag:Name"
Values: ["clone-vm-import-image"]
- Name: "task-state"
Values: ["completed", "active"]
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
A list of EC2 import tasks. Returned: always |
|
The architecture of the virtual machine. Returned: success |
|
A description string for the import image task. Returned: success |
|
Specifies whether the destination AMI of the imported image should be encrypted. Returned: success |
|
The target hypervisor platform. Returned: success |
|
The ID of the Amazon Machine Image (AMI) created by the import task. Returned: success |
|
The task ID of the import image task. Returned: success |
|
The identifier for the symmetric KMS key that was used to create the encrypted AMI. Returned: success |
|
The ARNs of the license configurations. Returned: success |
|
The license type to be used for the Amazon Machine Image (AMI) after importing. Returned: success |
|
The operating system of the virtual machine. Returned: success |
|
The progress of the task. Returned: success |
|
The name of the role to use when not using the default role, ‘vmimport’. Returned: success |
|
Describes the snapshot created from the imported disk. Returned: success |
|
A description for the snapshot. Returned: success |
|
The block device mapping for the snapshot. Returned: success |
|
The size of the disk in the snapshot, in GiB. Returned: success |
|
The format of the disk image from which the snapshot is created. Returned: success |
|
The percentage of progress for the task. Returned: success |
|
The snapshot ID of the disk being imported. Returned: success |
|
A brief status of the snapshot creation. Returned: success |
|
A detailed status message for the snapshot creation. Returned: success |
|
The URL used to access the disk image. Returned: success |
|
The Amazon S3 bucket for the disk image. Returned: success |
|
A brief status of the task. Returned: success |
|
A detailed status message of the import task. Returned: success |
|
The tags to apply to the import image task during creation. Returned: success |
|
The name of the EC2 image import task. Returned: success |
|
The usage operation value. Returned: success |