types

package
v1.1.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 10, 2021 License: Apache-2.0 Imports: 3 Imported by: 2

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AccessDeniedException 

type AccessDeniedException struct {
	Message *string
}

You do not have sufficient access to perform this action.

func (*AccessDeniedException) Error 

func (e *AccessDeniedException) Error() string

func (*AccessDeniedException) ErrorCode 

func (e *AccessDeniedException) ErrorCode() string

func (*AccessDeniedException) ErrorFault 

func (e *AccessDeniedException) ErrorFault() smithy.ErrorFault

func (*AccessDeniedException) ErrorMessage 

func (e *AccessDeniedException) ErrorMessage() string

type AutoScalingGroupConfiguration 

type AutoScalingGroupConfiguration struct {

	// The desired capacity, or number of instances, for the Auto Scaling group.
	DesiredCapacity int32

	// The instance type for the Auto Scaling group.
	InstanceType *string

	// The maximum size, or maximum number of instances, for the Auto Scaling group.
	MaxSize int32

	// The minimum size, or minimum number of instances, for the Auto Scaling group.
	MinSize int32
}

Describes the configuration of an Auto Scaling group.

type AutoScalingGroupRecommendation 

type AutoScalingGroupRecommendation struct {

	// The AWS account ID of the Auto Scaling group.
	AccountId *string

	// The Amazon Resource Name (ARN) of the Auto Scaling group.
	AutoScalingGroupArn *string

	// The name of the Auto Scaling group.
	AutoScalingGroupName *string

	// An array of objects that describe the current configuration of the Auto Scaling
	// group.
	CurrentConfiguration *AutoScalingGroupConfiguration

	// The finding classification for the Auto Scaling group. Findings for Auto Scaling
	// groups include:
	//
	// * NotOptimized —An Auto Scaling group is considered not
	// optimized when AWS Compute Optimizer identifies a recommendation that can
	// provide better performance for your workload.
	//
	// * Optimized —An Auto Scaling
	// group is considered optimized when Compute Optimizer determines that the group
	// is correctly provisioned to run your workload based on the chosen instance type.
	// For optimized resources, Compute Optimizer might recommend a new generation
	// instance type.
	Finding Finding

	// The time stamp of when the Auto Scaling group recommendation was last refreshed.
	LastRefreshTimestamp *time.Time

	// The number of days for which utilization metrics were analyzed for the Auto
	// Scaling group.
	LookBackPeriodInDays float64

	// An array of objects that describe the recommendation options for the Auto
	// Scaling group.
	RecommendationOptions []AutoScalingGroupRecommendationOption

	// An array of objects that describe the utilization metrics of the Auto Scaling
	// group.
	UtilizationMetrics []UtilizationMetric
}

Describes an Auto Scaling group recommendation.

type AutoScalingGroupRecommendationOption 

type AutoScalingGroupRecommendationOption struct {

	// An array of objects that describe an Auto Scaling group configuration.
	Configuration *AutoScalingGroupConfiguration

	// The performance risk of the Auto Scaling group configuration recommendation.
	// Performance risk is the likelihood of the recommended instance type not meeting
	// the performance requirement of your workload. The lowest performance risk is
	// categorized as 0, and the highest as 5.
	PerformanceRisk float64

	// An array of objects that describe the projected utilization metrics of the Auto
	// Scaling group recommendation option. The Cpu and Memory metrics are the only
	// projected utilization metrics returned. 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
	// (https://docs.aws.amazon.com/compute-optimizer/latest/ug/metrics.html#cw-agent).
	ProjectedUtilizationMetrics []UtilizationMetric

	// The rank of the Auto Scaling group recommendation option. The top recommendation
	// option is ranked as 1.
	Rank int32
}

Describes a recommendation option for an Auto Scaling group.

type EBSFilter added in v0.31.0 

type EBSFilter struct {

	// The name of the filter. Specify Finding to return recommendations with a
	// specific finding classification (e.g., Optimized).
	Name EBSFilterName

	// The value of the filter. The valid values are Optimized, or NotOptimized.
	Values []string
}

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.

type EBSFilterName added in v0.31.0 

type EBSFilterName string
const (
	EBSFilterNameFinding EBSFilterName = "Finding"
)

Enum values for EBSFilterName

func (EBSFilterName) Values added in v0.31.0 

func (EBSFilterName) Values() []EBSFilterName

Values returns all known values for EBSFilterName. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type EBSFinding added in v0.31.0 

type EBSFinding string
const (
	EBSFindingOptimized    EBSFinding = "Optimized"
	EBSFindingNotOptimized EBSFinding = "NotOptimized"
)

Enum values for EBSFinding

func (EBSFinding) Values added in v0.31.0 

func (EBSFinding) Values() []EBSFinding

Values returns all known values for EBSFinding. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type EBSMetricName added in v0.31.0 

type EBSMetricName string
const (
	EBSMetricNameVolumeReadOpsPerSecond    EBSMetricName = "VolumeReadOpsPerSecond"
	EBSMetricNameVolumeWriteOpsPerSecond   EBSMetricName = "VolumeWriteOpsPerSecond"
	EBSMetricNameVolumeReadBytesPerSecond  EBSMetricName = "VolumeReadBytesPerSecond"
	EBSMetricNameVolumeWriteBytesPerSecond EBSMetricName = "VolumeWriteBytesPerSecond"
)

Enum values for EBSMetricName

func (EBSMetricName) Values added in v0.31.0 

func (EBSMetricName) Values() []EBSMetricName

Values returns all known values for EBSMetricName. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type EBSUtilizationMetric added in v0.31.0 

type EBSUtilizationMetric struct {

	// The name of the utilization metric. The following utilization metrics are
	// available:
	//
	// * VolumeReadOpsPerSecond - The completed read operations per second
	// from the volume in a specified period of time. Unit: Count
	//
	// *
	// VolumeWriteOpsPerSecond - The completed write operations per second to the
	// volume in a specified period of time. Unit: Count
	//
	// * VolumeReadBytesPerSecond -
	// The bytes read per second from the volume in a specified period of time. Unit:
	// Bytes
	//
	// * VolumeWriteBytesPerSecond - The bytes written to the volume in a
	// specified period of time. Unit: Bytes
	Name EBSMetricName

	// The statistic of the utilization metric. The following statistics are
	// available:
	//
	// * Average - This is the value of Sum / SampleCount during the
	// specified period, or the average value observed during the specified period.
	//
	// *
	// Maximum - The highest value observed during the specified period. Use this value
	// to determine high volumes of activity for your application.
	Statistic MetricStatistic

	// The value of the utilization metric.
	Value float64
}

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.

type ExportDestination 

type ExportDestination struct {

	// An object that describes the destination Amazon Simple Storage Service (Amazon
	// S3) bucket name and object keys of a recommendations export file, and its
	// associated metadata file.
	S3 *S3Destination
}

Describes the destination of the recommendations export and metadata files.

type ExportableAutoScalingGroupField 

