AWS.Tools.BCMDataExports.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.BCMDataExports</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.BCMDE.AddBCMDEResourceTagCmdlet"> <summary> Adds tags for an existing data export definition. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMDE.AddBCMDEResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The unique identifier for the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMDE.AddBCMDEResourceTagCmdlet.ResourceTag"> <summary> <para> <para>The tags to associate with the resource. Each tag consists of a key and a value, and each key must be unique for the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMDE.AddBCMDEResourceTagCmdlet.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.BCMDataExports.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMDE.AddBCMDEResourceTagCmdlet.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.BCMDE.GetBCMDEExecutionCmdlet"> <summary> Exports data based on the source data update. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMDE.GetBCMDEExecutionCmdlet.ExecutionId"> <summary> <para> <para>The ID for this specific execution.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMDE.GetBCMDEExecutionCmdlet.ExportArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the Export object that generated this specific execution.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMDE.GetBCMDEExecutionCmdlet.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.BCMDataExports.Model.GetExecutionResponse). Specifying the name of a property of type Amazon.BCMDataExports.Model.GetExecutionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.BCMDE.GetBCMDEExecutionListCmdlet"> <summary> Lists the historical executions for the export. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMDE.GetBCMDEExecutionListCmdlet.ExportArn"> <summary> <para> <para>The Amazon Resource Name (ARN) for this export.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMDE.GetBCMDEExecutionListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of objects that are returned for the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMDE.GetBCMDEExecutionListCmdlet.NextToken"> <summary> <para> <para>The token to retrieve the next set of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMDE.GetBCMDEExecutionListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Executions'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BCMDataExports.Model.ListExecutionsResponse). Specifying the name of a property of type Amazon.BCMDataExports.Model.ListExecutionsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.BCMDE.GetBCMDEExportCmdlet"> <summary> Views the definition of an existing data export. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMDE.GetBCMDEExportCmdlet.ExportArn"> <summary> <para> <para>The Amazon Resource Name (ARN) for this export.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMDE.GetBCMDEExportCmdlet.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.BCMDataExports.Model.GetExportResponse). Specifying the name of a property of type Amazon.BCMDataExports.Model.GetExportResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.BCMDE.GetBCMDEExportListCmdlet"> <summary> Lists all data export definitions. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMDE.GetBCMDEExportListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of objects that are returned for the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMDE.GetBCMDEExportListCmdlet.NextToken"> <summary> <para> <para>The token to retrieve the next set of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMDE.GetBCMDEExportListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Exports'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BCMDataExports.Model.ListExportsResponse). Specifying the name of a property of type Amazon.BCMDataExports.Model.ListExportsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.BCMDE.GetBCMDEResourceTagCmdlet"> <summary> List tags associated with an existing data export. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMDE.GetBCMDEResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The unique identifier for the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMDE.GetBCMDEResourceTagCmdlet.MaxResult"> <summary> <para> <para>The maximum number of objects that are returned for the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMDE.GetBCMDEResourceTagCmdlet.NextToken"> <summary> <para> <para>The token to retrieve the next set of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMDE.GetBCMDEResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ResourceTags'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BCMDataExports.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.BCMDataExports.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="T:Amazon.PowerShell.Cmdlets.BCMDE.GetBCMDETableCmdlet"> <summary> Returns the metadata for the specified table and table properties. This includes the list of columns in the table schema, their data types, and column descriptions. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMDE.GetBCMDETableCmdlet.TableName"> <summary> <para> <para>The name of the table.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMDE.GetBCMDETableCmdlet.TableProperty"> <summary> <para> <para>TableProperties are additional configurations you can provide to change the data and schema of a table. Each table can have different TableProperties. Tables are not required to have any TableProperties. Each table property has a default value that it assumes if not specified.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMDE.GetBCMDETableCmdlet.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.BCMDataExports.Model.GetTableResponse). Specifying the name of a property of type Amazon.BCMDataExports.Model.GetTableResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.BCMDE.GetBCMDETableListCmdlet"> <summary> Lists all available tables in data exports. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMDE.GetBCMDETableListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of objects that are returned for the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMDE.GetBCMDETableListCmdlet.NextToken"> <summary> <para> <para>The token to retrieve the next set of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMDE.GetBCMDETableListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Tables'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BCMDataExports.Model.ListTablesResponse). Specifying the name of a property of type Amazon.BCMDataExports.Model.ListTablesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.BCMDE.NewBCMDEExportCmdlet"> <summary> Creates a data export and specifies the data query, the delivery preference, and any optional resource tags. <para> A <c>DataQuery</c> consists of both a <c>QueryStatement</c> and <c>TableConfigurations</c>. </para><para> The <c>QueryStatement</c> is an SQL statement. Data Exports only supports a limited subset of the SQL syntax. For more information on the SQL syntax that is supported, see <a href="https://docs.aws.amazon.com/cur/latest/userguide/de-data-query.html">Data query</a>. To view the available tables and columns, see the <a href="https://docs.aws.amazon.com/cur/latest/userguide/de-table-dictionary.html">Data Exports table dictionary</a>. </para><para> The <c>TableConfigurations</c> is a collection of specified <c>TableProperties</c> for the table being queried in the <c>QueryStatement</c>. TableProperties are additional configurations you can provide to change the data and schema of a table. Each table can have different TableProperties. However, tables are not required to have any TableProperties. Each table property has a default value that it assumes if not specified. For more information on table configurations, see <a href="https://docs.aws.amazon.com/cur/latest/userguide/de-data-query.html">Data query</a>. To view the table properties available for each table, see the <a href="https://docs.aws.amazon.com/cur/latest/userguide/de-table-dictionary.html">Data Exports table dictionary</a> or use the <c>ListTables</c> API to get a response of all tables and their available properties. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMDE.NewBCMDEExportCmdlet.S3OutputConfigurations_Compression"> <summary> <para> <para>The compression type for the data export.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMDE.NewBCMDEExportCmdlet.Export_Description"> <summary> <para> <para>The description for this specific data export.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMDE.NewBCMDEExportCmdlet.Export_ExportArn"> <summary> <para> <para>The Amazon Resource Name (ARN) for this export.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMDE.NewBCMDEExportCmdlet.S3OutputConfigurations_Format"> <summary> <para> <para>The file format for the data export.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMDE.NewBCMDEExportCmdlet.RefreshCadence_Frequency"> <summary> <para> <para>The frequency that data exports are updated. The export refreshes each time the source data updates, up to three times daily.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMDE.NewBCMDEExportCmdlet.Export_Name"> <summary> <para> <para>The name of this specific data export.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMDE.NewBCMDEExportCmdlet.S3OutputConfigurations_OutputType"> <summary> <para> <para>The output type for the data export.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMDE.NewBCMDEExportCmdlet.S3OutputConfigurations_Overwrite"> <summary> <para> <para>The rule to follow when generating a version of the data export file. You have the choice to overwrite the previous version or to be delivered in addition to the previous versions. Overwriting exports can save on Amazon S3 storage costs. Creating new export versions allows you to track the changes in cost and usage data over time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMDE.NewBCMDEExportCmdlet.DataQuery_QueryStatement"> <summary> <para> <para>The query statement.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMDE.NewBCMDEExportCmdlet.ResourceTag"> <summary> <para> <para>An optional list of tags to associate with the specified export. Each tag consists of a key and a value, and each key must be unique for the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMDE.NewBCMDEExportCmdlet.S3Destination_S3Bucket"> <summary> <para> <para>The name of the Amazon S3 bucket used as the destination of a data export file.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMDE.NewBCMDEExportCmdlet.S3Destination_S3Prefix"> <summary> <para> <para>The S3 path prefix you want prepended to the name of your data export.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMDE.NewBCMDEExportCmdlet.S3Destination_S3Region"> <summary> <para> <para>The S3 bucket Region.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMDE.NewBCMDEExportCmdlet.DataQuery_TableConfiguration"> <summary> <para> <para>The table configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMDE.NewBCMDEExportCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ExportArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BCMDataExports.Model.CreateExportResponse). Specifying the name of a property of type Amazon.BCMDataExports.Model.CreateExportResponse 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.BCMDE.NewBCMDEExportCmdlet.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.BCMDE.RemoveBCMDEExportCmdlet"> <summary> Deletes an existing data export. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMDE.RemoveBCMDEExportCmdlet.ExportArn"> <summary> <para> <para>The Amazon Resource Name (ARN) for this export.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMDE.RemoveBCMDEExportCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ExportArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BCMDataExports.Model.DeleteExportResponse). Specifying the name of a property of type Amazon.BCMDataExports.Model.DeleteExportResponse 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.BCMDE.RemoveBCMDEExportCmdlet.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.BCMDE.RemoveBCMDEResourceTagCmdlet"> <summary> Deletes tags associated with an existing data export definition. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMDE.RemoveBCMDEResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The unique identifier for the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMDE.RemoveBCMDEResourceTagCmdlet.ResourceTagKey"> <summary> <para> <para>The tag keys that are associated with the resource ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMDE.RemoveBCMDEResourceTagCmdlet.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.BCMDataExports.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMDE.RemoveBCMDEResourceTagCmdlet.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.BCMDE.UpdateBCMDEExportCmdlet"> <summary> Updates an existing data export by overwriting all export parameters. All export parameters must be provided in the UpdateExport request. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMDE.UpdateBCMDEExportCmdlet.S3OutputConfigurations_Compression"> <summary> <para> <para>The compression type for the data export.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMDE.UpdateBCMDEExportCmdlet.Export_Description"> <summary> <para> <para>The description for this specific data export.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMDE.UpdateBCMDEExportCmdlet.Export_ExportArn"> <summary> <para> <para>The Amazon Resource Name (ARN) for this export.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMDE.UpdateBCMDEExportCmdlet.ExportArn"> <summary> <para> <para>The Amazon Resource Name (ARN) for this export.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMDE.UpdateBCMDEExportCmdlet.S3OutputConfigurations_Format"> <summary> <para> <para>The file format for the data export.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMDE.UpdateBCMDEExportCmdlet.RefreshCadence_Frequency"> <summary> <para> <para>The frequency that data exports are updated. The export refreshes each time the source data updates, up to three times daily.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMDE.UpdateBCMDEExportCmdlet.Export_Name"> <summary> <para> <para>The name of this specific data export.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMDE.UpdateBCMDEExportCmdlet.S3OutputConfigurations_OutputType"> <summary> <para> <para>The output type for the data export.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMDE.UpdateBCMDEExportCmdlet.S3OutputConfigurations_Overwrite"> <summary> <para> <para>The rule to follow when generating a version of the data export file. You have the choice to overwrite the previous version or to be delivered in addition to the previous versions. Overwriting exports can save on Amazon S3 storage costs. Creating new export versions allows you to track the changes in cost and usage data over time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMDE.UpdateBCMDEExportCmdlet.DataQuery_QueryStatement"> <summary> <para> <para>The query statement.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMDE.UpdateBCMDEExportCmdlet.S3Destination_S3Bucket"> <summary> <para> <para>The name of the Amazon S3 bucket used as the destination of a data export file.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMDE.UpdateBCMDEExportCmdlet.S3Destination_S3Prefix"> <summary> <para> <para>The S3 path prefix you want prepended to the name of your data export.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMDE.UpdateBCMDEExportCmdlet.S3Destination_S3Region"> <summary> <para> <para>The S3 bucket Region.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMDE.UpdateBCMDEExportCmdlet.DataQuery_TableConfiguration"> <summary> <para> <para>The table configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMDE.UpdateBCMDEExportCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ExportArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BCMDataExports.Model.UpdateExportResponse). Specifying the name of a property of type Amazon.BCMDataExports.Model.UpdateExportResponse 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.BCMDE.UpdateBCMDEExportCmdlet.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> |