The following macros are not currently supported in the header:
  • unmigrated-wiki-markup

Documentation for Tasks for AWS 2.12 – other releases are available in the Tasks for AWS Documentation Directory.
View

Unknown macro: {spacejump}

or visit the current documentation home.

Using the AWS Step Functions State Machine task in Bamboo

Owned by Steffen Opel [Utoolity]
16.02.2017
2 min read

You can use the AWS Step Functions State Machine task to create or delete an AWS Step Functions state machine and start or stop a state machine execution.

On this page:

Related Pages:

Configuration

To configure an AWS Step Functions State Machine task:

  1. Navigate to the Tasks configuration tab for the job (this will be the default job if creating a new plan).
  2. Click the name of an existing AWS Step Functions State Machine task, or click Add Task and then AWS Step Functions State Machine to create a new task.

  3. Complete the following settings:

    1. Common to all tasks

       Click here to expand...
      Task Description (Optional) Identify the purpose of the task.
      Disable this task

      Check, or clear, to selectively run this task.

      Action

      Each task supports one or more actions depending on the target AWS resource. Select the desired action and configure the action specific parameters below.

      RegionSelect the desired AWS Region. Alternatively, select [Use region variable ...] to supply the region dynamically via Bamboo variables (needs to be a region code such as ap-southeast-2) - refer to How to parametrize the AWS region via a Bamboo variable for details.
      ...Configure task/action specific parameters, see below ...
      AWS Security Credentials
      SourceSelect the source for the required AWS Security Credentials - can be either Inline, an IAM Role for EC2 or a shared Identity Federation for AWS Connector.
      Connector(Conditional) Select the shared Identity Federation for AWS Connector. Alternatively, select [Use connector variable ...] to supply the connector dynamically via Bamboo variables (needs to be a connector id such as f24e81bc-7aff-42db-86a2-7cf82e24d871) - refer to How to parametrize the AWS connector via a Bamboo variable for details.

      • Actions supported by this task:

        Create State Machine


        Name

        Specify the state machine name.

        Role ARN

        Specify the Amazon Resource Name (ARN) of the IAM role to use for this state machine.

        DefinitionSpecify the Amazon States Language definition of the state machine.

        Delete State Machine


        State Machine ARN

        Specify the Amazon Resource Name (ARN) of the state machine.

        Start Execution


        State Machine ARN

        see Delete State Machine above

        Name

        (Optional) Specify a name for the execution.

        Input(Optional) Specify the JSON input data for the execution.
        Await Execution Result Timeout
        		Specify how long to await the execution to return a result (seconds, 0 to skip).

        Stop Execution


        Execution ARN
        		Specify the Amazon Resource Name (ARN) of the execution.
        Error
        		(Optional) Specify an arbitrary error code that identifies the cause of the termination.
        Cause(Optional) Specify a more detailed explanation of the cause of the termination.

Variables

All tasks support Bamboo Variable Substitution/Definition - this task's actions generate variables as follows:

A task's generated variables might get amended with respective AWS API additions over time - a live build log will always provide the most current variable shape accordingly

Create State Machine

Creating common variables for 1 resources affected by task:
... bamboo.custom.aws.stepfunctions.statemachine.resources: arn:aws:states:us-east-1:288727192237:stateMachine:taws-it280-1-ubot
Creating resource variables for state machine 'arn:aws:states:us-east-1:288727192237:stateMachine:taws-it280-1-ubot':
... bamboo.custom.aws.stepfunctions.statemachine.resources.arn:aws:states:us-east-1:288727192237:stateMachine:taws-it280-1-ubot.StateMachineArn: arn:aws:states:us-east-1:288727192237:stateMachine:taws-it280-1-ubot
... bamboo.custom.aws.stepfunctions.statemachine.resources.arn:aws:states:us-east-1:288727192237:stateMachine:taws-it280-1-ubot.CreationDate: 20170216T142255Z
Creating common variables for first resource affected by task:
Creating resource variables for state machine 'arn:aws:states:us-east-1:288727192237:stateMachine:taws-it280-1-ubot':
... bamboo.custom.aws.stepfunctions.statemachine.first.StateMachineArn: arn:aws:states:us-east-1:288727192237:stateMachine:taws-it280-1-ubot
... bamboo.custom.aws.stepfunctions.statemachine.first.CreationDate: 20170216T142255Z

Delete State Machine

N/A

Start Execution

