AWS.Tools.Athena.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.Athena</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.ATH.AddATHResourceTagCmdlet"> <summary> Adds one or more tags to an Athena resource. A tag is a label that you assign to a resource. Each tag consists of a key and an optional value, both of which you define. For example, you can use tags to categorize Athena workgroups, data catalogs, or capacity reservations by purpose, owner, or environment. Use a consistent set of tag keys to make it easier to search and filter the resources in your account. For best practices, see <a href="https://docs.aws.amazon.com/whitepapers/latest/tagging-best-practices/tagging-best-practices.html">Tagging Best Practices</a>. Tag keys can be from 1 to 128 UTF-8 Unicode characters, and tag values can be from 0 to 256 UTF-8 Unicode characters. Tags can use letters and numbers representable in UTF-8, and the following characters: + - = . _ : / @. Tag keys and values are case-sensitive. Tag keys must be unique per resource. If you specify more than one tag, separate them by commas. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.AddATHResourceTagCmdlet.ResourceARN"> <summary> <para> <para>Specifies the ARN of the Athena resource to which tags are to be added.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.AddATHResourceTagCmdlet.Tag"> <summary> <para> <para>A collection of one or more tags, separated by commas, to be added to an Athena resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.AddATHResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Athena.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.AddATHResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceARN parameter. The -PassThru parameter is deprecated, use -Select '^ResourceARN' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.AddATHResourceTagCmdlet.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.ATH.ExportATHNotebookCmdlet"> <summary> Exports the specified notebook and its metadata. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.ExportATHNotebookCmdlet.NotebookId"> <summary> <para> <para>The ID of the notebook to export.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.ExportATHNotebookCmdlet.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.Athena.Model.ExportNotebookResponse). Specifying the name of a property of type Amazon.Athena.Model.ExportNotebookResponse 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.ATH.ExportATHNotebookCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the NotebookId parameter. The -PassThru parameter is deprecated, use -Select '^NotebookId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.ExportATHNotebookCmdlet.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.ATH.GetATHApplicationDPUSizeListCmdlet"> <summary> Returns the supported DPU sizes for the supported application runtimes (for example, <c>Athena notebook version 1</c>).<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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHApplicationDPUSizeListCmdlet.MaxResult"> <summary> <para> <para>Specifies the maximum number of results to return.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHApplicationDPUSizeListCmdlet.NextToken"> <summary> <para> <para>A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated.</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/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHApplicationDPUSizeListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ApplicationDPUSizes'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Athena.Model.ListApplicationDPUSizesResponse). Specifying the name of a property of type Amazon.Athena.Model.ListApplicationDPUSizesResponse 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.ATH.GetATHApplicationDPUSizeListCmdlet.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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ATH.GetATHBatchPreparedStatementCmdlet"> <summary> Returns the details of a single prepared statement or a list of up to 256 prepared statements for the array of prepared statement names that you provide. Requires you to have access to the workgroup to which the prepared statements belong. If a prepared statement cannot be retrieved for the name specified, the statement is listed in <c>UnprocessedPreparedStatementNames</c>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHBatchPreparedStatementCmdlet.PreparedStatementName"> <summary> <para> <para>A list of prepared statement names to return.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHBatchPreparedStatementCmdlet.WorkGroup"> <summary> <para> <para>The name of the workgroup to which the prepared statements belong.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHBatchPreparedStatementCmdlet.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.Athena.Model.BatchGetPreparedStatementResponse). Specifying the name of a property of type Amazon.Athena.Model.BatchGetPreparedStatementResponse 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.ATH.GetATHBatchPreparedStatementCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the WorkGroup parameter. The -PassThru parameter is deprecated, use -Select '^WorkGroup' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ATH.GetATHCalculationExecutionCmdlet"> <summary> Describes a previously submitted calculation execution. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHCalculationExecutionCmdlet.CalculationExecutionId"> <summary> <para> <para>The calculation execution UUID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHCalculationExecutionCmdlet.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.Athena.Model.GetCalculationExecutionResponse). Specifying the name of a property of type Amazon.Athena.Model.GetCalculationExecutionResponse 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.ATH.GetATHCalculationExecutionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the CalculationExecutionId parameter. The -PassThru parameter is deprecated, use -Select '^CalculationExecutionId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ATH.GetATHCalculationExecutionCodeCmdlet"> <summary> Retrieves the unencrypted code that was executed for the calculation. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHCalculationExecutionCodeCmdlet.CalculationExecutionId"> <summary> <para> <para>The calculation execution UUID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHCalculationExecutionCodeCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'CodeBlock'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Athena.Model.GetCalculationExecutionCodeResponse). Specifying the name of a property of type Amazon.Athena.Model.GetCalculationExecutionCodeResponse 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.ATH.GetATHCalculationExecutionCodeCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the CalculationExecutionId parameter. The -PassThru parameter is deprecated, use -Select '^CalculationExecutionId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ATH.GetATHCalculationExecutionListCmdlet"> <summary> Lists the calculations that have been submitted to a session in descending order. Newer calculations are listed first; older calculations are listed later.<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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHCalculationExecutionListCmdlet.SessionId"> <summary> <para> <para>The session ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHCalculationExecutionListCmdlet.StateFilter"> <summary> <para> <para>A filter for a specific calculation execution state. A description of each state follows.</para><para><c>CREATING</c> - The calculation is in the process of being created.</para><para><c>CREATED</c> - The calculation has been created and is ready to run.</para><para><c>QUEUED</c> - The calculation has been queued for processing.</para><para><c>RUNNING</c> - The calculation is running.</para><para><c>CANCELING</c> - A request to cancel the calculation has been received and the system is working to stop it.</para><para><c>CANCELED</c> - The calculation is no longer running as the result of a cancel request.</para><para><c>COMPLETED</c> - The calculation has completed without error.</para><para><c>FAILED</c> - The calculation failed and is no longer running.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHCalculationExecutionListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of calculation executions to return.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHCalculationExecutionListCmdlet.NextToken"> <summary> <para> <para>A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the <c>NextToken</c> from the response object of the previous page call.</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/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHCalculationExecutionListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Calculations'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Athena.Model.ListCalculationExecutionsResponse). Specifying the name of a property of type Amazon.Athena.Model.ListCalculationExecutionsResponse 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.ATH.GetATHCalculationExecutionListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SessionId parameter. The -PassThru parameter is deprecated, use -Select '^SessionId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHCalculationExecutionListCmdlet.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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ATH.GetATHCalculationExecutionStatusCmdlet"> <summary> Gets the status of a current calculation. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHCalculationExecutionStatusCmdlet.CalculationExecutionId"> <summary> <para> <para>The calculation execution UUID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHCalculationExecutionStatusCmdlet.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.Athena.Model.GetCalculationExecutionStatusResponse). Specifying the name of a property of type Amazon.Athena.Model.GetCalculationExecutionStatusResponse 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.ATH.GetATHCalculationExecutionStatusCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the CalculationExecutionId parameter. The -PassThru parameter is deprecated, use -Select '^CalculationExecutionId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ATH.GetATHCapacityAssignmentConfigurationCmdlet"> <summary> Gets the capacity assignment configuration for a capacity reservation, if one exists. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHCapacityAssignmentConfigurationCmdlet.CapacityReservationName"> <summary> <para> <para>The name of the capacity reservation to retrieve the capacity assignment configuration for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHCapacityAssignmentConfigurationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'CapacityAssignmentConfiguration'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Athena.Model.GetCapacityAssignmentConfigurationResponse). Specifying the name of a property of type Amazon.Athena.Model.GetCapacityAssignmentConfigurationResponse 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.ATH.GetATHCapacityAssignmentConfigurationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the CapacityReservationName parameter. The -PassThru parameter is deprecated, use -Select '^CapacityReservationName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ATH.GetATHCapacityReservationCmdlet"> <summary> Returns information about the capacity reservation with the specified name. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHCapacityReservationCmdlet.Name"> <summary> <para> <para>The name of the capacity reservation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHCapacityReservationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'CapacityReservation'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Athena.Model.GetCapacityReservationResponse). Specifying the name of a property of type Amazon.Athena.Model.GetCapacityReservationResponse 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.ATH.GetATHCapacityReservationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ATH.GetATHCapacityReservationListCmdlet"> <summary> Lists the capacity reservations for the current account.<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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHCapacityReservationListCmdlet.MaxResult"> <summary> <para> <para>Specifies the maximum number of results to return.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHCapacityReservationListCmdlet.NextToken"> <summary> <para> <para>A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated.</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/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHCapacityReservationListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'CapacityReservations'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Athena.Model.ListCapacityReservationsResponse). Specifying the name of a property of type Amazon.Athena.Model.ListCapacityReservationsResponse 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.ATH.GetATHCapacityReservationListCmdlet.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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ATH.GetATHDatabaseCmdlet"> <summary> Returns a database object for the specified database and data catalog. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHDatabaseCmdlet.CatalogName"> <summary> <para> <para>The name of the data catalog that contains the database to return.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHDatabaseCmdlet.DatabaseName"> <summary> <para> <para>The name of the database to return.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHDatabaseCmdlet.WorkGroup"> <summary> <para> <para>The name of the workgroup for which the metadata is being fetched. Required if requesting an IAM Identity Center enabled Glue Data Catalog.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHDatabaseCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Database'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Athena.Model.GetDatabaseResponse). Specifying the name of a property of type Amazon.Athena.Model.GetDatabaseResponse 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.ATH.GetATHDatabaseCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DatabaseName parameter. The -PassThru parameter is deprecated, use -Select '^DatabaseName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ATH.GetATHDatabasisListCmdlet"> <summary> Lists the databases in the specified data catalog.<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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHDatabasisListCmdlet.CatalogName"> <summary> <para> <para>The name of the data catalog that contains the databases to return.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHDatabasisListCmdlet.WorkGroup"> <summary> <para> <para>The name of the workgroup for which the metadata is being fetched. Required if requesting an IAM Identity Center enabled Glue Data Catalog.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHDatabasisListCmdlet.MaxResult"> <summary> <para> <para>Specifies the maximum number of results to return.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHDatabasisListCmdlet.NextToken"> <summary> <para> <para>A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the <c>NextToken</c> from the response object of the previous page call.</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/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHDatabasisListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DatabaseList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Athena.Model.ListDatabasesResponse). Specifying the name of a property of type Amazon.Athena.Model.ListDatabasesResponse 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.ATH.GetATHDatabasisListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the CatalogName parameter. The -PassThru parameter is deprecated, use -Select '^CatalogName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHDatabasisListCmdlet.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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ATH.GetATHDataCatalogCmdlet"> <summary> Returns the specified data catalog. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHDataCatalogCmdlet.Name"> <summary> <para> <para>The name of the data catalog to return.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHDataCatalogCmdlet.WorkGroup"> <summary> <para> <para>The name of the workgroup. Required if making an IAM Identity Center request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHDataCatalogCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DataCatalog'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Athena.Model.GetDataCatalogResponse). Specifying the name of a property of type Amazon.Athena.Model.GetDataCatalogResponse 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.ATH.GetATHDataCatalogCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ATH.GetATHDataCatalogListCmdlet"> <summary> Lists the data catalogs in the current Amazon Web Services account. <note><para> In the Athena console, data catalogs are listed as "data sources" on the <b>Data sources</b> page under the <b>Data source name</b> column. </para></note><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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHDataCatalogListCmdlet.WorkGroup"> <summary> <para> <para>The name of the workgroup. Required if making an IAM Identity Center request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHDataCatalogListCmdlet.MaxResult"> <summary> <para> <para>Specifies the maximum number of data catalogs to return.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHDataCatalogListCmdlet.NextToken"> <summary> <para> <para>A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.</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/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHDataCatalogListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DataCatalogsSummary'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Athena.Model.ListDataCatalogsResponse). Specifying the name of a property of type Amazon.Athena.Model.ListDataCatalogsResponse 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.ATH.GetATHDataCatalogListCmdlet.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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ATH.GetATHEngineVersionListCmdlet"> <summary> Returns a list of engine versions that are available to choose from, including the Auto option.<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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHEngineVersionListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of engine versions to return in this request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHEngineVersionListCmdlet.NextToken"> <summary> <para> <para>A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the <c>NextToken</c> from the response object of the previous page call.</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/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHEngineVersionListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'EngineVersions'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Athena.Model.ListEngineVersionsResponse). Specifying the name of a property of type Amazon.Athena.Model.ListEngineVersionsResponse 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.ATH.GetATHEngineVersionListCmdlet.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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ATH.GetATHExecutorListCmdlet"> <summary> Lists, in descending order, the executors that joined a session. Newer executors are listed first; older executors are listed later. The result can be optionally filtered by state.<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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHExecutorListCmdlet.ExecutorStateFilter"> <summary> <para> <para>A filter for a specific executor state. A description of each state follows.</para><para><c>CREATING</c> - The executor is being started, including acquiring resources.</para><para><c>CREATED</c> - The executor has been started.</para><para><c>REGISTERED</c> - The executor has been registered.</para><para><c>TERMINATING</c> - The executor is in the process of shutting down.</para><para><c>TERMINATED</c> - The executor is no longer running.</para><para><c>FAILED</c> - Due to a failure, the executor is no longer running.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHExecutorListCmdlet.SessionId"> <summary> <para> <para>The session ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHExecutorListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of executors to return.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHExecutorListCmdlet.NextToken"> <summary> <para> <para>A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the <c>NextToken</c> from the response object of the previous page call.</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/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHExecutorListCmdlet.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.Athena.Model.ListExecutorsResponse). Specifying the name of a property of type Amazon.Athena.Model.ListExecutorsResponse 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.ATH.GetATHExecutorListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SessionId parameter. The -PassThru parameter is deprecated, use -Select '^SessionId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHExecutorListCmdlet.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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ATH.GetATHNamedQueryCmdlet"> <summary> Returns information about a single query. Requires that you have access to the workgroup in which the query was saved. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHNamedQueryCmdlet.NamedQueryId"> <summary> <para> <para>The unique ID of the query. Use <a>ListNamedQueries</a> to get query IDs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHNamedQueryCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'NamedQuery'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Athena.Model.GetNamedQueryResponse). Specifying the name of a property of type Amazon.Athena.Model.GetNamedQueryResponse 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.ATH.GetATHNamedQueryCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the NamedQueryId parameter. The -PassThru parameter is deprecated, use -Select '^NamedQueryId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ATH.GetATHNamedQueryBatchCmdlet"> <summary> Returns the details of a single named query or a list of up to 50 queries, which you provide as an array of query ID strings. Requires you to have access to the workgroup in which the queries were saved. Use <a>ListNamedQueriesInput</a> to get the list of named query IDs in the specified workgroup. If information could not be retrieved for a submitted query ID, information about the query ID submitted is listed under <a>UnprocessedNamedQueryId</a>. Named queries differ from executed queries. Use <a>BatchGetQueryExecutionInput</a> to get details about each unique query execution, and <a>ListQueryExecutionsInput</a> to get a list of query execution IDs. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHNamedQueryBatchCmdlet.NamedQueryId"> <summary> <para> <para>An array of query IDs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHNamedQueryBatchCmdlet.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.Athena.Model.BatchGetNamedQueryResponse). Specifying the name of a property of type Amazon.Athena.Model.BatchGetNamedQueryResponse 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.ATH.GetATHNamedQueryBatchCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the NamedQueryId parameter. The -PassThru parameter is deprecated, use -Select '^NamedQueryId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ATH.GetATHNamedQueryListCmdlet"> <summary> Provides a list of available query IDs only for queries saved in the specified workgroup. Requires that you have access to the specified workgroup. If a workgroup is not specified, lists the saved queries for the primary workgroup.<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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHNamedQueryListCmdlet.WorkGroup"> <summary> <para> <para>The name of the workgroup from which the named queries are being returned. If a workgroup is not specified, the saved queries for the primary workgroup are returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHNamedQueryListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of queries to return in this request.</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.ATH.GetATHNamedQueryListCmdlet.NextToken"> <summary> <para> <para>A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the <c>NextToken</c> from the response object of the previous page call.</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/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHNamedQueryListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'NamedQueryIds'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Athena.Model.ListNamedQueriesResponse). Specifying the name of a property of type Amazon.Athena.Model.ListNamedQueriesResponse 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.ATH.GetATHNamedQueryListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the WorkGroup parameter. The -PassThru parameter is deprecated, use -Select '^WorkGroup' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHNamedQueryListCmdlet.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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ATH.GetATHNotebookMetadataCmdlet"> <summary> Retrieves notebook metadata for the specified notebook ID. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHNotebookMetadataCmdlet.NotebookId"> <summary> <para> <para>The ID of the notebook whose metadata is to be retrieved.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHNotebookMetadataCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'NotebookMetadata'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Athena.Model.GetNotebookMetadataResponse). Specifying the name of a property of type Amazon.Athena.Model.GetNotebookMetadataResponse 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.ATH.GetATHNotebookMetadataCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the NotebookId parameter. The -PassThru parameter is deprecated, use -Select '^NotebookId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ATH.GetATHNotebookMetadataListCmdlet"> <summary> Displays the notebook files for the specified workgroup in paginated format.<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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHNotebookMetadataListCmdlet.Filters_Name"> <summary> <para> <para>The name of the notebook to search for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHNotebookMetadataListCmdlet.WorkGroup"> <summary> <para> <para>The name of the Spark enabled workgroup to retrieve notebook metadata for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHNotebookMetadataListCmdlet.MaxResult"> <summary> <para> <para>Specifies the maximum number of results to return.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHNotebookMetadataListCmdlet.NextToken"> <summary> <para> <para>A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated.</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/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHNotebookMetadataListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'NotebookMetadataList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Athena.Model.ListNotebookMetadataResponse). Specifying the name of a property of type Amazon.Athena.Model.ListNotebookMetadataResponse 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.ATH.GetATHNotebookMetadataListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the WorkGroup parameter. The -PassThru parameter is deprecated, use -Select '^WorkGroup' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHNotebookMetadataListCmdlet.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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ATH.GetATHNotebookSessionListCmdlet"> <summary> Lists, in descending order, the sessions that have been created in a notebook that are in an active state like <c>CREATING</c>, <c>CREATED</c>, <c>IDLE</c> or <c>BUSY</c>. Newer sessions are listed first; older sessions are listed later.<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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHNotebookSessionListCmdlet.NotebookId"> <summary> <para> <para>The ID of the notebook to list sessions for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHNotebookSessionListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of notebook sessions to return.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHNotebookSessionListCmdlet.NextToken"> <summary> <para> <para>A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the <c>NextToken</c> from the response object of the previous page call.</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/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHNotebookSessionListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'NotebookSessionsList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Athena.Model.ListNotebookSessionsResponse). Specifying the name of a property of type Amazon.Athena.Model.ListNotebookSessionsResponse 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.ATH.GetATHNotebookSessionListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the NotebookId parameter. The -PassThru parameter is deprecated, use -Select '^NotebookId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHNotebookSessionListCmdlet.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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ATH.GetATHPreparedStatementCmdlet"> <summary> Retrieves the prepared statement with the specified name from the specified workgroup. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHPreparedStatementCmdlet.StatementName"> <summary> <para> <para>The name of the prepared statement to retrieve.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHPreparedStatementCmdlet.WorkGroup"> <summary> <para> <para>The workgroup to which the statement to be retrieved belongs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHPreparedStatementCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'PreparedStatement'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Athena.Model.GetPreparedStatementResponse). Specifying the name of a property of type Amazon.Athena.Model.GetPreparedStatementResponse 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.ATH.GetATHPreparedStatementCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the StatementName parameter. The -PassThru parameter is deprecated, use -Select '^StatementName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ATH.GetATHPreparedStatementListCmdlet"> <summary> Lists the prepared statements in the specified workgroup.<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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHPreparedStatementListCmdlet.WorkGroup"> <summary> <para> <para>The workgroup to list the prepared statements for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHPreparedStatementListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return in this request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHPreparedStatementListCmdlet.NextToken"> <summary> <para> <para>A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the <c>NextToken</c> from the response object of the previous page call.</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/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHPreparedStatementListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'PreparedStatements'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Athena.Model.ListPreparedStatementsResponse). Specifying the name of a property of type Amazon.Athena.Model.ListPreparedStatementsResponse 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.ATH.GetATHPreparedStatementListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the WorkGroup parameter. The -PassThru parameter is deprecated, use -Select '^WorkGroup' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHPreparedStatementListCmdlet.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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ATH.GetATHQueryExecutionCmdlet"> <summary> Returns information about a single execution of a query if you have access to the workgroup in which the query ran. Each time a query executes, information about the query execution is saved with a unique ID. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHQueryExecutionCmdlet.QueryExecutionId"> <summary> <para> <para>The unique ID of the query execution.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHQueryExecutionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'QueryExecution'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Athena.Model.GetQueryExecutionResponse). Specifying the name of a property of type Amazon.Athena.Model.GetQueryExecutionResponse 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.ATH.GetATHQueryExecutionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the QueryExecutionId parameter. The -PassThru parameter is deprecated, use -Select '^QueryExecutionId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ATH.GetATHQueryExecutionBatchCmdlet"> <summary> Returns the details of a single query execution or a list of up to 50 query executions, which you provide as an array of query execution ID strings. Requires you to have access to the workgroup in which the queries ran. To get a list of query execution IDs, use <a>ListQueryExecutionsInput$WorkGroup</a>. Query executions differ from named (saved) queries. Use <a>BatchGetNamedQueryInput</a> to get details about named queries. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHQueryExecutionBatchCmdlet.QueryExecutionId"> <summary> <para> <para>An array of query execution IDs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHQueryExecutionBatchCmdlet.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.Athena.Model.BatchGetQueryExecutionResponse). Specifying the name of a property of type Amazon.Athena.Model.BatchGetQueryExecutionResponse 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.ATH.GetATHQueryExecutionBatchCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the QueryExecutionId parameter. The -PassThru parameter is deprecated, use -Select '^QueryExecutionId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ATH.GetATHQueryExecutionListCmdlet"> <summary> Provides a list of available query execution IDs for the queries in the specified workgroup. Athena keeps a query history for 45 days. If a workgroup is not specified, returns a list of query execution IDs for the primary workgroup. Requires you to have access to the workgroup in which the queries ran.<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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHQueryExecutionListCmdlet.WorkGroup"> <summary> <para> <para>The name of the workgroup from which queries are being returned. If a workgroup is not specified, a list of available query execution IDs for the queries in the primary workgroup is returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHQueryExecutionListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of query executions to return in this request.</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.ATH.GetATHQueryExecutionListCmdlet.NextToken"> <summary> <para> <para>A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the <c>NextToken</c> from the response object of the previous page call.</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/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHQueryExecutionListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'QueryExecutionIds'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Athena.Model.ListQueryExecutionsResponse). Specifying the name of a property of type Amazon.Athena.Model.ListQueryExecutionsResponse 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.ATH.GetATHQueryExecutionListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the WorkGroup parameter. The -PassThru parameter is deprecated, use -Select '^WorkGroup' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHQueryExecutionListCmdlet.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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ATH.GetATHQueryResultCmdlet"> <summary> Streams the results of a single query execution specified by <c>QueryExecutionId</c> from the Athena query results location in Amazon S3. For more information, see <a href="https://docs.aws.amazon.com/athena/latest/ug/querying.html">Working with query results, recent queries, and output files</a> in the <i>Amazon Athena User Guide</i>. This request does not execute the query but returns results. Use <a>StartQueryExecution</a> to run a query. <para> To stream query results successfully, the IAM principal with permission to call <c>GetQueryResults</c> also must have permissions to the Amazon S3 <c>GetObject</c> action for the Athena query results location. </para><important><para> IAM principals with permission to the Amazon S3 <c>GetObject</c> action for the query results location are able to retrieve query results from Amazon S3 even if permission to the <c>GetQueryResults</c> action is denied. To restrict user or role access, ensure that Amazon S3 permissions to the Athena query location are denied. </para></important><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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHQueryResultCmdlet.QueryExecutionId"> <summary> <para> <para>The unique ID of the query execution.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHQueryResultCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results (rows) to return in this request.</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.ATH.GetATHQueryResultCmdlet.NextToken"> <summary> <para> <para>A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the <c>NextToken</c> from the response object of the previous page call.</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/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHQueryResultCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ResultSet'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Athena.Model.GetQueryResultsResponse). Specifying the name of a property of type Amazon.Athena.Model.GetQueryResultsResponse 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.ATH.GetATHQueryResultCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the QueryExecutionId parameter. The -PassThru parameter is deprecated, use -Select '^QueryExecutionId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHQueryResultCmdlet.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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ATH.GetATHQueryRuntimeStatisticCmdlet"> <summary> Returns query execution runtime statistics related to a single execution of a query if you have access to the workgroup in which the query ran. Query execution runtime statistics are returned only when <a>QueryExecutionStatus$State</a> is in a SUCCEEDED or FAILED state. Stage-level input and output row count and data size statistics are not shown when a query has row-level filters defined in Lake Formation. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHQueryRuntimeStatisticCmdlet.QueryExecutionId"> <summary> <para> <para>The unique ID of the query execution.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHQueryRuntimeStatisticCmdlet.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.Athena.Model.GetQueryRuntimeStatisticsResponse). Specifying the name of a property of type Amazon.Athena.Model.GetQueryRuntimeStatisticsResponse 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.ATH.GetATHQueryRuntimeStatisticCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the QueryExecutionId parameter. The -PassThru parameter is deprecated, use -Select '^QueryExecutionId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ATH.GetATHResourceTagCmdlet"> <summary> Lists the tags associated with an Athena resource.<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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHResourceTagCmdlet.ResourceARN"> <summary> <para> <para>Lists the tags for the resource with the specified ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHResourceTagCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to be returned per request that lists the tags for the resource.</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.ATH.GetATHResourceTagCmdlet.NextToken"> <summary> <para> <para>The token for the next set of results, or null if there are no additional results for this request, where the request lists the tags for the resource with the specified ARN.</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/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Tags'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Athena.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.Athena.Model.ListTagsForResourceResponse 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.ATH.GetATHResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceARN parameter. The -PassThru parameter is deprecated, use -Select '^ResourceARN' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHResourceTagCmdlet.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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ATH.GetATHSessionCmdlet"> <summary> Gets the full details of a previously created session, including the session status and configuration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHSessionCmdlet.SessionId"> <summary> <para> <para>The session ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHSessionCmdlet.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.Athena.Model.GetSessionResponse). Specifying the name of a property of type Amazon.Athena.Model.GetSessionResponse 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.ATH.GetATHSessionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SessionId parameter. The -PassThru parameter is deprecated, use -Select '^SessionId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ATH.GetATHSessionListCmdlet"> <summary> Lists the sessions in a workgroup that are in an active state like <c>CREATING</c>, <c>CREATED</c>, <c>IDLE</c>, or <c>BUSY</c>. Newer sessions are listed first; older sessions are listed later.<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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHSessionListCmdlet.StateFilter"> <summary> <para> <para>A filter for a specific session state. A description of each state follows.</para><para><c>CREATING</c> - The session is being started, including acquiring resources.</para><para><c>CREATED</c> - The session has been started.</para><para><c>IDLE</c> - The session is able to accept a calculation.</para><para><c>BUSY</c> - The session is processing another task and is unable to accept a calculation.</para><para><c>TERMINATING</c> - The session is in the process of shutting down.</para><para><c>TERMINATED</c> - The session and its resources are no longer running.</para><para><c>DEGRADED</c> - The session has no healthy coordinators.</para><para><c>FAILED</c> - Due to a failure, the session and its resources are no longer running.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHSessionListCmdlet.WorkGroup"> <summary> <para> <para>The workgroup to which the session belongs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHSessionListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of sessions to return.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHSessionListCmdlet.NextToken"> <summary> <para> <para>A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the <c>NextToken</c> from the response object of the previous page call.</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/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHSessionListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Sessions'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Athena.Model.ListSessionsResponse). Specifying the name of a property of type Amazon.Athena.Model.ListSessionsResponse 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.ATH.GetATHSessionListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the WorkGroup parameter. The -PassThru parameter is deprecated, use -Select '^WorkGroup' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHSessionListCmdlet.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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ATH.GetATHSessionStatusCmdlet"> <summary> Gets the current status of a session. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHSessionStatusCmdlet.SessionId"> <summary> <para> <para>The session ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHSessionStatusCmdlet.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.Athena.Model.GetSessionStatusResponse). Specifying the name of a property of type Amazon.Athena.Model.GetSessionStatusResponse 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.ATH.GetATHSessionStatusCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SessionId parameter. The -PassThru parameter is deprecated, use -Select '^SessionId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ATH.GetATHTableMetadataCmdlet"> <summary> Returns table metadata for the specified catalog, database, and table. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHTableMetadataCmdlet.CatalogName"> <summary> <para> <para>The name of the data catalog that contains the database and table metadata to return.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHTableMetadataCmdlet.DatabaseName"> <summary> <para> <para>The name of the database that contains the table metadata to return.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHTableMetadataCmdlet.TableName"> <summary> <para> <para>The name of the table for which metadata is returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHTableMetadataCmdlet.WorkGroup"> <summary> <para> <para>The name of the workgroup for which the metadata is being fetched. Required if requesting an IAM Identity Center enabled Glue Data Catalog.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHTableMetadataCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'TableMetadata'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Athena.Model.GetTableMetadataResponse). Specifying the name of a property of type Amazon.Athena.Model.GetTableMetadataResponse 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.ATH.GetATHTableMetadataCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TableName parameter. The -PassThru parameter is deprecated, use -Select '^TableName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ATH.GetATHTableMetadataListCmdlet"> <summary> Lists the metadata for the tables in the specified data catalog database.<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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHTableMetadataListCmdlet.CatalogName"> <summary> <para> <para>The name of the data catalog for which table metadata should be returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHTableMetadataListCmdlet.DatabaseName"> <summary> <para> <para>The name of the database for which table metadata should be returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHTableMetadataListCmdlet.Expression"> <summary> <para> <para>A regex filter that pattern-matches table names. If no expression is supplied, metadata for all tables are listed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHTableMetadataListCmdlet.WorkGroup"> <summary> <para> <para>The name of the workgroup for which the metadata is being fetched. Required if requesting an IAM Identity Center enabled Glue Data Catalog.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHTableMetadataListCmdlet.MaxResult"> <summary> <para> <para>Specifies the maximum number of results to return.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHTableMetadataListCmdlet.NextToken"> <summary> <para> <para>A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.</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/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHTableMetadataListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'TableMetadataList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Athena.Model.ListTableMetadataResponse). Specifying the name of a property of type Amazon.Athena.Model.ListTableMetadataResponse 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.ATH.GetATHTableMetadataListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DatabaseName parameter. The -PassThru parameter is deprecated, use -Select '^DatabaseName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHTableMetadataListCmdlet.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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ATH.GetATHWorkGroupCmdlet"> <summary> Returns information about the workgroup with the specified name. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHWorkGroupCmdlet.WorkGroup"> <summary> <para> <para>The name of the workgroup.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHWorkGroupCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'WorkGroup'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Athena.Model.GetWorkGroupResponse). Specifying the name of a property of type Amazon.Athena.Model.GetWorkGroupResponse 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.ATH.GetATHWorkGroupCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the WorkGroup parameter. The -PassThru parameter is deprecated, use -Select '^WorkGroup' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ATH.GetATHWorkGroupListCmdlet"> <summary> Lists available workgroups for the account.<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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHWorkGroupListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of workgroups to return in this request.</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.ATH.GetATHWorkGroupListCmdlet.NextToken"> <summary> <para> <para>A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the <c>NextToken</c> from the response object of the previous page call.</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/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.GetATHWorkGroupListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'WorkGroups'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Athena.Model.ListWorkGroupsResponse). Specifying the name of a property of type Amazon.Athena.Model.ListWorkGroupsResponse 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.ATH.GetATHWorkGroupListCmdlet.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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ATH.ImportATHNotebookCmdlet"> <summary> Imports a single <c>ipynb</c> file to a Spark enabled workgroup. The maximum file size that can be imported is 10 megabytes. If an <c>ipynb</c> file with the same name already exists in the workgroup, throws an error. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.ImportATHNotebookCmdlet.ClientRequestToken"> <summary> <para> <para>A unique case-sensitive string used to ensure the request to import the notebook is idempotent (executes only once).</para><important><para>This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) auto-generate the token for you. If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide this token or the action will fail.</para></important> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.ImportATHNotebookCmdlet.Name"> <summary> <para> <para>The name of the notebook to import.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.ImportATHNotebookCmdlet.Payload"> <summary> <para> <para>The notebook content to be imported.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.ImportATHNotebookCmdlet.Type"> <summary> <para> <para>The notebook content type. Currently, the only valid type is <c>IPYNB</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.ImportATHNotebookCmdlet.WorkGroup"> <summary> <para> <para>The name of the Spark enabled workgroup to import the notebook to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.ImportATHNotebookCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'NotebookId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Athena.Model.ImportNotebookResponse). Specifying the name of a property of type Amazon.Athena.Model.ImportNotebookResponse 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.ATH.ImportATHNotebookCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the WorkGroup parameter. The -PassThru parameter is deprecated, use -Select '^WorkGroup' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.ImportATHNotebookCmdlet.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.ATH.NewATHCapacityReservationCmdlet"> <summary> Creates a capacity reservation with the specified name and number of requested data processing units. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.NewATHCapacityReservationCmdlet.Name"> <summary> <para> <para>The name of the capacity reservation to create.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.NewATHCapacityReservationCmdlet.Tag"> <summary> <para> <para>The tags for the capacity reservation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.NewATHCapacityReservationCmdlet.TargetDpus"> <summary> <para> <para>The number of requested data processing units.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.NewATHCapacityReservationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Athena.Model.CreateCapacityReservationResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.NewATHCapacityReservationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.NewATHCapacityReservationCmdlet.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.ATH.NewATHDataCatalogCmdlet"> <summary> Creates (registers) a data catalog with the specified name and properties. Catalogs created are visible to all users of the same Amazon Web Services account. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.NewATHDataCatalogCmdlet.Description"> <summary> <para> <para>A description of the data catalog to be created.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.NewATHDataCatalogCmdlet.Name"> <summary> <para> <para>The name of the data catalog to create. The catalog name must be unique for the Amazon Web Services account and can use a maximum of 127 alphanumeric, underscore, at sign, or hyphen characters. The remainder of the length constraint of 256 is reserved for use by Athena.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.NewATHDataCatalogCmdlet.Parameter"> <summary> <para> <para>Specifies the Lambda function or functions to use for creating the data catalog. This is a mapping whose values depend on the catalog type. </para><ul><li><para>For the <c>HIVE</c> data catalog type, use the following syntax. The <c>metadata-function</c> parameter is required. <c>The sdk-version</c> parameter is optional and defaults to the currently supported version.</para><para><c>metadata-function=<i>lambda_arn</i>, sdk-version=<i>version_number</i></c></para></li><li><para>For the <c>LAMBDA</c> data catalog type, use one of the following sets of required parameters, but not both.</para><ul><li><para>If you have one Lambda function that processes metadata and another for reading the actual data, use the following syntax. Both parameters are required.</para><para><c>metadata-function=<i>lambda_arn</i>, record-function=<i>lambda_arn</i></c></para></li><li><para> If you have a composite Lambda function that processes both metadata and data, use the following syntax to specify your Lambda function.</para><para><c>function=<i>lambda_arn</i></c></para></li></ul></li><li><para>The <c>GLUE</c> type takes a catalog ID parameter and is required. The <c><i>catalog_id</i></c> is the account ID of the Amazon Web Services account to which the Glue Data Catalog belongs.</para><para><c>catalog-id=<i>catalog_id</i></c></para><ul><li><para>The <c>GLUE</c> data catalog type also applies to the default <c>AwsDataCatalog</c> that already exists in your account, of which you can have only one and cannot modify.</para></li></ul></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.NewATHDataCatalogCmdlet.Tag"> <summary> <para> <para>A list of comma separated tags to add to the data catalog that is created.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.NewATHDataCatalogCmdlet.Type"> <summary> <para> <para>The type of data catalog to create: <c>LAMBDA</c> for a federated catalog, <c>HIVE</c> for an external hive metastore, or <c>GLUE</c> for an Glue Data Catalog.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.NewATHDataCatalogCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Athena.Model.CreateDataCatalogResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.NewATHDataCatalogCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.NewATHDataCatalogCmdlet.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.ATH.NewATHNamedQueryCmdlet"> <summary> Creates a named query in the specified workgroup. Requires that you have access to the workgroup. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.NewATHNamedQueryCmdlet.ClientRequestToken"> <summary> <para> <para>A unique case-sensitive string used to ensure the request to create the query is idempotent (executes only once). If another <c>CreateNamedQuery</c> request is received, the same response is returned and another query is not created. If a parameter has changed, for example, the <c>QueryString</c>, an error is returned.</para><important><para>This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) auto-generate the token for users. If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide this token or the action will fail.</para></important> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.NewATHNamedQueryCmdlet.Database"> <summary> <para> <para>The database to which the query belongs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.NewATHNamedQueryCmdlet.Description"> <summary> <para> <para>The query description.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.NewATHNamedQueryCmdlet.Name"> <summary> <para> <para>The query name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.NewATHNamedQueryCmdlet.QueryString"> <summary> <para> <para>The contents of the query with all query statements.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.NewATHNamedQueryCmdlet.WorkGroup"> <summary> <para> <para>The name of the workgroup in which the named query is being created.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.NewATHNamedQueryCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'NamedQueryId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Athena.Model.CreateNamedQueryResponse). Specifying the name of a property of type Amazon.Athena.Model.CreateNamedQueryResponse 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.ATH.NewATHNamedQueryCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the QueryString parameter. The -PassThru parameter is deprecated, use -Select '^QueryString' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.NewATHNamedQueryCmdlet.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.ATH.NewATHNotebookCmdlet"> <summary> Creates an empty <c>ipynb</c> file in the specified Apache Spark enabled workgroup. Throws an error if a file in the workgroup with the same name already exists. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.NewATHNotebookCmdlet.ClientRequestToken"> <summary> <para> <para>A unique case-sensitive string used to ensure the request to create the notebook is idempotent (executes only once).</para><important><para>This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) auto-generate the token for you. If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide this token or the action will fail.</para></important> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.NewATHNotebookCmdlet.Name"> <summary> <para> <para>The name of the <c>ipynb</c> file to be created in the Spark workgroup, without the <c>.ipynb</c> extension.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.NewATHNotebookCmdlet.WorkGroup"> <summary> <para> <para>The name of the Spark enabled workgroup in which the notebook will be created.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.NewATHNotebookCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'NotebookId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Athena.Model.CreateNotebookResponse). Specifying the name of a property of type Amazon.Athena.Model.CreateNotebookResponse 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.ATH.NewATHNotebookCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the WorkGroup parameter. The -PassThru parameter is deprecated, use -Select '^WorkGroup' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.NewATHNotebookCmdlet.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.ATH.NewATHPreparedStatementCmdlet"> <summary> Creates a prepared statement for use with SQL queries in Athena. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.NewATHPreparedStatementCmdlet.Description"> <summary> <para> <para>The description of the prepared statement.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.NewATHPreparedStatementCmdlet.QueryStatement"> <summary> <para> <para>The query string for the prepared statement.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.NewATHPreparedStatementCmdlet.StatementName"> <summary> <para> <para>The name of the prepared statement.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.NewATHPreparedStatementCmdlet.WorkGroup"> <summary> <para> <para>The name of the workgroup to which the prepared statement belongs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.NewATHPreparedStatementCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Athena.Model.CreatePreparedStatementResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.NewATHPreparedStatementCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the QueryStatement parameter. The -PassThru parameter is deprecated, use -Select '^QueryStatement' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.NewATHPreparedStatementCmdlet.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.ATH.NewATHPresignedNotebookUrlCmdlet"> <summary> Gets an authentication token and the URL at which the notebook can be accessed. During programmatic access, <c>CreatePresignedNotebookUrl</c> must be called every 10 minutes to refresh the authentication token. For information about granting programmatic access, see <a href="https://docs.aws.amazon.com/athena/latest/ug/setting-up.html#setting-up-grant-programmatic-access">Grant programmatic access</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.NewATHPresignedNotebookUrlCmdlet.SessionId"> <summary> <para> <para>The session ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.NewATHPresignedNotebookUrlCmdlet.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.Athena.Model.CreatePresignedNotebookUrlResponse). Specifying the name of a property of type Amazon.Athena.Model.CreatePresignedNotebookUrlResponse 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.ATH.NewATHPresignedNotebookUrlCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SessionId parameter. The -PassThru parameter is deprecated, use -Select '^SessionId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.NewATHPresignedNotebookUrlCmdlet.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.ATH.NewATHWorkGroupCmdlet"> <summary> Creates a workgroup with the specified name. A workgroup can be an Apache Spark enabled workgroup or an Athena SQL workgroup. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.NewATHWorkGroupCmdlet.Configuration_AdditionalConfiguration"> <summary> <para> <para>Specifies a user defined JSON string that is passed to the notebook engine.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.NewATHWorkGroupCmdlet.QueryResultsS3AccessGrantsConfiguration_AuthenticationType"> <summary> <para> <para>The authentication type used for Amazon S3 access grants. Currently, only <c>DIRECTORY_IDENTITY</c> is supported.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.NewATHWorkGroupCmdlet.Configuration_BytesScannedCutoffPerQuery"> <summary> <para> <para>The upper data usage limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.NewATHWorkGroupCmdlet.QueryResultsS3AccessGrantsConfiguration_CreateUserLevelPrefix"> <summary> <para> <para>When enabled, appends the user ID as an Amazon S3 path prefix to the query result output location.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.NewATHWorkGroupCmdlet.Description"> <summary> <para> <para>The workgroup description.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.NewATHWorkGroupCmdlet.EngineVersion_EffectiveEngineVersion"> <summary> <para> <para>Read only. The engine version on which the query runs. If the user requests a valid engine version other than Auto, the effective engine version is the same as the engine version that the user requested. If the user requests Auto, the effective engine version is chosen by Athena. When a request to update the engine version is made by a <c>CreateWorkGroup</c> or <c>UpdateWorkGroup</c> operation, the <c>EffectiveEngineVersion</c> field is ignored.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.NewATHWorkGroupCmdlet.IdentityCenterConfiguration_EnableIdentityCenter"> <summary> <para> <para>Specifies whether the workgroup is IAM Identity Center supported.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.NewATHWorkGroupCmdlet.Configuration_EnableMinimumEncryptionConfiguration"> <summary> <para> <para>Enforces a minimal level of encryption for the workgroup for query and calculation results that are written to Amazon S3. When enabled, workgroup users can set encryption only to the minimum level set by the administrator or higher when they submit queries.</para><para>The <c>EnforceWorkGroupConfiguration</c> setting takes precedence over the <c>EnableMinimumEncryptionConfiguration</c> flag. This means that if <c>EnforceWorkGroupConfiguration</c> is true, the <c>EnableMinimumEncryptionConfiguration</c> flag is ignored, and the workgroup configuration for encryption is used.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.NewATHWorkGroupCmdlet.QueryResultsS3AccessGrantsConfiguration_EnableS3AccessGrant"> <summary> <para> <para>Specifies whether Amazon S3 access grants are enabled for query results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.NewATHWorkGroupCmdlet.EncryptionConfiguration_EncryptionOption"> <summary> <para> <para>Indicates whether Amazon S3 server-side encryption with Amazon S3-managed keys (<c>SSE_S3</c>), server-side encryption with KMS-managed keys (<c>SSE_KMS</c>), or client-side encryption with KMS-managed keys (<c>CSE_KMS</c>) is used.</para><para>If a query runs in a workgroup and the workgroup overrides client-side settings, then the workgroup's setting for encryption is used. It specifies whether query results must be encrypted, for all queries that run in this workgroup. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.NewATHWorkGroupCmdlet.Configuration_EnforceWorkGroupConfiguration"> <summary> <para> <para>If set to "true", the settings for the workgroup override client-side settings. If set to "false", client-side settings are used. For more information, see <a href="https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html">Workgroup Settings Override Client-Side Settings</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.NewATHWorkGroupCmdlet.Configuration_ExecutionRole"> <summary> <para> <para>The ARN of the execution role used to access user resources for Spark sessions and Identity Center enabled workgroups. This property applies only to Spark enabled workgroups and Identity Center enabled workgroups.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.NewATHWorkGroupCmdlet.ResultConfiguration_ExpectedBucketOwner"> <summary> <para> <para>The Amazon Web Services account ID that you expect to be the owner of the Amazon S3 bucket specified by <a>ResultConfiguration$OutputLocation</a>. If set, Athena uses the value for <c>ExpectedBucketOwner</c> when it makes Amazon S3 calls to your specified output location. If the <c>ExpectedBucketOwner</c> Amazon Web Services account ID does not match the actual owner of the Amazon S3 bucket, the call fails with a permissions error.</para><para>This is a client-side setting. If workgroup settings override client-side settings, then the query uses the <c>ExpectedBucketOwner</c> setting that is specified for the workgroup, and also uses the location for storing query results specified in the workgroup. See <a>WorkGroupConfiguration$EnforceWorkGroupConfiguration</a> and <a href="https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html">Workgroup Settings Override Client-Side Settings</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.NewATHWorkGroupCmdlet.IdentityCenterConfiguration_IdentityCenterInstanceArn"> <summary> <para> <para>The IAM Identity Center instance ARN that the workgroup associates to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.NewATHWorkGroupCmdlet.CustomerContentEncryptionConfiguration_KmsKey"> <summary> <para> <para>The customer managed KMS key that is used to encrypt the user's data stores in Athena.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.NewATHWorkGroupCmdlet.EncryptionConfiguration_KmsKey"> <summary> <para> <para>For <c>SSE_KMS</c> and <c>CSE_KMS</c>, this is the KMS key ARN or ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.NewATHWorkGroupCmdlet.Name"> <summary> <para> <para>The workgroup name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.NewATHWorkGroupCmdlet.ResultConfiguration_OutputLocation"> <summary> <para> <para>The location in Amazon S3 where your query and calculation results are stored, such as <c>s3://path/to/query/bucket/</c>. To run the query, you must specify the query results location using one of the ways: either for individual queries using either this setting (client-side), or in the workgroup, using <a>WorkGroupConfiguration</a>. If none of them is set, Athena issues an error that no output location is provided. For more information, see <a href="https://docs.aws.amazon.com/athena/latest/ug/querying.html">Working with query results, recent queries, and output files</a>. If workgroup settings override client-side settings, then the query uses the settings specified for the workgroup. See <a>WorkGroupConfiguration$EnforceWorkGroupConfiguration</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.NewATHWorkGroupCmdlet.Configuration_PublishCloudWatchMetricsEnabled"> <summary> <para> <para>Indicates that the Amazon CloudWatch metrics are enabled for the workgroup.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.NewATHWorkGroupCmdlet.Configuration_RequesterPaysEnabled"> <summary> <para> <para>If set to <c>true</c>, allows members assigned to a workgroup to reference Amazon S3 Requester Pays buckets in queries. If set to <c>false</c>, workgroup members cannot query data from Requester Pays buckets, and queries that retrieve data from Requester Pays buckets cause an error. The default is <c>false</c>. For more information about Requester Pays buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html">Requester Pays Buckets</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.NewATHWorkGroupCmdlet.AclConfiguration_S3AclOption"> <summary> <para> <para>The Amazon S3 canned ACL that Athena should specify when storing query results. Currently the only supported canned ACL is <c>BUCKET_OWNER_FULL_CONTROL</c>. If a query runs in a workgroup and the workgroup overrides client-side settings, then the Amazon S3 canned ACL specified in the workgroup's settings is used for all queries that run in the workgroup. For more information about Amazon S3 canned ACLs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/acl-overview.html#canned-acl">Canned ACL</a> in the <i>Amazon S3 User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.NewATHWorkGroupCmdlet.EngineVersion_SelectedEngineVersion"> <summary> <para> <para>The engine version requested by the user. Possible values are determined by the output of <c>ListEngineVersions</c>, including AUTO. The default is AUTO.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.NewATHWorkGroupCmdlet.Tag"> <summary> <para> <para>A list of comma separated tags to add to the workgroup that is created.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.NewATHWorkGroupCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Athena.Model.CreateWorkGroupResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.NewATHWorkGroupCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.NewATHWorkGroupCmdlet.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.ATH.RemoveATHCapacityReservationCmdlet"> <summary> Deletes a cancelled capacity reservation. A reservation must be cancelled before it can be deleted. A deleted reservation is immediately removed from your account and can no longer be referenced, including by its ARN. A deleted reservation cannot be called by <c>GetCapacityReservation</c>, and deleted reservations do not appear in the output of <c>ListCapacityReservations</c>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.RemoveATHCapacityReservationCmdlet.Name"> <summary> <para> <para>The name of the capacity reservation to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.RemoveATHCapacityReservationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Athena.Model.DeleteCapacityReservationResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.RemoveATHCapacityReservationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.RemoveATHCapacityReservationCmdlet.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.ATH.RemoveATHDataCatalogCmdlet"> <summary> Deletes a data catalog. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.RemoveATHDataCatalogCmdlet.Name"> <summary> <para> <para>The name of the data catalog to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.RemoveATHDataCatalogCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Athena.Model.DeleteDataCatalogResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.RemoveATHDataCatalogCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.RemoveATHDataCatalogCmdlet.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.ATH.RemoveATHNamedQueryCmdlet"> <summary> Deletes the named query if you have access to the workgroup in which the query was saved. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.RemoveATHNamedQueryCmdlet.NamedQueryId"> <summary> <para> <para>The unique ID of the query to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.RemoveATHNamedQueryCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Athena.Model.DeleteNamedQueryResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.RemoveATHNamedQueryCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the NamedQueryId parameter. The -PassThru parameter is deprecated, use -Select '^NamedQueryId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.RemoveATHNamedQueryCmdlet.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.ATH.RemoveATHNotebookCmdlet"> <summary> Deletes the specified notebook. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.RemoveATHNotebookCmdlet.NotebookId"> <summary> <para> <para>The ID of the notebook to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.RemoveATHNotebookCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Athena.Model.DeleteNotebookResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.RemoveATHNotebookCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the NotebookId parameter. The -PassThru parameter is deprecated, use -Select '^NotebookId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.RemoveATHNotebookCmdlet.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.ATH.RemoveATHPreparedStatementCmdlet"> <summary> Deletes the prepared statement with the specified name from the specified workgroup. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.RemoveATHPreparedStatementCmdlet.StatementName"> <summary> <para> <para>The name of the prepared statement to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.RemoveATHPreparedStatementCmdlet.WorkGroup"> <summary> <para> <para>The workgroup to which the statement to be deleted belongs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.RemoveATHPreparedStatementCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Athena.Model.DeletePreparedStatementResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.RemoveATHPreparedStatementCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the StatementName parameter. The -PassThru parameter is deprecated, use -Select '^StatementName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.RemoveATHPreparedStatementCmdlet.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.ATH.RemoveATHResourceTagCmdlet"> <summary> Removes one or more tags from an Athena resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.RemoveATHResourceTagCmdlet.ResourceARN"> <summary> <para> <para>Specifies the ARN of the resource from which tags are to be removed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.RemoveATHResourceTagCmdlet.TagKey"> <summary> <para> <para>A comma-separated list of one or more tag keys whose tags are to be removed from the specified resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.RemoveATHResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Athena.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.RemoveATHResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceARN parameter. The -PassThru parameter is deprecated, use -Select '^ResourceARN' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.RemoveATHResourceTagCmdlet.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.ATH.RemoveATHSessionCmdlet"> <summary> Terminates an active session. A <c>TerminateSession</c> call on a session that is already inactive (for example, in a <c>FAILED</c>, <c>TERMINATED</c> or <c>TERMINATING</c> state) succeeds but has no effect. Calculations running in the session when <c>TerminateSession</c> is called are forcefully stopped, but may display as <c>FAILED</c> instead of <c>STOPPED</c>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.RemoveATHSessionCmdlet.SessionId"> <summary> <para> <para>The session ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.RemoveATHSessionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'State'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Athena.Model.TerminateSessionResponse). Specifying the name of a property of type Amazon.Athena.Model.TerminateSessionResponse 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.ATH.RemoveATHSessionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SessionId parameter. The -PassThru parameter is deprecated, use -Select '^SessionId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.RemoveATHSessionCmdlet.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.ATH.RemoveATHWorkGroupCmdlet"> <summary> Deletes the workgroup with the specified name. The primary workgroup cannot be deleted. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.RemoveATHWorkGroupCmdlet.RecursiveDeleteOption"> <summary> <para> <para>The option to delete the workgroup and its contents even if the workgroup contains any named queries, query executions, or notebooks.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.RemoveATHWorkGroupCmdlet.WorkGroup"> <summary> <para> <para>The unique name of the workgroup to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.RemoveATHWorkGroupCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Athena.Model.DeleteWorkGroupResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.RemoveATHWorkGroupCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the WorkGroup parameter. The -PassThru parameter is deprecated, use -Select '^WorkGroup' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.RemoveATHWorkGroupCmdlet.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.ATH.StartATHCalculationExecutionCmdlet"> <summary> Submits calculations for execution within a session. You can supply the code to run as an inline code block within the request. <note><para> The request syntax requires the <a>StartCalculationExecutionRequest$CodeBlock</a> parameter or the <a>CalculationConfiguration$CodeBlock</a> parameter, but not both. Because <a>CalculationConfiguration$CodeBlock</a> is deprecated, use the <a>StartCalculationExecutionRequest$CodeBlock</a> parameter instead. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.StartATHCalculationExecutionCmdlet.ClientRequestToken"> <summary> <para> <para>A unique case-sensitive string used to ensure the request to create the calculation is idempotent (executes only once). If another <c>StartCalculationExecutionRequest</c> is received, the same response is returned and another calculation is not created. If a parameter has changed, an error is returned.</para><important><para>This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) auto-generate the token for users. If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide this token or the action will fail.</para></important> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.StartATHCalculationExecutionCmdlet.CalculationConfiguration_CodeBlock"> <summary> <para> <para>A string that contains the code for the calculation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.StartATHCalculationExecutionCmdlet.CodeBlock"> <summary> <para> <para>A string that contains the code of the calculation. Use this parameter instead of <a>CalculationConfiguration$CodeBlock</a>, which is deprecated.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.StartATHCalculationExecutionCmdlet.Description"> <summary> <para> <para>A description of the calculation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.StartATHCalculationExecutionCmdlet.SessionId"> <summary> <para> <para>The session ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.StartATHCalculationExecutionCmdlet.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.Athena.Model.StartCalculationExecutionResponse). Specifying the name of a property of type Amazon.Athena.Model.StartCalculationExecutionResponse 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.ATH.StartATHCalculationExecutionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SessionId parameter. The -PassThru parameter is deprecated, use -Select '^SessionId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.StartATHCalculationExecutionCmdlet.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.ATH.StartATHQueryExecutionCmdlet"> <summary> Runs the SQL query statements contained in the <c>Query</c>. Requires you to have access to the workgroup in which the query ran. Running queries against an external catalog requires <a>GetDataCatalog</a> permission to the catalog. For code samples using the Amazon Web Services SDK for Java, see <a href="http://docs.aws.amazon.com/athena/latest/ug/code-samples.html">Examples and Code Samples</a> in the <i>Amazon Athena User Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.StartATHQueryExecutionCmdlet.QueryExecutionContext_Catalog"> <summary> <para> <para>The name of the data catalog used in the query execution.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.StartATHQueryExecutionCmdlet.ClientRequestToken"> <summary> <para> <para>A unique case-sensitive string used to ensure the request to create the query is idempotent (executes only once). If another <c>StartQueryExecution</c> request is received, the same response is returned and another query is not created. An error is returned if a parameter, such as <c>QueryString</c>, has changed. A call to <c>StartQueryExecution</c> that uses a previous client request token returns the same <c>QueryExecutionId</c> even if the requester doesn't have permission on the tables specified in <c>QueryString</c>.</para><important><para>This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) auto-generate the token for users. If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide this token or the action will fail.</para></important> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.StartATHQueryExecutionCmdlet.QueryExecutionContext_Database"> <summary> <para> <para>The name of the database used in the query execution. The database must exist in the catalog.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.StartATHQueryExecutionCmdlet.ResultReuseByAgeConfiguration_Enabled"> <summary> <para> <para>True if previous query results can be reused when the query is run; otherwise, false. The default is false.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.StartATHQueryExecutionCmdlet.EncryptionConfiguration_EncryptionOption"> <summary> <para> <para>Indicates whether Amazon S3 server-side encryption with Amazon S3-managed keys (<c>SSE_S3</c>), server-side encryption with KMS-managed keys (<c>SSE_KMS</c>), or client-side encryption with KMS-managed keys (<c>CSE_KMS</c>) is used.</para><para>If a query runs in a workgroup and the workgroup overrides client-side settings, then the workgroup's setting for encryption is used. It specifies whether query results must be encrypted, for all queries that run in this workgroup. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.StartATHQueryExecutionCmdlet.ExecutionParameter"> <summary> <para> <para>A list of values for the parameters in a query. The values are applied sequentially to the parameters in the query in the order in which the parameters occur.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.StartATHQueryExecutionCmdlet.ResultConfiguration_ExpectedBucketOwner"> <summary> <para> <para>The Amazon Web Services account ID that you expect to be the owner of the Amazon S3 bucket specified by <a>ResultConfiguration$OutputLocation</a>. If set, Athena uses the value for <c>ExpectedBucketOwner</c> when it makes Amazon S3 calls to your specified output location. If the <c>ExpectedBucketOwner</c> Amazon Web Services account ID does not match the actual owner of the Amazon S3 bucket, the call fails with a permissions error.</para><para>This is a client-side setting. If workgroup settings override client-side settings, then the query uses the <c>ExpectedBucketOwner</c> setting that is specified for the workgroup, and also uses the location for storing query results specified in the workgroup. See <a>WorkGroupConfiguration$EnforceWorkGroupConfiguration</a> and <a href="https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html">Workgroup Settings Override Client-Side Settings</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.StartATHQueryExecutionCmdlet.EncryptionConfiguration_KmsKey"> <summary> <para> <para>For <c>SSE_KMS</c> and <c>CSE_KMS</c>, this is the KMS key ARN or ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.StartATHQueryExecutionCmdlet.ResultReuseByAgeConfiguration_MaxAgeInMinute"> <summary> <para> <para>Specifies, in minutes, the maximum age of a previous query result that Athena should consider for reuse. The default is 60.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.StartATHQueryExecutionCmdlet.ResultConfiguration_OutputLocation"> <summary> <para> <para>The location in Amazon S3 where your query and calculation results are stored, such as <c>s3://path/to/query/bucket/</c>. To run the query, you must specify the query results location using one of the ways: either for individual queries using either this setting (client-side), or in the workgroup, using <a>WorkGroupConfiguration</a>. If none of them is set, Athena issues an error that no output location is provided. For more information, see <a href="https://docs.aws.amazon.com/athena/latest/ug/querying.html">Working with query results, recent queries, and output files</a>. If workgroup settings override client-side settings, then the query uses the settings specified for the workgroup. See <a>WorkGroupConfiguration$EnforceWorkGroupConfiguration</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.StartATHQueryExecutionCmdlet.QueryString"> <summary> <para> <para>The SQL query statements to be executed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.StartATHQueryExecutionCmdlet.AclConfiguration_S3AclOption"> <summary> <para> <para>The Amazon S3 canned ACL that Athena should specify when storing query results. Currently the only supported canned ACL is <c>BUCKET_OWNER_FULL_CONTROL</c>. If a query runs in a workgroup and the workgroup overrides client-side settings, then the Amazon S3 canned ACL specified in the workgroup's settings is used for all queries that run in the workgroup. For more information about Amazon S3 canned ACLs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/acl-overview.html#canned-acl">Canned ACL</a> in the <i>Amazon S3 User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.StartATHQueryExecutionCmdlet.WorkGroup"> <summary> <para> <para>The name of the workgroup in which the query is being started.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.StartATHQueryExecutionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'QueryExecutionId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Athena.Model.StartQueryExecutionResponse). Specifying the name of a property of type Amazon.Athena.Model.StartQueryExecutionResponse 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.ATH.StartATHQueryExecutionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the QueryString parameter. The -PassThru parameter is deprecated, use -Select '^QueryString' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.StartATHQueryExecutionCmdlet.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.ATH.StartATHSessionCmdlet"> <summary> Creates a session for running calculations within a workgroup. The session is ready when it reaches an <c>IDLE</c> state. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.StartATHSessionCmdlet.EngineConfiguration_AdditionalConfig"> <summary> <para> <para>Contains additional notebook engine <c>MAP<string, string></c> parameter mappings in the form of key-value pairs. To specify an Athena notebook that the Jupyter server will download and serve, specify a value for the <a>StartSessionRequest$NotebookVersion</a> field, and then add a key named <c>NotebookId</c> to <c>AdditionalConfigs</c> that has the value of the Athena notebook ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.StartATHSessionCmdlet.ClientRequestToken"> <summary> <para> <para>A unique case-sensitive string used to ensure the request to create the session is idempotent (executes only once). If another <c>StartSessionRequest</c> is received, the same response is returned and another session is not created. If a parameter has changed, an error is returned.</para><important><para>This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) auto-generate the token for users. If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide this token or the action will fail.</para></important> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.StartATHSessionCmdlet.EngineConfiguration_CoordinatorDpuSize"> <summary> <para> <para>The number of DPUs to use for the coordinator. A coordinator is a special executor that orchestrates processing work and manages other executors in a notebook session. The default is 1.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.StartATHSessionCmdlet.EngineConfiguration_DefaultExecutorDpuSize"> <summary> <para> <para>The default number of DPUs to use for executors. An executor is the smallest unit of compute that a notebook session can request from Athena. The default is 1.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.StartATHSessionCmdlet.Description"> <summary> <para> <para>The session description.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.StartATHSessionCmdlet.EngineConfiguration_MaxConcurrentDpus"> <summary> <para> <para>The maximum number of DPUs that can run concurrently.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.StartATHSessionCmdlet.NotebookVersion"> <summary> <para> <para>The notebook version. This value is supplied automatically for notebook sessions in the Athena console and is not required for programmatic session access. The only valid notebook version is <c>Athena notebook version 1</c>. If you specify a value for <c>NotebookVersion</c>, you must also specify a value for <c>NotebookId</c>. See <a>EngineConfiguration$AdditionalConfigs</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.StartATHSessionCmdlet.SessionIdleTimeoutInMinute"> <summary> <para> <para>The idle timeout in minutes for the session.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.StartATHSessionCmdlet.EngineConfiguration_SparkProperty"> <summary> <para> <para>Specifies custom jar files and Spark properties for use cases like cluster encryption, table formats, and general Spark tuning.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.StartATHSessionCmdlet.WorkGroup"> <summary> <para> <para>The workgroup to which the session belongs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.StartATHSessionCmdlet.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.Athena.Model.StartSessionResponse). Specifying the name of a property of type Amazon.Athena.Model.StartSessionResponse 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.ATH.StartATHSessionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the WorkGroup parameter. The -PassThru parameter is deprecated, use -Select '^WorkGroup' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.StartATHSessionCmdlet.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.ATH.StopATHCalculationExecutionCmdlet"> <summary> Requests the cancellation of a calculation. A <c>StopCalculationExecution</c> call on a calculation that is already in a terminal state (for example, <c>STOPPED</c>, <c>FAILED</c>, or <c>COMPLETED</c>) succeeds but has no effect. <note><para> Cancelling a calculation is done on a best effort basis. If a calculation cannot be cancelled, you can be charged for its completion. If you are concerned about being charged for a calculation that cannot be cancelled, consider terminating the session in which the calculation is running. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.StopATHCalculationExecutionCmdlet.CalculationExecutionId"> <summary> <para> <para>The calculation execution UUID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.StopATHCalculationExecutionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'State'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Athena.Model.StopCalculationExecutionResponse). Specifying the name of a property of type Amazon.Athena.Model.StopCalculationExecutionResponse 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.ATH.StopATHCalculationExecutionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the CalculationExecutionId parameter. The -PassThru parameter is deprecated, use -Select '^CalculationExecutionId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.StopATHCalculationExecutionCmdlet.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.ATH.StopATHCapacityReservationCmdlet"> <summary> Cancels the capacity reservation with the specified name. Cancelled reservations remain in your account and will be deleted 45 days after cancellation. During the 45 days, you cannot re-purpose or reuse a reservation that has been cancelled, but you can refer to its tags and view it for historical reference. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.StopATHCapacityReservationCmdlet.Name"> <summary> <para> <para>The name of the capacity reservation to cancel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.StopATHCapacityReservationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Athena.Model.CancelCapacityReservationResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.StopATHCapacityReservationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.StopATHCapacityReservationCmdlet.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.ATH.StopATHQueryExecutionCmdlet"> <summary> Stops a query execution. Requires you to have access to the workgroup in which the query ran. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.StopATHQueryExecutionCmdlet.QueryExecutionId"> <summary> <para> <para>The unique ID of the query execution to stop.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.StopATHQueryExecutionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Athena.Model.StopQueryExecutionResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.StopATHQueryExecutionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the QueryExecutionId parameter. The -PassThru parameter is deprecated, use -Select '^QueryExecutionId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.StopATHQueryExecutionCmdlet.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.ATH.UpdateATHCapacityReservationCmdlet"> <summary> Updates the number of requested data processing units for the capacity reservation with the specified name. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.UpdateATHCapacityReservationCmdlet.Name"> <summary> <para> <para>The name of the capacity reservation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.UpdateATHCapacityReservationCmdlet.TargetDpus"> <summary> <para> <para>The new number of requested data processing units.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.UpdateATHCapacityReservationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Athena.Model.UpdateCapacityReservationResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.UpdateATHCapacityReservationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.UpdateATHCapacityReservationCmdlet.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.ATH.UpdateATHDataCatalogCmdlet"> <summary> Updates the data catalog that has the specified name. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.UpdateATHDataCatalogCmdlet.Description"> <summary> <para> <para>New or modified text that describes the data catalog.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.UpdateATHDataCatalogCmdlet.Name"> <summary> <para> <para>The name of the data catalog to update. The catalog name must be unique for the Amazon Web Services account and can use a maximum of 127 alphanumeric, underscore, at sign, or hyphen characters. The remainder of the length constraint of 256 is reserved for use by Athena.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.UpdateATHDataCatalogCmdlet.Parameter"> <summary> <para> <para>Specifies the Lambda function or functions to use for updating the data catalog. This is a mapping whose values depend on the catalog type. </para><ul><li><para>For the <c>HIVE</c> data catalog type, use the following syntax. The <c>metadata-function</c> parameter is required. <c>The sdk-version</c> parameter is optional and defaults to the currently supported version.</para><para><c>metadata-function=<i>lambda_arn</i>, sdk-version=<i>version_number</i></c></para></li><li><para>For the <c>LAMBDA</c> data catalog type, use one of the following sets of required parameters, but not both.</para><ul><li><para>If you have one Lambda function that processes metadata and another for reading the actual data, use the following syntax. Both parameters are required.</para><para><c>metadata-function=<i>lambda_arn</i>, record-function=<i>lambda_arn</i></c></para></li><li><para> If you have a composite Lambda function that processes both metadata and data, use the following syntax to specify your Lambda function.</para><para><c>function=<i>lambda_arn</i></c></para></li></ul></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.UpdateATHDataCatalogCmdlet.Type"> <summary> <para> <para>Specifies the type of data catalog to update. Specify <c>LAMBDA</c> for a federated catalog, <c>HIVE</c> for an external hive metastore, or <c>GLUE</c> for an Glue Data Catalog.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.UpdateATHDataCatalogCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Athena.Model.UpdateDataCatalogResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.UpdateATHDataCatalogCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.UpdateATHDataCatalogCmdlet.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.ATH.UpdateATHNamedQueryCmdlet"> <summary> Updates a <a>NamedQuery</a> object. The database or workgroup cannot be updated. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.UpdateATHNamedQueryCmdlet.Description"> <summary> <para> <para>The query description.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.UpdateATHNamedQueryCmdlet.Name"> <summary> <para> <para>The name of the query.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.UpdateATHNamedQueryCmdlet.NamedQueryId"> <summary> <para> <para>The unique identifier (UUID) of the query.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.UpdateATHNamedQueryCmdlet.QueryString"> <summary> <para> <para>The contents of the query with all query statements.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.UpdateATHNamedQueryCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Athena.Model.UpdateNamedQueryResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.UpdateATHNamedQueryCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the NamedQueryId parameter. The -PassThru parameter is deprecated, use -Select '^NamedQueryId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.UpdateATHNamedQueryCmdlet.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.ATH.UpdateATHNotebookCmdlet"> <summary> Updates the contents of a Spark notebook. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.UpdateATHNotebookCmdlet.ClientRequestToken"> <summary> <para> <para>A unique case-sensitive string used to ensure the request to create the notebook is idempotent (executes only once).</para><important><para>This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) auto-generate the token for you. If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide this token or the action will fail.</para></important> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.UpdateATHNotebookCmdlet.NotebookId"> <summary> <para> <para>The ID of the notebook to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.UpdateATHNotebookCmdlet.Payload"> <summary> <para> <para>The updated content for the notebook.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.UpdateATHNotebookCmdlet.SessionId"> <summary> <para> <para>The active notebook session ID. Required if the notebook has an active session.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.UpdateATHNotebookCmdlet.Type"> <summary> <para> <para>The notebook content type. Currently, the only valid type is <c>IPYNB</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.UpdateATHNotebookCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Athena.Model.UpdateNotebookResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.UpdateATHNotebookCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the NotebookId parameter. The -PassThru parameter is deprecated, use -Select '^NotebookId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.UpdateATHNotebookCmdlet.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.ATH.UpdateATHNotebookMetadataCmdlet"> <summary> Updates the metadata for a notebook. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.UpdateATHNotebookMetadataCmdlet.ClientRequestToken"> <summary> <para> <para>A unique case-sensitive string used to ensure the request to create the notebook is idempotent (executes only once).</para><important><para>This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) auto-generate the token for you. If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide this token or the action will fail.</para></important> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.UpdateATHNotebookMetadataCmdlet.Name"> <summary> <para> <para>The name to update the notebook to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.UpdateATHNotebookMetadataCmdlet.NotebookId"> <summary> <para> <para>The ID of the notebook to update the metadata for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.UpdateATHNotebookMetadataCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Athena.Model.UpdateNotebookMetadataResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.UpdateATHNotebookMetadataCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the NotebookId parameter. The -PassThru parameter is deprecated, use -Select '^NotebookId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.UpdateATHNotebookMetadataCmdlet.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.ATH.UpdateATHPreparedStatementCmdlet"> <summary> Updates a prepared statement. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.UpdateATHPreparedStatementCmdlet.Description"> <summary> <para> <para>The description of the prepared statement.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.UpdateATHPreparedStatementCmdlet.QueryStatement"> <summary> <para> <para>The query string for the prepared statement.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.UpdateATHPreparedStatementCmdlet.StatementName"> <summary> <para> <para>The name of the prepared statement.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.UpdateATHPreparedStatementCmdlet.WorkGroup"> <summary> <para> <para>The workgroup for the prepared statement.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.UpdateATHPreparedStatementCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Athena.Model.UpdatePreparedStatementResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.UpdateATHPreparedStatementCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the StatementName parameter. The -PassThru parameter is deprecated, use -Select '^StatementName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.UpdateATHPreparedStatementCmdlet.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.ATH.UpdateATHWorkGroupCmdlet"> <summary> Updates the workgroup with the specified name. The workgroup's name cannot be changed. Only <c>ConfigurationUpdates</c> can be specified. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.UpdateATHWorkGroupCmdlet.ConfigurationUpdates_AdditionalConfiguration"> <summary> <para> <para>Contains a user defined string in JSON format for a Spark-enabled workgroup.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.UpdateATHWorkGroupCmdlet.QueryResultsS3AccessGrantsConfiguration_AuthenticationType"> <summary> <para> <para>The authentication type used for Amazon S3 access grants. Currently, only <c>DIRECTORY_IDENTITY</c> is supported.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.UpdateATHWorkGroupCmdlet.ConfigurationUpdates_BytesScannedCutoffPerQuery"> <summary> <para> <para>The upper limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.UpdateATHWorkGroupCmdlet.QueryResultsS3AccessGrantsConfiguration_CreateUserLevelPrefix"> <summary> <para> <para>When enabled, appends the user ID as an Amazon S3 path prefix to the query result output location.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.UpdateATHWorkGroupCmdlet.Description"> <summary> <para> <para>The workgroup description.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.UpdateATHWorkGroupCmdlet.EngineVersion_EffectiveEngineVersion"> <summary> <para> <para>Read only. The engine version on which the query runs. If the user requests a valid engine version other than Auto, the effective engine version is the same as the engine version that the user requested. If the user requests Auto, the effective engine version is chosen by Athena. When a request to update the engine version is made by a <c>CreateWorkGroup</c> or <c>UpdateWorkGroup</c> operation, the <c>EffectiveEngineVersion</c> field is ignored.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.UpdateATHWorkGroupCmdlet.ConfigurationUpdates_EnableMinimumEncryptionConfiguration"> <summary> <para> <para>Enforces a minimal level of encryption for the workgroup for query and calculation results that are written to Amazon S3. When enabled, workgroup users can set encryption only to the minimum level set by the administrator or higher when they submit queries. This setting does not apply to Spark-enabled workgroups.</para><para>The <c>EnforceWorkGroupConfiguration</c> setting takes precedence over the <c>EnableMinimumEncryptionConfiguration</c> flag. This means that if <c>EnforceWorkGroupConfiguration</c> is true, the <c>EnableMinimumEncryptionConfiguration</c> flag is ignored, and the workgroup configuration for encryption is used.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.UpdateATHWorkGroupCmdlet.QueryResultsS3AccessGrantsConfiguration_EnableS3AccessGrant"> <summary> <para> <para>Specifies whether Amazon S3 access grants are enabled for query results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.UpdateATHWorkGroupCmdlet.EncryptionConfiguration_EncryptionOption"> <summary> <para> <para>Indicates whether Amazon S3 server-side encryption with Amazon S3-managed keys (<c>SSE_S3</c>), server-side encryption with KMS-managed keys (<c>SSE_KMS</c>), or client-side encryption with KMS-managed keys (<c>CSE_KMS</c>) is used.</para><para>If a query runs in a workgroup and the workgroup overrides client-side settings, then the workgroup's setting for encryption is used. It specifies whether query results must be encrypted, for all queries that run in this workgroup. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.UpdateATHWorkGroupCmdlet.ConfigurationUpdates_EnforceWorkGroupConfiguration"> <summary> <para> <para>If set to "true", the settings for the workgroup override client-side settings. If set to "false" client-side settings are used. For more information, see <a href="https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html">Workgroup Settings Override Client-Side Settings</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.UpdateATHWorkGroupCmdlet.ConfigurationUpdates_ExecutionRole"> <summary> <para> <para>The ARN of the execution role used to access user resources for Spark sessions and Identity Center enabled workgroups. This property applies only to Spark enabled workgroups and Identity Center enabled workgroups.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.UpdateATHWorkGroupCmdlet.ResultConfigurationUpdates_ExpectedBucketOwner"> <summary> <para> <para>The Amazon Web Services account ID that you expect to be the owner of the Amazon S3 bucket specified by <a>ResultConfiguration$OutputLocation</a>. If set, Athena uses the value for <c>ExpectedBucketOwner</c> when it makes Amazon S3 calls to your specified output location. If the <c>ExpectedBucketOwner</c> Amazon Web Services account ID does not match the actual owner of the Amazon S3 bucket, the call fails with a permissions error.</para><para>If workgroup settings override client-side settings, then the query uses the <c>ExpectedBucketOwner</c> setting that is specified for the workgroup, and also uses the location for storing query results specified in the workgroup. See <a>WorkGroupConfiguration$EnforceWorkGroupConfiguration</a> and <a href="https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html">Workgroup Settings Override Client-Side Settings</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.UpdateATHWorkGroupCmdlet.CustomerContentEncryptionConfiguration_KmsKey"> <summary> <para> <para>The customer managed KMS key that is used to encrypt the user's data stores in Athena.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.UpdateATHWorkGroupCmdlet.EncryptionConfiguration_KmsKey"> <summary> <para> <para>For <c>SSE_KMS</c> and <c>CSE_KMS</c>, this is the KMS key ARN or ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.UpdateATHWorkGroupCmdlet.ResultConfigurationUpdates_OutputLocation"> <summary> <para> <para>The location in Amazon S3 where your query and calculation results are stored, such as <c>s3://path/to/query/bucket/</c>. For more information, see <a href="https://docs.aws.amazon.com/athena/latest/ug/querying.html">Working with query results, recent queries, and output files</a>. If workgroup settings override client-side settings, then the query uses the location for the query results and the encryption configuration that are specified for the workgroup. The "workgroup settings override" is specified in <c>EnforceWorkGroupConfiguration</c> (true/false) in the <c>WorkGroupConfiguration</c>. See <a>WorkGroupConfiguration$EnforceWorkGroupConfiguration</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.UpdateATHWorkGroupCmdlet.ConfigurationUpdates_PublishCloudWatchMetricsEnabled"> <summary> <para> <para>Indicates whether this workgroup enables publishing metrics to Amazon CloudWatch.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.UpdateATHWorkGroupCmdlet.ResultConfigurationUpdates_RemoveAclConfiguration"> <summary> <para> <para>If set to <c>true</c>, indicates that the previously-specified ACL configuration for queries in this workgroup should be ignored and set to null. If set to <c>false</c> or not set, and a value is present in the <c>AclConfiguration</c> of <c>ResultConfigurationUpdates</c>, the <c>AclConfiguration</c> in the workgroup's <c>ResultConfiguration</c> is updated with the new value. For more information, see <a href="https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html">Workgroup Settings Override Client-Side Settings</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.UpdateATHWorkGroupCmdlet.ConfigurationUpdates_RemoveBytesScannedCutoffPerQuery"> <summary> <para> <para>Indicates that the data usage control limit per query is removed. <a>WorkGroupConfiguration$BytesScannedCutoffPerQuery</a></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.UpdateATHWorkGroupCmdlet.ConfigurationUpdates_RemoveCustomerContentEncryptionConfiguration"> <summary> <para> <para>Removes content encryption configuration from an Apache Spark-enabled Athena workgroup.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.UpdateATHWorkGroupCmdlet.ResultConfigurationUpdates_RemoveEncryptionConfiguration"> <summary> <para> <para>If set to "true", indicates that the previously-specified encryption configuration (also known as the client-side setting) for queries in this workgroup should be ignored and set to null. If set to "false" or not set, and a value is present in the <c>EncryptionConfiguration</c> in <c>ResultConfigurationUpdates</c> (the client-side setting), the <c>EncryptionConfiguration</c> in the workgroup's <c>ResultConfiguration</c> will be updated with the new value. For more information, see <a href="https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html">Workgroup Settings Override Client-Side Settings</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.UpdateATHWorkGroupCmdlet.ResultConfigurationUpdates_RemoveExpectedBucketOwner"> <summary> <para> <para>If set to "true", removes the Amazon Web Services account ID previously specified for <a>ResultConfiguration$ExpectedBucketOwner</a>. If set to "false" or not set, and a value is present in the <c>ExpectedBucketOwner</c> in <c>ResultConfigurationUpdates</c> (the client-side setting), the <c>ExpectedBucketOwner</c> in the workgroup's <c>ResultConfiguration</c> is updated with the new value. For more information, see <a href="https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html">Workgroup Settings Override Client-Side Settings</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.UpdateATHWorkGroupCmdlet.ResultConfigurationUpdates_RemoveOutputLocation"> <summary> <para> <para>If set to "true", indicates that the previously-specified query results location (also known as a client-side setting) for queries in this workgroup should be ignored and set to null. If set to "false" or not set, and a value is present in the <c>OutputLocation</c> in <c>ResultConfigurationUpdates</c> (the client-side setting), the <c>OutputLocation</c> in the workgroup's <c>ResultConfiguration</c> will be updated with the new value. For more information, see <a href="https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html">Workgroup Settings Override Client-Side Settings</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.UpdateATHWorkGroupCmdlet.ConfigurationUpdates_RequesterPaysEnabled"> <summary> <para> <para>If set to <c>true</c>, allows members assigned to a workgroup to specify Amazon S3 Requester Pays buckets in queries. If set to <c>false</c>, workgroup members cannot query data from Requester Pays buckets, and queries that retrieve data from Requester Pays buckets cause an error. The default is <c>false</c>. For more information about Requester Pays buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html">Requester Pays Buckets</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.UpdateATHWorkGroupCmdlet.AclConfiguration_S3AclOption"> <summary> <para> <para>The Amazon S3 canned ACL that Athena should specify when storing query results. Currently the only supported canned ACL is <c>BUCKET_OWNER_FULL_CONTROL</c>. If a query runs in a workgroup and the workgroup overrides client-side settings, then the Amazon S3 canned ACL specified in the workgroup's settings is used for all queries that run in the workgroup. For more information about Amazon S3 canned ACLs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/acl-overview.html#canned-acl">Canned ACL</a> in the <i>Amazon S3 User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.UpdateATHWorkGroupCmdlet.EngineVersion_SelectedEngineVersion"> <summary> <para> <para>The engine version requested by the user. Possible values are determined by the output of <c>ListEngineVersions</c>, including AUTO. The default is AUTO.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.UpdateATHWorkGroupCmdlet.State"> <summary> <para> <para>The workgroup state that will be updated for the given workgroup.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.UpdateATHWorkGroupCmdlet.WorkGroup"> <summary> <para> <para>The specified workgroup that will be updated.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.UpdateATHWorkGroupCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Athena.Model.UpdateWorkGroupResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.UpdateATHWorkGroupCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the WorkGroup parameter. The -PassThru parameter is deprecated, use -Select '^WorkGroup' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.UpdateATHWorkGroupCmdlet.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.ATH.WriteATHCapacityAssignmentConfigurationCmdlet"> <summary> Puts a new capacity assignment configuration for a specified capacity reservation. If a capacity assignment configuration already exists for the capacity reservation, replaces the existing capacity assignment configuration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.WriteATHCapacityAssignmentConfigurationCmdlet.CapacityAssignment"> <summary> <para> <para>The list of assignments for the capacity assignment configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.WriteATHCapacityAssignmentConfigurationCmdlet.CapacityReservationName"> <summary> <para> <para>The name of the capacity reservation to put a capacity assignment configuration for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.WriteATHCapacityAssignmentConfigurationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Athena.Model.PutCapacityAssignmentConfigurationResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.WriteATHCapacityAssignmentConfigurationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the CapacityReservationName parameter. The -PassThru parameter is deprecated, use -Select '^CapacityReservationName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ATH.WriteATHCapacityAssignmentConfigurationCmdlet.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> |