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 Neptune Graph CreateGraphUsingImportTask API operation.

Syntax

New-NEPTGGraphUsingImportTask
-BlankNodeHandling <BlankNodeHandling>
-DeletionProtection <Boolean>
-VectorSearchConfiguration_Dimension <Int32>
-FailOnError <Boolean>
-Format <Format>
-GraphName <String>
-KmsKeyIdentifier <String>
-MaxProvisionedMemory <Int32>
-MinProvisionedMemory <Int32>
-ParquetType <ParquetType>
-Neptune_PreserveDefaultVertexLabel <Boolean>
-Neptune_PreserveEdgeId <Boolean>
-PublicConnectivity <Boolean>
-ReplicaCount <Int32>
-RoleArn <String>
-Neptune_S3ExportKmsKeyId <String>
-Neptune_S3ExportPath <String>
-Source <String>
-Tag <Hashtable>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonNeptuneGraphConfig>

Description

Creates a new Neptune Analytics graph and imports data into it, either from Amazon Simple Storage Service (S3) or from a Neptune database or a Neptune database snapshot. The data can be loaded from files in S3 that in either the Gremlin CSV format or the openCypher load format.

Parameters

-BlankNodeHandling <BlankNodeHandling>
The method to handle blank nodes in the dataset. Currently, only convertToIri is supported, meaning blank nodes are converted to unique IRIs at load time. Must be provided when format is ntriples. For more information, see Handling RDF values.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientConfig <AmazonNeptuneGraphConfig>
Amazon.PowerShell.Cmdlets.NEPTG.AmazonNeptuneGraphClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DeletionProtection <Boolean>
Indicates whether or not to enable deletion protection on the graph. The graph can’t be deleted when deletion protection is enabled. (true or false).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-FailOnError <Boolean>
If set to true, the task halts when an import error is encountered. If set to false, the task skips the data that caused the error and continues if possible.
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)
-Format <Format>
Specifies the format of S3 data to be imported. Valid values are CSV, which identifies the Gremlin CSV format, OPEN_CYPHER, which identifies the openCypher load format, or ntriples, which identifies the RDF n-triples format.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-GraphName <String>
A name for the new Neptune Analytics graph to be created.The name must contain from 1 to 63 letters, numbers, or hyphens, and its first character must be a letter. It cannot end with a hyphen or contain two consecutive hyphens. Only lowercase letters are allowed.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-KmsKeyIdentifier <String>
Specifies a KMS key to use to encrypt data imported into the new graph.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MaxProvisionedMemory <Int32>
The maximum provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph. Default: 1024, or the approved upper limit for your account. If both the minimum and maximum values are specified, the final provisioned-memory will be chosen per the actual size of your imported data. If neither value is specified, 128 m-NCUs are used.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MinProvisionedMemory <Int32>
The minimum provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph. Default: 16
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Neptune_PreserveDefaultVertexLabel <Boolean>
Neptune Analytics supports label-less vertices and no labels are assigned unless one is explicitly provided. Neptune assigns default labels when none is explicitly provided. When importing the data into Neptune Analytics, the default vertex labels can be omitted by setting preserveDefaultVertexLabels to false. Note that if the vertex only has default labels, and has no other properties or edges, then the vertex will effectively not get imported into Neptune Analytics when preserveDefaultVertexLabels is set to false.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesImportOptions_Neptune_PreserveDefaultVertexLabels
-Neptune_PreserveEdgeId <Boolean>
Neptune Analytics currently does not support user defined edge ids. The edge ids are not imported by default. They are imported if preserveEdgeIds is set to true, and ids are stored as properties on the relationships with the property name neptuneEdgeId.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesImportOptions_Neptune_PreserveEdgeIds
-Neptune_S3ExportKmsKeyId <String>
The KMS key to use to encrypt data in the S3 bucket where the graph data is exported
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesImportOptions_Neptune_S3ExportKmsKeyId
-Neptune_S3ExportPath <String>
The path to an S3 bucket from which to import data.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesImportOptions_Neptune_S3ExportPath
-ParquetType <ParquetType>
The parquet type of the import task.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PublicConnectivity <Boolean>
Specifies whether or not the graph can be reachable over the internet. All access to graphs is IAM authenticated. (true to enable, or false to disable).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ReplicaCount <Int32>
The number of replicas in other AZs to provision on the new graph after import. Default = 0, Min = 0, Max = 2. Additional charges equivalent to the m-NCUs selected for the graph apply for each replica.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RoleArn <String>
The ARN of the IAM role that will allow access to the data that is to be imported.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-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.NeptuneGraph.Model.CreateGraphUsingImportTaskResponse). Specifying the name of a property of type Amazon.NeptuneGraph.Model.CreateGraphUsingImportTaskResponse 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)
-Source <String>
A URL identifying to the location of the data to be imported. This can be an Amazon S3 path, or can point to a Neptune database endpoint or snapshot.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Tag <Hashtable>
Adds metadata tags to the new graph. These tags can also be used with cost allocation reporting, or used in a Condition statement in an IAM policy. 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
-VectorSearchConfiguration_Dimension <Int32>
The number of dimensions.
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

This cmdlet returns an Amazon.NeptuneGraph.Model.CreateGraphUsingImportTaskResponse object containing multiple properties.

Supported Version

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