DescribeModelBiasJobDefinition
Returns a description of a model bias job definition.
Request Syntax
{ "JobDefinitionName": "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.
- JobDefinitionName
-
The name of the model bias job definition. 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
{ "CreationTime": number, "JobDefinitionArn": "string", "JobDefinitionName": "string", "JobResources": { "ClusterConfig": { "InstanceCount": number, "InstanceType": "string", "VolumeKmsKeyId": "string", "VolumeSizeInGB": number } }, "ModelBiasAppSpecification": { "ConfigUri": "string", "Environment": { "string" : "string" }, "ImageUri": "string" }, "ModelBiasBaselineConfig": { "BaseliningJobName": "string", "ConstraintsResource": { "S3Uri": "string" } }, "ModelBiasJobInput": { "BatchTransformInput": { "DataCapturedDestinationS3Uri": "string", "DatasetFormat": { "Csv": { "Header": boolean }, "Json": { "Line": boolean }, "Parquet": { } }, "EndTimeOffset": "string", "ExcludeFeaturesAttribute": "string", "FeaturesAttribute": "string", "InferenceAttribute": "string", "LocalPath": "string", "ProbabilityAttribute": "string", "ProbabilityThresholdAttribute": number, "S3DataDistributionType": "string", "S3InputMode": "string", "StartTimeOffset": "string" }, "EndpointInput": { "EndpointName": "string", "EndTimeOffset": "string", "ExcludeFeaturesAttribute": "string", "FeaturesAttribute": "string", "InferenceAttribute": "string", "LocalPath": "string", "ProbabilityAttribute": "string", "ProbabilityThresholdAttribute": number, "S3DataDistributionType": "string", "S3InputMode": "string", "StartTimeOffset": "string" }, "GroundTruthS3Input": { "S3Uri": "string" } }, "ModelBiasJobOutputConfig": { "KmsKeyId": "string", "MonitoringOutputs": [ { "S3Output": { "LocalPath": "string", "S3UploadMode": "string", "S3Uri": "string" } } ] }, "NetworkConfig": { "EnableInterContainerTrafficEncryption": boolean, "EnableNetworkIsolation": boolean, "VpcConfig": { "SecurityGroupIds": [ "string" ], "Subnets": [ "string" ] } }, "RoleArn": "string", "StoppingCondition": { "MaxRuntimeInSeconds": number } }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.
- CreationTime
-
The time at which the model bias job was created.
Type: Timestamp
- JobDefinitionArn
-
The Amazon Resource Name (ARN) of the model bias job.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 256.
Pattern:
.* - JobDefinitionName
-
The name of the bias job definition. 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} - JobResources
-
Identifies the resources to deploy for a monitoring job.
Type: MonitoringResources object
- ModelBiasAppSpecification
-
Configures the model bias job to run a specified Docker container image.
Type: ModelBiasAppSpecification object
- ModelBiasBaselineConfig
-
The baseline configuration for a model bias job.
Type: ModelBiasBaselineConfig object
- ModelBiasJobInput
-
Inputs for the model bias job.
Type: ModelBiasJobInput object
- ModelBiasJobOutputConfig
-
The output configuration for monitoring jobs.
Type: MonitoringOutputConfig object
- NetworkConfig
-
Networking options for a model bias job.
Type: MonitoringNetworkConfig object
- RoleArn
-
The Amazon Resource Name (ARN) of the IAM role that has read permission to the input data location and write permission to the output data location in Amazon S3.
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
-
A time limit for how long the monitoring job is allowed to run before stopping.
Type: MonitoringStoppingCondition object
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: