AWS cli documentation change
Summary
Added documentation for 'Job' structure in search results including job metadata, status fields, and tagging information
Security assessment
The changes document standard job metadata fields and status tracking. While RoleArn and tags are mentioned, this is routine feature documentation without security-specific context. No vulnerabilities or security incidents are referenced.
Diff
diff --git a/cli/latest/reference/sagemaker/search.md b/cli/latest/reference/sagemaker/search.md index ab459e189..00e232c30 100644 --- a//cli/latest/reference/sagemaker/search.md +++ b//cli/latest/reference/sagemaker/search.md @@ -15 +15 @@ - * [AWS CLI 2.34.61 Command Reference](../../index.html) » + * [AWS CLI 2.34.63 Command Reference](../../index.html) » @@ -132,0 +133 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/sagema +> * `Job` @@ -25603,0 +25605,231 @@ Results -> (list) +>> +>> Job -> (structure) +>> +>>> Search shape for Job. Mirrors DescribeJobResponse fields. If you update DescribeJobResponse, update this structure as well. +>>> +>>> JobName -> (string) +>>> +>>>> The name of the job. +>>>> +>>>> Constraints: +>>>> +>>>> * min: `1` +>>>> * max: `63` +>>>> * pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` +>>>> + +>>> +>>> JobArn -> (string) +>>> +>>>> The Amazon Resource Name (ARN) of the job. +>>>> +>>>> Constraints: +>>>> +>>>> * min: `0` +>>>> * max: `256` +>>>> * pattern: `arn:(aws[a-z\-]*):sagemaker:[a-z0-9\-]+:[0-9]{12}:job/[a-zA-Z0-9]+/[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` +>>>> + +>>> +>>> RoleArn -> (string) +>>> +>>>> The ARN of the IAM role associated with the job. +>>>> +>>>> Constraints: +>>>> +>>>> * min: `20` +>>>> * max: `2048` +>>>> * pattern: `arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+` +>>>> + +>>> +>>> JobCategory -> (string) +>>> +>>>> The category of the job. +>>>> +>>>> Possible values: +>>>> +>>>> * `AgentRFT` +>>>> * `AgentRFTEvaluation` +>>>> + +>>> +>>> JobConfigSchemaVersion -> (string) +>>> +>>>> The schema version used for the job configuration document. +>>>> +>>>> Constraints: +>>>> +>>>> * min: `5` +>>>> * max: `16` +>>>> * pattern: `\d+\.\d+\.\d+` +>>>> + +>>> +>>> JobConfigDocument -> (string) +>>> +>>>> The JSON configuration document for the job. +>>>> +>>>> Constraints: +>>>> +>>>> * min: `1` +>>>> * max: `262144` +>>>> + +>>> +>>> CreationTime -> (timestamp) +>>> +>>>> The date and time that the job was created. +>>> +>>> LastModifiedTime -> (timestamp) +>>> +>>>> The date and time that the job was last modified. +>>> +>>> EndTime -> (timestamp) +>>> +>>>> The date and time that the job ended. +>>> +>>> JobStatus -> (string) +>>> +>>>> The current status of the job. +>>>> +>>>> Possible values: +>>>> +>>>> * `InProgress` +>>>> * `Completed` +>>>> * `Failed` +>>>> * `Stopping` +>>>> * `Stopped` +>>>> * `Deleting` +>>>> * `DeleteFailed` +>>>> + +>>> +>>> SecondaryStatus -> (string) +>>> +>>>> The detailed secondary status of the job, providing more granular information about the job’s progress. +>>>> +>>>> Possible values: +>>>> +>>>> * `Starting` +>>>> * `Downloading` +>>>> * `Training` +>>>> * `Uploading` +>>>> * `Stopping` +>>>> * `Stopped` +>>>> * `MaxRuntimeExceeded` +>>>> * `Interrupted` +>>>> * `Failed` +>>>> * `Completed` +>>>> * `Restarting` +>>>> * `Pending` +>>>> * `Evaluating` +>>>> * `Deleting` +>>>> * `DeleteFailed` +>>>> + +>>> +>>> SecondaryStatusTransitions -> (list) +>>> +>>>> A list of secondary status transitions for the job, with timestamps and optional status messages. +>>>> +>>>> Constraints: +>>>> +>>>> * min: `0` +>>>> * max: `100` +>>>> + +>>>> +>>>> (structure) +>>>> +>>>>> Represents a secondary status transition for a job. Jobs progress through multiple secondary statuses during execution. Each transition records the status, start time, optional end time, and an optional message with additional details. +>>>>> +>>>>> Status -> (string) [required] +>>>>> +>>>>>> The secondary status of the job at this transition point. +>>>>>> +>>>>>> Possible values: +>>>>>> +>>>>>> * `Starting` +>>>>>> * `Downloading` +>>>>>> * `Training` +>>>>>> * `Uploading` +>>>>>> * `Stopping` +>>>>>> * `Stopped` +>>>>>> * `MaxRuntimeExceeded` +>>>>>> * `Interrupted` +>>>>>> * `Failed` +>>>>>> * `Completed` +>>>>>> * `Restarting` +>>>>>> * `Pending` +>>>>>> * `Evaluating` +>>>>>> * `Deleting` +>>>>>> * `DeleteFailed` +>>>>>> + +>>>>> +>>>>> StartTime -> (timestamp) [required] +>>>>> +>>>>>> The date and time that the status transition started. +>>>>> +>>>>> EndTime -> (timestamp) +>>>>> +>>>>>> The date and time that the status transition ended. +>>>>> +>>>>> StatusMessage -> (string) +>>>>> +>>>>>> A detailed message about the status transition. +>>> +>>> FailureReason -> (string) +>>> +>>>> If the job failed, the reason it failed. +>>>> +>>>> Constraints: +>>>> +>>>> * min: `0` +>>>> * max: `1024` +>>>> + +>>> +>>> Tags -> (list)