5.0.0 • Published 3 years ago

@datafire/amazonaws_compute_optimizer v5.0.0

Weekly downloads
1
License
MIT
Repository
github
Last release
3 years ago

@datafire/amazonaws_compute_optimizer

Client library for AWS Compute Optimizer

Installation and Usage

npm install --save @datafire/amazonaws_compute_optimizer
let amazonaws_compute_optimizer = require('@datafire/amazonaws_compute_optimizer').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

.then(data => {
  console.log(data);
});

Description

AWS Compute Optimizer is a service that analyzes the configuration and utilization metrics of your AWS compute resources, such as EC2 instances, Auto Scaling groups, and Amazon EBS volumes. It reports whether your resources are optimal, and generates optimization recommendations to reduce the cost and improve the performance of your workloads. Compute Optimizer also provides recent utilization metric data, as well as projected utilization metric data for the recommendations, which you can use to evaluate which recommendation provides the best price-performance trade-off. The analysis of your usage patterns can help you decide when to move or resize your running resources, and still meet your performance and capacity requirements. For more information about Compute Optimizer, including the required permissions to use the service, see the AWS Compute Optimizer User Guide.

Actions

DescribeRecommendationExportJobs

amazonaws_compute_optimizer.DescribeRecommendationExportJobs({}, context)

Input

  • input object

Output

ExportAutoScalingGroupRecommendations

amazonaws_compute_optimizer.ExportAutoScalingGroupRecommendations({
  "s3DestinationConfig": null
}, context)

Input

Output

ExportEC2InstanceRecommendations

amazonaws_compute_optimizer.ExportEC2InstanceRecommendations({
  "s3DestinationConfig": null
}, context)

Input

Output

GetAutoScalingGroupRecommendations

amazonaws_compute_optimizer.GetAutoScalingGroupRecommendations({}, context)

Input

Output

GetEBSVolumeRecommendations

amazonaws_compute_optimizer.GetEBSVolumeRecommendations({}, context)

Input

Output

GetEC2InstanceRecommendations

amazonaws_compute_optimizer.GetEC2InstanceRecommendations({}, context)

Input

Output

GetEC2RecommendationProjectedMetrics

amazonaws_compute_optimizer.GetEC2RecommendationProjectedMetrics({
  "instanceArn": null,
  "stat": null,
  "period": null,
  "startTime": null,
  "endTime": null
}, context)

Input

  • input object
    • endTime required
    • instanceArn required
    • period required
    • startTime required
    • stat required

Output

GetEnrollmentStatus

amazonaws_compute_optimizer.GetEnrollmentStatus({}, context)

Input

  • input object

Output

GetRecommendationSummaries

amazonaws_compute_optimizer.GetRecommendationSummaries({}, context)

Input

  • input object

Output

UpdateEnrollmentStatus

amazonaws_compute_optimizer.UpdateEnrollmentStatus({
  "status": null
}, context)

Input

  • input object
    • includeMemberAccounts
    • status required

Output

Definitions

AccessDeniedException

AccountId

  • AccountId string

AccountIds

AutoScalingGroupArn

  • AutoScalingGroupArn string

AutoScalingGroupArns

AutoScalingGroupConfiguration

  • AutoScalingGroupConfiguration object: Describes the configuration of an Auto Scaling group.
    • desiredCapacity
    • instanceType
    • maxSize
    • minSize

AutoScalingGroupName

  • AutoScalingGroupName string

AutoScalingGroupRecommendation

  • AutoScalingGroupRecommendation object: Describes an Auto Scaling group recommendation.

AutoScalingGroupRecommendationOption

  • AutoScalingGroupRecommendationOption object: Describes a recommendation option for an Auto Scaling group.
    • configuration
      • desiredCapacity
      • instanceType
      • maxSize
      • minSize
    • performanceRisk
    • projectedUtilizationMetrics
    • rank

AutoScalingGroupRecommendationOptions

AutoScalingGroupRecommendations

Code

  • Code string

CreationTimestamp

  • CreationTimestamp string

CurrentInstanceType

  • CurrentInstanceType string

DescribeRecommendationExportJobsRequest

  • DescribeRecommendationExportJobsRequest object

DescribeRecommendationExportJobsResponse

DesiredCapacity

  • DesiredCapacity integer

DestinationBucket

  • DestinationBucket string

DestinationKey

  • DestinationKey string

DestinationKeyPrefix

  • DestinationKeyPrefix string

EBSFilter

  • EBSFilter object: Describes a filter that returns a more specific list of Amazon Elastic Block Store (Amazon EBS) volume recommendations. This filter is used with the GetEBSVolumeRecommendations action.

EBSFilterName

  • EBSFilterName string (values: Finding)

EBSFilters

EBSFinding

  • EBSFinding string (values: Optimized, NotOptimized)

EBSMetricName

  • EBSMetricName string (values: VolumeReadOpsPerSecond, VolumeWriteOpsPerSecond, VolumeReadBytesPerSecond, VolumeWriteBytesPerSecond)

EBSUtilizationMetric

  • EBSUtilizationMetric object: Describes a utilization metric of an Amazon Elastic Block Store (Amazon EBS) volume. Compare the utilization metric data of your resource against its projected utilization metric data to determine the performance difference between your current resource and the recommended option.
    • name
    • statistic
    • value

EBSUtilizationMetrics

ExportAutoScalingGroupRecommendationsRequest

ExportAutoScalingGroupRecommendationsResponse

  • ExportAutoScalingGroupRecommendationsResponse object
    • jobId
    • s3Destination
      • bucket
      • key
      • metadataKey

ExportDestination

  • ExportDestination object: Describes the destination of the recommendations export and metadata files.
    • s3
      • bucket
      • key
      • metadataKey

ExportEC2InstanceRecommendationsRequest

  • ExportEC2InstanceRecommendationsRequest object

ExportEC2InstanceRecommendationsResponse

  • ExportEC2InstanceRecommendationsResponse object
    • jobId
    • s3Destination
      • bucket
      • key
      • metadataKey

ExportableAutoScalingGroupField

  • ExportableAutoScalingGroupField string (values: AccountId, AutoScalingGroupArn, AutoScalingGroupName, Finding, UtilizationMetricsCpuMaximum, UtilizationMetricsMemoryMaximum, UtilizationMetricsEbsReadOpsPerSecondMaximum, UtilizationMetricsEbsWriteOpsPerSecondMaximum, UtilizationMetricsEbsReadBytesPerSecondMaximum, UtilizationMetricsEbsWriteBytesPerSecondMaximum, LookbackPeriodInDays, CurrentConfigurationInstanceType, CurrentConfigurationDesiredCapacity, CurrentConfigurationMinSize, CurrentConfigurationMaxSize, CurrentOnDemandPrice, CurrentStandardOneYearNoUpfrontReservedPrice, CurrentStandardThreeYearNoUpfrontReservedPrice, CurrentVCpus, CurrentMemory, CurrentStorage, CurrentNetwork, RecommendationOptionsConfigurationInstanceType, RecommendationOptionsConfigurationDesiredCapacity, RecommendationOptionsConfigurationMinSize, RecommendationOptionsConfigurationMaxSize, RecommendationOptionsProjectedUtilizationMetricsCpuMaximum, RecommendationOptionsProjectedUtilizationMetricsMemoryMaximum, RecommendationOptionsPerformanceRisk, RecommendationOptionsOnDemandPrice, RecommendationOptionsStandardOneYearNoUpfrontReservedPrice, RecommendationOptionsStandardThreeYearNoUpfrontReservedPrice, RecommendationOptionsVcpus, RecommendationOptionsMemory, RecommendationOptionsStorage, RecommendationOptionsNetwork, LastRefreshTimestamp)

ExportableAutoScalingGroupFields

ExportableInstanceField

  • ExportableInstanceField string (values: AccountId, InstanceArn, InstanceName, Finding, LookbackPeriodInDays, CurrentInstanceType, UtilizationMetricsCpuMaximum, UtilizationMetricsMemoryMaximum, UtilizationMetricsEbsReadOpsPerSecondMaximum, UtilizationMetricsEbsWriteOpsPerSecondMaximum, UtilizationMetricsEbsReadBytesPerSecondMaximum, UtilizationMetricsEbsWriteBytesPerSecondMaximum, CurrentOnDemandPrice, CurrentStandardOneYearNoUpfrontReservedPrice, CurrentStandardThreeYearNoUpfrontReservedPrice, CurrentVCpus, CurrentMemory, CurrentStorage, CurrentNetwork, RecommendationOptionsInstanceType, RecommendationOptionsProjectedUtilizationMetricsCpuMaximum, RecommendationOptionsProjectedUtilizationMetricsMemoryMaximum, RecommendationOptionsPerformanceRisk, RecommendationOptionsVcpus, RecommendationOptionsMemory, RecommendationOptionsStorage, RecommendationOptionsNetwork, RecommendationOptionsOnDemandPrice, RecommendationOptionsStandardOneYearNoUpfrontReservedPrice, RecommendationOptionsStandardThreeYearNoUpfrontReservedPrice, RecommendationsSourcesRecommendationSourceArn, RecommendationsSourcesRecommendationSourceType, LastRefreshTimestamp)

ExportableInstanceFields

FailureReason

  • FailureReason string

FileFormat

  • FileFormat string (values: Csv)

Filter

  • Filter object: Describes a filter that returns a more specific list of recommendations. This filter is used with the GetAutoScalingGroupRecommendations and GetEC2InstanceRecommendations actions.

FilterName

  • FilterName string (values: Finding, RecommendationSourceType)

FilterValue

  • FilterValue string

FilterValues

Filters

Finding

  • Finding string (values: Underprovisioned, Overprovisioned, Optimized, NotOptimized)

GetAutoScalingGroupRecommendationsRequest

GetAutoScalingGroupRecommendationsResponse

GetEBSVolumeRecommendationsRequest

GetEBSVolumeRecommendationsResponse

GetEC2InstanceRecommendationsRequest

  • GetEC2InstanceRecommendationsRequest object

GetEC2InstanceRecommendationsResponse

GetEC2RecommendationProjectedMetricsRequest

  • GetEC2RecommendationProjectedMetricsRequest object
    • endTime required
    • instanceArn required
    • period required
    • startTime required
    • stat required

GetEC2RecommendationProjectedMetricsResponse

GetEnrollmentStatusRequest

  • GetEnrollmentStatusRequest object

GetEnrollmentStatusResponse

  • GetEnrollmentStatusResponse object
    • memberAccountsEnrolled
    • status
    • statusReason

GetRecommendationError

  • GetRecommendationError object: Describes an error experienced when getting recommendations. For example, an error is returned if you request recommendations for an unsupported Auto Scaling group, or if you request recommendations for an instance of an unsupported instance family.
    • code
    • identifier
    • message

GetRecommendationErrors

GetRecommendationSummariesRequest

  • GetRecommendationSummariesRequest object

GetRecommendationSummariesResponse

Identifier

  • Identifier string

IncludeMemberAccounts

  • IncludeMemberAccounts boolean

InstanceArn

  • InstanceArn string

InstanceArns

InstanceName

  • InstanceName string

InstanceRecommendation

InstanceRecommendationOption

  • InstanceRecommendationOption object: Describes a recommendation option for an Amazon EC2 instance.

InstanceRecommendations

InstanceType

  • InstanceType string

InternalServerException

InvalidParameterValueException

JobFilter

  • JobFilter object: Describes a filter that returns a more specific list of recommendation export jobs. This filter is used with the DescribeRecommendationExportJobs action.

JobFilterName

  • JobFilterName string (values: ResourceType, JobStatus)

JobFilters

JobId

  • JobId string

JobIds

JobStatus

  • JobStatus string (values: Queued, InProgress, Complete, Failed)

LastRefreshTimestamp

  • LastRefreshTimestamp string

LastUpdatedTimestamp

  • LastUpdatedTimestamp string

LimitExceededException

LookBackPeriodInDays

  • LookBackPeriodInDays number

MaxResults

  • MaxResults integer

MaxSize

  • MaxSize integer

MemberAccountsEnrolled

  • MemberAccountsEnrolled boolean

Message

  • Message string

MetadataKey

  • MetadataKey string

MetricName

  • MetricName string (values: Cpu, Memory, EBS_READ_OPS_PER_SECOND, EBS_WRITE_OPS_PER_SECOND, EBS_READ_BYTES_PER_SECOND, EBS_WRITE_BYTES_PER_SECOND)

MetricStatistic

  • MetricStatistic string (values: Maximum, Average)

MetricValue

  • MetricValue number

MetricValues

MinSize

  • MinSize integer

MissingAuthenticationToken

NextToken

  • NextToken string

OptInRequiredException

PerformanceRisk

  • PerformanceRisk number

Period

  • Period integer

ProjectedMetric

  • ProjectedMetric object: Describes a projected utilization metric of a recommendation option, such as an Amazon EC2 instance. This represents the projected utilization of a recommendation option had you used that resource during the analyzed period. Compare the utilization metric data of your resource against its projected utilization metric data to determine the performance difference between your current resource and the recommended option. The Cpu and Memory metrics are the only projected utilization metrics returned when you run the GetEC2RecommendationProjectedMetrics action. Additionally, the Memory metric is returned only for resources that have the unified CloudWatch agent installed on them. For more information, see Enabling Memory Utilization with the CloudWatch Agent.

ProjectedMetrics

ProjectedUtilizationMetrics

Rank

  • Rank integer

