AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

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.

[ aws . bedrock ]

list-model-invocation-jobs

Description

Lists all batch inference jobs in the account. For more information, see View details about a batch inference job .

See also: AWS API Documentation

list-model-invocation-jobs is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: invocationJobSummaries

Synopsis

  list-model-invocation-jobs
[--submit-time-after <value>]
[--submit-time-before <value>]
[--status-equals <value>]
[--name-contains <value>]
[--sort-by <value>]
[--sort-order <value>]
[--cli-input-json <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <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>]

Options

--submit-time-after (timestamp)

Specify a time to filter for batch inference jobs that were submitted after the time you specify.

--submit-time-before (timestamp)

Specify a time to filter for batch inference jobs that were submitted before the time you specify.

--status-equals (string)

Specify a status to filter for batch inference jobs whose statuses match the string you specify.

Possible values:

  • Submitted
  • InProgress
  • Completed
  • Failed
  • Stopping
  • Stopped
  • PartiallyCompleted
  • Expired
  • Validating
  • Scheduled

--name-contains (string)

Specify a string to filter for batch inference jobs whose names contain the string.

--sort-by (string)

An attribute by which to sort the results.

Possible values:

  • CreationTime

--sort-order (string)

Specifies whether to sort the results by ascending or descending order.

Possible values:

  • Ascending
  • Descending

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

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command's output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command's output. If the total number of items available is more than the value specified, a NextToken is provided in the command's output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

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

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.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

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

Output

nextToken -> (string)

If there are more results than can fit in the response, a nextToken is returned. Use the nextToken in a request to return the next batch of results.

invocationJobSummaries -> (list)

A list of items, each of which contains a summary about a batch inference job.

(structure)

A summary of a batch inference job.

jobArn -> (string)

The Amazon Resource Name (ARN) of the batch inference job.

jobName -> (string)

The name of the batch inference job.

modelId -> (string)

The unique identifier of the foundation model used for model inference.

clientRequestToken -> (string)

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency .

roleArn -> (string)

The Amazon Resource Name (ARN) of the service role with permissions to carry out and manage batch inference. You can use the console to create a default service role or follow the steps at Create a service role for batch inference .

status -> (string)

The status of the batch inference job.

message -> (string)

If the batch inference job failed, this field contains a message describing why the job failed.

submitTime -> (timestamp)

The time at which the batch inference job was submitted.

lastModifiedTime -> (timestamp)

The time at which the batch inference job was last modified.

endTime -> (timestamp)

The time at which the batch inference job ended.

inputDataConfig -> (tagged union structure)

Details about the location of the input to the batch inference job.

Note

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

s3InputDataConfig -> (structure)

Contains the configuration of the S3 location of the input data.

s3InputFormat -> (string)

The format of the input data.

s3Uri -> (string)

The S3 location of the input data.

outputDataConfig -> (tagged union structure)

Details about the location of the output of the batch inference job.

Note

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

s3OutputDataConfig -> (structure)

Contains the configuration of the S3 location of the output data.

s3Uri -> (string)

The S3 location of the output data.

s3EncryptionKeyId -> (string)

The unique identifier of the key that encrypts the S3 location of the output data.

timeoutDurationInHours -> (integer)

The number of hours after which the batch inference job was set to time out.

jobExpirationTime -> (timestamp)

The time at which the batch inference job times or timed out.