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 . machinelearning . wait ]
Wait until JMESPath query Results[].Status returns COMPLETED for all elements when polling with describe-ml-models
. It will poll every 30 seconds until a successful state has been reached. This will exit with a return code of 255 after 60 failed checks.
See also: AWS API Documentation
ml-model-available
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: Results
ml-model-available
[--filter-variable <value>]
[--eq <value>]
[--gt <value>]
[--lt <value>]
[--ge <value>]
[--le <value>]
[--ne <value>]
[--prefix <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>]
--filter-variable
(string)
Use one of the following variables to filter a list of
MLModel
:
CreatedAt
- Sets the search criteria toMLModel
creation date.Status
- Sets the search criteria toMLModel
status.Name
- Sets the search criteria to the contents ofMLModel
****Name
.IAMUser
- Sets the search criteria to the user account that invoked theMLModel
creation.TrainingDataSourceId
- Sets the search criteria to theDataSource
used to train one or moreMLModel
.RealtimeEndpointStatus
- Sets the search criteria to theMLModel
real-time endpoint status.MLModelType
- Sets the search criteria toMLModel
type: binary, regression, or multi-class.Algorithm
- Sets the search criteria to the algorithm that theMLModel
uses.TrainingDataURI
- Sets the search criteria to the data file(s) used in training aMLModel
. The URL can identify either a file or an Amazon Simple Storage Service (Amazon S3) bucket or directory.Possible values:
CreatedAt
LastUpdatedAt
Status
Name
IAMUser
TrainingDataSourceId
RealtimeEndpointStatus
MLModelType
Algorithm
TrainingDataURI
--eq
(string)
The equal to operator. TheMLModel
results will haveFilterVariable
values that exactly match the value specified withEQ
.
--gt
(string)
The greater than operator. TheMLModel
results will haveFilterVariable
values that are greater than the value specified withGT
.
--lt
(string)
The less than operator. TheMLModel
results will haveFilterVariable
values that are less than the value specified withLT
.
--ge
(string)
The greater than or equal to operator. TheMLModel
results will haveFilterVariable
values that are greater than or equal to the value specified withGE
.
--le
(string)
The less than or equal to operator. TheMLModel
results will haveFilterVariable
values that are less than or equal to the value specified withLE
.
--ne
(string)
The not equal to operator. TheMLModel
results will haveFilterVariable
values not equal to the value specified withNE
.
--prefix
(string)
A string that is found at the beginning of a variable, such as
Name
orId
.For example, an
MLModel
could have theName
2014-09-09-HolidayGiftMailer
. To search for thisMLModel
, selectName
for theFilterVariable
and any of the following strings for thePrefix
:
- 2014-09
- 2014-09-09
- 2014-09-09-Holiday
--sort-order
(string)
A two-value parameter that determines the sequence of the resulting list of
MLModel
.
asc
- Arranges the list in ascending order (A-Z, 0-9).dsc
- Arranges the list in descending order (Z-A, 9-0).Results are sorted by
FilterVariable
.Possible values:
asc
dsc
--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 theNextToken
value in thestarting-token
argument of a subsequent command. Do not use theNextToken
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.
--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.
None