Export Rds Database Recommendations

computeoptimizer_export_rds_database_recommendations

R Documentation

Export optimization recommendations for your Amazon Aurora and Amazon Relational Database Service (Amazon RDS) databases

Description

Export optimization recommendations for your Amazon Aurora and Amazon Relational Database Service (Amazon RDS) databases.

Recommendations are exported in a comma-separated values (CSV) file, and its metadata in a JavaScript Object Notation (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 Aurora or RDS export job in progress per Amazon Web Services Region.

Usage

computeoptimizer_export_rds_database_recommendations(accountIds,
  filters, fieldsToExport, s3DestinationConfig, fileFormat,
  includeMemberAccounts, recommendationPreferences)

Arguments

accountIds	The Amazon Web Services account IDs for the export Amazon Aurora and RDS database recommendations. If your account is the management account or the delegated administrator of an organization, use this parameter to specify the member account you want to export recommendations to. This parameter can't be specified together with the include member accounts parameter. The parameters are mutually exclusive. If this parameter or the include member accounts parameter is omitted, the recommendations for member accounts aren't included in the export. You can specify multiple account IDs per request.
filters	An array of objects to specify a filter that exports a more specific set of Amazon Aurora and RDS recommendations.
fieldsToExport	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.
s3DestinationConfig	[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.
fileFormat	The format of the export file. The CSV file is the only export file format currently supported.
includeMemberAccounts	If your account is the management account or the delegated administrator of an organization, this parameter indicates whether to include recommendations for resources in all member accounts of the 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. If this parameter is omitted, recommendations for member accounts of the organization aren't included in the export file. If this parameter or the account ID parameter is omitted, recommendations for member accounts aren't included in the export.
recommendationPreferences	Describes the recommendation preferences to return in the response of a get_auto_scaling_group_recommendations, get_ec2_instance_recommendations, get_ec2_recommendation_projected_metrics, get_rds_database_recommendations, and get_rds_database_recommendation_projected_metrics request.

Value

A list with the following syntax:

list(
  jobId = "string",
  s3Destination = list(
    bucket = "string",
    key = "string",
    metadataKey = "string"
  )
)

Request syntax

svc$export_rds_database_recommendations(
  accountIds = list(
    "string"
  ),
  filters = list(
    list(
      name = "InstanceFinding"|"InstanceFindingReasonCode"|"StorageFinding"|"StorageFindingReasonCode"|"Idle",
      values = list(
        "string"
      )
    )
  ),
  fieldsToExport = list(
    "ResourceArn"|"AccountId"|"Engine"|"EngineVersion"|"Idle"|"MultiAZDBInstance"|"ClusterWriter"|"CurrentDBInstanceClass"|"CurrentStorageConfigurationStorageType"|"CurrentStorageConfigurationAllocatedStorage"|"CurrentStorageConfigurationMaxAllocatedStorage"|"CurrentStorageConfigurationIOPS"|"CurrentStorageConfigurationStorageThroughput"|"CurrentStorageEstimatedMonthlyVolumeIOPsCostVariation"|"CurrentInstanceOnDemandHourlyPrice"|"CurrentStorageOnDemandMonthlyPrice"|"LookbackPeriodInDays"|"CurrentStorageEstimatedClusterInstanceOnDemandMonthlyCost"|"CurrentStorageEstimatedClusterStorageOnDemandMonthlyCost"|"CurrentStorageEstimatedClusterStorageIOOnDemandMonthlyCost"|"CurrentInstancePerformanceRisk"|"UtilizationMetricsCpuMaximum"|"UtilizationMetricsMemoryMaximum"|"UtilizationMetricsEBSVolumeStorageSpaceUtilizationMaximum"|"UtilizationMetricsNetworkReceiveThroughputMaximum"|"UtilizationMetricsNetworkTransmitThroughputMaximum"|"UtilizationMetricsEBSVolumeReadIOPSMaximum"|"UtilizationMetricsEBSVolumeWriteIOPSMaximum"|"UtilizationMetricsEBSVolumeReadThroughputMaximum"|"UtilizationMetricsEBSVolumeWriteThroughputMaximum"|"UtilizationMetricsDatabaseConnectionsMaximum"|"UtilizationMetricsStorageNetworkReceiveThroughputMaximum"|"UtilizationMetricsStorageNetworkTransmitThroughputMaximum"|"UtilizationMetricsAuroraMemoryHealthStateMaximum"|"UtilizationMetricsAuroraMemoryNumDeclinedSqlTotalMaximum"|"UtilizationMetricsAuroraMemoryNumKillConnTotalMaximum"|"UtilizationMetricsAuroraMemoryNumKillQueryTotalMaximum"|"UtilizationMetricsReadIOPSEphemeralStorageMaximum"|"UtilizationMetricsWriteIOPSEphemeralStorageMaximum"|"UtilizationMetricsVolumeBytesUsedAverage"|"UtilizationMetricsVolumeReadIOPsAverage"|"UtilizationMetricsVolumeWriteIOPsAverage"|"InstanceFinding"|"InstanceFindingReasonCodes"|"StorageFinding"|"StorageFindingReasonCodes"|"InstanceRecommendationOptionsDBInstanceClass"|"InstanceRecommendationOptionsRank"|"InstanceRecommendationOptionsPerformanceRisk"|"InstanceRecommendationOptionsProjectedUtilizationMetricsCpuMaximum"|"StorageRecommendationOptionsStorageType"|"StorageRecommendationOptionsAllocatedStorage"|"StorageRecommendationOptionsMaxAllocatedStorage"|"StorageRecommendationOptionsIOPS"|"StorageRecommendationOptionsStorageThroughput"|"StorageRecommendationOptionsRank"|"StorageRecommendationOptionsEstimatedMonthlyVolumeIOPsCostVariation"|"InstanceRecommendationOptionsInstanceOnDemandHourlyPrice"|"InstanceRecommendationOptionsSavingsOpportunityPercentage"|"InstanceRecommendationOptionsEstimatedMonthlySavingsCurrency"|"InstanceRecommendationOptionsEstimatedMonthlySavingsValue"|"InstanceRecommendationOptionsSavingsOpportunityAfterDiscountsPercentage"|"InstanceRecommendationOptionsEstimatedMonthlySavingsCurrencyAfterDiscounts"|"InstanceRecommendationOptionsEstimatedMonthlySavingsValueAfterDiscounts"|"StorageRecommendationOptionsOnDemandMonthlyPrice"|"StorageRecommendationOptionsEstimatedClusterInstanceOnDemandMonthlyCost"|"StorageRecommendationOptionsEstimatedClusterStorageOnDemandMonthlyCost"|"StorageRecommendationOptionsEstimatedClusterStorageIOOnDemandMonthlyCost"|"StorageRecommendationOptionsSavingsOpportunityPercentage"|"StorageRecommendationOptionsEstimatedMonthlySavingsCurrency"|"StorageRecommendationOptionsEstimatedMonthlySavingsValue"|"StorageRecommendationOptionsSavingsOpportunityAfterDiscountsPercentage"|"StorageRecommendationOptionsEstimatedMonthlySavingsCurrencyAfterDiscounts"|"StorageRecommendationOptionsEstimatedMonthlySavingsValueAfterDiscounts"|"EffectiveRecommendationPreferencesCpuVendorArchitectures"|"EffectiveRecommendationPreferencesEnhancedInfrastructureMetrics"|"EffectiveRecommendationPreferencesLookBackPeriod"|"EffectiveRecommendationPreferencesSavingsEstimationMode"|"LastRefreshTimestamp"|"Tags"|"DBClusterIdentifier"|"PromotionTier"
  ),
  s3DestinationConfig = list(
    bucket = "string",
    keyPrefix = "string"
  ),
  fileFormat = "Csv",
  includeMemberAccounts = TRUE|FALSE,
  recommendationPreferences = list(
    cpuVendorArchitectures = list(
      "AWS_ARM64"|"CURRENT"
    )
  )
)