DescribeProcessingJob
Returns a description of a processing job.
Request Syntax
{ "ProcessingJobName": "string" }Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- ProcessingJobName
-
The name of the processing job. The name must be unique within an AWS Region in the AWS account.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern:
[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}Required: Yes
Response Syntax
{ "AppSpecification": { "ContainerArguments": [ "string" ], "ContainerEntrypoint": [ "string" ], "ImageUri": "string" }, "AutoMLJobArn": "string", "CreationTime": number, "Environment": { "string" : "string" }, "ExitMessage": "string", "ExperimentConfig": { "ExperimentName": "string", "RunName": "string", "TrialComponentDisplayName": "string", "TrialName": "string" }, "FailureReason": "string", "LastModifiedTime": number, "MonitoringScheduleArn": "string", "NetworkConfig": { "EnableInterContainerTrafficEncryption": boolean, "EnableNetworkIsolation": boolean, "VpcConfig": { "SecurityGroupIds": [ "string" ], "Subnets": [ "string" ] } }, "ProcessingEndTime": number, "ProcessingInputs": [ { "AppManaged": boolean, "DatasetDefinition": { "AthenaDatasetDefinition": { "Catalog": "string", "Database": "string", "KmsKeyId": "string", "OutputCompression": "string", "OutputFormat": "string", "OutputS3Uri": "string", "QueryString": "string", "WorkGroup": "string" }, "DataDistributionType": "string", "InputMode": "string", "LocalPath": "string", "RedshiftDatasetDefinition": { "ClusterId": "string", "ClusterRoleArn": "string", "Database": "string", "DbUser": "string", "KmsKeyId": "string", "OutputCompression": "string", "OutputFormat": "string", "OutputS3Uri": "string", "QueryString": "string" } }, "InputName": "string", "S3Input": { "LocalPath": "string", "S3CompressionType": "string", "S3DataDistributionType": "string", "S3DataType": "string", "S3InputMode": "string", "S3Uri": "string" } } ], "ProcessingJobArn": "string", "ProcessingJobName": "string", "ProcessingJobStatus": "string", "ProcessingOutputConfig": { "KmsKeyId": "string", "Outputs": [ { "AppManaged": boolean, "FeatureStoreOutput": { "FeatureGroupName": "string" }, "OutputName": "string", "S3Output": { "LocalPath": "string", "S3UploadMode": "string", "S3Uri": "string" } } ] }, "ProcessingResources": { "ClusterConfig": { "InstanceCount": number, "InstanceType": "string", "VolumeKmsKeyId": "string", "VolumeSizeInGB": number } }, "ProcessingStartTime": number, "RoleArn": "string", "StoppingCondition": { "MaxRuntimeInSeconds": number }, "TrainingJobArn": "string" }Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- AppSpecification
-
Configures the processing job to run a specified container image.
Type: AppSpecification object
- AutoMLJobArn
-
The ARN of an AutoML job associated with this processing job.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:automl-job/.* - CreationTime
-
The time at which the processing job was created.
Type: Timestamp
- Environment
-
The environment variables set in the Docker container.
Type: String to string map
Map Entries: Minimum number of 0 items. Maximum number of 100 items.
Key Length Constraints: Minimum length of 0. Maximum length of 256.
Key Pattern:
[a-zA-Z_][a-zA-Z0-9_]*Value Length Constraints: Minimum length of 0. Maximum length of 256.
Value Pattern:
[\S\s]* - ExitMessage
-
An optional string, up to one KB in size, that contains metadata from the processing container when the processing job exits.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Pattern:
[\S\s]* - ExperimentConfig
-
The configuration information used to create an experiment.
Type: ExperimentConfig object
- FailureReason
-
A string, up to one KB in size, that contains the reason a processing job failed, if it failed.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
- LastModifiedTime
-
The time at which the processing job was last modified.
Type: Timestamp
- MonitoringScheduleArn
-
The ARN of a monitoring schedule for an endpoint associated with this processing job.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 256.
Pattern:
.* - NetworkConfig
-
Networking options for a processing job.
Type: NetworkConfig object
- ProcessingEndTime
-
The time at which the processing job completed.
Type: Timestamp
- ProcessingInputs
-
The inputs for a processing job.
Type: Array of ProcessingInput objects
Array Members: Minimum number of 0 items. Maximum number of 10 items.
- ProcessingJobArn
-
The Amazon Resource Name (ARN) of the processing job.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 256.
Pattern:
arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:processing-job/[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62} - ProcessingJobName
-
The name of the processing job. The name must be unique within an AWS Region in the AWS account.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern:
[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62} - ProcessingJobStatus
-
Provides the status of a processing job.
Type: String
Valid Values:
InProgress | Completed | Failed | Stopping | Stopped - ProcessingOutputConfig
-
Output configuration for the processing job.
Type: ProcessingOutputConfig object
- ProcessingResources
-
Identifies the resources, ML compute instances, and ML storage volumes to deploy for a processing job. In distributed training, you specify more than one instance.
Type: ProcessingResources object
- ProcessingStartTime
-
The time at which the processing job started.
Type: Timestamp
- RoleArn
-
The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern:
arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+ - StoppingCondition
-
The time limit for how long the processing job is allowed to run.
Type: ProcessingStoppingCondition object
- TrainingJobArn
-
The ARN of a training job associated with this processing job.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 256.
Pattern:
arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:training-job/[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}
Errors
For information about the errors that are common to all actions, see Common Errors.
- ResourceNotFound
-
Resource being access is not found.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: