AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the AWSBillingAndCostManagementDataExports CreateExport API operation.

Syntax

New-BCMDEExport
-S3OutputConfigurations_Compression <CompressionOption>
-Export_Description <String>
-Export_ExportArn <String>
-S3OutputConfigurations_Format <FormatOption>
-RefreshCadence_Frequency <FrequencyOption>
-Export_Name <String>
-S3OutputConfigurations_OutputType <S3OutputType>
-S3OutputConfigurations_Overwrite <OverwriteOption>
-DataQuery_QueryStatement <String>
-ResourceTag <ResourceTag[]>
-S3Destination_S3Bucket <String>
-S3Destination_S3Prefix <String>
-S3Destination_S3Region <String>
-DataQuery_TableConfiguration <Hashtable>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonBCMDataExportsConfig>

Description

Creates a data export and specifies the data query, the delivery preference, and any optional resource tags. A DataQuery consists of both a QueryStatement and TableConfigurations. The QueryStatement 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 Data query. To view the available tables and columns, see the Data Exports table dictionary. The TableConfigurations is a collection of specified TableProperties for the table being queried in the QueryStatement. 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 Data query. To view the table properties available for each table, see the Data Exports table dictionary or use the ListTables API to get a response of all tables and their available properties.

Parameters

-ClientConfig <AmazonBCMDataExportsConfig>
Amazon.PowerShell.Cmdlets.BCMDE.AmazonBCMDataExportsClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DataQuery_QueryStatement <String>
The query statement.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesExport_DataQuery_QueryStatement
-DataQuery_TableConfiguration <Hashtable>
The table configuration. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesExport_DataQuery_TableConfigurations
-Export_Description <String>
The description for this specific data export.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Export_ExportArn <String>
The Amazon Resource Name (ARN) for this export.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Export_Name <String>
The name of this specific data export.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RefreshCadence_Frequency <FrequencyOption>
The frequency that data exports are updated. The export refreshes each time the source data updates, up to three times daily.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesExport_RefreshCadence_Frequency
-ResourceTag <ResourceTag[]>
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. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesResourceTags
-S3Destination_S3Bucket <String>
The name of the Amazon S3 bucket used as the destination of a data export file.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesExport_DestinationConfigurations_S3Destination_S3Bucket
-S3Destination_S3Prefix <String>
The S3 path prefix you want prepended to the name of your data export.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesExport_DestinationConfigurations_S3Destination_S3Prefix
-S3Destination_S3Region <String>
The S3 bucket Region.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesExport_DestinationConfigurations_S3Destination_S3Region
-S3OutputConfigurations_Compression <CompressionOption>
The compression type for the data export.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesExport_DestinationConfigurations_S3Destination_S3OutputConfigurations_Compression
-S3OutputConfigurations_Format <FormatOption>
The file format for the data export.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesExport_DestinationConfigurations_S3Destination_S3OutputConfigurations_Format
-S3OutputConfigurations_OutputType <S3OutputType>
The output type for the data export.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesExport_DestinationConfigurations_S3Destination_S3OutputConfigurations_OutputType
-S3OutputConfigurations_Overwrite <OverwriteOption>
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.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesExport_DestinationConfigurations_S3Destination_S3OutputConfigurations_Overwrite
-Select <String>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

System.String or Amazon.BCMDataExports.Model.CreateExportResponse
This cmdlet returns a System.String object. The service call response (type Amazon.BCMDataExports.Model.CreateExportResponse) can be returned by specifying '-Select *'.
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z