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 NeptuneData StartMLDataProcessingJob API operation.

Syntax

Start-NEPTMLDataProcessingJob
-Id <String>
-ConfigFileName <String>
-InputDataS3Location <String>
-ModelType <String>
-NeptuneIamRoleArn <String>
-PreviousDataProcessingJobId <String>
-ProcessedDataS3Location <String>
-ProcessingInstanceType <String>
-ProcessingInstanceVolumeSizeInGB <Int32>
-ProcessingTimeOutInSecond <Int32>
-S3OutputEncryptionKMSKey <String>
-SagemakerIamRoleArn <String>
-SecurityGroupId <String[]>
-Subnet <String[]>
-VolumeEncryptionKMSKey <String>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonNeptunedataConfig>

Description

Creates a new Neptune ML data processing job for processing the graph data exported from Neptune for training. See The dataprocessing command. When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:StartMLModelDataProcessingJob IAM action in that cluster.

Parameters

-ClientConfig <AmazonNeptunedataConfig>
Amazon.PowerShell.Cmdlets.NEPT.AmazonNeptunedataClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConfigFileName <String>
A data specification file that describes how to load the exported graph data for training. The file is automatically generated by the Neptune export toolkit. The default is training-data-configuration.json.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-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)
-Id <String>
A unique identifier for the new job. The default is an autogenerated UUID.
Required?False
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-InputDataS3Location <String>
The URI of the Amazon S3 location where you want SageMaker to download the data needed to run the data processing job.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-ModelType <String>
One of the two model types that Neptune ML currently supports: heterogeneous graph models (heterogeneous), and knowledge graph (kge). The default is none. If not specified, Neptune ML chooses the model type automatically based on the data.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NeptuneIamRoleArn <String>
The Amazon Resource Name (ARN) of an IAM role that SageMaker can assume to perform tasks on your behalf. This must be listed in your DB cluster parameter group or an error will occur.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the Id parameter. The -PassThru parameter is deprecated, use -Select '^Id' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PreviousDataProcessingJobId <String>
The job ID of a completed data processing job run on an earlier version of the data.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ProcessedDataS3Location <String>
The URI of the Amazon S3 location where you want SageMaker to save the results of a data processing job.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-ProcessingInstanceType <String>
The type of ML instance used during data processing. Its memory should be large enough to hold the processed dataset. The default is the smallest ml.r5 type whose memory is ten times larger than the size of the exported graph data on disk.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ProcessingInstanceVolumeSizeInGB <Int32>
The disk volume size of the processing instance. Both input data and processed data are stored on disk, so the volume size must be large enough to hold both data sets. The default is 0. If not specified or 0, Neptune ML chooses the volume size automatically based on the data size.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ProcessingTimeOutInSecond <Int32>
Timeout in seconds for the data processing job. The default is 86,400 (1 day).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesProcessingTimeOutInSeconds
-S3OutputEncryptionKMSKey <String>
The Amazon Key Management Service (Amazon KMS) key that SageMaker uses to encrypt the output of the processing job. The default is none.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SagemakerIamRoleArn <String>
The ARN of an IAM role for SageMaker execution. This must be listed in your DB cluster parameter group or an error will occur.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SecurityGroupId <String[]>
The VPC security group IDs. The default is None.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSecurityGroupIds
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Neptunedata.Model.StartMLDataProcessingJobResponse). Specifying the name of a property of type Amazon.Neptunedata.Model.StartMLDataProcessingJobResponse 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)
-Subnet <String[]>
The IDs of the subnets in the Neptune VPC. The default is None.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSubnets
-VolumeEncryptionKMSKey <String>
The Amazon Key Management Service (Amazon KMS) key that SageMaker uses to encrypt data on the storage volume attached to the ML compute instances that run the training job. The default is None.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)

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

Amazon.Neptunedata.Model.StartMLDataProcessingJobResponse
This cmdlet returns an Amazon.Neptunedata.Model.StartMLDataProcessingJobResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
AWS Tools for PowerShell User Guide

Supported Version

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