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-copy-jobs

Description

Returns a list of model copy jobs that you have submitted. You can filter the jobs to return based on one or more criteria. For more information, see Copy models to be used in other regions in the Amazon Bedrock User Guide .

See also: AWS API Documentation

list-model-copy-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: modelCopyJobSummaries

Synopsis

  list-model-copy-jobs
[--creation-time-after <value>]
[--creation-time-before <value>]
[--status-equals <value>]
[--source-account-equals <value>]
[--source-model-arn-equals <value>]
[--target-model-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)

Filters for model copy jobs created after the specified time.

--creation-time-before (timestamp)

Filters for model copy jobs created before the specified time.

--status-equals (string)

Filters for model copy jobs whose status matches the value that you specify.

Possible values:

  • InProgress
  • Completed
  • Failed

--source-account-equals (string)

Filters for model copy jobs in which the account that the source model belongs to is equal to the value that you specify.

--source-model-arn-equals (string)

Filters for model copy jobs in which the Amazon Resource Name (ARN) of the source model to is equal to the value that you specify.

--target-model-name-contains (string)

Filters for model copy jobs in which the name of the copied model contains the string that you specify.

--sort-by (string)

The field to sort by in the returned list of model copy jobs.

Possible values:

  • CreationTime

--sort-order (string)

Specifies whether to sort the results in 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 the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.

modelCopyJobSummaries -> (list)

A list of information about each model copy job.

(structure)

Contains details about each model copy job.

This data type is used in the following API operations:

jobArn -> (string)

The Amazon Resoource Name (ARN) of the model copy job.

status -> (string)

The status of the model copy job.

creationTime -> (timestamp)

The time that the model copy job was created.

targetModelArn -> (string)

The Amazon Resource Name (ARN) of the copied model.

targetModelName -> (string)

The name of the copied model.

sourceAccountId -> (string)

The unique identifier of the account that the model being copied originated from.

sourceModelArn -> (string)

The Amazon Resource Name (ARN) of the original model being copied.

targetModelKmsKeyArn -> (string)

The Amazon Resource Name (ARN) of the KMS key used to encrypt the copied model.

targetModelTags -> (list)

Tags associated with the copied model.

(structure)

Definition of the key/value pair for a tag.

key -> (string)

Key for the tag.

value -> (string)

Value for the tag.

failureMessage -> (string)

If a model fails to be copied, a message describing why the job failed is included here.

sourceModelName -> (string)

The name of the original model being copied.