ComputeOptimizer / Client / export_ebs_volume_recommendations

export_ebs_volume_recommendations

ComputeOptimizer.Client.export_ebs_volume_recommendations(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.export_ebs_volume_recommendations(
    accountIds=[
        'string',
    ],
    filters=[
        {
            'name': 'Finding',
            'values': [
                'string',
            ]
        },
    ],
    fieldsToExport=[
        'AccountId'|'VolumeArn'|'Finding'|'UtilizationMetricsVolumeReadOpsPerSecondMaximum'|'UtilizationMetricsVolumeWriteOpsPerSecondMaximum'|'UtilizationMetricsVolumeReadBytesPerSecondMaximum'|'UtilizationMetricsVolumeWriteBytesPerSecondMaximum'|'LookbackPeriodInDays'|'CurrentConfigurationVolumeType'|'CurrentConfigurationVolumeBaselineIOPS'|'CurrentConfigurationVolumeBaselineThroughput'|'CurrentConfigurationVolumeBurstIOPS'|'CurrentConfigurationVolumeBurstThroughput'|'CurrentConfigurationVolumeSize'|'CurrentMonthlyPrice'|'RecommendationOptionsConfigurationVolumeType'|'RecommendationOptionsConfigurationVolumeBaselineIOPS'|'RecommendationOptionsConfigurationVolumeBaselineThroughput'|'RecommendationOptionsConfigurationVolumeBurstIOPS'|'RecommendationOptionsConfigurationVolumeBurstThroughput'|'RecommendationOptionsConfigurationVolumeSize'|'RecommendationOptionsMonthlyPrice'|'RecommendationOptionsPerformanceRisk'|'LastRefreshTimestamp'|'CurrentPerformanceRisk'|'RecommendationOptionsSavingsOpportunityPercentage'|'RecommendationOptionsEstimatedMonthlySavingsCurrency'|'RecommendationOptionsEstimatedMonthlySavingsValue'|'Tags'|'RootVolume'|'CurrentConfigurationRootVolume'|'EffectiveRecommendationPreferencesSavingsEstimationMode'|'RecommendationOptionsSavingsOpportunityAfterDiscountsPercentage'|'RecommendationOptionsEstimatedMonthlySavingsCurrencyAfterDiscounts'|'RecommendationOptionsEstimatedMonthlySavingsValueAfterDiscounts',
    ],
    s3DestinationConfig={
        'bucket': 'string',
        'keyPrefix': 'string'
    },
    fileFormat='Csv',
    includeMemberAccounts=True|False
)

Parameters:

• accountIds (list) –

  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.

  • (string) –

• filters (list) –

  An array of objects to specify a filter that exports a more specific set of Amazon EBS volume recommendations.

  • (dict) –

    Describes a filter that returns a more specific list of Amazon Elastic Block Store (Amazon EBS) volume recommendations. Use this filter with the GetEBSVolumeRecommendations action.

    You can use LambdaFunctionRecommendationFilter with the GetLambdaFunctionRecommendations action, JobFilter with the DescribeRecommendationExportJobs action, and Filter with the GetAutoScalingGroupRecommendations and GetEC2InstanceRecommendations actions.

    • name (string) –

      The name of the filter.

      Specify Finding to return recommendations with a specific finding classification (for example, NotOptimized).

      You can filter your Amazon EBS volume recommendations by tag:key and tag-key tags.

      A tag:key is a key and value combination of a tag assigned to your Amazon EBS volume recommendations. Use the tag key in the filter name and the tag value as the filter value. For example, to find all Amazon EBS volume recommendations that have a tag with the key of Owner and the value of TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

      A tag-key is the key of a tag assigned to your Amazon EBS volume recommendations. Use this filter to find all of your Amazon EBS volume recommendations that have a tag with a specific key. This doesn’t consider the tag value. For example, you can find your Amazon EBS volume recommendations with a tag key value of Owner or without any tag keys assigned.

    • values (list) –

      The value of the filter.

      The valid values are Optimized, or NotOptimized.

      • (string) –

• fieldsToExport (list) –

  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.

  • (string) –

• s3DestinationConfig (dict) –

  [REQUIRED]

  Describes the destination Amazon Simple Storage Service (Amazon S3) bucket name and key prefix for a recommendations export job.

  You must create the destination Amazon S3 bucket for your recommendations export before you create the export job. Compute Optimizer does not create the S3 bucket for you. After you create the S3 bucket, ensure that it has the required permission policy to allow Compute Optimizer to write the export file to it. If you plan to specify an object prefix when you create the export job, you must include the object prefix in the policy that you add to the S3 bucket. For more information, see Amazon S3 Bucket Policy for Compute Optimizer in the Compute Optimizer User Guide.

  • bucket (string) –

    The name of the Amazon S3 bucket to use as the destination for an export job.

  • keyPrefix (string) –

    The Amazon S3 bucket prefix for an export job.

• fileFormat (string) –

  The format of the export file.

  The only export file format currently supported is Csv.

• includeMemberAccounts (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.

Return type:

dict

Returns:

Response Syntax

{
    'jobId': 'string',
    's3Destination': {
        'bucket': 'string',
        'key': 'string',
        'metadataKey': 'string'
    }
}

Response Structure

• (dict) –

  • jobId (string) –

    The identification number of the export job.

    Use the DescribeRecommendationExportJobs action, and specify the job ID to view the status of an export job.

  • s3Destination (dict) –

    Describes the destination Amazon Simple Storage Service (Amazon S3) bucket name and object keys of a recommendations export file, and its associated metadata file.

    • bucket (string) –

      The name of the Amazon S3 bucket used as the destination of an export file.

    • key (string) –

      The Amazon S3 bucket key of an export file.

      The key uniquely identifies the object, or export file, in the S3 bucket.

    • metadataKey (string) –

      The Amazon S3 bucket key of a metadata file.

      The key uniquely identifies the object, or metadata file, in the S3 bucket.

Exceptions

• ComputeOptimizer.Client.exceptions.OptInRequiredException

• ComputeOptimizer.Client.exceptions.InternalServerException

• ComputeOptimizer.Client.exceptions.ServiceUnavailableException

• ComputeOptimizer.Client.exceptions.AccessDeniedException

• ComputeOptimizer.Client.exceptions.InvalidParameterValueException

• ComputeOptimizer.Client.exceptions.MissingAuthenticationToken

• ComputeOptimizer.Client.exceptions.ThrottlingException

• ComputeOptimizer.Client.exceptions.LimitExceededException