Rename stepfunctions modules (ansible-collections#1310)

Rename stepfunctions modules SUMMARY Rename stepfunctions modules in line with naming guidelines (drop the aws_ prefix) ISSUE TYPE Feature Pull Request COMPONENT NAME plugins/modules/aws_step_functions_state_machine.py plugins/modules/stepfunctions_state_machine.py plugins/modules/aws_step_functions_state_machine_execution.py plugins/modules/stepfunctions_state_machine_execution.py ADDITIONAL INFORMATION Reviewed-by: Alina Buzachis <None> Reviewed-by: Mark Chappell <None>
abikouo · Jul 5, 2022 · 822255c · 822255c
1 parent 98ce05b
commit 822255c
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 24 deletions.
diff --git a/aws_step_functions_state_machine.py → stepfunctions_state_machine.py b/aws_step_functions_state_machine.py → stepfunctions_state_machine.py
@@ -9,51 +9,53 @@
 
 DOCUMENTATION = '''
 ---
-module: aws_step_functions_state_machine
+module: stepfunctions_state_machine
 version_added: 1.0.0
 short_description: Manage AWS Step Functions state machines
 description:
-  - Create, update and delete state machines in AWS Step Functions.
-  - Calling the module in C(state=present) for an existing AWS Step Functions state machine
-    will attempt to update the state machine definition, IAM Role, or tags with the provided data.
+    - Create, update and delete state machines in AWS Step Functions.
+    - Calling the module in C(state=present) for an existing AWS Step Functions state machine
+      will attempt to update the state machine definition, IAM Role, or tags with the provided data.
+    - Prior to release 5.0.0 this module was called C(community.aws.aws_step_functions_state_machine).
+      The usage did not change.
 
 options:
     name:
         description:
-            - Name of the state machine
+            - Name of the state machine.
         required: true
         type: str
     definition:
         description:
             - The Amazon States Language definition of the state machine. See
               U(https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html) for more
               information on the Amazon States Language.
-            - "This parameter is required when C(state=present)."
+            - Required when I(state=present).
         type: json
     role_arn:
         description:
             - The ARN of the IAM Role that will be used by the state machine for its executions.
-            - "This parameter is required when C(state=present)."
+            - Required when I(state=present).
         type: str
     state:
         description:
-            - Desired state for the state machine
+            - Desired state for the state machine.
         default: present
         choices: [ present, absent ]
         type: str
 
 extends_documentation_fragment:
-  - amazon.aws.aws
-  - amazon.aws.ec2
-  - amazon.aws.tags
+    - amazon.aws.aws
+    - amazon.aws.ec2
+    - amazon.aws.tags
 author:
-  - Tom De Keyser (@tdekeyser)
+    - Tom De Keyser (@tdekeyser)
 '''
 
 EXAMPLES = '''
 # Create a new AWS Step Functions state machine
 - name: Setup HelloWorld state machine
-  community.aws.aws_step_functions_state_machine:
+  community.aws.stepfunctions_state_machine:
     name: "HelloWorldStateMachine"
     definition: "{{ lookup('file','state_machine.json') }}"
     role_arn: arn:aws:iam::987654321012:role/service-role/invokeLambdaStepFunctionsRole
@@ -62,7 +64,7 @@
 
 # Update an existing state machine
 - name: Change IAM Role and tags of HelloWorld state machine
-  community.aws.aws_step_functions_state_machine:
+  community.aws.stepfunctions_state_machine:
     name: HelloWorldStateMachine
     definition: "{{ lookup('file','state_machine.json') }}"
     role_arn: arn:aws:iam::987654321012:role/service-role/anotherStepFunctionsRole
@@ -71,7 +73,7 @@
 
 # Remove the AWS Step Functions state machine
 - name: Delete HelloWorld state machine
-  community.aws.aws_step_functions_state_machine:
+  community.aws.stepfunctions_state_machine:
     name: HelloWorldStateMachine
     state: absent
 '''

diff --git a/...step_functions_state_machine_execution.py → stepfunctions_state_machine_execution.py b/...step_functions_state_machine_execution.py → stepfunctions_state_machine_execution.py
@@ -9,18 +9,19 @@
 
 DOCUMENTATION = '''
 ---
-module: aws_step_functions_state_machine_execution
+module: stepfunctions_state_machine_execution
 version_added: 1.0.0
 
-short_description: Start or stop execution of an AWS Step Functions state machine.
-
+short_description: Start or stop execution of an AWS Step Functions state machine
 
 description:
     - Start or stop execution of a state machine in AWS Step Functions.
+    - Prior to release 5.0.0 this module was called C(community.aws.aws_step_functions_state_machine_execution).
+      The usage did not change.
 
 options:
     action:
-        description: Desired action (start or stop) for a state machine execution.
+        description: Desired action (C(start) or C(stop)) for a state machine execution.
         default: start
         choices: [ start, stop ]
         type: str
@@ -47,23 +48,22 @@
         default: ''
 
 extends_documentation_fragment:
-- amazon.aws.aws
-- amazon.aws.ec2
-
+    - amazon.aws.aws
+    - amazon.aws.ec2
 
 author:
     - Prasad Katti (@prasadkatti)
 '''
 
 EXAMPLES = '''
 - name: Start an execution of a state machine
-  community.aws.aws_step_functions_state_machine_execution:
+  community.aws.stepfunctions_state_machine_execution:
     name: an_execution_name
     execution_input: '{ "IsHelloWorldExample": true }'
     state_machine_arn: "arn:aws:states:us-west-2:682285639423:stateMachine:HelloWorldStateMachine"
 
 - name: Stop an execution of a state machine
-  community.aws.aws_step_functions_state_machine_execution:
+  community.aws.stepfunctions_state_machine_execution:
     action: stop
     execution_arn: "arn:aws:states:us-west-2:682285639423:execution:HelloWorldStateMachineCopy:a1e8e2b5-5dfe-d40e-d9e3-6201061047c8"
     cause: "cause of task failure"