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-provisioned-model-throughputs

Description

Lists the Provisioned Throughputs in the account. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.

See also: AWS API Documentation

list-provisioned-model-throughputs 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: provisionedModelSummaries

Synopsis

  list-provisioned-model-throughputs
[--creation-time-after <value>]
[--creation-time-before <value>]
[--status-equals <value>]
[--model-arn-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

--creation-time-after (timestamp)

A filter that returns Provisioned Throughputs created after the specified time.

--creation-time-before (timestamp)

A filter that returns Provisioned Throughputs created before the specified time.

--status-equals (string)

A filter that returns Provisioned Throughputs if their statuses matches the value that you specify.

Possible values:

  • Creating
  • InService
  • Updating
  • Failed

--model-arn-equals (string)

A filter that returns Provisioned Throughputs whose model Amazon Resource Name (ARN) is equal to the value that you specify.

--name-contains (string)

A filter that returns Provisioned Throughputs if their name contains the expression that you specify.

--sort-by (string)

The field by which to sort the returned list of Provisioned Throughputs.

Possible values:

  • CreationTime

--sort-order (string)

The sort order of the results.

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 the number you specified in the maxResults field, this value is returned. To see the next batch of results, include this value in the nextToken field in another list request.

provisionedModelSummaries -> (list)

A list of summaries, one for each Provisioned Throughput in the response.

(structure)

A summary of information about a Provisioned Throughput.

This data type is used in the following API operations:

provisionedModelName -> (string)

The name of the Provisioned Throughput.

provisionedModelArn -> (string)

The Amazon Resource Name (ARN) of the Provisioned Throughput.

modelArn -> (string)

The Amazon Resource Name (ARN) of the model associated with the Provisioned Throughput.

desiredModelArn -> (string)

The Amazon Resource Name (ARN) of the model requested to be associated to this Provisioned Throughput. This value differs from the modelArn if updating hasn't completed.

foundationModelArn -> (string)

The Amazon Resource Name (ARN) of the base model for which the Provisioned Throughput was created, or of the base model that the custom model for which the Provisioned Throughput was created was customized.

modelUnits -> (integer)

The number of model units allocated to the Provisioned Throughput.

desiredModelUnits -> (integer)

The number of model units that was requested to be allocated to the Provisioned Throughput.

status -> (string)

The status of the Provisioned Throughput.

commitmentDuration -> (string)

The duration for which the Provisioned Throughput was committed.

commitmentExpirationTime -> (timestamp)

The timestamp for when the commitment term of the Provisioned Throughput expires.

creationTime -> (timestamp)

The time that the Provisioned Throughput was created.

lastModifiedTime -> (timestamp)

The time that the Provisioned Throughput was last modified.