From a2e4196c11bbaaf33f5ddda3ad34e03f2f0e4489 Mon Sep 17 00:00:00 2001 From: Prasad Katti Date: Mon, 30 Oct 2017 16:49:30 -0700 Subject: [PATCH] [aws] Document boto3 requirement (#32329) --- lib/ansible/modules/cloud/amazon/aws_kms.py | 1 + lib/ansible/modules/cloud/amazon/aws_waf_facts.py | 1 + lib/ansible/modules/cloud/amazon/ec2_asg_facts.py | 1 + lib/ansible/modules/cloud/amazon/ec2_group_facts.py | 1 + lib/ansible/modules/cloud/amazon/ec2_snapshot_facts.py | 1 + lib/ansible/modules/cloud/amazon/ec2_vpc_igw_facts.py | 1 + lib/ansible/modules/cloud/amazon/ecs_ecr.py | 1 + lib/ansible/modules/cloud/amazon/elasticache.py | 1 + lib/ansible/modules/cloud/amazon/elb_application_lb.py | 1 + lib/ansible/modules/cloud/amazon/elb_application_lb_facts.py | 1 + lib/ansible/modules/cloud/amazon/elb_target_group.py | 1 + lib/ansible/modules/cloud/amazon/elb_target_group_facts.py | 1 + lib/ansible/modules/cloud/amazon/kinesis_stream.py | 1 + lib/ansible/modules/cloud/amazon/rds_param_group.py | 1 + lib/ansible/modules/cloud/amazon/redshift_facts.py | 1 + lib/ansible/modules/cloud/amazon/s3_website.py | 1 + 16 files changed, 16 insertions(+) diff --git a/lib/ansible/modules/cloud/amazon/aws_kms.py b/lib/ansible/modules/cloud/amazon/aws_kms.py index 385716fbab1..1c6ebd21af6 100644 --- a/lib/ansible/modules/cloud/amazon/aws_kms.py +++ b/lib/ansible/modules/cloud/amazon/aws_kms.py @@ -26,6 +26,7 @@ short_description: Perform various KMS management tasks. description: - Manage role/user access to a KMS key. Not designed for encrypting/decrypting. version_added: "2.3" +requirements: [ boto3 ] options: mode: description: diff --git a/lib/ansible/modules/cloud/amazon/aws_waf_facts.py b/lib/ansible/modules/cloud/amazon/aws_waf_facts.py index 98c9b846218..9e327851446 100644 --- a/lib/ansible/modules/cloud/amazon/aws_waf_facts.py +++ b/lib/ansible/modules/cloud/amazon/aws_waf_facts.py @@ -12,6 +12,7 @@ short_description: Retrieve facts for WAF ACLs, Rule , Conditions and Filters. description: - Retrieve facts for WAF ACLs, Rule , Conditions and Filters. version_added: "2.4" +requirements: [ boto3 ] options: name: description: diff --git a/lib/ansible/modules/cloud/amazon/ec2_asg_facts.py b/lib/ansible/modules/cloud/amazon/ec2_asg_facts.py index fdc0ddb4b55..994a8453952 100644 --- a/lib/ansible/modules/cloud/amazon/ec2_asg_facts.py +++ b/lib/ansible/modules/cloud/amazon/ec2_asg_facts.py @@ -18,6 +18,7 @@ short_description: Gather facts about ec2 Auto Scaling Groups (ASGs) in AWS description: - Gather facts about ec2 Auto Scaling Groups (ASGs) in AWS version_added: "2.2" +requirements: [ boto3 ] author: "Rob White (@wimnat)" options: name: diff --git a/lib/ansible/modules/cloud/amazon/ec2_group_facts.py b/lib/ansible/modules/cloud/amazon/ec2_group_facts.py index af7f6ef80fd..d036ce548f6 100644 --- a/lib/ansible/modules/cloud/amazon/ec2_group_facts.py +++ b/lib/ansible/modules/cloud/amazon/ec2_group_facts.py @@ -18,6 +18,7 @@ short_description: Gather facts about ec2 security groups in AWS. description: - Gather facts about ec2 security groups in AWS. version_added: "2.3" +requirements: [ boto3 ] author: "Henrique Rodrigues (github.com/Sodki)" options: filters: diff --git a/lib/ansible/modules/cloud/amazon/ec2_snapshot_facts.py b/lib/ansible/modules/cloud/amazon/ec2_snapshot_facts.py index a4c8e8a66f1..d9a2414fe75 100644 --- a/lib/ansible/modules/cloud/amazon/ec2_snapshot_facts.py +++ b/lib/ansible/modules/cloud/amazon/ec2_snapshot_facts.py @@ -18,6 +18,7 @@ short_description: Gather facts about ec2 volume snapshots in AWS description: - Gather facts about ec2 volume snapshots in AWS version_added: "2.1" +requirements: [ boto3 ] author: "Rob White (@wimnat)" options: snapshot_ids: diff --git a/lib/ansible/modules/cloud/amazon/ec2_vpc_igw_facts.py b/lib/ansible/modules/cloud/amazon/ec2_vpc_igw_facts.py index 8051a247e09..7f912704f7f 100644 --- a/lib/ansible/modules/cloud/amazon/ec2_vpc_igw_facts.py +++ b/lib/ansible/modules/cloud/amazon/ec2_vpc_igw_facts.py @@ -18,6 +18,7 @@ short_description: Gather facts about internet gateways in AWS description: - Gather facts about internet gateways in AWS. version_added: "2.3" +requirements: [ boto3 ] author: "Nick Aslanidis (@naslanidis)" options: filters: diff --git a/lib/ansible/modules/cloud/amazon/ecs_ecr.py b/lib/ansible/modules/cloud/amazon/ecs_ecr.py index de98bb1d926..3c53034fa06 100644 --- a/lib/ansible/modules/cloud/amazon/ecs_ecr.py +++ b/lib/ansible/modules/cloud/amazon/ecs_ecr.py @@ -18,6 +18,7 @@ version_added: "2.3" short_description: Manage Elastic Container Registry repositories description: - Manage Elastic Container Registry repositories +requirements: [ boto3 ] options: name: description: diff --git a/lib/ansible/modules/cloud/amazon/elasticache.py b/lib/ansible/modules/cloud/amazon/elasticache.py index dfada424895..cbb09cc026d 100644 --- a/lib/ansible/modules/cloud/amazon/elasticache.py +++ b/lib/ansible/modules/cloud/amazon/elasticache.py @@ -16,6 +16,7 @@ description: - Manage cache clusters in Amazon Elasticache. - Returns information about the specified cache cluster. version_added: "1.4" +requirements: [ boto3 ] author: "Jim Dalton (@jsdalton)" options: state: diff --git a/lib/ansible/modules/cloud/amazon/elb_application_lb.py b/lib/ansible/modules/cloud/amazon/elb_application_lb.py index 64983320697..5fabfd3464f 100644 --- a/lib/ansible/modules/cloud/amazon/elb_application_lb.py +++ b/lib/ansible/modules/cloud/amazon/elb_application_lb.py @@ -25,6 +25,7 @@ short_description: Manage an Application load balancer description: - Manage an AWS Application Elastic Load Balancer. See U(https://aws.amazon.com/blogs/aws/new-aws-application-load-balancer/) for details. version_added: "2.4" +requirements: [ boto3 ] author: "Rob White (@wimnat)" options: access_logs_enabled: diff --git a/lib/ansible/modules/cloud/amazon/elb_application_lb_facts.py b/lib/ansible/modules/cloud/amazon/elb_application_lb_facts.py index 6ac866a38dc..268d96d52e5 100644 --- a/lib/ansible/modules/cloud/amazon/elb_application_lb_facts.py +++ b/lib/ansible/modules/cloud/amazon/elb_application_lb_facts.py @@ -17,6 +17,7 @@ short_description: Gather facts about application ELBs in AWS description: - Gather facts about application ELBs in AWS version_added: "2.4" +requirements: [ boto3 ] author: Rob White (@wimnat) options: load_balancer_arns: diff --git a/lib/ansible/modules/cloud/amazon/elb_target_group.py b/lib/ansible/modules/cloud/amazon/elb_target_group.py index 1203ec6074f..501b7382cbe 100644 --- a/lib/ansible/modules/cloud/amazon/elb_target_group.py +++ b/lib/ansible/modules/cloud/amazon/elb_target_group.py @@ -18,6 +18,7 @@ description: - Manage an AWS Application Elastic Load Balancer target group. See U(http://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-target-groups.html) for details. version_added: "2.4" +requirements: [ boto3 ] author: "Rob White (@wimnat)" options: deregistration_delay_timeout: diff --git a/lib/ansible/modules/cloud/amazon/elb_target_group_facts.py b/lib/ansible/modules/cloud/amazon/elb_target_group_facts.py index 0cf548ea30a..95dbf928704 100644 --- a/lib/ansible/modules/cloud/amazon/elb_target_group_facts.py +++ b/lib/ansible/modules/cloud/amazon/elb_target_group_facts.py @@ -17,6 +17,7 @@ short_description: Gather facts about ELB target groups in AWS description: - Gather facts about ELB target groups in AWS version_added: "2.4" +requirements: [ boto3 ] author: Rob White (@wimnat) options: load_balancer_arn: diff --git a/lib/ansible/modules/cloud/amazon/kinesis_stream.py b/lib/ansible/modules/cloud/amazon/kinesis_stream.py index 349f27cd6e0..26a0d34e7b5 100644 --- a/lib/ansible/modules/cloud/amazon/kinesis_stream.py +++ b/lib/ansible/modules/cloud/amazon/kinesis_stream.py @@ -20,6 +20,7 @@ description: - Update the retention period of a Kinesis Stream. - Update Tags on a Kinesis Stream. version_added: "2.2" +requirements: [ boto3 ] author: Allen Sanabria (@linuxdynasty) options: name: diff --git a/lib/ansible/modules/cloud/amazon/rds_param_group.py b/lib/ansible/modules/cloud/amazon/rds_param_group.py index da627d91d8a..e8584b435bc 100644 --- a/lib/ansible/modules/cloud/amazon/rds_param_group.py +++ b/lib/ansible/modules/cloud/amazon/rds_param_group.py @@ -26,6 +26,7 @@ version_added: "1.5" short_description: manage RDS parameter groups description: - Creates, modifies, and deletes RDS parameter groups. This module has a dependency on python-boto >= 2.5. +requirements: [ boto3 ] options: state: description: diff --git a/lib/ansible/modules/cloud/amazon/redshift_facts.py b/lib/ansible/modules/cloud/amazon/redshift_facts.py index 1053523f53c..1b09cc1fb12 100644 --- a/lib/ansible/modules/cloud/amazon/redshift_facts.py +++ b/lib/ansible/modules/cloud/amazon/redshift_facts.py @@ -19,6 +19,7 @@ short_description: Gather facts about Redshift cluster(s) description: - Gather facts about Redshift cluster(s) version_added: "2.4" +requirements: [ boto3 ] options: cluster_identifier: description: diff --git a/lib/ansible/modules/cloud/amazon/s3_website.py b/lib/ansible/modules/cloud/amazon/s3_website.py index 6c01985d76b..43658181f1b 100644 --- a/lib/ansible/modules/cloud/amazon/s3_website.py +++ b/lib/ansible/modules/cloud/amazon/s3_website.py @@ -18,6 +18,7 @@ short_description: Configure an s3 bucket as a website description: - Configure an s3 bucket as a website version_added: "2.2" +requirements: [ boto3 ] author: Rob White (@wimnat) options: name: