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 AWS Application Discovery Service StartExportTask API operation.

Syntax

Start-ADSExportTask
-ExportDataFormat <String[]>
-Ec2RecommendationsPreferences_Enabled <Boolean>
-EndTime <DateTime>
-Ec2RecommendationsPreferences_ExcludedInstanceType <String[]>
-Filter <ExportFilter[]>
-CpuPerformanceMetricBasis_Name <String>
-RamPerformanceMetricBasis_Name <String>
-ReservedInstanceOptions_OfferingClass <OfferingClass>
-CpuPerformanceMetricBasis_PercentageAdjust <Double>
-RamPerformanceMetricBasis_PercentageAdjust <Double>
-Ec2RecommendationsPreferences_PreferredRegion <String>
-ReservedInstanceOptions_PurchasingOption <PurchasingOption>
-StartTime <DateTime>
-Ec2RecommendationsPreferences_Tenancy <Tenancy>
-ReservedInstanceOptions_TermLength <TermLength>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonApplicationDiscoveryServiceConfig>

Description

Begins the export of a discovered data report to an Amazon S3 bucket managed by Amazon Web Services. Exports might provide an estimate of fees and savings based on certain information that you provide. Fee estimates do not include any taxes that might apply. Your actual fees and savings depend on a variety of factors, including your actual usage of Amazon Web Services services, which might vary from the estimates provided in this report. If you do not specify preferences or agentIds in the filter, a summary of all servers, applications, tags, and performance is generated. This data is an aggregation of all server data collected through on-premises tooling, file import, application grouping and applying tags. If you specify agentIds in a filter, the task exports up to 72 hours of detailed data collected by the identified Application Discovery Agent, including network, process, and performance details. A time range for exported agent data may be set by using startTime and endTime. Export of detailed agent data is limited to five concurrently running exports. Export of detailed agent data is limited to two exports per day. If you enable ec2RecommendationsPreferences in preferences , an Amazon EC2 instance matching the characteristics of each server in Application Discovery Service is generated. Changing the attributes of the ec2RecommendationsPreferences changes the criteria of the recommendation.

Parameters

-ClientConfig <AmazonApplicationDiscoveryServiceConfig>
Amazon.PowerShell.Cmdlets.ADS.AmazonApplicationDiscoveryServiceClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CpuPerformanceMetricBasis_Name <String>
A utilization metric that is used by the recommendations.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPreferences_Ec2RecommendationsPreferences_CpuPerformanceMetricBasis_Name
-CpuPerformanceMetricBasis_PercentageAdjust <Double>
Specifies the percentage of the specified utilization metric that is used by the recommendations.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPreferences_Ec2RecommendationsPreferences_CpuPerformanceMetricBasis_PercentageAdjust
-Ec2RecommendationsPreferences_Enabled <Boolean>
If set to true, the export preferences is set to Ec2RecommendationsExportPreferences.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPreferences_Ec2RecommendationsPreferences_Enabled
-Ec2RecommendationsPreferences_ExcludedInstanceType <String[]>
An array of instance types to exclude from recommendations. 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)
AliasesPreferences_Ec2RecommendationsPreferences_ExcludedInstanceTypes
-Ec2RecommendationsPreferences_PreferredRegion <String>
The target Amazon Web Services Region for the recommendations. You can use any of the Region codes available for the chosen service, as listed in Amazon Web Services service endpoints in the Amazon Web Services General Reference.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPreferences_Ec2RecommendationsPreferences_PreferredRegion
-Ec2RecommendationsPreferences_Tenancy <Tenancy>
The target tenancy to use for your recommended EC2 instances.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPreferences_Ec2RecommendationsPreferences_Tenancy
-EndTime <DateTime>
The end timestamp for exported data from the single Application Discovery Agent selected in the filters. If no value is specified, exported data includes the most recent data collected by the agent.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ExportDataFormat <String[]>
The file format for the returned export data. Default value is CSV. Note:TheGRAPHMLoption has been deprecated. 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?1
Accept pipeline input?True (ByValue, ByPropertyName)
-Filter <ExportFilter[]>
If a filter is present, it selects the single agentId of the Application Discovery Agent for which data is exported. The agentId can be found in the results of the DescribeAgents API or CLI. If no filter is present, startTime and endTime are ignored and exported data includes both Amazon Web Services Application Discovery Service Agentless Collector collectors data and summary data from Application Discovery Agent agents. 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)
AliasesFilters
-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)
-RamPerformanceMetricBasis_Name <String>
A utilization metric that is used by the recommendations.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPreferences_Ec2RecommendationsPreferences_RamPerformanceMetricBasis_Name
-RamPerformanceMetricBasis_PercentageAdjust <Double>
Specifies the percentage of the specified utilization metric that is used by the recommendations.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPreferences_Ec2RecommendationsPreferences_RamPerformanceMetricBasis_PercentageAdjust
-ReservedInstanceOptions_OfferingClass <OfferingClass>
The flexibility to change the instance types needed for your Reserved Instance.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPreferences_Ec2RecommendationsPreferences_ReservedInstanceOptions_OfferingClass
-ReservedInstanceOptions_PurchasingOption <PurchasingOption>
The payment plan to use for your Reserved Instance.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPreferences_Ec2RecommendationsPreferences_ReservedInstanceOptions_PurchasingOption
-ReservedInstanceOptions_TermLength <TermLength>
The preferred duration of the Reserved Instance term.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPreferences_Ec2RecommendationsPreferences_ReservedInstanceOptions_TermLength
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'ExportId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ApplicationDiscoveryService.Model.StartExportTaskResponse). Specifying the name of a property of type Amazon.ApplicationDiscoveryService.Model.StartExportTaskResponse 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)
-StartTime <DateTime>
The start timestamp for exported data from the single Application Discovery Agent selected in the filters. If no value is specified, data is exported starting from the first data collected by the agent.
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.ApplicationDiscoveryService.Model.StartExportTaskResponse
This cmdlet returns a System.String object. The service call response (type Amazon.ApplicationDiscoveryService.Model.StartExportTaskResponse) can be returned by specifying '-Select *'.
AWS Tools for PowerShell User Guide

Supported Version

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