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 CreateProcessingJob API operation.

Syntax

New-SMProcessingJob
-ProcessingJobName <String>
-AppSpecification_ContainerArgument <String[]>
-AppSpecification_ContainerEntrypoint <String[]>
-NetworkConfig_EnableInterContainerTrafficEncryption <Boolean>
-NetworkConfig_EnableNetworkIsolation <Boolean>
-Environment <Hashtable>
-ExperimentConfig_ExperimentName <String>
-AppSpecification_ImageUri <String>
-ClusterConfig_InstanceCount <Int32>
-ClusterConfig_InstanceType <ProcessingInstanceType>
-ProcessingOutputConfig_KmsKeyId <String>
-StoppingCondition_MaxRuntimeInSecond <Int32>
-ProcessingOutputConfig_Output <ProcessingOutput[]>
-ProcessingInput <ProcessingInput[]>
-RoleArn <String>
-VpcConfig_SecurityGroupId <String[]>
-VpcConfig_Subnet <String[]>
-Tag <Tag[]>
-ExperimentConfig_TrialComponentDisplayName <String>
-ExperimentConfig_TrialName <String>
-ClusterConfig_VolumeKmsKeyId <String>
-ClusterConfig_VolumeSizeInGB <Int32>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>

Description

Creates a processing job.

Parameters

-AppSpecification_ContainerArgument <String[]>
The arguments for a container used to run a processing job.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAppSpecification_ContainerArguments
-AppSpecification_ContainerEntrypoint <String[]>
The entrypoint for a container used to run a processing job.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AppSpecification_ImageUri <String>
The container image to be run by the processing job.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClusterConfig_InstanceCount <Int32>
The number of ML compute instances to use in the processing 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)
AliasesProcessingResources_ClusterConfig_InstanceCount
-ClusterConfig_InstanceType <ProcessingInstanceType>
The ML compute instance type for the processing job.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesProcessingResources_ClusterConfig_InstanceType
-ClusterConfig_VolumeKmsKeyId <String>
The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the processing job. Certain Nitro-based instances include local storage, dependent on the instance type. Local storage volumes are encrypted using a hardware module on the instance. You can't request a VolumeKmsKeyId when using an instance type with local storage.For a list of instance types that support local instance storage, see Instance Store Volumes.For more information about local instance storage encryption, see SSD Instance Store Volumes.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesProcessingResources_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.Certain Nitro-based instances include local storage with a fixed total size, dependent on the instance type. When using these instances for processing, Amazon SageMaker mounts the local instance storage instead of Amazon EBS gp2 storage. You can't request a VolumeSizeInGB greater than the total size of the local instance storage.For a list of instance types that support local instance storage, including the total size per instance type, see Instance Store Volumes.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesProcessingResources_ClusterConfig_VolumeSizeInGB
-Environment <Hashtable>
The environment variables to set in the Docker container. Up to 100 key and values entries in the map are supported.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ExperimentConfig_ExperimentName <String>
The name of an existing experiment to associate the trial component with.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ExperimentConfig_TrialComponentDisplayName <String>
The display name for the trial component. If this key isn't specified, the display name is the trial component name.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ExperimentConfig_TrialName <String>
The name of an existing trial to associate the trial component with. If not specified, a new trial is created.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
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)
-NetworkConfig_EnableInterContainerTrafficEncryption <Boolean>
Whether to encrypt all communications between distributed processing jobs. Choose True to encrypt communications. Encryption provides greater security for distributed processing 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 processing job.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the ProcessingJobName parameter. The -PassThru parameter is deprecated, use -Select '^ProcessingJobName' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ProcessingInput <ProcessingInput[]>
An array of inputs configuring the data to download into the processing container.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesProcessingInputs
-ProcessingJobName <String>
The name of the processing job. 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)
-ProcessingOutputConfig_KmsKeyId <String>
The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt the processing job output. KmsKeyId can be an ID of a KMS key, ARN of a KMS key, alias of a KMS key, or alias of a KMS key. The KmsKeyId is applied to all outputs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ProcessingOutputConfig_Output <ProcessingOutput[]>
An array of outputs configuring the data to upload from the processing container.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesProcessingOutputConfig_Outputs
-RoleArn <String>
The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker 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 'ProcessingJobArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.CreateProcessingJobResponse). Specifying the name of a property of type Amazon.SageMaker.Model.CreateProcessingJobResponse 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>
Specifies the maximum runtime in 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.
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.
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.
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

This cmdlet returns a System.String object. The service call response (type Amazon.SageMaker.Model.CreateProcessingJobResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.

Supported Version

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