AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Amazon SageMaker Service CreateModelExplainabilityJobDefinition API operation.

Syntax

New-SMModelExplainabilityJobDefinition
-JobDefinitionName <String>
-ModelExplainabilityBaselineConfig_BaseliningJobName <String>
-ModelExplainabilityAppSpecification_ConfigUri <String>
-BatchTransformInput_DataCapturedDestinationS3Uri <String>
-NetworkConfig_EnableInterContainerTrafficEncryption <Boolean>
-NetworkConfig_EnableNetworkIsolation <Boolean>
-EndpointInput_EndpointName <String>
-BatchTransformInput_EndTimeOffset <String>
-EndpointInput_EndTimeOffset <String>
-ModelExplainabilityAppSpecification_Environment <Hashtable>
-BatchTransformInput_ExcludeFeaturesAttribute <String>
-EndpointInput_ExcludeFeaturesAttribute <String>
-BatchTransformInput_FeaturesAttribute <String>
-EndpointInput_FeaturesAttribute <String>
-Csv_Header <Boolean>
-ModelExplainabilityAppSpecification_ImageUri <String>
-BatchTransformInput_InferenceAttribute <String>
-EndpointInput_InferenceAttribute <String>
-ClusterConfig_InstanceCount <Int32>
-ClusterConfig_InstanceType <ProcessingInstanceType>
-ModelExplainabilityJobOutputConfig_KmsKeyId <String>
-Json_Line <Boolean>
-BatchTransformInput_LocalPath <String>
-EndpointInput_LocalPath <String>
-StoppingCondition_MaxRuntimeInSecond <Int32>
-ModelExplainabilityJobOutputConfig_MonitoringOutput <MonitoringOutput[]>
-DatasetFormat_Parquet <MonitoringParquetDatasetFormat>
-BatchTransformInput_ProbabilityAttribute <String>
-EndpointInput_ProbabilityAttribute <String>
-BatchTransformInput_ProbabilityThresholdAttribute <Double>
-EndpointInput_ProbabilityThresholdAttribute <Double>
-RoleArn <String>
-BatchTransformInput_S3DataDistributionType <ProcessingS3DataDistributionType>
-EndpointInput_S3DataDistributionType <ProcessingS3DataDistributionType>
-BatchTransformInput_S3InputMode <ProcessingS3InputMode>
-EndpointInput_S3InputMode <ProcessingS3InputMode>
-ConstraintsResource_S3Uri <String>
-VpcConfig_SecurityGroupId <String[]>
-BatchTransformInput_StartTimeOffset <String>
-EndpointInput_StartTimeOffset <String>
-VpcConfig_Subnet <String[]>
-Tag <Tag[]>
-ClusterConfig_VolumeKmsKeyId <String>
-ClusterConfig_VolumeSizeInGB <Int32>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonSageMakerConfig>

Description

Creates the definition for a model explainability job.

Parameters

