computeoptimizer

package
v1.34.3 Latest Latest
Warning

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

 Go to latest Published: Aug 12, 2020 License: Apache-2.0 Imports: 10 Imported by: 16

Documentation

Overview

Package computeoptimizer provides the client and types for making API requests to AWS Compute Optimizer.

AWS Compute Optimizer is a service that analyzes the configuration and utilization metrics of your AWS resources, such as EC2 instances and Auto Scaling groups. 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 (https://docs.aws.amazon.com/compute-optimizer/latest/ug/).

See https://docs.aws.amazon.com/goto/WebAPI/compute-optimizer-2019-11-01 for more information on this service.

See computeoptimizer package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/computeoptimizer/

Using the Client

To contact AWS Compute Optimizer with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the AWS Compute Optimizer client ComputeOptimizer for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/computeoptimizer/#New

Index

Constants

View Source 
const (
	// ExportableAutoScalingGroupFieldAccountId is a ExportableAutoScalingGroupField enum value
	ExportableAutoScalingGroupFieldAccountId = "AccountId"

	// ExportableAutoScalingGroupFieldAutoScalingGroupArn is a ExportableAutoScalingGroupField enum value
	ExportableAutoScalingGroupFieldAutoScalingGroupArn = "AutoScalingGroupArn"

	// ExportableAutoScalingGroupFieldAutoScalingGroupName is a ExportableAutoScalingGroupField enum value
	ExportableAutoScalingGroupFieldAutoScalingGroupName = "AutoScalingGroupName"

	// ExportableAutoScalingGroupFieldFinding is a ExportableAutoScalingGroupField enum value
	ExportableAutoScalingGroupFieldFinding = "Finding"

	// ExportableAutoScalingGroupFieldUtilizationMetricsCpuMaximum is a ExportableAutoScalingGroupField enum value
	ExportableAutoScalingGroupFieldUtilizationMetricsCpuMaximum = "UtilizationMetricsCpuMaximum"

	// ExportableAutoScalingGroupFieldUtilizationMetricsMemoryMaximum is a ExportableAutoScalingGroupField enum value
	ExportableAutoScalingGroupFieldUtilizationMetricsMemoryMaximum = "UtilizationMetricsMemoryMaximum"

	// ExportableAutoScalingGroupFieldLookbackPeriodInDays is a ExportableAutoScalingGroupField enum value
	ExportableAutoScalingGroupFieldLookbackPeriodInDays = "LookbackPeriodInDays"

	// ExportableAutoScalingGroupFieldCurrentConfigurationInstanceType is a ExportableAutoScalingGroupField enum value
	ExportableAutoScalingGroupFieldCurrentConfigurationInstanceType = "CurrentConfigurationInstanceType"

	// ExportableAutoScalingGroupFieldCurrentConfigurationDesiredCapacity is a ExportableAutoScalingGroupField enum value
	ExportableAutoScalingGroupFieldCurrentConfigurationDesiredCapacity = "CurrentConfigurationDesiredCapacity"

	// ExportableAutoScalingGroupFieldCurrentConfigurationMinSize is a ExportableAutoScalingGroupField enum value
	ExportableAutoScalingGroupFieldCurrentConfigurationMinSize = "CurrentConfigurationMinSize"

	// ExportableAutoScalingGroupFieldCurrentConfigurationMaxSize is a ExportableAutoScalingGroupField enum value
	ExportableAutoScalingGroupFieldCurrentConfigurationMaxSize = "CurrentConfigurationMaxSize"

	// ExportableAutoScalingGroupFieldCurrentOnDemandPrice is a ExportableAutoScalingGroupField enum value
	ExportableAutoScalingGroupFieldCurrentOnDemandPrice = "CurrentOnDemandPrice"

	// ExportableAutoScalingGroupFieldCurrentStandardOneYearNoUpfrontReservedPrice is a ExportableAutoScalingGroupField enum value
	ExportableAutoScalingGroupFieldCurrentStandardOneYearNoUpfrontReservedPrice = "CurrentStandardOneYearNoUpfrontReservedPrice"

	// ExportableAutoScalingGroupFieldCurrentStandardThreeYearNoUpfrontReservedPrice is a ExportableAutoScalingGroupField enum value
	ExportableAutoScalingGroupFieldCurrentStandardThreeYearNoUpfrontReservedPrice = "CurrentStandardThreeYearNoUpfrontReservedPrice"

	// ExportableAutoScalingGroupFieldCurrentVcpus is a ExportableAutoScalingGroupField enum value
	ExportableAutoScalingGroupFieldCurrentVcpus = "CurrentVCpus"

	// ExportableAutoScalingGroupFieldCurrentMemory is a ExportableAutoScalingGroupField enum value
	ExportableAutoScalingGroupFieldCurrentMemory = "CurrentMemory"

	// ExportableAutoScalingGroupFieldCurrentStorage is a ExportableAutoScalingGroupField enum value
	ExportableAutoScalingGroupFieldCurrentStorage = "CurrentStorage"

	// ExportableAutoScalingGroupFieldCurrentNetwork is a ExportableAutoScalingGroupField enum value
	ExportableAutoScalingGroupFieldCurrentNetwork = "CurrentNetwork"

	// ExportableAutoScalingGroupFieldRecommendationOptionsConfigurationInstanceType is a ExportableAutoScalingGroupField enum value
	ExportableAutoScalingGroupFieldRecommendationOptionsConfigurationInstanceType = "RecommendationOptionsConfigurationInstanceType"

	// ExportableAutoScalingGroupFieldRecommendationOptionsConfigurationDesiredCapacity is a ExportableAutoScalingGroupField enum value
	ExportableAutoScalingGroupFieldRecommendationOptionsConfigurationDesiredCapacity = "RecommendationOptionsConfigurationDesiredCapacity"

	// ExportableAutoScalingGroupFieldRecommendationOptionsConfigurationMinSize is a ExportableAutoScalingGroupField enum value
	ExportableAutoScalingGroupFieldRecommendationOptionsConfigurationMinSize = "RecommendationOptionsConfigurationMinSize"

	// ExportableAutoScalingGroupFieldRecommendationOptionsConfigurationMaxSize is a ExportableAutoScalingGroupField enum value
	ExportableAutoScalingGroupFieldRecommendationOptionsConfigurationMaxSize = "RecommendationOptionsConfigurationMaxSize"

	// ExportableAutoScalingGroupFieldRecommendationOptionsProjectedUtilizationMetricsCpuMaximum is a ExportableAutoScalingGroupField enum value
	ExportableAutoScalingGroupFieldRecommendationOptionsProjectedUtilizationMetricsCpuMaximum = "RecommendationOptionsProjectedUtilizationMetricsCpuMaximum"

	// ExportableAutoScalingGroupFieldRecommendationOptionsProjectedUtilizationMetricsMemoryMaximum is a ExportableAutoScalingGroupField enum value
	ExportableAutoScalingGroupFieldRecommendationOptionsProjectedUtilizationMetricsMemoryMaximum = "RecommendationOptionsProjectedUtilizationMetricsMemoryMaximum"

	// ExportableAutoScalingGroupFieldRecommendationOptionsPerformanceRisk is a ExportableAutoScalingGroupField enum value
	ExportableAutoScalingGroupFieldRecommendationOptionsPerformanceRisk = "RecommendationOptionsPerformanceRisk"

	// ExportableAutoScalingGroupFieldRecommendationOptionsOnDemandPrice is a ExportableAutoScalingGroupField enum value
	ExportableAutoScalingGroupFieldRecommendationOptionsOnDemandPrice = "RecommendationOptionsOnDemandPrice"

	// ExportableAutoScalingGroupFieldRecommendationOptionsStandardOneYearNoUpfrontReservedPrice is a ExportableAutoScalingGroupField enum value
	ExportableAutoScalingGroupFieldRecommendationOptionsStandardOneYearNoUpfrontReservedPrice = "RecommendationOptionsStandardOneYearNoUpfrontReservedPrice"

	// ExportableAutoScalingGroupFieldRecommendationOptionsStandardThreeYearNoUpfrontReservedPrice is a ExportableAutoScalingGroupField enum value
	ExportableAutoScalingGroupFieldRecommendationOptionsStandardThreeYearNoUpfrontReservedPrice = "RecommendationOptionsStandardThreeYearNoUpfrontReservedPrice"

	// ExportableAutoScalingGroupFieldRecommendationOptionsVcpus is a ExportableAutoScalingGroupField enum value
	ExportableAutoScalingGroupFieldRecommendationOptionsVcpus = "RecommendationOptionsVcpus"

	// ExportableAutoScalingGroupFieldRecommendationOptionsMemory is a ExportableAutoScalingGroupField enum value
	ExportableAutoScalingGroupFieldRecommendationOptionsMemory = "RecommendationOptionsMemory"

	// ExportableAutoScalingGroupFieldRecommendationOptionsStorage is a ExportableAutoScalingGroupField enum value
	ExportableAutoScalingGroupFieldRecommendationOptionsStorage = "RecommendationOptionsStorage"

	// ExportableAutoScalingGroupFieldRecommendationOptionsNetwork is a ExportableAutoScalingGroupField enum value
	ExportableAutoScalingGroupFieldRecommendationOptionsNetwork = "RecommendationOptionsNetwork"

	// ExportableAutoScalingGroupFieldLastRefreshTimestamp is a ExportableAutoScalingGroupField enum value
	ExportableAutoScalingGroupFieldLastRefreshTimestamp = "LastRefreshTimestamp"
)
View Source 
const (
	// ExportableInstanceFieldAccountId is a ExportableInstanceField enum value
	ExportableInstanceFieldAccountId = "AccountId"

	// ExportableInstanceFieldInstanceArn is a ExportableInstanceField enum value
	ExportableInstanceFieldInstanceArn = "InstanceArn"

	// ExportableInstanceFieldInstanceName is a ExportableInstanceField enum value
	ExportableInstanceFieldInstanceName = "InstanceName"

	// ExportableInstanceFieldFinding is a ExportableInstanceField enum value
	ExportableInstanceFieldFinding = "Finding"

	// ExportableInstanceFieldLookbackPeriodInDays is a ExportableInstanceField enum value
	ExportableInstanceFieldLookbackPeriodInDays = "LookbackPeriodInDays"

	// ExportableInstanceFieldCurrentInstanceType is a ExportableInstanceField enum value
	ExportableInstanceFieldCurrentInstanceType = "CurrentInstanceType"

	// ExportableInstanceFieldUtilizationMetricsCpuMaximum is a ExportableInstanceField enum value
	ExportableInstanceFieldUtilizationMetricsCpuMaximum = "UtilizationMetricsCpuMaximum"

	// ExportableInstanceFieldUtilizationMetricsMemoryMaximum is a ExportableInstanceField enum value
	ExportableInstanceFieldUtilizationMetricsMemoryMaximum = "UtilizationMetricsMemoryMaximum"

	// ExportableInstanceFieldCurrentOnDemandPrice is a ExportableInstanceField enum value
	ExportableInstanceFieldCurrentOnDemandPrice = "CurrentOnDemandPrice"

	// ExportableInstanceFieldCurrentStandardOneYearNoUpfrontReservedPrice is a ExportableInstanceField enum value
	ExportableInstanceFieldCurrentStandardOneYearNoUpfrontReservedPrice = "CurrentStandardOneYearNoUpfrontReservedPrice"

	// ExportableInstanceFieldCurrentStandardThreeYearNoUpfrontReservedPrice is a ExportableInstanceField enum value
	ExportableInstanceFieldCurrentStandardThreeYearNoUpfrontReservedPrice = "CurrentStandardThreeYearNoUpfrontReservedPrice"

	// ExportableInstanceFieldCurrentVcpus is a ExportableInstanceField enum value
	ExportableInstanceFieldCurrentVcpus = "CurrentVCpus"

	// ExportableInstanceFieldCurrentMemory is a ExportableInstanceField enum value
	ExportableInstanceFieldCurrentMemory = "CurrentMemory"

	// ExportableInstanceFieldCurrentStorage is a ExportableInstanceField enum value
	ExportableInstanceFieldCurrentStorage = "CurrentStorage"

	// ExportableInstanceFieldCurrentNetwork is a ExportableInstanceField enum value
	ExportableInstanceFieldCurrentNetwork = "CurrentNetwork"

	// ExportableInstanceFieldRecommendationOptionsInstanceType is a ExportableInstanceField enum value
	ExportableInstanceFieldRecommendationOptionsInstanceType = "RecommendationOptionsInstanceType"

	// ExportableInstanceFieldRecommendationOptionsProjectedUtilizationMetricsCpuMaximum is a ExportableInstanceField enum value
	ExportableInstanceFieldRecommendationOptionsProjectedUtilizationMetricsCpuMaximum = "RecommendationOptionsProjectedUtilizationMetricsCpuMaximum"

	// ExportableInstanceFieldRecommendationOptionsProjectedUtilizationMetricsMemoryMaximum is a ExportableInstanceField enum value
	ExportableInstanceFieldRecommendationOptionsProjectedUtilizationMetricsMemoryMaximum = "RecommendationOptionsProjectedUtilizationMetricsMemoryMaximum"

	// ExportableInstanceFieldRecommendationOptionsPerformanceRisk is a ExportableInstanceField enum value
	ExportableInstanceFieldRecommendationOptionsPerformanceRisk = "RecommendationOptionsPerformanceRisk"

	// ExportableInstanceFieldRecommendationOptionsVcpus is a ExportableInstanceField enum value
	ExportableInstanceFieldRecommendationOptionsVcpus = "RecommendationOptionsVcpus"

	// ExportableInstanceFieldRecommendationOptionsMemory is a ExportableInstanceField enum value
	ExportableInstanceFieldRecommendationOptionsMemory = "RecommendationOptionsMemory"

	// ExportableInstanceFieldRecommendationOptionsStorage is a ExportableInstanceField enum value
	ExportableInstanceFieldRecommendationOptionsStorage = "RecommendationOptionsStorage"

	// ExportableInstanceFieldRecommendationOptionsNetwork is a ExportableInstanceField enum value
	ExportableInstanceFieldRecommendationOptionsNetwork = "RecommendationOptionsNetwork"

	// ExportableInstanceFieldRecommendationOptionsOnDemandPrice is a ExportableInstanceField enum value
	ExportableInstanceFieldRecommendationOptionsOnDemandPrice = "RecommendationOptionsOnDemandPrice"

	// ExportableInstanceFieldRecommendationOptionsStandardOneYearNoUpfrontReservedPrice is a ExportableInstanceField enum value
	ExportableInstanceFieldRecommendationOptionsStandardOneYearNoUpfrontReservedPrice = "RecommendationOptionsStandardOneYearNoUpfrontReservedPrice"

	// ExportableInstanceFieldRecommendationOptionsStandardThreeYearNoUpfrontReservedPrice is a ExportableInstanceField enum value
	ExportableInstanceFieldRecommendationOptionsStandardThreeYearNoUpfrontReservedPrice = "RecommendationOptionsStandardThreeYearNoUpfrontReservedPrice"

	// ExportableInstanceFieldRecommendationsSourcesRecommendationSourceArn is a ExportableInstanceField enum value
	ExportableInstanceFieldRecommendationsSourcesRecommendationSourceArn = "RecommendationsSourcesRecommendationSourceArn"

	// ExportableInstanceFieldRecommendationsSourcesRecommendationSourceType is a ExportableInstanceField enum value
	ExportableInstanceFieldRecommendationsSourcesRecommendationSourceType = "RecommendationsSourcesRecommendationSourceType"

	// ExportableInstanceFieldLastRefreshTimestamp is a ExportableInstanceField enum value
	ExportableInstanceFieldLastRefreshTimestamp = "LastRefreshTimestamp"
)
View Source 
const (
	// FilterNameFinding is a FilterName enum value
	FilterNameFinding = "Finding"

	// FilterNameRecommendationSourceType is a FilterName enum value
	FilterNameRecommendationSourceType = "RecommendationSourceType"
)
View Source 
const (
	// FindingUnderprovisioned is a Finding enum value
	FindingUnderprovisioned = "Underprovisioned"

	// FindingOverprovisioned is a Finding enum value
	FindingOverprovisioned = "Overprovisioned"

	// FindingOptimized is a Finding enum value
	FindingOptimized = "Optimized"

	// FindingNotOptimized is a Finding enum value
	FindingNotOptimized = "NotOptimized"
)
View Source 
const (
	// JobFilterNameResourceType is a JobFilterName enum value
	JobFilterNameResourceType = "ResourceType"

	// JobFilterNameJobStatus is a JobFilterName enum value
	JobFilterNameJobStatus = "JobStatus"
)
View Source 
const (
	// JobStatusQueued is a JobStatus enum value
	JobStatusQueued = "Queued"

	// JobStatusInProgress is a JobStatus enum value
	JobStatusInProgress = "InProgress"

	// JobStatusComplete is a JobStatus enum value
	JobStatusComplete = "Complete"

	// JobStatusFailed is a JobStatus enum value
	JobStatusFailed = "Failed"
)
View Source 
const (
	// MetricNameCpu is a MetricName enum value
	MetricNameCpu = "Cpu"

	// MetricNameMemory is a MetricName enum value
	MetricNameMemory = "Memory"
)
View Source 
const (
	// MetricStatisticMaximum is a MetricStatistic enum value
	MetricStatisticMaximum = "Maximum"

	// MetricStatisticAverage is a MetricStatistic enum value
	MetricStatisticAverage = "Average"
)
View Source 
const (
	// RecommendationSourceTypeEc2instance is a RecommendationSourceType enum value
	RecommendationSourceTypeEc2instance = "Ec2Instance"

	// RecommendationSourceTypeAutoScalingGroup is a RecommendationSourceType enum value
	RecommendationSourceTypeAutoScalingGroup = "AutoScalingGroup"
)
View Source 
const (
	// ResourceTypeEc2instance is a ResourceType enum value
	ResourceTypeEc2instance = "Ec2Instance"

	// ResourceTypeAutoScalingGroup is a ResourceType enum value
	ResourceTypeAutoScalingGroup = "AutoScalingGroup"
)
View Source 
const (
	// StatusActive is a Status enum value
	StatusActive = "Active"

	// StatusInactive is a Status enum value
	StatusInactive = "Inactive"

	// StatusPending is a Status enum value
	StatusPending = "Pending"

	// StatusFailed is a Status enum value
	StatusFailed = "Failed"
)
View Source 
const (

	// ErrCodeAccessDeniedException for service response error code
	// "AccessDeniedException".
	//
	// You do not have sufficient access to perform this action.
	ErrCodeAccessDeniedException = "AccessDeniedException"

	// ErrCodeInternalServerException for service response error code
	// "InternalServerException".
	//
	// An internal error has occurred. Try your call again.
	ErrCodeInternalServerException = "InternalServerException"

	// ErrCodeInvalidParameterValueException for service response error code
	// "InvalidParameterValueException".
	//
	// An invalid or out-of-range value was supplied for the input parameter.
	ErrCodeInvalidParameterValueException = "InvalidParameterValueException"

	// ErrCodeLimitExceededException for service response error code
	// "LimitExceededException".
	//
	// The request exceeds a limit of the service.
	ErrCodeLimitExceededException = "LimitExceededException"

	// ErrCodeMissingAuthenticationToken for service response error code
	// "MissingAuthenticationToken".
	//
	// The request must contain either a valid (registered) AWS access key ID or
	// X.509 certificate.
	ErrCodeMissingAuthenticationToken = "MissingAuthenticationToken"

	// ErrCodeOptInRequiredException for service response error code
	// "OptInRequiredException".
	//
	// The account is not opted in to AWS Compute Optimizer.
	ErrCodeOptInRequiredException = "OptInRequiredException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// A resource that is required for the action doesn't exist.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// ErrCodeServiceUnavailableException for service response error code
	// "ServiceUnavailableException".
	//
	// The request has failed due to a temporary failure of the server.
	ErrCodeServiceUnavailableException = "ServiceUnavailableException"

	// ErrCodeThrottlingException for service response error code
	// "ThrottlingException".
	//
	// The request was denied due to request throttling.
	ErrCodeThrottlingException = "ThrottlingException"
)
View Source 
const (
	ServiceName = "Compute Optimizer" // Name of service.
	EndpointsID = "compute-optimizer" // ID to lookup a service endpoint with.
	ServiceID   = "Compute Optimizer" // ServiceID is a unique identifier of a specific service.
)

Service information constants

View Source 
const (
	// FileFormatCsv is a FileFormat enum value
	FileFormatCsv = "Csv"
)

Variables

This section is empty.

Functions

func ExportableAutoScalingGroupField_Values added in v1.34.3 

func ExportableAutoScalingGroupField_Values() []string

ExportableAutoScalingGroupField_Values returns all elements of the ExportableAutoScalingGroupField enum

func ExportableInstanceField_Values added in v1.34.3 

func ExportableInstanceField_Values() []string

ExportableInstanceField_Values returns all elements of the ExportableInstanceField enum

func FileFormat_Values added in v1.34.3 

func FileFormat_Values() []string

FileFormat_Values returns all elements of the FileFormat enum

func FilterName_Values added in v1.34.3 

func FilterName_Values() []string

FilterName_Values returns all elements of the FilterName enum

func Finding_Values added in v1.34.3 

func Finding_Values() []string

Finding_Values returns all elements of the Finding enum

func JobFilterName_Values added in v1.34.3 

func JobFilterName_Values() []string

JobFilterName_Values returns all elements of the JobFilterName enum

func JobStatus_Values added in v1.34.3 

func JobStatus_Values() []string

JobStatus_Values returns all elements of the JobStatus enum

func MetricName_Values added in v1.34.3 

func MetricName_Values() []string

MetricName_Values returns all elements of the MetricName enum

func MetricStatistic_Values added in v1.34.3 

func MetricStatistic_Values() []string

MetricStatistic_Values returns all elements of the MetricStatistic enum

func RecommendationSourceType_Values added in v1.34.3 

func RecommendationSourceType_Values() []string

RecommendationSourceType_Values returns all elements of the RecommendationSourceType enum

func ResourceType_Values added in v1.34.3 

func ResourceType_Values() []string

ResourceType_Values returns all elements of the ResourceType enum

func Status_Values added in v1.34.3 

func Status_Values() []string

Status_Values returns all elements of the Status enum

Types

type AccessDeniedException added in v1.28.0 

type AccessDeniedException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

You do not have sufficient access to perform this action.

func (*AccessDeniedException) Code added in v1.28.0 

func (s *AccessDeniedException) Code() string

Code returns the exception type name.

func (*AccessDeniedException) Error added in v1.28.0 

func (s *AccessDeniedException) Error() string

func (AccessDeniedException) GoString added in v1.28.0 

func (s AccessDeniedException) GoString() string

GoString returns the string representation

func (*AccessDeniedException) Message added in v1.28.0 

func (s *AccessDeniedException) Message() string

Message returns the exception's message.

func (*AccessDeniedException) OrigErr added in v1.28.0 

func (s *AccessDeniedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*AccessDeniedException) RequestID added in v1.28.0 

func (s *AccessDeniedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*AccessDeniedException) StatusCode added in v1.28.0 

func (s *AccessDeniedException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (AccessDeniedException) String added in v1.28.0 

func (s AccessDeniedException) String() string

String returns the string representation

type AutoScalingGroupConfiguration 

type AutoScalingGroupConfiguration struct {

	// The desired capacity, or number of instances, for the Auto Scaling group.
	DesiredCapacity *int64 `locationName:"desiredCapacity" type:"integer"`

	// The instance type for the Auto Scaling group.
	InstanceType *string `locationName:"instanceType" type:"string"`

	// The maximum size, or maximum number of instances, for the Auto Scaling group.
	MaxSize *int64 `locationName:"maxSize" type:"integer"`

	// The minimum size, or minimum number of instances, for the Auto Scaling group.
	MinSize *int64 `locationName:"minSize" type:"integer"`
	// contains filtered or unexported fields
}

Describes the configuration of an Auto Scaling group.

func (AutoScalingGroupConfiguration) GoString 

func (s AutoScalingGroupConfiguration) GoString() string

GoString returns the string representation

func (*AutoScalingGroupConfiguration) SetDesiredCapacity 

func (s *AutoScalingGroupConfiguration) SetDesiredCapacity(v int64) *AutoScalingGroupConfiguration

SetDesiredCapacity sets the DesiredCapacity field's value.

func (*AutoScalingGroupConfiguration) SetInstanceType 

func (s *AutoScalingGroupConfiguration) SetInstanceType(v string) *AutoScalingGroupConfiguration

SetInstanceType sets the InstanceType field's value.

func (*AutoScalingGroupConfiguration) SetMaxSize 

func (s *AutoScalingGroupConfiguration) SetMaxSize(v int64) *AutoScalingGroupConfiguration

SetMaxSize sets the MaxSize field's value.

func (*AutoScalingGroupConfiguration) SetMinSize 

func (s *AutoScalingGroupConfiguration) SetMinSize(v int64) *AutoScalingGroupConfiguration

SetMinSize sets the MinSize field's value.

func (AutoScalingGroupConfiguration) String 

func (s AutoScalingGroupConfiguration) String() string

String returns the string representation

type AutoScalingGroupRecommendation 

type AutoScalingGroupRecommendation struct {

	// The AWS account ID of the Auto Scaling group.
	AccountId *string `locationName:"accountId" type:"string"`

	// The Amazon Resource Name (ARN) of the Auto Scaling group.
	AutoScalingGroupArn *string `locationName:"autoScalingGroupArn" type:"string"`

	// The name of the Auto Scaling group.
	AutoScalingGroupName *string `locationName:"autoScalingGroupName" type:"string"`

	// An array of objects that describe the current configuration of the Auto Scaling
	// group.
	CurrentConfiguration *AutoScalingGroupConfiguration `locationName:"currentConfiguration" type:"structure"`

	// 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.
	//
	// The values that are returned might be NOT_OPTIMIZED or OPTIMIZED.
	Finding *string `locationName:"finding" type:"string" enum:"Finding"`

	// The time stamp of when the Auto Scaling group recommendation was last refreshed.
	LastRefreshTimestamp *time.Time `locationName:"lastRefreshTimestamp" type:"timestamp"`

	// The number of days for which utilization metrics were analyzed for the Auto
	// Scaling group.
	LookBackPeriodInDays *float64 `locationName:"lookBackPeriodInDays" type:"double"`

	// An array of objects that describe the recommendation options for the Auto
	// Scaling group.
	RecommendationOptions []*AutoScalingGroupRecommendationOption `locationName:"recommendationOptions" type:"list"`

	// An array of objects that describe the utilization metrics of the Auto Scaling
	// group.
	UtilizationMetrics []*UtilizationMetric `locationName:"utilizationMetrics" type:"list"`
	// contains filtered or unexported fields
}

Describes an Auto Scaling group recommendation.

func (AutoScalingGroupRecommendation) GoString 

func (s AutoScalingGroupRecommendation) GoString() string

GoString returns the string representation

func (*AutoScalingGroupRecommendation) SetAccountId 

func (s *AutoScalingGroupRecommendation) SetAccountId(v string) *AutoScalingGroupRecommendation

SetAccountId sets the AccountId field's value.

func (*AutoScalingGroupRecommendation) SetAutoScalingGroupArn 

func (s *AutoScalingGroupRecommendation) SetAutoScalingGroupArn(v string) *AutoScalingGroupRecommendation

SetAutoScalingGroupArn sets the AutoScalingGroupArn field's value.

func (*AutoScalingGroupRecommendation) SetAutoScalingGroupName 

func (s *AutoScalingGroupRecommendation) SetAutoScalingGroupName(v string) *AutoScalingGroupRecommendation

SetAutoScalingGroupName sets the AutoScalingGroupName field's value.

func (*AutoScalingGroupRecommendation) SetCurrentConfiguration 

func (s *AutoScalingGroupRecommendation) SetCurrentConfiguration(v *AutoScalingGroupConfiguration) *AutoScalingGroupRecommendation

SetCurrentConfiguration sets the CurrentConfiguration field's value.

func (*AutoScalingGroupRecommendation) SetFinding 

func (s *AutoScalingGroupRecommendation) SetFinding(v string) *AutoScalingGroupRecommendation

SetFinding sets the Finding field's value.

func (*AutoScalingGroupRecommendation) SetLastRefreshTimestamp 

func (s *AutoScalingGroupRecommendation) SetLastRefreshTimestamp(v time.Time) *AutoScalingGroupRecommendation

SetLastRefreshTimestamp sets the LastRefreshTimestamp field's value.

func (*AutoScalingGroupRecommendation) SetLookBackPeriodInDays 

func (s *AutoScalingGroupRecommendation) SetLookBackPeriodInDays(v float64) *AutoScalingGroupRecommendation

SetLookBackPeriodInDays sets the LookBackPeriodInDays field's value.

func (*AutoScalingGroupRecommendation) SetRecommendationOptions 

func (s *AutoScalingGroupRecommendation) SetRecommendationOptions(v []*AutoScalingGroupRecommendationOption) *AutoScalingGroupRecommendation

SetRecommendationOptions sets the RecommendationOptions field's value.

func (*AutoScalingGroupRecommendation) SetUtilizationMetrics 

func (s *AutoScalingGroupRecommendation) SetUtilizationMetrics(v []*UtilizationMetric) *AutoScalingGroupRecommendation

SetUtilizationMetrics sets the UtilizationMetrics field's value.

func (AutoScalingGroupRecommendation) String 

func (s AutoScalingGroupRecommendation) String() string

String returns the string representation

type AutoScalingGroupRecommendationOption 

type AutoScalingGroupRecommendationOption struct {

	// An array of objects that describe an Auto Scaling group configuration.
	Configuration *AutoScalingGroupConfiguration `locationName:"configuration" type:"structure"`

	// 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 `locationName:"performanceRisk" type:"double"`

	// An array of objects that describe the projected utilization metrics of the
	// Auto Scaling group recommendation option.
	ProjectedUtilizationMetrics []*UtilizationMetric `locationName:"projectedUtilizationMetrics" type:"list"`

	// The rank of the Auto Scaling group recommendation option.
	//
	// The top recommendation option is ranked as 1.
	Rank *int64 `locationName:"rank" type:"integer"`
	// contains filtered or unexported fields
}

Describes a recommendation option for an Auto Scaling group.

func (AutoScalingGroupRecommendationOption) GoString 

func (s AutoScalingGroupRecommendationOption) GoString() string

GoString returns the string representation

func (*AutoScalingGroupRecommendationOption) SetConfiguration 

func (s *AutoScalingGroupRecommendationOption) SetConfiguration(v *AutoScalingGroupConfiguration) *AutoScalingGroupRecommendationOption

SetConfiguration sets the Configuration field's value.

func (*AutoScalingGroupRecommendationOption) SetPerformanceRisk 

func (s *AutoScalingGroupRecommendationOption) SetPerformanceRisk(v float64) *AutoScalingGroupRecommendationOption

SetPerformanceRisk sets the PerformanceRisk field's value.

func (*AutoScalingGroupRecommendationOption) SetProjectedUtilizationMetrics 

func (s *AutoScalingGroupRecommendationOption) SetProjectedUtilizationMetrics(v []*UtilizationMetric) *AutoScalingGroupRecommendationOption

SetProjectedUtilizationMetrics sets the ProjectedUtilizationMetrics field's value.

func (*AutoScalingGroupRecommendationOption) SetRank 

func (s *AutoScalingGroupRecommendationOption) SetRank(v int64) *AutoScalingGroupRecommendationOption

SetRank sets the Rank field's value.

func (AutoScalingGroupRecommendationOption) String 

func (s AutoScalingGroupRecommendationOption) String() string

String returns the string representation

type ComputeOptimizer 

type ComputeOptimizer struct {
	*client.Client
}

ComputeOptimizer provides the API operation methods for making requests to AWS Compute Optimizer. See this package's package overview docs for details on the service.

ComputeOptimizer methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New 

func New(p client.ConfigProvider, cfgs ...*aws.Config) *ComputeOptimizer

New creates a new instance of the ComputeOptimizer client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example: 

mySession := session.Must(session.NewSession())

// Create a ComputeOptimizer client from just a session.
svc := computeoptimizer.New(mySession)

// Create a ComputeOptimizer client with additional configuration
svc := computeoptimizer.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*ComputeOptimizer) DescribeRecommendationExportJobs added in v1.31.15 

func (c *ComputeOptimizer) DescribeRecommendationExportJobs(input *DescribeRecommendationExportJobsInput) (*DescribeRecommendationExportJobsOutput, error)

DescribeRecommendationExportJobs API operation for AWS Compute Optimizer.

Describes recommendation export jobs created in the last seven days.

Use the ExportAutoScalingGroupRecommendations or ExportEC2InstanceRecommendations actions to request an export of your recommendations. Then use the DescribeRecommendationExportJobs action to view your export jobs.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Compute Optimizer's API operation DescribeRecommendationExportJobs for usage and error information.

Returned Error Types:

  • OptInRequiredException The account is not opted in to AWS Compute Optimizer.

  • InternalServerException An internal error has occurred. Try your call again.

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

  • AccessDeniedException You do not have sufficient access to perform this action.

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

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

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

  • ThrottlingException The request was denied due to request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/compute-optimizer-2019-11-01/DescribeRecommendationExportJobs

func (*ComputeOptimizer) DescribeRecommendationExportJobsRequest added in v1.31.15 

func (c *ComputeOptimizer) DescribeRecommendationExportJobsRequest(input *DescribeRecommendationExportJobsInput) (req *request.Request, output *DescribeRecommendationExportJobsOutput)

DescribeRecommendationExportJobsRequest generates a "aws/request.Request" representing the client's request for the DescribeRecommendationExportJobs operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeRecommendationExportJobs for more information on using the DescribeRecommendationExportJobs API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeRecommendationExportJobsRequest method.
req, resp := client.DescribeRecommendationExportJobsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/compute-optimizer-2019-11-01/DescribeRecommendationExportJobs

func (*ComputeOptimizer) DescribeRecommendationExportJobsWithContext added in v1.31.15 

func (c *ComputeOptimizer) DescribeRecommendationExportJobsWithContext(ctx aws.Context, input *DescribeRecommendationExportJobsInput, opts ...request.Option) (*DescribeRecommendationExportJobsOutput, error)

DescribeRecommendationExportJobsWithContext is the same as DescribeRecommendationExportJobs with the addition of the ability to pass a context and additional request options.

See DescribeRecommendationExportJobs for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ComputeOptimizer) ExportAutoScalingGroupRecommendations added in v1.31.15 

