AWS cli documentation change
Summary
Changed 'Amazon Braket job' to 'Amazon Braket hybrid job' in command description
Security assessment
Terminology update reflects product naming changes but contains no security context.
Diff
diff --git a/cli/latest/reference/braket/create-job.md b/cli/latest/reference/braket/create-job.md index 54710dab7..5749ac19f 100644 --- a//cli/latest/reference/braket/create-job.md +++ b//cli/latest/reference/braket/create-job.md @@ -15 +15 @@ - * [AWS CLI 2.28.8 Command Reference](../../index.html) » + * [AWS CLI 2.28.11 Command Reference](../../index.html) » @@ -59 +59 @@ First time using the AWS CLI? See the [User Guide](https://docs.aws.amazon.com/c -Creates an Amazon Braket job. +Creates an Amazon Braket hybrid job. @@ -67,3 +66,0 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/braket - --algorithm-specification <value> - [--associations <value>] - [--checkpoint-config <value>] @@ -71,2 +68 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/braket - --device-config <value> - [--hyper-parameters <value>] + --algorithm-specification <value> @@ -74,2 +69,0 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/braket - --instance-config <value> - --job-name <value> @@ -76,0 +71,2 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/braket + [--checkpoint-config <value>] + --job-name <value> @@ -78,0 +75,3 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/braket + --instance-config <value> + [--hyper-parameters <value>] + --device-config <value> @@ -79,0 +79 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/braket + [--associations <value>] @@ -103,0 +104,4 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/braket +`--client-token` (string) + +> The client token associated with this request that guarantees that the request is idempotent. + @@ -108,8 +111,0 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/braket -> containerImage -> (structure) -> ->> The container image used to create an Amazon Braket job. ->> ->> uri -> (string) ->> ->>> The URI locating the container image. -> @@ -120,4 +115,0 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/braket ->> compressionType -> (string) ->> ->>> The type of compression used by the Python scripts for an Amazon Braket job. ->> @@ -126 +118 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/braket ->>> The path to the Python script that serves as the entry point for an Amazon Braket job. +>>> The entry point in the algorithm scripts from where the execution begins in the hybrid job. @@ -130 +122,13 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/braket ->>> The URI that specifies the S3 path to the Python script module that contains the training script used by an Amazon Braket job. +>>> The URI that specifies the S3 path to the algorithm scripts used by an Amazon Braket hybrid job. +>> +>> compressionType -> (string) +>> +>>> The type of compression used to store the algorithm scripts in Amazon S3 storage. +> +> containerImage -> (structure) +> +>> The container image used to create an Amazon Braket hybrid job. +>> +>> uri -> (string) +>> +>>> The URI locating the container image. @@ -135 +139 @@ Shorthand Syntax: - containerImage={uri=string},scriptModeConfig={compressionType=string,entryPoint=string,s3Uri=string} + scriptModeConfig={entryPoint=string,s3Uri=string,compressionType=string},containerImage={uri=string} @@ -142,3 +145,0 @@ JSON Syntax: - "containerImage": { - "uri": "string" - }, @@ -146 +146,0 @@ JSON Syntax: - "compressionType": "NONE"|"GZIP", @@ -148 +148,5 @@ JSON Syntax: - "s3Uri": "string" + "s3Uri": "string", + "compressionType": "NONE"|"GZIP" + }, + "containerImage": { + "uri": "string" @@ -153 +157 @@ JSON Syntax: -`--associations` (list) +`--input-data-config` (list) @@ -155 +159 @@ JSON Syntax: -> The list of Amazon Braket resources associated with the hybrid job. +> A list of parameters that specify the name and type of input data and where it is located. @@ -159 +163 @@ JSON Syntax: ->> The Amazon Braket resource and the association type. +>> A list of parameters that specify the input channels, type of input data, and where it is located. @@ -161 +165 @@ JSON Syntax: ->> arn -> (string) +>> channelName -> (string) @@ -163 +167 @@ JSON Syntax: ->>> The Amazon Braket resource arn. +>>> A named input source that an Amazon Braket hybrid job can consume. @@ -165 +169 @@ JSON Syntax: ->> type -> (string) +>> contentType -> (string) @@ -167 +171,13 @@ JSON Syntax: ->>> The association type for the specified Amazon Braket resource arn. +>>> The MIME type of the data. +>> +>> dataSource -> (structure) +>> +>>> The location of the input data. +>>> +>>> s3DataSource -> (structure) +>>> +>>>> Amazon S3 path of the input data used by the hybrid job. +>>>> +>>>> s3Uri -> (string) +>>>> +>>>>> Depending on the value specified for the `S3DataType` , identifies either a key name prefix or a manifest that locates the S3 data source. @@ -172 +188 @@ Shorthand Syntax: - arn=string,type=string ... + channelName=string,contentType=string,dataSource={s3DataSource={s3Uri=string}} ... @@ -180,2 +196,7 @@ JSON Syntax: - "arn": "string", - "type": "RESERVATION_TIME_WINDOW_ARN" + "channelName": "string", + "contentType": "string", + "dataSource": { + "s3DataSource": { + "s3Uri": "string" + } + } @@ -187 +208 @@ JSON Syntax: -`--checkpoint-config` (structure) +`--output-data-config` (structure) @@ -189 +210 @@ JSON Syntax: -> Information about the output locations for job checkpoint data. +> The path to the S3 location where you want to store hybrid job artifacts and the encryption key used to store them. @@ -191 +212 @@ JSON Syntax: -> localPath -> (string) +> kmsKeyId -> (string) @@ -193 +214 @@ JSON Syntax: ->> (Optional) The local directory where checkpoints are written. The default directory is `/opt/braket/checkpoints/` . +>> The AWS Key Management Service (AWS KMS) key that Amazon Braket uses to encrypt the hybrid job training artifacts at rest using Amazon S3 server-side encryption. @@ -195 +216 @@ JSON Syntax: -> s3Uri -> (string) +> s3Path -> (string) @@ -197 +218 @@ JSON Syntax: ->> Identifies the S3 path where you want Amazon Braket to store checkpoints. For example, `s3://bucket-name/key-name-prefix` . +>> Identifies the S3 path where you want Amazon Braket to store the hybrid job training artifacts. For example, `s3://bucket-name/key-name-prefix` . @@ -202 +223 @@ Shorthand Syntax: - localPath=string,s3Uri=string + kmsKeyId=string,s3Path=string @@ -209,2 +230,2 @@ JSON Syntax: - "localPath": "string", - "s3Uri": "string" + "kmsKeyId": "string", + "s3Path": "string" @@ -214,5 +235 @@ JSON Syntax: -`--client-token` (string) - -> A unique token that guarantees that the call to this API is idempotent. - -`--device-config` (structure) +`--checkpoint-config` (structure) @@ -220 +237 @@ JSON Syntax: -> The quantum processing unit (QPU) or simulator used to create an Amazon Braket job. +> Information about the output locations for hybrid job checkpoint data. @@ -222 +239,5 @@ JSON Syntax: -> device -> (string) +> localPath -> (string) +> +>> (Optional) The local directory where checkpoint data is stored. The default directory is `/opt/braket/checkpoints/` . +> +> s3Uri -> (string) @@ -224 +245 @@ JSON Syntax: ->> The primary quantum processing unit (QPU) or simulator used to create and run an Amazon Braket job. +>> Identifies the S3 path where you want Amazon Braket to store checkpoint data. For example, `s3://bucket-name/key-name-prefix` . @@ -229 +250 @@ Shorthand Syntax: - device=string + localPath=string,s3Uri=string @@ -236 +257,2 @@ JSON Syntax: - "device": "string" + "localPath": "string", + "s3Uri": "string" @@ -240,15 +262 @@ JSON Syntax: -`--hyper-parameters` (map) - -> Algorithm-specific parameters used by an Amazon Braket job that influence the quality of the training job. The values are set with a string of JSON key:value pairs, where the key is the name of the hyperparameter and the value is the value of th hyperparameter. -> -> key -> (string) -> -> value -> (string) - -Shorthand Syntax: - - - KeyName1=string,KeyName2=string - - -JSON Syntax: +`--job-name` (string) @@ -255,0 +264 @@ JSON Syntax: