AWS.Tools.FinSpaceData.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.FinSpaceData</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.FNSP.AddFNSPUserToPermissionGroupCmdlet"> <summary> Adds a user to a permission group to grant permissions for actions a user can perform in FinSpace.<br/><br/>This operation is deprecated. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.AddFNSPUserToPermissionGroupCmdlet.PermissionGroupId"> <summary> <para> <para>The unique identifier for the permission group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.AddFNSPUserToPermissionGroupCmdlet.UserId"> <summary> <para> <para>The unique identifier for the user.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.AddFNSPUserToPermissionGroupCmdlet.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.AddFNSPUserToPermissionGroupCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'StatusCode'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FinSpaceData.Model.AssociateUserToPermissionGroupResponse). Specifying the name of a property of type Amazon.FinSpaceData.Model.AssociateUserToPermissionGroupResponse 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.AddFNSPUserToPermissionGroupCmdlet.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.DisableFNSPUserCmdlet"> <summary> Denies access to the FinSpace web application and API for the specified user.<br/><br/>This operation is deprecated. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.DisableFNSPUserCmdlet.UserId"> <summary> <para> <para>The unique identifier for the user that you want to deactivate.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.DisableFNSPUserCmdlet.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.DisableFNSPUserCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'UserId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FinSpaceData.Model.DisableUserResponse). Specifying the name of a property of type Amazon.FinSpaceData.Model.DisableUserResponse 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.DisableFNSPUserCmdlet.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.EnableFNSPUserCmdlet"> <summary> Allows the specified user to access the FinSpace web application and API.<br/><br/>This operation is deprecated. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.EnableFNSPUserCmdlet.UserId"> <summary> <para> <para>The unique identifier for the user that you want to activate.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.EnableFNSPUserCmdlet.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.EnableFNSPUserCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'UserId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FinSpaceData.Model.EnableUserResponse). Specifying the name of a property of type Amazon.FinSpaceData.Model.EnableUserResponse 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.EnableFNSPUserCmdlet.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.GetFNSPChangesetCmdlet"> <summary> Get information about a Changeset.<br/><br/>This operation is deprecated. </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="T:Amazon.PowerShell.Cmdlets.FNSP.GetFNSPChangesetListCmdlet"> <summary> Lists the FinSpace Changesets for a Dataset.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. This cmdlet didn't autopaginate in V4, auto-pagination support was added in V5.<br/><br/>This operation is deprecated. </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> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.GetFNSPChangesetListCmdlet.NextToken"> <summary> <para> <para>A token that indicates where a results page should begin.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </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.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. This cmdlet didn't autopaginate in V4. To preserve the V4 autopagination behavior for all cmdlets, run Set-AWSAutoIterationMode -IterationMode v4. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FNSP.GetFNSPDatasetCmdlet"> <summary> Returns information about a Dataset.<br/><br/>This operation is deprecated. </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="T:Amazon.PowerShell.Cmdlets.FNSP.GetFNSPDatasetListCmdlet"> <summary> Lists all of the active Datasets that a user has access to.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. This cmdlet didn't autopaginate in V4, auto-pagination support was added in V5.<br/><br/>This operation is deprecated. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.GetFNSPDatasetListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results per page.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.GetFNSPDatasetListCmdlet.NextToken"> <summary> <para> <para>A token that indicates where a results page should begin.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </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="P:Amazon.PowerShell.Cmdlets.FNSP.GetFNSPDatasetListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. This cmdlet didn't autopaginate in V4. To preserve the V4 autopagination behavior for all cmdlets, run Set-AWSAutoIterationMode -IterationMode v4. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FNSP.GetFNSPDataViewCmdlet"> <summary> Gets information about a Dataview.<br/><br/>This operation is deprecated. </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="T:Amazon.PowerShell.Cmdlets.FNSP.GetFNSPDataViewListCmdlet"> <summary> Lists all available Dataviews for a Dataset.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. This cmdlet didn't autopaginate in V4, auto-pagination support was added in V5.<br/><br/>This operation is deprecated. </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> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.GetFNSPDataViewListCmdlet.NextToken"> <summary> <para> <para>A token that indicates where a results page should begin.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </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.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. This cmdlet didn't autopaginate in V4. To preserve the V4 autopagination behavior for all cmdlets, run Set-AWSAutoIterationMode -IterationMode v4. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FNSP.GetFNSPExternalDataViewAccessDetailCmdlet"> <summary> Returns the credentials to access the external Dataview from an S3 location. To call this API: <ul><li><para> You must retrieve the programmatic credentials. </para></li><li><para> You must be a member of a FinSpace user group, where the dataset that you want to access has <c>Read Dataset Data</c> permissions. </para></li></ul><br/><br/>This operation is deprecated. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.GetFNSPExternalDataViewAccessDetailCmdlet.DatasetId"> <summary> <para> <para>The unique identifier for the Dataset.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.GetFNSPExternalDataViewAccessDetailCmdlet.DataViewId"> <summary> <para> <para>The unique identifier for the Dataview that you want to access.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.GetFNSPExternalDataViewAccessDetailCmdlet.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.GetExternalDataViewAccessDetailsResponse). Specifying the name of a property of type Amazon.FinSpaceData.Model.GetExternalDataViewAccessDetailsResponse 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.GetFNSPPermissionGroupCmdlet"> <summary> Retrieves the details of a specific permission group.<br/><br/>This operation is deprecated. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.GetFNSPPermissionGroupCmdlet.PermissionGroupId"> <summary> <para> <para>The unique identifier for the permission group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.GetFNSPPermissionGroupCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'PermissionGroup'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FinSpaceData.Model.GetPermissionGroupResponse). Specifying the name of a property of type Amazon.FinSpaceData.Model.GetPermissionGroupResponse 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.GetFNSPPermissionGroupListCmdlet"> <summary> Lists all available permission groups in FinSpace.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. This cmdlet didn't autopaginate in V4, auto-pagination support was added in V5.<br/><br/>This operation is deprecated. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.GetFNSPPermissionGroupListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results per page.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>100</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.GetFNSPPermissionGroupListCmdlet.NextToken"> <summary> <para> <para>A token that indicates where a results page should begin.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.GetFNSPPermissionGroupListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'PermissionGroups'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FinSpaceData.Model.ListPermissionGroupsResponse). Specifying the name of a property of type Amazon.FinSpaceData.Model.ListPermissionGroupsResponse 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.GetFNSPPermissionGroupListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. This cmdlet didn't autopaginate in V4. To preserve the V4 autopagination behavior for all cmdlets, run Set-AWSAutoIterationMode -IterationMode v4. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FNSP.GetFNSPPermissionGroupsByUserListCmdlet"> <summary> Lists all the permission groups that are associated with a specific user.<br/><br/>This operation is deprecated. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.GetFNSPPermissionGroupsByUserListCmdlet.UserId"> <summary> <para> <para>The unique identifier for the user.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.GetFNSPPermissionGroupsByUserListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results per page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.GetFNSPPermissionGroupsByUserListCmdlet.NextToken"> <summary> <para> <para>A token that indicates where a results page should begin.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.GetFNSPPermissionGroupsByUserListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'PermissionGroups'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FinSpaceData.Model.ListPermissionGroupsByUserResponse). Specifying the name of a property of type Amazon.FinSpaceData.Model.ListPermissionGroupsByUserResponse 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.GetFNSPProgrammaticAccessCredentialCmdlet"> <summary> Request programmatic credentials to use with FinSpace SDK. For more information, see <a href="https://docs.aws.amazon.com/finspace/latest/data-api/fs-using-the-finspace-api.html#accessing-credentials">Step 2. Access credentials programmatically using IAM access key id and secret access key</a>.<br/><br/>This operation is deprecated. </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="T:Amazon.PowerShell.Cmdlets.FNSP.GetFNSPUserCmdlet"> <summary> Retrieves details for a specific user.<br/><br/>This operation is deprecated. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.GetFNSPUserCmdlet.UserId"> <summary> <para> <para>The unique identifier of the user to get data for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.GetFNSPUserCmdlet.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.GetUserResponse). Specifying the name of a property of type Amazon.FinSpaceData.Model.GetUserResponse 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.GetFNSPUserListCmdlet"> <summary> Lists all available users in FinSpace.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. This cmdlet didn't autopaginate in V4, auto-pagination support was added in V5.<br/><br/>This operation is deprecated. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.GetFNSPUserListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results per page.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>100</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.GetFNSPUserListCmdlet.NextToken"> <summary> <para> <para>A token that indicates where a results page should begin.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.GetFNSPUserListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Users'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FinSpaceData.Model.ListUsersResponse). Specifying the name of a property of type Amazon.FinSpaceData.Model.ListUsersResponse 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.GetFNSPUserListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. This cmdlet didn't autopaginate in V4. To preserve the V4 autopagination behavior for all cmdlets, run Set-AWSAutoIterationMode -IterationMode v4. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FNSP.GetFNSPUsersByPermissionGroupListCmdlet"> <summary> Lists details of all the users in a specific permission group.<br/><br/>This operation is deprecated. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.GetFNSPUsersByPermissionGroupListCmdlet.PermissionGroupId"> <summary> <para> <para>The unique identifier for the permission group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.GetFNSPUsersByPermissionGroupListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results per page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.GetFNSPUsersByPermissionGroupListCmdlet.NextToken"> <summary> <para> <para>A token that indicates where a results page should begin.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.GetFNSPUsersByPermissionGroupListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Users'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FinSpaceData.Model.ListUsersByPermissionGroupResponse). Specifying the name of a property of type Amazon.FinSpaceData.Model.ListUsersByPermissionGroupResponse 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.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.<br/><br/>This operation is deprecated. </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><c>SAGEMAKER</c> – 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><c>INGESTION</c> – 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="T:Amazon.PowerShell.Cmdlets.FNSP.NewFNSPChangesetCmdlet"> <summary> Creates a new Changeset in a FinSpace Dataset.<br/><br/>This operation is deprecated. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.NewFNSPChangesetCmdlet.ChangeType"> <summary> <para> <para>The option to indicate how a Changeset will be applied to a Dataset.</para><ul><li><para><c>REPLACE</c> – Changeset will be considered as a replacement to all prior loaded Changesets.</para></li><li><para><c>APPEND</c> – Changeset will be considered as an addition to the end of all prior loaded Changesets.</para></li><li><para><c>MODIFY</c> – 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 (<c>formatType</c>), header row (<c>withHeader</c>), data separation character (<c>separator</c>) and the type of compression (<c>compression</c>). </para><para><c>formatType</c> is a required attribute and can have the following values: </para><ul><li><para><c>PARQUET</c> – Parquet source file format.</para></li><li><para><c>CSV</c> – CSV source file format.</para></li><li><para><c>JSON</c> – JSON source file format.</para></li><li><para><c>XML</c> – XML source file format.</para></li></ul><para>Here is an example of how you could specify the <c>formatParams</c>:</para><para><c> "formatParams": { "formatType": "CSV", "withHeader": "true", "separator": ",", "compression":"None" } </c></para><para>Note that if you only provide <c>formatType</c> as <c>CSV</c>, the rest of the attributes will automatically default to CSV values as following:</para><para><c> { "withHeader": "true", "separator": "," } </c></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 (<c>s3SourcePath</c>) and the source of the changeset (<c>sourceType</c>).</para><para>Both <c>s3SourcePath</c> and <c>sourceType</c> are required attributes.</para><para>Here is an example of how you could specify the <c>sourceParams</c>:</para><para><c> "sourceParams": { "s3SourcePath": "s3://finspace-landing-us-east-2-bk7gcfvitndqa6ebnvys4d/scratch/wr5hh8pwkpqqkxa4sxrmcw/ingestion/equity.csv", "sourceType": "S3" } </c></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.<br/><br/>This operation is deprecated. </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><c>TABULAR</c> – Data is structured in a tabular format.</para></li><li><para><c>NON_TABULAR</c> – 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>The 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 for the <c>PermissionGroup</c>.</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.<br/><br/>This operation is deprecated. </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><c>GLUE_TABLE</c> – Glue table destination type.</para></li><li><para><c>S3</c> – 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>Dataview export file format.</para><ul><li><para><c>PARQUET</c> – Parquet export file format.</para></li><li><para><c>DELIMITED_TEXT</c> – 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 <c>s3DestinationExportFileFormatOptions</c></para><para><c> { "header": "true", "delimiter": ",", "compression": "gzip" }</c></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.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.NewFNSPPermissionGroupCmdlet"> <summary> Creates a group of permissions for various actions that a user can perform in FinSpace.<br/><br/>This operation is deprecated. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.NewFNSPPermissionGroupCmdlet.ApplicationPermission"> <summary> <para> <para>The option to indicate FinSpace application permissions that are granted to a specific group.</para><important><para>When assigning application permissions, be aware that the permission <c>ManageUsersAndGroups</c> allows users to grant themselves or others access to any functionality in their FinSpace environment's application. It should only be granted to trusted users.</para></important><ul><li><para><c>CreateDataset</c> – Group members can create new datasets.</para></li><li><para><c>ManageClusters</c> – Group members can manage Apache Spark clusters from FinSpace notebooks.</para></li><li><para><c>ManageUsersAndGroups</c> – Group members can manage users and permission groups. This is a privileged permission that allows users to grant themselves or others access to any functionality in the application. It should only be granted to trusted users.</para></li><li><para><c>ManageAttributeSets</c> – Group members can manage attribute sets.</para></li><li><para><c>ViewAuditData</c> – Group members can view audit data.</para></li><li><para><c>AccessNotebooks</c> – Group members will have access to FinSpace notebooks.</para></li><li><para><c>GetTemporaryCredentials</c> – Group members can get temporary API credentials.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.NewFNSPPermissionGroupCmdlet.Description"> <summary> <para> <para>A brief description for the permission group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.NewFNSPPermissionGroupCmdlet.Name"> <summary> <para> <para>The name of the permission group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.NewFNSPPermissionGroupCmdlet.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.NewFNSPPermissionGroupCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'PermissionGroupId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FinSpaceData.Model.CreatePermissionGroupResponse). Specifying the name of a property of type Amazon.FinSpaceData.Model.CreatePermissionGroupResponse 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.NewFNSPPermissionGroupCmdlet.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.NewFNSPUserCmdlet"> <summary> Creates a new user in FinSpace.<br/><br/>This operation is deprecated. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.NewFNSPUserCmdlet.ApiAccess"> <summary> <para> <para>The option to indicate whether the user can use the <c>GetProgrammaticAccessCredentials</c> API to obtain credentials that can then be used to access other FinSpace Data API operations.</para><ul><li><para><c>ENABLED</c> – The user has permissions to use the APIs.</para></li><li><para><c>DISABLED</c> – The user does not have permissions to use any APIs.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.NewFNSPUserCmdlet.ApiAccessPrincipalArn"> <summary> <para> <para>The ARN identifier of an AWS user or role that is allowed to call the <c>GetProgrammaticAccessCredentials</c> API to obtain a credentials token for a specific FinSpace user. This must be an IAM role within your FinSpace account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.NewFNSPUserCmdlet.EmailAddress"> <summary> <para> <para>The email address of the user that you want to register. The email address serves as a uniquer identifier for each user and cannot be changed after it's created.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.NewFNSPUserCmdlet.FirstName"> <summary> <para> <para>The first name of the user that you want to register.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.NewFNSPUserCmdlet.LastName"> <summary> <para> <para>The last name of the user that you want to register.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.NewFNSPUserCmdlet.Type"> <summary> <para> <para>The option to indicate the type of user. Use one of the following options to specify this parameter:</para><ul><li><para><c>SUPER_USER</c> – A user with permission to all the functionality and data in FinSpace.</para></li><li><para><c>APP_USER</c> – A user with specific permissions in FinSpace. The users are assigned permissions by adding them to a permission group.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.NewFNSPUserCmdlet.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.NewFNSPUserCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'UserId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FinSpaceData.Model.CreateUserResponse). Specifying the name of a property of type Amazon.FinSpaceData.Model.CreateUserResponse 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.NewFNSPUserCmdlet.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.<br/><br/>This operation is deprecated. </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.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.RemoveFNSPPermissionGroupCmdlet"> <summary> Deletes a permission group. This action is irreversible.<br/><br/>This operation is deprecated. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.RemoveFNSPPermissionGroupCmdlet.PermissionGroupId"> <summary> <para> <para>The unique identifier for the permission group that you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.RemoveFNSPPermissionGroupCmdlet.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.RemoveFNSPPermissionGroupCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'PermissionGroupId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FinSpaceData.Model.DeletePermissionGroupResponse). Specifying the name of a property of type Amazon.FinSpaceData.Model.DeletePermissionGroupResponse 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.RemoveFNSPPermissionGroupCmdlet.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.RemoveFNSPUserFromPermissionGroupCmdlet"> <summary> Removes a user from a permission group.<br/><br/>This operation is deprecated. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.RemoveFNSPUserFromPermissionGroupCmdlet.PermissionGroupId"> <summary> <para> <para>The unique identifier for the permission group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.RemoveFNSPUserFromPermissionGroupCmdlet.UserId"> <summary> <para> <para>The unique identifier for the user.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.RemoveFNSPUserFromPermissionGroupCmdlet.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.RemoveFNSPUserFromPermissionGroupCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'StatusCode'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FinSpaceData.Model.DisassociateUserFromPermissionGroupResponse). Specifying the name of a property of type Amazon.FinSpaceData.Model.DisassociateUserFromPermissionGroupResponse 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.RemoveFNSPUserFromPermissionGroupCmdlet.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.ResetFNSPUserPasswordCmdlet"> <summary> Resets the password for a specified user ID and generates a temporary one. Only a superuser can reset password for other users. Resetting the password immediately invalidates the previous password associated with the user.<br/><br/>This operation is deprecated. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.ResetFNSPUserPasswordCmdlet.UserId"> <summary> <para> <para>The unique identifier of the user that a temporary password is requested for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.ResetFNSPUserPasswordCmdlet.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.ResetFNSPUserPasswordCmdlet.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.ResetUserPasswordResponse). Specifying the name of a property of type Amazon.FinSpaceData.Model.ResetUserPasswordResponse 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.ResetFNSPUserPasswordCmdlet.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.<br/><br/>This operation is deprecated. </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 (<c>formatType</c>), header row (<c>withHeader</c>), data separation character (<c>separator</c>) and the type of compression (<c>compression</c>). </para><para><c>formatType</c> is a required attribute and can have the following values: </para><ul><li><para><c>PARQUET</c> – Parquet source file format.</para></li><li><para><c>CSV</c> – CSV source file format.</para></li><li><para><c>JSON</c> – JSON source file format.</para></li><li><para><c>XML</c> – XML source file format.</para></li></ul><para>Here is an example of how you could specify the <c>formatParams</c>:</para><para><c> "formatParams": { "formatType": "CSV", "withHeader": "true", "separator": ",", "compression":"None" } </c></para><para>Note that if you only provide <c>formatType</c> as <c>CSV</c>, the rest of the attributes will automatically default to CSV values as following:</para><para><c> { "withHeader": "true", "separator": "," } </c></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 (<c>s3SourcePath</c>) and the source of the changeset (<c>sourceType</c>).</para><para>Both <c>s3SourcePath</c> and <c>sourceType</c> are required attributes.</para><para>Here is an example of how you could specify the <c>sourceParams</c>:</para><para><c> "sourceParams": { "s3SourcePath": "s3://finspace-landing-us-east-2-bk7gcfvitndqa6ebnvys4d/scratch/wr5hh8pwkpqqkxa4sxrmcw/ingestion/equity.csv", "sourceType": "S3" } </c></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.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.<br/><br/>This operation is deprecated. </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><c>TABULAR</c> – Data is structured in a tabular format.</para></li><li><para><c>NON_TABULAR</c> – 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.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.UpdateFNSPPermissionGroupCmdlet"> <summary> Modifies the details of a permission group. You cannot modify a <c>permissionGroupID</c>.<br/><br/>This operation is deprecated. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.UpdateFNSPPermissionGroupCmdlet.ApplicationPermission"> <summary> <para> <para>The permissions that are granted to a specific group for accessing the FinSpace application.</para><important><para>When assigning application permissions, be aware that the permission <c>ManageUsersAndGroups</c> allows users to grant themselves or others access to any functionality in their FinSpace environment's application. It should only be granted to trusted users.</para></important><ul><li><para><c>CreateDataset</c> – Group members can create new datasets.</para></li><li><para><c>ManageClusters</c> – Group members can manage Apache Spark clusters from FinSpace notebooks.</para></li><li><para><c>ManageUsersAndGroups</c> – Group members can manage users and permission groups. This is a privileged permission that allows users to grant themselves or others access to any functionality in the application. It should only be granted to trusted users.</para></li><li><para><c>ManageAttributeSets</c> – Group members can manage attribute sets.</para></li><li><para><c>ViewAuditData</c> – Group members can view audit data.</para></li><li><para><c>AccessNotebooks</c> – Group members will have access to FinSpace notebooks.</para></li><li><para><c>GetTemporaryCredentials</c> – Group members can get temporary API credentials.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.UpdateFNSPPermissionGroupCmdlet.Description"> <summary> <para> <para>A brief description for the permission group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.UpdateFNSPPermissionGroupCmdlet.Name"> <summary> <para> <para>The name of the permission group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.UpdateFNSPPermissionGroupCmdlet.PermissionGroupId"> <summary> <para> <para>The unique identifier for the permission group to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.UpdateFNSPPermissionGroupCmdlet.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.UpdateFNSPPermissionGroupCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'PermissionGroupId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FinSpaceData.Model.UpdatePermissionGroupResponse). Specifying the name of a property of type Amazon.FinSpaceData.Model.UpdatePermissionGroupResponse 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.UpdateFNSPPermissionGroupCmdlet.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.UpdateFNSPUserCmdlet"> <summary> Modifies the details of the specified user. You cannot update the <c>userId</c> for a user.<br/><br/>This operation is deprecated. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.UpdateFNSPUserCmdlet.ApiAccess"> <summary> <para> <para>The option to indicate whether the user can use the <c>GetProgrammaticAccessCredentials</c> API to obtain credentials that can then be used to access other FinSpace Data API operations.</para><ul><li><para><c>ENABLED</c> – The user has permissions to use the APIs.</para></li><li><para><c>DISABLED</c> – The user does not have permissions to use any APIs.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.UpdateFNSPUserCmdlet.ApiAccessPrincipalArn"> <summary> <para> <para>The ARN identifier of an AWS user or role that is allowed to call the <c>GetProgrammaticAccessCredentials</c> API to obtain a credentials token for a specific FinSpace user. This must be an IAM role within your FinSpace account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.UpdateFNSPUserCmdlet.FirstName"> <summary> <para> <para>The first name of the user.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.UpdateFNSPUserCmdlet.LastName"> <summary> <para> <para>The last name of the user.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.UpdateFNSPUserCmdlet.Type"> <summary> <para> <para>The option to indicate the type of user.</para><ul><li><para><c>SUPER_USER</c>– A user with permission to all the functionality and data in FinSpace.</para></li><li><para><c>APP_USER</c> – A user with specific permissions in FinSpace. The users are assigned permissions by adding them to a permission group.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.UpdateFNSPUserCmdlet.UserId"> <summary> <para> <para>The unique identifier for the user that you want to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FNSP.UpdateFNSPUserCmdlet.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.UpdateFNSPUserCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'UserId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FinSpaceData.Model.UpdateUserResponse). Specifying the name of a property of type Amazon.FinSpaceData.Model.UpdateUserResponse 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.UpdateFNSPUserCmdlet.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> |