func (c *ComputeOptimizer) ExportAutoScalingGroupRecommendations(input *ExportAutoScalingGroupRecommendationsInput) (*ExportAutoScalingGroupRecommendationsOutput, error)

ExportAutoScalingGroupRecommendations API operation for AWS Compute Optimizer.

Exports optimization recommendations for Auto Scaling groups.

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 (https://docs.aws.amazon.com/compute-optimizer/latest/ug/exporting-recommendations.html) in the Compute Optimizer User Guide.

You can have only one Auto Scaling group export job in progress per AWS Region.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Compute Optimizer's API operation ExportAutoScalingGroupRecommendations for usage and error information.

Returned Error Types:

  • OptInRequiredException The account is not opted in to AWS Compute Optimizer.

  • InternalServerException An internal error has occurred. Try your call again.

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

  • AccessDeniedException You do not have sufficient access to perform this action.

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

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

  • ThrottlingException The request was denied due to request throttling.

  • LimitExceededException The request exceeds a limit of the service.

See also, https://docs.aws.amazon.com/goto/WebAPI/compute-optimizer-2019-11-01/ExportAutoScalingGroupRecommendations

func (*ComputeOptimizer) ExportAutoScalingGroupRecommendationsRequest added in v1.31.15 

func (c *ComputeOptimizer) ExportAutoScalingGroupRecommendationsRequest(input *ExportAutoScalingGroupRecommendationsInput) (req *request.Request, output *ExportAutoScalingGroupRecommendationsOutput)

ExportAutoScalingGroupRecommendationsRequest generates a "aws/request.Request" representing the client's request for the ExportAutoScalingGroupRecommendations operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ExportAutoScalingGroupRecommendations for more information on using the ExportAutoScalingGroupRecommendations API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ExportAutoScalingGroupRecommendationsRequest method.
req, resp := client.ExportAutoScalingGroupRecommendationsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/compute-optimizer-2019-11-01/ExportAutoScalingGroupRecommendations

func (*ComputeOptimizer) ExportAutoScalingGroupRecommendationsWithContext added in v1.31.15 

func (c *ComputeOptimizer) ExportAutoScalingGroupRecommendationsWithContext(ctx aws.Context, input *ExportAutoScalingGroupRecommendationsInput, opts ...request.Option) (*ExportAutoScalingGroupRecommendationsOutput, error)

ExportAutoScalingGroupRecommendationsWithContext is the same as ExportAutoScalingGroupRecommendations with the addition of the ability to pass a context and additional request options.

See ExportAutoScalingGroupRecommendations for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ComputeOptimizer) ExportEC2InstanceRecommendations added in v1.31.15 

func (c *ComputeOptimizer) ExportEC2InstanceRecommendations(input *ExportEC2InstanceRecommendationsInput) (*ExportEC2InstanceRecommendationsOutput, error)

ExportEC2InstanceRecommendations API operation for AWS Compute Optimizer.

Exports optimization recommendations for Amazon EC2 instances.

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 (https://docs.aws.amazon.com/compute-optimizer/latest/ug/exporting-recommendations.html) in the Compute Optimizer User Guide.

You can have only one Amazon EC2 instance export job in progress per AWS Region.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Compute Optimizer's API operation ExportEC2InstanceRecommendations for usage and error information.

Returned Error Types:

  • OptInRequiredException The account is not opted in to AWS Compute Optimizer.

  • InternalServerException An internal error has occurred. Try your call again.

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

  • AccessDeniedException You do not have sufficient access to perform this action.

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

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

  • ThrottlingException The request was denied due to request throttling.

  • LimitExceededException The request exceeds a limit of the service.

See also, https://docs.aws.amazon.com/goto/WebAPI/compute-optimizer-2019-11-01/ExportEC2InstanceRecommendations

func (*ComputeOptimizer) ExportEC2InstanceRecommendationsRequest added in v1.31.15 

func (c *ComputeOptimizer) ExportEC2InstanceRecommendationsRequest(input *ExportEC2InstanceRecommendationsInput) (req *request.Request, output *ExportEC2InstanceRecommendationsOutput)

ExportEC2InstanceRecommendationsRequest generates a "aws/request.Request" representing the client's request for the ExportEC2InstanceRecommendations operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ExportEC2InstanceRecommendations for more information on using the ExportEC2InstanceRecommendations API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ExportEC2InstanceRecommendationsRequest method.
req, resp := client.ExportEC2InstanceRecommendationsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/compute-optimizer-2019-11-01/ExportEC2InstanceRecommendations

func (*ComputeOptimizer) ExportEC2InstanceRecommendationsWithContext added in v1.31.15 

func (c *ComputeOptimizer) ExportEC2InstanceRecommendationsWithContext(ctx aws.Context, input *ExportEC2InstanceRecommendationsInput, opts ...request.Option) (*ExportEC2InstanceRecommendationsOutput, error)

ExportEC2InstanceRecommendationsWithContext is the same as ExportEC2InstanceRecommendations with the addition of the ability to pass a context and additional request options.

See ExportEC2InstanceRecommendations for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ComputeOptimizer) GetAutoScalingGroupRecommendations 

func (c *ComputeOptimizer) GetAutoScalingGroupRecommendations(input *GetAutoScalingGroupRecommendationsInput) (*GetAutoScalingGroupRecommendationsOutput, error)

GetAutoScalingGroupRecommendations API operation for AWS Compute Optimizer.

Returns Auto Scaling group recommendations.

AWS Compute Optimizer currently generates recommendations for Auto Scaling groups that are configured to run instances of the M, C, R, T, and X instance families. The service does not generate recommendations for Auto Scaling groups that have a scaling policy attached to them, or that do not have the same values for desired, minimum, and maximum capacity. In order for Compute Optimizer to analyze your Auto Scaling groups, they must be of a fixed size. For more information, see the AWS Compute Optimizer User Guide (https://docs.aws.amazon.com/compute-optimizer/latest/ug/what-is.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Compute Optimizer's API operation GetAutoScalingGroupRecommendations for usage and error information.

Returned Error Types:

  • OptInRequiredException The account is not opted in to AWS Compute Optimizer.

  • InternalServerException An internal error has occurred. Try your call again.

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

  • AccessDeniedException You do not have sufficient access to perform this action.

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

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

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

  • ThrottlingException The request was denied due to request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/compute-optimizer-2019-11-01/GetAutoScalingGroupRecommendations

func (*ComputeOptimizer) GetAutoScalingGroupRecommendationsRequest 

func (c *ComputeOptimizer) GetAutoScalingGroupRecommendationsRequest(input *GetAutoScalingGroupRecommendationsInput) (req *request.Request, output *GetAutoScalingGroupRecommendationsOutput)

GetAutoScalingGroupRecommendationsRequest generates a "aws/request.Request" representing the client's request for the GetAutoScalingGroupRecommendations operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetAutoScalingGroupRecommendations for more information on using the GetAutoScalingGroupRecommendations API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetAutoScalingGroupRecommendationsRequest method.
req, resp := client.GetAutoScalingGroupRecommendationsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/compute-optimizer-2019-11-01/GetAutoScalingGroupRecommendations

func (*ComputeOptimizer) GetAutoScalingGroupRecommendationsWithContext 

func (c *ComputeOptimizer) GetAutoScalingGroupRecommendationsWithContext(ctx aws.Context, input *GetAutoScalingGroupRecommendationsInput, opts ...request.Option) (*GetAutoScalingGroupRecommendationsOutput, error)

GetAutoScalingGroupRecommendationsWithContext is the same as GetAutoScalingGroupRecommendations with the addition of the ability to pass a context and additional request options.

See GetAutoScalingGroupRecommendations for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ComputeOptimizer) GetEC2InstanceRecommendations 

func (c *ComputeOptimizer) GetEC2InstanceRecommendations(input *GetEC2InstanceRecommendationsInput) (*GetEC2InstanceRecommendationsOutput, error)

GetEC2InstanceRecommendations API operation for AWS Compute Optimizer.

Returns Amazon EC2 instance recommendations.

AWS Compute Optimizer currently generates recommendations for Amazon Elastic Compute Cloud (Amazon EC2) and Amazon EC2 Auto Scaling. It generates recommendations for M, C, R, T, and X instance families. For more information, see the AWS Compute Optimizer User Guide (https://docs.aws.amazon.com/compute-optimizer/latest/ug/what-is.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Compute Optimizer's API operation GetEC2InstanceRecommendations for usage and error information.

Returned Error Types:

  • OptInRequiredException The account is not opted in to AWS Compute Optimizer.

  • InternalServerException An internal error has occurred. Try your call again.

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

  • AccessDeniedException You do not have sufficient access to perform this action.

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

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

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

  • ThrottlingException The request was denied due to request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/compute-optimizer-2019-11-01/GetEC2InstanceRecommendations

func (*ComputeOptimizer) GetEC2InstanceRecommendationsRequest 

func (c *ComputeOptimizer) GetEC2InstanceRecommendationsRequest(input *GetEC2InstanceRecommendationsInput) (req *request.Request, output *GetEC2InstanceRecommendationsOutput)

GetEC2InstanceRecommendationsRequest generates a "aws/request.Request" representing the client's request for the GetEC2InstanceRecommendations operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetEC2InstanceRecommendations for more information on using the GetEC2InstanceRecommendations API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetEC2InstanceRecommendationsRequest method.
req, resp := client.GetEC2InstanceRecommendationsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/compute-optimizer-2019-11-01/GetEC2InstanceRecommendations

func (*ComputeOptimizer) GetEC2InstanceRecommendationsWithContext 

func (c *ComputeOptimizer) GetEC2InstanceRecommendationsWithContext(ctx aws.Context, input *GetEC2InstanceRecommendationsInput, opts ...request.Option) (*GetEC2InstanceRecommendationsOutput, error)

GetEC2InstanceRecommendationsWithContext is the same as GetEC2InstanceRecommendations with the addition of the ability to pass a context and additional request options.

See GetEC2InstanceRecommendations for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ComputeOptimizer) GetEC2RecommendationProjectedMetrics 