type ExportableAutoScalingGroupField string
const (
	ExportableAutoScalingGroupFieldAccountId                                                     ExportableAutoScalingGroupField = "AccountId"
	ExportableAutoScalingGroupFieldAutoScalingGroupArn                                           ExportableAutoScalingGroupField = "AutoScalingGroupArn"
	ExportableAutoScalingGroupFieldAutoScalingGroupName                                          ExportableAutoScalingGroupField = "AutoScalingGroupName"
	ExportableAutoScalingGroupFieldFinding                                                       ExportableAutoScalingGroupField = "Finding"
	ExportableAutoScalingGroupFieldUtilizationMetricsCpuMaximum                                  ExportableAutoScalingGroupField = "UtilizationMetricsCpuMaximum"
	ExportableAutoScalingGroupFieldUtilizationMetricsMemoryMaximum                               ExportableAutoScalingGroupField = "UtilizationMetricsMemoryMaximum"
	ExportableAutoScalingGroupFieldUtilizationMetricsEbsReadOpsPerSecondMaximum                  ExportableAutoScalingGroupField = "UtilizationMetricsEbsReadOpsPerSecondMaximum"
	ExportableAutoScalingGroupFieldUtilizationMetricsEbsWriteOpsPerSecondMaximum                 ExportableAutoScalingGroupField = "UtilizationMetricsEbsWriteOpsPerSecondMaximum"
	ExportableAutoScalingGroupFieldUtilizationMetricsEbsReadBytesPerSecondMaximum                ExportableAutoScalingGroupField = "UtilizationMetricsEbsReadBytesPerSecondMaximum"
	ExportableAutoScalingGroupFieldUtilizationMetricsEbsWriteBytesPerSecondMaximum               ExportableAutoScalingGroupField = "UtilizationMetricsEbsWriteBytesPerSecondMaximum"
	ExportableAutoScalingGroupFieldLookbackPeriodInDays                                          ExportableAutoScalingGroupField = "LookbackPeriodInDays"
	ExportableAutoScalingGroupFieldCurrentConfigurationInstanceType                              ExportableAutoScalingGroupField = "CurrentConfigurationInstanceType"
	ExportableAutoScalingGroupFieldCurrentConfigurationDesiredCapacity                           ExportableAutoScalingGroupField = "CurrentConfigurationDesiredCapacity"
	ExportableAutoScalingGroupFieldCurrentConfigurationMinSize                                   ExportableAutoScalingGroupField = "CurrentConfigurationMinSize"
	ExportableAutoScalingGroupFieldCurrentConfigurationMaxSize                                   ExportableAutoScalingGroupField = "CurrentConfigurationMaxSize"
	ExportableAutoScalingGroupFieldCurrentOnDemandPrice                                          ExportableAutoScalingGroupField = "CurrentOnDemandPrice"
	ExportableAutoScalingGroupFieldCurrentStandardOneYearNoUpfrontReservedPrice                  ExportableAutoScalingGroupField = "CurrentStandardOneYearNoUpfrontReservedPrice"
	ExportableAutoScalingGroupFieldCurrentStandardThreeYearNoUpfrontReservedPrice                ExportableAutoScalingGroupField = "CurrentStandardThreeYearNoUpfrontReservedPrice"
	ExportableAutoScalingGroupFieldCurrentVcpus                                                  ExportableAutoScalingGroupField = "CurrentVCpus"
	ExportableAutoScalingGroupFieldCurrentMemory                                                 ExportableAutoScalingGroupField = "CurrentMemory"
	ExportableAutoScalingGroupFieldCurrentStorage                                                ExportableAutoScalingGroupField = "CurrentStorage"
	ExportableAutoScalingGroupFieldCurrentNetwork                                                ExportableAutoScalingGroupField = "CurrentNetwork"
	ExportableAutoScalingGroupFieldRecommendationOptionsConfigurationInstanceType                ExportableAutoScalingGroupField = "RecommendationOptionsConfigurationInstanceType"
	ExportableAutoScalingGroupFieldRecommendationOptionsConfigurationDesiredCapacity             ExportableAutoScalingGroupField = "RecommendationOptionsConfigurationDesiredCapacity"
	ExportableAutoScalingGroupFieldRecommendationOptionsConfigurationMinSize                     ExportableAutoScalingGroupField = "RecommendationOptionsConfigurationMinSize"
	ExportableAutoScalingGroupFieldRecommendationOptionsConfigurationMaxSize                     ExportableAutoScalingGroupField = "RecommendationOptionsConfigurationMaxSize"
	ExportableAutoScalingGroupFieldRecommendationOptionsProjectedUtilizationMetricsCpuMaximum    ExportableAutoScalingGroupField = "RecommendationOptionsProjectedUtilizationMetricsCpuMaximum"
	ExportableAutoScalingGroupFieldRecommendationOptionsProjectedUtilizationMetricsMemoryMaximum ExportableAutoScalingGroupField = "RecommendationOptionsProjectedUtilizationMetricsMemoryMaximum"
	ExportableAutoScalingGroupFieldRecommendationOptionsPerformanceRisk                          ExportableAutoScalingGroupField = "RecommendationOptionsPerformanceRisk"
	ExportableAutoScalingGroupFieldRecommendationOptionsOnDemandPrice                            ExportableAutoScalingGroupField = "RecommendationOptionsOnDemandPrice"
	ExportableAutoScalingGroupFieldRecommendationOptionsStandardOneYearNoUpfrontReservedPrice    ExportableAutoScalingGroupField = "RecommendationOptionsStandardOneYearNoUpfrontReservedPrice"
	ExportableAutoScalingGroupFieldRecommendationOptionsStandardThreeYearNoUpfrontReservedPrice  ExportableAutoScalingGroupField = "RecommendationOptionsStandardThreeYearNoUpfrontReservedPrice"
	ExportableAutoScalingGroupFieldRecommendationOptionsVcpus                                    ExportableAutoScalingGroupField = "RecommendationOptionsVcpus"
	ExportableAutoScalingGroupFieldRecommendationOptionsMemory                                   ExportableAutoScalingGroupField = "RecommendationOptionsMemory"
	ExportableAutoScalingGroupFieldRecommendationOptionsStorage                                  ExportableAutoScalingGroupField = "RecommendationOptionsStorage"
	ExportableAutoScalingGroupFieldRecommendationOptionsNetwork                                  ExportableAutoScalingGroupField = "RecommendationOptionsNetwork"
	ExportableAutoScalingGroupFieldLastRefreshTimestamp                                          ExportableAutoScalingGroupField = "LastRefreshTimestamp"
)

Enum values for ExportableAutoScalingGroupField

func (ExportableAutoScalingGroupField) Values added in v0.29.0 

func (ExportableAutoScalingGroupField) Values() []ExportableAutoScalingGroupField

Values returns all known values for ExportableAutoScalingGroupField. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ExportableInstanceField 

type ExportableInstanceField string
const (
	ExportableInstanceFieldAccountId                                                     ExportableInstanceField = "AccountId"
	ExportableInstanceFieldInstanceArn                                                   ExportableInstanceField = "InstanceArn"
	ExportableInstanceFieldInstanceName                                                  ExportableInstanceField = "InstanceName"
	ExportableInstanceFieldFinding                                                       ExportableInstanceField = "Finding"
	ExportableInstanceFieldLookbackPeriodInDays                                          ExportableInstanceField = "LookbackPeriodInDays"
	ExportableInstanceFieldCurrentInstanceType                                           ExportableInstanceField = "CurrentInstanceType"
	ExportableInstanceFieldUtilizationMetricsCpuMaximum                                  ExportableInstanceField = "UtilizationMetricsCpuMaximum"
	ExportableInstanceFieldUtilizationMetricsMemoryMaximum                               ExportableInstanceField = "UtilizationMetricsMemoryMaximum"
	ExportableInstanceFieldUtilizationMetricsEbsReadOpsPerSecondMaximum                  ExportableInstanceField = "UtilizationMetricsEbsReadOpsPerSecondMaximum"
	ExportableInstanceFieldUtilizationMetricsEbsWriteOpsPerSecondMaximum                 ExportableInstanceField = "UtilizationMetricsEbsWriteOpsPerSecondMaximum"
	ExportableInstanceFieldUtilizationMetricsEbsReadBytesPerSecondMaximum                ExportableInstanceField = "UtilizationMetricsEbsReadBytesPerSecondMaximum"
	ExportableInstanceFieldUtilizationMetricsEbsWriteBytesPerSecondMaximum               ExportableInstanceField = "UtilizationMetricsEbsWriteBytesPerSecondMaximum"
	ExportableInstanceFieldCurrentOnDemandPrice                                          ExportableInstanceField = "CurrentOnDemandPrice"
	ExportableInstanceFieldCurrentStandardOneYearNoUpfrontReservedPrice                  ExportableInstanceField = "CurrentStandardOneYearNoUpfrontReservedPrice"
	ExportableInstanceFieldCurrentStandardThreeYearNoUpfrontReservedPrice                ExportableInstanceField = "CurrentStandardThreeYearNoUpfrontReservedPrice"
	ExportableInstanceFieldCurrentVcpus                                                  ExportableInstanceField = "CurrentVCpus"
	ExportableInstanceFieldCurrentMemory                                                 ExportableInstanceField = "CurrentMemory"
	ExportableInstanceFieldCurrentStorage                                                ExportableInstanceField = "CurrentStorage"
	ExportableInstanceFieldCurrentNetwork                                                ExportableInstanceField = "CurrentNetwork"
	ExportableInstanceFieldRecommendationOptionsInstanceType                             ExportableInstanceField = "RecommendationOptionsInstanceType"
	ExportableInstanceFieldRecommendationOptionsProjectedUtilizationMetricsCpuMaximum    ExportableInstanceField = "RecommendationOptionsProjectedUtilizationMetricsCpuMaximum"
	ExportableInstanceFieldRecommendationOptionsProjectedUtilizationMetricsMemoryMaximum ExportableInstanceField = "RecommendationOptionsProjectedUtilizationMetricsMemoryMaximum"
	ExportableInstanceFieldRecommendationOptionsPerformanceRisk                          ExportableInstanceField = "RecommendationOptionsPerformanceRisk"
	ExportableInstanceFieldRecommendationOptionsVcpus                                    ExportableInstanceField = "RecommendationOptionsVcpus"
	ExportableInstanceFieldRecommendationOptionsMemory                                   ExportableInstanceField = "RecommendationOptionsMemory"
	ExportableInstanceFieldRecommendationOptionsStorage                                  ExportableInstanceField = "RecommendationOptionsStorage"
	ExportableInstanceFieldRecommendationOptionsNetwork                                  ExportableInstanceField = "RecommendationOptionsNetwork"
	ExportableInstanceFieldRecommendationOptionsOnDemandPrice                            ExportableInstanceField = "RecommendationOptionsOnDemandPrice"
	ExportableInstanceFieldRecommendationOptionsStandardOneYearNoUpfrontReservedPrice    ExportableInstanceField = "RecommendationOptionsStandardOneYearNoUpfrontReservedPrice"
	ExportableInstanceFieldRecommendationOptionsStandardThreeYearNoUpfrontReservedPrice  ExportableInstanceField = "RecommendationOptionsStandardThreeYearNoUpfrontReservedPrice"
	ExportableInstanceFieldRecommendationsSourcesRecommendationSourceArn                 ExportableInstanceField = "RecommendationsSourcesRecommendationSourceArn"
	ExportableInstanceFieldRecommendationsSourcesRecommendationSourceType                ExportableInstanceField = "RecommendationsSourcesRecommendationSourceType"
	ExportableInstanceFieldLastRefreshTimestamp                                          ExportableInstanceField = "LastRefreshTimestamp"
)

Enum values for ExportableInstanceField

func (ExportableInstanceField) Values added in v0.29.0 

func (ExportableInstanceField) Values() []ExportableInstanceField

Values returns all known values for ExportableInstanceField. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type FileFormat 

type FileFormat string
const (
	FileFormatCsv FileFormat = "Csv"
)

Enum values for FileFormat

func (FileFormat) Values added in v0.29.0 

func (FileFormat) Values() []FileFormat

Values returns all known values for FileFormat. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type Filter 

type Filter struct {

	// The name of the filter. Specify Finding to return recommendations with a
	// specific finding classification (e.g., Overprovisioned). Specify
	// RecommendationSourceType to return recommendations of a specific resource type
	// (e.g., AutoScalingGroup).
	Name FilterName

	// The value of the filter. The valid values for this parameter are as follows,
	// depending on what you specify for the name parameter and the resource type that
	// you wish to filter results for:
	//
	// * Specify Optimized or NotOptimized if you
	// specified the name parameter as Finding and you want to filter results for Auto
	// Scaling groups.
	//
	// * Specify Underprovisioned, Overprovisioned, or Optimized if
	// you specified the name parameter as Finding and you want to filter results for
	// EC2 instances.
	//
	// * Specify Ec2Instance or AutoScalingGroup if you specified the
	// name parameter as RecommendationSourceType.
	Values []string
}

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

type FilterName 

type FilterName string
const (
	FilterNameFinding                  FilterName = "Finding"
	FilterNameRecommendationSourceType FilterName = "RecommendationSourceType"
)

