Get Started on Cloud
BasicsPipelinesActions & ServicesEnvironmentsIntegrationsTargetsTestsDomainsSandboxesAgents & TunnelsYAML

YAML for AWS CLI 2

View as Markdown

Execute AWS CLI v2 commands with integration-based authentication.

YAML parameters for AWS CLI 2

PARAMETERS
integrationrequiredstring
Amazon integration (AMAZON).
execute_commandsrequiredstring[]
The commands that will be executed.
regionrequiredstring
The Amazon S3 region.
typerequiredstring

Value: AWS_CLI_2

actionrequiredstring
Unique identifier for the action within the pipeline.
shellstring enum
The name of the shell that will be used to execute commands.
Allowed enum:
SH,
BASH,
POWERSHELL
setup_commandsstring[]
The command that will be executed only on the first run.
trigger_timestring enum
Specifies when the action should be executed.
Allowed enum:
ON_EVERY_EXECUTION,
ON_SUCCESS,
ON_FAILURE,
ON_BACK_TO_SUCCESS,
ON_WARNING,
ON_WAIT_FOR_APPROVE,
ON_TERMINATE
loopstring[]
The list of variables for dynamic action execution. The action runs once for each value.
run_only_on_first_failureboolean
Defines whether the action should be executed on each failure. Restricted to and required if the trigger_time is ON_FAILURE.
disabledboolean
When set to true the action is disabled. By default it is set to false.
timeoutinteger
The timeout in seconds.
ignore_errorsboolean
If set to true the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions.
retry_intervalinteger
Delay time between auto retries in seconds.
retry_countinteger
Number of retries if the action fails.
run_nextstring enum
Defines whether the action should run in parallel with the next one.
Allowed enum:
WAIT_ON_SUCCESS,
IN_SOFT_PARALLEL,
IN_HARD_PARALLEL
trigger_conditionsTriggerConditionYaml[]
The list of trigger conditions to meet so that the action can be triggered.
variablesVariableYaml[]
The list of variables you can use in the action.

Last modified on Apr 27, 2026

Previous pageAWS CLINext pageAWS CloudFormation

YAML examples for AWS CLI 2

AWS CLI v2 commands

yaml
  - action: "Run AWS CLI v2 command"
    type: "AWS_CLI_2"
    trigger_time: "ON_EVERY_EXECUTION"
    shell: "SH"
    setup_commands:
      - "apt-get update && apt-get -y install git"
    execute_commands:
      - "aws s3 ls"
    region: "us-west-2"
    integration: "my_integration"