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.
create-model-invocation-job¶
Description¶
Creates a batch inference job to invoke a model on multiple prompts. Format your data according to Format your inference data and upload it to an Amazon S3 bucket. For more information, see Process multiple prompts with batch inference .
The response returns a jobArn that you can use to stop or get details about the job.
See also: AWS API Documentation
Synopsis¶
create-model-invocation-job
--job-name <value>
--role-arn <value>
[--client-request-token <value>]
--model-id <value>
--input-data-config <value>
--output-data-config <value>
[--vpc-config <value>]
[--timeout-duration-in-hours <value>]
[--tags <value>]
[--cli-input-json <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¶
--job-name (string)
A name to give the batch inference job.
--role-arn (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 .
--client-request-token (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 .
--model-id (string)
The unique identifier of the foundation model to use for the batch inference job.
--input-data-config (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.s3BucketOwner -> (string)
The ID of the Amazon Web Services account that owns the S3 bucket containing the input data.
Shorthand Syntax:
s3InputDataConfig={s3InputFormat=string,s3Uri=string,s3BucketOwner=string}
JSON Syntax:
{
"s3InputDataConfig": {
"s3InputFormat": "JSONL",
"s3Uri": "string",
"s3BucketOwner": "string"
}
}
--output-data-config (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.s3BucketOwner -> (string)
The ID of the Amazon Web Services account that owns the S3 bucket containing the output data.
Shorthand Syntax:
s3OutputDataConfig={s3Uri=string,s3EncryptionKeyId=string,s3BucketOwner=string}
JSON Syntax:
{
"s3OutputDataConfig": {
"s3Uri": "string",
"s3EncryptionKeyId": "string",
"s3BucketOwner": "string"
}
}
--vpc-config (structure)
The configuration of the Virtual Private Cloud (VPC) for the data in the batch inference job. For more information, see Protect batch inference jobs using a VPC .
subnetIds -> (list)
An array of IDs for each subnet in the VPC to use.
(string)
securityGroupIds -> (list)
An array of IDs for each security group in the VPC to use.
(string)
Shorthand Syntax:
subnetIds=string,string,securityGroupIds=string,string
JSON Syntax:
{
"subnetIds": ["string", ...],
"securityGroupIds": ["string", ...]
}
--timeout-duration-in-hours (integer)
The number of hours after which to force the batch inference job to time out.
--tags (list)
Any tags to associate with the batch inference job. For more information, see Tagging Amazon Bedrock resources .
(structure)
Definition of the key/value pair for a tag.
key -> (string)
Key for the tag.value -> (string)
Value for the tag.
Shorthand Syntax:
key=string,value=string ...
JSON Syntax:
[
{
"key": "string",
"value": "string"
}
...
]
--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.
--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. 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.
- 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.