Enum values for FilterName

func (FilterName) Values added in v0.29.0 

func (FilterName) Values() []FilterName

Values returns all known values for FilterName. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type Finding 

type Finding string
const (
	FindingUnderProvisioned Finding = "Underprovisioned"
	FindingOverProvisioned  Finding = "Overprovisioned"
	FindingOptimized        Finding = "Optimized"
	FindingNotOptimized     Finding = "NotOptimized"
)

Enum values for Finding

func (Finding) Values added in v0.29.0 

func (Finding) Values() []Finding

Values returns all known values for Finding. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type GetRecommendationError 

type GetRecommendationError struct {

	// The error code.
	Code *string

	// The ID of the error.
	Identifier *string

	// The message, or reason, for the error.
	Message *string
}

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.

type InstanceRecommendation 

type InstanceRecommendation struct {

	// The AWS account ID of the instance.
	AccountId *string

	// The instance type of the current instance.
	CurrentInstanceType *string

	// The finding classification for the instance. Findings for instances include:
	//
	// *
	// Underprovisioned —An instance is considered under-provisioned when at least one
	// specification of your instance, such as CPU, memory, or network, does not meet
	// the performance requirements of your workload. Under-provisioned instances may
	// lead to poor application performance.
	//
	// * Overprovisioned —An instance is
	// considered over-provisioned when at least one specification of your instance,
	// such as CPU, memory, or network, can be sized down while still meeting the
	// performance requirements of your workload, and no specification is
	// under-provisioned. Over-provisioned instances may lead to unnecessary
	// infrastructure cost.
	//
	// * Optimized —An instance is considered optimized when all
	// specifications of your instance, such as CPU, memory, and network, meet the
	// performance requirements of your workload and is not over provisioned. An
	// optimized instance runs your workloads with optimal performance and
	// infrastructure cost. For optimized resources, AWS Compute Optimizer might
	// recommend a new generation instance type.
	Finding Finding

	// The Amazon Resource Name (ARN) of the current instance.
	InstanceArn *string

	// The name of the current instance.
	InstanceName *string

	// The time stamp of when the instance recommendation was last refreshed.
	LastRefreshTimestamp *time.Time

	// The number of days for which utilization metrics were analyzed for the instance.
	LookBackPeriodInDays float64

	// An array of objects that describe the recommendation options for the instance.
	RecommendationOptions []InstanceRecommendationOption

	// An array of objects that describe the source resource of the recommendation.
	RecommendationSources []RecommendationSource

	// An array of objects that describe the utilization metrics of the instance.
	UtilizationMetrics []UtilizationMetric
}

Describes an Amazon EC2 instance recommendation.

type InstanceRecommendationOption 

type InstanceRecommendationOption struct {

	// The instance type of the instance recommendation.
	InstanceType *string

	// The performance risk of the instance recommendation option. Performance risk is
	// the likelihood of the recommended instance type not meeting the performance
	// requirement of your workload. The lowest performance risk is categorized as 0,
	// and the highest as 5.
	PerformanceRisk float64

	// An array of objects that describe the projected utilization metrics of the
	// instance recommendation option. The Cpu and Memory metrics are the only
	// projected utilization metrics returned. 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
	// (https://docs.aws.amazon.com/compute-optimizer/latest/ug/metrics.html#cw-agent).
	ProjectedUtilizationMetrics []UtilizationMetric

	// The rank of the instance recommendation option. The top recommendation option is
	// ranked as 1.
	Rank int32
}

Describes a recommendation option for an Amazon EC2 instance.

type InternalServerException 

type InternalServerException struct {
	Message *string
}

An internal error has occurred. Try your call again.

func (*InternalServerException) Error 

func (e *InternalServerException) Error() string

func (*InternalServerException) ErrorCode 

func (e *InternalServerException) ErrorCode() string

func (*InternalServerException) ErrorFault 

func (e *InternalServerException) ErrorFault() smithy.ErrorFault

func (*InternalServerException) ErrorMessage 

func (e *InternalServerException) ErrorMessage() string

type InvalidParameterValueException 

type InvalidParameterValueException struct {
	Message *string
}

An invalid or out-of-range value was supplied for the input parameter.

func (*InvalidParameterValueException) Error 

func (e *InvalidParameterValueException) Error() string

func (*InvalidParameterValueException) ErrorCode 

func (e *InvalidParameterValueException) ErrorCode() string

func (*InvalidParameterValueException) ErrorFault 

func (e *InvalidParameterValueException) ErrorFault() smithy.ErrorFault

func (*InvalidParameterValueException) ErrorMessage 

func (e *InvalidParameterValueException) ErrorMessage() string

type JobFilter 

type JobFilter struct {

	// The name of the filter. Specify ResourceType to return export jobs of a specific
	// resource type (e.g., Ec2Instance). Specify JobStatus to return export jobs with
	// a specific status (e.g, Complete).
	Name JobFilterName

	// The value of the filter. The valid values for this parameter are as follows,
	// depending on what you specify for the name parameter:
	//
	// * Specify Ec2Instance or
	// AutoScalingGroup if you specified the name parameter as ResourceType. There is
	// no filter for EBS volumes because volume recommendations cannot be exported at
	// this time.
	//
	// * Specify Queued, InProgress, Complete, or Failed if you specified
	// the name parameter as JobStatus.
	Values []string
}

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

type JobFilterName 

type JobFilterName string
const (
	JobFilterNameResourceType JobFilterName = "ResourceType"
	JobFilterNameJobStatus    JobFilterName = "JobStatus"
)

Enum values for JobFilterName

func (JobFilterName) Values added in v0.29.0 

func (JobFilterName) Values() []JobFilterName

Values returns all known values for JobFilterName. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type JobStatus 

type JobStatus string
const (
	JobStatusQueued     JobStatus = "Queued"
	JobStatusInProgress JobStatus = "InProgress"
	JobStatusComplete   JobStatus = "Complete"
	JobStatusFailed     JobStatus = "Failed"
)

Enum values for JobStatus

func (JobStatus) Values added in v0.29.0 

func (JobStatus) Values() []JobStatus

Values returns all known values for JobStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type LimitExceededException 

type LimitExceededException struct {
	Message *string
}

The request exceeds a limit of the service.

func (*LimitExceededException) Error 

func (e *LimitExceededException) Error() string

func (*LimitExceededException) ErrorCode 

func (e *LimitExceededException) ErrorCode() string

func (*LimitExceededException) ErrorFault 

func (e *LimitExceededException) ErrorFault() smithy.ErrorFault

func (*LimitExceededException) ErrorMessage 

func (e *LimitExceededException) ErrorMessage() string

type MetricName 

type MetricName string
const (
	MetricNameCpu                    MetricName = "Cpu"
	MetricNameMemory                 MetricName = "Memory"
	MetricNameEbsReadOpsPerSecond    MetricName = "EBS_READ_OPS_PER_SECOND"
	MetricNameEbsWriteOpsPerSecond   MetricName = "EBS_WRITE_OPS_PER_SECOND"
	MetricNameEbsReadBytesPerSecond  MetricName = "EBS_READ_BYTES_PER_SECOND"
	MetricNameEbsWriteBytesPerSecond MetricName = "EBS_WRITE_BYTES_PER_SECOND"
)

Enum values for MetricName

func (MetricName) Values added in v0.29.0 

func (MetricName) Values() []MetricName

Values returns all known values for MetricName. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type MetricStatistic 

type MetricStatistic string
const (
	MetricStatisticMaximum MetricStatistic = "Maximum"
	MetricStatisticAverage MetricStatistic = "Average"
)

Enum values for MetricStatistic

func (MetricStatistic) Values added in v0.29.0 

func (MetricStatistic) Values() []MetricStatistic

Values returns all known values for MetricStatistic. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type MissingAuthenticationToken 

type MissingAuthenticationToken struct {
	Message *string
}

The request must contain either a valid (registered) AWS access key ID or X.509 certificate.

func (*MissingAuthenticationToken) Error 

func (e *MissingAuthenticationToken) Error() string

func (*MissingAuthenticationToken) ErrorCode 

func (e *MissingAuthenticationToken) ErrorCode() string

func (*MissingAuthenticationToken) ErrorFault 

func (e *MissingAuthenticationToken) ErrorFault() smithy.ErrorFault

func (*MissingAuthenticationToken) ErrorMessage 

func (e *MissingAuthenticationToken) ErrorMessage() string

type OptInRequiredException 

type OptInRequiredException struct {
	Message *string
}

The account is not opted in to AWS Compute Optimizer.

func (*OptInRequiredException) Error 

func (e *OptInRequiredException) Error() string

func (*OptInRequiredException) ErrorCode 

func (e *OptInRequiredException) ErrorCode() string

func (*OptInRequiredException) ErrorFault 

func (e *OptInRequiredException) ErrorFault() smithy.ErrorFault

func (*OptInRequiredException) ErrorMessage 

func (e *OptInRequiredException) ErrorMessage() string

type ProjectedMetric 