func (c *ComputeOptimizer) GetEC2RecommendationProjectedMetrics(input *GetEC2RecommendationProjectedMetricsInput) (*GetEC2RecommendationProjectedMetricsOutput, error)

GetEC2RecommendationProjectedMetrics API operation for AWS Compute Optimizer.

Returns the projected utilization metrics of Amazon EC2 instance recommendations.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Compute Optimizer's API operation GetEC2RecommendationProjectedMetrics for usage and error information.

Returned Error Types:

  • OptInRequiredException The account is not opted in to AWS Compute Optimizer.

  • InternalServerException An internal error has occurred. Try your call again.

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

  • AccessDeniedException You do not have sufficient access to perform this action.

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

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

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

  • ThrottlingException The request was denied due to request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/compute-optimizer-2019-11-01/GetEC2RecommendationProjectedMetrics

func (*ComputeOptimizer) GetEC2RecommendationProjectedMetricsRequest 

func (c *ComputeOptimizer) GetEC2RecommendationProjectedMetricsRequest(input *GetEC2RecommendationProjectedMetricsInput) (req *request.Request, output *GetEC2RecommendationProjectedMetricsOutput)

GetEC2RecommendationProjectedMetricsRequest generates a "aws/request.Request" representing the client's request for the GetEC2RecommendationProjectedMetrics operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetEC2RecommendationProjectedMetrics for more information on using the GetEC2RecommendationProjectedMetrics API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetEC2RecommendationProjectedMetricsRequest method.
req, resp := client.GetEC2RecommendationProjectedMetricsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/compute-optimizer-2019-11-01/GetEC2RecommendationProjectedMetrics

func (*ComputeOptimizer) GetEC2RecommendationProjectedMetricsWithContext 

func (c *ComputeOptimizer) GetEC2RecommendationProjectedMetricsWithContext(ctx aws.Context, input *GetEC2RecommendationProjectedMetricsInput, opts ...request.Option) (*GetEC2RecommendationProjectedMetricsOutput, error)

GetEC2RecommendationProjectedMetricsWithContext is the same as GetEC2RecommendationProjectedMetrics with the addition of the ability to pass a context and additional request options.

See GetEC2RecommendationProjectedMetrics for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ComputeOptimizer) GetEnrollmentStatus 

func (c *ComputeOptimizer) GetEnrollmentStatus(input *GetEnrollmentStatusInput) (*GetEnrollmentStatusOutput, error)

GetEnrollmentStatus API operation for AWS Compute Optimizer.

Returns the enrollment (opt in) status of an account to the AWS Compute Optimizer service.

If the account is the master account of an organization, this action also confirms the enrollment status of member accounts within the organization.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Compute Optimizer's API operation GetEnrollmentStatus for usage and error information.

Returned Error Types:

  • InternalServerException An internal error has occurred. Try your call again.

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

  • AccessDeniedException You do not have sufficient access to perform this action.

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

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

  • ThrottlingException The request was denied due to request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/compute-optimizer-2019-11-01/GetEnrollmentStatus

func (*ComputeOptimizer) GetEnrollmentStatusRequest 

func (c *ComputeOptimizer) GetEnrollmentStatusRequest(input *GetEnrollmentStatusInput) (req *request.Request, output *GetEnrollmentStatusOutput)

GetEnrollmentStatusRequest generates a "aws/request.Request" representing the client's request for the GetEnrollmentStatus operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetEnrollmentStatus for more information on using the GetEnrollmentStatus API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetEnrollmentStatusRequest method.
req, resp := client.GetEnrollmentStatusRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/compute-optimizer-2019-11-01/GetEnrollmentStatus

func (*ComputeOptimizer) GetEnrollmentStatusWithContext 

func (c *ComputeOptimizer) GetEnrollmentStatusWithContext(ctx aws.Context, input *GetEnrollmentStatusInput, opts ...request.Option) (*GetEnrollmentStatusOutput, error)

GetEnrollmentStatusWithContext is the same as GetEnrollmentStatus with the addition of the ability to pass a context and additional request options.

See GetEnrollmentStatus for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ComputeOptimizer) GetRecommendationSummaries 

func (c *ComputeOptimizer) GetRecommendationSummaries(input *GetRecommendationSummariesInput) (*GetRecommendationSummariesOutput, error)

GetRecommendationSummaries API operation for AWS Compute Optimizer.

Returns the optimization findings for an account.

For example, it returns the number of Amazon EC2 instances in an account that are under-provisioned, over-provisioned, or optimized. It also returns the number of Auto Scaling groups in an account that are not optimized, or optimized.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Compute Optimizer's API operation GetRecommendationSummaries for usage and error information.

Returned Error Types:

  • OptInRequiredException The account is not opted in to AWS Compute Optimizer.

  • InternalServerException An internal error has occurred. Try your call again.

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

  • AccessDeniedException You do not have sufficient access to perform this action.

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

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

  • ThrottlingException The request was denied due to request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/compute-optimizer-2019-11-01/GetRecommendationSummaries

func (*ComputeOptimizer) GetRecommendationSummariesRequest 

func (c *ComputeOptimizer) GetRecommendationSummariesRequest(input *GetRecommendationSummariesInput) (req *request.Request, output *GetRecommendationSummariesOutput)

GetRecommendationSummariesRequest generates a "aws/request.Request" representing the client's request for the GetRecommendationSummaries operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetRecommendationSummaries for more information on using the GetRecommendationSummaries API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetRecommendationSummariesRequest method.
req, resp := client.GetRecommendationSummariesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/compute-optimizer-2019-11-01/GetRecommendationSummaries

func (*ComputeOptimizer) GetRecommendationSummariesWithContext 

func (c *ComputeOptimizer) GetRecommendationSummariesWithContext(ctx aws.Context, input *GetRecommendationSummariesInput, opts ...request.Option) (*GetRecommendationSummariesOutput, error)

GetRecommendationSummariesWithContext is the same as GetRecommendationSummaries with the addition of the ability to pass a context and additional request options.

See GetRecommendationSummaries for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ComputeOptimizer) UpdateEnrollmentStatus 

func (c *ComputeOptimizer) UpdateEnrollmentStatus(input *UpdateEnrollmentStatusInput) (*UpdateEnrollmentStatusOutput, error)

UpdateEnrollmentStatus API operation for AWS Compute Optimizer.

Updates the enrollment (opt in) status of an account to the AWS Compute Optimizer service.

If the account is a master account of an organization, this action can also be used to enroll member accounts within the organization.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Compute Optimizer's API operation UpdateEnrollmentStatus for usage and error information.

Returned Error Types:

  • InternalServerException An internal error has occurred. Try your call again.

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

  • AccessDeniedException You do not have sufficient access to perform this action.

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

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

  • ThrottlingException The request was denied due to request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/compute-optimizer-2019-11-01/UpdateEnrollmentStatus

func (*ComputeOptimizer) UpdateEnrollmentStatusRequest 

func (c *ComputeOptimizer) UpdateEnrollmentStatusRequest(input *UpdateEnrollmentStatusInput) (req *request.Request, output *UpdateEnrollmentStatusOutput)

UpdateEnrollmentStatusRequest generates a "aws/request.Request" representing the client's request for the UpdateEnrollmentStatus operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateEnrollmentStatus for more information on using the UpdateEnrollmentStatus API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdateEnrollmentStatusRequest method.
req, resp := client.UpdateEnrollmentStatusRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/compute-optimizer-2019-11-01/UpdateEnrollmentStatus

func (*ComputeOptimizer) UpdateEnrollmentStatusWithContext 

func (c *ComputeOptimizer) UpdateEnrollmentStatusWithContext(ctx aws.Context, input *UpdateEnrollmentStatusInput, opts ...request.Option) (*UpdateEnrollmentStatusOutput, error)

UpdateEnrollmentStatusWithContext is the same as UpdateEnrollmentStatus with the addition of the ability to pass a context and additional request options.

See UpdateEnrollmentStatus for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type DescribeRecommendationExportJobsInput added in v1.31.15 

