AWS.Tools.Neptunedata.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.Neptunedata</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.NEPT.GetNEPTEngineStatusCmdlet"> <summary> Retrieves the status of the graph database on the host. <para> 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 <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getenginestatus">neptune-db:GetEngineStatus</a> IAM action in that cluster. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.GetNEPTEngineStatusCmdlet.Select"> <summary> 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.GetEngineStatusResponse). Specifying the name of a property of type Amazon.Neptunedata.Model.GetEngineStatusResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.NEPT.GetNEPTGremlinQueryListCmdlet"> <summary> Lists active Gremlin queries. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-api-status.html">Gremlin query status API</a> for details about the output. <para> 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 <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getquerystatus">neptune-db:GetQueryStatus</a> IAM action in that cluster. </para><para> Note that the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys">neptune-db:QueryLanguage:Gremlin</a> IAM condition key can be used in the policy document to restrict the use of Gremlin queries (see <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html">Condition keys available in Neptune IAM data-access policy statements</a>). </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.GetNEPTGremlinQueryListCmdlet.IncludeWaiting"> <summary> <para> <para>If set to <c>TRUE</c>, the list returned includes waiting queries. The default is <c>FALSE</c>;</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.GetNEPTGremlinQueryListCmdlet.Select"> <summary> 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.ListGremlinQueriesResponse). Specifying the name of a property of type Amazon.Neptunedata.Model.ListGremlinQueriesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.NEPT.GetNEPTGremlinQueryStatusCmdlet"> <summary> Gets the status of a specified Gremlin query. <para> 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 <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getquerystatus">neptune-db:GetQueryStatus</a> IAM action in that cluster. </para><para> Note that the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys">neptune-db:QueryLanguage:Gremlin</a> IAM condition key can be used in the policy document to restrict the use of Gremlin queries (see <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html">Condition keys available in Neptune IAM data-access policy statements</a>). </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.GetNEPTGremlinQueryStatusCmdlet.QueryId"> <summary> <para> <para>The unique identifier that identifies the Gremlin query.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.GetNEPTGremlinQueryStatusCmdlet.Select"> <summary> 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.GetGremlinQueryStatusResponse). Specifying the name of a property of type Amazon.Neptunedata.Model.GetGremlinQueryStatusResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.NEPT.GetNEPTLoaderJobListCmdlet"> <summary> Retrieves a list of the <c>loadIds</c> for all active loader jobs. <para> 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 <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#listloaderjobs">neptune-db:ListLoaderJobs</a> IAM action in that cluster.. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.GetNEPTLoaderJobListCmdlet.IncludeQueuedLoad"> <summary> <para> <para>An optional parameter that can be used to exclude the load IDs of queued load requests when requesting a list of load IDs by setting the parameter to <c>FALSE</c>. The default value is <c>TRUE</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.GetNEPTLoaderJobListCmdlet.Limit"> <summary> <para> <para>The number of load IDs to list. Must be a positive integer greater than zero and not more than <c>100</c> (which is the default).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.GetNEPTLoaderJobListCmdlet.Select"> <summary> 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.ListLoaderJobsResponse). Specifying the name of a property of type Amazon.Neptunedata.Model.ListLoaderJobsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.NEPT.GetNEPTLoaderJobStatusCmdlet"> <summary> Gets status information about a specified load job. Neptune keeps track of the most recent 1,024 bulk load jobs, and stores the last 10,000 error details per job. <para> See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/load-api-reference-status.htm">Neptune Loader Get-Status API</a> for more information. </para><para> 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 <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getloaderjobstatus">neptune-db:GetLoaderJobStatus</a> IAM action in that cluster.. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.GetNEPTLoaderJobStatusCmdlet.Detail"> <summary> <para> <para>Flag indicating whether or not to include details beyond the overall status (<c>TRUE</c> or <c>FALSE</c>; the default is <c>FALSE</c>).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.GetNEPTLoaderJobStatusCmdlet.Error"> <summary> <para> <para>Flag indicating whether or not to include a list of errors encountered (<c>TRUE</c> or <c>FALSE</c>; the default is <c>FALSE</c>).</para><para>The list of errors is paged. The <c>page</c> and <c>errorsPerPage</c> parameters allow you to page through all the errors.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.GetNEPTLoaderJobStatusCmdlet.ErrorsPerPage"> <summary> <para> <para>The number of errors returned in each page (a positive integer; the default is <c>10</c>). Only valid when the <c>errors</c> parameter set to <c>TRUE</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.GetNEPTLoaderJobStatusCmdlet.LoadId"> <summary> <para> <para>The load ID of the load job to get the status of.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.GetNEPTLoaderJobStatusCmdlet.Page"> <summary> <para> <para>The error page number (a positive integer; the default is <c>1</c>). Only valid when the <c>errors</c> parameter is set to <c>TRUE</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.GetNEPTLoaderJobStatusCmdlet.Select"> <summary> 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.GetLoaderJobStatusResponse). Specifying the name of a property of type Amazon.Neptunedata.Model.GetLoaderJobStatusResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.NEPT.GetNEPTMLDataProcessingJobCmdlet"> <summary> Retrieves information about a specified data processing job. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-dataprocessing.html">The <c>dataprocessing</c> command</a>. <para> 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 <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getmldataprocessingjobstatus">neptune-db:neptune-db:GetMLDataProcessingJobStatus</a> IAM action in that cluster. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.GetNEPTMLDataProcessingJobCmdlet.Id"> <summary> <para> <para>The unique identifier of the data-processing job to be retrieved.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.GetNEPTMLDataProcessingJobCmdlet.NeptuneIamRoleArn"> <summary> <para> <para>The ARN of an IAM role that provides Neptune access to SageMaker and Amazon S3 resources. This must be listed in your DB cluster parameter group or an error will occur.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.GetNEPTMLDataProcessingJobCmdlet.Select"> <summary> 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.GetMLDataProcessingJobResponse). Specifying the name of a property of type Amazon.Neptunedata.Model.GetMLDataProcessingJobResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.NEPT.GetNEPTMLDataProcessingJobListCmdlet"> <summary> Returns a list of Neptune ML data processing jobs. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-dataprocessing.html#machine-learning-api-dataprocessing-list-jobs">Listing active data-processing jobs using the Neptune ML dataprocessing command</a>. <para> 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 <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#listmldataprocessingjobs">neptune-db:ListMLDataProcessingJobs</a> IAM action in that cluster. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.GetNEPTMLDataProcessingJobListCmdlet.NeptuneIamRoleArn"> <summary> <para> <para>The ARN of an IAM role that provides Neptune access to SageMaker and Amazon S3 resources. This must be listed in your DB cluster parameter group or an error will occur.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.GetNEPTMLDataProcessingJobListCmdlet.MaxItem"> <summary> <para> <para>The maximum number of items to return (from 1 to 1024; the default is 10).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.GetNEPTMLDataProcessingJobListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Ids'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Neptunedata.Model.ListMLDataProcessingJobsResponse). Specifying the name of a property of type Amazon.Neptunedata.Model.ListMLDataProcessingJobsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.NEPT.GetNEPTMLEndpointCmdlet"> <summary> Retrieves details about an inference endpoint. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-endpoints.html">Managing inference endpoints using the endpoints command</a>. <para> 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 <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getmlendpointstatus">neptune-db:GetMLEndpointStatus</a> IAM action in that cluster. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.GetNEPTMLEndpointCmdlet.Id"> <summary> <para> <para>The unique identifier of the inference endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.GetNEPTMLEndpointCmdlet.NeptuneIamRoleArn"> <summary> <para> <para>The ARN of an IAM role that provides Neptune access to SageMaker and Amazon S3 resources. This must be listed in your DB cluster parameter group or an error will occur.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.GetNEPTMLEndpointCmdlet.Select"> <summary> 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.GetMLEndpointResponse). Specifying the name of a property of type Amazon.Neptunedata.Model.GetMLEndpointResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.NEPT.GetNEPTMLEndpointListCmdlet"> <summary> Lists existing inference endpoints. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-endpoints.html">Managing inference endpoints using the endpoints command</a>. <para> 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 <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#listmlendpoints">neptune-db:ListMLEndpoints</a> IAM action in that cluster. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.GetNEPTMLEndpointListCmdlet.NeptuneIamRoleArn"> <summary> <para> <para>The ARN of an IAM role that provides Neptune access to SageMaker and Amazon S3 resources. This must be listed in your DB cluster parameter group or an error will occur.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.GetNEPTMLEndpointListCmdlet.MaxItem"> <summary> <para> <para>The maximum number of items to return (from 1 to 1024; the default is 10.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.GetNEPTMLEndpointListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Ids'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Neptunedata.Model.ListMLEndpointsResponse). Specifying the name of a property of type Amazon.Neptunedata.Model.ListMLEndpointsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.NEPT.GetNEPTMLModelTrainingJobCmdlet"> <summary> Retrieves information about a Neptune ML model training job. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-modeltraining.html">Model training using the <c>modeltraining</c> command</a>. <para> 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 <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getmlmodeltrainingjobstatus">neptune-db:GetMLModelTrainingJobStatus</a> IAM action in that cluster. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.GetNEPTMLModelTrainingJobCmdlet.Id"> <summary> <para> <para>The unique identifier of the model-training job to retrieve.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.GetNEPTMLModelTrainingJobCmdlet.NeptuneIamRoleArn"> <summary> <para> <para>The ARN of an IAM role that provides Neptune access to SageMaker and Amazon S3 resources. This must be listed in your DB cluster parameter group or an error will occur.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.GetNEPTMLModelTrainingJobCmdlet.Select"> <summary> 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.GetMLModelTrainingJobResponse). Specifying the name of a property of type Amazon.Neptunedata.Model.GetMLModelTrainingJobResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.NEPT.GetNEPTMLModelTrainingJobListCmdlet"> <summary> Lists Neptune ML model-training jobs. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-modeltraining.html">Model training using the <c>modeltraining</c> command</a>. <para> 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 <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#neptune-db:listmlmodeltrainingjobs">neptune-db:neptune-db:ListMLModelTrainingJobs</a> IAM action in that cluster. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.GetNEPTMLModelTrainingJobListCmdlet.NeptuneIamRoleArn"> <summary> <para> <para>The ARN of an IAM role that provides Neptune access to SageMaker and Amazon S3 resources. This must be listed in your DB cluster parameter group or an error will occur.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.GetNEPTMLModelTrainingJobListCmdlet.MaxItem"> <summary> <para> <para>The maximum number of items to return (from 1 to 1024; the default is 10).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.GetNEPTMLModelTrainingJobListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Ids'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Neptunedata.Model.ListMLModelTrainingJobsResponse). Specifying the name of a property of type Amazon.Neptunedata.Model.ListMLModelTrainingJobsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.NEPT.GetNEPTMLModelTransformJobCmdlet"> <summary> Gets information about a specified model transform job. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-model-transform.html">Use a trained model to generate new model artifacts</a>. <para> 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 <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getmlmodeltransformjobstatus">neptune-db:GetMLModelTransformJobStatus</a> IAM action in that cluster. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.GetNEPTMLModelTransformJobCmdlet.Id"> <summary> <para> <para>The unique identifier of the model-transform job to be reetrieved.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.GetNEPTMLModelTransformJobCmdlet.NeptuneIamRoleArn"> <summary> <para> <para>The ARN of an IAM role that provides Neptune access to SageMaker and Amazon S3 resources. This must be listed in your DB cluster parameter group or an error will occur.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.GetNEPTMLModelTransformJobCmdlet.Select"> <summary> 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.GetMLModelTransformJobResponse). Specifying the name of a property of type Amazon.Neptunedata.Model.GetMLModelTransformJobResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.NEPT.GetNEPTMLModelTransformJobListCmdlet"> <summary> Returns a list of model transform job IDs. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-model-transform.html">Use a trained model to generate new model artifacts</a>. <para> 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 <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#listmlmodeltransformjobs">neptune-db:ListMLModelTransformJobs</a> IAM action in that cluster. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.GetNEPTMLModelTransformJobListCmdlet.NeptuneIamRoleArn"> <summary> <para> <para>The ARN of an IAM role that provides Neptune access to SageMaker and Amazon S3 resources. This must be listed in your DB cluster parameter group or an error will occur.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.GetNEPTMLModelTransformJobListCmdlet.MaxItem"> <summary> <para> <para>The maximum number of items to return (from 1 to 1024; the default is 10).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.GetNEPTMLModelTransformJobListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Ids'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Neptunedata.Model.ListMLModelTransformJobsResponse). Specifying the name of a property of type Amazon.Neptunedata.Model.ListMLModelTransformJobsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.NEPT.GetNEPTOpenCypherQueryListCmdlet"> <summary> Lists active openCypher queries. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-opencypher-status.html">Neptune openCypher status endpoint</a> for more information. <para> 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 <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getquerystatus">neptune-db:GetQueryStatus</a> IAM action in that cluster. </para><para> Note that the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys">neptune-db:QueryLanguage:OpenCypher</a> IAM condition key can be used in the policy document to restrict the use of openCypher queries (see <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html">Condition keys available in Neptune IAM data-access policy statements</a>). </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.GetNEPTOpenCypherQueryListCmdlet.IncludeWaiting"> <summary> <para> <para> When set to <c>TRUE</c> and other parameters are not present, causes status information to be returned for waiting queries as well as for running queries.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.GetNEPTOpenCypherQueryListCmdlet.Select"> <summary> 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.ListOpenCypherQueriesResponse). Specifying the name of a property of type Amazon.Neptunedata.Model.ListOpenCypherQueriesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.NEPT.GetNEPTOpenCypherQueryStatusCmdlet"> <summary> Retrieves the status of a specified openCypher query. <para> 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 <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getquerystatus">neptune-db:GetQueryStatus</a> IAM action in that cluster. </para><para> Note that the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys">neptune-db:QueryLanguage:OpenCypher</a> IAM condition key can be used in the policy document to restrict the use of openCypher queries (see <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html">Condition keys available in Neptune IAM data-access policy statements</a>). </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.GetNEPTOpenCypherQueryStatusCmdlet.QueryId"> <summary> <para> <para>The unique ID of the openCypher query for which to retrieve the query status.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.GetNEPTOpenCypherQueryStatusCmdlet.Select"> <summary> 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.GetOpenCypherQueryStatusResponse). Specifying the name of a property of type Amazon.Neptunedata.Model.GetOpenCypherQueryStatusResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.NEPT.GetNEPTPropertygraphStatisticCmdlet"> <summary> Gets property graph statistics (Gremlin and openCypher). <para> 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 <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getstatisticsstatus">neptune-db:GetStatisticsStatus</a> IAM action in that cluster. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.GetNEPTPropertygraphStatisticCmdlet.Select"> <summary> 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.GetPropertygraphStatisticsResponse). Specifying the name of a property of type Amazon.Neptunedata.Model.GetPropertygraphStatisticsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.NEPT.GetNEPTPropertygraphStreamCmdlet"> <summary> Gets a stream for a property graph. <para> With the Neptune Streams feature, you can generate a complete sequence of change-log entries that record every change made to your graph data as it happens. <c>GetPropertygraphStream</c> lets you collect these change-log entries for a property graph. </para><para> The Neptune streams feature needs to be enabled on your Neptune DBcluster. To enable streams, set the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/parameters.html#parameters-db-cluster-parameters-neptune_streams">neptune_streams</a> DB cluster parameter to <c>1</c>. </para><para> See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/streams.html">Capturing graph changes in real time using Neptune streams</a>. </para><para> 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 <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getstreamrecords">neptune-db:GetStreamRecords</a> IAM action in that cluster. </para><para> 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 enables one of the following IAM actions, depending on the query: </para><para> Note that you can restrict property-graph queries using the following IAM context keys: </para><ul><li><para><a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys">neptune-db:QueryLanguage:Gremlin</a></para></li><li><para><a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys">neptune-db:QueryLanguage:OpenCypher</a></para></li></ul><para> See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html">Condition keys available in Neptune IAM data-access policy statements</a>). </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.GetNEPTPropertygraphStreamCmdlet.CommitNum"> <summary> <para> <para>The commit number of the starting record to read from the change-log stream. This parameter is required when <c>iteratorType</c> is<c>AT_SEQUENCE_NUMBER</c> or <c>AFTER_SEQUENCE_NUMBER</c>, and ignored when <c>iteratorType</c> is <c>TRIM_HORIZON</c> or <c>LATEST</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.GetNEPTPropertygraphStreamCmdlet.Encoding"> <summary> <para> <para>If set to TRUE, Neptune compresses the response using gzip encoding.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.GetNEPTPropertygraphStreamCmdlet.IteratorType"> <summary> <para> <para>Can be one of:</para><ul><li><para><c>AT_SEQUENCE_NUMBER</c> – Indicates that reading should start from the event sequence number specified jointly by the <c>commitNum</c> and <c>opNum</c> parameters.</para></li><li><para><c>AFTER_SEQUENCE_NUMBER</c> – Indicates that reading should start right after the event sequence number specified jointly by the <c>commitNum</c> and <c>opNum</c> parameters.</para></li><li><para><c>TRIM_HORIZON</c> – Indicates that reading should start at the last untrimmed record in the system, which is the oldest unexpired (not yet deleted) record in the change-log stream.</para></li><li><para><c>LATEST</c> – Indicates that reading should start at the most recent record in the system, which is the latest unexpired (not yet deleted) record in the change-log stream.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.GetNEPTPropertygraphStreamCmdlet.OpNum"> <summary> <para> <para>The operation sequence number within the specified commit to start reading from in the change-log stream data. The default is <c>1</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.GetNEPTPropertygraphStreamCmdlet.Limit"> <summary> <para> <para>Specifies the maximum number of records to return. There is also a size limit of 10 MB on the response that can't be modified and that takes precedence over the number of records specified in the <c>limit</c> parameter. The response does include a threshold-breaching record if the 10 MB limit was reached.</para><para>The range for <c>limit</c> is 1 to 100,000, with a default of 10.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.GetNEPTPropertygraphStreamCmdlet.Select"> <summary> 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.GetPropertygraphStreamResponse). Specifying the name of a property of type Amazon.Neptunedata.Model.GetPropertygraphStreamResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.NEPT.GetNEPTPropertygraphSummaryCmdlet"> <summary> Gets a graph summary for a property graph. <para> 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 <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getgraphsummary">neptune-db:GetGraphSummary</a> IAM action in that cluster. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.GetNEPTPropertygraphSummaryCmdlet.Mode"> <summary> <para> <para>Mode can take one of two values: <c>BASIC</c> (the default), and <c>DETAILED</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.GetNEPTPropertygraphSummaryCmdlet.Select"> <summary> 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.GetPropertygraphSummaryResponse). Specifying the name of a property of type Amazon.Neptunedata.Model.GetPropertygraphSummaryResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.NEPT.GetNEPTRDFGraphSummaryCmdlet"> <summary> Gets a graph summary for an RDF graph. <para> 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 <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getgraphsummary">neptune-db:GetGraphSummary</a> IAM action in that cluster. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.GetNEPTRDFGraphSummaryCmdlet.Mode"> <summary> <para> <para>Mode can take one of two values: <c>BASIC</c> (the default), and <c>DETAILED</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.GetNEPTRDFGraphSummaryCmdlet.Select"> <summary> 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.GetRDFGraphSummaryResponse). Specifying the name of a property of type Amazon.Neptunedata.Model.GetRDFGraphSummaryResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.NEPT.GetNEPTSparqlStatisticCmdlet"> <summary> Gets RDF statistics (SPARQL). </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.GetNEPTSparqlStatisticCmdlet.Select"> <summary> 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.GetSparqlStatisticsResponse). Specifying the name of a property of type Amazon.Neptunedata.Model.GetSparqlStatisticsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.NEPT.GetNEPTSparqlStreamCmdlet"> <summary> Gets a stream for an RDF graph. <para> With the Neptune Streams feature, you can generate a complete sequence of change-log entries that record every change made to your graph data as it happens. <c>GetSparqlStream</c> lets you collect these change-log entries for an RDF graph. </para><para> The Neptune streams feature needs to be enabled on your Neptune DBcluster. To enable streams, set the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/parameters.html#parameters-db-cluster-parameters-neptune_streams">neptune_streams</a> DB cluster parameter to <c>1</c>. </para><para> See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/streams.html">Capturing graph changes in real time using Neptune streams</a>. </para><para> 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 <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getstreamrecords">neptune-db:GetStreamRecords</a> IAM action in that cluster. </para><para> Note that the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys">neptune-db:QueryLanguage:Sparql</a> IAM condition key can be used in the policy document to restrict the use of SPARQL queries (see <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html">Condition keys available in Neptune IAM data-access policy statements</a>). </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.GetNEPTSparqlStreamCmdlet.CommitNum"> <summary> <para> <para>The commit number of the starting record to read from the change-log stream. This parameter is required when <c>iteratorType</c> is<c>AT_SEQUENCE_NUMBER</c> or <c>AFTER_SEQUENCE_NUMBER</c>, and ignored when <c>iteratorType</c> is <c>TRIM_HORIZON</c> or <c>LATEST</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.GetNEPTSparqlStreamCmdlet.Encoding"> <summary> <para> <para>If set to TRUE, Neptune compresses the response using gzip encoding.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.GetNEPTSparqlStreamCmdlet.IteratorType"> <summary> <para> <para>Can be one of:</para><ul><li><para><c>AT_SEQUENCE_NUMBER</c> – Indicates that reading should start from the event sequence number specified jointly by the <c>commitNum</c> and <c>opNum</c> parameters.</para></li><li><para><c>AFTER_SEQUENCE_NUMBER</c> – Indicates that reading should start right after the event sequence number specified jointly by the <c>commitNum</c> and <c>opNum</c> parameters.</para></li><li><para><c>TRIM_HORIZON</c> – Indicates that reading should start at the last untrimmed record in the system, which is the oldest unexpired (not yet deleted) record in the change-log stream.</para></li><li><para><c>LATEST</c> – Indicates that reading should start at the most recent record in the system, which is the latest unexpired (not yet deleted) record in the change-log stream.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.GetNEPTSparqlStreamCmdlet.OpNum"> <summary> <para> <para>The operation sequence number within the specified commit to start reading from in the change-log stream data. The default is <c>1</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.GetNEPTSparqlStreamCmdlet.Limit"> <summary> <para> <para>Specifies the maximum number of records to return. There is also a size limit of 10 MB on the response that can't be modified and that takes precedence over the number of records specified in the <c>limit</c> parameter. The response does include a threshold-breaching record if the 10 MB limit was reached.</para><para>The range for <c>limit</c> is 1 to 100,000, with a default of 10.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.GetNEPTSparqlStreamCmdlet.Select"> <summary> 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.GetSparqlStreamResponse). Specifying the name of a property of type Amazon.Neptunedata.Model.GetSparqlStreamResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.NEPT.InvokeNEPTFastResetCmdlet"> <summary> The fast reset REST API lets you reset a Neptune graph quicky and easily, removing all of its data. <para> Neptune fast reset is a two-step process. First you call <c>ExecuteFastReset</c> with <c>action</c> set to <c>initiateDatabaseReset</c>. This returns a UUID token which you then include when calling <c>ExecuteFastReset</c> again with <c>action</c> set to <c>performDatabaseReset</c>. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/manage-console-fast-reset.html">Empty an Amazon Neptune DB cluster using the fast reset API</a>. </para><para> 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 <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#resetdatabase">neptune-db:ResetDatabase</a> IAM action in that cluster. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.InvokeNEPTFastResetCmdlet.Action"> <summary> <para> <para>The fast reset action. One of the following values:</para><ul><li><para><b><c>initiateDatabaseReset</c></b> – This action generates a unique token needed to actually perform the fast reset.</para></li><li><para><b><c>performDatabaseReset</c></b> – This action uses the token generated by the <c>initiateDatabaseReset</c> action to actually perform the fast reset.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.InvokeNEPTFastResetCmdlet.Token"> <summary> <para> <para>The fast-reset token to initiate the reset.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.InvokeNEPTFastResetCmdlet.Select"> <summary> 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.ExecuteFastResetResponse). Specifying the name of a property of type Amazon.Neptunedata.Model.ExecuteFastResetResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.InvokeNEPTFastResetCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.NEPT.InvokeNEPTGremlinExplainQueryCmdlet"> <summary> Executes a Gremlin Explain query. <para> Amazon Neptune has added a Gremlin feature named <c>explain</c> that provides is a self-service tool for understanding the execution approach being taken by the Neptune engine for the query. You invoke it by adding an <c>explain</c> parameter to an HTTP call that submits a Gremlin query. </para><para> The explain feature provides information about the logical structure of query execution plans. You can use this information to identify potential evaluation and execution bottlenecks and to tune your query, as explained in <a href="https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-traversal-tuning.html">Tuning Gremlin queries</a>. You can also use query hints to improve query execution plans. </para><para> 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 one of the following IAM actions in that cluster, depending on the query: </para><ul><li><para><a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#readdataviaquery">neptune-db:ReadDataViaQuery</a></para></li><li><para><a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#writedataviaquery">neptune-db:WriteDataViaQuery</a></para></li><li><para><a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#deletedataviaquery">neptune-db:DeleteDataViaQuery</a></para></li></ul><para> Note that the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys">neptune-db:QueryLanguage:Gremlin</a> IAM condition key can be used in the policy document to restrict the use of Gremlin queries (see <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html">Condition keys available in Neptune IAM data-access policy statements</a>). </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.InvokeNEPTGremlinExplainQueryCmdlet.GremlinQuery"> <summary> <para> <para>The Gremlin explain query string.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.InvokeNEPTGremlinExplainQueryCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Output'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Neptunedata.Model.ExecuteGremlinExplainQueryResponse). Specifying the name of a property of type Amazon.Neptunedata.Model.ExecuteGremlinExplainQueryResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.InvokeNEPTGremlinExplainQueryCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.NEPT.InvokeNEPTGremlinProfileQueryCmdlet"> <summary> Executes a Gremlin Profile query, which runs a specified traversal, collects various metrics about the run, and produces a profile report as output. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-profile-api.html">Gremlin profile API in Neptune</a> for details. <para> 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 <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#readdataviaquery">neptune-db:ReadDataViaQuery</a> IAM action in that cluster. </para><para> Note that the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys">neptune-db:QueryLanguage:Gremlin</a> IAM condition key can be used in the policy document to restrict the use of Gremlin queries (see <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html">Condition keys available in Neptune IAM data-access policy statements</a>). </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.InvokeNEPTGremlinProfileQueryCmdlet.Chop"> <summary> <para> <para>If non-zero, causes the results string to be truncated at that number of characters. If set to zero, the string contains all the results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.InvokeNEPTGremlinProfileQueryCmdlet.GremlinQuery"> <summary> <para> <para>The Gremlin query string to profile.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.InvokeNEPTGremlinProfileQueryCmdlet.IndexOp"> <summary> <para> <para>If this flag is set to <c>TRUE</c>, the results include a detailed report of all index operations that took place during query execution and serialization.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.InvokeNEPTGremlinProfileQueryCmdlet.Result"> <summary> <para> <para>If this flag is set to <c>TRUE</c>, the query results are gathered and displayed as part of the profile report. If <c>FALSE</c>, only the result count is displayed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.InvokeNEPTGremlinProfileQueryCmdlet.Serializer"> <summary> <para> <para>If non-null, the gathered results are returned in a serialized response message in the format specified by this parameter. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-profile-api.html">Gremlin profile API in Neptune</a> for more information.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.InvokeNEPTGremlinProfileQueryCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Output'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Neptunedata.Model.ExecuteGremlinProfileQueryResponse). Specifying the name of a property of type Amazon.Neptunedata.Model.ExecuteGremlinProfileQueryResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.InvokeNEPTGremlinProfileQueryCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.NEPT.InvokeNEPTGremlinQueryCmdlet"> <summary> This commands executes a Gremlin query. Amazon Neptune is compatible with Apache TinkerPop3 and Gremlin, so you can use the Gremlin traversal language to query the graph, as described under <a href="https://tinkerpop.apache.org/docs/current/reference/#graph">The Graph</a> in the Apache TinkerPop3 documentation. More details can also be found in <a href="https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-gremlin.html">Accessing a Neptune graph with Gremlin</a>. <para> 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 enables one of the following IAM actions in that cluster, depending on the query: </para><ul><li><para><a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#readdataviaquery">neptune-db:ReadDataViaQuery</a></para></li><li><para><a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#writedataviaquery">neptune-db:WriteDataViaQuery</a></para></li><li><para><a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#deletedataviaquery">neptune-db:DeleteDataViaQuery</a></para></li></ul><para> Note that the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys">neptune-db:QueryLanguage:Gremlin</a> IAM condition key can be used in the policy document to restrict the use of Gremlin queries (see <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html">Condition keys available in Neptune IAM data-access policy statements</a>). </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.InvokeNEPTGremlinQueryCmdlet.GremlinQuery"> <summary> <para> <para>Using this API, you can run Gremlin queries in string format much as you can using the HTTP endpoint. The interface is compatible with whatever Gremlin version your DB cluster is using (see the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-gremlin-client.html#best-practices-gremlin-java-latest">Tinkerpop client section</a> to determine which Gremlin releases your engine version supports).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.InvokeNEPTGremlinQueryCmdlet.Serializer"> <summary> <para> <para>If non-null, the query results are returned in a serialized response message in the format specified by this parameter. See the <a href="https://tinkerpop.apache.org/docs/current/reference/#_graphson">GraphSON</a> section in the TinkerPop documentation for a list of the formats that are currently supported.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.InvokeNEPTGremlinQueryCmdlet.Select"> <summary> 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.ExecuteGremlinQueryResponse). Specifying the name of a property of type Amazon.Neptunedata.Model.ExecuteGremlinQueryResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.InvokeNEPTGremlinQueryCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.NEPT.InvokeNEPTOpenCypherExplainQueryCmdlet"> <summary> Executes an openCypher <c>explain</c> request. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-opencypher-explain.html">The openCypher explain feature</a> for more information. <para> 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 <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#readdataviaquery">neptune-db:ReadDataViaQuery</a> IAM action in that cluster. </para><para> Note that the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys">neptune-db:QueryLanguage:OpenCypher</a> IAM condition key can be used in the policy document to restrict the use of openCypher queries (see <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html">Condition keys available in Neptune IAM data-access policy statements</a>). </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.InvokeNEPTOpenCypherExplainQueryCmdlet.ExplainMode"> <summary> <para> <para>The openCypher <c>explain</c> mode. Can be one of: <c>static</c>, <c>dynamic</c>, or <c>details</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.InvokeNEPTOpenCypherExplainQueryCmdlet.OpenCypherQuery"> <summary> <para> <para>The openCypher query string.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.InvokeNEPTOpenCypherExplainQueryCmdlet.Parameter"> <summary> <para> <para>The openCypher query parameters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.InvokeNEPTOpenCypherExplainQueryCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Results'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Neptunedata.Model.ExecuteOpenCypherExplainQueryResponse). Specifying the name of a property of type Amazon.Neptunedata.Model.ExecuteOpenCypherExplainQueryResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.InvokeNEPTOpenCypherExplainQueryCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.NEPT.InvokeNEPTOpenCypherQueryCmdlet"> <summary> Executes an openCypher query. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-opencypher.html">Accessing the Neptune Graph with openCypher</a> for more information. <para> Neptune supports building graph applications using openCypher, which is currently one of the most popular query languages among developers working with graph databases. Developers, business analysts, and data scientists like openCypher's declarative, SQL-inspired syntax because it provides a familiar structure in which to querying property graphs. </para><para> The openCypher language was originally developed by Neo4j, then open-sourced in 2015 and contributed to the <a href="https://opencypher.org/">openCypher project</a> under an Apache 2 open-source license. </para><para> Note that 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 one of the following IAM actions in that cluster, depending on the query: </para><ul><li><para><a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#readdataviaquery">neptune-db:ReadDataViaQuery</a></para></li><li><para><a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#writedataviaquery">neptune-db:WriteDataViaQuery</a></para></li><li><para><a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#deletedataviaquery">neptune-db:DeleteDataViaQuery</a></para></li></ul><para> Note also that the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys">neptune-db:QueryLanguage:OpenCypher</a> IAM condition key can be used in the policy document to restrict the use of openCypher queries (see <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html">Condition keys available in Neptune IAM data-access policy statements</a>). </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.InvokeNEPTOpenCypherQueryCmdlet.OpenCypherQuery"> <summary> <para> <para>The openCypher query string to be executed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.InvokeNEPTOpenCypherQueryCmdlet.Parameter"> <summary> <para> <para>The openCypher query parameters for query execution. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/opencypher-parameterized-queries.html">Examples of openCypher parameterized queries</a> for more information.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.InvokeNEPTOpenCypherQueryCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Results'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Neptunedata.Model.ExecuteOpenCypherQueryResponse). Specifying the name of a property of type Amazon.Neptunedata.Model.ExecuteOpenCypherQueryResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.InvokeNEPTOpenCypherQueryCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.NEPT.NewNEPTMLEndpointCmdlet"> <summary> Creates a new Neptune ML inference endpoint that lets you query one specific model that the model-training process constructed. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-endpoints.html">Managing inference endpoints using the endpoints command</a>. <para> 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 <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#createmlendpoint">neptune-db:CreateMLEndpoint</a> IAM action in that cluster. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.NewNEPTMLEndpointCmdlet.Id"> <summary> <para> <para>A unique identifier for the new inference endpoint. The default is an autogenerated timestamped name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.NewNEPTMLEndpointCmdlet.InstanceCount"> <summary> <para> <para>The minimum number of Amazon EC2 instances to deploy to an endpoint for prediction. The default is 1</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.NewNEPTMLEndpointCmdlet.InstanceType"> <summary> <para> <para>The type of Neptune ML instance to use for online servicing. The default is <c>ml.m5.xlarge</c>. Choosing the ML instance for an inference endpoint depends on the task type, the graph size, and your budget.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.NewNEPTMLEndpointCmdlet.MlModelTrainingJobId"> <summary> <para> <para>The job Id of the completed model-training job that has created the model that the inference endpoint will point to. You must supply either the <c>mlModelTrainingJobId</c> or the <c>mlModelTransformJobId</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.NewNEPTMLEndpointCmdlet.MlModelTransformJobId"> <summary> <para> <para>The job Id of the completed model-transform job. You must supply either the <c>mlModelTrainingJobId</c> or the <c>mlModelTransformJobId</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.NewNEPTMLEndpointCmdlet.ModelName"> <summary> <para> <para>Model type for training. By default the Neptune ML model is automatically based on the <c>modelType</c> used in data processing, but you can specify a different model type here. The default is <c>rgcn</c> for heterogeneous graphs and <c>kge</c> for knowledge graphs. The only valid value for heterogeneous graphs is <c>rgcn</c>. Valid values for knowledge graphs are: <c>kge</c>, <c>transe</c>, <c>distmult</c>, and <c>rotate</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.NewNEPTMLEndpointCmdlet.NeptuneIamRoleArn"> <summary> <para> <para>The ARN of an IAM role providing Neptune access to SageMaker and Amazon S3 resources. This must be listed in your DB cluster parameter group or an error will be thrown.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.NewNEPTMLEndpointCmdlet.Update"> <summary> <para> <para>If set to <c>true</c>, <c>update</c> indicates that this is an update request. The default is <c>false</c>. You must supply either the <c>mlModelTrainingJobId</c> or the <c>mlModelTransformJobId</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.NewNEPTMLEndpointCmdlet.VolumeEncryptionKMSKey"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.NewNEPTMLEndpointCmdlet.Select"> <summary> 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.CreateMLEndpointResponse). Specifying the name of a property of type Amazon.Neptunedata.Model.CreateMLEndpointResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.NewNEPTMLEndpointCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.NEPT.RemoveNEPTMLEndpointCmdlet"> <summary> Cancels the creation of a Neptune ML inference endpoint. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-endpoints.html">Managing inference endpoints using the endpoints command</a>. <para> 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 <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#deletemlendpoint">neptune-db:DeleteMLEndpoint</a> IAM action in that cluster. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.RemoveNEPTMLEndpointCmdlet.Clean"> <summary> <para> <para>If this flag is set to <c>TRUE</c>, all Neptune ML S3 artifacts should be deleted when the job is stopped. The default is <c>FALSE</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.RemoveNEPTMLEndpointCmdlet.Id"> <summary> <para> <para>The unique identifier of the inference endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.RemoveNEPTMLEndpointCmdlet.NeptuneIamRoleArn"> <summary> <para> <para>The ARN of an IAM role providing Neptune access to SageMaker and Amazon S3 resources. This must be listed in your DB cluster parameter group or an error will be thrown.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.RemoveNEPTMLEndpointCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Status'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Neptunedata.Model.DeleteMLEndpointResponse). Specifying the name of a property of type Amazon.Neptunedata.Model.DeleteMLEndpointResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.RemoveNEPTMLEndpointCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.NEPT.RemoveNEPTPropertygraphStatisticCmdlet"> <summary> Deletes statistics for Gremlin and openCypher (property graph) data. <para> 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 <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#deletestatistics">neptune-db:DeleteStatistics</a> IAM action in that cluster. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.RemoveNEPTPropertygraphStatisticCmdlet.Select"> <summary> 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.DeletePropertygraphStatisticsResponse). Specifying the name of a property of type Amazon.Neptunedata.Model.DeletePropertygraphStatisticsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.RemoveNEPTPropertygraphStatisticCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.NEPT.RemoveNEPTSparqlStatisticCmdlet"> <summary> Deletes SPARQL statistics <para> 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 <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#deletestatistics">neptune-db:DeleteStatistics</a> IAM action in that cluster. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.RemoveNEPTSparqlStatisticCmdlet.Select"> <summary> 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.DeleteSparqlStatisticsResponse). Specifying the name of a property of type Amazon.Neptunedata.Model.DeleteSparqlStatisticsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.RemoveNEPTSparqlStatisticCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.NEPT.StartNEPTLoaderJobCmdlet"> <summary> Starts a Neptune bulk loader job to load data from an Amazon S3 bucket into a Neptune DB instance. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load.html">Using the Amazon Neptune Bulk Loader to Ingest Data</a>. <para> 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 <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#startloaderjob">neptune-db:StartLoaderJob</a> IAM action in that cluster. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.StartNEPTLoaderJobCmdlet.Dependency"> <summary> <para> <para>This is an optional parameter that can make a queued load request contingent on the successful completion of one or more previous jobs in the queue.</para><para>Neptune can queue up as many as 64 load requests at a time, if their <c>queueRequest</c> parameters are set to <c>"TRUE"</c>. The <c>dependencies</c> parameter lets you make execution of such a queued request dependent on the successful completion of one or more specified previous requests in the queue.</para><para>For example, if load <c>Job-A</c> and <c>Job-B</c> are independent of each other, but load <c>Job-C</c> needs <c>Job-A</c> and <c>Job-B</c> to be finished before it begins, proceed as follows:</para><ol><li><para>Submit <c>load-job-A</c> and <c>load-job-B</c> one after another in any order, and save their load-ids.</para></li><li><para>Submit <c>load-job-C</c> with the load-ids of the two jobs in its <c>dependencies</c> field:</para></li></ol><para>Because of the <c>dependencies</c> parameter, the bulk loader will not start <c>Job-C</c> until <c>Job-A</c> and <c>Job-B</c> have completed successfully. If either one of them fails, Job-C will not be executed, and its status will be set to <c>LOAD_FAILED_BECAUSE_DEPENDENCY_NOT_SATISFIED</c>.</para><para>You can set up multiple levels of dependency in this way, so that the failure of one job will cause all requests that are directly or indirectly dependent on it to be cancelled.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.StartNEPTLoaderJobCmdlet.FailOnError"> <summary> <para> <para><b><c>failOnError</c></b> – A flag to toggle a complete stop on an error.</para><para><i>Allowed values</i>: <c>"TRUE"</c>, <c>"FALSE"</c>.</para><para><i>Default value</i>: <c>"TRUE"</c>.</para><para>When this parameter is set to <c>"FALSE"</c>, the loader tries to load all the data in the location specified, skipping any entries with errors.</para><para>When this parameter is set to <c>"TRUE"</c>, the loader stops as soon as it encounters an error. Data loaded up to that point persists.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.StartNEPTLoaderJobCmdlet.Format"> <summary> <para> <para>The format of the data. For more information about data formats for the Neptune <c>Loader</c> command, see <a href="https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format.html">Load Data Formats</a>.</para><para><b>Allowed values</b></para><ul><li><para><b><c>csv</c></b> for the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-gremlin.html">Gremlin CSV data format</a>.</para></li><li><para><b><c>opencypher</c></b> for the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-opencypher.html">openCypher CSV data format</a>.</para></li><li><para><b><c>ntriples</c></b> for the <a href="https://www.w3.org/TR/n-triples/">N-Triples RDF data format</a>.</para></li><li><para><b><c>nquads</c></b> for the <a href="https://www.w3.org/TR/n-quads/">N-Quads RDF data format</a>.</para></li><li><para><b><c>rdfxml</c></b> for the <a href="https://www.w3.org/TR/rdf-syntax-grammar/">RDF\XML RDF data format</a>.</para></li><li><para><b><c>turtle</c></b> for the <a href="https://www.w3.org/TR/turtle/">Turtle RDF data format</a>.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.StartNEPTLoaderJobCmdlet.IamRoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) for an IAM role to be assumed by the Neptune DB instance for access to the S3 bucket. The IAM role ARN provided here should be attached to the DB cluster (see <a href="https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-IAM-add-role-cluster.html">Adding the IAM Role to an Amazon Neptune Cluster</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.StartNEPTLoaderJobCmdlet.Mode"> <summary> <para> <para>The load job mode.</para><para><i>Allowed values</i>: <c>RESUME</c>, <c>NEW</c>, <c>AUTO</c>.</para><para><i>Default value</i>: <c>AUTO</c>.</para><para><b /></para><ul><li><para><c>RESUME</c> – In RESUME mode, the loader looks for a previous load from this source, and if it finds one, resumes that load job. If no previous load job is found, the loader stops.</para><para>The loader avoids reloading files that were successfully loaded in a previous job. It only tries to process failed files. If you dropped previously loaded data from your Neptune cluster, that data is not reloaded in this mode. If a previous load job loaded all files from the same source successfully, nothing is reloaded, and the loader returns success.</para></li><li><para><c>NEW</c> – In NEW mode, the creates a new load request regardless of any previous loads. You can use this mode to reload all the data from a source after dropping previously loaded data from your Neptune cluster, or to load new data available at the same source.</para></li><li><para><c>AUTO</c> – In AUTO mode, the loader looks for a previous load job from the same source, and if it finds one, resumes that job, just as in <c>RESUME</c> mode.</para><para>If the loader doesn't find a previous load job from the same source, it loads all data from the source, just as in <c>NEW</c> mode.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.StartNEPTLoaderJobCmdlet.Parallelism"> <summary> <para> <para>The optional <c>parallelism</c> parameter can be set to reduce the number of threads used by the bulk load process.</para><para><i>Allowed values</i>:</para><ul><li><para><c>LOW</c> – The number of threads used is the number of available vCPUs divided by 8.</para></li><li><para><c>MEDIUM</c> – The number of threads used is the number of available vCPUs divided by 2.</para></li><li><para><c>HIGH</c> – The number of threads used is the same as the number of available vCPUs.</para></li><li><para><c>OVERSUBSCRIBE</c> – The number of threads used is the number of available vCPUs multiplied by 2. If this value is used, the bulk loader takes up all available resources.</para><para>This does not mean, however, that the <c>OVERSUBSCRIBE</c> setting results in 100% CPU utilization. Because the load operation is I/O bound, the highest CPU utilization to expect is in the 60% to 70% range.</para></li></ul><para><i>Default value</i>: <c>HIGH</c></para><para>The <c>parallelism</c> setting can sometimes result in a deadlock between threads when loading openCypher data. When this happens, Neptune returns the <c>LOAD_DATA_DEADLOCK</c> error. You can generally fix the issue by setting <c>parallelism</c> to a lower setting and retrying the load command.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.StartNEPTLoaderJobCmdlet.ParserConfiguration"> <summary> <para> <para><b><c>parserConfiguration</c></b> – An optional object with additional parser configuration values. Each of the child parameters is also optional:</para><para><b /></para><ul><li><para><b><c>namedGraphUri</c></b> – The default graph for all RDF formats when no graph is specified (for non-quads formats and NQUAD entries with no graph).</para><para>The default is <c>https://aws.amazon.com/neptune/vocab/v01/DefaultNamedGraph</c>.</para></li><li><para><b><c>baseUri</c></b> – The base URI for RDF/XML and Turtle formats.</para><para>The default is <c>https://aws.amazon.com/neptune/default</c>.</para></li><li><para><b><c>allowEmptyStrings</c></b> – Gremlin users need to be able to pass empty string values("") as node and edge properties when loading CSV data. If <c>allowEmptyStrings</c> is set to <c>false</c> (the default), such empty strings are treated as nulls and are not loaded.</para><para>If <c>allowEmptyStrings</c> is set to <c>true</c>, the loader treats empty strings as valid property values and loads them accordingly.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.StartNEPTLoaderJobCmdlet.QueueRequest"> <summary> <para> <para>This is an optional flag parameter that indicates whether the load request can be queued up or not. </para><para>You don't have to wait for one load job to complete before issuing the next one, because Neptune can queue up as many as 64 jobs at a time, provided that their <c>queueRequest</c> parameters are all set to <c>"TRUE"</c>. The queue order of the jobs will be first-in-first-out (FIFO).</para><para>If the <c>queueRequest</c> parameter is omitted or set to <c>"FALSE"</c>, the load request will fail if another load job is already running.</para><para><i>Allowed values</i>: <c>"TRUE"</c>, <c>"FALSE"</c>.</para><para><i>Default value</i>: <c>"FALSE"</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.StartNEPTLoaderJobCmdlet.S3BucketRegion"> <summary> <para> <para>The Amazon region of the S3 bucket. This must match the Amazon Region of the DB cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.StartNEPTLoaderJobCmdlet.Source"> <summary> <para> <para>The <c>source</c> parameter accepts an S3 URI that identifies a single file, multiple files, a folder, or multiple folders. Neptune loads every data file in any folder that is specified.</para><para>The URI can be in any of the following formats.</para><ul><li><para><c>s3://(bucket_name)/(object-key-name)</c></para></li><li><para><c>https://s3.amazonaws.com/(bucket_name)/(object-key-name)</c></para></li><li><para><c>https://s3.us-east-1.amazonaws.com/(bucket_name)/(object-key-name)</c></para></li></ul><para>The <c>object-key-name</c> element of the URI is equivalent to the <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.html#API_ListObjects_RequestParameters">prefix</a> parameter in an S3 <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.html">ListObjects</a> API call. It identifies all the objects in the specified S3 bucket whose names begin with that prefix. That can be a single file or folder, or multiple files and/or folders.</para><para>The specified folder or folders can contain multiple vertex files and multiple edge files.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.StartNEPTLoaderJobCmdlet.UpdateSingleCardinalityProperty"> <summary> <para> <para><c>updateSingleCardinalityProperties</c> is an optional parameter that controls how the bulk loader treats a new value for single-cardinality vertex or edge properties. This is not supported for loading openCypher data.</para><para><i>Allowed values</i>: <c>"TRUE"</c>, <c>"FALSE"</c>.</para><para><i>Default value</i>: <c>"FALSE"</c>.</para><para>By default, or when <c>updateSingleCardinalityProperties</c> is explicitly set to <c>"FALSE"</c>, the loader treats a new value as an error, because it violates single cardinality.</para><para>When <c>updateSingleCardinalityProperties</c> is set to <c>"TRUE"</c>, on the other hand, the bulk loader replaces the existing value with the new one. If multiple edge or single-cardinality vertex property values are provided in the source file(s) being loaded, the final value at the end of the bulk load could be any one of those new values. The loader only guarantees that the existing value has been replaced by one of the new ones.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.StartNEPTLoaderJobCmdlet.UserProvidedEdgeId"> <summary> <para> <para>This parameter is required only when loading openCypher data that contains relationship IDs. It must be included and set to <c>True</c> when openCypher relationship IDs are explicitly provided in the load data (recommended).</para><para>When <c>userProvidedEdgeIds</c> is absent or set to <c>True</c>, an <c>:ID</c> column must be present in every relationship file in the load.</para><para>When <c>userProvidedEdgeIds</c> is present and set to <c>False</c>, relationship files in the load <b>must not</b> contain an <c>:ID</c> column. Instead, the Neptune loader automatically generates an ID for each relationship.</para><para>It's useful to provide relationship IDs explicitly so that the loader can resume loading after error in the CSV data have been fixed, without having to reload any relationships that have already been loaded. If relationship IDs have not been explicitly assigned, the loader cannot resume a failed load if any relationship file has had to be corrected, and must instead reload all the relationships.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.StartNEPTLoaderJobCmdlet.Select"> <summary> 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.StartLoaderJobResponse). Specifying the name of a property of type Amazon.Neptunedata.Model.StartLoaderJobResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.StartNEPTLoaderJobCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.NEPT.StartNEPTMLDataProcessingJobCmdlet"> <summary> Creates a new Neptune ML data processing job for processing the graph data exported from Neptune for training. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-dataprocessing.html">The <c>dataprocessing</c> command</a>. <para> 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 <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#startmlmodeldataprocessingjob">neptune-db:StartMLModelDataProcessingJob</a> IAM action in that cluster. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.StartNEPTMLDataProcessingJobCmdlet.ConfigFileName"> <summary> <para> <para>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 <c>training-data-configuration.json</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.StartNEPTMLDataProcessingJobCmdlet.Id"> <summary> <para> <para>A unique identifier for the new job. The default is an autogenerated UUID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.StartNEPTMLDataProcessingJobCmdlet.InputDataS3Location"> <summary> <para> <para>The URI of the Amazon S3 location where you want SageMaker to download the data needed to run the data processing job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.StartNEPTMLDataProcessingJobCmdlet.ModelType"> <summary> <para> <para>One of the two model types that Neptune ML currently supports: heterogeneous graph models (<c>heterogeneous</c>), and knowledge graph (<c>kge</c>). The default is none. If not specified, Neptune ML chooses the model type automatically based on the data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.StartNEPTMLDataProcessingJobCmdlet.NeptuneIamRoleArn"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.StartNEPTMLDataProcessingJobCmdlet.PreviousDataProcessingJobId"> <summary> <para> <para>The job ID of a completed data processing job run on an earlier version of the data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.StartNEPTMLDataProcessingJobCmdlet.ProcessedDataS3Location"> <summary> <para> <para>The URI of the Amazon S3 location where you want SageMaker to save the results of a data processing job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.StartNEPTMLDataProcessingJobCmdlet.ProcessingInstanceType"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.StartNEPTMLDataProcessingJobCmdlet.ProcessingInstanceVolumeSizeInGB"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.StartNEPTMLDataProcessingJobCmdlet.ProcessingTimeOutInSecond"> <summary> <para> <para>Timeout in seconds for the data processing job. The default is 86,400 (1 day).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.StartNEPTMLDataProcessingJobCmdlet.S3OutputEncryptionKMSKey"> <summary> <para> <para>The Amazon Key Management Service (Amazon KMS) key that SageMaker uses to encrypt the output of the processing job. The default is none.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.StartNEPTMLDataProcessingJobCmdlet.SagemakerIamRoleArn"> <summary> <para> <para>The ARN of an IAM role for SageMaker execution. This must be listed in your DB cluster parameter group or an error will occur.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.StartNEPTMLDataProcessingJobCmdlet.SecurityGroupId"> <summary> <para> <para>The VPC security group IDs. The default is None.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.StartNEPTMLDataProcessingJobCmdlet.Subnet"> <summary> <para> <para>The IDs of the subnets in the Neptune VPC. The default is None.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.StartNEPTMLDataProcessingJobCmdlet.VolumeEncryptionKMSKey"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.StartNEPTMLDataProcessingJobCmdlet.Select"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.StartNEPTMLDataProcessingJobCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.NEPT.StartNEPTMLModelTrainingJobCmdlet"> <summary> Creates a new Neptune ML model training job. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-modeltraining.html">Model training using the <c>modeltraining</c> command</a>. <para> 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 <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#startmlmodeltrainingjob">neptune-db:StartMLModelTrainingJob</a> IAM action in that cluster. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.StartNEPTMLModelTrainingJobCmdlet.BaseProcessingInstanceType"> <summary> <para> <para>The type of ML instance used in preparing and managing training of ML models. This is a CPU instance chosen based on memory requirements for processing the training data and model.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.StartNEPTMLModelTrainingJobCmdlet.DataProcessingJobId"> <summary> <para> <para>The job ID of the completed data-processing job that has created the data that the training will work with.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.StartNEPTMLModelTrainingJobCmdlet.EnableManagedSpotTraining"> <summary> <para> <para>Optimizes the cost of training machine-learning models by using Amazon Elastic Compute Cloud spot instances. The default is <c>False</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.StartNEPTMLModelTrainingJobCmdlet.Id"> <summary> <para> <para>A unique identifier for the new job. The default is An autogenerated UUID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.StartNEPTMLModelTrainingJobCmdlet.MaxHPONumberOfTrainingJob"> <summary> <para> <para>Maximum total number of training jobs to start for the hyperparameter tuning job. The default is 2. Neptune ML automatically tunes the hyperparameters of the machine learning model. To obtain a model that performs well, use at least 10 jobs (in other words, set <c>maxHPONumberOfTrainingJobs</c> to 10). In general, the more tuning runs, the better the results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.StartNEPTMLModelTrainingJobCmdlet.MaxHPOParallelTrainingJob"> <summary> <para> <para>Maximum number of parallel training jobs to start for the hyperparameter tuning job. The default is 2. The number of parallel jobs you can run is limited by the available resources on your training instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.StartNEPTMLModelTrainingJobCmdlet.NeptuneIamRoleArn"> <summary> <para> <para>The ARN of an IAM role that provides Neptune access to SageMaker and Amazon S3 resources. This must be listed in your DB cluster parameter group or an error will occur.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.StartNEPTMLModelTrainingJobCmdlet.PreviousModelTrainingJobId"> <summary> <para> <para>The job ID of a completed model-training job that you want to update incrementally based on updated data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.StartNEPTMLModelTrainingJobCmdlet.S3OutputEncryptionKMSKey"> <summary> <para> <para>The Amazon Key Management Service (KMS) key that SageMaker uses to encrypt the output of the processing job. The default is none.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.StartNEPTMLModelTrainingJobCmdlet.SagemakerIamRoleArn"> <summary> <para> <para>The ARN of an IAM role for SageMaker execution.This must be listed in your DB cluster parameter group or an error will occur.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.StartNEPTMLModelTrainingJobCmdlet.SecurityGroupId"> <summary> <para> <para>The VPC security group IDs. The default is None.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.StartNEPTMLModelTrainingJobCmdlet.CustomModelTrainingParameters_SourceS3DirectoryPath"> <summary> <para> <para>The path to the Amazon S3 location where the Python module implementing your model is located. This must point to a valid existing Amazon S3 location that contains, at a minimum, a training script, a transform script, and a <c>model-hpo-configuration.json</c> file.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.StartNEPTMLModelTrainingJobCmdlet.Subnet"> <summary> <para> <para>The IDs of the subnets in the Neptune VPC. The default is None.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.StartNEPTMLModelTrainingJobCmdlet.CustomModelTrainingParameters_TrainingEntryPointScript"> <summary> <para> <para>The name of the entry point in your module of a script that performs model training and takes hyperparameters as command-line arguments, including fixed hyperparameters. The default is <c>training.py</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.StartNEPTMLModelTrainingJobCmdlet.TrainingInstanceType"> <summary> <para> <para>The type of ML instance used for model training. All Neptune ML models support CPU, GPU, and multiGPU training. The default is <c>ml.p3.2xlarge</c>. Choosing the right instance type for training depends on the task type, graph size, and your budget.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.StartNEPTMLModelTrainingJobCmdlet.TrainingInstanceVolumeSizeInGB"> <summary> <para> <para>The disk volume size of the training instance. Both input data and the output model 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 selects a disk volume size based on the recommendation generated in the data processing step.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.StartNEPTMLModelTrainingJobCmdlet.TrainingTimeOutInSecond"> <summary> <para> <para>Timeout in seconds for the training job. The default is 86,400 (1 day).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.StartNEPTMLModelTrainingJobCmdlet.TrainModelS3Location"> <summary> <para> <para>The location in Amazon S3 where the model artifacts are to be stored.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.StartNEPTMLModelTrainingJobCmdlet.CustomModelTrainingParameters_TransformEntryPointScript"> <summary> <para> <para>The name of the entry point in your module of a script that should be run after the best model from the hyperparameter search has been identified, to compute the model artifacts necessary for model deployment. It should be able to run with no command-line arguments.The default is <c>transform.py</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.StartNEPTMLModelTrainingJobCmdlet.VolumeEncryptionKMSKey"> <summary> <para> <para>The Amazon Key Management Service (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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.StartNEPTMLModelTrainingJobCmdlet.Select"> <summary> 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.StartMLModelTrainingJobResponse). Specifying the name of a property of type Amazon.Neptunedata.Model.StartMLModelTrainingJobResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.StartNEPTMLModelTrainingJobCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.NEPT.StartNEPTMLModelTransformJobCmdlet"> <summary> Creates a new model transform job. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-model-transform.html">Use a trained model to generate new model artifacts</a>. <para> 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 <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#startmlmodeltransformjob">neptune-db:StartMLModelTransformJob</a> IAM action in that cluster. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.StartNEPTMLModelTransformJobCmdlet.BaseProcessingInstanceType"> <summary> <para> <para>The type of ML instance used in preparing and managing training of ML models. This is an ML compute instance chosen based on memory requirements for processing the training data and model.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.StartNEPTMLModelTransformJobCmdlet.BaseProcessingInstanceVolumeSizeInGB"> <summary> <para> <para>The disk volume size of the training instance in gigabytes. The default is 0. Both input data and the output model are stored on disk, so the volume size must be large enough to hold both data sets. If not specified or 0, Neptune ML selects a disk volume size based on the recommendation generated in the data processing step.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.StartNEPTMLModelTransformJobCmdlet.DataProcessingJobId"> <summary> <para> <para>The job ID of a completed data-processing job. You must include either <c>dataProcessingJobId</c> and a <c>mlModelTrainingJobId</c>, or a <c>trainingJobName</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.StartNEPTMLModelTransformJobCmdlet.Id"> <summary> <para> <para>A unique identifier for the new job. The default is an autogenerated UUID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.StartNEPTMLModelTransformJobCmdlet.MlModelTrainingJobId"> <summary> <para> <para>The job ID of a completed model-training job. You must include either <c>dataProcessingJobId</c> and a <c>mlModelTrainingJobId</c>, or a <c>trainingJobName</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.StartNEPTMLModelTransformJobCmdlet.ModelTransformOutputS3Location"> <summary> <para> <para>The location in Amazon S3 where the model artifacts are to be stored.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.StartNEPTMLModelTransformJobCmdlet.NeptuneIamRoleArn"> <summary> <para> <para>The ARN of an IAM role that provides Neptune access to SageMaker and Amazon S3 resources. This must be listed in your DB cluster parameter group or an error will occur.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.StartNEPTMLModelTransformJobCmdlet.S3OutputEncryptionKMSKey"> <summary> <para> <para>The Amazon Key Management Service (KMS) key that SageMaker uses to encrypt the output of the processing job. The default is none.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.StartNEPTMLModelTransformJobCmdlet.SagemakerIamRoleArn"> <summary> <para> <para>The ARN of an IAM role for SageMaker execution. This must be listed in your DB cluster parameter group or an error will occur.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.StartNEPTMLModelTransformJobCmdlet.SecurityGroupId"> <summary> <para> <para>The VPC security group IDs. The default is None.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.StartNEPTMLModelTransformJobCmdlet.CustomModelTransformParameters_SourceS3DirectoryPath"> <summary> <para> <para>The path to the Amazon S3 location where the Python module implementing your model is located. This must point to a valid existing Amazon S3 location that contains, at a minimum, a training script, a transform script, and a <c>model-hpo-configuration.json</c> file.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.StartNEPTMLModelTransformJobCmdlet.Subnet"> <summary> <para> <para>The IDs of the subnets in the Neptune VPC. The default is None.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.StartNEPTMLModelTransformJobCmdlet.TrainingJobName"> <summary> <para> <para>The name of a completed SageMaker training job. You must include either <c>dataProcessingJobId</c> and a <c>mlModelTrainingJobId</c>, or a <c>trainingJobName</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.StartNEPTMLModelTransformJobCmdlet.CustomModelTransformParameters_TransformEntryPointScript"> <summary> <para> <para>The name of the entry point in your module of a script that should be run after the best model from the hyperparameter search has been identified, to compute the model artifacts necessary for model deployment. It should be able to run with no command-line arguments. The default is <c>transform.py</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.StartNEPTMLModelTransformJobCmdlet.VolumeEncryptionKMSKey"> <summary> <para> <para>The Amazon Key Management Service (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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.StartNEPTMLModelTransformJobCmdlet.Select"> <summary> 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.StartMLModelTransformJobResponse). Specifying the name of a property of type Amazon.Neptunedata.Model.StartMLModelTransformJobResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.StartNEPTMLModelTransformJobCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.NEPT.StopNEPTGremlinQueryCmdlet"> <summary> Cancels a Gremlin query. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-api-status-cancel.html">Gremlin query cancellation</a> for more information. <para> 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 <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#cancelquery">neptune-db:CancelQuery</a> IAM action in that cluster. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.StopNEPTGremlinQueryCmdlet.QueryId"> <summary> <para> <para>The unique identifier that identifies the query to be canceled.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.StopNEPTGremlinQueryCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Status'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Neptunedata.Model.CancelGremlinQueryResponse). Specifying the name of a property of type Amazon.Neptunedata.Model.CancelGremlinQueryResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.StopNEPTGremlinQueryCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.NEPT.StopNEPTLoaderJobCmdlet"> <summary> Cancels a specified load job. This is an HTTP <c>DELETE</c> request. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/load-api-reference-status.htm">Neptune Loader Get-Status API</a> for more information. <para> 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 <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#cancelloaderjob">neptune-db:CancelLoaderJob</a> IAM action in that cluster.. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.StopNEPTLoaderJobCmdlet.LoadId"> <summary> <para> <para>The ID of the load job to be deleted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.StopNEPTLoaderJobCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Status'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Neptunedata.Model.CancelLoaderJobResponse). Specifying the name of a property of type Amazon.Neptunedata.Model.CancelLoaderJobResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.StopNEPTLoaderJobCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.NEPT.StopNEPTMLDataProcessingJobCmdlet"> <summary> Cancels a Neptune ML data processing job. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-dataprocessing.html">The <c>dataprocessing</c> command</a>. <para> 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 <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#cancelmldataprocessingjob">neptune-db:CancelMLDataProcessingJob</a> IAM action in that cluster. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.StopNEPTMLDataProcessingJobCmdlet.Clean"> <summary> <para> <para>If set to <c>TRUE</c>, this flag specifies that all Neptune ML S3 artifacts should be deleted when the job is stopped. The default is <c>FALSE</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.StopNEPTMLDataProcessingJobCmdlet.Id"> <summary> <para> <para>The unique identifier of the data-processing job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.StopNEPTMLDataProcessingJobCmdlet.NeptuneIamRoleArn"> <summary> <para> <para>The ARN of an IAM role that provides Neptune access to SageMaker and Amazon S3 resources. This must be listed in your DB cluster parameter group or an error will occur.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.StopNEPTMLDataProcessingJobCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Status'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Neptunedata.Model.CancelMLDataProcessingJobResponse). Specifying the name of a property of type Amazon.Neptunedata.Model.CancelMLDataProcessingJobResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.StopNEPTMLDataProcessingJobCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.NEPT.StopNEPTMLModelTrainingJobCmdlet"> <summary> Cancels a Neptune ML model training job. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-modeltraining.html">Model training using the <c>modeltraining</c> command</a>. <para> 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 <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#cancelmlmodeltrainingjob">neptune-db:CancelMLModelTrainingJob</a> IAM action in that cluster. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.StopNEPTMLModelTrainingJobCmdlet.Clean"> <summary> <para> <para>If set to <c>TRUE</c>, this flag specifies that all Amazon S3 artifacts should be deleted when the job is stopped. The default is <c>FALSE</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.StopNEPTMLModelTrainingJobCmdlet.Id"> <summary> <para> <para>The unique identifier of the model-training job to be canceled.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.StopNEPTMLModelTrainingJobCmdlet.NeptuneIamRoleArn"> <summary> <para> <para>The ARN of an IAM role that provides Neptune access to SageMaker and Amazon S3 resources. This must be listed in your DB cluster parameter group or an error will occur.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.StopNEPTMLModelTrainingJobCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Status'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Neptunedata.Model.CancelMLModelTrainingJobResponse). Specifying the name of a property of type Amazon.Neptunedata.Model.CancelMLModelTrainingJobResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.StopNEPTMLModelTrainingJobCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.NEPT.StopNEPTMLModelTransformJobCmdlet"> <summary> Cancels a specified model transform job. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-model-transform.html">Use a trained model to generate new model artifacts</a>. <para> 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 <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#cancelmlmodeltransformjob">neptune-db:CancelMLModelTransformJob</a> IAM action in that cluster. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.StopNEPTMLModelTransformJobCmdlet.Clean"> <summary> <para> <para>If this flag is set to <c>TRUE</c>, all Neptune ML S3 artifacts should be deleted when the job is stopped. The default is <c>FALSE</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.StopNEPTMLModelTransformJobCmdlet.Id"> <summary> <para> <para>The unique ID of the model transform job to be canceled.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.StopNEPTMLModelTransformJobCmdlet.NeptuneIamRoleArn"> <summary> <para> <para>The ARN of an IAM role that provides Neptune access to SageMaker and Amazon S3 resources. This must be listed in your DB cluster parameter group or an error will occur.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.StopNEPTMLModelTransformJobCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Status'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Neptunedata.Model.CancelMLModelTransformJobResponse). Specifying the name of a property of type Amazon.Neptunedata.Model.CancelMLModelTransformJobResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.StopNEPTMLModelTransformJobCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.NEPT.StopNEPTOpenCypherQueryCmdlet"> <summary> Cancels a specified openCypher query. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-opencypher-status.html">Neptune openCypher status endpoint</a> for more information. <para> 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 <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#cancelquery">neptune-db:CancelQuery</a> IAM action in that cluster. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.StopNEPTOpenCypherQueryCmdlet.QueryId"> <summary> <para> <para>The unique ID of the openCypher query to cancel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.StopNEPTOpenCypherQueryCmdlet.Silent"> <summary> <para> <para>If set to <c>TRUE</c>, causes the cancelation of the openCypher query to happen silently.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.StopNEPTOpenCypherQueryCmdlet.Select"> <summary> 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.CancelOpenCypherQueryResponse). Specifying the name of a property of type Amazon.Neptunedata.Model.CancelOpenCypherQueryResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.StopNEPTOpenCypherQueryCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.NEPT.UpdateNEPTPropertygraphStatisticCmdlet"> <summary> Manages the generation and use of property graph statistics. <para> 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 <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#managestatistics">neptune-db:ManageStatistics</a> IAM action in that cluster. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.UpdateNEPTPropertygraphStatisticCmdlet.Mode"> <summary> <para> <para>The statistics generation mode. One of: <c>DISABLE_AUTOCOMPUTE</c>, <c>ENABLE_AUTOCOMPUTE</c>, or <c>REFRESH</c>, the last of which manually triggers DFE statistics generation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.UpdateNEPTPropertygraphStatisticCmdlet.Select"> <summary> 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.ManagePropertygraphStatisticsResponse). Specifying the name of a property of type Amazon.Neptunedata.Model.ManagePropertygraphStatisticsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.UpdateNEPTPropertygraphStatisticCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.NEPT.UpdateNEPTSparqlStatisticCmdlet"> <summary> Manages the generation and use of RDF graph statistics. <para> 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 <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#managestatistics">neptune-db:ManageStatistics</a> IAM action in that cluster. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.UpdateNEPTSparqlStatisticCmdlet.Mode"> <summary> <para> <para>The statistics generation mode. One of: <c>DISABLE_AUTOCOMPUTE</c>, <c>ENABLE_AUTOCOMPUTE</c>, or <c>REFRESH</c>, the last of which manually triggers DFE statistics generation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.UpdateNEPTSparqlStatisticCmdlet.Select"> <summary> 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.ManageSparqlStatisticsResponse). Specifying the name of a property of type Amazon.Neptunedata.Model.ManageSparqlStatisticsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NEPT.UpdateNEPTSparqlStatisticCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> </members> </doc> |