[ aws . sagemaker-inference-router-runtime ]
Submits an asynchronous inference request to an inference router. Before you call this operation, upload the input data to Amazon S3 in the router’s Amazon Web Services Region. The router returns as soon as it accepts the request, and sends the request to one of the destinations of the routing target. The destination reads the input from Amazon S3, and the inference response is written to the Amazon S3 output path that the routing target specifies.
If a destination doesn’t start the request within the routing target’s MaxTimeInBacklogSeconds , the router moves the request to another destination. After your model starts processing the request, the request doesn’t move. If no destination can take the request before RequestTTLSeconds runs out, or every destination has been tried, the router writes a failure object to the FailureLocation and publishes a notification to the routing target’s error topic, if one is configured.
For information about the permissions that the caller and each destination need, see Send asynchronous requests through an inference router .
See also: AWS API Documentation
invoke-inference-router-async
--inference-router-name <value>
--routing-target-name <value>
[--content-type <value>]
[--accept <value>]
[--custom-attributes <value>]
[--inference-id <value>]
--input-location <value>
[--s3-output-path-extension <value>]
[--filename <value>]
[--request-ttl-seconds <value>]
[--invocation-timeout-seconds <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]
[--cli-error-format <value>]
[--help]
--inference-router-name (string) [required]
The name of the inference router to invoke.
Constraints:
- min:
1- max:
63- pattern:
[a-zA-Z0-9](-*[a-zA-Z0-9])*
--routing-target-name (string) [required]
The name of the routing target in the inference router. The routing target must be configured for asynchronous inference.
Constraints:
- min:
1- max:
63- pattern:
[a-zA-Z0-9](-*[a-zA-Z0-9])*
--content-type (string)
The MIME type of the input data in Amazon S3. The router passes it to the destination.
Constraints:
- min:
0- max:
1024- pattern:
\p{ASCII}*
--accept (string)
The MIME type that you want for the inference response. The router passes it to the destination.
Constraints:
- min:
0- max:
1024- pattern:
\p{ASCII}*
--custom-attributes (string)
Provides additional information about the inference request. The value is an opaque string that the router passes, unchanged, to the model container of the destination that serves the request. The value can contain up to 1,024 visible US-ASCII characters.
Constraints:
- min:
0- max:
1024- pattern:
\p{ASCII}*
--inference-id (string)
An identifier for the inference request. If you don’t provide one, SageMaker AI generates one and returns it in the response.
Constraints:
- min:
1- max:
64- pattern:
\S[\p{Print}]*
--input-location (string) [required]
The Amazon S3 URI of the object that contains the input data for the inference. The bucket must be in the inference router’s Amazon Web Services Region and owned by the router’s account. The destination endpoint’s execution role reads the object, and the destination’s asynchronous inference limits apply to it.
Constraints:
- min:
1- max:
1024- pattern:
(https|s3)://([^/]+)/?(.*)
--s3-output-path-extension (string)
The path extension that is appended to the routing target’s Amazon S3 output path where the inference response is stored.
Constraints:
- min:
1- max:
512- pattern:
(?!s3:|https:)[a-zA-Z0-9!_.*'()/-]+
--filename (string)
The file name of the inference response stored in Amazon S3. If you don’t provide one, SageMaker AI generates one.
Constraints:
- min:
1- max:
64- pattern:
(?!.*\..*\.)[a-zA-Z0-9][a-zA-Z0-9-_\.]*
--request-ttl-seconds (integer)
The time to live of the request, in seconds, measured from when the router accepts it. If no destination starts the request in this time, the request fails. The default is 21,600 seconds (6 hours).
Constraints:
- min:
60- max:
21600
--invocation-timeout-seconds (integer)
The maximum time, in seconds, that a destination can spend processing the request before the request is marked as expired. The default is 900 seconds (15 minutes).
Constraints:
- min:
1- max:
3600
--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.
--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.
--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.
--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.
--cli-error-format (string)
The formatting style for error output. By default, errors are displayed in enhanced format.
--help (boolean)
Display help for the command/subcommand.
InferenceId -> (string)
The identifier for the inference request. This is the
InferenceIdthat you provided, or the one that SageMaker AI generated.Constraints:
- min:
0- max:
1024- pattern:
\p{ASCII}*
OutputLocation -> (string)
The Amazon S3 URI where the inference response is written. The location doesn’t change if the router moves the request to another destination.
Constraints:
- min:
0- max:
1024- pattern:
\p{ASCII}*
FailureLocation -> (string)
The Amazon S3 URI where the failure details are written if the inference fails.
Constraints:
- min:
0- max:
1024- pattern:
\p{ASCII}*