type DescribeRecommendationExportJobsInput struct {

	// An array of objects that describe a filter to return a more specific list
	// of export jobs.
	Filters []*JobFilter `locationName:"filters" type:"list"`

	// The identification numbers of the export jobs to return.
	//
	// An export job ID is returned when you create an export using the ExportAutoScalingGroupRecommendations
	// or ExportEC2InstanceRecommendations actions.
	//
	// All export jobs created in the last seven days are returned if this parameter
	// is omitted.
	JobIds []*string `locationName:"jobIds" type:"list"`

	// The maximum number of export jobs to return with a single request.
	//
	// To retrieve the remaining results, make another request with the returned
	// NextToken value.
	MaxResults *int64 `locationName:"maxResults" type:"integer"`

	// The token to advance to the next page of export jobs.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeRecommendationExportJobsInput) GoString added in v1.31.15 

func (s DescribeRecommendationExportJobsInput) GoString() string

GoString returns the string representation

func (*DescribeRecommendationExportJobsInput) SetFilters added in v1.31.15 

func (s *DescribeRecommendationExportJobsInput) SetFilters(v []*JobFilter) *DescribeRecommendationExportJobsInput

SetFilters sets the Filters field's value.

func (*DescribeRecommendationExportJobsInput) SetJobIds added in v1.31.15 

func (s *DescribeRecommendationExportJobsInput) SetJobIds(v []*string) *DescribeRecommendationExportJobsInput

SetJobIds sets the JobIds field's value.

func (*DescribeRecommendationExportJobsInput) SetMaxResults added in v1.31.15 

func (s *DescribeRecommendationExportJobsInput) SetMaxResults(v int64) *DescribeRecommendationExportJobsInput

SetMaxResults sets the MaxResults field's value.

func (*DescribeRecommendationExportJobsInput) SetNextToken added in v1.31.15 

func (s *DescribeRecommendationExportJobsInput) SetNextToken(v string) *DescribeRecommendationExportJobsInput

SetNextToken sets the NextToken field's value.

func (DescribeRecommendationExportJobsInput) String added in v1.31.15 

func (s DescribeRecommendationExportJobsInput) String() string

String returns the string representation

type DescribeRecommendationExportJobsOutput added in v1.31.15 

type DescribeRecommendationExportJobsOutput struct {

	// The token to use to advance to the next page of export jobs.
	//
	// This value is null when there are no more pages of export jobs to return.
	NextToken *string `locationName:"nextToken" type:"string"`

	// An array of objects that describe recommendation export jobs.
	RecommendationExportJobs []*RecommendationExportJob `locationName:"recommendationExportJobs" type:"list"`
	// contains filtered or unexported fields
}

func (DescribeRecommendationExportJobsOutput) GoString added in v1.31.15 

func (s DescribeRecommendationExportJobsOutput) GoString() string

GoString returns the string representation

func (*DescribeRecommendationExportJobsOutput) SetNextToken added in v1.31.15 

func (s *DescribeRecommendationExportJobsOutput) SetNextToken(v string) *DescribeRecommendationExportJobsOutput

SetNextToken sets the NextToken field's value.

func (*DescribeRecommendationExportJobsOutput) SetRecommendationExportJobs added in v1.31.15 

func (s *DescribeRecommendationExportJobsOutput) SetRecommendationExportJobs(v []*RecommendationExportJob) *DescribeRecommendationExportJobsOutput

SetRecommendationExportJobs sets the RecommendationExportJobs field's value.

func (DescribeRecommendationExportJobsOutput) String added in v1.31.15 

func (s DescribeRecommendationExportJobsOutput) String() string

String returns the string representation

type ExportAutoScalingGroupRecommendationsInput added in v1.31.15 

type ExportAutoScalingGroupRecommendationsInput struct {

	// The IDs of the AWS accounts for which to export Auto Scaling group recommendations.
	//
	// If your account is the master account of an organization, use this parameter
	// to specify the member accounts 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.
	AccountIds []*string `locationName:"accountIds" type:"list"`

	// The recommendations data to include in the export file.
	FieldsToExport []*string `locationName:"fieldsToExport" type:"list"`

	// The format of the export file.
	//
	// The only export file format currently supported is Csv.
	FileFormat *string `locationName:"fileFormat" type:"string" enum:"FileFormat"`

	// An array of objects that describe a filter to export a more specific set
	// of Auto Scaling group recommendations.
	Filters []*Filter `locationName:"filters" type:"list"`

	// Indicates whether to include recommendations for resources in all member
	// accounts of the organization if your account is the master account of an
	// organization.
	//
	// The member accounts must also be opted in to Compute Optimizer.
	//
	// 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.
	IncludeMemberAccounts *bool `locationName:"includeMemberAccounts" type:"boolean"`

	// An object to specify the destination Amazon Simple Storage Service (Amazon
	// S3) bucket name and key prefix for the 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.
	//
	// S3DestinationConfig is a required field
	S3DestinationConfig *S3DestinationConfig `locationName:"s3DestinationConfig" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (ExportAutoScalingGroupRecommendationsInput) GoString added in v1.31.15 

func (s ExportAutoScalingGroupRecommendationsInput) GoString() string

GoString returns the string representation

func (*ExportAutoScalingGroupRecommendationsInput) SetAccountIds added in v1.31.15 

func (s *ExportAutoScalingGroupRecommendationsInput) SetAccountIds(v []*string) *ExportAutoScalingGroupRecommendationsInput

SetAccountIds sets the AccountIds field's value.

func (*ExportAutoScalingGroupRecommendationsInput) SetFieldsToExport added in v1.31.15 

func (s *ExportAutoScalingGroupRecommendationsInput) SetFieldsToExport(v []*string) *ExportAutoScalingGroupRecommendationsInput

SetFieldsToExport sets the FieldsToExport field's value.

func (*ExportAutoScalingGroupRecommendationsInput) SetFileFormat added in v1.31.15 

func (s *ExportAutoScalingGroupRecommendationsInput) SetFileFormat(v string) *ExportAutoScalingGroupRecommendationsInput

SetFileFormat sets the FileFormat field's value.

func (*ExportAutoScalingGroupRecommendationsInput) SetFilters added in v1.31.15 

func (s *ExportAutoScalingGroupRecommendationsInput) SetFilters(v []*Filter) *ExportAutoScalingGroupRecommendationsInput

SetFilters sets the Filters field's value.

func (*ExportAutoScalingGroupRecommendationsInput) SetIncludeMemberAccounts added in v1.31.15 

func (s *ExportAutoScalingGroupRecommendationsInput) SetIncludeMemberAccounts(v bool) *ExportAutoScalingGroupRecommendationsInput

SetIncludeMemberAccounts sets the IncludeMemberAccounts field's value.

func (*ExportAutoScalingGroupRecommendationsInput) SetS3DestinationConfig added in v1.31.15 

func (s *ExportAutoScalingGroupRecommendationsInput) SetS3DestinationConfig(v *S3DestinationConfig) *ExportAutoScalingGroupRecommendationsInput

SetS3DestinationConfig sets the S3DestinationConfig field's value.

func (ExportAutoScalingGroupRecommendationsInput) String added in v1.31.15 

func (s ExportAutoScalingGroupRecommendationsInput) String() string

String returns the string representation

func (*ExportAutoScalingGroupRecommendationsInput) Validate added in v1.31.15 

func (s *ExportAutoScalingGroupRecommendationsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ExportAutoScalingGroupRecommendationsOutput added in v1.31.15 

type ExportAutoScalingGroupRecommendationsOutput struct {

	// The identification number of the export job.
	//
	// Use the DescribeRecommendationExportJobs action, and specify the job ID to
	// view the status of an export job.
	JobId *string `locationName:"jobId" type:"string"`

	// An object that describes the destination Amazon S3 bucket of a recommendations
	// export file.
	S3Destination *S3Destination `locationName:"s3Destination" type:"structure"`
	// contains filtered or unexported fields
}

func (ExportAutoScalingGroupRecommendationsOutput) GoString added in v1.31.15 

func (s ExportAutoScalingGroupRecommendationsOutput) GoString() string

GoString returns the string representation

func (*ExportAutoScalingGroupRecommendationsOutput) SetJobId added in v1.31.15 

func (s *ExportAutoScalingGroupRecommendationsOutput) SetJobId(v string) *ExportAutoScalingGroupRecommendationsOutput

SetJobId sets the JobId field's value.

func (*ExportAutoScalingGroupRecommendationsOutput) SetS3Destination added in v1.31.15 

func (s *ExportAutoScalingGroupRecommendationsOutput) SetS3Destination(v *S3Destination) *ExportAutoScalingGroupRecommendationsOutput

SetS3Destination sets the S3Destination field's value.

func (ExportAutoScalingGroupRecommendationsOutput) String added in v1.31.15 

func (s ExportAutoScalingGroupRecommendationsOutput) String() string

String returns the string representation

type ExportDestination added in v1.31.15 

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 `locationName:"s3" type:"structure"`
	// contains filtered or unexported fields
}

Describes the destination of the recommendations export and metadata files.

func (ExportDestination) GoString added in v1.31.15 

func (s ExportDestination) GoString() string

GoString returns the string representation

func (*ExportDestination) SetS3 added in v1.31.15 

func (s *ExportDestination) SetS3(v *S3Destination) *ExportDestination

SetS3 sets the S3 field's value.

func (ExportDestination) String added in v1.31.15 

func (s ExportDestination) String() string

String returns the string representation

type ExportEC2InstanceRecommendationsInput added in v1.31.15 

type ExportEC2InstanceRecommendationsInput struct {

	// The IDs of the AWS accounts for which to export instance recommendations.
	//
	// If your account is the master account of an organization, use this parameter
	// to specify the member accounts 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.
	AccountIds []*string `locationName:"accountIds" type:"list"`

	// The recommendations data to include in the export file.
	FieldsToExport []*string `locationName:"fieldsToExport" type:"list"`

	// The format of the export file.
	//
	// The only export file format currently supported is Csv.
	FileFormat *string `locationName:"fileFormat" type:"string" enum:"FileFormat"`

	// An array of objects that describe a filter to export a more specific set
	// of instance recommendations.
	Filters []*Filter `locationName:"filters" type:"list"`

	// Indicates whether to include recommendations for resources in all member
	// accounts of the organization if your account is the master account of an
	// organization.
	//
	// The member accounts must also be opted in to Compute Optimizer.
	//
	// Recommendations for member accounts of the organization are not included
	// in the export file if this parameter is omitted.
	//
	// Recommendations for member accounts are not included in the export if this
	// parameter, or the account IDs parameter, is omitted.
	IncludeMemberAccounts *bool `locationName:"includeMemberAccounts" type:"boolean"`

	// An object to specify the destination Amazon Simple Storage Service (Amazon
	// S3) bucket name and key prefix for the 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.
	//
	// S3DestinationConfig is a required field
	S3DestinationConfig *S3DestinationConfig `locationName:"s3DestinationConfig" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (ExportEC2InstanceRecommendationsInput) GoString added in v1.31.15 

func (s ExportEC2InstanceRecommendationsInput) GoString() string

GoString returns the string representation

func (*ExportEC2InstanceRecommendationsInput) SetAccountIds added in v1.31.15 

func (s *ExportEC2InstanceRecommendationsInput) SetAccountIds(v []*string) *ExportEC2InstanceRecommendationsInput

SetAccountIds sets the AccountIds field's value.

func (*ExportEC2InstanceRecommendationsInput) SetFieldsToExport added in v1.31.15 

func (s *ExportEC2InstanceRecommendationsInput) SetFieldsToExport(v []*string) *ExportEC2InstanceRecommendationsInput

SetFieldsToExport sets the FieldsToExport field's value.

func (*ExportEC2InstanceRecommendationsInput) SetFileFormat added in v1.31.15 

func (s *ExportEC2InstanceRecommendationsInput) SetFileFormat(v string) *ExportEC2InstanceRecommendationsInput

SetFileFormat sets the FileFormat field's value.

func (*ExportEC2InstanceRecommendationsInput) SetFilters added in v1.31.15 

func (s *ExportEC2InstanceRecommendationsInput) SetFilters(v []*Filter) *ExportEC2InstanceRecommendationsInput

SetFilters sets the Filters field's value.

func (*ExportEC2InstanceRecommendationsInput) SetIncludeMemberAccounts added in v1.31.15 

func (s *ExportEC2InstanceRecommendationsInput) SetIncludeMemberAccounts(v bool) *ExportEC2InstanceRecommendationsInput

SetIncludeMemberAccounts sets the IncludeMemberAccounts field's value.

func (*ExportEC2InstanceRecommendationsInput) SetS3DestinationConfig added in v1.31.15 

func (s *ExportEC2InstanceRecommendationsInput) SetS3DestinationConfig(v *S3DestinationConfig) *ExportEC2InstanceRecommendationsInput

SetS3DestinationConfig sets the S3DestinationConfig field's value.

func (ExportEC2InstanceRecommendationsInput) String added in v1.31.15 

func (s ExportEC2InstanceRecommendationsInput) String() string

String returns the string representation

func (*ExportEC2InstanceRecommendationsInput) Validate added in v1.31.15 

func (s *ExportEC2InstanceRecommendationsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ExportEC2InstanceRecommendationsOutput added in v1.31.15 

type ExportEC2InstanceRecommendationsOutput struct {

	// The identification number of the export job.
	//
	// Use the DescribeRecommendationExportJobs action, and specify the job ID to
	// view the status of an export job.
	JobId *string `locationName:"jobId" type:"string"`

	// An object that describes the destination Amazon S3 bucket of a recommendations
	// export file.
	S3Destination *S3Destination `locationName:"s3Destination" type:"structure"`
	// contains filtered or unexported fields
}

func (ExportEC2InstanceRecommendationsOutput) GoString added in v1.31.15 

func (s ExportEC2InstanceRecommendationsOutput) GoString() string

GoString returns the string representation

func (*ExportEC2InstanceRecommendationsOutput) SetJobId added in v1.31.15 

func (s *ExportEC2InstanceRecommendationsOutput) SetJobId(v string) *ExportEC2InstanceRecommendationsOutput

SetJobId sets the JobId field's value.

func (*ExportEC2InstanceRecommendationsOutput) SetS3Destination added in v1.31.15 

func (s *ExportEC2InstanceRecommendationsOutput) SetS3Destination(v *S3Destination) *ExportEC2InstanceRecommendationsOutput

SetS3Destination sets the S3Destination field's value.

func (ExportEC2InstanceRecommendationsOutput) String added in v1.31.15 

func (s ExportEC2InstanceRecommendationsOutput) String() string

String returns the string representation

type Filter 

type Filter struct {

	// The name of the filter.
	//
	// Specify Finding to return recommendations with a specific findings classification
	// (e.g., Overprovisioned).
	//
	// Specify RecommendationSourceType to return recommendations of a specific
	// resource type (e.g., AutoScalingGroup).
	Name *string `locationName:"name" type:"string" enum:"FilterName"`

	// The value of the filter.
	//
	// If you specify the name parameter as Finding, and you request recommendations
	// for an instance, then the valid values are Underprovisioned, Overprovisioned,
	// NotOptimized, or Optimized.
	//
	// If you specify the name parameter as Finding, and you request recommendations
	// for an Auto Scaling group, then the valid values are Optimized, or NotOptimized.
	//
	// If you specify the name parameter as RecommendationSourceType, then the valid
	// values are Ec2Instance, or AutoScalingGroup.
	Values []*string `locationName:"values" type:"list"`
	// contains filtered or unexported fields
}

Describes a filter that returns a more specific list of recommendations.

func (Filter) GoString 

func (s Filter) GoString() string

GoString returns the string representation

func (*Filter) SetName 

func (s *Filter) SetName(v string) *Filter

SetName sets the Name field's value.

func (*Filter) SetValues 

func (s *Filter) SetValues(v []*string) *Filter

SetValues sets the Values field's value.

func (Filter) String 

func (s Filter) String() string

String returns the string representation

type GetAutoScalingGroupRecommendationsInput 

type GetAutoScalingGroupRecommendationsInput struct {

	// The IDs of the AWS accounts for which to return Auto Scaling group recommendations.
	//
	// If your account is the master account of an organization, use this parameter
	// to specify the member accounts for which you want to return Auto Scaling
	// group recommendations.
	//
	// Only one account ID can be specified per request.
	AccountIds []*string `locationName:"accountIds" type:"list"`

	// The Amazon Resource Name (ARN) of the Auto Scaling groups for which to return
	// recommendations.
	AutoScalingGroupArns []*string `locationName:"autoScalingGroupArns" type:"list"`

	// An array of objects that describe a filter that returns a more specific list
	// of Auto Scaling group recommendations.
	Filters []*Filter `locationName:"filters" type:"list"`

	// The maximum number of Auto Scaling group recommendations to return with a
	// single request.
	//
	// To retrieve the remaining results, make another request with the returned
	// NextToken value.
	MaxResults *int64 `locationName:"maxResults" type:"integer"`

	// The token to advance to the next page of Auto Scaling group recommendations.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (GetAutoScalingGroupRecommendationsInput) GoString 

func (s GetAutoScalingGroupRecommendationsInput) GoString() string

GoString returns the string representation

func (*GetAutoScalingGroupRecommendationsInput) SetAccountIds 

func (s *GetAutoScalingGroupRecommendationsInput) SetAccountIds(v []*string) *GetAutoScalingGroupRecommendationsInput

SetAccountIds sets the AccountIds field's value.

func (*GetAutoScalingGroupRecommendationsInput) SetAutoScalingGroupArns 

func (s *GetAutoScalingGroupRecommendationsInput) SetAutoScalingGroupArns(v []*string) *GetAutoScalingGroupRecommendationsInput

SetAutoScalingGroupArns sets the AutoScalingGroupArns field's value.

func (*GetAutoScalingGroupRecommendationsInput) SetFilters 

func (s *GetAutoScalingGroupRecommendationsInput) SetFilters(v []*Filter) *GetAutoScalingGroupRecommendationsInput

SetFilters sets the Filters field's value.

func (*GetAutoScalingGroupRecommendationsInput) SetMaxResults 

func (s *GetAutoScalingGroupRecommendationsInput) SetMaxResults(v int64) *GetAutoScalingGroupRecommendationsInput

SetMaxResults sets the MaxResults field's value.

func (*GetAutoScalingGroupRecommendationsInput) SetNextToken 

func (s *GetAutoScalingGroupRecommendationsInput) SetNextToken(v string) *GetAutoScalingGroupRecommendationsInput

SetNextToken sets the NextToken field's value.

func (GetAutoScalingGroupRecommendationsInput) String 

func (s GetAutoScalingGroupRecommendationsInput) String() string

String returns the string representation

type GetAutoScalingGroupRecommendationsOutput 

type GetAutoScalingGroupRecommendationsOutput struct {

	// An array of objects that describe Auto Scaling group recommendations.
	AutoScalingGroupRecommendations []*AutoScalingGroupRecommendation `locationName:"autoScalingGroupRecommendations" type:"list"`

	// An array of objects that describe errors of the request.
	//
	// For example, an error is returned if you request recommendations for an unsupported
	// Auto Scaling group.
	Errors []*GetRecommendationError `locationName:"errors" type:"list"`

	// The token to use to advance to the next page of Auto Scaling group recommendations.
	//
	// This value is null when there are no more pages of Auto Scaling group recommendations
	// to return.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (GetAutoScalingGroupRecommendationsOutput) GoString 

func (s GetAutoScalingGroupRecommendationsOutput) GoString() string

GoString returns the string representation

func (*GetAutoScalingGroupRecommendationsOutput) SetAutoScalingGroupRecommendations 

func (s *GetAutoScalingGroupRecommendationsOutput) SetAutoScalingGroupRecommendations(v []*AutoScalingGroupRecommendation) *GetAutoScalingGroupRecommendationsOutput

SetAutoScalingGroupRecommendations sets the AutoScalingGroupRecommendations field's value.

func (*GetAutoScalingGroupRecommendationsOutput) SetErrors 

func (s *GetAutoScalingGroupRecommendationsOutput) SetErrors(v []*GetRecommendationError) *GetAutoScalingGroupRecommendationsOutput

SetErrors sets the Errors field's value.

func (*GetAutoScalingGroupRecommendationsOutput) SetNextToken 

func (s *GetAutoScalingGroupRecommendationsOutput) SetNextToken(v string) *GetAutoScalingGroupRecommendationsOutput

SetNextToken sets the NextToken field's value.

func (GetAutoScalingGroupRecommendationsOutput) String 

func (s GetAutoScalingGroupRecommendationsOutput) String() string

String returns the string representation

type GetEC2InstanceRecommendationsInput 

type GetEC2InstanceRecommendationsInput struct {

	// The IDs of the AWS accounts for which to return instance recommendations.
	//
	// If your account is the master account of an organization, use this parameter
	// to specify the member accounts for which you want to return instance recommendations.
	//
	// Only one account ID can be specified per request.
	AccountIds []*string `locationName:"accountIds" type:"list"`

	// An array of objects that describe a filter that returns a more specific list
	// of instance recommendations.
	Filters []*Filter `locationName:"filters" type:"list"`

	// The Amazon Resource Name (ARN) of the instances for which to return recommendations.
	InstanceArns []*string `locationName:"instanceArns" type:"list"`

	// The maximum number of instance recommendations to return with a single request.
	//
	// To retrieve the remaining results, make another request with the returned
	// NextToken value.
	MaxResults *int64 `locationName:"maxResults" type:"integer"`

	// The token to advance to the next page of instance recommendations.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (GetEC2InstanceRecommendationsInput) GoString 

func (s GetEC2InstanceRecommendationsInput) GoString() string

GoString returns the string representation

func (*GetEC2InstanceRecommendationsInput) SetAccountIds 

func (s *GetEC2InstanceRecommendationsInput) SetAccountIds(v []*string) *GetEC2InstanceRecommendationsInput

SetAccountIds sets the AccountIds field's value.

func (*GetEC2InstanceRecommendationsInput) SetFilters 

func (s *GetEC2InstanceRecommendationsInput) SetFilters(v []*Filter) *GetEC2InstanceRecommendationsInput

SetFilters sets the Filters field's value.

func (*GetEC2InstanceRecommendationsInput) SetInstanceArns 

func (s *GetEC2InstanceRecommendationsInput) SetInstanceArns(v []*string) *GetEC2InstanceRecommendationsInput

SetInstanceArns sets the InstanceArns field's value.

func (*GetEC2InstanceRecommendationsInput) SetMaxResults 

func (s *GetEC2InstanceRecommendationsInput) SetMaxResults(v int64) *GetEC2InstanceRecommendationsInput

SetMaxResults sets the MaxResults field's value.

func (*GetEC2InstanceRecommendationsInput) SetNextToken 

func (s *GetEC2InstanceRecommendationsInput) SetNextToken(v string) *GetEC2InstanceRecommendationsInput

SetNextToken sets the NextToken field's value.

func (GetEC2InstanceRecommendationsInput) String 

func (s GetEC2InstanceRecommendationsInput) String() string

String returns the string representation

type GetEC2InstanceRecommendationsOutput 

type GetEC2InstanceRecommendationsOutput struct {

	// An array of objects that describe errors of the request.
	//
	// For example, an error is returned if you request recommendations for an instance
	// of an unsupported instance family.
	Errors []*GetRecommendationError `locationName:"errors" type:"list"`

	// An array of objects that describe instance recommendations.
	InstanceRecommendations []*InstanceRecommendation `locationName:"instanceRecommendations" type:"list"`

	// The token to use to advance to the next page of instance recommendations.
	//
	// This value is null when there are no more pages of instance recommendations
	// to return.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (GetEC2InstanceRecommendationsOutput) GoString 

func (s GetEC2InstanceRecommendationsOutput) GoString() string

GoString returns the string representation

func (*GetEC2InstanceRecommendationsOutput) SetErrors 

func (s *GetEC2InstanceRecommendationsOutput) SetErrors(v []*GetRecommendationError) *GetEC2InstanceRecommendationsOutput

SetErrors sets the Errors field's value.

func (*GetEC2InstanceRecommendationsOutput) SetInstanceRecommendations 

func (s *GetEC2InstanceRecommendationsOutput) SetInstanceRecommendations(v []*InstanceRecommendation) *GetEC2InstanceRecommendationsOutput

SetInstanceRecommendations sets the InstanceRecommendations field's value.

func (*GetEC2InstanceRecommendationsOutput) SetNextToken 

func (s *GetEC2InstanceRecommendationsOutput) SetNextToken(v string) *GetEC2InstanceRecommendationsOutput

SetNextToken sets the NextToken field's value.

func (GetEC2InstanceRecommendationsOutput) String 

func (s GetEC2InstanceRecommendationsOutput) String() string

String returns the string representation

type GetEC2RecommendationProjectedMetricsInput 

type GetEC2RecommendationProjectedMetricsInput struct {

	// The time stamp of the last projected metrics data point to return.
	//
	// EndTime is a required field
	EndTime *time.Time `locationName:"endTime" type:"timestamp" required:"true"`

	// The Amazon Resource Name (ARN) of the instances for which to return recommendation
	// projected metrics.
	//
	// InstanceArn is a required field
	InstanceArn *string `locationName:"instanceArn" type:"string" required:"true"`

	// The granularity, in seconds, of the projected metrics data points.
	//
	// Period is a required field
	Period *int64 `locationName:"period" type:"integer" required:"true"`

	// The time stamp of the first projected metrics data point to return.
	//
	// StartTime is a required field
	StartTime *time.Time `locationName:"startTime" type:"timestamp" required:"true"`

	// The statistic of the projected metrics.
	//
	// Stat is a required field
	Stat *string `locationName:"stat" type:"string" required:"true" enum:"MetricStatistic"`
	// contains filtered or unexported fields
}

func (GetEC2RecommendationProjectedMetricsInput) GoString 

func (s GetEC2RecommendationProjectedMetricsInput) GoString() string

GoString returns the string representation

func (*GetEC2RecommendationProjectedMetricsInput) SetEndTime 

func (s *GetEC2RecommendationProjectedMetricsInput) SetEndTime(v time.Time) *GetEC2RecommendationProjectedMetricsInput

SetEndTime sets the EndTime field's value.

func (*GetEC2RecommendationProjectedMetricsInput) SetInstanceArn 

func (s *GetEC2RecommendationProjectedMetricsInput) SetInstanceArn(v string) *GetEC2RecommendationProjectedMetricsInput

SetInstanceArn sets the InstanceArn field's value.

func (*GetEC2RecommendationProjectedMetricsInput) SetPeriod 

func (s *GetEC2RecommendationProjectedMetricsInput) SetPeriod(v int64) *GetEC2RecommendationProjectedMetricsInput

SetPeriod sets the Period field's value.

func (*GetEC2RecommendationProjectedMetricsInput) SetStartTime 

func (s *GetEC2RecommendationProjectedMetricsInput) SetStartTime(v time.Time) *GetEC2RecommendationProjectedMetricsInput

SetStartTime sets the StartTime field's value.

func (*GetEC2RecommendationProjectedMetricsInput) SetStat 

func (s *GetEC2RecommendationProjectedMetricsInput) SetStat(v string) *GetEC2RecommendationProjectedMetricsInput

SetStat sets the Stat field's value.

func (GetEC2RecommendationProjectedMetricsInput) String 

func (s GetEC2RecommendationProjectedMetricsInput) String() string

String returns the string representation

func (*GetEC2RecommendationProjectedMetricsInput) Validate 

func (s *GetEC2RecommendationProjectedMetricsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetEC2RecommendationProjectedMetricsOutput 

type GetEC2RecommendationProjectedMetricsOutput struct {

	// An array of objects that describe a projected metrics.
	RecommendedOptionProjectedMetrics []*RecommendedOptionProjectedMetric `locationName:"recommendedOptionProjectedMetrics" type:"list"`
	// contains filtered or unexported fields
}

func (GetEC2RecommendationProjectedMetricsOutput) GoString 

func (s GetEC2RecommendationProjectedMetricsOutput) GoString() string

GoString returns the string representation

func (*GetEC2RecommendationProjectedMetricsOutput) SetRecommendedOptionProjectedMetrics 

func (s *GetEC2RecommendationProjectedMetricsOutput) SetRecommendedOptionProjectedMetrics(v []*RecommendedOptionProjectedMetric) *GetEC2RecommendationProjectedMetricsOutput

SetRecommendedOptionProjectedMetrics sets the RecommendedOptionProjectedMetrics field's value.

func (GetEC2RecommendationProjectedMetricsOutput) String 

func (s GetEC2RecommendationProjectedMetricsOutput) String() string

String returns the string representation

type GetEnrollmentStatusInput 

type GetEnrollmentStatusInput struct {
	// contains filtered or unexported fields
}

func (GetEnrollmentStatusInput) GoString 

func (s GetEnrollmentStatusInput) GoString() string

GoString returns the string representation

func (GetEnrollmentStatusInput) String 

func (s GetEnrollmentStatusInput) String() string

String returns the string representation

type GetEnrollmentStatusOutput 

type GetEnrollmentStatusOutput struct {

	// Confirms the enrollment status of member accounts within the organization,
	// if the account is a master account of an organization.
	MemberAccountsEnrolled *bool `locationName:"memberAccountsEnrolled" type:"boolean"`

	// The enrollment status of the account.
	Status *string `locationName:"status" type:"string" enum:"Status"`

	// The reason for the enrollment status of the account.
	//
	// For example, an account might show a status of Pending because member accounts
	// of an organization require more time to be enrolled in the service.
	StatusReason *string `locationName:"statusReason" type:"string"`
	// contains filtered or unexported fields
}

func (GetEnrollmentStatusOutput) GoString 

func (s GetEnrollmentStatusOutput) GoString() string

GoString returns the string representation

func (*GetEnrollmentStatusOutput) SetMemberAccountsEnrolled 

func (s *GetEnrollmentStatusOutput) SetMemberAccountsEnrolled(v bool) *GetEnrollmentStatusOutput

SetMemberAccountsEnrolled sets the MemberAccountsEnrolled field's value.

func (*GetEnrollmentStatusOutput) SetStatus 

func (s *GetEnrollmentStatusOutput) SetStatus(v string) *GetEnrollmentStatusOutput

SetStatus sets the Status field's value.

func (*GetEnrollmentStatusOutput) SetStatusReason 

func (s *GetEnrollmentStatusOutput) SetStatusReason(v string) *GetEnrollmentStatusOutput

SetStatusReason sets the StatusReason field's value.

func (GetEnrollmentStatusOutput) String 

func (s GetEnrollmentStatusOutput) String() string

String returns the string representation

type GetRecommendationError 

type GetRecommendationError struct {

	// The error code.
	Code *string `locationName:"code" type:"string"`

	// The ID of the error.
	Identifier *string `locationName:"identifier" type:"string"`

	// The message, or reason, for the error.
	Message *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

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.

func (GetRecommendationError) GoString 

func (s GetRecommendationError) GoString() string

GoString returns the string representation

func (*GetRecommendationError) SetCode 

func (s *GetRecommendationError) SetCode(v string) *GetRecommendationError

SetCode sets the Code field's value.

func (*GetRecommendationError) SetIdentifier 

func (s *GetRecommendationError) SetIdentifier(v string) *GetRecommendationError

SetIdentifier sets the Identifier field's value.

func (*GetRecommendationError) SetMessage 

func (s *GetRecommendationError) SetMessage(v string) *GetRecommendationError

SetMessage sets the Message field's value.

func (GetRecommendationError) String 

func (s GetRecommendationError) String() string

String returns the string representation

type GetRecommendationSummariesInput 

type GetRecommendationSummariesInput struct {

	// The IDs of the AWS accounts for which to return recommendation summaries.
	//
	// If your account is the master account of an organization, use this parameter
	// to specify the member accounts for which you want to return recommendation
	// summaries.
	//
	// Only one account ID can be specified per request.
	AccountIds []*string `locationName:"accountIds" type:"list"`

	// The maximum number of recommendation summaries to return with a single request.
	//
	// To retrieve the remaining results, make another request with the returned
	// NextToken value.
	MaxResults *int64 `locationName:"maxResults" type:"integer"`

	// The token to advance to the next page of recommendation summaries.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (GetRecommendationSummariesInput) GoString 

func (s GetRecommendationSummariesInput) GoString() string

GoString returns the string representation

func (*GetRecommendationSummariesInput) SetAccountIds 

func (s *GetRecommendationSummariesInput) SetAccountIds(v []*string) *GetRecommendationSummariesInput

SetAccountIds sets the AccountIds field's value.

func (*GetRecommendationSummariesInput) SetMaxResults 

func (s *GetRecommendationSummariesInput) SetMaxResults(v int64) *GetRecommendationSummariesInput

SetMaxResults sets the MaxResults field's value.

func (*GetRecommendationSummariesInput) SetNextToken 

func (s *GetRecommendationSummariesInput) SetNextToken(v string) *GetRecommendationSummariesInput

SetNextToken sets the NextToken field's value.

func (GetRecommendationSummariesInput) String 

func (s GetRecommendationSummariesInput) String() string

String returns the string representation

type GetRecommendationSummariesOutput 

type GetRecommendationSummariesOutput struct {

	// The token to use to advance to the next page of recommendation summaries.
	//
	// This value is null when there are no more pages of recommendation summaries
	// to return.
	NextToken *string `locationName:"nextToken" type:"string"`

	// An array of objects that summarize a recommendation.
	RecommendationSummaries []*RecommendationSummary `locationName:"recommendationSummaries" type:"list"`
	// contains filtered or unexported fields
}

func (GetRecommendationSummariesOutput) GoString 

func (s GetRecommendationSummariesOutput) GoString() string

GoString returns the string representation

func (*GetRecommendationSummariesOutput) SetNextToken 

func (s *GetRecommendationSummariesOutput) SetNextToken(v string) *GetRecommendationSummariesOutput

SetNextToken sets the NextToken field's value.

func (*GetRecommendationSummariesOutput) SetRecommendationSummaries 

func (s *GetRecommendationSummariesOutput) SetRecommendationSummaries(v []*RecommendationSummary) *GetRecommendationSummariesOutput

SetRecommendationSummaries sets the RecommendationSummaries field's value.

func (GetRecommendationSummariesOutput) String 

func (s GetRecommendationSummariesOutput) String() string

String returns the string representation

type InstanceRecommendation 

type InstanceRecommendation struct {

	// The AWS account ID of the instance.
	AccountId *string `locationName:"accountId" type:"string"`

	// The instance type of the current instance.
	CurrentInstanceType *string `locationName:"currentInstanceType" type:"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.
	//
	// The values that are returned might be UNDER_PROVISIONED, OVER_PROVISIONED,
	// or OPTIMIZED.
	Finding *string `locationName:"finding" type:"string" enum:"Finding"`

	// The Amazon Resource Name (ARN) of the current instance.
	InstanceArn *string `locationName:"instanceArn" type:"string"`

	// The name of the current instance.
	InstanceName *string `locationName:"instanceName" type:"string"`

	// The time stamp of when the instance recommendation was last refreshed.
	LastRefreshTimestamp *time.Time `locationName:"lastRefreshTimestamp" type:"timestamp"`

	// The number of days for which utilization metrics were analyzed for the instance.
	LookBackPeriodInDays *float64 `locationName:"lookBackPeriodInDays" type:"double"`

	// An array of objects that describe the recommendation options for the instance.
	RecommendationOptions []*InstanceRecommendationOption `locationName:"recommendationOptions" type:"list"`

	// An array of objects that describe the source resource of the recommendation.
	RecommendationSources []*RecommendationSource `locationName:"recommendationSources" type:"list"`

	// An array of objects that describe the utilization metrics of the instance.
	UtilizationMetrics []*UtilizationMetric `locationName:"utilizationMetrics" type:"list"`
	// contains filtered or unexported fields
}

Describes an Amazon EC2 instance recommendation.

func (InstanceRecommendation) GoString 

func (s InstanceRecommendation) GoString() string

GoString returns the string representation

func (*InstanceRecommendation) SetAccountId 

func (s *InstanceRecommendation) SetAccountId(v string) *InstanceRecommendation

SetAccountId sets the AccountId field's value.

func (*InstanceRecommendation) SetCurrentInstanceType 

func (s *InstanceRecommendation) SetCurrentInstanceType(v string) *InstanceRecommendation

SetCurrentInstanceType sets the CurrentInstanceType field's value.

func (*InstanceRecommendation) SetFinding 

func (s *InstanceRecommendation) SetFinding(v string) *InstanceRecommendation

SetFinding sets the Finding field's value.

func (*InstanceRecommendation) SetInstanceArn 

func (s *InstanceRecommendation) SetInstanceArn(v string) *InstanceRecommendation

SetInstanceArn sets the InstanceArn field's value.

func (*InstanceRecommendation) SetInstanceName 

func (s *InstanceRecommendation) SetInstanceName(v string) *InstanceRecommendation

SetInstanceName sets the InstanceName field's value.

func (*InstanceRecommendation) SetLastRefreshTimestamp 

func (s *InstanceRecommendation) SetLastRefreshTimestamp(v time.Time) *InstanceRecommendation

SetLastRefreshTimestamp sets the LastRefreshTimestamp field's value.

func (*InstanceRecommendation) SetLookBackPeriodInDays 

func (s *InstanceRecommendation) SetLookBackPeriodInDays(v float64) *InstanceRecommendation

SetLookBackPeriodInDays sets the LookBackPeriodInDays field's value.

func (*InstanceRecommendation) SetRecommendationOptions 

func (s *InstanceRecommendation) SetRecommendationOptions(v []*InstanceRecommendationOption) *InstanceRecommendation

SetRecommendationOptions sets the RecommendationOptions field's value.

func (*InstanceRecommendation) SetRecommendationSources 

func (s *InstanceRecommendation) SetRecommendationSources(v []*RecommendationSource) *InstanceRecommendation

SetRecommendationSources sets the RecommendationSources field's value.

func (*InstanceRecommendation) SetUtilizationMetrics 

func (s *InstanceRecommendation) SetUtilizationMetrics(v []*UtilizationMetric) *InstanceRecommendation

SetUtilizationMetrics sets the UtilizationMetrics field's value.

func (InstanceRecommendation) String 

func (s InstanceRecommendation) String() string

String returns the string representation

type InstanceRecommendationOption 

type InstanceRecommendationOption struct {

	// The instance type of the instance recommendation.
	InstanceType *string `locationName:"instanceType" type:"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 `locationName:"performanceRisk" type:"double"`

	// An array of objects that describe the projected utilization metrics of the
	// instance recommendation option.
	ProjectedUtilizationMetrics []*UtilizationMetric `locationName:"projectedUtilizationMetrics" type:"list"`

	// The rank of the instance recommendation option.
	//
	// The top recommendation option is ranked as 1.
	Rank *int64 `locationName:"rank" type:"integer"`
	// contains filtered or unexported fields
}

Describes a recommendation option for an Amazon EC2 instance.

func (InstanceRecommendationOption) GoString 

func (s InstanceRecommendationOption) GoString() string

GoString returns the string representation

func (*InstanceRecommendationOption) SetInstanceType 

func (s *InstanceRecommendationOption) SetInstanceType(v string) *InstanceRecommendationOption

SetInstanceType sets the InstanceType field's value.

func (*InstanceRecommendationOption) SetPerformanceRisk 

func (s *InstanceRecommendationOption) SetPerformanceRisk(v float64) *InstanceRecommendationOption

SetPerformanceRisk sets the PerformanceRisk field's value.

func (*InstanceRecommendationOption) SetProjectedUtilizationMetrics 

func (s *InstanceRecommendationOption) SetProjectedUtilizationMetrics(v []*UtilizationMetric) *InstanceRecommendationOption

SetProjectedUtilizationMetrics sets the ProjectedUtilizationMetrics field's value.

func (*InstanceRecommendationOption) SetRank 

func (s *InstanceRecommendationOption) SetRank(v int64) *InstanceRecommendationOption

SetRank sets the Rank field's value.

func (InstanceRecommendationOption) String 

func (s InstanceRecommendationOption) String() string

String returns the string representation

type InternalServerException added in v1.28.0 

type InternalServerException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

An internal error has occurred. Try your call again.

func (*InternalServerException) Code added in v1.28.0 

func (s *InternalServerException) Code() string

Code returns the exception type name.

func (*InternalServerException) Error added in v1.28.0 

func (s *InternalServerException) Error() string

func (InternalServerException) GoString added in v1.28.0 

func (s InternalServerException) GoString() string

GoString returns the string representation

func (*InternalServerException) Message added in v1.28.0 

func (s *InternalServerException) Message() string

Message returns the exception's message.

func (*InternalServerException) OrigErr added in v1.28.0 

func (s *InternalServerException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalServerException) RequestID added in v1.28.0 

func (s *InternalServerException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalServerException) StatusCode added in v1.28.0 

func (s *InternalServerException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InternalServerException) String added in v1.28.0 

func (s InternalServerException) String() string

String returns the string representation

type InvalidParameterValueException added in v1.28.0 

type InvalidParameterValueException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

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

func (*InvalidParameterValueException) Code added in v1.28.0 

func (s *InvalidParameterValueException) Code() string

Code returns the exception type name.

func (*InvalidParameterValueException) Error added in v1.28.0 

func (s *InvalidParameterValueException) Error() string

func (InvalidParameterValueException) GoString added in v1.28.0 

func (s InvalidParameterValueException) GoString() string

GoString returns the string representation

func (*InvalidParameterValueException) Message added in v1.28.0 

func (s *InvalidParameterValueException) Message() string

Message returns the exception's message.

func (*InvalidParameterValueException) OrigErr added in v1.28.0 

func (s *InvalidParameterValueException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidParameterValueException) RequestID added in v1.28.0 

func (s *InvalidParameterValueException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidParameterValueException) StatusCode added in v1.28.0 

func (s *InvalidParameterValueException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidParameterValueException) String added in v1.28.0 

func (s InvalidParameterValueException) String() string

String returns the string representation

type JobFilter added in v1.31.15 

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 *string `locationName:"name" type:"string" enum:"JobFilterName"`

	// The value of the filter.
	//
	// If you specify the name parameter as ResourceType, the valid values are Ec2Instance
	// or AutoScalingGroup.
	//
	// If you specify the name parameter as JobStatus, the valid values are Queued,
	// InProgress, Complete, or Failed.
	Values []*string `locationName:"values" type:"list"`
	// contains filtered or unexported fields
}

Describes a filter that returns a more specific list of recommendation export jobs.

This filter is used with the DescribeRecommendationExportJobs action.

func (JobFilter) GoString added in v1.31.15 

func (s JobFilter) GoString() string

GoString returns the string representation

func (*JobFilter) SetName added in v1.31.15 

func (s *JobFilter) SetName(v string) *JobFilter

SetName sets the Name field's value.

func (*JobFilter) SetValues added in v1.31.15 

func (s *JobFilter) SetValues(v []*string) *JobFilter

SetValues sets the Values field's value.

func (JobFilter) String added in v1.31.15 

func (s JobFilter) String() string

String returns the string representation

type LimitExceededException added in v1.31.15 

type LimitExceededException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The request exceeds a limit of the service.

func (*LimitExceededException) Code added in v1.31.15 

func (s *LimitExceededException) Code() string

Code returns the exception type name.

func (*LimitExceededException) Error added in v1.31.15 

func (s *LimitExceededException) Error() string

func (LimitExceededException) GoString added in v1.31.15 

func (s LimitExceededException) GoString() string

GoString returns the string representation

func (*LimitExceededException) Message added in v1.31.15 

func (s *LimitExceededException) Message() string

Message returns the exception's message.

func (*LimitExceededException) OrigErr added in v1.31.15 

func (s *LimitExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*LimitExceededException) RequestID added in v1.31.15 

func (s *LimitExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*LimitExceededException) StatusCode added in v1.31.15 

func (s *LimitExceededException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (LimitExceededException) String added in v1.31.15 

func (s LimitExceededException) String() string

String returns the string representation

type MissingAuthenticationToken added in v1.28.0 

type MissingAuthenticationToken struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

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

func (*MissingAuthenticationToken) Code added in v1.28.0 

func (s *MissingAuthenticationToken) Code() string

Code returns the exception type name.

func (*MissingAuthenticationToken) Error added in v1.28.0 

func (s *MissingAuthenticationToken) Error() string

func (MissingAuthenticationToken) GoString added in v1.28.0 

func (s MissingAuthenticationToken) GoString() string

GoString returns the string representation

func (*MissingAuthenticationToken) Message added in v1.28.0 

func (s *MissingAuthenticationToken) Message() string

Message returns the exception's message.

func (*MissingAuthenticationToken) OrigErr added in v1.28.0 

func (s *MissingAuthenticationToken) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*MissingAuthenticationToken) RequestID added in v1.28.0 

func (s *MissingAuthenticationToken) RequestID() string

RequestID returns the service's response RequestID for request.

func (*MissingAuthenticationToken) StatusCode added in v1.28.0 

func (s *MissingAuthenticationToken) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (MissingAuthenticationToken) String added in v1.28.0 

func (s MissingAuthenticationToken) String() string

String returns the string representation

type OptInRequiredException added in v1.28.0 

type OptInRequiredException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The account is not opted in to AWS Compute Optimizer.

func (*OptInRequiredException) Code added in v1.28.0 

func (s *OptInRequiredException) Code() string

Code returns the exception type name.

func (*OptInRequiredException) Error added in v1.28.0 

func (s *OptInRequiredException) Error() string

func (OptInRequiredException) GoString added in v1.28.0 

func (s OptInRequiredException) GoString() string

GoString returns the string representation

func (*OptInRequiredException) Message added in v1.28.0 

func (s *OptInRequiredException) Message() string

Message returns the exception's message.

func (*OptInRequiredException) OrigErr added in v1.28.0 

func (s *OptInRequiredException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*OptInRequiredException) RequestID added in v1.28.0 

func (s *OptInRequiredException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*OptInRequiredException) StatusCode added in v1.28.0 

func (s *OptInRequiredException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (OptInRequiredException) String added in v1.28.0 

func (s OptInRequiredException) String() string

String returns the string representation

type ProjectedMetric 

type ProjectedMetric struct {

	// The name of the projected utilization metric.
	//
	// Memory metrics are only returned 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/AmazonCloudWatch/latest/monitoring/Install-CloudWatch-Agent.html).
	Name *string `locationName:"name" type:"string" enum:"MetricName"`

	// The time stamps of the projected utilization metric.
	Timestamps []*time.Time `locationName:"timestamps" type:"list"`

	// The values of the projected utilization metrics.
	Values []*float64 `locationName:"values" type:"list"`
	// contains filtered or unexported fields
}

Describes a projected utilization metric of a recommendation option, such as an Amazon EC2 instance.

func (ProjectedMetric) GoString 

func (s ProjectedMetric) GoString() string

GoString returns the string representation

func (*ProjectedMetric) SetName 

func (s *ProjectedMetric) SetName(v string) *ProjectedMetric

SetName sets the Name field's value.

func (*ProjectedMetric) SetTimestamps 

func (s *ProjectedMetric) SetTimestamps(v []*time.Time) *ProjectedMetric

SetTimestamps sets the Timestamps field's value.

func (*ProjectedMetric) SetValues 

func (s *ProjectedMetric) SetValues(v []*float64) *ProjectedMetric

SetValues sets the Values field's value.

func (ProjectedMetric) String 

func (s ProjectedMetric) String() string

String returns the string representation

type RecommendationExportJob added in v1.31.15 

type RecommendationExportJob struct {

	// The timestamp of when the export job was created.
	CreationTimestamp *time.Time `locationName:"creationTimestamp" type:"timestamp"`

	// An object that describes the destination of the export file.
	Destination *ExportDestination `locationName:"destination" type:"structure"`

	// The reason for an export job failure.
	FailureReason *string `locationName:"failureReason" type:"string"`

	// The identification number of the export job.
	JobId *string `locationName:"jobId" type:"string"`

	// The timestamp of when the export job was last updated.
	LastUpdatedTimestamp *time.Time `locationName:"lastUpdatedTimestamp" type:"timestamp"`

	// The resource type of the exported recommendations.
	ResourceType *string `locationName:"resourceType" type:"string" enum:"ResourceType"`

	// The status of the export job.
	Status *string `locationName:"status" type:"string" enum:"JobStatus"`
	// contains filtered or unexported fields
}

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.

func (RecommendationExportJob) GoString added in v1.31.15 

func (s RecommendationExportJob) GoString() string

GoString returns the string representation

func (*RecommendationExportJob) SetCreationTimestamp added in v1.31.15 

func (s *RecommendationExportJob) SetCreationTimestamp(v time.Time) *RecommendationExportJob

SetCreationTimestamp sets the CreationTimestamp field's value.

func (*RecommendationExportJob) SetDestination added in v1.31.15 

func (s *RecommendationExportJob) SetDestination(v *ExportDestination) *RecommendationExportJob

SetDestination sets the Destination field's value.

func (*RecommendationExportJob) SetFailureReason added in v1.31.15 

func (s *RecommendationExportJob) SetFailureReason(v string) *RecommendationExportJob

SetFailureReason sets the FailureReason field's value.

func (*RecommendationExportJob) SetJobId added in v1.31.15 

func (s *RecommendationExportJob) SetJobId(v string) *RecommendationExportJob

SetJobId sets the JobId field's value.

func (*RecommendationExportJob) SetLastUpdatedTimestamp added in v1.31.15 

func (s *RecommendationExportJob) SetLastUpdatedTimestamp(v time.Time) *RecommendationExportJob

SetLastUpdatedTimestamp sets the LastUpdatedTimestamp field's value.

func (*RecommendationExportJob) SetResourceType added in v1.31.15 

func (s *RecommendationExportJob) SetResourceType(v string) *RecommendationExportJob

SetResourceType sets the ResourceType field's value.

func (*RecommendationExportJob) SetStatus added in v1.31.15 

func (s *RecommendationExportJob) SetStatus(v string) *RecommendationExportJob

SetStatus sets the Status field's value.

func (RecommendationExportJob) String added in v1.31.15 

func (s RecommendationExportJob) String() string

String returns the string representation

type RecommendationSource 

type RecommendationSource struct {

	// The Amazon Resource Name (ARN) of the recommendation source.
	RecommendationSourceArn *string `locationName:"recommendationSourceArn" type:"string"`

	// The resource type of the recommendation source.
	RecommendationSourceType *string `locationName:"recommendationSourceType" type:"string" enum:"RecommendationSourceType"`
	// contains filtered or unexported fields
}

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

func (RecommendationSource) GoString 

func (s RecommendationSource) GoString() string

GoString returns the string representation

func (*RecommendationSource) SetRecommendationSourceArn 

func (s *RecommendationSource) SetRecommendationSourceArn(v string) *RecommendationSource

SetRecommendationSourceArn sets the RecommendationSourceArn field's value.

func (*RecommendationSource) SetRecommendationSourceType 

func (s *RecommendationSource) SetRecommendationSourceType(v string) *RecommendationSource

SetRecommendationSourceType sets the RecommendationSourceType field's value.

func (RecommendationSource) String 

func (s RecommendationSource) String() string

String returns the string representation

type RecommendationSummary 

type RecommendationSummary struct {

	// The AWS account ID of the recommendation summary.
	AccountId *string `locationName:"accountId" type:"string"`

	// The resource type of the recommendation.
	RecommendationResourceType *string `locationName:"recommendationResourceType" type:"string" enum:"RecommendationSourceType"`

	// An array of objects that describe a recommendation summary.
	Summaries []*Summary `locationName:"summaries" type:"list"`
	// contains filtered or unexported fields
}

A summary of a recommendation.

func (RecommendationSummary) GoString 

func (s RecommendationSummary) GoString() string

GoString returns the string representation

func (*RecommendationSummary) SetAccountId 

func (s *RecommendationSummary) SetAccountId(v string) *RecommendationSummary

SetAccountId sets the AccountId field's value.

func (*RecommendationSummary) SetRecommendationResourceType 

func (s *RecommendationSummary) SetRecommendationResourceType(v string) *RecommendationSummary

SetRecommendationResourceType sets the RecommendationResourceType field's value.

func (*RecommendationSummary) SetSummaries 

func (s *RecommendationSummary) SetSummaries(v []*Summary) *RecommendationSummary

SetSummaries sets the Summaries field's value.

func (RecommendationSummary) String 

func (s RecommendationSummary) String() string

String returns the string representation

type RecommendedOptionProjectedMetric 

type RecommendedOptionProjectedMetric struct {

	// An array of objects that describe a projected utilization metric.
	ProjectedMetrics []*ProjectedMetric `locationName:"projectedMetrics" type:"list"`

	// 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 *int64 `locationName:"rank" type:"integer"`

	// The recommended instance type.
	RecommendedInstanceType *string `locationName:"recommendedInstanceType" type:"string"`
	// contains filtered or unexported fields
}

Describes a projected utilization metric of a recommendation option.

func (RecommendedOptionProjectedMetric) GoString 

func (s RecommendedOptionProjectedMetric) GoString() string

GoString returns the string representation

func (*RecommendedOptionProjectedMetric) SetProjectedMetrics 

func (s *RecommendedOptionProjectedMetric) SetProjectedMetrics(v []*ProjectedMetric) *RecommendedOptionProjectedMetric

SetProjectedMetrics sets the ProjectedMetrics field's value.

func (*RecommendedOptionProjectedMetric) SetRank 

func (s *RecommendedOptionProjectedMetric) SetRank(v int64) *RecommendedOptionProjectedMetric

SetRank sets the Rank field's value.

func (*RecommendedOptionProjectedMetric) SetRecommendedInstanceType 

func (s *RecommendedOptionProjectedMetric) SetRecommendedInstanceType(v string) *RecommendedOptionProjectedMetric

SetRecommendedInstanceType sets the RecommendedInstanceType field's value.

func (RecommendedOptionProjectedMetric) String 

func (s RecommendedOptionProjectedMetric) String() string

String returns the string representation

type ResourceNotFoundException added in v1.28.0 

type ResourceNotFoundException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

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

func (*ResourceNotFoundException) Code added in v1.28.0 

func (s *ResourceNotFoundException) Code() string

Code returns the exception type name.

func (*ResourceNotFoundException) Error added in v1.28.0 

func (s *ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString added in v1.28.0 

func (s ResourceNotFoundException) GoString() string

GoString returns the string representation

func (*ResourceNotFoundException) Message added in v1.28.0 

func (s *ResourceNotFoundException) Message() string

Message returns the exception's message.

func (*ResourceNotFoundException) OrigErr added in v1.28.0 

func (s *ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFoundException) RequestID added in v1.28.0 

func (s *ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFoundException) StatusCode added in v1.28.0 

func (s *ResourceNotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceNotFoundException) String added in v1.28.0 

func (s ResourceNotFoundException) String() string

String returns the string representation

type S3Destination added in v1.31.15 

type S3Destination struct {

	// The name of the Amazon S3 bucket used as the destination of an export file.
	Bucket *string `locationName:"bucket" type:"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 `locationName:"key" type:"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 `locationName:"metadataKey" type:"string"`
	// contains filtered or unexported fields
}

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

func (S3Destination) GoString added in v1.31.15 

func (s S3Destination) GoString() string

GoString returns the string representation

func (*S3Destination) SetBucket added in v1.31.15 

func (s *S3Destination) SetBucket(v string) *S3Destination

SetBucket sets the Bucket field's value.

func (*S3Destination) SetKey added in v1.31.15 

func (s *S3Destination) SetKey(v string) *S3Destination

SetKey sets the Key field's value.

func (*S3Destination) SetMetadataKey added in v1.31.15 

func (s *S3Destination) SetMetadataKey(v string) *S3Destination

SetMetadataKey sets the MetadataKey field's value.

func (S3Destination) String added in v1.31.15 

func (s S3Destination) String() string

String returns the string representation

type S3DestinationConfig added in v1.31.15 

type S3DestinationConfig struct {

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

	// The Amazon S3 bucket prefix for an export job.
	KeyPrefix *string `locationName:"keyPrefix" type:"string"`
	// contains filtered or unexported fields
}

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.

func (S3DestinationConfig) GoString added in v1.31.15 

func (s S3DestinationConfig) GoString() string

GoString returns the string representation

func (*S3DestinationConfig) SetBucket added in v1.31.15 

func (s *S3DestinationConfig) SetBucket(v string) *S3DestinationConfig

SetBucket sets the Bucket field's value.

func (*S3DestinationConfig) SetKeyPrefix added in v1.31.15 

func (s *S3DestinationConfig) SetKeyPrefix(v string) *S3DestinationConfig

SetKeyPrefix sets the KeyPrefix field's value.

func (S3DestinationConfig) String added in v1.31.15 

func (s S3DestinationConfig) String() string

String returns the string representation

type ServiceUnavailableException added in v1.28.0 

type ServiceUnavailableException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

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

func (*ServiceUnavailableException) Code added in v1.28.0 

func (s *ServiceUnavailableException) Code() string

Code returns the exception type name.

func (*ServiceUnavailableException) Error added in v1.28.0 

func (s *ServiceUnavailableException) Error() string

func (ServiceUnavailableException) GoString added in v1.28.0 

func (s ServiceUnavailableException) GoString() string

GoString returns the string representation

func (*ServiceUnavailableException) Message added in v1.28.0 

func (s *ServiceUnavailableException) Message() string

Message returns the exception's message.

func (*ServiceUnavailableException) OrigErr added in v1.28.0 

func (s *ServiceUnavailableException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ServiceUnavailableException) RequestID added in v1.28.0 

func (s *ServiceUnavailableException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ServiceUnavailableException) StatusCode added in v1.28.0 

func (s *ServiceUnavailableException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ServiceUnavailableException) String added in v1.28.0 

func (s ServiceUnavailableException) String() string

String returns the string representation

type Summary 

type Summary struct {

	// The finding classification of the recommendation.
	Name *string `locationName:"name" type:"string" enum:"Finding"`

	// The value of the recommendation summary.
	Value *float64 `locationName:"value" type:"double"`
	// contains filtered or unexported fields
}

The summary of a recommendation.

func (Summary) GoString 

func (s Summary) GoString() string

GoString returns the string representation

func (*Summary) SetName 

func (s *Summary) SetName(v string) *Summary

SetName sets the Name field's value.

func (*Summary) SetValue 

func (s *Summary) SetValue(v float64) *Summary

SetValue sets the Value field's value.

func (Summary) String 

func (s Summary) String() string

String returns the string representation

type ThrottlingException added in v1.28.0 

type ThrottlingException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The request was denied due to request throttling.

func (*ThrottlingException) Code added in v1.28.0 

func (s *ThrottlingException) Code() string

Code returns the exception type name.

func (*ThrottlingException) Error added in v1.28.0 

func (s *ThrottlingException) Error() string

func (ThrottlingException) GoString added in v1.28.0 

func (s ThrottlingException) GoString() string

GoString returns the string representation

func (*ThrottlingException) Message added in v1.28.0 

func (s *ThrottlingException) Message() string

Message returns the exception's message.

func (*ThrottlingException) OrigErr added in v1.28.0 

func (s *ThrottlingException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ThrottlingException) RequestID added in v1.28.0 

func (s *ThrottlingException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ThrottlingException) StatusCode added in v1.28.0 

func (s *ThrottlingException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ThrottlingException) String added in v1.28.0 

func (s ThrottlingException) String() string

String returns the string representation

type UpdateEnrollmentStatusInput 

type UpdateEnrollmentStatusInput struct {

	// Indicates whether to enroll member accounts of the organization if the your
	// account is the master account of an organization.
	IncludeMemberAccounts *bool `locationName:"includeMemberAccounts" type:"boolean"`

	// The new enrollment status of the account.
	//
	// Accepted options are Active or Inactive. You will get an error if Pending
	// or Failed are specified.
	//
	// Status is a required field
	Status *string `locationName:"status" type:"string" required:"true" enum:"Status"`
	// contains filtered or unexported fields
}

func (UpdateEnrollmentStatusInput) GoString 

func (s UpdateEnrollmentStatusInput) GoString() string

GoString returns the string representation

func (*UpdateEnrollmentStatusInput) SetIncludeMemberAccounts 

func (s *UpdateEnrollmentStatusInput) SetIncludeMemberAccounts(v bool) *UpdateEnrollmentStatusInput

SetIncludeMemberAccounts sets the IncludeMemberAccounts field's value.

func (*UpdateEnrollmentStatusInput) SetStatus 

func (s *UpdateEnrollmentStatusInput) SetStatus(v string) *UpdateEnrollmentStatusInput

SetStatus sets the Status field's value.

func (UpdateEnrollmentStatusInput) String 

func (s UpdateEnrollmentStatusInput) String() string

String returns the string representation

func (*UpdateEnrollmentStatusInput) Validate 

func (s *UpdateEnrollmentStatusInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateEnrollmentStatusOutput 

type UpdateEnrollmentStatusOutput struct {

	// The enrollment status of the account.
	Status *string `locationName:"status" type:"string" enum:"Status"`

	// The reason for the enrollment status of the account. For example, an account
	// might show a status of Pending because member accounts of an organization
	// require more time to be enrolled in the service.
	StatusReason *string `locationName:"statusReason" type:"string"`
	// contains filtered or unexported fields
}

func (UpdateEnrollmentStatusOutput) GoString 

func (s UpdateEnrollmentStatusOutput) GoString() string

GoString returns the string representation

func (*UpdateEnrollmentStatusOutput) SetStatus 

func (s *UpdateEnrollmentStatusOutput) SetStatus(v string) *UpdateEnrollmentStatusOutput

SetStatus sets the Status field's value.

func (*UpdateEnrollmentStatusOutput) SetStatusReason 

func (s *UpdateEnrollmentStatusOutput) SetStatusReason(v string) *UpdateEnrollmentStatusOutput

SetStatusReason sets the StatusReason field's value.

func (UpdateEnrollmentStatusOutput) String 

func (s UpdateEnrollmentStatusOutput) String() string

String returns the string representation

type UtilizationMetric 

type UtilizationMetric struct {

	// The name of the utilization metric.
	//
	// Memory metrics are only returned 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/AmazonCloudWatch/latest/monitoring/Install-CloudWatch-Agent.html).
	Name *string `locationName:"name" type:"string" enum:"MetricName"`

	// The statistic of the utilization metric.
	Statistic *string `locationName:"statistic" type:"string" enum:"MetricStatistic"`

	// The value of the utilization metric.
	Value *float64 `locationName:"value" type:"double"`
	// contains filtered or unexported fields
}

Describes a utilization metric of a resource, such as an Amazon EC2 instance.

func (UtilizationMetric) GoString 

func (s UtilizationMetric) GoString() string

GoString returns the string representation

func (*UtilizationMetric) SetName 

func (s *UtilizationMetric) SetName(v string) *UtilizationMetric

SetName sets the Name field's value.

func (*UtilizationMetric) SetStatistic 

func (s *UtilizationMetric) SetStatistic(v string) *UtilizationMetric

SetStatistic sets the Statistic field's value.

func (*UtilizationMetric) SetValue 

func (s *UtilizationMetric) SetValue(v float64) *UtilizationMetric

SetValue sets the Value field's value.

func (UtilizationMetric) String 

func (s UtilizationMetric) String() string

String returns the string representation

Source Files

View all Source files

Directories

Path Synopsis
Package computeoptimizeriface provides an interface to enable mocking the AWS Compute Optimizer service client for testing your code.
 Package computeoptimizeriface provides an interface to enable mocking the AWS Compute Optimizer service client for testing your code.

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.