AWS CLI Command Reference

[ aws . bedrock-agent-runtime ]

get-invocation-step

Description

Retrieves the details of a specific invocation step within an invocation in a session. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions .

See also: AWS API Documentation

Synopsis

  get-invocation-step
--invocation-identifier <value>
--invocation-step-id <value>
--session-identifier <value>
[--cli-input-json | --cli-input-yaml]
[--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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--invocation-identifier (string)

The unique identifier for the invocation in UUID format.

--invocation-step-id (string)

The unique identifier (in UUID format) for the specific invocation step to retrieve.

--session-identifier (string)

The unique identifier for the invocation step’s associated session. You can specify either the session’s sessionId or its Amazon Resource Name (ARN).

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--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.

  • json
  • text
  • table
  • yaml
  • yaml-stream

--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.

  • on
  • off
  • auto

--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.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output

invocationStep -> (structure)

The complete details of the requested invocation step.

invocationId -> (string)

The unique identifier (in UUID format) for the invocation that includes the invocation step.

invocationStepId -> (string)

The unique identifier (in UUID format) for the invocation step.

invocationStepTime -> (timestamp)

The timestamp for when the invocation step was created.

payload -> (tagged union structure)

Payload content, such as text and images, for the invocation step.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: contentBlocks.

contentBlocks -> (list)

The content for the invocation step.

(tagged union structure)

A block of content that you pass to, or receive from, a Amazon Bedrock session in an invocation step. You pass the content to a session in the payLoad of the PutInvocationStep API operation. You retrieve the content with the GetInvocationStep API operation.

For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions .

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: image, text.

image -> (structure)

The image in the invocation step.

format -> (string)

The format of the image.

source -> (tagged union structure)

The source for the image.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: bytes, s3Location.

bytes -> (blob)

The raw image bytes for the image. If you use an Amazon Web Services SDK, you don’t need to encode the image bytes in base64.

s3Location -> (structure)

The path to the Amazon S3 bucket where the image is stored.

uri -> (string)

The path to the Amazon S3 bucket where the image is stored.

text -> (string)

The text in the invocation step.

sessionId -> (string)

The unique identifier of the session containing the invocation step.
© Copyright 2025, Amazon Web Services. Created using Sphinx.