Documentation ¶
Overview ¶
Package applicationautoscaling provides the client and types for making API requests to Application Auto Scaling.
With Application Auto Scaling, you can automatically scale your AWS resources. The experience similar to that of Auto Scaling (https://aws.amazon.com/autoscaling/). You can use Application Auto Scaling to accomplish the following tasks:
Define scaling policies to automatically scale your AWS resources
Scale your resources in response to CloudWatch alarms
View the history of your scaling events
Application Auto Scaling can scale the following AWS resources:
Amazon ECS services. For more information, see Service Auto Scaling (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-auto-scaling.html) in the Amazon EC2 Container Service Developer Guide.
Amazon EC2 Spot fleets. For more information, see Automatic Scaling for Spot Fleet (http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/fleet-auto-scaling.html) in the Amazon EC2 User Guide.
Amazon EMR clusters. For more information, see Using Automatic Scaling in Amazon EMR (http://docs.aws.amazon.com/ElasticMapReduce/latest/ManagementGuide/emr-automatic-scaling.html) in the Amazon EMR Management Guide.
AppStream 2.0 fleets. For more information, see Autoscaling Amazon AppStream 2.0 Resources (http://docs.aws.amazon.com/appstream2/latest/developerguide/autoscaling.html) in the Amazon AppStream 2.0 Developer Guide.
For a list of supported regions, see AWS Regions and Endpoints: Application Auto Scaling (http://docs.aws.amazon.com/general/latest/gr/rande.html#as-app_region) in the AWS General Reference.
See https://docs.aws.amazon.com/goto/WebAPI/application-autoscaling-2016-02-06 for more information on this service.
See applicationautoscaling package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/applicationautoscaling/
Using the Client ¶
To use the client for Application Auto Scaling you will first need to create a new instance of it.
When creating a client for an AWS service you'll first need to have a Session already created. The Session provides configuration that can be shared between multiple service clients. Additional configuration can be applied to the Session and service's client when they are constructed. The aws package's Config type contains several fields such as Region for the AWS Region the client should make API requests too. The optional Config value can be provided as the variadic argument for Sessions and client creation.
Once the service's client is created you can use it to make API requests the AWS service. These clients are safe to use concurrently.
// Create a session to share configuration, and load external configuration. sess := session.Must(session.NewSession()) // Create the service's client with the session. svc := applicationautoscaling.New(sess)
See the SDK's documentation for more information on how to use service clients. https://docs.aws.amazon.com/sdk-for-go/api/
See aws package's Config type for more information on configuration options. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config
See the Application Auto Scaling client ApplicationAutoScaling for more information on creating the service's client. https://docs.aws.amazon.com/sdk-for-go/api/service/applicationautoscaling/#New
Once the client is created you can make an API request to the service. Each API method takes a input parameter, and returns the service response and an error.
The API method will document which error codes the service can be returned by the operation if the service models the API operation's errors. These errors will also be available as const strings prefixed with "ErrCode".
result, err := svc.DeleteScalingPolicy(params) if err != nil { // Cast err to awserr.Error to handle specific error codes. aerr, ok := err.(awserr.Error) if ok && aerr.Code() == <error code to check for> { // Specific error code handling } return err } fmt.Println("DeleteScalingPolicy result:") fmt.Println(result)
Using the Client with Context ¶
The service's client also provides methods to make API requests with a Context value. This allows you to control the timeout, and cancellation of pending requests. These methods also take request Option as variadic parameter to apply additional configuration to the API request.
ctx := context.Background() result, err := svc.DeleteScalingPolicyWithContext(ctx, params)
See the request package documentation for more information on using Context pattern with the SDK. https://docs.aws.amazon.com/sdk-for-go/api/aws/request/
Index ¶
- Constants
- type Alarm
- type ApplicationAutoScaling
- func (c *ApplicationAutoScaling) DeleteScalingPolicy(input *DeleteScalingPolicyInput) (*DeleteScalingPolicyOutput, error)
- func (c *ApplicationAutoScaling) DeleteScalingPolicyRequest(input *DeleteScalingPolicyInput) (req *request.Request, output *DeleteScalingPolicyOutput)
- func (c *ApplicationAutoScaling) DeleteScalingPolicyWithContext(ctx aws.Context, input *DeleteScalingPolicyInput, opts ...request.Option) (*DeleteScalingPolicyOutput, error)
- func (c *ApplicationAutoScaling) DeregisterScalableTarget(input *DeregisterScalableTargetInput) (*DeregisterScalableTargetOutput, error)
- func (c *ApplicationAutoScaling) DeregisterScalableTargetRequest(input *DeregisterScalableTargetInput) (req *request.Request, output *DeregisterScalableTargetOutput)
- func (c *ApplicationAutoScaling) DeregisterScalableTargetWithContext(ctx aws.Context, input *DeregisterScalableTargetInput, opts ...request.Option) (*DeregisterScalableTargetOutput, error)
- func (c *ApplicationAutoScaling) DescribeScalableTargets(input *DescribeScalableTargetsInput) (*DescribeScalableTargetsOutput, error)
- func (c *ApplicationAutoScaling) DescribeScalableTargetsPages(input *DescribeScalableTargetsInput, ...) error
- func (c *ApplicationAutoScaling) DescribeScalableTargetsPagesWithContext(ctx aws.Context, input *DescribeScalableTargetsInput, ...) error
- func (c *ApplicationAutoScaling) DescribeScalableTargetsRequest(input *DescribeScalableTargetsInput) (req *request.Request, output *DescribeScalableTargetsOutput)
- func (c *ApplicationAutoScaling) DescribeScalableTargetsWithContext(ctx aws.Context, input *DescribeScalableTargetsInput, opts ...request.Option) (*DescribeScalableTargetsOutput, error)
- func (c *ApplicationAutoScaling) DescribeScalingActivities(input *DescribeScalingActivitiesInput) (*DescribeScalingActivitiesOutput, error)
- func (c *ApplicationAutoScaling) DescribeScalingActivitiesPages(input *DescribeScalingActivitiesInput, ...) error
- func (c *ApplicationAutoScaling) DescribeScalingActivitiesPagesWithContext(ctx aws.Context, input *DescribeScalingActivitiesInput, ...) error
- func (c *ApplicationAutoScaling) DescribeScalingActivitiesRequest(input *DescribeScalingActivitiesInput) (req *request.Request, output *DescribeScalingActivitiesOutput)
- func (c *ApplicationAutoScaling) DescribeScalingActivitiesWithContext(ctx aws.Context, input *DescribeScalingActivitiesInput, opts ...request.Option) (*DescribeScalingActivitiesOutput, error)
- func (c *ApplicationAutoScaling) DescribeScalingPolicies(input *DescribeScalingPoliciesInput) (*DescribeScalingPoliciesOutput, error)
- func (c *ApplicationAutoScaling) DescribeScalingPoliciesPages(input *DescribeScalingPoliciesInput, ...) error
- func (c *ApplicationAutoScaling) DescribeScalingPoliciesPagesWithContext(ctx aws.Context, input *DescribeScalingPoliciesInput, ...) error
- func (c *ApplicationAutoScaling) DescribeScalingPoliciesRequest(input *DescribeScalingPoliciesInput) (req *request.Request, output *DescribeScalingPoliciesOutput)
- func (c *ApplicationAutoScaling) DescribeScalingPoliciesWithContext(ctx aws.Context, input *DescribeScalingPoliciesInput, opts ...request.Option) (*DescribeScalingPoliciesOutput, error)
- func (c *ApplicationAutoScaling) PutScalingPolicy(input *PutScalingPolicyInput) (*PutScalingPolicyOutput, error)
- func (c *ApplicationAutoScaling) PutScalingPolicyRequest(input *PutScalingPolicyInput) (req *request.Request, output *PutScalingPolicyOutput)
- func (c *ApplicationAutoScaling) PutScalingPolicyWithContext(ctx aws.Context, input *PutScalingPolicyInput, opts ...request.Option) (*PutScalingPolicyOutput, error)
- func (c *ApplicationAutoScaling) RegisterScalableTarget(input *RegisterScalableTargetInput) (*RegisterScalableTargetOutput, error)
- func (c *ApplicationAutoScaling) RegisterScalableTargetRequest(input *RegisterScalableTargetInput) (req *request.Request, output *RegisterScalableTargetOutput)
- func (c *ApplicationAutoScaling) RegisterScalableTargetWithContext(ctx aws.Context, input *RegisterScalableTargetInput, opts ...request.Option) (*RegisterScalableTargetOutput, error)
- type DeleteScalingPolicyInput
- func (s DeleteScalingPolicyInput) GoString() string
- func (s *DeleteScalingPolicyInput) SetPolicyName(v string) *DeleteScalingPolicyInput
- func (s *DeleteScalingPolicyInput) SetResourceId(v string) *DeleteScalingPolicyInput
- func (s *DeleteScalingPolicyInput) SetScalableDimension(v string) *DeleteScalingPolicyInput
- func (s *DeleteScalingPolicyInput) SetServiceNamespace(v string) *DeleteScalingPolicyInput
- func (s DeleteScalingPolicyInput) String() string
- func (s *DeleteScalingPolicyInput) Validate() error
- type DeleteScalingPolicyOutput
- type DeregisterScalableTargetInput
- func (s DeregisterScalableTargetInput) GoString() string
- func (s *DeregisterScalableTargetInput) SetResourceId(v string) *DeregisterScalableTargetInput
- func (s *DeregisterScalableTargetInput) SetScalableDimension(v string) *DeregisterScalableTargetInput
- func (s *DeregisterScalableTargetInput) SetServiceNamespace(v string) *DeregisterScalableTargetInput
- func (s DeregisterScalableTargetInput) String() string
- func (s *DeregisterScalableTargetInput) Validate() error
- type DeregisterScalableTargetOutput
- type DescribeScalableTargetsInput
- func (s DescribeScalableTargetsInput) GoString() string
- func (s *DescribeScalableTargetsInput) SetMaxResults(v int64) *DescribeScalableTargetsInput
- func (s *DescribeScalableTargetsInput) SetNextToken(v string) *DescribeScalableTargetsInput
- func (s *DescribeScalableTargetsInput) SetResourceIds(v []*string) *DescribeScalableTargetsInput
- func (s *DescribeScalableTargetsInput) SetScalableDimension(v string) *DescribeScalableTargetsInput
- func (s *DescribeScalableTargetsInput) SetServiceNamespace(v string) *DescribeScalableTargetsInput
- func (s DescribeScalableTargetsInput) String() string
- func (s *DescribeScalableTargetsInput) Validate() error
- type DescribeScalableTargetsOutput
- func (s DescribeScalableTargetsOutput) GoString() string
- func (s *DescribeScalableTargetsOutput) SetNextToken(v string) *DescribeScalableTargetsOutput
- func (s *DescribeScalableTargetsOutput) SetScalableTargets(v []*ScalableTarget) *DescribeScalableTargetsOutput
- func (s DescribeScalableTargetsOutput) String() string
- type DescribeScalingActivitiesInput
- func (s DescribeScalingActivitiesInput) GoString() string
- func (s *DescribeScalingActivitiesInput) SetMaxResults(v int64) *DescribeScalingActivitiesInput
- func (s *DescribeScalingActivitiesInput) SetNextToken(v string) *DescribeScalingActivitiesInput
- func (s *DescribeScalingActivitiesInput) SetResourceId(v string) *DescribeScalingActivitiesInput
- func (s *DescribeScalingActivitiesInput) SetScalableDimension(v string) *DescribeScalingActivitiesInput
- func (s *DescribeScalingActivitiesInput) SetServiceNamespace(v string) *DescribeScalingActivitiesInput
- func (s DescribeScalingActivitiesInput) String() string
- func (s *DescribeScalingActivitiesInput) Validate() error
- type DescribeScalingActivitiesOutput
- func (s DescribeScalingActivitiesOutput) GoString() string
- func (s *DescribeScalingActivitiesOutput) SetNextToken(v string) *DescribeScalingActivitiesOutput
- func (s *DescribeScalingActivitiesOutput) SetScalingActivities(v []*ScalingActivity) *DescribeScalingActivitiesOutput
- func (s DescribeScalingActivitiesOutput) String() string
- type DescribeScalingPoliciesInput
- func (s DescribeScalingPoliciesInput) GoString() string
- func (s *DescribeScalingPoliciesInput) SetMaxResults(v int64) *DescribeScalingPoliciesInput
- func (s *DescribeScalingPoliciesInput) SetNextToken(v string) *DescribeScalingPoliciesInput
- func (s *DescribeScalingPoliciesInput) SetPolicyNames(v []*string) *DescribeScalingPoliciesInput
- func (s *DescribeScalingPoliciesInput) SetResourceId(v string) *DescribeScalingPoliciesInput
- func (s *DescribeScalingPoliciesInput) SetScalableDimension(v string) *DescribeScalingPoliciesInput
- func (s *DescribeScalingPoliciesInput) SetServiceNamespace(v string) *DescribeScalingPoliciesInput
- func (s DescribeScalingPoliciesInput) String() string
- func (s *DescribeScalingPoliciesInput) Validate() error
- type DescribeScalingPoliciesOutput
- func (s DescribeScalingPoliciesOutput) GoString() string
- func (s *DescribeScalingPoliciesOutput) SetNextToken(v string) *DescribeScalingPoliciesOutput
- func (s *DescribeScalingPoliciesOutput) SetScalingPolicies(v []*ScalingPolicy) *DescribeScalingPoliciesOutput
- func (s DescribeScalingPoliciesOutput) String() string
- type PutScalingPolicyInput
- func (s PutScalingPolicyInput) GoString() string
- func (s *PutScalingPolicyInput) SetPolicyName(v string) *PutScalingPolicyInput
- func (s *PutScalingPolicyInput) SetPolicyType(v string) *PutScalingPolicyInput
- func (s *PutScalingPolicyInput) SetResourceId(v string) *PutScalingPolicyInput
- func (s *PutScalingPolicyInput) SetScalableDimension(v string) *PutScalingPolicyInput
- func (s *PutScalingPolicyInput) SetServiceNamespace(v string) *PutScalingPolicyInput
- func (s *PutScalingPolicyInput) SetStepScalingPolicyConfiguration(v *StepScalingPolicyConfiguration) *PutScalingPolicyInput
- func (s PutScalingPolicyInput) String() string
- func (s *PutScalingPolicyInput) Validate() error
- type PutScalingPolicyOutput
- type RegisterScalableTargetInput
- func (s RegisterScalableTargetInput) GoString() string
- func (s *RegisterScalableTargetInput) SetMaxCapacity(v int64) *RegisterScalableTargetInput
- func (s *RegisterScalableTargetInput) SetMinCapacity(v int64) *RegisterScalableTargetInput
- func (s *RegisterScalableTargetInput) SetResourceId(v string) *RegisterScalableTargetInput
- func (s *RegisterScalableTargetInput) SetRoleARN(v string) *RegisterScalableTargetInput
- func (s *RegisterScalableTargetInput) SetScalableDimension(v string) *RegisterScalableTargetInput
- func (s *RegisterScalableTargetInput) SetServiceNamespace(v string) *RegisterScalableTargetInput
- func (s RegisterScalableTargetInput) String() string
- func (s *RegisterScalableTargetInput) Validate() error
- type RegisterScalableTargetOutput
- type ScalableTarget
- func (s ScalableTarget) GoString() string
- func (s *ScalableTarget) SetCreationTime(v time.Time) *ScalableTarget
- func (s *ScalableTarget) SetMaxCapacity(v int64) *ScalableTarget
- func (s *ScalableTarget) SetMinCapacity(v int64) *ScalableTarget
- func (s *ScalableTarget) SetResourceId(v string) *ScalableTarget
- func (s *ScalableTarget) SetRoleARN(v string) *ScalableTarget
- func (s *ScalableTarget) SetScalableDimension(v string) *ScalableTarget
- func (s *ScalableTarget) SetServiceNamespace(v string) *ScalableTarget
- func (s ScalableTarget) String() string
- type ScalingActivity
- func (s ScalingActivity) GoString() string
- func (s *ScalingActivity) SetActivityId(v string) *ScalingActivity
- func (s *ScalingActivity) SetCause(v string) *ScalingActivity
- func (s *ScalingActivity) SetDescription(v string) *ScalingActivity
- func (s *ScalingActivity) SetDetails(v string) *ScalingActivity
- func (s *ScalingActivity) SetEndTime(v time.Time) *ScalingActivity
- func (s *ScalingActivity) SetResourceId(v string) *ScalingActivity
- func (s *ScalingActivity) SetScalableDimension(v string) *ScalingActivity
- func (s *ScalingActivity) SetServiceNamespace(v string) *ScalingActivity
- func (s *ScalingActivity) SetStartTime(v time.Time) *ScalingActivity
- func (s *ScalingActivity) SetStatusCode(v string) *ScalingActivity
- func (s *ScalingActivity) SetStatusMessage(v string) *ScalingActivity
- func (s ScalingActivity) String() string
- type ScalingPolicy
- func (s ScalingPolicy) GoString() string
- func (s *ScalingPolicy) SetAlarms(v []*Alarm) *ScalingPolicy
- func (s *ScalingPolicy) SetCreationTime(v time.Time) *ScalingPolicy
- func (s *ScalingPolicy) SetPolicyARN(v string) *ScalingPolicy
- func (s *ScalingPolicy) SetPolicyName(v string) *ScalingPolicy
- func (s *ScalingPolicy) SetPolicyType(v string) *ScalingPolicy
- func (s *ScalingPolicy) SetResourceId(v string) *ScalingPolicy
- func (s *ScalingPolicy) SetScalableDimension(v string) *ScalingPolicy
- func (s *ScalingPolicy) SetServiceNamespace(v string) *ScalingPolicy
- func (s *ScalingPolicy) SetStepScalingPolicyConfiguration(v *StepScalingPolicyConfiguration) *ScalingPolicy
- func (s ScalingPolicy) String() string
- type StepAdjustment
- func (s StepAdjustment) GoString() string
- func (s *StepAdjustment) SetMetricIntervalLowerBound(v float64) *StepAdjustment
- func (s *StepAdjustment) SetMetricIntervalUpperBound(v float64) *StepAdjustment
- func (s *StepAdjustment) SetScalingAdjustment(v int64) *StepAdjustment
- func (s StepAdjustment) String() string
- func (s *StepAdjustment) Validate() error
- type StepScalingPolicyConfiguration
- func (s StepScalingPolicyConfiguration) GoString() string
- func (s *StepScalingPolicyConfiguration) SetAdjustmentType(v string) *StepScalingPolicyConfiguration
- func (s *StepScalingPolicyConfiguration) SetCooldown(v int64) *StepScalingPolicyConfiguration
- func (s *StepScalingPolicyConfiguration) SetMetricAggregationType(v string) *StepScalingPolicyConfiguration
- func (s *StepScalingPolicyConfiguration) SetMinAdjustmentMagnitude(v int64) *StepScalingPolicyConfiguration
- func (s *StepScalingPolicyConfiguration) SetStepAdjustments(v []*StepAdjustment) *StepScalingPolicyConfiguration
- func (s StepScalingPolicyConfiguration) String() string
- func (s *StepScalingPolicyConfiguration) Validate() error
Examples ¶
- ApplicationAutoScaling.DeleteScalingPolicy
- ApplicationAutoScaling.DeregisterScalableTarget
- ApplicationAutoScaling.DescribeScalableTargets
- ApplicationAutoScaling.DescribeScalingActivities
- ApplicationAutoScaling.DescribeScalingPolicies
- ApplicationAutoScaling.PutScalingPolicy
- ApplicationAutoScaling.RegisterScalableTarget
Constants ¶
const ( // AdjustmentTypeChangeInCapacity is a AdjustmentType enum value AdjustmentTypeChangeInCapacity = "ChangeInCapacity" // AdjustmentTypePercentChangeInCapacity is a AdjustmentType enum value AdjustmentTypePercentChangeInCapacity = "PercentChangeInCapacity" // AdjustmentTypeExactCapacity is a AdjustmentType enum value AdjustmentTypeExactCapacity = "ExactCapacity" )
const ( // MetricAggregationTypeAverage is a MetricAggregationType enum value MetricAggregationTypeAverage = "Average" // MetricAggregationTypeMinimum is a MetricAggregationType enum value MetricAggregationTypeMinimum = "Minimum" // MetricAggregationTypeMaximum is a MetricAggregationType enum value MetricAggregationTypeMaximum = "Maximum" )
const ( // ScalableDimensionEcsServiceDesiredCount is a ScalableDimension enum value ScalableDimensionEcsServiceDesiredCount = "ecs:service:DesiredCount" // ScalableDimensionEc2SpotFleetRequestTargetCapacity is a ScalableDimension enum value ScalableDimensionEc2SpotFleetRequestTargetCapacity = "ec2:spot-fleet-request:TargetCapacity" // ScalableDimensionElasticmapreduceInstancegroupInstanceCount is a ScalableDimension enum value ScalableDimensionElasticmapreduceInstancegroupInstanceCount = "elasticmapreduce:instancegroup:InstanceCount" // ScalableDimensionAppstreamFleetDesiredCapacity is a ScalableDimension enum value ScalableDimensionAppstreamFleetDesiredCapacity = "appstream:fleet:DesiredCapacity" )
const ( // ScalingActivityStatusCodePending is a ScalingActivityStatusCode enum value ScalingActivityStatusCodePending = "Pending" // ScalingActivityStatusCodeInProgress is a ScalingActivityStatusCode enum value ScalingActivityStatusCodeInProgress = "InProgress" // ScalingActivityStatusCodeSuccessful is a ScalingActivityStatusCode enum value ScalingActivityStatusCodeSuccessful = "Successful" // ScalingActivityStatusCodeOverridden is a ScalingActivityStatusCode enum value ScalingActivityStatusCodeOverridden = "Overridden" // ScalingActivityStatusCodeUnfulfilled is a ScalingActivityStatusCode enum value ScalingActivityStatusCodeUnfulfilled = "Unfulfilled" // ScalingActivityStatusCodeFailed is a ScalingActivityStatusCode enum value ScalingActivityStatusCodeFailed = "Failed" )
const ( // ServiceNamespaceEcs is a ServiceNamespace enum value ServiceNamespaceEcs = "ecs" // ServiceNamespaceElasticmapreduce is a ServiceNamespace enum value ServiceNamespaceElasticmapreduce = "elasticmapreduce" // ServiceNamespaceEc2 is a ServiceNamespace enum value ServiceNamespaceEc2 = "ec2" // ServiceNamespaceAppstream is a ServiceNamespace enum value ServiceNamespaceAppstream = "appstream" )
const ( // ErrCodeConcurrentUpdateException for service response error code // "ConcurrentUpdateException". // // Concurrent updates caused an exception, for example, if you request an update // to an Application Auto Scaling resource that already has a pending update. ErrCodeConcurrentUpdateException = "ConcurrentUpdateException" // ErrCodeFailedResourceAccessException for service response error code // "FailedResourceAccessException". // // Failed access to resources caused an exception. This exception currently // only applies to DescribeScalingPolicies. It is thrown when Application Auto // Scaling is unable to retrieve the alarms associated with a scaling policy // due to a client error, for example, if the role ARN specified for a scalable // target does not have the proper permissions to call the CloudWatch DescribeAlarms // (http://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_DescribeAlarms.html) // API operation on behalf of your account. ErrCodeFailedResourceAccessException = "FailedResourceAccessException" // ErrCodeInternalServiceException for service response error code // "InternalServiceException". // // The service encountered an internal error. ErrCodeInternalServiceException = "InternalServiceException" // ErrCodeInvalidNextTokenException for service response error code // "InvalidNextTokenException". // // The next token supplied was invalid. ErrCodeInvalidNextTokenException = "InvalidNextTokenException" // ErrCodeLimitExceededException for service response error code // "LimitExceededException". // // Your account exceeded a limit. This exception is thrown when a per-account // resource limit is exceeded. For more information, see Application Auto Scaling // Limits (http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html#limits_as-app). ErrCodeLimitExceededException = "LimitExceededException" // ErrCodeObjectNotFoundException for service response error code // "ObjectNotFoundException". // // The specified object could not be found. For any Put or Register API operation, // which depends on the existence of a scalable target, this exception is thrown // if the scalable target with the specified service namespace, resource ID, // and scalable dimension does not exist. For any Delete or Deregister API operation, // this exception is thrown if the resource that is to be deleted or deregistered // cannot be found. ErrCodeObjectNotFoundException = "ObjectNotFoundException" // ErrCodeValidationException for service response error code // "ValidationException". // // An exception was thrown for a validation issue. Review the available parameters // for the API request. ErrCodeValidationException = "ValidationException" )
const ( ServiceName = "autoscaling" // Service endpoint prefix API calls made to. EndpointsID = "application-autoscaling" // Service ID for Regions and Endpoints metadata. )
Service information constants
const (
// PolicyTypeStepScaling is a PolicyType enum value
PolicyTypeStepScaling = "StepScaling"
)
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Alarm ¶
type Alarm struct { // The Amazon Resource Name (ARN) of the alarm. // // AlarmARN is a required field AlarmARN *string `type:"string" required:"true"` // The name of the alarm. // // AlarmName is a required field AlarmName *string `type:"string" required:"true"` // contains filtered or unexported fields }
Represents a CloudWatch alarm associated with a scaling policy. Please also see https://docs.aws.amazon.com/goto/WebAPI/application-autoscaling-2016-02-06/Alarm
func (*Alarm) SetAlarmARN ¶ added in v1.5.1
SetAlarmARN sets the AlarmARN field's value.
func (*Alarm) SetAlarmName ¶ added in v1.5.1
SetAlarmName sets the AlarmName field's value.
type ApplicationAutoScaling ¶
ApplicationAutoScaling provides the API operation methods for making requests to Application Auto Scaling. See this package's package overview docs for details on the service.
ApplicationAutoScaling 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) *ApplicationAutoScaling
New creates a new instance of the ApplicationAutoScaling 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:
// Create a ApplicationAutoScaling client from just a session. svc := applicationautoscaling.New(mySession) // Create a ApplicationAutoScaling client with additional configuration svc := applicationautoscaling.New(mySession, aws.NewConfig().WithRegion("us-west-2"))
func (*ApplicationAutoScaling) DeleteScalingPolicy ¶
func (c *ApplicationAutoScaling) DeleteScalingPolicy(input *DeleteScalingPolicyInput) (*DeleteScalingPolicyOutput, error)
DeleteScalingPolicy API operation for Application Auto Scaling.
Deletes the specified Application Auto Scaling scaling policy.
Deleting a policy deletes the underlying alarm action, but does not delete the CloudWatch alarm associated with the scaling policy, even if it no longer has an associated action.
To create a scaling policy or update an existing one, see PutScalingPolicy.
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 Application Auto Scaling's API operation DeleteScalingPolicy for usage and error information.
Returned Error Codes:
ErrCodeValidationException "ValidationException" An exception was thrown for a validation issue. Review the available parameters for the API request.
ErrCodeObjectNotFoundException "ObjectNotFoundException" The specified object could not be found. For any Put or Register API operation, which depends on the existence of a scalable target, this exception is thrown if the scalable target with the specified service namespace, resource ID, and scalable dimension does not exist. For any Delete or Deregister API operation, this exception is thrown if the resource that is to be deleted or deregistered cannot be found.
ErrCodeConcurrentUpdateException "ConcurrentUpdateException" Concurrent updates caused an exception, for example, if you request an update to an Application Auto Scaling resource that already has a pending update.
ErrCodeInternalServiceException "InternalServiceException" The service encountered an internal error.
Please also see https://docs.aws.amazon.com/goto/WebAPI/application-autoscaling-2016-02-06/DeleteScalingPolicy
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/applicationautoscaling" ) func main() { sess := session.Must(session.NewSession()) svc := applicationautoscaling.New(sess) params := &applicationautoscaling.DeleteScalingPolicyInput{ PolicyName: aws.String("ResourceIdMaxLen1600"), // Required ResourceId: aws.String("ResourceIdMaxLen1600"), // Required ScalableDimension: aws.String("ScalableDimension"), // Required ServiceNamespace: aws.String("ServiceNamespace"), // Required } resp, err := svc.DeleteScalingPolicy(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*ApplicationAutoScaling) DeleteScalingPolicyRequest ¶
func (c *ApplicationAutoScaling) DeleteScalingPolicyRequest(input *DeleteScalingPolicyInput) (req *request.Request, output *DeleteScalingPolicyOutput)
DeleteScalingPolicyRequest generates a "aws/request.Request" representing the client's request for the DeleteScalingPolicy operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See DeleteScalingPolicy for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteScalingPolicy method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the DeleteScalingPolicyRequest method. req, resp := client.DeleteScalingPolicyRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/application-autoscaling-2016-02-06/DeleteScalingPolicy
func (*ApplicationAutoScaling) DeleteScalingPolicyWithContext ¶ added in v1.8.0
func (c *ApplicationAutoScaling) DeleteScalingPolicyWithContext(ctx aws.Context, input *DeleteScalingPolicyInput, opts ...request.Option) (*DeleteScalingPolicyOutput, error)
DeleteScalingPolicyWithContext is the same as DeleteScalingPolicy with the addition of the ability to pass a context and additional request options.
See DeleteScalingPolicy 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 (*ApplicationAutoScaling) DeregisterScalableTarget ¶
func (c *ApplicationAutoScaling) DeregisterScalableTarget(input *DeregisterScalableTargetInput) (*DeregisterScalableTargetOutput, error)
DeregisterScalableTarget API operation for Application Auto Scaling.
Deregisters a scalable target.
Deregistering a scalable target deletes the scaling policies that are associated with it.
To create a scalable target or update an existing one, see RegisterScalableTarget.
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 Application Auto Scaling's API operation DeregisterScalableTarget for usage and error information.
Returned Error Codes:
ErrCodeValidationException "ValidationException" An exception was thrown for a validation issue. Review the available parameters for the API request.
ErrCodeObjectNotFoundException "ObjectNotFoundException" The specified object could not be found. For any Put or Register API operation, which depends on the existence of a scalable target, this exception is thrown if the scalable target with the specified service namespace, resource ID, and scalable dimension does not exist. For any Delete or Deregister API operation, this exception is thrown if the resource that is to be deleted or deregistered cannot be found.
ErrCodeConcurrentUpdateException "ConcurrentUpdateException" Concurrent updates caused an exception, for example, if you request an update to an Application Auto Scaling resource that already has a pending update.
ErrCodeInternalServiceException "InternalServiceException" The service encountered an internal error.
Please also see https://docs.aws.amazon.com/goto/WebAPI/application-autoscaling-2016-02-06/DeregisterScalableTarget
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/applicationautoscaling" ) func main() { sess := session.Must(session.NewSession()) svc := applicationautoscaling.New(sess) params := &applicationautoscaling.DeregisterScalableTargetInput{ ResourceId: aws.String("ResourceIdMaxLen1600"), // Required ScalableDimension: aws.String("ScalableDimension"), // Required ServiceNamespace: aws.String("ServiceNamespace"), // Required } resp, err := svc.DeregisterScalableTarget(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*ApplicationAutoScaling) DeregisterScalableTargetRequest ¶
func (c *ApplicationAutoScaling) DeregisterScalableTargetRequest(input *DeregisterScalableTargetInput) (req *request.Request, output *DeregisterScalableTargetOutput)
DeregisterScalableTargetRequest generates a "aws/request.Request" representing the client's request for the DeregisterScalableTarget operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See DeregisterScalableTarget for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeregisterScalableTarget method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the DeregisterScalableTargetRequest method. req, resp := client.DeregisterScalableTargetRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/application-autoscaling-2016-02-06/DeregisterScalableTarget
func (*ApplicationAutoScaling) DeregisterScalableTargetWithContext ¶ added in v1.8.0
func (c *ApplicationAutoScaling) DeregisterScalableTargetWithContext(ctx aws.Context, input *DeregisterScalableTargetInput, opts ...request.Option) (*DeregisterScalableTargetOutput, error)
DeregisterScalableTargetWithContext is the same as DeregisterScalableTarget with the addition of the ability to pass a context and additional request options.
See DeregisterScalableTarget 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 (*ApplicationAutoScaling) DescribeScalableTargets ¶
func (c *ApplicationAutoScaling) DescribeScalableTargets(input *DescribeScalableTargetsInput) (*DescribeScalableTargetsOutput, error)
DescribeScalableTargets API operation for Application Auto Scaling.
Provides descriptive information about the scalable targets in the specified namespace.
You can filter the results using the ResourceIds and ScalableDimension parameters.
To create a scalable target or update an existing one, see RegisterScalableTarget. If you are no longer using a scalable target, you can deregister it using DeregisterScalableTarget.
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 Application Auto Scaling's API operation DescribeScalableTargets for usage and error information.
Returned Error Codes:
ErrCodeValidationException "ValidationException" An exception was thrown for a validation issue. Review the available parameters for the API request.
ErrCodeInvalidNextTokenException "InvalidNextTokenException" The next token supplied was invalid.
ErrCodeConcurrentUpdateException "ConcurrentUpdateException" Concurrent updates caused an exception, for example, if you request an update to an Application Auto Scaling resource that already has a pending update.
ErrCodeInternalServiceException "InternalServiceException" The service encountered an internal error.
Please also see https://docs.aws.amazon.com/goto/WebAPI/application-autoscaling-2016-02-06/DescribeScalableTargets
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/applicationautoscaling" ) func main() { sess := session.Must(session.NewSession()) svc := applicationautoscaling.New(sess) params := &applicationautoscaling.DescribeScalableTargetsInput{ ServiceNamespace: aws.String("ServiceNamespace"), // Required MaxResults: aws.Int64(1), NextToken: aws.String("XmlString"), ResourceIds: []*string{ aws.String("ResourceIdMaxLen1600"), // Required // More values... }, ScalableDimension: aws.String("ScalableDimension"), } resp, err := svc.DescribeScalableTargets(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*ApplicationAutoScaling) DescribeScalableTargetsPages ¶
func (c *ApplicationAutoScaling) DescribeScalableTargetsPages(input *DescribeScalableTargetsInput, fn func(*DescribeScalableTargetsOutput, bool) bool) error
DescribeScalableTargetsPages iterates over the pages of a DescribeScalableTargets operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See DescribeScalableTargets method for more information on how to use this operation.
Note: This operation can generate multiple requests to a service.
// Example iterating over at most 3 pages of a DescribeScalableTargets operation. pageNum := 0 err := client.DescribeScalableTargetsPages(params, func(page *DescribeScalableTargetsOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })
func (*ApplicationAutoScaling) DescribeScalableTargetsPagesWithContext ¶ added in v1.8.0
func (c *ApplicationAutoScaling) DescribeScalableTargetsPagesWithContext(ctx aws.Context, input *DescribeScalableTargetsInput, fn func(*DescribeScalableTargetsOutput, bool) bool, opts ...request.Option) error
DescribeScalableTargetsPagesWithContext same as DescribeScalableTargetsPages except it takes a Context and allows setting request options on the pages.
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 (*ApplicationAutoScaling) DescribeScalableTargetsRequest ¶
func (c *ApplicationAutoScaling) DescribeScalableTargetsRequest(input *DescribeScalableTargetsInput) (req *request.Request, output *DescribeScalableTargetsOutput)
DescribeScalableTargetsRequest generates a "aws/request.Request" representing the client's request for the DescribeScalableTargets operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See DescribeScalableTargets for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DescribeScalableTargets method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the DescribeScalableTargetsRequest method. req, resp := client.DescribeScalableTargetsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/application-autoscaling-2016-02-06/DescribeScalableTargets
func (*ApplicationAutoScaling) DescribeScalableTargetsWithContext ¶ added in v1.8.0
func (c *ApplicationAutoScaling) DescribeScalableTargetsWithContext(ctx aws.Context, input *DescribeScalableTargetsInput, opts ...request.Option) (*DescribeScalableTargetsOutput, error)
DescribeScalableTargetsWithContext is the same as DescribeScalableTargets with the addition of the ability to pass a context and additional request options.
See DescribeScalableTargets 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 (*ApplicationAutoScaling) DescribeScalingActivities ¶
func (c *ApplicationAutoScaling) DescribeScalingActivities(input *DescribeScalingActivitiesInput) (*DescribeScalingActivitiesOutput, error)
DescribeScalingActivities API operation for Application Auto Scaling.
Provides descriptive information about the scaling activities in the specified namespace from the previous six weeks.
You can filter the results using the ResourceId and ScalableDimension parameters.
Scaling activities are triggered by CloudWatch alarms that are associated with scaling policies. To view the scaling policies for a service namespace, see DescribeScalingPolicies. To create a scaling policy or update an existing one, see PutScalingPolicy.
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 Application Auto Scaling's API operation DescribeScalingActivities for usage and error information.
Returned Error Codes:
ErrCodeValidationException "ValidationException" An exception was thrown for a validation issue. Review the available parameters for the API request.
ErrCodeInvalidNextTokenException "InvalidNextTokenException" The next token supplied was invalid.
ErrCodeConcurrentUpdateException "ConcurrentUpdateException" Concurrent updates caused an exception, for example, if you request an update to an Application Auto Scaling resource that already has a pending update.
ErrCodeInternalServiceException "InternalServiceException" The service encountered an internal error.
Please also see https://docs.aws.amazon.com/goto/WebAPI/application-autoscaling-2016-02-06/DescribeScalingActivities
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/applicationautoscaling" ) func main() { sess := session.Must(session.NewSession()) svc := applicationautoscaling.New(sess) params := &applicationautoscaling.DescribeScalingActivitiesInput{ ServiceNamespace: aws.String("ServiceNamespace"), // Required MaxResults: aws.Int64(1), NextToken: aws.String("XmlString"), ResourceId: aws.String("ResourceIdMaxLen1600"), ScalableDimension: aws.String("ScalableDimension"), } resp, err := svc.DescribeScalingActivities(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*ApplicationAutoScaling) DescribeScalingActivitiesPages ¶
func (c *ApplicationAutoScaling) DescribeScalingActivitiesPages(input *DescribeScalingActivitiesInput, fn func(*DescribeScalingActivitiesOutput, bool) bool) error
DescribeScalingActivitiesPages iterates over the pages of a DescribeScalingActivities operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See DescribeScalingActivities method for more information on how to use this operation.
Note: This operation can generate multiple requests to a service.
// Example iterating over at most 3 pages of a DescribeScalingActivities operation. pageNum := 0 err := client.DescribeScalingActivitiesPages(params, func(page *DescribeScalingActivitiesOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })
func (*ApplicationAutoScaling) DescribeScalingActivitiesPagesWithContext ¶ added in v1.8.0
func (c *ApplicationAutoScaling) DescribeScalingActivitiesPagesWithContext(ctx aws.Context, input *DescribeScalingActivitiesInput, fn func(*DescribeScalingActivitiesOutput, bool) bool, opts ...request.Option) error
DescribeScalingActivitiesPagesWithContext same as DescribeScalingActivitiesPages except it takes a Context and allows setting request options on the pages.
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 (*ApplicationAutoScaling) DescribeScalingActivitiesRequest ¶
func (c *ApplicationAutoScaling) DescribeScalingActivitiesRequest(input *DescribeScalingActivitiesInput) (req *request.Request, output *DescribeScalingActivitiesOutput)
DescribeScalingActivitiesRequest generates a "aws/request.Request" representing the client's request for the DescribeScalingActivities operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See DescribeScalingActivities for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DescribeScalingActivities method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the DescribeScalingActivitiesRequest method. req, resp := client.DescribeScalingActivitiesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/application-autoscaling-2016-02-06/DescribeScalingActivities
func (*ApplicationAutoScaling) DescribeScalingActivitiesWithContext ¶ added in v1.8.0
func (c *ApplicationAutoScaling) DescribeScalingActivitiesWithContext(ctx aws.Context, input *DescribeScalingActivitiesInput, opts ...request.Option) (*DescribeScalingActivitiesOutput, error)
DescribeScalingActivitiesWithContext is the same as DescribeScalingActivities with the addition of the ability to pass a context and additional request options.
See DescribeScalingActivities 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 (*ApplicationAutoScaling) DescribeScalingPolicies ¶
func (c *ApplicationAutoScaling) DescribeScalingPolicies(input *DescribeScalingPoliciesInput) (*DescribeScalingPoliciesOutput, error)
DescribeScalingPolicies API operation for Application Auto Scaling.
Provides descriptive information about the scaling policies in the specified namespace.
You can filter the results using the ResourceId, ScalableDimension, and PolicyNames parameters.
To create a scaling policy or update an existing one, see PutScalingPolicy. If you are no longer using a scaling policy, you can delete it using DeleteScalingPolicy.
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 Application Auto Scaling's API operation DescribeScalingPolicies for usage and error information.
Returned Error Codes:
ErrCodeValidationException "ValidationException" An exception was thrown for a validation issue. Review the available parameters for the API request.
ErrCodeFailedResourceAccessException "FailedResourceAccessException" Failed access to resources caused an exception. This exception currently only applies to DescribeScalingPolicies. It is thrown when Application Auto Scaling is unable to retrieve the alarms associated with a scaling policy due to a client error, for example, if the role ARN specified for a scalable target does not have the proper permissions to call the CloudWatch DescribeAlarms (http://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_DescribeAlarms.html) API operation on behalf of your account.
ErrCodeInvalidNextTokenException "InvalidNextTokenException" The next token supplied was invalid.
ErrCodeConcurrentUpdateException "ConcurrentUpdateException" Concurrent updates caused an exception, for example, if you request an update to an Application Auto Scaling resource that already has a pending update.
ErrCodeInternalServiceException "InternalServiceException" The service encountered an internal error.
Please also see https://docs.aws.amazon.com/goto/WebAPI/application-autoscaling-2016-02-06/DescribeScalingPolicies
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/applicationautoscaling" ) func main() { sess := session.Must(session.NewSession()) svc := applicationautoscaling.New(sess) params := &applicationautoscaling.DescribeScalingPoliciesInput{ ServiceNamespace: aws.String("ServiceNamespace"), // Required MaxResults: aws.Int64(1), NextToken: aws.String("XmlString"), PolicyNames: []*string{ aws.String("ResourceIdMaxLen1600"), // Required // More values... }, ResourceId: aws.String("ResourceIdMaxLen1600"), ScalableDimension: aws.String("ScalableDimension"), } resp, err := svc.DescribeScalingPolicies(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*ApplicationAutoScaling) DescribeScalingPoliciesPages ¶
func (c *ApplicationAutoScaling) DescribeScalingPoliciesPages(input *DescribeScalingPoliciesInput, fn func(*DescribeScalingPoliciesOutput, bool) bool) error
DescribeScalingPoliciesPages iterates over the pages of a DescribeScalingPolicies operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See DescribeScalingPolicies method for more information on how to use this operation.
Note: This operation can generate multiple requests to a service.
// Example iterating over at most 3 pages of a DescribeScalingPolicies operation. pageNum := 0 err := client.DescribeScalingPoliciesPages(params, func(page *DescribeScalingPoliciesOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })
func (*ApplicationAutoScaling) DescribeScalingPoliciesPagesWithContext ¶ added in v1.8.0
func (c *ApplicationAutoScaling) DescribeScalingPoliciesPagesWithContext(ctx aws.Context, input *DescribeScalingPoliciesInput, fn func(*DescribeScalingPoliciesOutput, bool) bool, opts ...request.Option) error
DescribeScalingPoliciesPagesWithContext same as DescribeScalingPoliciesPages except it takes a Context and allows setting request options on the pages.
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 (*ApplicationAutoScaling) DescribeScalingPoliciesRequest ¶
func (c *ApplicationAutoScaling) DescribeScalingPoliciesRequest(input *DescribeScalingPoliciesInput) (req *request.Request, output *DescribeScalingPoliciesOutput)
DescribeScalingPoliciesRequest generates a "aws/request.Request" representing the client's request for the DescribeScalingPolicies operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See DescribeScalingPolicies for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DescribeScalingPolicies method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the DescribeScalingPoliciesRequest method. req, resp := client.DescribeScalingPoliciesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/application-autoscaling-2016-02-06/DescribeScalingPolicies
func (*ApplicationAutoScaling) DescribeScalingPoliciesWithContext ¶ added in v1.8.0
func (c *ApplicationAutoScaling) DescribeScalingPoliciesWithContext(ctx aws.Context, input *DescribeScalingPoliciesInput, opts ...request.Option) (*DescribeScalingPoliciesOutput, error)
DescribeScalingPoliciesWithContext is the same as DescribeScalingPolicies with the addition of the ability to pass a context and additional request options.
See DescribeScalingPolicies 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 (*ApplicationAutoScaling) PutScalingPolicy ¶
func (c *ApplicationAutoScaling) PutScalingPolicy(input *PutScalingPolicyInput) (*PutScalingPolicyOutput, error)
PutScalingPolicy API operation for Application Auto Scaling.
Creates or updates a policy for an Application Auto Scaling scalable target.
Each scalable target is identified by a service namespace, resource ID, and scalable dimension. A scaling policy applies to the scalable target identified by those three attributes. You cannot create a scaling policy without first registering a scalable target using RegisterScalableTarget.
To update a policy, specify its policy name and the parameters that you want to change. Any parameters that you don't specify are not changed by this update request.
You can view the scaling policies for a service namespace using DescribeScalingPolicies. If you are no longer using a scaling policy, you can delete it using DeleteScalingPolicy.
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 Application Auto Scaling's API operation PutScalingPolicy for usage and error information.
Returned Error Codes:
ErrCodeValidationException "ValidationException" An exception was thrown for a validation issue. Review the available parameters for the API request.
ErrCodeLimitExceededException "LimitExceededException" Your account exceeded a limit. This exception is thrown when a per-account resource limit is exceeded. For more information, see Application Auto Scaling Limits (http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html#limits_as-app).
ErrCodeObjectNotFoundException "ObjectNotFoundException" The specified object could not be found. For any Put or Register API operation, which depends on the existence of a scalable target, this exception is thrown if the scalable target with the specified service namespace, resource ID, and scalable dimension does not exist. For any Delete or Deregister API operation, this exception is thrown if the resource that is to be deleted or deregistered cannot be found.
ErrCodeConcurrentUpdateException "ConcurrentUpdateException" Concurrent updates caused an exception, for example, if you request an update to an Application Auto Scaling resource that already has a pending update.
ErrCodeInternalServiceException "InternalServiceException" The service encountered an internal error.
Please also see https://docs.aws.amazon.com/goto/WebAPI/application-autoscaling-2016-02-06/PutScalingPolicy
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/applicationautoscaling" ) func main() { sess := session.Must(session.NewSession()) svc := applicationautoscaling.New(sess) params := &applicationautoscaling.PutScalingPolicyInput{ PolicyName: aws.String("PolicyName"), // Required ResourceId: aws.String("ResourceIdMaxLen1600"), // Required ScalableDimension: aws.String("ScalableDimension"), // Required ServiceNamespace: aws.String("ServiceNamespace"), // Required PolicyType: aws.String("PolicyType"), StepScalingPolicyConfiguration: &applicationautoscaling.StepScalingPolicyConfiguration{ AdjustmentType: aws.String("AdjustmentType"), Cooldown: aws.Int64(1), MetricAggregationType: aws.String("MetricAggregationType"), MinAdjustmentMagnitude: aws.Int64(1), StepAdjustments: []*applicationautoscaling.StepAdjustment{ { // Required ScalingAdjustment: aws.Int64(1), // Required MetricIntervalLowerBound: aws.Float64(1.0), MetricIntervalUpperBound: aws.Float64(1.0), }, // More values... }, }, } resp, err := svc.PutScalingPolicy(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*ApplicationAutoScaling) PutScalingPolicyRequest ¶
func (c *ApplicationAutoScaling) PutScalingPolicyRequest(input *PutScalingPolicyInput) (req *request.Request, output *PutScalingPolicyOutput)
PutScalingPolicyRequest generates a "aws/request.Request" representing the client's request for the PutScalingPolicy operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See PutScalingPolicy for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the PutScalingPolicy method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the PutScalingPolicyRequest method. req, resp := client.PutScalingPolicyRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/application-autoscaling-2016-02-06/PutScalingPolicy
func (*ApplicationAutoScaling) PutScalingPolicyWithContext ¶ added in v1.8.0
func (c *ApplicationAutoScaling) PutScalingPolicyWithContext(ctx aws.Context, input *PutScalingPolicyInput, opts ...request.Option) (*PutScalingPolicyOutput, error)
PutScalingPolicyWithContext is the same as PutScalingPolicy with the addition of the ability to pass a context and additional request options.
See PutScalingPolicy 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 (*ApplicationAutoScaling) RegisterScalableTarget ¶
func (c *ApplicationAutoScaling) RegisterScalableTarget(input *RegisterScalableTargetInput) (*RegisterScalableTargetOutput, error)
RegisterScalableTarget API operation for Application Auto Scaling.
Registers or updates a scalable target. A scalable target is a resource that Application Auto Scaling can scale out or scale in. After you have registered a scalable target, you can use this operation to update the minimum and maximum values for your scalable dimension.
After you register a scalable target, you can create and apply scaling policies using PutScalingPolicy. You can view the scaling policies for a service namespace using DescribeScalableTargets. If you are no longer using a scalable target, you can deregister it using DeregisterScalableTarget.
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 Application Auto Scaling's API operation RegisterScalableTarget for usage and error information.
Returned Error Codes:
ErrCodeValidationException "ValidationException" An exception was thrown for a validation issue. Review the available parameters for the API request.
ErrCodeLimitExceededException "LimitExceededException" Your account exceeded a limit. This exception is thrown when a per-account resource limit is exceeded. For more information, see Application Auto Scaling Limits (http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html#limits_as-app).
ErrCodeConcurrentUpdateException "ConcurrentUpdateException" Concurrent updates caused an exception, for example, if you request an update to an Application Auto Scaling resource that already has a pending update.
ErrCodeInternalServiceException "InternalServiceException" The service encountered an internal error.
Please also see https://docs.aws.amazon.com/goto/WebAPI/application-autoscaling-2016-02-06/RegisterScalableTarget
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/applicationautoscaling" ) func main() { sess := session.Must(session.NewSession()) svc := applicationautoscaling.New(sess) params := &applicationautoscaling.RegisterScalableTargetInput{ ResourceId: aws.String("ResourceIdMaxLen1600"), // Required ScalableDimension: aws.String("ScalableDimension"), // Required ServiceNamespace: aws.String("ServiceNamespace"), // Required MaxCapacity: aws.Int64(1), MinCapacity: aws.Int64(1), RoleARN: aws.String("ResourceIdMaxLen1600"), } resp, err := svc.RegisterScalableTarget(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*ApplicationAutoScaling) RegisterScalableTargetRequest ¶
func (c *ApplicationAutoScaling) RegisterScalableTargetRequest(input *RegisterScalableTargetInput) (req *request.Request, output *RegisterScalableTargetOutput)
RegisterScalableTargetRequest generates a "aws/request.Request" representing the client's request for the RegisterScalableTarget operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See RegisterScalableTarget for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the RegisterScalableTarget method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the RegisterScalableTargetRequest method. req, resp := client.RegisterScalableTargetRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/application-autoscaling-2016-02-06/RegisterScalableTarget
func (*ApplicationAutoScaling) RegisterScalableTargetWithContext ¶ added in v1.8.0
func (c *ApplicationAutoScaling) RegisterScalableTargetWithContext(ctx aws.Context, input *RegisterScalableTargetInput, opts ...request.Option) (*RegisterScalableTargetOutput, error)
RegisterScalableTargetWithContext is the same as RegisterScalableTarget with the addition of the ability to pass a context and additional request options.
See RegisterScalableTarget 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 DeleteScalingPolicyInput ¶
type DeleteScalingPolicyInput struct { // The name of the scaling policy. // // PolicyName is a required field PolicyName *string `min:"1" type:"string" required:"true"` // The identifier of the resource associated with the scalable target. This // string consists of the resource type and unique identifier. // // * ECS service - The resource type is service and the unique identifier // is the cluster name and service name. Example: service/default/sample-webapp. // // * Spot fleet request - The resource type is spot-fleet-request and the // unique identifier is the Spot fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE. // // * EMR cluster - The resource type is instancegroup and the unique identifier // is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0. // // * AppStream 2.0 fleet - The resource type is fleet and the unique identifier // is the fleet name. Example: fleet/sample-fleet. // // ResourceId is a required field ResourceId *string `min:"1" type:"string" required:"true"` // The scalable dimension. This string consists of the service namespace, resource // type, and scaling property. // // * ecs:service:DesiredCount - The desired task count of an ECS service. // // * ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot // fleet request. // // * elasticmapreduce:instancegroup:InstanceCount - The instance count of // an EMR Instance Group. // // * appstream:fleet:DesiredCapacity - The desired capacity of an AppStream // 2.0 fleet. // // ScalableDimension is a required field ScalableDimension *string `type:"string" required:"true" enum:"ScalableDimension"` // The namespace of the AWS service. For more information, see AWS Service Namespaces // (http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces) // in the Amazon Web Services General Reference. // // ServiceNamespace is a required field ServiceNamespace *string `type:"string" required:"true" enum:"ServiceNamespace"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/application-autoscaling-2016-02-06/DeleteScalingPolicyRequest
func (DeleteScalingPolicyInput) GoString ¶
func (s DeleteScalingPolicyInput) GoString() string
GoString returns the string representation
func (*DeleteScalingPolicyInput) SetPolicyName ¶ added in v1.5.1
func (s *DeleteScalingPolicyInput) SetPolicyName(v string) *DeleteScalingPolicyInput
SetPolicyName sets the PolicyName field's value.
func (*DeleteScalingPolicyInput) SetResourceId ¶ added in v1.5.1
func (s *DeleteScalingPolicyInput) SetResourceId(v string) *DeleteScalingPolicyInput
SetResourceId sets the ResourceId field's value.
func (*DeleteScalingPolicyInput) SetScalableDimension ¶ added in v1.5.1
func (s *DeleteScalingPolicyInput) SetScalableDimension(v string) *DeleteScalingPolicyInput
SetScalableDimension sets the ScalableDimension field's value.
func (*DeleteScalingPolicyInput) SetServiceNamespace ¶ added in v1.5.1
func (s *DeleteScalingPolicyInput) SetServiceNamespace(v string) *DeleteScalingPolicyInput
SetServiceNamespace sets the ServiceNamespace field's value.
func (DeleteScalingPolicyInput) String ¶
func (s DeleteScalingPolicyInput) String() string
String returns the string representation
func (*DeleteScalingPolicyInput) Validate ¶
func (s *DeleteScalingPolicyInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteScalingPolicyOutput ¶
type DeleteScalingPolicyOutput struct {
// contains filtered or unexported fields
}
Please also see https://docs.aws.amazon.com/goto/WebAPI/application-autoscaling-2016-02-06/DeleteScalingPolicyResponse
func (DeleteScalingPolicyOutput) GoString ¶
func (s DeleteScalingPolicyOutput) GoString() string
GoString returns the string representation
func (DeleteScalingPolicyOutput) String ¶
func (s DeleteScalingPolicyOutput) String() string
String returns the string representation
type DeregisterScalableTargetInput ¶
type DeregisterScalableTargetInput struct { // The identifier of the resource associated with the scalable target. This // string consists of the resource type and unique identifier. // // * ECS service - The resource type is service and the unique identifier // is the cluster name and service name. Example: service/default/sample-webapp. // // * Spot fleet request - The resource type is spot-fleet-request and the // unique identifier is the Spot fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE. // // * EMR cluster - The resource type is instancegroup and the unique identifier // is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0. // // * AppStream 2.0 fleet - The resource type is fleet and the unique identifier // is the fleet name. Example: fleet/sample-fleet. // // ResourceId is a required field ResourceId *string `min:"1" type:"string" required:"true"` // The scalable dimension associated with the scalable target. This string consists // of the service namespace, resource type, and scaling property. // // * ecs:service:DesiredCount - The desired task count of an ECS service. // // * ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot // fleet request. // // * elasticmapreduce:instancegroup:InstanceCount - The instance count of // an EMR Instance Group. // // * appstream:fleet:DesiredCapacity - The desired capacity of an AppStream // 2.0 fleet. // // ScalableDimension is a required field ScalableDimension *string `type:"string" required:"true" enum:"ScalableDimension"` // The namespace of the AWS service. For more information, see AWS Service Namespaces // (http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces) // in the Amazon Web Services General Reference. // // ServiceNamespace is a required field ServiceNamespace *string `type:"string" required:"true" enum:"ServiceNamespace"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/application-autoscaling-2016-02-06/DeregisterScalableTargetRequest
func (DeregisterScalableTargetInput) GoString ¶
func (s DeregisterScalableTargetInput) GoString() string
GoString returns the string representation
func (*DeregisterScalableTargetInput) SetResourceId ¶ added in v1.5.1
func (s *DeregisterScalableTargetInput) SetResourceId(v string) *DeregisterScalableTargetInput
SetResourceId sets the ResourceId field's value.
func (*DeregisterScalableTargetInput) SetScalableDimension ¶ added in v1.5.1
func (s *DeregisterScalableTargetInput) SetScalableDimension(v string) *DeregisterScalableTargetInput
SetScalableDimension sets the ScalableDimension field's value.
func (*DeregisterScalableTargetInput) SetServiceNamespace ¶ added in v1.5.1
func (s *DeregisterScalableTargetInput) SetServiceNamespace(v string) *DeregisterScalableTargetInput
SetServiceNamespace sets the ServiceNamespace field's value.
func (DeregisterScalableTargetInput) String ¶
func (s DeregisterScalableTargetInput) String() string
String returns the string representation
func (*DeregisterScalableTargetInput) Validate ¶
func (s *DeregisterScalableTargetInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeregisterScalableTargetOutput ¶
type DeregisterScalableTargetOutput struct {
// contains filtered or unexported fields
}
Please also see https://docs.aws.amazon.com/goto/WebAPI/application-autoscaling-2016-02-06/DeregisterScalableTargetResponse
func (DeregisterScalableTargetOutput) GoString ¶
func (s DeregisterScalableTargetOutput) GoString() string
GoString returns the string representation
func (DeregisterScalableTargetOutput) String ¶
func (s DeregisterScalableTargetOutput) String() string
String returns the string representation
type DescribeScalableTargetsInput ¶
type DescribeScalableTargetsInput struct { // The maximum number of scalable target results. This value can be between // 1 and 50. The default value is 50. // // If this parameter is used, the operation returns up to MaxResults results // at a time, along with a NextToken value. To get the next set of results, // include the NextToken value in a subsequent call. If this parameter is not // used, the operation returns up to 50 results and a NextToken value, if applicable. MaxResults *int64 `type:"integer"` // The token for the next set of results. NextToken *string `type:"string"` // The identifier of the resource associated with the scalable target. This // string consists of the resource type and unique identifier. If you specify // a scalable dimension, you must also specify a resource ID. // // * ECS service - The resource type is service and the unique identifier // is the cluster name and service name. Example: service/default/sample-webapp. // // * Spot fleet request - The resource type is spot-fleet-request and the // unique identifier is the Spot fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE. // // * EMR cluster - The resource type is instancegroup and the unique identifier // is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0. // // * AppStream 2.0 fleet - The resource type is fleet and the unique identifier // is the fleet name. Example: fleet/sample-fleet. ResourceIds []*string `type:"list"` // The scalable dimension associated with the scalable target. This string consists // of the service namespace, resource type, and scaling property. If you specify // a scalable dimension, you must also specify a resource ID. // // * ecs:service:DesiredCount - The desired task count of an ECS service. // // * ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot // fleet request. // // * elasticmapreduce:instancegroup:InstanceCount - The instance count of // an EMR Instance Group. // // * appstream:fleet:DesiredCapacity - The desired capacity of an AppStream // 2.0 fleet. ScalableDimension *string `type:"string" enum:"ScalableDimension"` // The namespace of the AWS service. For more information, see AWS Service Namespaces // (http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces) // in the Amazon Web Services General Reference. // // ServiceNamespace is a required field ServiceNamespace *string `type:"string" required:"true" enum:"ServiceNamespace"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/application-autoscaling-2016-02-06/DescribeScalableTargetsRequest
func (DescribeScalableTargetsInput) GoString ¶
func (s DescribeScalableTargetsInput) GoString() string
GoString returns the string representation
func (*DescribeScalableTargetsInput) SetMaxResults ¶ added in v1.5.1
func (s *DescribeScalableTargetsInput) SetMaxResults(v int64) *DescribeScalableTargetsInput
SetMaxResults sets the MaxResults field's value.
func (*DescribeScalableTargetsInput) SetNextToken ¶ added in v1.5.1
func (s *DescribeScalableTargetsInput) SetNextToken(v string) *DescribeScalableTargetsInput
SetNextToken sets the NextToken field's value.
func (*DescribeScalableTargetsInput) SetResourceIds ¶ added in v1.5.1
func (s *DescribeScalableTargetsInput) SetResourceIds(v []*string) *DescribeScalableTargetsInput
SetResourceIds sets the ResourceIds field's value.
func (*DescribeScalableTargetsInput) SetScalableDimension ¶ added in v1.5.1
func (s *DescribeScalableTargetsInput) SetScalableDimension(v string) *DescribeScalableTargetsInput
SetScalableDimension sets the ScalableDimension field's value.
func (*DescribeScalableTargetsInput) SetServiceNamespace ¶ added in v1.5.1
func (s *DescribeScalableTargetsInput) SetServiceNamespace(v string) *DescribeScalableTargetsInput
SetServiceNamespace sets the ServiceNamespace field's value.
func (DescribeScalableTargetsInput) String ¶
func (s DescribeScalableTargetsInput) String() string
String returns the string representation
func (*DescribeScalableTargetsInput) Validate ¶
func (s *DescribeScalableTargetsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeScalableTargetsOutput ¶
type DescribeScalableTargetsOutput struct { // The token required to get the next set of results. This value is null if // there are no more results to return. NextToken *string `type:"string"` // The list of scalable targets that matches the request parameters. ScalableTargets []*ScalableTarget `type:"list"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/application-autoscaling-2016-02-06/DescribeScalableTargetsResponse
func (DescribeScalableTargetsOutput) GoString ¶
func (s DescribeScalableTargetsOutput) GoString() string
GoString returns the string representation
func (*DescribeScalableTargetsOutput) SetNextToken ¶ added in v1.5.1
func (s *DescribeScalableTargetsOutput) SetNextToken(v string) *DescribeScalableTargetsOutput
SetNextToken sets the NextToken field's value.
func (*DescribeScalableTargetsOutput) SetScalableTargets ¶ added in v1.5.1
func (s *DescribeScalableTargetsOutput) SetScalableTargets(v []*ScalableTarget) *DescribeScalableTargetsOutput
SetScalableTargets sets the ScalableTargets field's value.
func (DescribeScalableTargetsOutput) String ¶
func (s DescribeScalableTargetsOutput) String() string
String returns the string representation
type DescribeScalingActivitiesInput ¶
type DescribeScalingActivitiesInput struct { // The maximum number of scalable target results. This value can be between // 1 and 50. The default value is 50. // // If this parameter is used, the operation returns up to MaxResults results // at a time, along with a NextToken value. To get the next set of results, // include the NextToken value in a subsequent call. If this parameter is not // used, the operation returns up to 50 results and a NextToken value, if applicable. MaxResults *int64 `type:"integer"` // The token for the next set of results. NextToken *string `type:"string"` // The identifier of the resource associated with the scaling activity. This // string consists of the resource type and unique identifier. If you specify // a scalable dimension, you must also specify a resource ID. // // * ECS service - The resource type is service and the unique identifier // is the cluster name and service name. Example: service/default/sample-webapp. // // * Spot fleet request - The resource type is spot-fleet-request and the // unique identifier is the Spot fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE. // // * EMR cluster - The resource type is instancegroup and the unique identifier // is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0. // // * AppStream 2.0 fleet - The resource type is fleet and the unique identifier // is the fleet name. Example: fleet/sample-fleet. ResourceId *string `min:"1" type:"string"` // The scalable dimension. This string consists of the service namespace, resource // type, and scaling property. If you specify a scalable dimension, you must // also specify a resource ID. // // * ecs:service:DesiredCount - The desired task count of an ECS service. // // * ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot // fleet request. // // * elasticmapreduce:instancegroup:InstanceCount - The instance count of // an EMR Instance Group. // // * appstream:fleet:DesiredCapacity - The desired capacity of an AppStream // 2.0 fleet. ScalableDimension *string `type:"string" enum:"ScalableDimension"` // The namespace of the AWS service. For more information, see AWS Service Namespaces // (http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces) // in the Amazon Web Services General Reference. // // ServiceNamespace is a required field ServiceNamespace *string `type:"string" required:"true" enum:"ServiceNamespace"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/application-autoscaling-2016-02-06/DescribeScalingActivitiesRequest
func (DescribeScalingActivitiesInput) GoString ¶
func (s DescribeScalingActivitiesInput) GoString() string
GoString returns the string representation
func (*DescribeScalingActivitiesInput) SetMaxResults ¶ added in v1.5.1
func (s *DescribeScalingActivitiesInput) SetMaxResults(v int64) *DescribeScalingActivitiesInput
SetMaxResults sets the MaxResults field's value.
func (*DescribeScalingActivitiesInput) SetNextToken ¶ added in v1.5.1
func (s *DescribeScalingActivitiesInput) SetNextToken(v string) *DescribeScalingActivitiesInput
SetNextToken sets the NextToken field's value.
func (*DescribeScalingActivitiesInput) SetResourceId ¶ added in v1.5.1
func (s *DescribeScalingActivitiesInput) SetResourceId(v string) *DescribeScalingActivitiesInput
SetResourceId sets the ResourceId field's value.
func (*DescribeScalingActivitiesInput) SetScalableDimension ¶ added in v1.5.1
func (s *DescribeScalingActivitiesInput) SetScalableDimension(v string) *DescribeScalingActivitiesInput
SetScalableDimension sets the ScalableDimension field's value.
func (*DescribeScalingActivitiesInput) SetServiceNamespace ¶ added in v1.5.1
func (s *DescribeScalingActivitiesInput) SetServiceNamespace(v string) *DescribeScalingActivitiesInput
SetServiceNamespace sets the ServiceNamespace field's value.
func (DescribeScalingActivitiesInput) String ¶
func (s DescribeScalingActivitiesInput) String() string
String returns the string representation
func (*DescribeScalingActivitiesInput) Validate ¶
func (s *DescribeScalingActivitiesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeScalingActivitiesOutput ¶
type DescribeScalingActivitiesOutput struct { // The token required to get the next set of results. This value is null if // there are no more results to return. NextToken *string `type:"string"` // A list of scaling activity objects. ScalingActivities []*ScalingActivity `type:"list"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/application-autoscaling-2016-02-06/DescribeScalingActivitiesResponse
func (DescribeScalingActivitiesOutput) GoString ¶
func (s DescribeScalingActivitiesOutput) GoString() string
GoString returns the string representation
func (*DescribeScalingActivitiesOutput) SetNextToken ¶ added in v1.5.1
func (s *DescribeScalingActivitiesOutput) SetNextToken(v string) *DescribeScalingActivitiesOutput
SetNextToken sets the NextToken field's value.
func (*DescribeScalingActivitiesOutput) SetScalingActivities ¶ added in v1.5.1
func (s *DescribeScalingActivitiesOutput) SetScalingActivities(v []*ScalingActivity) *DescribeScalingActivitiesOutput
SetScalingActivities sets the ScalingActivities field's value.
func (DescribeScalingActivitiesOutput) String ¶
func (s DescribeScalingActivitiesOutput) String() string
String returns the string representation
type DescribeScalingPoliciesInput ¶
type DescribeScalingPoliciesInput struct { // The maximum number of scalable target results. This value can be between // 1 and 50. The default value is 50. // // If this parameter is used, the operation returns up to MaxResults results // at a time, along with a NextToken value. To get the next set of results, // include the NextToken value in a subsequent call. If this parameter is not // used, the operation returns up to 50 results and a NextToken value, if applicable. MaxResults *int64 `type:"integer"` // The token for the next set of results. NextToken *string `type:"string"` // The names of the scaling policies to describe. PolicyNames []*string `type:"list"` // The identifier of the resource associated with the scaling policy. This string // consists of the resource type and unique identifier. If you specify a scalable // dimension, you must also specify a resource ID. // // * ECS service - The resource type is service and the unique identifier // is the cluster name and service name. Example: service/default/sample-webapp. // // * Spot fleet request - The resource type is spot-fleet-request and the // unique identifier is the Spot fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE. // // * EMR cluster - The resource type is instancegroup and the unique identifier // is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0. // // * AppStream 2.0 fleet - The resource type is fleet and the unique identifier // is the fleet name. Example: fleet/sample-fleet. ResourceId *string `min:"1" type:"string"` // The scalable dimension. This string consists of the service namespace, resource // type, and scaling property. If you specify a scalable dimension, you must // also specify a resource ID. // // * ecs:service:DesiredCount - The desired task count of an ECS service. // // * ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot // fleet request. // // * elasticmapreduce:instancegroup:InstanceCount - The instance count of // an EMR Instance Group. // // * appstream:fleet:DesiredCapacity - The desired capacity of an AppStream // 2.0 fleet. ScalableDimension *string `type:"string" enum:"ScalableDimension"` // The namespace of the AWS service. For more information, see AWS Service Namespaces // (http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces) // in the Amazon Web Services General Reference. // // ServiceNamespace is a required field ServiceNamespace *string `type:"string" required:"true" enum:"ServiceNamespace"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/application-autoscaling-2016-02-06/DescribeScalingPoliciesRequest
func (DescribeScalingPoliciesInput) GoString ¶
func (s DescribeScalingPoliciesInput) GoString() string
GoString returns the string representation
func (*DescribeScalingPoliciesInput) SetMaxResults ¶ added in v1.5.1
func (s *DescribeScalingPoliciesInput) SetMaxResults(v int64) *DescribeScalingPoliciesInput
SetMaxResults sets the MaxResults field's value.
func (*DescribeScalingPoliciesInput) SetNextToken ¶ added in v1.5.1
func (s *DescribeScalingPoliciesInput) SetNextToken(v string) *DescribeScalingPoliciesInput
SetNextToken sets the NextToken field's value.
func (*DescribeScalingPoliciesInput) SetPolicyNames ¶ added in v1.5.1
func (s *DescribeScalingPoliciesInput) SetPolicyNames(v []*string) *DescribeScalingPoliciesInput
SetPolicyNames sets the PolicyNames field's value.
func (*DescribeScalingPoliciesInput) SetResourceId ¶ added in v1.5.1
func (s *DescribeScalingPoliciesInput) SetResourceId(v string) *DescribeScalingPoliciesInput
SetResourceId sets the ResourceId field's value.
func (*DescribeScalingPoliciesInput) SetScalableDimension ¶ added in v1.5.1
func (s *DescribeScalingPoliciesInput) SetScalableDimension(v string) *DescribeScalingPoliciesInput
SetScalableDimension sets the ScalableDimension field's value.
func (*DescribeScalingPoliciesInput) SetServiceNamespace ¶ added in v1.5.1
func (s *DescribeScalingPoliciesInput) SetServiceNamespace(v string) *DescribeScalingPoliciesInput
SetServiceNamespace sets the ServiceNamespace field's value.
func (DescribeScalingPoliciesInput) String ¶
func (s DescribeScalingPoliciesInput) String() string
String returns the string representation
func (*DescribeScalingPoliciesInput) Validate ¶
func (s *DescribeScalingPoliciesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeScalingPoliciesOutput ¶
type DescribeScalingPoliciesOutput struct { // The token required to get the next set of results. This value is null if // there are no more results to return. NextToken *string `type:"string"` // A list of scaling policy objects. ScalingPolicies []*ScalingPolicy `type:"list"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/application-autoscaling-2016-02-06/DescribeScalingPoliciesResponse
func (DescribeScalingPoliciesOutput) GoString ¶
func (s DescribeScalingPoliciesOutput) GoString() string
GoString returns the string representation
func (*DescribeScalingPoliciesOutput) SetNextToken ¶ added in v1.5.1
func (s *DescribeScalingPoliciesOutput) SetNextToken(v string) *DescribeScalingPoliciesOutput
SetNextToken sets the NextToken field's value.
func (*DescribeScalingPoliciesOutput) SetScalingPolicies ¶ added in v1.5.1
func (s *DescribeScalingPoliciesOutput) SetScalingPolicies(v []*ScalingPolicy) *DescribeScalingPoliciesOutput
SetScalingPolicies sets the ScalingPolicies field's value.
func (DescribeScalingPoliciesOutput) String ¶
func (s DescribeScalingPoliciesOutput) String() string
String returns the string representation
type PutScalingPolicyInput ¶
type PutScalingPolicyInput struct { // The name of the scaling policy. // // PolicyName is a required field PolicyName *string `min:"1" type:"string" required:"true"` // The policy type. If you are creating a new policy, this parameter is required. // If you are updating a policy, this parameter is not required. PolicyType *string `type:"string" enum:"PolicyType"` // The identifier of the resource associated with the scaling policy. This string // consists of the resource type and unique identifier. // // * ECS service - The resource type is service and the unique identifier // is the cluster name and service name. Example: service/default/sample-webapp. // // * Spot fleet request - The resource type is spot-fleet-request and the // unique identifier is the Spot fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE. // // * EMR cluster - The resource type is instancegroup and the unique identifier // is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0. // // * AppStream 2.0 fleet - The resource type is fleet and the unique identifier // is the fleet name. Example: fleet/sample-fleet. // // ResourceId is a required field ResourceId *string `min:"1" type:"string" required:"true"` // The scalable dimension. This string consists of the service namespace, resource // type, and scaling property. // // * ecs:service:DesiredCount - The desired task count of an ECS service. // // * ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot // fleet request. // // * elasticmapreduce:instancegroup:InstanceCount - The instance count of // an EMR Instance Group. // // * appstream:fleet:DesiredCapacity - The desired capacity of an AppStream // 2.0 fleet. // // ScalableDimension is a required field ScalableDimension *string `type:"string" required:"true" enum:"ScalableDimension"` // The namespace of the AWS service. For more information, see AWS Service Namespaces // (http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces) // in the Amazon Web Services General Reference. // // ServiceNamespace is a required field ServiceNamespace *string `type:"string" required:"true" enum:"ServiceNamespace"` // The configuration for the step scaling policy. If you are creating a new // policy, this parameter is required. If you are updating a policy, this parameter // is not required. For more information, see StepScalingPolicyConfiguration // and StepAdjustment. StepScalingPolicyConfiguration *StepScalingPolicyConfiguration `type:"structure"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/application-autoscaling-2016-02-06/PutScalingPolicyRequest
func (PutScalingPolicyInput) GoString ¶
func (s PutScalingPolicyInput) GoString() string
GoString returns the string representation
func (*PutScalingPolicyInput) SetPolicyName ¶ added in v1.5.1
func (s *PutScalingPolicyInput) SetPolicyName(v string) *PutScalingPolicyInput
SetPolicyName sets the PolicyName field's value.
func (*PutScalingPolicyInput) SetPolicyType ¶ added in v1.5.1
func (s *PutScalingPolicyInput) SetPolicyType(v string) *PutScalingPolicyInput
SetPolicyType sets the PolicyType field's value.
func (*PutScalingPolicyInput) SetResourceId ¶ added in v1.5.1
func (s *PutScalingPolicyInput) SetResourceId(v string) *PutScalingPolicyInput
SetResourceId sets the ResourceId field's value.
func (*PutScalingPolicyInput) SetScalableDimension ¶ added in v1.5.1
func (s *PutScalingPolicyInput) SetScalableDimension(v string) *PutScalingPolicyInput
SetScalableDimension sets the ScalableDimension field's value.
func (*PutScalingPolicyInput) SetServiceNamespace ¶ added in v1.5.1
func (s *PutScalingPolicyInput) SetServiceNamespace(v string) *PutScalingPolicyInput
SetServiceNamespace sets the ServiceNamespace field's value.
func (*PutScalingPolicyInput) SetStepScalingPolicyConfiguration ¶ added in v1.5.1
func (s *PutScalingPolicyInput) SetStepScalingPolicyConfiguration(v *StepScalingPolicyConfiguration) *PutScalingPolicyInput
SetStepScalingPolicyConfiguration sets the StepScalingPolicyConfiguration field's value.
func (PutScalingPolicyInput) String ¶
func (s PutScalingPolicyInput) String() string
String returns the string representation
func (*PutScalingPolicyInput) Validate ¶
func (s *PutScalingPolicyInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type PutScalingPolicyOutput ¶
type PutScalingPolicyOutput struct { // The Amazon Resource Name (ARN) of the resulting scaling policy. // // PolicyARN is a required field PolicyARN *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/application-autoscaling-2016-02-06/PutScalingPolicyResponse
func (PutScalingPolicyOutput) GoString ¶
func (s PutScalingPolicyOutput) GoString() string
GoString returns the string representation
func (*PutScalingPolicyOutput) SetPolicyARN ¶ added in v1.5.1
func (s *PutScalingPolicyOutput) SetPolicyARN(v string) *PutScalingPolicyOutput
SetPolicyARN sets the PolicyARN field's value.
func (PutScalingPolicyOutput) String ¶
func (s PutScalingPolicyOutput) String() string
String returns the string representation
type RegisterScalableTargetInput ¶
type RegisterScalableTargetInput struct { // The maximum value to scale to in response to a scale out event. This parameter // is required if you are registering a scalable target and optional if you // are updating one. MaxCapacity *int64 `type:"integer"` // The minimum value to scale to in response to a scale in event. This parameter // is required if you are registering a scalable target and optional if you // are updating one. MinCapacity *int64 `type:"integer"` // The identifier of the resource associated with the scalable target. This // string consists of the resource type and unique identifier. // // * ECS service - The resource type is service and the unique identifier // is the cluster name and service name. Example: service/default/sample-webapp. // // * Spot fleet request - The resource type is spot-fleet-request and the // unique identifier is the Spot fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE. // // * EMR cluster - The resource type is instancegroup and the unique identifier // is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0. // // * AppStream 2.0 fleet - The resource type is fleet and the unique identifier // is the fleet name. Example: fleet/sample-fleet. // // ResourceId is a required field ResourceId *string `min:"1" type:"string" required:"true"` // The ARN of an IAM role that allows Application Auto Scaling to modify the // scalable target on your behalf. This parameter is required when you register // a scalable target and optional when you update one. RoleARN *string `min:"1" type:"string"` // The scalable dimension associated with the scalable target. This string consists // of the service namespace, resource type, and scaling property. // // * ecs:service:DesiredCount - The desired task count of an ECS service. // // * ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot // fleet request. // // * elasticmapreduce:instancegroup:InstanceCount - The instance count of // an EMR Instance Group. // // * appstream:fleet:DesiredCapacity - The desired capacity of an AppStream // 2.0 fleet. // // ScalableDimension is a required field ScalableDimension *string `type:"string" required:"true" enum:"ScalableDimension"` // The namespace of the AWS service. For more information, see AWS Service Namespaces // (http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces) // in the Amazon Web Services General Reference. // // ServiceNamespace is a required field ServiceNamespace *string `type:"string" required:"true" enum:"ServiceNamespace"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/application-autoscaling-2016-02-06/RegisterScalableTargetRequest
func (RegisterScalableTargetInput) GoString ¶
func (s RegisterScalableTargetInput) GoString() string
GoString returns the string representation
func (*RegisterScalableTargetInput) SetMaxCapacity ¶ added in v1.5.1
func (s *RegisterScalableTargetInput) SetMaxCapacity(v int64) *RegisterScalableTargetInput
SetMaxCapacity sets the MaxCapacity field's value.
func (*RegisterScalableTargetInput) SetMinCapacity ¶ added in v1.5.1
func (s *RegisterScalableTargetInput) SetMinCapacity(v int64) *RegisterScalableTargetInput
SetMinCapacity sets the MinCapacity field's value.
func (*RegisterScalableTargetInput) SetResourceId ¶ added in v1.5.1
func (s *RegisterScalableTargetInput) SetResourceId(v string) *RegisterScalableTargetInput
SetResourceId sets the ResourceId field's value.
func (*RegisterScalableTargetInput) SetRoleARN ¶ added in v1.5.1
func (s *RegisterScalableTargetInput) SetRoleARN(v string) *RegisterScalableTargetInput
SetRoleARN sets the RoleARN field's value.
func (*RegisterScalableTargetInput) SetScalableDimension ¶ added in v1.5.1
func (s *RegisterScalableTargetInput) SetScalableDimension(v string) *RegisterScalableTargetInput
SetScalableDimension sets the ScalableDimension field's value.
func (*RegisterScalableTargetInput) SetServiceNamespace ¶ added in v1.5.1
func (s *RegisterScalableTargetInput) SetServiceNamespace(v string) *RegisterScalableTargetInput
SetServiceNamespace sets the ServiceNamespace field's value.
func (RegisterScalableTargetInput) String ¶
func (s RegisterScalableTargetInput) String() string
String returns the string representation
func (*RegisterScalableTargetInput) Validate ¶
func (s *RegisterScalableTargetInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type RegisterScalableTargetOutput ¶
type RegisterScalableTargetOutput struct {
// contains filtered or unexported fields
}
Please also see https://docs.aws.amazon.com/goto/WebAPI/application-autoscaling-2016-02-06/RegisterScalableTargetResponse
func (RegisterScalableTargetOutput) GoString ¶
func (s RegisterScalableTargetOutput) GoString() string
GoString returns the string representation
func (RegisterScalableTargetOutput) String ¶
func (s RegisterScalableTargetOutput) String() string
String returns the string representation
type ScalableTarget ¶
type ScalableTarget struct { // The Unix timestamp for when the scalable target was created. // // CreationTime is a required field CreationTime *time.Time `type:"timestamp" timestampFormat:"unix" required:"true"` // The maximum value to scale to in response to a scale out event. // // MaxCapacity is a required field MaxCapacity *int64 `type:"integer" required:"true"` // The minimum value to scale to in response to a scale in event. // // MinCapacity is a required field MinCapacity *int64 `type:"integer" required:"true"` // The identifier of the resource associated with the scalable target. This // string consists of the resource type and unique identifier. // // * ECS service - The resource type is service and the unique identifier // is the cluster name and service name. Example: service/default/sample-webapp. // // * Spot fleet request - The resource type is spot-fleet-request and the // unique identifier is the Spot fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE. // // * EMR cluster - The resource type is instancegroup and the unique identifier // is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0. // // * AppStream 2.0 fleet - The resource type is fleet and the unique identifier // is the fleet name. Example: fleet/sample-fleet. // // ResourceId is a required field ResourceId *string `min:"1" type:"string" required:"true"` // The ARN of an IAM role that allows Application Auto Scaling to modify the // scalable target on your behalf. // // RoleARN is a required field RoleARN *string `min:"1" type:"string" required:"true"` // The scalable dimension associated with the scalable target. This string consists // of the service namespace, resource type, and scaling property. // // * ecs:service:DesiredCount - The desired task count of an ECS service. // // * ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot // fleet request. // // * elasticmapreduce:instancegroup:InstanceCount - The instance count of // an EMR Instance Group. // // * appstream:fleet:DesiredCapacity - The desired capacity of an AppStream // 2.0 fleet. // // ScalableDimension is a required field ScalableDimension *string `type:"string" required:"true" enum:"ScalableDimension"` // The namespace of the AWS service. For more information, see AWS Service Namespaces // (http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces) // in the Amazon Web Services General Reference. // // ServiceNamespace is a required field ServiceNamespace *string `type:"string" required:"true" enum:"ServiceNamespace"` // contains filtered or unexported fields }
Represents a scalable target. Please also see https://docs.aws.amazon.com/goto/WebAPI/application-autoscaling-2016-02-06/ScalableTarget
func (ScalableTarget) GoString ¶
func (s ScalableTarget) GoString() string
GoString returns the string representation
func (*ScalableTarget) SetCreationTime ¶ added in v1.5.1
func (s *ScalableTarget) SetCreationTime(v time.Time) *ScalableTarget
SetCreationTime sets the CreationTime field's value.
func (*ScalableTarget) SetMaxCapacity ¶ added in v1.5.1
func (s *ScalableTarget) SetMaxCapacity(v int64) *ScalableTarget
SetMaxCapacity sets the MaxCapacity field's value.
func (*ScalableTarget) SetMinCapacity ¶ added in v1.5.1
func (s *ScalableTarget) SetMinCapacity(v int64) *ScalableTarget
SetMinCapacity sets the MinCapacity field's value.
func (*ScalableTarget) SetResourceId ¶ added in v1.5.1
func (s *ScalableTarget) SetResourceId(v string) *ScalableTarget
SetResourceId sets the ResourceId field's value.
func (*ScalableTarget) SetRoleARN ¶ added in v1.5.1
func (s *ScalableTarget) SetRoleARN(v string) *ScalableTarget
SetRoleARN sets the RoleARN field's value.
func (*ScalableTarget) SetScalableDimension ¶ added in v1.5.1
func (s *ScalableTarget) SetScalableDimension(v string) *ScalableTarget
SetScalableDimension sets the ScalableDimension field's value.
func (*ScalableTarget) SetServiceNamespace ¶ added in v1.5.1
func (s *ScalableTarget) SetServiceNamespace(v string) *ScalableTarget
SetServiceNamespace sets the ServiceNamespace field's value.
func (ScalableTarget) String ¶
func (s ScalableTarget) String() string
String returns the string representation
type ScalingActivity ¶
type ScalingActivity struct { // The unique identifier of the scaling activity. // // ActivityId is a required field ActivityId *string `type:"string" required:"true"` // A simple description of what caused the scaling activity to happen. // // Cause is a required field Cause *string `type:"string" required:"true"` // A simple description of what action the scaling activity intends to accomplish. // // Description is a required field Description *string `type:"string" required:"true"` // The details about the scaling activity. Details *string `type:"string"` // The Unix timestamp for when the scaling activity ended. EndTime *time.Time `type:"timestamp" timestampFormat:"unix"` // The identifier of the resource associated with the scaling activity. This // string consists of the resource type and unique identifier. // // * ECS service - The resource type is service and the unique identifier // is the cluster name and service name. Example: service/default/sample-webapp. // // * Spot fleet request - The resource type is spot-fleet-request and the // unique identifier is the Spot fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE. // // * EMR cluster - The resource type is instancegroup and the unique identifier // is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0. // // * AppStream 2.0 fleet - The resource type is fleet and the unique identifier // is the fleet name. Example: fleet/sample-fleet. // // ResourceId is a required field ResourceId *string `min:"1" type:"string" required:"true"` // The scalable dimension. This string consists of the service namespace, resource // type, and scaling property. // // * ecs:service:DesiredCount - The desired task count of an ECS service. // // * ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot // fleet request. // // * elasticmapreduce:instancegroup:InstanceCount - The instance count of // an EMR Instance Group. // // * appstream:fleet:DesiredCapacity - The desired capacity of an AppStream // 2.0 fleet. // // ScalableDimension is a required field ScalableDimension *string `type:"string" required:"true" enum:"ScalableDimension"` // The namespace of the AWS service. For more information, see AWS Service Namespaces // (http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces) // in the Amazon Web Services General Reference. // // ServiceNamespace is a required field ServiceNamespace *string `type:"string" required:"true" enum:"ServiceNamespace"` // The Unix timestamp for when the scaling activity began. // // StartTime is a required field StartTime *time.Time `type:"timestamp" timestampFormat:"unix" required:"true"` // Indicates the status of the scaling activity. // // StatusCode is a required field StatusCode *string `type:"string" required:"true" enum:"ScalingActivityStatusCode"` // A simple message about the current status of the scaling activity. StatusMessage *string `type:"string"` // contains filtered or unexported fields }
Represents a scaling activity. Please also see https://docs.aws.amazon.com/goto/WebAPI/application-autoscaling-2016-02-06/ScalingActivity
func (ScalingActivity) GoString ¶
func (s ScalingActivity) GoString() string
GoString returns the string representation
func (*ScalingActivity) SetActivityId ¶ added in v1.5.1
func (s *ScalingActivity) SetActivityId(v string) *ScalingActivity
SetActivityId sets the ActivityId field's value.
func (*ScalingActivity) SetCause ¶ added in v1.5.1
func (s *ScalingActivity) SetCause(v string) *ScalingActivity
SetCause sets the Cause field's value.
func (*ScalingActivity) SetDescription ¶ added in v1.5.1
func (s *ScalingActivity) SetDescription(v string) *ScalingActivity
SetDescription sets the Description field's value.
func (*ScalingActivity) SetDetails ¶ added in v1.5.1
func (s *ScalingActivity) SetDetails(v string) *ScalingActivity
SetDetails sets the Details field's value.
func (*ScalingActivity) SetEndTime ¶ added in v1.5.1
func (s *ScalingActivity) SetEndTime(v time.Time) *ScalingActivity
SetEndTime sets the EndTime field's value.
func (*ScalingActivity) SetResourceId ¶ added in v1.5.1
func (s *ScalingActivity) SetResourceId(v string) *ScalingActivity
SetResourceId sets the ResourceId field's value.
func (*ScalingActivity) SetScalableDimension ¶ added in v1.5.1
func (s *ScalingActivity) SetScalableDimension(v string) *ScalingActivity
SetScalableDimension sets the ScalableDimension field's value.
func (*ScalingActivity) SetServiceNamespace ¶ added in v1.5.1
func (s *ScalingActivity) SetServiceNamespace(v string) *ScalingActivity
SetServiceNamespace sets the ServiceNamespace field's value.
func (*ScalingActivity) SetStartTime ¶ added in v1.5.1
func (s *ScalingActivity) SetStartTime(v time.Time) *ScalingActivity
SetStartTime sets the StartTime field's value.
func (*ScalingActivity) SetStatusCode ¶ added in v1.5.1
func (s *ScalingActivity) SetStatusCode(v string) *ScalingActivity
SetStatusCode sets the StatusCode field's value.
func (*ScalingActivity) SetStatusMessage ¶ added in v1.5.1
func (s *ScalingActivity) SetStatusMessage(v string) *ScalingActivity
SetStatusMessage sets the StatusMessage field's value.
func (ScalingActivity) String ¶
func (s ScalingActivity) String() string
String returns the string representation
type ScalingPolicy ¶
type ScalingPolicy struct { // The CloudWatch alarms associated with the scaling policy. Alarms []*Alarm `type:"list"` // The Unix timestamp for when the scaling policy was created. // // CreationTime is a required field CreationTime *time.Time `type:"timestamp" timestampFormat:"unix" required:"true"` // The Amazon Resource Name (ARN) of the scaling policy. // // PolicyARN is a required field PolicyARN *string `min:"1" type:"string" required:"true"` // The name of the scaling policy. // // PolicyName is a required field PolicyName *string `min:"1" type:"string" required:"true"` // The scaling policy type. // // PolicyType is a required field PolicyType *string `type:"string" required:"true" enum:"PolicyType"` // The identifier of the resource associated with the scaling policy. This string // consists of the resource type and unique identifier. // // * ECS service - The resource type is service and the unique identifier // is the cluster name and service name. Example: service/default/sample-webapp. // // * Spot fleet request - The resource type is spot-fleet-request and the // unique identifier is the Spot fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE. // // * EMR cluster - The resource type is instancegroup and the unique identifier // is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0. // // * AppStream 2.0 fleet - The resource type is fleet and the unique identifier // is the fleet name. Example: fleet/sample-fleet. // // ResourceId is a required field ResourceId *string `min:"1" type:"string" required:"true"` // The scalable dimension. This string consists of the service namespace, resource // type, and scaling property. // // * ecs:service:DesiredCount - The desired task count of an ECS service. // // * ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot // fleet request. // // * elasticmapreduce:instancegroup:InstanceCount - The instance count of // an EMR Instance Group. // // * appstream:fleet:DesiredCapacity - The desired capacity of an AppStream // 2.0 fleet. // // ScalableDimension is a required field ScalableDimension *string `type:"string" required:"true" enum:"ScalableDimension"` // The namespace of the AWS service. For more information, see AWS Service Namespaces // (http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces) // in the Amazon Web Services General Reference. // // ServiceNamespace is a required field ServiceNamespace *string `type:"string" required:"true" enum:"ServiceNamespace"` // The configuration for the step scaling policy. StepScalingPolicyConfiguration *StepScalingPolicyConfiguration `type:"structure"` // contains filtered or unexported fields }
Represents a scaling policy. Please also see https://docs.aws.amazon.com/goto/WebAPI/application-autoscaling-2016-02-06/ScalingPolicy
func (ScalingPolicy) GoString ¶
func (s ScalingPolicy) GoString() string
GoString returns the string representation
func (*ScalingPolicy) SetAlarms ¶ added in v1.5.1
func (s *ScalingPolicy) SetAlarms(v []*Alarm) *ScalingPolicy
SetAlarms sets the Alarms field's value.
func (*ScalingPolicy) SetCreationTime ¶ added in v1.5.1
func (s *ScalingPolicy) SetCreationTime(v time.Time) *ScalingPolicy
SetCreationTime sets the CreationTime field's value.
func (*ScalingPolicy) SetPolicyARN ¶ added in v1.5.1
func (s *ScalingPolicy) SetPolicyARN(v string) *ScalingPolicy
SetPolicyARN sets the PolicyARN field's value.
func (*ScalingPolicy) SetPolicyName ¶ added in v1.5.1
func (s *ScalingPolicy) SetPolicyName(v string) *ScalingPolicy
SetPolicyName sets the PolicyName field's value.
func (*ScalingPolicy) SetPolicyType ¶ added in v1.5.1
func (s *ScalingPolicy) SetPolicyType(v string) *ScalingPolicy
SetPolicyType sets the PolicyType field's value.
func (*ScalingPolicy) SetResourceId ¶ added in v1.5.1
func (s *ScalingPolicy) SetResourceId(v string) *ScalingPolicy
SetResourceId sets the ResourceId field's value.
func (*ScalingPolicy) SetScalableDimension ¶ added in v1.5.1
func (s *ScalingPolicy) SetScalableDimension(v string) *ScalingPolicy
SetScalableDimension sets the ScalableDimension field's value.
func (*ScalingPolicy) SetServiceNamespace ¶ added in v1.5.1
func (s *ScalingPolicy) SetServiceNamespace(v string) *ScalingPolicy
SetServiceNamespace sets the ServiceNamespace field's value.
func (*ScalingPolicy) SetStepScalingPolicyConfiguration ¶ added in v1.5.1
func (s *ScalingPolicy) SetStepScalingPolicyConfiguration(v *StepScalingPolicyConfiguration) *ScalingPolicy
SetStepScalingPolicyConfiguration sets the StepScalingPolicyConfiguration field's value.
func (ScalingPolicy) String ¶
func (s ScalingPolicy) String() string
String returns the string representation
type StepAdjustment ¶
type StepAdjustment struct { // The lower bound for the difference between the alarm threshold and the CloudWatch // metric. If the metric value is above the breach threshold, the lower bound // is inclusive (the metric must be greater than or equal to the threshold plus // the lower bound). Otherwise, it is exclusive (the metric must be greater // than the threshold plus the lower bound). A null value indicates negative // infinity. MetricIntervalLowerBound *float64 `type:"double"` // The upper bound for the difference between the alarm threshold and the CloudWatch // metric. If the metric value is above the breach threshold, the upper bound // is exclusive (the metric must be less than the threshold plus the upper bound). // Otherwise, it is inclusive (the metric must be less than or equal to the // threshold plus the upper bound). A null value indicates positive infinity. // // The upper bound must be greater than the lower bound. MetricIntervalUpperBound *float64 `type:"double"` // The amount by which to scale, based on the specified adjustment type. A positive // value adds to the current scalable dimension while a negative number removes // from the current scalable dimension. // // ScalingAdjustment is a required field ScalingAdjustment *int64 `type:"integer" required:"true"` // contains filtered or unexported fields }
Represents a step adjustment for a StepScalingPolicyConfiguration. Describes an adjustment based on the difference between the value of the aggregated CloudWatch metric and the breach threshold that you've defined for the alarm.
For the following examples, suppose that you have an alarm with a breach threshold of 50:
To trigger the adjustment when the metric is greater than or equal to 50 and less than 60, specify a lower bound of 0 and an upper bound of 10.
To trigger the adjustment when the metric is greater than 40 and less than or equal to 50, specify a lower bound of -10 and an upper bound of 0.
There are a few rules for the step adjustments for your step policy:
The ranges of your step adjustments can't overlap or have a gap.
At most one step adjustment can have a null lower bound. If one step adjustment has a negative lower bound, then there must be a step adjustment with a null lower bound.
At most one step adjustment can have a null upper bound. If one step adjustment has a positive upper bound, then there must be a step adjustment with a null upper bound.
The upper and lower bound can't be null in the same step adjustment.
Please also see https://docs.aws.amazon.com/goto/WebAPI/application-autoscaling-2016-02-06/StepAdjustment
func (StepAdjustment) GoString ¶
func (s StepAdjustment) GoString() string
GoString returns the string representation
func (*StepAdjustment) SetMetricIntervalLowerBound ¶ added in v1.5.1
func (s *StepAdjustment) SetMetricIntervalLowerBound(v float64) *StepAdjustment
SetMetricIntervalLowerBound sets the MetricIntervalLowerBound field's value.
func (*StepAdjustment) SetMetricIntervalUpperBound ¶ added in v1.5.1
func (s *StepAdjustment) SetMetricIntervalUpperBound(v float64) *StepAdjustment
SetMetricIntervalUpperBound sets the MetricIntervalUpperBound field's value.
func (*StepAdjustment) SetScalingAdjustment ¶ added in v1.5.1
func (s *StepAdjustment) SetScalingAdjustment(v int64) *StepAdjustment
SetScalingAdjustment sets the ScalingAdjustment field's value.
func (StepAdjustment) String ¶
func (s StepAdjustment) String() string
String returns the string representation
func (*StepAdjustment) Validate ¶
func (s *StepAdjustment) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type StepScalingPolicyConfiguration ¶
type StepScalingPolicyConfiguration struct { // The adjustment type, which specifies how the ScalingAdjustment parameter // in a StepAdjustment is interpreted. AdjustmentType *string `type:"string" enum:"AdjustmentType"` // The amount of time, in seconds, after a scaling activity completes where // previous trigger-related scaling activities can influence future scaling // events. // // For scale out policies, while Cooldown is in effect, the capacity that has // been added by the previous scale out event that initiated the Cooldown is // calculated as part of the desired capacity for the next scale out. The intention // is to continuously (but not excessively) scale out. For example, an alarm // triggers a step scaling policy to scale out an Amazon ECS service by 2 tasks, // the scaling activity completes successfully, and a Cooldown period of 5 minutes // starts. During the Cooldown period, if the alarm triggers the same policy // again but at a more aggressive step adjustment to scale out the service by // 3 tasks, the 2 tasks that were added in the previous scale out event are // considered part of that capacity and only 1 additional task is added to the // desired count. // // For scale in policies, the Cooldown period is used to block subsequent scale // in requests until it has expired. The intention is to scale in conservatively // to protect your application's availability. However, if another alarm triggers // a scale out policy during the Cooldown period after a scale-in, Application // Auto Scaling scales out your scalable target immediately. Cooldown *int64 `type:"integer"` // The aggregation type for the CloudWatch metrics. Valid values are Minimum, // Maximum, and Average. MetricAggregationType *string `type:"string" enum:"MetricAggregationType"` // The minimum number to adjust your scalable dimension as a result of a scaling // activity. If the adjustment type is PercentChangeInCapacity, the scaling // policy changes the scalable dimension of the scalable target by this amount. MinAdjustmentMagnitude *int64 `type:"integer"` // A set of adjustments that enable you to scale based on the size of the alarm // breach. StepAdjustments []*StepAdjustment `type:"list"` // contains filtered or unexported fields }
Represents a step scaling policy configuration. Please also see https://docs.aws.amazon.com/goto/WebAPI/application-autoscaling-2016-02-06/StepScalingPolicyConfiguration
func (StepScalingPolicyConfiguration) GoString ¶
func (s StepScalingPolicyConfiguration) GoString() string
GoString returns the string representation
func (*StepScalingPolicyConfiguration) SetAdjustmentType ¶ added in v1.5.1
func (s *StepScalingPolicyConfiguration) SetAdjustmentType(v string) *StepScalingPolicyConfiguration
SetAdjustmentType sets the AdjustmentType field's value.
func (*StepScalingPolicyConfiguration) SetCooldown ¶ added in v1.5.1
func (s *StepScalingPolicyConfiguration) SetCooldown(v int64) *StepScalingPolicyConfiguration
SetCooldown sets the Cooldown field's value.
func (*StepScalingPolicyConfiguration) SetMetricAggregationType ¶ added in v1.5.1
func (s *StepScalingPolicyConfiguration) SetMetricAggregationType(v string) *StepScalingPolicyConfiguration
SetMetricAggregationType sets the MetricAggregationType field's value.
func (*StepScalingPolicyConfiguration) SetMinAdjustmentMagnitude ¶ added in v1.5.1
func (s *StepScalingPolicyConfiguration) SetMinAdjustmentMagnitude(v int64) *StepScalingPolicyConfiguration
SetMinAdjustmentMagnitude sets the MinAdjustmentMagnitude field's value.
func (*StepScalingPolicyConfiguration) SetStepAdjustments ¶ added in v1.5.1
func (s *StepScalingPolicyConfiguration) SetStepAdjustments(v []*StepAdjustment) *StepScalingPolicyConfiguration
SetStepAdjustments sets the StepAdjustments field's value.
func (StepScalingPolicyConfiguration) String ¶
func (s StepScalingPolicyConfiguration) String() string
String returns the string representation
func (*StepScalingPolicyConfiguration) Validate ¶
func (s *StepScalingPolicyConfiguration) Validate() error
Validate inspects the fields of the type to determine if they are valid.
Directories ¶
Path | Synopsis |
---|---|
Package applicationautoscalingiface provides an interface to enable mocking the Application Auto Scaling service client for testing your code.
|
Package applicationautoscalingiface provides an interface to enable mocking the Application Auto Scaling service client for testing your code. |