AWS cli documentation change
Summary
Updated documentation for 'get-job' command to reflect hybrid job terminology, reorganized parameter descriptions, and clarified encryption/security configurations.
Security assessment
The change adds explicit documentation about AWS KMS encryption for hybrid job artifacts ('kmsKeyId' field) and IAM role permissions ('roleArn'), which are security features. However, there is no evidence of addressing a specific security vulnerability.
Diff
diff --git a/cli/latest/reference/braket/get-job.md b/cli/latest/reference/braket/get-job.md index ecd4ec6ab..65ef5c56a 100644 --- a//cli/latest/reference/braket/get-job.md +++ b//cli/latest/reference/braket/get-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 -Retrieves the specified Amazon Braket job. +Retrieves the specified Amazon Braket hybrid job. @@ -67 +66,0 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/braket - [--additional-attribute-names <value>] @@ -68,0 +68 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/braket + [--additional-attribute-names <value>] @@ -92,0 +93,4 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/braket +`--job-arn` (string) + +> The ARN of the hybrid job to retrieve. + @@ -95 +99 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/braket -> A list of attributes to return information for. +> A list of attributes to return additional information for. Only the QueueInfo additional attribute name is currently supported. @@ -108,4 +111,0 @@ Syntax: -`--job-arn` (string) - -> The ARN of the job to retrieve. - @@ -211,61 +211 @@ Disable automatically prompt for CLI input parameters. -algorithmSpecification -> (structure) - -> Definition of the Amazon Braket job created. Specifies the container image the job uses, information about the Python scripts used for entry and training, and the user-defined metrics used to evaluation the job. -> -> containerImage -> (structure) -> ->> The container image used to create an Amazon Braket job. ->> ->> uri -> (string) ->> ->>> The URI locating the container image. -> -> scriptModeConfig -> (structure) -> ->> Configures the paths to the Python scripts used for entry and training. ->> ->> compressionType -> (string) ->> ->>> The type of compression used by the Python scripts for an Amazon Braket job. ->> ->> entryPoint -> (string) ->> ->>> The path to the Python script that serves as the entry point for an Amazon Braket job. ->> ->> s3Uri -> (string) ->> ->>> The URI that specifies the S3 path to the Python script module that contains the training script used by an Amazon Braket job. - -associations -> (list) - -> The list of Amazon Braket resources associated with the hybrid job. -> -> (structure) -> ->> The Amazon Braket resource and the association type. ->> ->> arn -> (string) ->> ->>> The Amazon Braket resource arn. ->> ->> type -> (string) ->> ->>> The association type for the specified Amazon Braket resource arn. - -billableDuration -> (integer) - -> The billable time the Amazon Braket job used to complete. - -checkpointConfig -> (structure) - -> Information about the output locations for job checkpoint data. -> -> localPath -> (string) -> ->> (Optional) The local directory where checkpoints are written. The default directory is `/opt/braket/checkpoints/` . -> -> s3Uri -> (string) -> ->> Identifies the S3 path where you want Amazon Braket to store checkpoints. For example, `s3://bucket-name/key-name-prefix` . - -createdAt -> (timestamp) +status -> (string) @@ -273 +213 @@ createdAt -> (timestamp) -> The date and time that the Amazon Braket job was created. +> The status of the Amazon Braket hybrid job. @@ -275 +215 @@ createdAt -> (timestamp) -deviceConfig -> (structure) +jobArn -> (string) @@ -277,5 +217 @@ deviceConfig -> (structure) -> The quantum processing unit (QPU) or simulator used to run the Amazon Braket job. -> -> device -> (string) -> ->> The primary quantum processing unit (QPU) or simulator used to create and run an Amazon Braket job. +> The ARN of the Amazon Braket hybrid job. @@ -283 +219 @@ deviceConfig -> (structure) -endedAt -> (timestamp) +roleArn -> (string) @@ -285 +221 @@ endedAt -> (timestamp) -> The date and time that the Amazon Braket job ended. +> The Amazon Resource Name (ARN) of an IAM role that Amazon Braket can assume to perform tasks on behalf of a user. It can access user resources, run an Amazon Braket job container on behalf of user, and output results and other hybrid job details to the s3 buckets of a user. @@ -287 +223 @@ endedAt -> (timestamp) -events -> (list) +failureReason -> (string) @@ -289,17 +225 @@ events -> (list) -> Details about the type and time events occurred related to the Amazon Braket job. -> -> (structure) -> ->> Details about the type and time events occurred related to the Amazon Braket job. ->> ->> eventType -> (string) ->> ->>> The type of event that occurred related to the Amazon Braket job. ->> ->> message -> (string) ->> ->>> A message describing the event that occurred related to the Amazon Braket job. ->> ->> timeOfEvent -> (timestamp) ->> ->>> The type of event that occurred related to the Amazon Braket job. +> A description of the reason why an Amazon Braket hybrid job failed, if it failed. @@ -307 +227 @@ events -> (list) -failureReason -> (string) +jobName -> (string) @@ -309 +229 @@ failureReason -> (string) -> A description of the reason why an Amazon Braket job failed, if it failed. +> The name of the Amazon Braket hybrid job. @@ -313 +233 @@ hyperParameters -> (map) -> Algorithm-specific parameters used by an Amazon Braket job that influence the quality of the traiing 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. +> Algorithm-specific parameters used by an Amazon Braket hybrid job that influence the quality of the traiing job. The values are set with a map of JSON key:value pairs, where the key is the name of the hyperparameter and the value is the value of th hyperparameter. @@ -329 +249 @@ inputDataConfig -> (list) ->>> A named input source that an Amazon Braket job can consume. +>>> A named input source that an Amazon Braket hybrid job can consume. @@ -337 +257 @@ inputDataConfig -> (list) ->>> The location of the channel data. +>>> The location of the input data. @@ -341 +261 @@ inputDataConfig -> (list) ->>>> Information about the data stored in Amazon S3 used by the Amazon Braket job. +>>>> Amazon S3 path of the input data used by the hybrid job. @@ -347 +267 @@ inputDataConfig -> (list) -instanceConfig -> (structure) +outputDataConfig -> (structure) @@ -349,5 +269 @@ instanceConfig -> (structure) -> The resource instances to use while running the hybrid job on Amazon Braket. -> -> instanceCount -> (integer) -> ->> Configures the number of resource instances to use while running an Amazon Braket job on Amazon Braket. The default value is 1. +> The path to the S3 location where hybrid job artifacts are stored and the encryption key used to store them there. @@ -355 +271 @@ instanceConfig -> (structure) -> instanceType -> (string) +> kmsKeyId -> (string) @@ -357 +273 @@ instanceConfig -> (structure) ->> Configures the type resource instances to use while running an Amazon Braket hybrid job. +>> 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. @@ -359 +275 @@ instanceConfig -> (structure) -> volumeSizeInGb -> (integer) +> s3Path -> (string) @@ -361 +277 @@ instanceConfig -> (structure) ->> The size of the storage volume, in GB, that user wants to provision. +>> Identifies the S3 path where you want Amazon Braket to store the hybrid job training artifacts. For example, `s3://bucket-name/key-name-prefix` . @@ -363 +279 @@ instanceConfig -> (structure) -jobArn -> (string) +stoppingCondition -> (structure) @@ -365 +281,5 @@ jobArn -> (string) -> The ARN of the Amazon Braket job. +> The user-defined criteria that specifies when to stop a running hybrid job. +> +> maxRuntimeInSeconds -> (integer) +> +>> The maximum length of time, in seconds, that an Amazon Braket hybrid job can run. @@ -367 +287 @@ jobArn -> (string) -jobName -> (string) +checkpointConfig -> (structure) @@ -369 +289,9 @@ jobName -> (string) -> The name of the Amazon Braket job. +> Information about the output locations for hybrid job checkpoint data. +> +> localPath -> (string) +> +>> (Optional) The local directory where checkpoint data is stored. The default directory is `/opt/braket/checkpoints/` . +> +> s3Uri -> (string) +> +>> Identifies the S3 path where you want Amazon Braket to store checkpoint data. For example, `s3://bucket-name/key-name-prefix` . @@ -371 +299 @@ jobName -> (string) -outputDataConfig -> (structure) +algorithmSpecification -> (structure) @@ -373 +301 @@ outputDataConfig -> (structure) -> The path to the S3 location where job artifacts are stored and the encryption key used to store them there.