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 Compute Optimizer ExportEBSVolumeRecommendations API operation.

Syntax

Export-COEBSVolumeRecommendation
-AccountId <String[]>
-S3DestinationConfig_Bucket <String>
-FieldsToExport <String[]>
-FileFormat <FileFormat>
-Filter <EBSFilter[]>
-IncludeMemberAccount <Boolean>
-S3DestinationConfig_KeyPrefix <String>
-Select <String>
-Force <SwitchParameter>

Description

Exports optimization recommendations for Amazon EBS volumes. Recommendations are exported in a comma-separated values (.csv) file, and its metadata in a JavaScript Object Notation (JSON) (.json) file, to an existing Amazon Simple Storage Service (Amazon S3) bucket that you specify. For more information, see Exporting Recommendations in the Compute Optimizer User Guide. You can have only one Amazon EBS volume export job in progress per Amazon Web Services Region.

Parameters

-AccountId <String[]>
The IDs of the Amazon Web Services accounts for which to export Amazon EBS volume recommendations.If your account is the management account of an organization, use this parameter to specify the member account for which you want to export recommendations.This parameter cannot be specified together with the include member accounts parameter. The parameters are mutually exclusive.Recommendations for member accounts are not included in the export if this parameter, or the include member accounts parameter, is omitted.You can specify multiple account IDs per request.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAccountIds
-FieldsToExport <String[]>
The recommendations data to include in the export file. For more information about the fields that can be exported, see Exported files in the Compute Optimizer User Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-FileFormat <FileFormat>
The format of the export file.The only export file format currently supported is Csv.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Filter <EBSFilter[]>
An array of objects to specify a filter that exports a more specific set of Amazon EBS volume recommendations.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFilters
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)
-IncludeMemberAccount <Boolean>
Indicates whether to include recommendations for resources in all member accounts of the organization if your account is the management account of an organization.The member accounts must also be opted in to Compute Optimizer, and trusted access for Compute Optimizer must be enabled in the organization account. For more information, see Compute Optimizer and Amazon Web Services Organizations trusted access in the Compute Optimizer User Guide.Recommendations for member accounts of the organization are not included in the export file if this parameter is omitted.This parameter cannot be specified together with the account IDs parameter. The parameters are mutually exclusive.Recommendations for member accounts are not included in the export if this parameter, or the account IDs parameter, is omitted.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesIncludeMemberAccounts
-S3DestinationConfig_Bucket <String>
The name of the Amazon S3 bucket to use as the destination for an export job.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-S3DestinationConfig_KeyPrefix <String>
The Amazon S3 bucket prefix for an export job.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
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.ComputeOptimizer.Model.ExportEBSVolumeRecommendationsResponse). Specifying the name of a property of type Amazon.ComputeOptimizer.Model.ExportEBSVolumeRecommendationsResponse 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

This cmdlet returns an Amazon.ComputeOptimizer.Model.ExportEBSVolumeRecommendationsResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.

Supported Version

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