Creating common variables for 1 resources affected by task:
... bamboo.custom.aws.stepfunctions.execution.resources: arn:aws:states:us-east-1:288727192237:execution:taws-it280-1-ubot:TAWS-IT2120-SFCSSD-1-execution-1
Creating resource variables for execution 'arn:aws:states:us-east-1:288727192237:execution:taws-it280-1-ubot:TAWS-IT2120-SFCSSD-1-execution-1':
... bamboo.custom.aws.stepfunctions.execution.resources.arn:aws:states:us-east-1:288727192237:execution:taws-it280-1-ubot:TAWS-IT2120-SFCSSD-1-execution-1.ExecutionArn: arn:aws:states:us-east-1:288727192237:execution:taws-it280-1-ubot:TAWS-IT2120-SFCSSD-1-execution-1
... bamboo.custom.aws.stepfunctions.execution.resources.arn:aws:states:us-east-1:288727192237:execution:taws-it280-1-ubot:TAWS-IT2120-SFCSSD-1-execution-1.Input: {}
... bamboo.custom.aws.stepfunctions.execution.resources.arn:aws:states:us-east-1:288727192237:execution:taws-it280-1-ubot:TAWS-IT2120-SFCSSD-1-execution-1.Name: TAWS-IT2120-SFCSSD-1-execution-1
... bamboo.custom.aws.stepfunctions.execution.resources.arn:aws:states:us-east-1:288727192237:execution:taws-it280-1-ubot:TAWS-IT2120-SFCSSD-1-execution-1.Output: [{},{}]
... bamboo.custom.aws.stepfunctions.execution.resources.arn:aws:states:us-east-1:288727192237:execution:taws-it280-1-ubot:TAWS-IT2120-SFCSSD-1-execution-1.StateMachineArn: arn:aws:states:us-east-1:288727192237:stateMachine:taws-it280-1-ubot
... bamboo.custom.aws.stepfunctions.execution.resources.arn:aws:states:us-east-1:288727192237:execution:taws-it280-1-ubot:TAWS-IT2120-SFCSSD-1-execution-1.Status: SUCCEEDED
... bamboo.custom.aws.stepfunctions.execution.resources.arn:aws:states:us-east-1:288727192237:execution:taws-it280-1-ubot:TAWS-IT2120-SFCSSD-1-execution-1.StartDate: 20170216T142255Z
... bamboo.custom.aws.stepfunctions.execution.resources.arn:aws:states:us-east-1:288727192237:execution:taws-it280-1-ubot:TAWS-IT2120-SFCSSD-1-execution-1.StopDate: 20170216T142311Z


Stop Execution

Creating common variables for 1 resources affected by task:
... bamboo.custom.aws.stepfunctions.execution.resources: arn:aws:states:us-east-1:288727192237:execution:taws-it280-1-ubot:TAWS-IT2120-SFCSSD-1-execution-2
Creating resource variables for execution 'arn:aws:states:us-east-1:288727192237:execution:taws-it280-1-ubot:TAWS-IT2120-SFCSSD-1-execution-2':
... bamboo.custom.aws.stepfunctions.execution.resources.arn:aws:states:us-east-1:288727192237:execution:taws-it280-1-ubot:TAWS-IT2120-SFCSSD-1-execution-2.ExecutionArn: arn:aws:states:us-east-1:288727192237:execution:taws-it280-1-ubot:TAWS-IT2120-SFCSSD-1-execution-2
... bamboo.custom.aws.stepfunctions.execution.resources.arn:aws:states:us-east-1:288727192237:execution:taws-it280-1-ubot:TAWS-IT2120-SFCSSD-1-execution-2.StopDate: 20170216T142327Z
Creating common variables for first resource affected by task:
Creating resource variables for execution 'arn:aws:states:us-east-1:288727192237:execution:taws-it280-1-ubot:TAWS-IT2120-SFCSSD-1-execution-2':
... bamboo.custom.aws.stepfunctions.execution.first.ExecutionArn: arn:aws:states:us-east-1:288727192237:execution:taws-it280-1-ubot:TAWS-IT2120-SFCSSD-1-execution-2
... bamboo.custom.aws.stepfunctions.execution.first.StopDate: 20170216T142327Z


How-to Articles

Frequently Asked Questions (FAQ)

Atlassian®, Atlassian Bamboo®, Bitbucket®, Atlassian Crowd®, Confluence®, Jira®, Jira Service Management™, Opsgenie®, and Statuspage™ are registered trademarks of Atlassian.
Amazon Web Services™, AWS™ and the “Powered by Amazon Web Services” logo are trademarks of Amazon.com, Inc. or its affiliates in the United States and/or other countries.

Utoolity® is a registered trademark of Utoolity GmbH.
© 2024 Utoolity GmbH. All rights reserved.