AWS.Tools.FinSpaceData.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.FinSpaceData</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.FNSP.GetFNSPChangesetCmdlet"> <summary> Get information about a Changeset. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.GetFNSPChangesetCmdlet.ChangesetId"> <summary> <para> <para>The unique identifier of the Changeset for which to get data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.GetFNSPChangesetCmdlet.DatasetId"> <summary> <para> <para>The unique identifier for the FinSpace Dataset where the Changeset is created.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.GetFNSPChangesetCmdlet.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.FinSpaceData.Model.GetChangesetResponse). Specifying the name of a property of type Amazon.FinSpaceData.Model.GetChangesetResponse 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.FNSP.GetFNSPChangesetCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DatasetId parameter. The -PassThru parameter is deprecated, use -Select '^DatasetId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FNSP.GetFNSPChangesetListCmdlet"> <summary> Lists the FinSpace Changesets for a Dataset. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.GetFNSPChangesetListCmdlet.DatasetId"> <summary> <para> <para>The unique identifier for the FinSpace Dataset to which the Changeset belongs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.GetFNSPChangesetListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results per page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.GetFNSPChangesetListCmdlet.NextToken"> <summary> <para> <para>A token indicating where a results page should begin.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.GetFNSPChangesetListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Changesets'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FinSpaceData.Model.ListChangesetsResponse). Specifying the name of a property of type Amazon.FinSpaceData.Model.ListChangesetsResponse 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.FNSP.GetFNSPChangesetListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DatasetId parameter. The -PassThru parameter is deprecated, use -Select '^DatasetId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FNSP.GetFNSPDatasetCmdlet"> <summary> Returns information about a Dataset. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.GetFNSPDatasetCmdlet.DatasetId"> <summary> <para> <para>The unique identifier for a Dataset.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.GetFNSPDatasetCmdlet.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.FinSpaceData.Model.GetDatasetResponse). Specifying the name of a property of type Amazon.FinSpaceData.Model.GetDatasetResponse 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.FNSP.GetFNSPDatasetCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DatasetId parameter. The -PassThru parameter is deprecated, use -Select '^DatasetId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FNSP.GetFNSPDatasetListCmdlet"> <summary> Lists all of the active Datasets that a user has access to. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.GetFNSPDatasetListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results per page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.GetFNSPDatasetListCmdlet.NextToken"> <summary> <para> <para>A token indicating where a results page should begin.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.GetFNSPDatasetListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Datasets'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FinSpaceData.Model.ListDatasetsResponse). Specifying the name of a property of type Amazon.FinSpaceData.Model.ListDatasetsResponse 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.FNSP.GetFNSPDataViewCmdlet"> <summary> Gets information about a Dataview. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.GetFNSPDataViewCmdlet.DatasetId"> <summary> <para> <para>The unique identifier for the Dataset used in the Dataview.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.GetFNSPDataViewCmdlet.DataViewId"> <summary> <para> <para>The unique identifier for the Dataview.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.GetFNSPDataViewCmdlet.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.FinSpaceData.Model.GetDataViewResponse). Specifying the name of a property of type Amazon.FinSpaceData.Model.GetDataViewResponse 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.FNSP.GetFNSPDataViewCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DatasetId parameter. The -PassThru parameter is deprecated, use -Select '^DatasetId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FNSP.GetFNSPDataViewListCmdlet"> <summary> Lists all available Dataviews for a Dataset. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.GetFNSPDataViewListCmdlet.DatasetId"> <summary> <para> <para>The unique identifier of the Dataset for which to retrieve Dataviews.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.GetFNSPDataViewListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results per page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.GetFNSPDataViewListCmdlet.NextToken"> <summary> <para> <para>A token indicating where a results page should begin.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.GetFNSPDataViewListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DataViews'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FinSpaceData.Model.ListDataViewsResponse). Specifying the name of a property of type Amazon.FinSpaceData.Model.ListDataViewsResponse 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.FNSP.GetFNSPDataViewListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DatasetId parameter. The -PassThru parameter is deprecated, use -Select '^DatasetId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FNSP.GetFNSPProgrammaticAccessCredentialCmdlet"> <summary> Request programmatic credentials to use with FinSpace SDK. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.GetFNSPProgrammaticAccessCredentialCmdlet.DurationInMinute"> <summary> <para> <para>The time duration in which the credentials remain valid. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.GetFNSPProgrammaticAccessCredentialCmdlet.EnvironmentId"> <summary> <para> <para>The FinSpace environment identifier.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.GetFNSPProgrammaticAccessCredentialCmdlet.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.FinSpaceData.Model.GetProgrammaticAccessCredentialsResponse). Specifying the name of a property of type Amazon.FinSpaceData.Model.GetProgrammaticAccessCredentialsResponse 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.FNSP.GetFNSPProgrammaticAccessCredentialCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the EnvironmentId parameter. The -PassThru parameter is deprecated, use -Select '^EnvironmentId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FNSP.GetFNSPWorkingLocationCmdlet"> <summary> A temporary Amazon S3 location, where you can copy your files from a source location to stage or use as a scratch space in FinSpace notebook. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.GetFNSPWorkingLocationCmdlet.LocationType"> <summary> <para> <para>Specify the type of the working location.</para><ul><li><para><code>SAGEMAKER</code> - Use the Amazon S3 location as a temporary location to store data content when working with FinSpace Notebooks that run on SageMaker studio.</para></li><li><para><code>INGESTION</code> - Use the Amazon S3 location as a staging location to copy your data content and then use the location with the Changeset creation operation.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.GetFNSPWorkingLocationCmdlet.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.FinSpaceData.Model.GetWorkingLocationResponse). Specifying the name of a property of type Amazon.FinSpaceData.Model.GetWorkingLocationResponse 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.FNSP.GetFNSPWorkingLocationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the LocationType parameter. The -PassThru parameter is deprecated, use -Select '^LocationType' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FNSP.NewFNSPChangesetCmdlet"> <summary> Creates a new Changeset in a FinSpace Dataset. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.NewFNSPChangesetCmdlet.ChangeType"> <summary> <para> <para>Option to indicate how a Changeset will be applied to a Dataset.</para><ul><li><para><code>REPLACE</code> - Changeset will be considered as a replacement to all prior loaded Changesets.</para></li><li><para><code>APPEND</code> - Changeset will be considered as an addition to the end of all prior loaded Changesets.</para></li><li><para><code>MODIFY</code> - Changeset is considered as a replacement to a specific prior ingested Changeset.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.NewFNSPChangesetCmdlet.DatasetId"> <summary> <para> <para>The unique identifier for the FinSpace Dataset where the Changeset will be created. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.NewFNSPChangesetCmdlet.FormatParam"> <summary> <para> <para>Options that define the structure of the source file(s) including the format type (<code>formatType</code>), header row (<code>withHeader</code>), data separation character (<code>separator</code>) and the type of compression (<code>compression</code>). </para><para><code>formatType</code> is a required attribute and can have the following values: </para><ul><li><para><code>PARQUET</code> - Parquet source file format.</para></li><li><para><code>CSV</code> - CSV source file format.</para></li><li><para><code>JSON</code> - JSON source file format.</para></li><li><para><code>XML</code> - XML source file format.</para></li></ul><para>Here is an example of how you could specify the <code>formatParams</code>:</para><para><code> "formatParams": { "formatType": "CSV", "withHeader": "true", "separator": ",", "compression":"None" } </code></para><para>Note that if you only provide <code>formatType</code> as <code>CSV</code>, the rest of the attributes will automatically default to CSV values as following:</para><para><code> { "withHeader": "true", "separator": "," } </code></para><para> For more information about supported file formats, see <a href="https://docs.aws.amazon.com/finspace/latest/userguide/supported-data-types.html">Supported Data Types and File Formats</a> in the FinSpace User Guide.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.NewFNSPChangesetCmdlet.SourceParam"> <summary> <para> <para>Options that define the location of the data being ingested (<code>s3SourcePath</code>) and the source of the changeset (<code>sourceType</code>).</para><para>Both <code>s3SourcePath</code> and <code>sourceType</code> are required attributes.</para><para>Here is an example of how you could specify the <code>sourceParams</code>:</para><para><code> "sourceParams": { "s3SourcePath": "s3://finspace-landing-us-east-2-bk7gcfvitndqa6ebnvys4d/scratch/wr5hh8pwkpqqkxa4sxrmcw/ingestion/equity.csv", "sourceType": "S3" } </code></para><para>The S3 path that you specify must allow the FinSpace role access. To do that, you first need to configure the IAM policy on S3 bucket. For more information, see <a href="https://docs.aws.amazon.com/finspace/latest/data-api/fs-using-the-finspace-api.html#access-s3-buckets">Loading data from an Amazon S3 Bucket using the FinSpace API</a>section.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.NewFNSPChangesetCmdlet.ClientToken"> <summary> <para> <para>A token that ensures idempotency. This token expires in 10 minutes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.NewFNSPChangesetCmdlet.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.FinSpaceData.Model.CreateChangesetResponse). Specifying the name of a property of type Amazon.FinSpaceData.Model.CreateChangesetResponse 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.FNSP.NewFNSPChangesetCmdlet.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.FNSP.NewFNSPDatasetCmdlet"> <summary> Creates a new FinSpace Dataset. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.NewFNSPDatasetCmdlet.Alias"> <summary> <para> <para>The unique resource identifier for a Dataset.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.NewFNSPDatasetCmdlet.TabularSchemaConfig_Column"> <summary> <para> <para>List of column definitions.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.NewFNSPDatasetCmdlet.DatasetDescription"> <summary> <para> <para>Description of a Dataset.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.NewFNSPDatasetCmdlet.PermissionGroupParams_DatasetPermission"> <summary> <para> <para>List of resource permissions.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.NewFNSPDatasetCmdlet.DatasetTitle"> <summary> <para> <para>Display title for a FinSpace Dataset.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.NewFNSPDatasetCmdlet.OwnerInfo_Email"> <summary> <para> <para>Email address for the Dataset owner.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.NewFNSPDatasetCmdlet.Kind"> <summary> <para> <para>The format in which Dataset data is structured.</para><ul><li><para><code>TABULAR</code> - Data is structured in a tabular format.</para></li><li><para><code>NON_TABULAR</code> - Data is structured in a non-tabular format.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.NewFNSPDatasetCmdlet.OwnerInfo_Name"> <summary> <para> <para>Name of the Dataset owner.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.NewFNSPDatasetCmdlet.PermissionGroupParams_PermissionGroupId"> <summary> <para> <para>The unique identifier of the PermissionGroup.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.NewFNSPDatasetCmdlet.OwnerInfo_PhoneNumber"> <summary> <para> <para>Phone number for the Dataset owner.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.NewFNSPDatasetCmdlet.TabularSchemaConfig_PrimaryKeyColumn"> <summary> <para> <para>List of column names used for primary key.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.NewFNSPDatasetCmdlet.ClientToken"> <summary> <para> <para>A token that ensures idempotency. This token expires in 10 minutes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.NewFNSPDatasetCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DatasetId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FinSpaceData.Model.CreateDatasetResponse). Specifying the name of a property of type Amazon.FinSpaceData.Model.CreateDatasetResponse 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.FNSP.NewFNSPDatasetCmdlet.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.FNSP.NewFNSPDataViewCmdlet"> <summary> Creates a Dataview for a Dataset. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.NewFNSPDataViewCmdlet.AsOfTimestamp"> <summary> <para> <para>Beginning time to use for the Dataview. The value is determined as Epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.NewFNSPDataViewCmdlet.AutoUpdate"> <summary> <para> <para>Flag to indicate Dataview should be updated automatically.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.NewFNSPDataViewCmdlet.DatasetId"> <summary> <para> <para>The unique Dataset identifier that is used to create a Dataview.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.NewFNSPDataViewCmdlet.DestinationTypeParams_DestinationType"> <summary> <para> <para>Destination type for a Dataview.</para><ul><li><para><code>GLUE_TABLE</code> - Glue table destination type.</para></li><li><para><code>S3</code> - S3 destination type.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.NewFNSPDataViewCmdlet.PartitionColumn"> <summary> <para> <para>Ordered set of column names used to partition data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.NewFNSPDataViewCmdlet.DestinationTypeParams_S3DestinationExportFileFormat"> <summary> <para> <para>Data view export file format.</para><ul><li><para><code>PARQUET</code> - Parquet export file format.</para></li><li><para><code>DELIMITED_TEXT</code> - Delimited text export file format.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.NewFNSPDataViewCmdlet.DestinationTypeParams_S3DestinationExportFileFormatOption"> <summary> <para> <para>Format Options for S3 Destination type.</para><para>Here is an example of how you could specify the <code>s3DestinationExportFileFormatOptions</code></para><para><code> { "header": "true", "delimiter": ",", "compression": "gzip" }</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.NewFNSPDataViewCmdlet.SortColumn"> <summary> <para> <para>Columns to be used for sorting the data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.NewFNSPDataViewCmdlet.ClientToken"> <summary> <para> <para>A token that ensures idempotency. This token expires in 10 minutes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.NewFNSPDataViewCmdlet.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.FinSpaceData.Model.CreateDataViewResponse). Specifying the name of a property of type Amazon.FinSpaceData.Model.CreateDataViewResponse 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.FNSP.NewFNSPDataViewCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DatasetId parameter. The -PassThru parameter is deprecated, use -Select '^DatasetId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.NewFNSPDataViewCmdlet.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.FNSP.RemoveFNSPDatasetCmdlet"> <summary> Deletes a FinSpace Dataset. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.RemoveFNSPDatasetCmdlet.DatasetId"> <summary> <para> <para>The unique identifier of the Dataset to be deleted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.RemoveFNSPDatasetCmdlet.ClientToken"> <summary> <para> <para>A token that ensures idempotency. This token expires in 10 minutes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.RemoveFNSPDatasetCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DatasetId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FinSpaceData.Model.DeleteDatasetResponse). Specifying the name of a property of type Amazon.FinSpaceData.Model.DeleteDatasetResponse 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.FNSP.RemoveFNSPDatasetCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DatasetId parameter. The -PassThru parameter is deprecated, use -Select '^DatasetId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.RemoveFNSPDatasetCmdlet.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.FNSP.UpdateFNSPChangesetCmdlet"> <summary> Updates a FinSpace Changeset. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.UpdateFNSPChangesetCmdlet.ChangesetId"> <summary> <para> <para>The unique identifier for the Changeset to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.UpdateFNSPChangesetCmdlet.DatasetId"> <summary> <para> <para>The unique identifier for the FinSpace Dataset in which the Changeset is created.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.UpdateFNSPChangesetCmdlet.FormatParam"> <summary> <para> <para>Options that define the structure of the source file(s) including the format type (<code>formatType</code>), header row (<code>withHeader</code>), data separation character (<code>separator</code>) and the type of compression (<code>compression</code>). </para><para><code>formatType</code> is a required attribute and can have the following values: </para><ul><li><para><code>PARQUET</code> - Parquet source file format.</para></li><li><para><code>CSV</code> - CSV source file format.</para></li><li><para><code>JSON</code> - JSON source file format.</para></li><li><para><code>XML</code> - XML source file format.</para></li></ul><para>Here is an example of how you could specify the <code>formatParams</code>:</para><para><code> "formatParams": { "formatType": "CSV", "withHeader": "true", "separator": ",", "compression":"None" } </code></para><para>Note that if you only provide <code>formatType</code> as <code>CSV</code>, the rest of the attributes will automatically default to CSV values as following:</para><para><code> { "withHeader": "true", "separator": "," } </code></para><para> For more information about supported file formats, see <a href="https://docs.aws.amazon.com/finspace/latest/userguide/supported-data-types.html">Supported Data Types and File Formats</a> in the FinSpace User Guide.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.UpdateFNSPChangesetCmdlet.SourceParam"> <summary> <para> <para>Options that define the location of the data being ingested (<code>s3SourcePath</code>) and the source of the changeset (<code>sourceType</code>).</para><para>Both <code>s3SourcePath</code> and <code>sourceType</code> are required attributes.</para><para>Here is an example of how you could specify the <code>sourceParams</code>:</para><para><code> "sourceParams": { "s3SourcePath": "s3://finspace-landing-us-east-2-bk7gcfvitndqa6ebnvys4d/scratch/wr5hh8pwkpqqkxa4sxrmcw/ingestion/equity.csv", "sourceType": "S3" } </code></para><para>The S3 path that you specify must allow the FinSpace role access. To do that, you first need to configure the IAM policy on S3 bucket. For more information, see <a href="https://docs.aws.amazon.com/finspace/latest/data-api/fs-using-the-finspace-api.html#access-s3-buckets">Loading data from an Amazon S3 Bucket using the FinSpace API</a>section.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.UpdateFNSPChangesetCmdlet.ClientToken"> <summary> <para> <para>A token that ensures idempotency. This token expires in 10 minutes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.UpdateFNSPChangesetCmdlet.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.FinSpaceData.Model.UpdateChangesetResponse). Specifying the name of a property of type Amazon.FinSpaceData.Model.UpdateChangesetResponse 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.FNSP.UpdateFNSPChangesetCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DatasetId parameter. The -PassThru parameter is deprecated, use -Select '^DatasetId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.UpdateFNSPChangesetCmdlet.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.FNSP.UpdateFNSPDatasetCmdlet"> <summary> Updates a FinSpace Dataset. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.UpdateFNSPDatasetCmdlet.Alias"> <summary> <para> <para>The unique resource identifier for a Dataset.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.UpdateFNSPDatasetCmdlet.TabularSchemaConfig_Column"> <summary> <para> <para>List of column definitions.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.UpdateFNSPDatasetCmdlet.DatasetDescription"> <summary> <para> <para>A description for the Dataset.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.UpdateFNSPDatasetCmdlet.DatasetId"> <summary> <para> <para>The unique identifier for the Dataset to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.UpdateFNSPDatasetCmdlet.DatasetTitle"> <summary> <para> <para>A display title for the Dataset.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.UpdateFNSPDatasetCmdlet.Kind"> <summary> <para> <para>The format in which the Dataset data is structured.</para><ul><li><para><code>TABULAR</code> - Data is structured in a tabular format.</para></li><li><para><code>NON_TABULAR</code> - Data is structured in a non-tabular format.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.UpdateFNSPDatasetCmdlet.TabularSchemaConfig_PrimaryKeyColumn"> <summary> <para> <para>List of column names used for primary key.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.UpdateFNSPDatasetCmdlet.ClientToken"> <summary> <para> <para>A token that ensures idempotency. This token expires in 10 minutes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.UpdateFNSPDatasetCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DatasetId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FinSpaceData.Model.UpdateDatasetResponse). Specifying the name of a property of type Amazon.FinSpaceData.Model.UpdateDatasetResponse 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.FNSP.UpdateFNSPDatasetCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DatasetId parameter. The -PassThru parameter is deprecated, use -Select '^DatasetId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.UpdateFNSPDatasetCmdlet.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> |