AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.
Executes the next step of an act, processing tool call results and returning new tool calls if needed.
See also: AWS API Documentation
invoke-act-step uses document type values. Document types follow the JSON data model where valid values are: strings, numbers, booleans, null, arrays, and objects. For command input, options and nested parameters that are labeled with the type document must be provided as JSON. Shorthand syntax does not support document types.
invoke-act-step
--workflow-definition-name <value>
--workflow-run-id <value>
--session-id <value>
--act-id <value>
--call-results <value>
[--previous-step-id <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--v2-debug]
--workflow-definition-name (string)
The name of the workflow definition containing the act.
--workflow-run-id (string)
The unique identifier of the workflow run containing the act.
--session-id (string)
The unique identifier of the session containing the act.
--act-id (string)
The unique identifier of the act to invoke the next step for.
--call-results (list)
The results from previous tool calls that the act requested.
(structure)
The result returned from executing a tool call.
callId -> (string)
The identifier of the tool call that this result corresponds to.content -> (list)
The content returned by the tool execution, which can include text or other media types.
(tagged union structure)
Content returned from a tool call execution.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:text.text -> (string)
Text content returned from the tool execution.
Shorthand Syntax:
callId=string,content=[{text=string},{text=string}] ...
JSON Syntax:
[
{
"callId": "string",
"content": [
{
"text": "string"
}
...
]
}
...
]
--previous-step-id (string)
The identifier of the previous step, used for tracking execution flow.
--cli-input-json (string)
Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.
--debug (boolean)
Turn on debug logging.
--endpoint-url (string)
Override command’s default URL with the given URL.
--no-verify-ssl (boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate (boolean)
Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.
--output (string)
The formatting style for command output.
--query (string)
A JMESPath query to use in filtering the response data.
--profile (string)
Use a specific profile from your credential file.
--region (string)
The region to use. Overrides config/env settings.
--version (string)
Display the version of this tool.
--color (string)
Turn on/off color output.
--no-sign-request (boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle (string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout (int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout (int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
--v2-debug (boolean)
Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.
calls -> (list)
A list of tool calls that the act wants to execute in this step.
(structure)
A request for the client to execute a specific tool with given parameters.
callId -> (string)
A unique identifier for this tool call, used to match results back to requests.input -> (document)
The input parameters for the tool call, formatted according to the tool’s schema.name -> (string)
The name of the tool to invoke, following the pattern ‘tool.{toolName}’ or ‘browser.{browserAction}’.
stepId -> (string)
The unique identifier for this execution step.