type ProjectedMetric struct {

	// The name of the projected utilization metric. The following projected
	// utilization metrics are returned:
	//
	// * Cpu - The projected percentage of allocated
	// EC2 compute units that would be in use on the recommendation option had you used
	// that resource during the analyzed period. This metric identifies the processing
	// power required to run an application on the recommendation option. Depending on
	// the instance type, tools in your operating system can show a lower percentage
	// than CloudWatch when the instance is not allocated a full processor core. Units:
	// Percent
	//
	// * Memory - The percentage of memory that would be in use on the
	// recommendation option had you used that resource during the analyzed period.
	// This metric identifies the amount of memory required to run an application on
	// the recommendation option. Units: Percent 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
	// (https://docs.aws.amazon.com/compute-optimizer/latest/ug/metrics.html#cw-agent).
	Name MetricName

	// The time stamps of the projected utilization metric.
	Timestamps []time.Time

	// The values of the projected utilization metrics.
	Values []float64
}

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 (https://docs.aws.amazon.com/compute-optimizer/latest/ug/metrics.html#cw-agent).

type RecommendationExportJob 

type RecommendationExportJob struct {

	// The timestamp of when the export job was created.
	CreationTimestamp *time.Time

	// An object that describes the destination of the export file.
	Destination *ExportDestination

	// The reason for an export job failure.
	FailureReason *string

	// The identification number of the export job.
	JobId *string

	// The timestamp of when the export job was last updated.
	LastUpdatedTimestamp *time.Time

	// The resource type of the exported recommendations.
	ResourceType ResourceType

	// The status of the export job.
	Status JobStatus
}

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.

type RecommendationSource 

type RecommendationSource struct {

	// The Amazon Resource Name (ARN) of the recommendation source.
	RecommendationSourceArn *string

	// The resource type of the recommendation source.
	RecommendationSourceType RecommendationSourceType
}

Describes the source of a recommendation, such as an Amazon EC2 instance or Auto Scaling group.

type RecommendationSourceType 

type RecommendationSourceType string
const (
	RecommendationSourceTypeEc2Instance      RecommendationSourceType = "Ec2Instance"
	RecommendationSourceTypeAutoScalingGroup RecommendationSourceType = "AutoScalingGroup"
	RecommendationSourceTypeEbsVolume        RecommendationSourceType = "EbsVolume"
)

Enum values for RecommendationSourceType

func (RecommendationSourceType) Values added in v0.29.0 

func (RecommendationSourceType) Values() []RecommendationSourceType

Values returns all known values for RecommendationSourceType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type RecommendationSummary 

type RecommendationSummary struct {

	// The AWS account ID of the recommendation summary.
	AccountId *string

	// The resource type of the recommendation.
	RecommendationResourceType RecommendationSourceType

	// An array of objects that describe a recommendation summary.
	Summaries []Summary
}

A summary of a recommendation.

type RecommendedOptionProjectedMetric 

type RecommendedOptionProjectedMetric struct {

	// An array of objects that describe a projected utilization metric.
	ProjectedMetrics []ProjectedMetric

	// The rank of the recommendation option projected metric. The top recommendation
	// option is ranked as 1. The projected metric rank correlates to the
	// recommendation option rank. For example, the projected metric ranked as 1 is
	// related to the recommendation option that is also ranked as 1 in the same
	// response.
	Rank int32

	// The recommended instance type.
	RecommendedInstanceType *string
}

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 (https://docs.aws.amazon.com/compute-optimizer/latest/ug/metrics.html#cw-agent).

type ResourceNotFoundException 

type ResourceNotFoundException struct {
	Message *string
}

A resource that is required for the action doesn't exist.

func (*ResourceNotFoundException) Error 

func (e *ResourceNotFoundException) Error() string

func (*ResourceNotFoundException) ErrorCode 

func (e *ResourceNotFoundException) ErrorCode() string

func (*ResourceNotFoundException) ErrorFault 

func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault

func (*ResourceNotFoundException) ErrorMessage 

func (e *ResourceNotFoundException) ErrorMessage() string

type ResourceType 

type ResourceType string
const (
	ResourceTypeEc2Instance      ResourceType = "Ec2Instance"
	ResourceTypeAutoScalingGroup ResourceType = "AutoScalingGroup"
)

Enum values for ResourceType

func (ResourceType) Values added in v0.29.0 

func (ResourceType) Values() []ResourceType

Values returns all known values for ResourceType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type S3Destination 

type S3Destination struct {

	// The name of the Amazon S3 bucket used as the destination of an export file.
	Bucket *string

	// The Amazon S3 bucket key of an export file. The key uniquely identifies the
	// object, or export file, in the S3 bucket.
	Key *string

	// The Amazon S3 bucket key of a metadata file. The key uniquely identifies the
	// object, or metadata file, in the S3 bucket.
	MetadataKey *string
}

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

type S3DestinationConfig 

type S3DestinationConfig struct {

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

	// The Amazon S3 bucket prefix for an export job.
	KeyPrefix *string
}

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 (https://docs.aws.amazon.com/compute-optimizer/latest/ug/create-s3-bucket-policy-for-compute-optimizer.html) in the Compute Optimizer user guide.

type ServiceUnavailableException 

type ServiceUnavailableException struct {
	Message *string
}

The request has failed due to a temporary failure of the server.

func (*ServiceUnavailableException) Error 

func (e *ServiceUnavailableException) Error() string

func (*ServiceUnavailableException) ErrorCode 

func (e *ServiceUnavailableException) ErrorCode() string

func (*ServiceUnavailableException) ErrorFault 

func (e *ServiceUnavailableException) ErrorFault() smithy.ErrorFault

func (*ServiceUnavailableException) ErrorMessage 

func (e *ServiceUnavailableException) ErrorMessage() string

type Status 

type Status string
const (
	StatusActive   Status = "Active"
	StatusInactive Status = "Inactive"
	StatusPending  Status = "Pending"
	StatusFailed   Status = "Failed"
)

Enum values for Status

func (Status) Values added in v0.29.0 

func (Status) Values() []Status

Values returns all known values for Status. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type Summary 

type Summary struct {

	// The finding classification of the recommendation.
	Name Finding

	// The value of the recommendation summary.
	Value float64
}

The summary of a recommendation.

type ThrottlingException 

type ThrottlingException struct {
	Message *string
}

The request was denied due to request throttling.

func (*ThrottlingException) Error 

func (e *ThrottlingException) Error() string

func (*ThrottlingException) ErrorCode 

func (e *ThrottlingException) ErrorCode() string

func (*ThrottlingException) ErrorFault 

func (e *ThrottlingException) ErrorFault() smithy.ErrorFault

func (*ThrottlingException) ErrorMessage 

func (e *ThrottlingException) ErrorMessage() string

type UtilizationMetric 

type UtilizationMetric struct {

	// The name of the utilization metric. The following utilization metrics are
	// available:
	//
	// * Cpu - The percentage of allocated EC2 compute units that are
	// currently in use on the instance. This metric identifies the processing power
	// required to run an application on the instance. Depending on the instance type,
	// tools in your operating system can show a lower percentage than CloudWatch when
	// the instance is not allocated a full processor core. Units: Percent
	//
	// * Memory -
	// The percentage of memory that is currently in use on the instance. This metric
	// identifies the amount of memory required to run an application on the instance.
	// Units: Percent 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
	// (https://docs.aws.amazon.com/compute-optimizer/latest/ug/metrics.html#cw-agent).
	//
	// *
	// EBS_READ_OPS_PER_SECOND - The completed read operations from all EBS volumes
	// attached to the instance in a specified period of time. Unit: Count
	//
	// *
	// EBS_WRITE_OPS_PER_SECOND - The completed write operations to all EBS volumes
	// attached to the instance in a specified period of time. Unit: Count
	//
	// *
	// EBS_READ_BYTES_PER_SECOND - The bytes read from all EBS volumes attached to the
	// instance in a specified period of time. Unit: Bytes
	//
	// *
	// EBS_WRITE_BYTES_PER_SECOND - The bytes written to all EBS volumes attached to
	// the instance in a specified period of time. Unit: Bytes
	Name MetricName

	// The statistic of the utilization metric. The following statistics are
	// available:
	//
	// * Average - This is the value of Sum / SampleCount during the
	// specified period, or the average value observed during the specified period.
	//
	// *
	// Maximum - The highest value observed during the specified period. Use this value
	// to determine high volumes of activity for your application.
	Statistic MetricStatistic

	// The value of the utilization metric.
	Value float64
}

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.

type VolumeConfiguration added in v0.31.0 

type VolumeConfiguration struct {

	// The baseline IOPS of the volume.
	VolumeBaselineIOPS int32

	// The baseline throughput of the volume.
	VolumeBaselineThroughput int32

	// The burst IOPS of the volume.
	VolumeBurstIOPS int32

	// The burst throughput of the volume.
	VolumeBurstThroughput int32

	// The size of the volume, in GiB.
	VolumeSize int32

	// The volume type. This can be gp2 for General Purpose SSD, io1 or io2 for
	// Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or
	// standard for Magnetic volumes.
	VolumeType *string
}

Describes the configuration of an Amazon Elastic Block Store (Amazon EBS) volume.

type VolumeRecommendation added in v0.31.0 

type VolumeRecommendation struct {

	// The AWS account ID of the volume.
	AccountId *string

	// An array of objects that describe the current configuration of the volume.
	CurrentConfiguration *VolumeConfiguration

	// The finding classification for the volume. Findings for volumes include:
	//
	// *
	// NotOptimized —A volume is considered not optimized when AWS Compute Optimizer
	// identifies a recommendation that can provide better performance for your
	// workload.
	//
	// * Optimized —An volume is considered optimized when Compute Optimizer
	// determines that the volume is correctly provisioned to run your workload based
	// on the chosen volume type. For optimized resources, Compute Optimizer might
	// recommend a new generation volume type.
	Finding EBSFinding

	// The time stamp of when the volume recommendation was last refreshed.
	LastRefreshTimestamp *time.Time

	// The number of days for which utilization metrics were analyzed for the volume.
	LookBackPeriodInDays float64

	// An array of objects that describe the utilization metrics of the volume.
	UtilizationMetrics []EBSUtilizationMetric

	// The Amazon Resource Name (ARN) of the current volume.
	VolumeArn *string

	// An array of objects that describe the recommendation options for the volume.
	VolumeRecommendationOptions []VolumeRecommendationOption
}

Describes an Amazon Elastic Block Store (Amazon EBS) volume recommendation.

type VolumeRecommendationOption added in v0.31.0 

type VolumeRecommendationOption struct {

	// An array of objects that describe a volume configuration.
	Configuration *VolumeConfiguration

	// The performance risk of the volume recommendation option. Performance risk is
	// the likelihood of the recommended volume type not meeting the performance
	// requirement of your workload. The lowest performance risk is categorized as 0,
	// and the highest as 5.
	PerformanceRisk float64

	// The rank of the volume recommendation option. The top recommendation option is
	// ranked as 1.
	Rank int32
}

Describes a recommendation option for an Amazon Elastic Block Store (Amazon EBS) instance.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.