RecommendationExportJob

  • RecommendationExportJob object: Describes a recommendation export job. Use the DescribeRecommendationExportJobs action to view your recommendation export jobs. Use the ExportAutoScalingGroupRecommendations or ExportEC2InstanceRecommendations actions to request an export of your recommendations.
    • creationTimestamp
    • destination
      • s3
        • bucket
        • key
        • metadataKey
    • failureReason
    • jobId
    • lastUpdatedTimestamp
    • resourceType
    • status

RecommendationExportJobs

RecommendationOptions

RecommendationSource

  • RecommendationSource object: Describes the source of a recommendation, such as an Amazon EC2 instance or Auto Scaling group.
    • recommendationSourceArn
    • recommendationSourceType

RecommendationSourceArn

  • RecommendationSourceArn string

RecommendationSourceType

  • RecommendationSourceType string (values: Ec2Instance, AutoScalingGroup, EbsVolume)

RecommendationSources

RecommendationSummaries

RecommendationSummary

  • RecommendationSummary object: A summary of a recommendation.
    • accountId
    • recommendationResourceType
    • summaries

RecommendedInstanceType

  • RecommendedInstanceType string

RecommendedOptionProjectedMetric

  • RecommendedOptionProjectedMetric object: Describes a projected utilization metric of a recommendation option. The Cpu and Memory metrics are the only projected utilization metrics returned when you run the GetEC2RecommendationProjectedMetrics action. Additionally, the Memory metric is returned only for resources that have the unified CloudWatch agent installed on them. For more information, see Enabling Memory Utilization with the CloudWatch Agent.

RecommendedOptionProjectedMetrics

ResourceNotFoundException

ResourceType

  • ResourceType string (values: Ec2Instance, AutoScalingGroup)

S3Destination

  • S3Destination object: 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
    • key
    • metadataKey

S3DestinationConfig

  • S3DestinationConfig object: 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
    • keyPrefix

ServiceUnavailableException

Status

  • Status string (values: Active, Inactive, Pending, Failed)

StatusReason

  • StatusReason string

Summaries

Summary

  • Summary object: The summary of a recommendation.
    • name
    • value

SummaryValue

  • SummaryValue number

ThrottlingException

Timestamp

  • Timestamp string

Timestamps

UpdateEnrollmentStatusRequest

  • UpdateEnrollmentStatusRequest object
    • includeMemberAccounts
    • status required

UpdateEnrollmentStatusResponse

  • UpdateEnrollmentStatusResponse object
    • status
    • statusReason

UtilizationMetric

  • UtilizationMetric object: Describes a utilization metric of a resource, such as an Amazon EC2 instance. Compare the utilization metric data of your resource against its projected utilization metric data to determine the performance difference between your current resource and the recommended option.
    • name
    • statistic
    • value

UtilizationMetrics

VolumeArn

  • VolumeArn string

VolumeArns

VolumeBaselineIOPS

  • VolumeBaselineIOPS integer

VolumeBaselineThroughput

  • VolumeBaselineThroughput integer

VolumeBurstIOPS

  • VolumeBurstIOPS integer

VolumeBurstThroughput

  • VolumeBurstThroughput integer

VolumeConfiguration

  • VolumeConfiguration object: Describes the configuration of an Amazon Elastic Block Store (Amazon EBS) volume.
    • volumeBaselineIOPS
    • volumeBaselineThroughput
    • volumeBurstIOPS
    • volumeBurstThroughput
    • volumeSize
    • volumeType

VolumeRecommendation

  • VolumeRecommendation object: Describes an Amazon Elastic Block Store (Amazon EBS) volume recommendation.
    • accountId
    • currentConfiguration
      • volumeBaselineIOPS
      • volumeBaselineThroughput
      • volumeBurstIOPS
      • volumeBurstThroughput
      • volumeSize
      • volumeType
    • finding
    • lastRefreshTimestamp
    • lookBackPeriodInDays
    • utilizationMetrics
    • volumeArn
    • volumeRecommendationOptions

VolumeRecommendationOption

  • VolumeRecommendationOption object: Describes a recommendation option for an Amazon Elastic Block Store (Amazon EBS) instance.
    • configuration
      • volumeBaselineIOPS
      • volumeBaselineThroughput
      • volumeBurstIOPS
      • volumeBurstThroughput
      • volumeSize
      • volumeType
    • performanceRisk
    • rank

VolumeRecommendationOptions

VolumeRecommendations

VolumeSize

  • VolumeSize integer

VolumeType

  • VolumeType string
datafireaws-sdk
@infinitebrahmanuniverse/nolb-_datafire_am@everything-registry/sub-chunk-220
5.0.0

3 years ago