-BatchTransformInput_DataCapturedDestinationS3Uri <String>
The Amazon S3 location being used to capture the data.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesModelExplainabilityJobInput_BatchTransformInput_DataCapturedDestinationS3Uri
-BatchTransformInput_EndTimeOffset <String>
If specified, monitoring jobs subtract this time from the end time. For information about using offsets for scheduling monitoring jobs, see Schedule Model Quality Monitoring Jobs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesModelExplainabilityJobInput_BatchTransformInput_EndTimeOffset
-BatchTransformInput_ExcludeFeaturesAttribute <String>
The attributes of the input data to exclude from the analysis.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesModelExplainabilityJobInput_BatchTransformInput_ExcludeFeaturesAttribute
-BatchTransformInput_FeaturesAttribute <String>
The attributes of the input data that are the input features.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesModelExplainabilityJobInput_BatchTransformInput_FeaturesAttribute
-BatchTransformInput_InferenceAttribute <String>
The attribute of the input data that represents the ground truth label.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesModelExplainabilityJobInput_BatchTransformInput_InferenceAttribute
-BatchTransformInput_LocalPath <String>
Path to the filesystem where the batch transform data is available to the container.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesModelExplainabilityJobInput_BatchTransformInput_LocalPath
-BatchTransformInput_ProbabilityAttribute <String>
In a classification problem, the attribute that represents the class probability.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesModelExplainabilityJobInput_BatchTransformInput_ProbabilityAttribute
-BatchTransformInput_ProbabilityThresholdAttribute <Double>
The threshold for the class probability to be evaluated as a positive result.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesModelExplainabilityJobInput_BatchTransformInput_ProbabilityThresholdAttribute
-BatchTransformInput_S3DataDistributionType <ProcessingS3DataDistributionType>
Whether input data distributed in Amazon S3 is fully replicated or sharded by an S3 key. Defaults to FullyReplicated
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesModelExplainabilityJobInput_BatchTransformInput_S3DataDistributionType
-BatchTransformInput_S3InputMode <ProcessingS3InputMode>
Whether the Pipe or File is used as the input mode for transferring data for the monitoring job. Pipe mode is recommended for large datasets. File mode is useful for small files that fit in memory. Defaults to File.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesModelExplainabilityJobInput_BatchTransformInput_S3InputMode
-BatchTransformInput_StartTimeOffset <String>
If specified, monitoring jobs substract this time from the start time. For information about using offsets for scheduling monitoring jobs, see Schedule Model Quality Monitoring Jobs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesModelExplainabilityJobInput_BatchTransformInput_StartTimeOffset
-ClientConfig <AmazonSageMakerConfig>
Amazon.PowerShell.Cmdlets.SM.AmazonSageMakerClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClusterConfig_InstanceCount <Int32>
The number of ML compute instances to use in the model monitoring job. For distributed processing jobs, specify a value greater than 1. The default value is 1.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesJobResources_ClusterConfig_InstanceCount
-ClusterConfig_InstanceType <ProcessingInstanceType>
The ML compute instance type for the processing job.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesJobResources_ClusterConfig_InstanceType
-ClusterConfig_VolumeKmsKeyId <String>
The Key Management Service (KMS) key that Amazon SageMaker AI uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the model monitoring job.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesJobResources_ClusterConfig_VolumeKmsKeyId
-ClusterConfig_VolumeSizeInGB <Int32>
The size of the ML storage volume, in gigabytes, that you want to provision. You must specify sufficient ML storage for your scenario.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesJobResources_ClusterConfig_VolumeSizeInGB
-ConstraintsResource_S3Uri <String>
The Amazon S3 URI for the constraints resource.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesModelExplainabilityBaselineConfig_ConstraintsResource_S3Uri
-Csv_Header <Boolean>
Indicates if the CSV data has a header.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesModelExplainabilityJobInput_BatchTransformInput_DatasetFormat_Csv_Header
-DatasetFormat_Parquet <MonitoringParquetDatasetFormat>
The Parquet dataset used in the monitoring job
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesModelExplainabilityJobInput_BatchTransformInput_DatasetFormat_Parquet
-EndpointInput_EndpointName <String>
An endpoint in customer's account which has enabled DataCaptureConfig enabled.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesModelExplainabilityJobInput_EndpointInput_EndpointName
-EndpointInput_EndTimeOffset <String>
If specified, monitoring jobs substract this time from the end time. For information about using offsets for scheduling monitoring jobs, see Schedule Model Quality Monitoring Jobs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesModelExplainabilityJobInput_EndpointInput_EndTimeOffset
-EndpointInput_ExcludeFeaturesAttribute <String>
The attributes of the input data to exclude from the analysis.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesModelExplainabilityJobInput_EndpointInput_ExcludeFeaturesAttribute
-EndpointInput_FeaturesAttribute <String>
The attributes of the input data that are the input features.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesModelExplainabilityJobInput_EndpointInput_FeaturesAttribute
-EndpointInput_InferenceAttribute <String>
The attribute of the input data that represents the ground truth label.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesModelExplainabilityJobInput_EndpointInput_InferenceAttribute
-EndpointInput_LocalPath <String>
Path to the filesystem where the endpoint data is available to the container.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesModelExplainabilityJobInput_EndpointInput_LocalPath
-EndpointInput_ProbabilityAttribute <String>
In a classification problem, the attribute that represents the class probability.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesModelExplainabilityJobInput_EndpointInput_ProbabilityAttribute
-EndpointInput_ProbabilityThresholdAttribute <Double>
The threshold for the class probability to be evaluated as a positive result.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesModelExplainabilityJobInput_EndpointInput_ProbabilityThresholdAttribute
-EndpointInput_S3DataDistributionType <ProcessingS3DataDistributionType>
Whether input data distributed in Amazon S3 is fully replicated or sharded by an Amazon S3 key. Defaults to FullyReplicated
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesModelExplainabilityJobInput_EndpointInput_S3DataDistributionType
-EndpointInput_S3InputMode <ProcessingS3InputMode>
Whether the Pipe or File is used as the input mode for transferring data for the monitoring job. Pipe mode is recommended for large datasets. File mode is useful for small files that fit in memory. Defaults to File.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesModelExplainabilityJobInput_EndpointInput_S3InputMode
-EndpointInput_StartTimeOffset <String>
If specified, monitoring jobs substract this time from the start time. For information about using offsets for scheduling monitoring jobs, see Schedule Model Quality Monitoring Jobs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesModelExplainabilityJobInput_EndpointInput_StartTimeOffset
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-JobDefinitionName <String>
The name of the model explainability job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-Json_Line <Boolean>
Indicates if the file should be read as a JSON object per line.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesModelExplainabilityJobInput_BatchTransformInput_DatasetFormat_Json_Line
-ModelExplainabilityAppSpecification_ConfigUri <String>
JSON formatted Amazon S3 file that defines explainability parameters. For more information on this JSON configuration file, see Configure model explainability parameters.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-ModelExplainabilityAppSpecification_Environment <Hashtable>
Sets the environment variables in the Docker container. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ModelExplainabilityAppSpecification_ImageUri <String>
The container image to be run by the model explainability job.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-ModelExplainabilityBaselineConfig_BaseliningJobName <String>
The name of the baseline model explainability job.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ModelExplainabilityJobOutputConfig_KmsKeyId <String>
The Key Management Service (KMS) key that Amazon SageMaker AI uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ModelExplainabilityJobOutputConfig_MonitoringOutput <MonitoringOutput[]>
Monitoring outputs for monitoring jobs. This is where the output of the periodic monitoring jobs is uploaded. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesModelExplainabilityJobOutputConfig_MonitoringOutputs
-NetworkConfig_EnableInterContainerTrafficEncryption <Boolean>
Whether to encrypt all communications between the instances used for the monitoring jobs. Choose True to encrypt communications. Encryption provides greater security for distributed jobs, but the processing might take longer.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkConfig_EnableNetworkIsolation <Boolean>
Whether to allow inbound and outbound network calls to and from the containers used for the monitoring job.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RoleArn <String>
The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI can assume to perform tasks on your behalf.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'JobDefinitionArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.CreateModelExplainabilityJobDefinitionResponse). Specifying the name of a property of type Amazon.SageMaker.Model.CreateModelExplainabilityJobDefinitionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-StoppingCondition_MaxRuntimeInSecond <Int32>
The maximum runtime allowed in seconds.The MaxRuntimeInSeconds cannot exceed the frequency of the job. For data quality and model explainability, this can be up to 3600 seconds for an hourly schedule. For model bias and model quality hourly schedules, this can be up to 1800 seconds.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoppingCondition_MaxRuntimeInSeconds
-Tag <Tag[]>
(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags
-VpcConfig_SecurityGroupId <String[]>
The VPC security group IDs, in the form sg-xxxxxxxx. Specify the security groups for the VPC that is specified in the Subnets field. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesNetworkConfig_VpcConfig_SecurityGroupIds
-VpcConfig_Subnet <String[]>
The ID of the subnets in the VPC to which you want to connect your training job or model. For information about the availability of specific instance types, see Supported Instance Types and Availability Zones. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesNetworkConfig_VpcConfig_Subnets

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

System.String or Amazon.SageMaker.Model.CreateModelExplainabilityJobDefinitionResponse
This cmdlet returns a System.String object. The service call response (type Amazon.SageMaker.Model.CreateModelExplainabilityJobDefinitionResponse) can be returned by specifying '-Select *'.
Developer Guide
Service API Reference
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z