applicationautoscaling

package
v1.49.24 Latest Latest
Warning

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

Go to latest
Published: Jan 18, 2024 License: Apache-2.0 Imports: 10 Imported by: 272

Documentation

Overview

Package applicationautoscaling provides the client and types for making API requests to Application Auto Scaling.

With Application Auto Scaling, you can configure automatic scaling for the following resources:

  • Amazon AppStream 2.0 fleets

  • Amazon Aurora Replicas

  • Amazon Comprehend document classification and entity recognizer endpoints

  • Amazon DynamoDB tables and global secondary indexes throughput capacity

  • Amazon ECS services

  • Amazon ElastiCache for Redis clusters (replication groups)

  • Amazon EMR clusters

  • Amazon Keyspaces (for Apache Cassandra) tables

  • Lambda function provisioned concurrency

  • Amazon Managed Streaming for Apache Kafka broker storage

  • Amazon Neptune clusters

  • Amazon SageMaker endpoint variants

  • Amazon SageMaker Serverless endpoint provisioned concurrency

  • Amazon SageMaker inference components

  • Spot Fleets (Amazon EC2)

  • Custom resources provided by your own applications or services

To learn more about Application Auto Scaling, see the Application Auto Scaling User Guide (https://docs.aws.amazon.com/autoscaling/application/userguide/what-is-application-auto-scaling.html).

API Summary

The Application Auto Scaling service API includes three key sets of actions:

  • Register and manage scalable targets - Register Amazon Web Services or custom resources as scalable targets (a resource that Application Auto Scaling can scale), set minimum and maximum capacity limits, and retrieve information on existing scalable targets.

  • Configure and manage automatic scaling - Define scaling policies to dynamically scale your resources in response to CloudWatch alarms, schedule one-time or recurring scaling actions, and retrieve your recent scaling activity history.

  • Suspend and resume scaling - Temporarily suspend and later resume automatic scaling by calling the RegisterScalableTarget (https://docs.aws.amazon.com/autoscaling/application/APIReference/API_RegisterScalableTarget.html) API action for any Application Auto Scaling scalable target. You can suspend and resume (individually or in combination) scale-out activities that are triggered by a scaling policy, scale-in activities that are triggered by a scaling policy, and scheduled scaling.

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 contact Application Auto Scaling with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

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

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

See the Application Auto Scaling client ApplicationAutoScaling for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/applicationautoscaling/#New

Index

Examples

Constants

View Source
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"
)
View Source
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"
)
View Source
const (
	// MetricStatisticAverage is a MetricStatistic enum value
	MetricStatisticAverage = "Average"

	// MetricStatisticMinimum is a MetricStatistic enum value
	MetricStatisticMinimum = "Minimum"

	// MetricStatisticMaximum is a MetricStatistic enum value
	MetricStatisticMaximum = "Maximum"

	// MetricStatisticSampleCount is a MetricStatistic enum value
	MetricStatisticSampleCount = "SampleCount"

	// MetricStatisticSum is a MetricStatistic enum value
	MetricStatisticSum = "Sum"
)
View Source
const (
	// MetricTypeDynamoDbreadCapacityUtilization is a MetricType enum value
	MetricTypeDynamoDbreadCapacityUtilization = "DynamoDBReadCapacityUtilization"

	// MetricTypeDynamoDbwriteCapacityUtilization is a MetricType enum value
	MetricTypeDynamoDbwriteCapacityUtilization = "DynamoDBWriteCapacityUtilization"

	// MetricTypeAlbrequestCountPerTarget is a MetricType enum value
	MetricTypeAlbrequestCountPerTarget = "ALBRequestCountPerTarget"

	// MetricTypeRdsreaderAverageCpuutilization is a MetricType enum value
	MetricTypeRdsreaderAverageCpuutilization = "RDSReaderAverageCPUUtilization"

	// MetricTypeRdsreaderAverageDatabaseConnections is a MetricType enum value
	MetricTypeRdsreaderAverageDatabaseConnections = "RDSReaderAverageDatabaseConnections"

	// MetricTypeEc2spotFleetRequestAverageCpuutilization is a MetricType enum value
	MetricTypeEc2spotFleetRequestAverageCpuutilization = "EC2SpotFleetRequestAverageCPUUtilization"

	// MetricTypeEc2spotFleetRequestAverageNetworkIn is a MetricType enum value
	MetricTypeEc2spotFleetRequestAverageNetworkIn = "EC2SpotFleetRequestAverageNetworkIn"

	// MetricTypeEc2spotFleetRequestAverageNetworkOut is a MetricType enum value
	MetricTypeEc2spotFleetRequestAverageNetworkOut = "EC2SpotFleetRequestAverageNetworkOut"

	// MetricTypeSageMakerVariantInvocationsPerInstance is a MetricType enum value
	MetricTypeSageMakerVariantInvocationsPerInstance = "SageMakerVariantInvocationsPerInstance"

	// MetricTypeEcsserviceAverageCpuutilization is a MetricType enum value
	MetricTypeEcsserviceAverageCpuutilization = "ECSServiceAverageCPUUtilization"

	// MetricTypeEcsserviceAverageMemoryUtilization is a MetricType enum value
	MetricTypeEcsserviceAverageMemoryUtilization = "ECSServiceAverageMemoryUtilization"

	// MetricTypeAppStreamAverageCapacityUtilization is a MetricType enum value
	MetricTypeAppStreamAverageCapacityUtilization = "AppStreamAverageCapacityUtilization"

	// MetricTypeComprehendInferenceUtilization is a MetricType enum value
	MetricTypeComprehendInferenceUtilization = "ComprehendInferenceUtilization"

	// MetricTypeLambdaProvisionedConcurrencyUtilization is a MetricType enum value
	MetricTypeLambdaProvisionedConcurrencyUtilization = "LambdaProvisionedConcurrencyUtilization"

	// MetricTypeCassandraReadCapacityUtilization is a MetricType enum value
	MetricTypeCassandraReadCapacityUtilization = "CassandraReadCapacityUtilization"

	// MetricTypeCassandraWriteCapacityUtilization is a MetricType enum value
	MetricTypeCassandraWriteCapacityUtilization = "CassandraWriteCapacityUtilization"

	// MetricTypeKafkaBrokerStorageUtilization is a MetricType enum value
	MetricTypeKafkaBrokerStorageUtilization = "KafkaBrokerStorageUtilization"

	// MetricTypeElastiCachePrimaryEngineCpuutilization is a MetricType enum value
	MetricTypeElastiCachePrimaryEngineCpuutilization = "ElastiCachePrimaryEngineCPUUtilization"

	// MetricTypeElastiCacheReplicaEngineCpuutilization is a MetricType enum value
	MetricTypeElastiCacheReplicaEngineCpuutilization = "ElastiCacheReplicaEngineCPUUtilization"

	// MetricTypeElastiCacheDatabaseMemoryUsageCountedForEvictPercentage is a MetricType enum value
	MetricTypeElastiCacheDatabaseMemoryUsageCountedForEvictPercentage = "ElastiCacheDatabaseMemoryUsageCountedForEvictPercentage"

	// MetricTypeNeptuneReaderAverageCpuutilization is a MetricType enum value
	MetricTypeNeptuneReaderAverageCpuutilization = "NeptuneReaderAverageCPUUtilization"

	// MetricTypeSageMakerVariantProvisionedConcurrencyUtilization is a MetricType enum value
	MetricTypeSageMakerVariantProvisionedConcurrencyUtilization = "SageMakerVariantProvisionedConcurrencyUtilization"

	// MetricTypeElastiCacheDatabaseCapacityUsageCountedForEvictPercentage is a MetricType enum value
	MetricTypeElastiCacheDatabaseCapacityUsageCountedForEvictPercentage = "ElastiCacheDatabaseCapacityUsageCountedForEvictPercentage"

	// MetricTypeSageMakerInferenceComponentInvocationsPerCopy is a MetricType enum value
	MetricTypeSageMakerInferenceComponentInvocationsPerCopy = "SageMakerInferenceComponentInvocationsPerCopy"
)
View Source
const (
	// PolicyTypeStepScaling is a PolicyType enum value
	PolicyTypeStepScaling = "StepScaling"

	// PolicyTypeTargetTrackingScaling is a PolicyType enum value
	PolicyTypeTargetTrackingScaling = "TargetTrackingScaling"
)
View Source
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"

	// ScalableDimensionDynamodbTableReadCapacityUnits is a ScalableDimension enum value
	ScalableDimensionDynamodbTableReadCapacityUnits = "dynamodb:table:ReadCapacityUnits"

	// ScalableDimensionDynamodbTableWriteCapacityUnits is a ScalableDimension enum value
	ScalableDimensionDynamodbTableWriteCapacityUnits = "dynamodb:table:WriteCapacityUnits"

	// ScalableDimensionDynamodbIndexReadCapacityUnits is a ScalableDimension enum value
	ScalableDimensionDynamodbIndexReadCapacityUnits = "dynamodb:index:ReadCapacityUnits"

	// ScalableDimensionDynamodbIndexWriteCapacityUnits is a ScalableDimension enum value
	ScalableDimensionDynamodbIndexWriteCapacityUnits = "dynamodb:index:WriteCapacityUnits"

	// ScalableDimensionRdsClusterReadReplicaCount is a ScalableDimension enum value
	ScalableDimensionRdsClusterReadReplicaCount = "rds:cluster:ReadReplicaCount"

	// ScalableDimensionSagemakerVariantDesiredInstanceCount is a ScalableDimension enum value
	ScalableDimensionSagemakerVariantDesiredInstanceCount = "sagemaker:variant:DesiredInstanceCount"

	// ScalableDimensionCustomResourceResourceTypeProperty is a ScalableDimension enum value
	ScalableDimensionCustomResourceResourceTypeProperty = "custom-resource:ResourceType:Property"

	// ScalableDimensionComprehendDocumentClassifierEndpointDesiredInferenceUnits is a ScalableDimension enum value
	ScalableDimensionComprehendDocumentClassifierEndpointDesiredInferenceUnits = "comprehend:document-classifier-endpoint:DesiredInferenceUnits"

	// ScalableDimensionComprehendEntityRecognizerEndpointDesiredInferenceUnits is a ScalableDimension enum value
	ScalableDimensionComprehendEntityRecognizerEndpointDesiredInferenceUnits = "comprehend:entity-recognizer-endpoint:DesiredInferenceUnits"

	// ScalableDimensionLambdaFunctionProvisionedConcurrency is a ScalableDimension enum value
	ScalableDimensionLambdaFunctionProvisionedConcurrency = "lambda:function:ProvisionedConcurrency"

	// ScalableDimensionCassandraTableReadCapacityUnits is a ScalableDimension enum value
	ScalableDimensionCassandraTableReadCapacityUnits = "cassandra:table:ReadCapacityUnits"

	// ScalableDimensionCassandraTableWriteCapacityUnits is a ScalableDimension enum value
	ScalableDimensionCassandraTableWriteCapacityUnits = "cassandra:table:WriteCapacityUnits"

	// ScalableDimensionKafkaBrokerStorageVolumeSize is a ScalableDimension enum value
	ScalableDimensionKafkaBrokerStorageVolumeSize = "kafka:broker-storage:VolumeSize"

	// ScalableDimensionElasticacheReplicationGroupNodeGroups is a ScalableDimension enum value
	ScalableDimensionElasticacheReplicationGroupNodeGroups = "elasticache:replication-group:NodeGroups"

	// ScalableDimensionElasticacheReplicationGroupReplicas is a ScalableDimension enum value
	ScalableDimensionElasticacheReplicationGroupReplicas = "elasticache:replication-group:Replicas"

	// ScalableDimensionNeptuneClusterReadReplicaCount is a ScalableDimension enum value
	ScalableDimensionNeptuneClusterReadReplicaCount = "neptune:cluster:ReadReplicaCount"

	// ScalableDimensionSagemakerVariantDesiredProvisionedConcurrency is a ScalableDimension enum value
	ScalableDimensionSagemakerVariantDesiredProvisionedConcurrency = "sagemaker:variant:DesiredProvisionedConcurrency"

	// ScalableDimensionSagemakerInferenceComponentDesiredCopyCount is a ScalableDimension enum value
	ScalableDimensionSagemakerInferenceComponentDesiredCopyCount = "sagemaker:inference-component:DesiredCopyCount"
)
View Source
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"
)
View Source
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"

	// ServiceNamespaceDynamodb is a ServiceNamespace enum value
	ServiceNamespaceDynamodb = "dynamodb"

	// ServiceNamespaceRds is a ServiceNamespace enum value
	ServiceNamespaceRds = "rds"

	// ServiceNamespaceSagemaker is a ServiceNamespace enum value
	ServiceNamespaceSagemaker = "sagemaker"

	// ServiceNamespaceCustomResource is a ServiceNamespace enum value
	ServiceNamespaceCustomResource = "custom-resource"

	// ServiceNamespaceComprehend is a ServiceNamespace enum value
	ServiceNamespaceComprehend = "comprehend"

	// ServiceNamespaceLambda is a ServiceNamespace enum value
	ServiceNamespaceLambda = "lambda"

	// ServiceNamespaceCassandra is a ServiceNamespace enum value
	ServiceNamespaceCassandra = "cassandra"

	// ServiceNamespaceKafka is a ServiceNamespace enum value
	ServiceNamespaceKafka = "kafka"

	// ServiceNamespaceElasticache is a ServiceNamespace enum value
	ServiceNamespaceElasticache = "elasticache"

	// ServiceNamespaceNeptune is a ServiceNamespace enum value
	ServiceNamespaceNeptune = "neptune"
)
View Source
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 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 permission to call the CloudWatch
	// DescribeAlarms (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_DescribeAlarms.html)
	// on your behalf.
	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".
	//
	// A per-account resource limit is exceeded. For more information, see Application
	// Auto Scaling service quotas (https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-limits.html).
	ErrCodeLimitExceededException = "LimitExceededException"

	// ErrCodeObjectNotFoundException for service response error code
	// "ObjectNotFoundException".
	//
	// The specified object could not be found. For any operation that 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 operation that deletes or deregisters a resource,
	// this exception is thrown if the resource cannot be found.
	ErrCodeObjectNotFoundException = "ObjectNotFoundException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// The specified resource doesn't exist.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// ErrCodeTooManyTagsException for service response error code
	// "TooManyTagsException".
	//
	// The request contains too many tags. Try the request again with fewer tags.
	ErrCodeTooManyTagsException = "TooManyTagsException"

	// 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"
)
View Source
const (
	ServiceName = "autoscaling"              // Name of service.
	EndpointsID = "application-autoscaling"  // ID to lookup a service endpoint with.
	ServiceID   = "Application Auto Scaling" // ServiceID is a unique identifier of a specific service.
)

Service information constants

Variables

This section is empty.

Functions

func AdjustmentType_Values added in v1.34.3

func AdjustmentType_Values() []string

AdjustmentType_Values returns all elements of the AdjustmentType enum

func MetricAggregationType_Values added in v1.34.3

func MetricAggregationType_Values() []string

MetricAggregationType_Values returns all elements of the MetricAggregationType enum

func MetricStatistic_Values added in v1.34.3

func MetricStatistic_Values() []string

MetricStatistic_Values returns all elements of the MetricStatistic enum

func MetricType_Values added in v1.34.3

func MetricType_Values() []string

MetricType_Values returns all elements of the MetricType enum

func PolicyType_Values added in v1.34.3

func PolicyType_Values() []string

PolicyType_Values returns all elements of the PolicyType enum

func ScalableDimension_Values added in v1.34.3

func ScalableDimension_Values() []string

ScalableDimension_Values returns all elements of the ScalableDimension enum

func ScalingActivityStatusCode_Values added in v1.34.3

func ScalingActivityStatusCode_Values() []string

ScalingActivityStatusCode_Values returns all elements of the ScalingActivityStatusCode enum

func ServiceNamespace_Values added in v1.34.3

func ServiceNamespace_Values() []string

ServiceNamespace_Values returns all elements of the ServiceNamespace enum

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.

func (Alarm) GoString

func (s Alarm) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Alarm) SetAlarmARN added in v1.5.0

func (s *Alarm) SetAlarmARN(v string) *Alarm

SetAlarmARN sets the AlarmARN field's value.

func (*Alarm) SetAlarmName added in v1.5.0

func (s *Alarm) SetAlarmName(v string) *Alarm

SetAlarmName sets the AlarmName field's value.

func (Alarm) String

func (s Alarm) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ApplicationAutoScaling

type ApplicationAutoScaling struct {
	*client.Client
}

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

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:

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

// 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

DeleteScalingPolicy API operation for Application Auto Scaling.

Deletes the specified scaling policy for an Application Auto Scaling scalable target.

Deleting a step scaling 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.

For more information, see Delete a step scaling policy (https://docs.aws.amazon.com/autoscaling/application/userguide/create-step-scaling-policy-cli.html#delete-step-scaling-policy) and Delete a target tracking scaling policy (https://docs.aws.amazon.com/autoscaling/application/userguide/create-target-tracking-policy-cli.html#delete-target-tracking-policy) in the Application Auto Scaling User Guide.

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 Types:

  • ValidationException An exception was thrown for a validation issue. Review the available parameters for the API request.

  • ObjectNotFoundException The specified object could not be found. For any operation that 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 operation that deletes or deregisters a resource, this exception is thrown if the resource cannot be found.

  • 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.

  • InternalServiceException The service encountered an internal error.

See also, https://docs.aws.amazon.com/goto/WebAPI/application-autoscaling-2016-02-06/DeleteScalingPolicy

Example (Shared00)

To delete a scaling policy This example deletes a scaling policy for the Amazon ECS service called web-app, which is running in the default cluster.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/applicationautoscaling"
)

func main() {
	svc := applicationautoscaling.New(session.New())
	input := &applicationautoscaling.DeleteScalingPolicyInput{
		PolicyName:        aws.String("web-app-cpu-lt-25"),
		ResourceId:        aws.String("service/default/web-app"),
		ScalableDimension: aws.String("ecs:service:DesiredCount"),
		ServiceNamespace:  aws.String("ecs"),
	}

	result, err := svc.DeleteScalingPolicy(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case applicationautoscaling.ErrCodeValidationException:
				fmt.Println(applicationautoscaling.ErrCodeValidationException, aerr.Error())
			case applicationautoscaling.ErrCodeObjectNotFoundException:
				fmt.Println(applicationautoscaling.ErrCodeObjectNotFoundException, aerr.Error())
			case applicationautoscaling.ErrCodeConcurrentUpdateException:
				fmt.Println(applicationautoscaling.ErrCodeConcurrentUpdateException, aerr.Error())
			case applicationautoscaling.ErrCodeInternalServiceException:
				fmt.Println(applicationautoscaling.ErrCodeInternalServiceException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
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 will be populated with the request's response once the request completes successfully.

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

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

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

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

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

See also, 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) DeleteScheduledAction added in v1.12.25

DeleteScheduledAction API operation for Application Auto Scaling.

Deletes the specified scheduled action for an Application Auto Scaling scalable target.

For more information, see Delete a scheduled action (https://docs.aws.amazon.com/autoscaling/application/userguide/scheduled-scaling-additional-cli-commands.html#delete-scheduled-action) in the Application Auto Scaling User Guide.

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 DeleteScheduledAction for usage and error information.

Returned Error Types:

  • ValidationException An exception was thrown for a validation issue. Review the available parameters for the API request.

  • ObjectNotFoundException The specified object could not be found. For any operation that 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 operation that deletes or deregisters a resource, this exception is thrown if the resource cannot be found.

  • 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.

  • InternalServiceException The service encountered an internal error.

See also, https://docs.aws.amazon.com/goto/WebAPI/application-autoscaling-2016-02-06/DeleteScheduledAction

Example (Shared00)

To delete a scheduled action This example deletes a scheduled action for the AppStream 2.0 fleet called sample-fleet.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/applicationautoscaling"
)

func main() {
	svc := applicationautoscaling.New(session.New())
	input := &applicationautoscaling.DeleteScheduledActionInput{
		ResourceId:          aws.String("fleet/sample-fleet"),
		ScalableDimension:   aws.String("appstream:fleet:DesiredCapacity"),
		ScheduledActionName: aws.String("my-recurring-action"),
		ServiceNamespace:    aws.String("appstream"),
	}

	result, err := svc.DeleteScheduledAction(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case applicationautoscaling.ErrCodeValidationException:
				fmt.Println(applicationautoscaling.ErrCodeValidationException, aerr.Error())
			case applicationautoscaling.ErrCodeObjectNotFoundException:
				fmt.Println(applicationautoscaling.ErrCodeObjectNotFoundException, aerr.Error())
			case applicationautoscaling.ErrCodeConcurrentUpdateException:
				fmt.Println(applicationautoscaling.ErrCodeConcurrentUpdateException, aerr.Error())
			case applicationautoscaling.ErrCodeInternalServiceException:
				fmt.Println(applicationautoscaling.ErrCodeInternalServiceException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*ApplicationAutoScaling) DeleteScheduledActionRequest added in v1.12.25

func (c *ApplicationAutoScaling) DeleteScheduledActionRequest(input *DeleteScheduledActionInput) (req *request.Request, output *DeleteScheduledActionOutput)

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

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

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/application-autoscaling-2016-02-06/DeleteScheduledAction

func (*ApplicationAutoScaling) DeleteScheduledActionWithContext added in v1.12.25

func (c *ApplicationAutoScaling) DeleteScheduledActionWithContext(ctx aws.Context, input *DeleteScheduledActionInput, opts ...request.Option) (*DeleteScheduledActionOutput, error)

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

See DeleteScheduledAction 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

DeregisterScalableTarget API operation for Application Auto Scaling.

Deregisters an Application Auto Scaling scalable target when you have finished using it. To see which resources have been registered, use DescribeScalableTargets (https://docs.aws.amazon.com/autoscaling/application/APIReference/API_DescribeScalableTargets.html).

Deregistering a scalable target deletes the scaling policies and the scheduled actions that are associated with it.

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 Types:

  • ValidationException An exception was thrown for a validation issue. Review the available parameters for the API request.

  • ObjectNotFoundException The specified object could not be found. For any operation that 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 operation that deletes or deregisters a resource, this exception is thrown if the resource cannot be found.

  • 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.

  • InternalServiceException The service encountered an internal error.

See also, https://docs.aws.amazon.com/goto/WebAPI/application-autoscaling-2016-02-06/DeregisterScalableTarget

Example (Shared00)

To deregister a scalable target This example deregisters a scalable target for an Amazon ECS service called web-app that is running in the default cluster.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/applicationautoscaling"
)

func main() {
	svc := applicationautoscaling.New(session.New())
	input := &applicationautoscaling.DeregisterScalableTargetInput{
		ResourceId:        aws.String("service/default/web-app"),
		ScalableDimension: aws.String("ecs:service:DesiredCount"),
		ServiceNamespace:  aws.String("ecs"),
	}

	result, err := svc.DeregisterScalableTarget(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case applicationautoscaling.ErrCodeValidationException:
				fmt.Println(applicationautoscaling.ErrCodeValidationException, aerr.Error())
			case applicationautoscaling.ErrCodeObjectNotFoundException:
				fmt.Println(applicationautoscaling.ErrCodeObjectNotFoundException, aerr.Error())
			case applicationautoscaling.ErrCodeConcurrentUpdateException:
				fmt.Println(applicationautoscaling.ErrCodeConcurrentUpdateException, aerr.Error())
			case applicationautoscaling.ErrCodeInternalServiceException:
				fmt.Println(applicationautoscaling.ErrCodeInternalServiceException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
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 will be populated with the request's response once the request completes successfully.

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

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

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

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

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

See also, 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

DescribeScalableTargets API operation for Application Auto Scaling.

Gets information about the scalable targets in the specified namespace.

You can filter the results using ResourceIds and ScalableDimension.

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 Types:

  • ValidationException An exception was thrown for a validation issue. Review the available parameters for the API request.

  • InvalidNextTokenException The next token supplied was invalid.

  • 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.

  • InternalServiceException The service encountered an internal error.

See also, https://docs.aws.amazon.com/goto/WebAPI/application-autoscaling-2016-02-06/DescribeScalableTargets

Example (Shared00)

To describe scalable targets This example describes the scalable targets for the ECS service namespace.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/applicationautoscaling"
)

func main() {
	svc := applicationautoscaling.New(session.New())
	input := &applicationautoscaling.DescribeScalableTargetsInput{
		ServiceNamespace: aws.String("ecs"),
	}

	result, err := svc.DescribeScalableTargets(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case applicationautoscaling.ErrCodeValidationException:
				fmt.Println(applicationautoscaling.ErrCodeValidationException, aerr.Error())
			case applicationautoscaling.ErrCodeInvalidNextTokenException:
				fmt.Println(applicationautoscaling.ErrCodeInvalidNextTokenException, aerr.Error())
			case applicationautoscaling.ErrCodeConcurrentUpdateException:
				fmt.Println(applicationautoscaling.ErrCodeConcurrentUpdateException, aerr.Error())
			case applicationautoscaling.ErrCodeInternalServiceException:
				fmt.Println(applicationautoscaling.ErrCodeInternalServiceException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
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 *applicationautoscaling.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 will be populated with the request's response once the request completes successfully.

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

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

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

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

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

See also, 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

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 ResourceId and ScalableDimension.

For information about viewing scaling activities using the Amazon Web Services CLI, see Scaling activities for Application Auto Scaling (https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-scaling-activities.html).

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

See the AWS API reference guide for Application Auto Scaling's API operation DescribeScalingActivities for usage and error information.

Returned Error Types:

  • ValidationException An exception was thrown for a validation issue. Review the available parameters for the API request.

  • InvalidNextTokenException The next token supplied was invalid.

  • 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.

  • InternalServiceException The service encountered an internal error.

See also, https://docs.aws.amazon.com/goto/WebAPI/application-autoscaling-2016-02-06/DescribeScalingActivities

Example (Shared00)

To describe scaling activities for a scalable target This example describes the scaling activities for an Amazon ECS service called web-app that is running in the default cluster.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/applicationautoscaling"
)

func main() {
	svc := applicationautoscaling.New(session.New())
	input := &applicationautoscaling.DescribeScalingActivitiesInput{
		ResourceId:        aws.String("service/default/web-app"),
		ScalableDimension: aws.String("ecs:service:DesiredCount"),
		ServiceNamespace:  aws.String("ecs"),
	}

	result, err := svc.DescribeScalingActivities(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case applicationautoscaling.ErrCodeValidationException:
				fmt.Println(applicationautoscaling.ErrCodeValidationException, aerr.Error())
			case applicationautoscaling.ErrCodeInvalidNextTokenException:
				fmt.Println(applicationautoscaling.ErrCodeInvalidNextTokenException, aerr.Error())
			case applicationautoscaling.ErrCodeConcurrentUpdateException:
				fmt.Println(applicationautoscaling.ErrCodeConcurrentUpdateException, aerr.Error())
			case applicationautoscaling.ErrCodeInternalServiceException:
				fmt.Println(applicationautoscaling.ErrCodeInternalServiceException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
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 *applicationautoscaling.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 will be populated with the request's response once the request completes successfully.

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

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

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

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

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

See also, 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

DescribeScalingPolicies API operation for Application Auto Scaling.

Describes the Application Auto Scaling scaling policies for the specified service namespace.

You can filter the results using ResourceId, ScalableDimension, and PolicyNames.

For more information, see Target tracking scaling policies (https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-target-tracking.html) and Step scaling policies (https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-step-scaling-policies.html) in the Application Auto Scaling User Guide.

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 Types:

  • ValidationException An exception was thrown for a validation issue. Review the available parameters for the API request.

  • FailedResourceAccessException Failed access to resources caused an exception. This exception 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 permission to call the CloudWatch DescribeAlarms (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_DescribeAlarms.html) on your behalf.

  • InvalidNextTokenException The next token supplied was invalid.

  • 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.

  • InternalServiceException The service encountered an internal error.

See also, https://docs.aws.amazon.com/goto/WebAPI/application-autoscaling-2016-02-06/DescribeScalingPolicies

Example (Shared00)

To describe scaling policies This example describes the scaling policies for the ECS service namespace.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/applicationautoscaling"
)

func main() {
	svc := applicationautoscaling.New(session.New())
	input := &applicationautoscaling.DescribeScalingPoliciesInput{
		ServiceNamespace: aws.String("ecs"),
	}

	result, err := svc.DescribeScalingPolicies(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case applicationautoscaling.ErrCodeValidationException:
				fmt.Println(applicationautoscaling.ErrCodeValidationException, aerr.Error())
			case applicationautoscaling.ErrCodeFailedResourceAccessException:
				fmt.Println(applicationautoscaling.ErrCodeFailedResourceAccessException, aerr.Error())
			case applicationautoscaling.ErrCodeInvalidNextTokenException:
				fmt.Println(applicationautoscaling.ErrCodeInvalidNextTokenException, aerr.Error())
			case applicationautoscaling.ErrCodeConcurrentUpdateException:
				fmt.Println(applicationautoscaling.ErrCodeConcurrentUpdateException, aerr.Error())
			case applicationautoscaling.ErrCodeInternalServiceException:
				fmt.Println(applicationautoscaling.ErrCodeInternalServiceException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
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 *applicationautoscaling.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 will be populated with the request's response once the request completes successfully.

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

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

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

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

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

See also, 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) DescribeScheduledActions added in v1.12.25

DescribeScheduledActions API operation for Application Auto Scaling.

Describes the Application Auto Scaling scheduled actions for the specified service namespace.

You can filter the results using the ResourceId, ScalableDimension, and ScheduledActionNames parameters.

For more information, see Scheduled scaling (https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-scheduled-scaling.html) and Managing scheduled scaling (https://docs.aws.amazon.com/autoscaling/application/userguide/scheduled-scaling-additional-cli-commands.html) in the Application Auto Scaling User Guide.

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 DescribeScheduledActions for usage and error information.

Returned Error Types:

  • ValidationException An exception was thrown for a validation issue. Review the available parameters for the API request.

  • InvalidNextTokenException The next token supplied was invalid.

  • 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.

  • InternalServiceException The service encountered an internal error.

See also, https://docs.aws.amazon.com/goto/WebAPI/application-autoscaling-2016-02-06/DescribeScheduledActions

Example (Shared00)

To describe scheduled actions This example describes the scheduled actions for the dynamodb service namespace.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/applicationautoscaling"
)

func main() {
	svc := applicationautoscaling.New(session.New())
	input := &applicationautoscaling.DescribeScheduledActionsInput{
		ServiceNamespace: aws.String("dynamodb"),
	}

	result, err := svc.DescribeScheduledActions(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case applicationautoscaling.ErrCodeValidationException:
				fmt.Println(applicationautoscaling.ErrCodeValidationException, aerr.Error())
			case applicationautoscaling.ErrCodeInvalidNextTokenException:
				fmt.Println(applicationautoscaling.ErrCodeInvalidNextTokenException, aerr.Error())
			case applicationautoscaling.ErrCodeConcurrentUpdateException:
				fmt.Println(applicationautoscaling.ErrCodeConcurrentUpdateException, aerr.Error())
			case applicationautoscaling.ErrCodeInternalServiceException:
				fmt.Println(applicationautoscaling.ErrCodeInternalServiceException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*ApplicationAutoScaling) DescribeScheduledActionsPages added in v1.23.12

func (c *ApplicationAutoScaling) DescribeScheduledActionsPages(input *DescribeScheduledActionsInput, fn func(*DescribeScheduledActionsOutput, bool) bool) error

DescribeScheduledActionsPages iterates over the pages of a DescribeScheduledActions operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeScheduledActions 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 DescribeScheduledActions operation.
pageNum := 0
err := client.DescribeScheduledActionsPages(params,
    func(page *applicationautoscaling.DescribeScheduledActionsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*ApplicationAutoScaling) DescribeScheduledActionsPagesWithContext added in v1.23.12

func (c *ApplicationAutoScaling) DescribeScheduledActionsPagesWithContext(ctx aws.Context, input *DescribeScheduledActionsInput, fn func(*DescribeScheduledActionsOutput, bool) bool, opts ...request.Option) error

DescribeScheduledActionsPagesWithContext same as DescribeScheduledActionsPages 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) DescribeScheduledActionsRequest added in v1.12.25

func (c *ApplicationAutoScaling) DescribeScheduledActionsRequest(input *DescribeScheduledActionsInput) (req *request.Request, output *DescribeScheduledActionsOutput)

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

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

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/application-autoscaling-2016-02-06/DescribeScheduledActions

func (*ApplicationAutoScaling) DescribeScheduledActionsWithContext added in v1.12.25

func (c *ApplicationAutoScaling) DescribeScheduledActionsWithContext(ctx aws.Context, input *DescribeScheduledActionsInput, opts ...request.Option) (*DescribeScheduledActionsOutput, error)

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

See DescribeScheduledActions 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) ListTagsForResource added in v1.44.225

ListTagsForResource API operation for Application Auto Scaling.

Returns all the tags on the specified Application Auto Scaling scalable target.

For general information about tags, including the format and syntax, see Tagging Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the Amazon Web Services General Reference.

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 ListTagsForResource for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The specified resource doesn't exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/application-autoscaling-2016-02-06/ListTagsForResource

Example (Shared00)

To list tags for a scalable target This example lists the tag key names and values that are attached to the scalable target specified by its ARN.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/applicationautoscaling"
)

func main() {
	svc := applicationautoscaling.New(session.New())
	input := &applicationautoscaling.ListTagsForResourceInput{
		ResourceARN: aws.String("arn:aws:application-autoscaling:us-west-2:123456789012:scalable-target/1234abcd56ab78cd901ef1234567890ab123"),
	}

	result, err := svc.ListTagsForResource(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case applicationautoscaling.ErrCodeResourceNotFoundException:
				fmt.Println(applicationautoscaling.ErrCodeResourceNotFoundException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*ApplicationAutoScaling) ListTagsForResourceRequest added in v1.44.225

func (c *ApplicationAutoScaling) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput)

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

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

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/application-autoscaling-2016-02-06/ListTagsForResource

func (*ApplicationAutoScaling) ListTagsForResourceWithContext added in v1.44.225

func (c *ApplicationAutoScaling) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error)

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

See ListTagsForResource 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

PutScalingPolicy API operation for Application Auto Scaling.

Creates or updates a scaling 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 until you have registered the resource as a scalable target.

Multiple scaling policies can be in force at the same time for the same scalable target. You can have one or more target tracking scaling policies, one or more step scaling policies, or both. However, there is a chance that multiple policies could conflict, instructing the scalable target to scale out or in at the same time. Application Auto Scaling gives precedence to the policy that provides the largest capacity for both scale out and scale in. For example, if one policy increases capacity by 3, another policy increases capacity by 200 percent, and the current capacity is 10, Application Auto Scaling uses the policy with the highest calculated capacity (200% of 10 = 20) and scales out to 30.

We recommend caution, however, when using target tracking scaling policies with step scaling policies because conflicts between these policies can cause undesirable behavior. For example, if the step scaling policy initiates a scale-in activity before the target tracking policy is ready to scale in, the scale-in activity will not be blocked. After the scale-in activity completes, the target tracking policy could instruct the scalable target to scale out again.

For more information, see Target tracking scaling policies (https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-target-tracking.html) and Step scaling policies (https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-step-scaling-policies.html) in the Application Auto Scaling User Guide.

If a scalable target is deregistered, the scalable target is no longer available to use scaling policies. Any scaling policies that were specified for the scalable target are deleted.

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 Types:

  • ValidationException An exception was thrown for a validation issue. Review the available parameters for the API request.

  • LimitExceededException A per-account resource limit is exceeded. For more information, see Application Auto Scaling service quotas (https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-limits.html).

  • ObjectNotFoundException The specified object could not be found. For any operation that 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 operation that deletes or deregisters a resource, this exception is thrown if the resource cannot be found.

  • 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.

  • FailedResourceAccessException Failed access to resources caused an exception. This exception 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 permission to call the CloudWatch DescribeAlarms (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_DescribeAlarms.html) on your behalf.

  • InternalServiceException The service encountered an internal error.

See also, https://docs.aws.amazon.com/goto/WebAPI/application-autoscaling-2016-02-06/PutScalingPolicy

Example (Shared00)

To apply a target tracking scaling policy with a predefined metric specification The following example applies a target tracking scaling policy with a predefined metric specification to an Amazon ECS service called web-app in the default cluster. The policy keeps the average CPU utilization of the service at 75 percent, with scale-out and scale-in cooldown periods of 60 seconds.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/applicationautoscaling"
)

func main() {
	svc := applicationautoscaling.New(session.New())
	input := &applicationautoscaling.PutScalingPolicyInput{
		PolicyName:        aws.String("cpu75-target-tracking-scaling-policy"),
		PolicyType:        aws.String("TargetTrackingScaling"),
		ResourceId:        aws.String("service/default/web-app"),
		ScalableDimension: aws.String("ecs:service:DesiredCount"),
		ServiceNamespace:  aws.String("ecs"),
		TargetTrackingScalingPolicyConfiguration: &applicationautoscaling.TargetTrackingScalingPolicyConfiguration{
			PredefinedMetricSpecification: &applicationautoscaling.PredefinedMetricSpecification{
				PredefinedMetricType: aws.String("ECSServiceAverageCPUUtilization"),
			},
			ScaleInCooldown:  aws.Int64(60),
			ScaleOutCooldown: aws.Int64(60),
			TargetValue:      aws.Float64(75.000000),
		},
	}

	result, err := svc.PutScalingPolicy(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case applicationautoscaling.ErrCodeValidationException:
				fmt.Println(applicationautoscaling.ErrCodeValidationException, aerr.Error())
			case applicationautoscaling.ErrCodeLimitExceededException:
				fmt.Println(applicationautoscaling.ErrCodeLimitExceededException, aerr.Error())
			case applicationautoscaling.ErrCodeObjectNotFoundException:
				fmt.Println(applicationautoscaling.ErrCodeObjectNotFoundException, aerr.Error())
			case applicationautoscaling.ErrCodeConcurrentUpdateException:
				fmt.Println(applicationautoscaling.ErrCodeConcurrentUpdateException, aerr.Error())
			case applicationautoscaling.ErrCodeFailedResourceAccessException:
				fmt.Println(applicationautoscaling.ErrCodeFailedResourceAccessException, aerr.Error())
			case applicationautoscaling.ErrCodeInternalServiceException:
				fmt.Println(applicationautoscaling.ErrCodeInternalServiceException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
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 will be populated with the request's response once the request completes successfully.

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

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

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

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

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

See also, 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) PutScheduledAction added in v1.12.25

PutScheduledAction API operation for Application Auto Scaling.

Creates or updates a scheduled action for an Application Auto Scaling scalable target.

Each scalable target is identified by a service namespace, resource ID, and scalable dimension. A scheduled action applies to the scalable target identified by those three attributes. You cannot create a scheduled action until you have registered the resource as a scalable target.

When you specify start and end times with a recurring schedule using a cron expression or rates, they form the boundaries for when the recurring action starts and stops.

To update a scheduled action, specify the parameters that you want to change. If you don't specify start and end times, the old values are deleted.

For more information, see Scheduled scaling (https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-scheduled-scaling.html) in the Application Auto Scaling User Guide.

If a scalable target is deregistered, the scalable target is no longer available to run scheduled actions. Any scheduled actions that were specified for the scalable target are deleted.

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 PutScheduledAction for usage and error information.

Returned Error Types:

  • ValidationException An exception was thrown for a validation issue. Review the available parameters for the API request.

  • LimitExceededException A per-account resource limit is exceeded. For more information, see Application Auto Scaling service quotas (https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-limits.html).

  • ObjectNotFoundException The specified object could not be found. For any operation that 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 operation that deletes or deregisters a resource, this exception is thrown if the resource cannot be found.

  • 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.

  • InternalServiceException The service encountered an internal error.

See also, https://docs.aws.amazon.com/goto/WebAPI/application-autoscaling-2016-02-06/PutScheduledAction

Example (Shared00)

To create a recurring scheduled action This example adds a scheduled action to a DynamoDB table called TestTable to scale out on a recurring schedule. On the specified schedule (every day at 12:15pm UTC), if the current capacity is below the value specified for MinCapacity, Application Auto Scaling scales out to the value specified by MinCapacity.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/applicationautoscaling"
)

func main() {
	svc := applicationautoscaling.New(session.New())
	input := &applicationautoscaling.PutScheduledActionInput{
		ResourceId:        aws.String("table/TestTable"),
		ScalableDimension: aws.String("dynamodb:table:WriteCapacityUnits"),
		ScalableTargetAction: &applicationautoscaling.ScalableTargetAction{
			MinCapacity: aws.Int64(6),
		},
		Schedule:            aws.String("cron(15 12 * * ? *)"),
		ScheduledActionName: aws.String("my-recurring-action"),
		ServiceNamespace:    aws.String("dynamodb"),
	}

	result, err := svc.PutScheduledAction(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case applicationautoscaling.ErrCodeValidationException:
				fmt.Println(applicationautoscaling.ErrCodeValidationException, aerr.Error())
			case applicationautoscaling.ErrCodeLimitExceededException:
				fmt.Println(applicationautoscaling.ErrCodeLimitExceededException, aerr.Error())
			case applicationautoscaling.ErrCodeObjectNotFoundException:
				fmt.Println(applicationautoscaling.ErrCodeObjectNotFoundException, aerr.Error())
			case applicationautoscaling.ErrCodeConcurrentUpdateException:
				fmt.Println(applicationautoscaling.ErrCodeConcurrentUpdateException, aerr.Error())
			case applicationautoscaling.ErrCodeInternalServiceException:
				fmt.Println(applicationautoscaling.ErrCodeInternalServiceException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*ApplicationAutoScaling) PutScheduledActionRequest added in v1.12.25

func (c *ApplicationAutoScaling) PutScheduledActionRequest(input *PutScheduledActionInput) (req *request.Request, output *PutScheduledActionOutput)

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

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

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/application-autoscaling-2016-02-06/PutScheduledAction

func (*ApplicationAutoScaling) PutScheduledActionWithContext added in v1.12.25

func (c *ApplicationAutoScaling) PutScheduledActionWithContext(ctx aws.Context, input *PutScheduledActionInput, opts ...request.Option) (*PutScheduledActionOutput, error)

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

See PutScheduledAction 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

RegisterScalableTarget API operation for Application Auto Scaling.

Registers or updates a scalable target, which is the resource that you want to scale.

Scalable targets are uniquely identified by the combination of resource ID, scalable dimension, and namespace, which represents some capacity dimension of the underlying service.

When you register a new scalable target, you must specify values for the minimum and maximum capacity. If the specified resource is not active in the target service, this operation does not change the resource's current capacity. Otherwise, it changes the resource's current capacity to a value that is inside of this range.

If you add a scaling policy, current capacity is adjustable within the specified range when scaling starts. Application Auto Scaling scaling policies will not scale capacity to values that are outside of the minimum and maximum range.

After you register a scalable target, you do not need to register it again to use other Application Auto Scaling operations. To see which resources have been registered, use DescribeScalableTargets (https://docs.aws.amazon.com/autoscaling/application/APIReference/API_DescribeScalableTargets.html). You can also view the scaling policies for a service namespace by using DescribeScalableTargets (https://docs.aws.amazon.com/autoscaling/application/APIReference/API_DescribeScalableTargets.html). If you no longer need a scalable target, you can deregister it by using DeregisterScalableTarget (https://docs.aws.amazon.com/autoscaling/application/APIReference/API_DeregisterScalableTarget.html).

To update a scalable target, specify the parameters that you want to change. Include the parameters that identify the scalable target: resource ID, scalable dimension, and namespace. Any parameters that you don't specify are not changed by this update request.

If you call the RegisterScalableTarget API operation to create a scalable target, there might be a brief delay until the operation achieves eventual consistency (https://en.wikipedia.org/wiki/Eventual_consistency). You might become aware of this brief delay if you get unexpected errors when performing sequential operations. The typical strategy is to retry the request, and some Amazon Web Services SDKs include automatic backoff and retry logic.

If you call the RegisterScalableTarget API operation to update an existing scalable target, Application Auto Scaling retrieves the current capacity of the resource. If it's below the minimum capacity or above the maximum capacity, Application Auto Scaling adjusts the capacity of the scalable target to place it within these bounds, even if you don't include the MinCapacity or MaxCapacity request parameters.

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 Types:

  • ValidationException An exception was thrown for a validation issue. Review the available parameters for the API request.

  • LimitExceededException A per-account resource limit is exceeded. For more information, see Application Auto Scaling service quotas (https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-limits.html).

  • 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.

  • InternalServiceException The service encountered an internal error.

See also, https://docs.aws.amazon.com/goto/WebAPI/application-autoscaling-2016-02-06/RegisterScalableTarget

Example (Shared00)

To register an ECS service as a scalable target This example registers a scalable target from an Amazon ECS service called web-app that is running on the default cluster, with a minimum desired count of 1 task and a maximum desired count of 10 tasks.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/applicationautoscaling"
)

func main() {
	svc := applicationautoscaling.New(session.New())
	input := &applicationautoscaling.RegisterScalableTargetInput{
		MaxCapacity:       aws.Int64(10),
		MinCapacity:       aws.Int64(1),
		ResourceId:        aws.String("service/default/web-app"),
		ScalableDimension: aws.String("ecs:service:DesiredCount"),
		ServiceNamespace:  aws.String("ecs"),
	}

	result, err := svc.RegisterScalableTarget(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case applicationautoscaling.ErrCodeValidationException:
				fmt.Println(applicationautoscaling.ErrCodeValidationException, aerr.Error())
			case applicationautoscaling.ErrCodeLimitExceededException:
				fmt.Println(applicationautoscaling.ErrCodeLimitExceededException, aerr.Error())
			case applicationautoscaling.ErrCodeConcurrentUpdateException:
				fmt.Println(applicationautoscaling.ErrCodeConcurrentUpdateException, aerr.Error())
			case applicationautoscaling.ErrCodeInternalServiceException:
				fmt.Println(applicationautoscaling.ErrCodeInternalServiceException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
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 will be populated with the request's response once the request completes successfully.

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

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

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

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

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

See also, 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.

func (*ApplicationAutoScaling) TagResource added in v1.44.225

TagResource API operation for Application Auto Scaling.

Adds or edits tags on an Application Auto Scaling scalable target.

Each tag consists of a tag key and a tag value, which are both case-sensitive strings. To add a tag, specify a new tag key and a tag value. To edit a tag, specify an existing tag key and a new tag value.

You can use this operation to tag an Application Auto Scaling scalable target, but you cannot tag a scaling policy or scheduled action.

You can also add tags to an Application Auto Scaling scalable target while creating it (RegisterScalableTarget).

For general information about tags, including the format and syntax, see Tagging Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the Amazon Web Services General Reference.

Use tags to control access to a scalable target. For more information, see Tagging support for Application Auto Scaling (https://docs.aws.amazon.com/autoscaling/application/userguide/resource-tagging-support.html) in the Application Auto Scaling User Guide.

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 TagResource for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The specified resource doesn't exist.

  • TooManyTagsException The request contains too many tags. Try the request again with fewer tags.

  • ValidationException An exception was thrown for a validation issue. Review the available parameters for the API request.

See also, https://docs.aws.amazon.com/goto/WebAPI/application-autoscaling-2016-02-06/TagResource

Example (Shared00)

To add a tag to a scalable target This example adds a tag with the key name "environment" and the value "production" to the scalable target specified by its ARN.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/applicationautoscaling"
)

func main() {
	svc := applicationautoscaling.New(session.New())
	input := &applicationautoscaling.TagResourceInput{
		ResourceARN: aws.String("arn:aws:application-autoscaling:us-west-2:123456789012:scalable-target/1234abcd56ab78cd901ef1234567890ab123"),
		Tags: map[string]*string{
			"environment": aws.String("production"),
		},
	}

	result, err := svc.TagResource(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case applicationautoscaling.ErrCodeResourceNotFoundException:
				fmt.Println(applicationautoscaling.ErrCodeResourceNotFoundException, aerr.Error())
			case applicationautoscaling.ErrCodeTooManyTagsException:
				fmt.Println(applicationautoscaling.ErrCodeTooManyTagsException, aerr.Error())
			case applicationautoscaling.ErrCodeValidationException:
				fmt.Println(applicationautoscaling.ErrCodeValidationException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*ApplicationAutoScaling) TagResourceRequest added in v1.44.225

func (c *ApplicationAutoScaling) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput)

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

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

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/application-autoscaling-2016-02-06/TagResource

func (*ApplicationAutoScaling) TagResourceWithContext added in v1.44.225

func (c *ApplicationAutoScaling) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error)

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

See TagResource 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) UntagResource added in v1.44.225

UntagResource API operation for Application Auto Scaling.

Deletes tags from an Application Auto Scaling scalable target. To delete a tag, specify the tag key and the Application Auto Scaling scalable target.

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 UntagResource for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The specified resource doesn't exist.

  • ValidationException An exception was thrown for a validation issue. Review the available parameters for the API request.

See also, https://docs.aws.amazon.com/goto/WebAPI/application-autoscaling-2016-02-06/UntagResource

Example (Shared00)

To remove a tag from a scalable target This example removes the tag pair with the key name "environment" from the scalable target specified by its ARN.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/applicationautoscaling"
)

func main() {
	svc := applicationautoscaling.New(session.New())
	input := &applicationautoscaling.UntagResourceInput{
		ResourceARN: aws.String("arn:aws:application-autoscaling:us-west-2:123456789012:scalable-target/1234abcd56ab78cd901ef1234567890ab123"),
		TagKeys: []*string{
			aws.String("environment"),
		},
	}

	result, err := svc.UntagResource(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case applicationautoscaling.ErrCodeResourceNotFoundException:
				fmt.Println(applicationautoscaling.ErrCodeResourceNotFoundException, aerr.Error())
			case applicationautoscaling.ErrCodeValidationException:
				fmt.Println(applicationautoscaling.ErrCodeValidationException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*ApplicationAutoScaling) UntagResourceRequest added in v1.44.225

func (c *ApplicationAutoScaling) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput)

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

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

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/application-autoscaling-2016-02-06/UntagResource

func (*ApplicationAutoScaling) UntagResourceWithContext added in v1.44.225

func (c *ApplicationAutoScaling) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error)

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

See UntagResource 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 ConcurrentUpdateException added in v1.28.0

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

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

Concurrent updates caused an exception, for example, if you request an update to an Application Auto Scaling resource that already has a pending update.

func (*ConcurrentUpdateException) Code added in v1.28.0

Code returns the exception type name.

func (*ConcurrentUpdateException) Error added in v1.28.0

func (s *ConcurrentUpdateException) Error() string

func (ConcurrentUpdateException) GoString added in v1.28.0

func (s ConcurrentUpdateException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConcurrentUpdateException) Message added in v1.28.0

func (s *ConcurrentUpdateException) Message() string

Message returns the exception's message.

func (*ConcurrentUpdateException) OrigErr added in v1.28.0

func (s *ConcurrentUpdateException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ConcurrentUpdateException) RequestID added in v1.28.0

func (s *ConcurrentUpdateException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ConcurrentUpdateException) StatusCode added in v1.28.0

func (s *ConcurrentUpdateException) StatusCode() int

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

func (ConcurrentUpdateException) String added in v1.28.0

func (s ConcurrentUpdateException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CustomizedMetricSpecification added in v1.8.42

type CustomizedMetricSpecification struct {

	// The dimensions of the metric.
	//
	// Conditional: If you published your metric with dimensions, you must specify
	// the same dimensions in your scaling policy.
	Dimensions []*MetricDimension `type:"list"`

	// The name of the metric. To get the exact metric name, namespace, and dimensions,
	// inspect the Metric (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_Metric.html)
	// object that's returned by a call to ListMetrics (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_ListMetrics.html).
	MetricName *string `type:"string"`

	// The metrics to include in the target tracking scaling policy, as a metric
	// data query. This can include both raw metric and metric math expressions.
	Metrics []*TargetTrackingMetricDataQuery `type:"list"`

	// The namespace of the metric.
	Namespace *string `type:"string"`

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

	// The unit of the metric. For a complete list of the units that CloudWatch
	// supports, see the MetricDatum (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html)
	// data type in the Amazon CloudWatch API Reference.
	Unit *string `type:"string"`
	// contains filtered or unexported fields
}

Represents a CloudWatch metric of your choosing for a target tracking scaling policy to use with Application Auto Scaling.

For information about the available metrics for a service, see Amazon Web Services services that publish CloudWatch metrics (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html) in the Amazon CloudWatch User Guide.

To create your customized metric specification:

  • Add values for each required parameter from CloudWatch. You can use an existing metric, or a new metric that you create. To use your own metric, you must first publish the metric to CloudWatch. For more information, see Publish custom metrics (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html) in the Amazon CloudWatch User Guide.

  • Choose a metric that changes proportionally with capacity. The value of the metric should increase or decrease in inverse proportion to the number of capacity units. That is, the value of the metric should decrease when capacity increases, and increase when capacity decreases.

For more information about the CloudWatch terminology below, see Amazon CloudWatch concepts (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html) in the Amazon CloudWatch User Guide.

func (CustomizedMetricSpecification) GoString added in v1.8.42

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CustomizedMetricSpecification) SetDimensions added in v1.8.42

SetDimensions sets the Dimensions field's value.

func (*CustomizedMetricSpecification) SetMetricName added in v1.8.42

SetMetricName sets the MetricName field's value.

func (*CustomizedMetricSpecification) SetMetrics added in v1.44.221

SetMetrics sets the Metrics field's value.

func (*CustomizedMetricSpecification) SetNamespace added in v1.8.42

SetNamespace sets the Namespace field's value.

func (*CustomizedMetricSpecification) SetStatistic added in v1.8.42

SetStatistic sets the Statistic field's value.

func (*CustomizedMetricSpecification) SetUnit added in v1.8.42

SetUnit sets the Unit field's value.

func (CustomizedMetricSpecification) String added in v1.8.42

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CustomizedMetricSpecification) Validate added in v1.8.42

func (s *CustomizedMetricSpecification) Validate() error

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

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 - 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.
	//
	//    * DynamoDB table - The resource type is table and the unique identifier
	//    is the table name. Example: table/my-table.
	//
	//    * DynamoDB global secondary index - The resource type is index and the
	//    unique identifier is the index name. Example: table/my-table/index/my-table-index.
	//
	//    * Aurora DB cluster - The resource type is cluster and the unique identifier
	//    is the cluster name. Example: cluster:my-db-cluster.
	//
	//    * SageMaker endpoint variant - The resource type is variant and the unique
	//    identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
	//
	//    * Custom resources are not supported with a resource type. This parameter
	//    must specify the OutputValue from the CloudFormation template stack used
	//    to access the resources. The unique identifier is defined by the service
	//    provider. More information is available in our GitHub repository (https://github.com/aws/aws-auto-scaling-custom-resource).
	//
	//    * Amazon Comprehend document classification endpoint - The resource type
	//    and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.
	//
	//    * Amazon Comprehend entity recognizer endpoint - The resource type and
	//    unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE.
	//
	//    * Lambda provisioned concurrency - The resource type is function and the
	//    unique identifier is the function name with a function version or alias
	//    name suffix that is not $LATEST. Example: function:my-function:prod or
	//    function:my-function:1.
	//
	//    * Amazon Keyspaces table - The resource type is table and the unique identifier
	//    is the table name. Example: keyspace/mykeyspace/table/mytable.
	//
	//    * Amazon MSK cluster - The resource type and unique identifier are specified
	//    using the cluster ARN. Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.
	//
	//    * Amazon ElastiCache replication group - The resource type is replication-group
	//    and the unique identifier is the replication group name. Example: replication-group/mycluster.
	//
	//    * Neptune cluster - The resource type is cluster and the unique identifier
	//    is the cluster name. Example: cluster:mycluster.
	//
	//    * SageMaker Serverless endpoint - The resource type is variant and the
	//    unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
	//
	//    * SageMaker inference component - The resource type is inference-component
	//    and the unique identifier is the resource ID. Example: inference-component/my-inference-component.
	//
	// 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.
	//
	//    * elasticmapreduce:instancegroup:InstanceCount - The instance count of
	//    an EMR Instance Group.
	//
	//    * ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot
	//    Fleet.
	//
	//    * appstream:fleet:DesiredCapacity - The desired capacity of an AppStream
	//    2.0 fleet.
	//
	//    * dynamodb:table:ReadCapacityUnits - The provisioned read capacity for
	//    a DynamoDB table.
	//
	//    * dynamodb:table:WriteCapacityUnits - The provisioned write capacity for
	//    a DynamoDB table.
	//
	//    * dynamodb:index:ReadCapacityUnits - The provisioned read capacity for
	//    a DynamoDB global secondary index.
	//
	//    * dynamodb:index:WriteCapacityUnits - The provisioned write capacity for
	//    a DynamoDB global secondary index.
	//
	//    * rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora
	//    DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible
	//    edition.
	//
	//    * sagemaker:variant:DesiredInstanceCount - The number of EC2 instances
	//    for a SageMaker model endpoint variant.
	//
	//    * custom-resource:ResourceType:Property - The scalable dimension for a
	//    custom resource provided by your own application or service.
	//
	//    * comprehend:document-classifier-endpoint:DesiredInferenceUnits - The
	//    number of inference units for an Amazon Comprehend document classification
	//    endpoint.
	//
	//    * comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number
	//    of inference units for an Amazon Comprehend entity recognizer endpoint.
	//
	//    * lambda:function:ProvisionedConcurrency - The provisioned concurrency
	//    for a Lambda function.
	//
	//    * cassandra:table:ReadCapacityUnits - The provisioned read capacity for
	//    an Amazon Keyspaces table.
	//
	//    * cassandra:table:WriteCapacityUnits - The provisioned write capacity
	//    for an Amazon Keyspaces table.
	//
	//    * kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB)
	//    for brokers in an Amazon MSK cluster.
	//
	//    * elasticache:replication-group:NodeGroups - The number of node groups
	//    for an Amazon ElastiCache replication group.
	//
	//    * elasticache:replication-group:Replicas - The number of replicas per
	//    node group for an Amazon ElastiCache replication group.
	//
	//    * neptune:cluster:ReadReplicaCount - The count of read replicas in an
	//    Amazon Neptune DB cluster.
	//
	//    * sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency
	//    for a SageMaker Serverless endpoint.
	//
	//    * sagemaker:inference-component:DesiredCopyCount - The number of copies
	//    across an endpoint for a SageMaker inference component.
	//
	// ScalableDimension is a required field
	ScalableDimension *string `type:"string" required:"true" enum:"ScalableDimension"`

	// The namespace of the Amazon Web Services service that provides the resource.
	// For a resource provided by your own application or service, use custom-resource
	// instead.
	//
	// ServiceNamespace is a required field
	ServiceNamespace *string `type:"string" required:"true" enum:"ServiceNamespace"`
	// contains filtered or unexported fields
}

func (DeleteScalingPolicyInput) GoString

func (s DeleteScalingPolicyInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteScalingPolicyInput) SetPolicyName added in v1.5.0

SetPolicyName sets the PolicyName field's value.

func (*DeleteScalingPolicyInput) SetResourceId added in v1.5.0

SetResourceId sets the ResourceId field's value.

func (*DeleteScalingPolicyInput) SetScalableDimension added in v1.5.0

func (s *DeleteScalingPolicyInput) SetScalableDimension(v string) *DeleteScalingPolicyInput

SetScalableDimension sets the ScalableDimension field's value.

func (*DeleteScalingPolicyInput) SetServiceNamespace added in v1.5.0

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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
}

func (DeleteScalingPolicyOutput) GoString

func (s DeleteScalingPolicyOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteScalingPolicyOutput) String

func (s DeleteScalingPolicyOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteScheduledActionInput added in v1.12.25

type DeleteScheduledActionInput struct {

	// The identifier of the resource associated with the scheduled action. 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 - 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.
	//
	//    * DynamoDB table - The resource type is table and the unique identifier
	//    is the table name. Example: table/my-table.
	//
	//    * DynamoDB global secondary index - The resource type is index and the
	//    unique identifier is the index name. Example: table/my-table/index/my-table-index.
	//
	//    * Aurora DB cluster - The resource type is cluster and the unique identifier
	//    is the cluster name. Example: cluster:my-db-cluster.
	//
	//    * SageMaker endpoint variant - The resource type is variant and the unique
	//    identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
	//
	//    * Custom resources are not supported with a resource type. This parameter
	//    must specify the OutputValue from the CloudFormation template stack used
	//    to access the resources. The unique identifier is defined by the service
	//    provider. More information is available in our GitHub repository (https://github.com/aws/aws-auto-scaling-custom-resource).
	//
	//    * Amazon Comprehend document classification endpoint - The resource type
	//    and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.
	//
	//    * Amazon Comprehend entity recognizer endpoint - The resource type and
	//    unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE.
	//
	//    * Lambda provisioned concurrency - The resource type is function and the
	//    unique identifier is the function name with a function version or alias
	//    name suffix that is not $LATEST. Example: function:my-function:prod or
	//    function:my-function:1.
	//
	//    * Amazon Keyspaces table - The resource type is table and the unique identifier
	//    is the table name. Example: keyspace/mykeyspace/table/mytable.
	//
	//    * Amazon MSK cluster - The resource type and unique identifier are specified
	//    using the cluster ARN. Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.
	//
	//    * Amazon ElastiCache replication group - The resource type is replication-group
	//    and the unique identifier is the replication group name. Example: replication-group/mycluster.
	//
	//    * Neptune cluster - The resource type is cluster and the unique identifier
	//    is the cluster name. Example: cluster:mycluster.
	//
	//    * SageMaker Serverless endpoint - The resource type is variant and the
	//    unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
	//
	//    * SageMaker inference component - The resource type is inference-component
	//    and the unique identifier is the resource ID. Example: inference-component/my-inference-component.
	//
	// 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.
	//
	//    * elasticmapreduce:instancegroup:InstanceCount - The instance count of
	//    an EMR Instance Group.
	//
	//    * ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot
	//    Fleet.
	//
	//    * appstream:fleet:DesiredCapacity - The desired capacity of an AppStream
	//    2.0 fleet.
	//
	//    * dynamodb:table:ReadCapacityUnits - The provisioned read capacity for
	//    a DynamoDB table.
	//
	//    * dynamodb:table:WriteCapacityUnits - The provisioned write capacity for
	//    a DynamoDB table.
	//
	//    * dynamodb:index:ReadCapacityUnits - The provisioned read capacity for
	//    a DynamoDB global secondary index.
	//
	//    * dynamodb:index:WriteCapacityUnits - The provisioned write capacity for
	//    a DynamoDB global secondary index.
	//
	//    * rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora
	//    DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible
	//    edition.
	//
	//    * sagemaker:variant:DesiredInstanceCount - The number of EC2 instances
	//    for a SageMaker model endpoint variant.
	//
	//    * custom-resource:ResourceType:Property - The scalable dimension for a
	//    custom resource provided by your own application or service.
	//
	//    * comprehend:document-classifier-endpoint:DesiredInferenceUnits - The
	//    number of inference units for an Amazon Comprehend document classification
	//    endpoint.
	//
	//    * comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number
	//    of inference units for an Amazon Comprehend entity recognizer endpoint.
	//
	//    * lambda:function:ProvisionedConcurrency - The provisioned concurrency
	//    for a Lambda function.
	//
	//    * cassandra:table:ReadCapacityUnits - The provisioned read capacity for
	//    an Amazon Keyspaces table.
	//
	//    * cassandra:table:WriteCapacityUnits - The provisioned write capacity
	//    for an Amazon Keyspaces table.
	//
	//    * kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB)
	//    for brokers in an Amazon MSK cluster.
	//
	//    * elasticache:replication-group:NodeGroups - The number of node groups
	//    for an Amazon ElastiCache replication group.
	//
	//    * elasticache:replication-group:Replicas - The number of replicas per
	//    node group for an Amazon ElastiCache replication group.
	//
	//    * neptune:cluster:ReadReplicaCount - The count of read replicas in an
	//    Amazon Neptune DB cluster.
	//
	//    * sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency
	//    for a SageMaker Serverless endpoint.
	//
	//    * sagemaker:inference-component:DesiredCopyCount - The number of copies
	//    across an endpoint for a SageMaker inference component.
	//
	// ScalableDimension is a required field
	ScalableDimension *string `type:"string" required:"true" enum:"ScalableDimension"`

	// The name of the scheduled action.
	//
	// ScheduledActionName is a required field
	ScheduledActionName *string `min:"1" type:"string" required:"true"`

	// The namespace of the Amazon Web Services service that provides the resource.
	// For a resource provided by your own application or service, use custom-resource
	// instead.
	//
	// ServiceNamespace is a required field
	ServiceNamespace *string `type:"string" required:"true" enum:"ServiceNamespace"`
	// contains filtered or unexported fields
}

func (DeleteScheduledActionInput) GoString added in v1.12.25

func (s DeleteScheduledActionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteScheduledActionInput) SetResourceId added in v1.12.25

SetResourceId sets the ResourceId field's value.

func (*DeleteScheduledActionInput) SetScalableDimension added in v1.12.25

func (s *DeleteScheduledActionInput) SetScalableDimension(v string) *DeleteScheduledActionInput

SetScalableDimension sets the ScalableDimension field's value.

func (*DeleteScheduledActionInput) SetScheduledActionName added in v1.12.25

func (s *DeleteScheduledActionInput) SetScheduledActionName(v string) *DeleteScheduledActionInput

SetScheduledActionName sets the ScheduledActionName field's value.

func (*DeleteScheduledActionInput) SetServiceNamespace added in v1.12.25

SetServiceNamespace sets the ServiceNamespace field's value.

func (DeleteScheduledActionInput) String added in v1.12.25

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteScheduledActionInput) Validate added in v1.12.25

func (s *DeleteScheduledActionInput) Validate() error

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

type DeleteScheduledActionOutput added in v1.12.25

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

func (DeleteScheduledActionOutput) GoString added in v1.12.25

func (s DeleteScheduledActionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteScheduledActionOutput) String added in v1.12.25

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 - 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.
	//
	//    * DynamoDB table - The resource type is table and the unique identifier
	//    is the table name. Example: table/my-table.
	//
	//    * DynamoDB global secondary index - The resource type is index and the
	//    unique identifier is the index name. Example: table/my-table/index/my-table-index.
	//
	//    * Aurora DB cluster - The resource type is cluster and the unique identifier
	//    is the cluster name. Example: cluster:my-db-cluster.
	//
	//    * SageMaker endpoint variant - The resource type is variant and the unique
	//    identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
	//
	//    * Custom resources are not supported with a resource type. This parameter
	//    must specify the OutputValue from the CloudFormation template stack used
	//    to access the resources. The unique identifier is defined by the service
	//    provider. More information is available in our GitHub repository (https://github.com/aws/aws-auto-scaling-custom-resource).
	//
	//    * Amazon Comprehend document classification endpoint - The resource type
	//    and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.
	//
	//    * Amazon Comprehend entity recognizer endpoint - The resource type and
	//    unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE.
	//
	//    * Lambda provisioned concurrency - The resource type is function and the
	//    unique identifier is the function name with a function version or alias
	//    name suffix that is not $LATEST. Example: function:my-function:prod or
	//    function:my-function:1.
	//
	//    * Amazon Keyspaces table - The resource type is table and the unique identifier
	//    is the table name. Example: keyspace/mykeyspace/table/mytable.
	//
	//    * Amazon MSK cluster - The resource type and unique identifier are specified
	//    using the cluster ARN. Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.
	//
	//    * Amazon ElastiCache replication group - The resource type is replication-group
	//    and the unique identifier is the replication group name. Example: replication-group/mycluster.
	//
	//    * Neptune cluster - The resource type is cluster and the unique identifier
	//    is the cluster name. Example: cluster:mycluster.
	//
	//    * SageMaker Serverless endpoint - The resource type is variant and the
	//    unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
	//
	//    * SageMaker inference component - The resource type is inference-component
	//    and the unique identifier is the resource ID. Example: inference-component/my-inference-component.
	//
	// 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.
	//
	//    * elasticmapreduce:instancegroup:InstanceCount - The instance count of
	//    an EMR Instance Group.
	//
	//    * ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot
	//    Fleet.
	//
	//    * appstream:fleet:DesiredCapacity - The desired capacity of an AppStream
	//    2.0 fleet.
	//
	//    * dynamodb:table:ReadCapacityUnits - The provisioned read capacity for
	//    a DynamoDB table.
	//
	//    * dynamodb:table:WriteCapacityUnits - The provisioned write capacity for
	//    a DynamoDB table.
	//
	//    * dynamodb:index:ReadCapacityUnits - The provisioned read capacity for
	//    a DynamoDB global secondary index.
	//
	//    * dynamodb:index:WriteCapacityUnits - The provisioned write capacity for
	//    a DynamoDB global secondary index.
	//
	//    * rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora
	//    DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible
	//    edition.
	//
	//    * sagemaker:variant:DesiredInstanceCount - The number of EC2 instances
	//    for a SageMaker model endpoint variant.
	//
	//    * custom-resource:ResourceType:Property - The scalable dimension for a
	//    custom resource provided by your own application or service.
	//
	//    * comprehend:document-classifier-endpoint:DesiredInferenceUnits - The
	//    number of inference units for an Amazon Comprehend document classification
	//    endpoint.
	//
	//    * comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number
	//    of inference units for an Amazon Comprehend entity recognizer endpoint.
	//
	//    * lambda:function:ProvisionedConcurrency - The provisioned concurrency
	//    for a Lambda function.
	//
	//    * cassandra:table:ReadCapacityUnits - The provisioned read capacity for
	//    an Amazon Keyspaces table.
	//
	//    * cassandra:table:WriteCapacityUnits - The provisioned write capacity
	//    for an Amazon Keyspaces table.
	//
	//    * kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB)
	//    for brokers in an Amazon MSK cluster.
	//
	//    * elasticache:replication-group:NodeGroups - The number of node groups
	//    for an Amazon ElastiCache replication group.
	//
	//    * elasticache:replication-group:Replicas - The number of replicas per
	//    node group for an Amazon ElastiCache replication group.
	//
	//    * neptune:cluster:ReadReplicaCount - The count of read replicas in an
	//    Amazon Neptune DB cluster.
	//
	//    * sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency
	//    for a SageMaker Serverless endpoint.
	//
	//    * sagemaker:inference-component:DesiredCopyCount - The number of copies
	//    across an endpoint for a SageMaker inference component.
	//
	// ScalableDimension is a required field
	ScalableDimension *string `type:"string" required:"true" enum:"ScalableDimension"`

	// The namespace of the Amazon Web Services service that provides the resource.
	// For a resource provided by your own application or service, use custom-resource
	// instead.
	//
	// ServiceNamespace is a required field
	ServiceNamespace *string `type:"string" required:"true" enum:"ServiceNamespace"`
	// contains filtered or unexported fields
}

func (DeregisterScalableTargetInput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeregisterScalableTargetInput) SetResourceId added in v1.5.0

SetResourceId sets the ResourceId field's value.

func (*DeregisterScalableTargetInput) SetScalableDimension added in v1.5.0

SetScalableDimension sets the ScalableDimension field's value.

func (*DeregisterScalableTargetInput) SetServiceNamespace added in v1.5.0

SetServiceNamespace sets the ServiceNamespace field's value.

func (DeregisterScalableTargetInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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
}

func (DeregisterScalableTargetOutput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeregisterScalableTargetOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeScalableTargetsInput

type DescribeScalableTargetsInput struct {

	// The maximum number of scalable targets. 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.
	//
	//    * 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 - 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.
	//
	//    * DynamoDB table - The resource type is table and the unique identifier
	//    is the table name. Example: table/my-table.
	//
	//    * DynamoDB global secondary index - The resource type is index and the
	//    unique identifier is the index name. Example: table/my-table/index/my-table-index.
	//
	//    * Aurora DB cluster - The resource type is cluster and the unique identifier
	//    is the cluster name. Example: cluster:my-db-cluster.
	//
	//    * SageMaker endpoint variant - The resource type is variant and the unique
	//    identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
	//
	//    * Custom resources are not supported with a resource type. This parameter
	//    must specify the OutputValue from the CloudFormation template stack used
	//    to access the resources. The unique identifier is defined by the service
	//    provider. More information is available in our GitHub repository (https://github.com/aws/aws-auto-scaling-custom-resource).
	//
	//    * Amazon Comprehend document classification endpoint - The resource type
	//    and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.
	//
	//    * Amazon Comprehend entity recognizer endpoint - The resource type and
	//    unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE.
	//
	//    * Lambda provisioned concurrency - The resource type is function and the
	//    unique identifier is the function name with a function version or alias
	//    name suffix that is not $LATEST. Example: function:my-function:prod or
	//    function:my-function:1.
	//
	//    * Amazon Keyspaces table - The resource type is table and the unique identifier
	//    is the table name. Example: keyspace/mykeyspace/table/mytable.
	//
	//    * Amazon MSK cluster - The resource type and unique identifier are specified
	//    using the cluster ARN. Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.
	//
	//    * Amazon ElastiCache replication group - The resource type is replication-group
	//    and the unique identifier is the replication group name. Example: replication-group/mycluster.
	//
	//    * Neptune cluster - The resource type is cluster and the unique identifier
	//    is the cluster name. Example: cluster:mycluster.
	//
	//    * SageMaker Serverless endpoint - The resource type is variant and the
	//    unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
	//
	//    * SageMaker inference component - The resource type is inference-component
	//    and the unique identifier is the resource ID. Example: inference-component/my-inference-component.
	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.
	//
	//    * elasticmapreduce:instancegroup:InstanceCount - The instance count of
	//    an EMR Instance Group.
	//
	//    * ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot
	//    Fleet.
	//
	//    * appstream:fleet:DesiredCapacity - The desired capacity of an AppStream
	//    2.0 fleet.
	//
	//    * dynamodb:table:ReadCapacityUnits - The provisioned read capacity for
	//    a DynamoDB table.
	//
	//    * dynamodb:table:WriteCapacityUnits - The provisioned write capacity for
	//    a DynamoDB table.
	//
	//    * dynamodb:index:ReadCapacityUnits - The provisioned read capacity for
	//    a DynamoDB global secondary index.
	//
	//    * dynamodb:index:WriteCapacityUnits - The provisioned write capacity for
	//    a DynamoDB global secondary index.
	//
	//    * rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora
	//    DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible
	//    edition.
	//
	//    * sagemaker:variant:DesiredInstanceCount - The number of EC2 instances
	//    for a SageMaker model endpoint variant.
	//
	//    * custom-resource:ResourceType:Property - The scalable dimension for a
	//    custom resource provided by your own application or service.
	//
	//    * comprehend:document-classifier-endpoint:DesiredInferenceUnits - The
	//    number of inference units for an Amazon Comprehend document classification
	//    endpoint.
	//
	//    * comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number
	//    of inference units for an Amazon Comprehend entity recognizer endpoint.
	//
	//    * lambda:function:ProvisionedConcurrency - The provisioned concurrency
	//    for a Lambda function.
	//
	//    * cassandra:table:ReadCapacityUnits - The provisioned read capacity for
	//    an Amazon Keyspaces table.
	//
	//    * cassandra:table:WriteCapacityUnits - The provisioned write capacity
	//    for an Amazon Keyspaces table.
	//
	//    * kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB)
	//    for brokers in an Amazon MSK cluster.
	//
	//    * elasticache:replication-group:NodeGroups - The number of node groups
	//    for an Amazon ElastiCache replication group.
	//
	//    * elasticache:replication-group:Replicas - The number of replicas per
	//    node group for an Amazon ElastiCache replication group.
	//
	//    * neptune:cluster:ReadReplicaCount - The count of read replicas in an
	//    Amazon Neptune DB cluster.
	//
	//    * sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency
	//    for a SageMaker Serverless endpoint.
	//
	//    * sagemaker:inference-component:DesiredCopyCount - The number of copies
	//    across an endpoint for a SageMaker inference component.
	ScalableDimension *string `type:"string" enum:"ScalableDimension"`

	// The namespace of the Amazon Web Services service that provides the resource.
	// For a resource provided by your own application or service, use custom-resource
	// instead.
	//
	// ServiceNamespace is a required field
	ServiceNamespace *string `type:"string" required:"true" enum:"ServiceNamespace"`
	// contains filtered or unexported fields
}

func (DescribeScalableTargetsInput) GoString

func (s DescribeScalableTargetsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeScalableTargetsInput) SetMaxResults added in v1.5.0

SetMaxResults sets the MaxResults field's value.

func (*DescribeScalableTargetsInput) SetNextToken added in v1.5.0

SetNextToken sets the NextToken field's value.

func (*DescribeScalableTargetsInput) SetResourceIds added in v1.5.0

SetResourceIds sets the ResourceIds field's value.

func (*DescribeScalableTargetsInput) SetScalableDimension added in v1.5.0

SetScalableDimension sets the ScalableDimension field's value.

func (*DescribeScalableTargetsInput) SetServiceNamespace added in v1.5.0

SetServiceNamespace sets the ServiceNamespace field's value.

func (DescribeScalableTargetsInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 scalable targets that match the request parameters.
	ScalableTargets []*ScalableTarget `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeScalableTargetsOutput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeScalableTargetsOutput) SetNextToken added in v1.5.0

SetNextToken sets the NextToken field's value.

func (*DescribeScalableTargetsOutput) SetScalableTargets added in v1.5.0

SetScalableTargets sets the ScalableTargets field's value.

func (DescribeScalableTargetsOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeScalingActivitiesInput

type DescribeScalingActivitiesInput struct {

	// Specifies whether to include activities that aren't scaled (not scaled activities)
	// in the response. Not scaled activities are activities that aren't completed
	// or started for various reasons, such as preventing infinite scaling loops.
	// For help interpreting the not scaled reason details in the response, see
	// Scaling activities for Application Auto Scaling (https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-scaling-activities.html).
	IncludeNotScaledActivities *bool `type:"boolean"`

	// The maximum number of scalable targets. 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.
	//
	//    * 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 - 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.
	//
	//    * DynamoDB table - The resource type is table and the unique identifier
	//    is the table name. Example: table/my-table.
	//
	//    * DynamoDB global secondary index - The resource type is index and the
	//    unique identifier is the index name. Example: table/my-table/index/my-table-index.
	//
	//    * Aurora DB cluster - The resource type is cluster and the unique identifier
	//    is the cluster name. Example: cluster:my-db-cluster.
	//
	//    * SageMaker endpoint variant - The resource type is variant and the unique
	//    identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
	//
	//    * Custom resources are not supported with a resource type. This parameter
	//    must specify the OutputValue from the CloudFormation template stack used
	//    to access the resources. The unique identifier is defined by the service
	//    provider. More information is available in our GitHub repository (https://github.com/aws/aws-auto-scaling-custom-resource).
	//
	//    * Amazon Comprehend document classification endpoint - The resource type
	//    and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.
	//
	//    * Amazon Comprehend entity recognizer endpoint - The resource type and
	//    unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE.
	//
	//    * Lambda provisioned concurrency - The resource type is function and the
	//    unique identifier is the function name with a function version or alias
	//    name suffix that is not $LATEST. Example: function:my-function:prod or
	//    function:my-function:1.
	//
	//    * Amazon Keyspaces table - The resource type is table and the unique identifier
	//    is the table name. Example: keyspace/mykeyspace/table/mytable.
	//
	//    * Amazon MSK cluster - The resource type and unique identifier are specified
	//    using the cluster ARN. Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.
	//
	//    * Amazon ElastiCache replication group - The resource type is replication-group
	//    and the unique identifier is the replication group name. Example: replication-group/mycluster.
	//
	//    * Neptune cluster - The resource type is cluster and the unique identifier
	//    is the cluster name. Example: cluster:mycluster.
	//
	//    * SageMaker Serverless endpoint - The resource type is variant and the
	//    unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
	//
	//    * SageMaker inference component - The resource type is inference-component
	//    and the unique identifier is the resource ID. Example: inference-component/my-inference-component.
	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.
	//
	//    * elasticmapreduce:instancegroup:InstanceCount - The instance count of
	//    an EMR Instance Group.
	//
	//    * ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot
	//    Fleet.
	//
	//    * appstream:fleet:DesiredCapacity - The desired capacity of an AppStream
	//    2.0 fleet.
	//
	//    * dynamodb:table:ReadCapacityUnits - The provisioned read capacity for
	//    a DynamoDB table.
	//
	//    * dynamodb:table:WriteCapacityUnits - The provisioned write capacity for
	//    a DynamoDB table.
	//
	//    * dynamodb:index:ReadCapacityUnits - The provisioned read capacity for
	//    a DynamoDB global secondary index.
	//
	//    * dynamodb:index:WriteCapacityUnits - The provisioned write capacity for
	//    a DynamoDB global secondary index.
	//
	//    * rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora
	//    DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible
	//    edition.
	//
	//    * sagemaker:variant:DesiredInstanceCount - The number of EC2 instances
	//    for a SageMaker model endpoint variant.
	//
	//    * custom-resource:ResourceType:Property - The scalable dimension for a
	//    custom resource provided by your own application or service.
	//
	//    * comprehend:document-classifier-endpoint:DesiredInferenceUnits - The
	//    number of inference units for an Amazon Comprehend document classification
	//    endpoint.
	//
	//    * comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number
	//    of inference units for an Amazon Comprehend entity recognizer endpoint.
	//
	//    * lambda:function:ProvisionedConcurrency - The provisioned concurrency
	//    for a Lambda function.
	//
	//    * cassandra:table:ReadCapacityUnits - The provisioned read capacity for
	//    an Amazon Keyspaces table.
	//
	//    * cassandra:table:WriteCapacityUnits - The provisioned write capacity
	//    for an Amazon Keyspaces table.
	//
	//    * kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB)
	//    for brokers in an Amazon MSK cluster.
	//
	//    * elasticache:replication-group:NodeGroups - The number of node groups
	//    for an Amazon ElastiCache replication group.
	//
	//    * elasticache:replication-group:Replicas - The number of replicas per
	//    node group for an Amazon ElastiCache replication group.
	//
	//    * neptune:cluster:ReadReplicaCount - The count of read replicas in an
	//    Amazon Neptune DB cluster.
	//
	//    * sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency
	//    for a SageMaker Serverless endpoint.
	//
	//    * sagemaker:inference-component:DesiredCopyCount - The number of copies
	//    across an endpoint for a SageMaker inference component.
	ScalableDimension *string `type:"string" enum:"ScalableDimension"`

	// The namespace of the Amazon Web Services service that provides the resource.
	// For a resource provided by your own application or service, use custom-resource
	// instead.
	//
	// ServiceNamespace is a required field
	ServiceNamespace *string `type:"string" required:"true" enum:"ServiceNamespace"`
	// contains filtered or unexported fields
}

func (DescribeScalingActivitiesInput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeScalingActivitiesInput) SetIncludeNotScaledActivities added in v1.44.173

func (s *DescribeScalingActivitiesInput) SetIncludeNotScaledActivities(v bool) *DescribeScalingActivitiesInput

SetIncludeNotScaledActivities sets the IncludeNotScaledActivities field's value.

func (*DescribeScalingActivitiesInput) SetMaxResults added in v1.5.0

SetMaxResults sets the MaxResults field's value.

func (*DescribeScalingActivitiesInput) SetNextToken added in v1.5.0

SetNextToken sets the NextToken field's value.

func (*DescribeScalingActivitiesInput) SetResourceId added in v1.5.0

SetResourceId sets the ResourceId field's value.

func (*DescribeScalingActivitiesInput) SetScalableDimension added in v1.5.0

SetScalableDimension sets the ScalableDimension field's value.

func (*DescribeScalingActivitiesInput) SetServiceNamespace added in v1.5.0

SetServiceNamespace sets the ServiceNamespace field's value.

func (DescribeScalingActivitiesInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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
}

func (DescribeScalingActivitiesOutput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeScalingActivitiesOutput) SetNextToken added in v1.5.0

SetNextToken sets the NextToken field's value.

func (*DescribeScalingActivitiesOutput) SetScalingActivities added in v1.5.0

SetScalingActivities sets the ScalingActivities field's value.

func (DescribeScalingActivitiesOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeScalingPoliciesInput

type DescribeScalingPoliciesInput struct {

	// The maximum number of scalable targets. This value can be between 1 and 10.
	// The default value is 10.
	//
	// 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 10 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.
	//
	//    * 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 - 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.
	//
	//    * DynamoDB table - The resource type is table and the unique identifier
	//    is the table name. Example: table/my-table.
	//
	//    * DynamoDB global secondary index - The resource type is index and the
	//    unique identifier is the index name. Example: table/my-table/index/my-table-index.
	//
	//    * Aurora DB cluster - The resource type is cluster and the unique identifier
	//    is the cluster name. Example: cluster:my-db-cluster.
	//
	//    * SageMaker endpoint variant - The resource type is variant and the unique
	//    identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
	//
	//    * Custom resources are not supported with a resource type. This parameter
	//    must specify the OutputValue from the CloudFormation template stack used
	//    to access the resources. The unique identifier is defined by the service
	//    provider. More information is available in our GitHub repository (https://github.com/aws/aws-auto-scaling-custom-resource).
	//
	//    * Amazon Comprehend document classification endpoint - The resource type
	//    and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.
	//
	//    * Amazon Comprehend entity recognizer endpoint - The resource type and
	//    unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE.
	//
	//    * Lambda provisioned concurrency - The resource type is function and the
	//    unique identifier is the function name with a function version or alias
	//    name suffix that is not $LATEST. Example: function:my-function:prod or
	//    function:my-function:1.
	//
	//    * Amazon Keyspaces table - The resource type is table and the unique identifier
	//    is the table name. Example: keyspace/mykeyspace/table/mytable.
	//
	//    * Amazon MSK cluster - The resource type and unique identifier are specified
	//    using the cluster ARN. Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.
	//
	//    * Amazon ElastiCache replication group - The resource type is replication-group
	//    and the unique identifier is the replication group name. Example: replication-group/mycluster.
	//
	//    * Neptune cluster - The resource type is cluster and the unique identifier
	//    is the cluster name. Example: cluster:mycluster.
	//
	//    * SageMaker Serverless endpoint - The resource type is variant and the
	//    unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
	//
	//    * SageMaker inference component - The resource type is inference-component
	//    and the unique identifier is the resource ID. Example: inference-component/my-inference-component.
	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.
	//
	//    * elasticmapreduce:instancegroup:InstanceCount - The instance count of
	//    an EMR Instance Group.
	//
	//    * ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot
	//    Fleet.
	//
	//    * appstream:fleet:DesiredCapacity - The desired capacity of an AppStream
	//    2.0 fleet.
	//
	//    * dynamodb:table:ReadCapacityUnits - The provisioned read capacity for
	//    a DynamoDB table.
	//
	//    * dynamodb:table:WriteCapacityUnits - The provisioned write capacity for
	//    a DynamoDB table.
	//
	//    * dynamodb:index:ReadCapacityUnits - The provisioned read capacity for
	//    a DynamoDB global secondary index.
	//
	//    * dynamodb:index:WriteCapacityUnits - The provisioned write capacity for
	//    a DynamoDB global secondary index.
	//
	//    * rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora
	//    DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible
	//    edition.
	//
	//    * sagemaker:variant:DesiredInstanceCount - The number of EC2 instances
	//    for a SageMaker model endpoint variant.
	//
	//    * custom-resource:ResourceType:Property - The scalable dimension for a
	//    custom resource provided by your own application or service.
	//
	//    * comprehend:document-classifier-endpoint:DesiredInferenceUnits - The
	//    number of inference units for an Amazon Comprehend document classification
	//    endpoint.
	//
	//    * comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number
	//    of inference units for an Amazon Comprehend entity recognizer endpoint.
	//
	//    * lambda:function:ProvisionedConcurrency - The provisioned concurrency
	//    for a Lambda function.
	//
	//    * cassandra:table:ReadCapacityUnits - The provisioned read capacity for
	//    an Amazon Keyspaces table.
	//
	//    * cassandra:table:WriteCapacityUnits - The provisioned write capacity
	//    for an Amazon Keyspaces table.
	//
	//    * kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB)
	//    for brokers in an Amazon MSK cluster.
	//
	//    * elasticache:replication-group:NodeGroups - The number of node groups
	//    for an Amazon ElastiCache replication group.
	//
	//    * elasticache:replication-group:Replicas - The number of replicas per
	//    node group for an Amazon ElastiCache replication group.
	//
	//    * neptune:cluster:ReadReplicaCount - The count of read replicas in an
	//    Amazon Neptune DB cluster.
	//
	//    * sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency
	//    for a SageMaker Serverless endpoint.
	//
	//    * sagemaker:inference-component:DesiredCopyCount - The number of copies
	//    across an endpoint for a SageMaker inference component.
	ScalableDimension *string `type:"string" enum:"ScalableDimension"`

	// The namespace of the Amazon Web Services service that provides the resource.
	// For a resource provided by your own application or service, use custom-resource
	// instead.
	//
	// ServiceNamespace is a required field
	ServiceNamespace *string `type:"string" required:"true" enum:"ServiceNamespace"`
	// contains filtered or unexported fields
}

func (DescribeScalingPoliciesInput) GoString

func (s DescribeScalingPoliciesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeScalingPoliciesInput) SetMaxResults added in v1.5.0

SetMaxResults sets the MaxResults field's value.

func (*DescribeScalingPoliciesInput) SetNextToken added in v1.5.0

SetNextToken sets the NextToken field's value.

func (*DescribeScalingPoliciesInput) SetPolicyNames added in v1.5.0

SetPolicyNames sets the PolicyNames field's value.

func (*DescribeScalingPoliciesInput) SetResourceId added in v1.5.0

SetResourceId sets the ResourceId field's value.

func (*DescribeScalingPoliciesInput) SetScalableDimension added in v1.5.0

SetScalableDimension sets the ScalableDimension field's value.

func (*DescribeScalingPoliciesInput) SetServiceNamespace added in v1.5.0

SetServiceNamespace sets the ServiceNamespace field's value.

func (DescribeScalingPoliciesInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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"`

	// Information about the scaling policies.
	ScalingPolicies []*ScalingPolicy `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeScalingPoliciesOutput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeScalingPoliciesOutput) SetNextToken added in v1.5.0

SetNextToken sets the NextToken field's value.

func (*DescribeScalingPoliciesOutput) SetScalingPolicies added in v1.5.0

SetScalingPolicies sets the ScalingPolicies field's value.

func (DescribeScalingPoliciesOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeScheduledActionsInput added in v1.12.25

type DescribeScheduledActionsInput struct {

	// The maximum number of scheduled action 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 scheduled action. 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 - 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.
	//
	//    * DynamoDB table - The resource type is table and the unique identifier
	//    is the table name. Example: table/my-table.
	//
	//    * DynamoDB global secondary index - The resource type is index and the
	//    unique identifier is the index name. Example: table/my-table/index/my-table-index.
	//
	//    * Aurora DB cluster - The resource type is cluster and the unique identifier
	//    is the cluster name. Example: cluster:my-db-cluster.
	//
	//    * SageMaker endpoint variant - The resource type is variant and the unique
	//    identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
	//
	//    * Custom resources are not supported with a resource type. This parameter
	//    must specify the OutputValue from the CloudFormation template stack used
	//    to access the resources. The unique identifier is defined by the service
	//    provider. More information is available in our GitHub repository (https://github.com/aws/aws-auto-scaling-custom-resource).
	//
	//    * Amazon Comprehend document classification endpoint - The resource type
	//    and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.
	//
	//    * Amazon Comprehend entity recognizer endpoint - The resource type and
	//    unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE.
	//
	//    * Lambda provisioned concurrency - The resource type is function and the
	//    unique identifier is the function name with a function version or alias
	//    name suffix that is not $LATEST. Example: function:my-function:prod or
	//    function:my-function:1.
	//
	//    * Amazon Keyspaces table - The resource type is table and the unique identifier
	//    is the table name. Example: keyspace/mykeyspace/table/mytable.
	//
	//    * Amazon MSK cluster - The resource type and unique identifier are specified
	//    using the cluster ARN. Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.
	//
	//    * Amazon ElastiCache replication group - The resource type is replication-group
	//    and the unique identifier is the replication group name. Example: replication-group/mycluster.
	//
	//    * Neptune cluster - The resource type is cluster and the unique identifier
	//    is the cluster name. Example: cluster:mycluster.
	//
	//    * SageMaker Serverless endpoint - The resource type is variant and the
	//    unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
	//
	//    * SageMaker inference component - The resource type is inference-component
	//    and the unique identifier is the resource ID. Example: inference-component/my-inference-component.
	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.
	//
	//    * elasticmapreduce:instancegroup:InstanceCount - The instance count of
	//    an EMR Instance Group.
	//
	//    * ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot
	//    Fleet.
	//
	//    * appstream:fleet:DesiredCapacity - The desired capacity of an AppStream
	//    2.0 fleet.
	//
	//    * dynamodb:table:ReadCapacityUnits - The provisioned read capacity for
	//    a DynamoDB table.
	//
	//    * dynamodb:table:WriteCapacityUnits - The provisioned write capacity for
	//    a DynamoDB table.
	//
	//    * dynamodb:index:ReadCapacityUnits - The provisioned read capacity for
	//    a DynamoDB global secondary index.
	//
	//    * dynamodb:index:WriteCapacityUnits - The provisioned write capacity for
	//    a DynamoDB global secondary index.
	//
	//    * rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora
	//    DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible
	//    edition.
	//
	//    * sagemaker:variant:DesiredInstanceCount - The number of EC2 instances
	//    for a SageMaker model endpoint variant.
	//
	//    * custom-resource:ResourceType:Property - The scalable dimension for a
	//    custom resource provided by your own application or service.
	//
	//    * comprehend:document-classifier-endpoint:DesiredInferenceUnits - The
	//    number of inference units for an Amazon Comprehend document classification
	//    endpoint.
	//
	//    * comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number
	//    of inference units for an Amazon Comprehend entity recognizer endpoint.
	//
	//    * lambda:function:ProvisionedConcurrency - The provisioned concurrency
	//    for a Lambda function.
	//
	//    * cassandra:table:ReadCapacityUnits - The provisioned read capacity for
	//    an Amazon Keyspaces table.
	//
	//    * cassandra:table:WriteCapacityUnits - The provisioned write capacity
	//    for an Amazon Keyspaces table.
	//
	//    * kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB)
	//    for brokers in an Amazon MSK cluster.
	//
	//    * elasticache:replication-group:NodeGroups - The number of node groups
	//    for an Amazon ElastiCache replication group.
	//
	//    * elasticache:replication-group:Replicas - The number of replicas per
	//    node group for an Amazon ElastiCache replication group.
	//
	//    * neptune:cluster:ReadReplicaCount - The count of read replicas in an
	//    Amazon Neptune DB cluster.
	//
	//    * sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency
	//    for a SageMaker Serverless endpoint.
	//
	//    * sagemaker:inference-component:DesiredCopyCount - The number of copies
	//    across an endpoint for a SageMaker inference component.
	ScalableDimension *string `type:"string" enum:"ScalableDimension"`

	// The names of the scheduled actions to describe.
	ScheduledActionNames []*string `type:"list"`

	// The namespace of the Amazon Web Services service that provides the resource.
	// For a resource provided by your own application or service, use custom-resource
	// instead.
	//
	// ServiceNamespace is a required field
	ServiceNamespace *string `type:"string" required:"true" enum:"ServiceNamespace"`
	// contains filtered or unexported fields
}

func (DescribeScheduledActionsInput) GoString added in v1.12.25

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeScheduledActionsInput) SetMaxResults added in v1.12.25

SetMaxResults sets the MaxResults field's value.

func (*DescribeScheduledActionsInput) SetNextToken added in v1.12.25

SetNextToken sets the NextToken field's value.

func (*DescribeScheduledActionsInput) SetResourceId added in v1.12.25

SetResourceId sets the ResourceId field's value.

func (*DescribeScheduledActionsInput) SetScalableDimension added in v1.12.25

SetScalableDimension sets the ScalableDimension field's value.

func (*DescribeScheduledActionsInput) SetScheduledActionNames added in v1.12.25

func (s *DescribeScheduledActionsInput) SetScheduledActionNames(v []*string) *DescribeScheduledActionsInput

SetScheduledActionNames sets the ScheduledActionNames field's value.

func (*DescribeScheduledActionsInput) SetServiceNamespace added in v1.12.25

SetServiceNamespace sets the ServiceNamespace field's value.

func (DescribeScheduledActionsInput) String added in v1.12.25

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeScheduledActionsInput) Validate added in v1.12.25

func (s *DescribeScheduledActionsInput) Validate() error

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

type DescribeScheduledActionsOutput added in v1.12.25

type DescribeScheduledActionsOutput 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"`

	// Information about the scheduled actions.
	ScheduledActions []*ScheduledAction `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeScheduledActionsOutput) GoString added in v1.12.25

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeScheduledActionsOutput) SetNextToken added in v1.12.25

SetNextToken sets the NextToken field's value.

func (*DescribeScheduledActionsOutput) SetScheduledActions added in v1.12.25

SetScheduledActions sets the ScheduledActions field's value.

func (DescribeScheduledActionsOutput) String added in v1.12.25

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type FailedResourceAccessException added in v1.28.0

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

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

Failed access to resources caused an exception. This exception 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 permission to call the CloudWatch DescribeAlarms (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_DescribeAlarms.html) on your behalf.

func (*FailedResourceAccessException) Code added in v1.28.0

Code returns the exception type name.

func (*FailedResourceAccessException) Error added in v1.28.0

func (FailedResourceAccessException) GoString added in v1.28.0

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FailedResourceAccessException) Message added in v1.28.0

Message returns the exception's message.

func (*FailedResourceAccessException) OrigErr added in v1.28.0

func (s *FailedResourceAccessException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*FailedResourceAccessException) RequestID added in v1.28.0

func (s *FailedResourceAccessException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*FailedResourceAccessException) StatusCode added in v1.28.0

func (s *FailedResourceAccessException) StatusCode() int

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

func (FailedResourceAccessException) String added in v1.28.0

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InternalServiceException added in v1.28.0

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

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

The service encountered an internal error.

func (*InternalServiceException) Code added in v1.28.0

func (s *InternalServiceException) Code() string

Code returns the exception type name.

func (*InternalServiceException) Error added in v1.28.0

func (s *InternalServiceException) Error() string

func (InternalServiceException) GoString added in v1.28.0

func (s InternalServiceException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InternalServiceException) Message added in v1.28.0

func (s *InternalServiceException) Message() string

Message returns the exception's message.

func (*InternalServiceException) OrigErr added in v1.28.0

func (s *InternalServiceException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalServiceException) RequestID added in v1.28.0

func (s *InternalServiceException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalServiceException) StatusCode added in v1.28.0

func (s *InternalServiceException) StatusCode() int

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

func (InternalServiceException) String added in v1.28.0

func (s InternalServiceException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InvalidNextTokenException added in v1.28.0

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

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

The next token supplied was invalid.

func (*InvalidNextTokenException) Code added in v1.28.0

Code returns the exception type name.

func (*InvalidNextTokenException) Error added in v1.28.0

func (s *InvalidNextTokenException) Error() string

func (InvalidNextTokenException) GoString added in v1.28.0

func (s InvalidNextTokenException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InvalidNextTokenException) Message added in v1.28.0

func (s *InvalidNextTokenException) Message() string

Message returns the exception's message.

func (*InvalidNextTokenException) OrigErr added in v1.28.0

func (s *InvalidNextTokenException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidNextTokenException) RequestID added in v1.28.0

func (s *InvalidNextTokenException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidNextTokenException) StatusCode added in v1.28.0

func (s *InvalidNextTokenException) StatusCode() int

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

func (InvalidNextTokenException) String added in v1.28.0

func (s InvalidNextTokenException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type LimitExceededException added in v1.28.0

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

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

A per-account resource limit is exceeded. For more information, see Application Auto Scaling service quotas (https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-limits.html).

func (*LimitExceededException) Code added in v1.28.0

func (s *LimitExceededException) Code() string

Code returns the exception type name.

func (*LimitExceededException) Error added in v1.28.0

func (s *LimitExceededException) Error() string

func (LimitExceededException) GoString added in v1.28.0

func (s LimitExceededException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LimitExceededException) Message added in v1.28.0

func (s *LimitExceededException) Message() string

Message returns the exception's message.

func (*LimitExceededException) OrigErr added in v1.28.0

func (s *LimitExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*LimitExceededException) RequestID added in v1.28.0

func (s *LimitExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*LimitExceededException) StatusCode added in v1.28.0

func (s *LimitExceededException) StatusCode() int

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

func (LimitExceededException) String added in v1.28.0

func (s LimitExceededException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListTagsForResourceInput added in v1.44.225

type ListTagsForResourceInput struct {

	// Specify the ARN of the scalable target.
	//
	// For example: arn:aws:application-autoscaling:us-east-1:123456789012:scalable-target/1234abcd56ab78cd901ef1234567890ab123
	//
	// To get the ARN for a scalable target, use DescribeScalableTargets.
	//
	// ResourceARN is a required field
	ResourceARN *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceInput) GoString added in v1.44.225

func (s ListTagsForResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) SetResourceARN added in v1.44.225

SetResourceARN sets the ResourceARN field's value.

func (ListTagsForResourceInput) String added in v1.44.225

func (s ListTagsForResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) Validate added in v1.44.225

func (s *ListTagsForResourceInput) Validate() error

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

type ListTagsForResourceOutput added in v1.44.225

type ListTagsForResourceOutput struct {

	// A list of tags. Each tag consists of a tag key and a tag value.
	Tags map[string]*string `type:"map"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceOutput) GoString added in v1.44.225

func (s ListTagsForResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceOutput) SetTags added in v1.44.225

SetTags sets the Tags field's value.

func (ListTagsForResourceOutput) String added in v1.44.225

func (s ListTagsForResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type MetricDimension added in v1.8.42

type MetricDimension struct {

	// The name of the dimension.
	//
	// Name is a required field
	Name *string `type:"string" required:"true"`

	// The value of the dimension.
	//
	// Value is a required field
	Value *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Describes the dimension names and values associated with a metric.

func (MetricDimension) GoString added in v1.8.42

func (s MetricDimension) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MetricDimension) SetName added in v1.8.42

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

SetName sets the Name field's value.

func (*MetricDimension) SetValue added in v1.8.42

func (s *MetricDimension) SetValue(v string) *MetricDimension

SetValue sets the Value field's value.

func (MetricDimension) String added in v1.8.42

func (s MetricDimension) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MetricDimension) Validate added in v1.8.42

func (s *MetricDimension) Validate() error

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

type NotScaledReason added in v1.44.173

type NotScaledReason struct {

	// A code that represents the reason for not scaling.
	//
	// Valid values:
	//
	//    * AutoScalingAnticipatedFlapping
	//
	//    * TargetServicePutResourceAsUnscalable
	//
	//    * AlreadyAtMaxCapacity
	//
	//    * AlreadyAtMinCapacity
	//
	//    * AlreadyAtDesiredCapacity
	//
	// Code is a required field
	Code *string `type:"string" required:"true"`

	// The current capacity.
	CurrentCapacity *int64 `type:"integer"`

	// The maximum capacity.
	MaxCapacity *int64 `type:"integer"`

	// The minimum capacity.
	MinCapacity *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Describes the reason for an activity that isn't scaled (not scaled activity), in machine-readable format. For help interpreting the not scaled reason details, see Scaling activities for Application Auto Scaling (https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-scaling-activities.html).

func (NotScaledReason) GoString added in v1.44.173

func (s NotScaledReason) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*NotScaledReason) SetCode added in v1.44.173

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

SetCode sets the Code field's value.

func (*NotScaledReason) SetCurrentCapacity added in v1.44.173

func (s *NotScaledReason) SetCurrentCapacity(v int64) *NotScaledReason

SetCurrentCapacity sets the CurrentCapacity field's value.

func (*NotScaledReason) SetMaxCapacity added in v1.44.173

func (s *NotScaledReason) SetMaxCapacity(v int64) *NotScaledReason

SetMaxCapacity sets the MaxCapacity field's value.

func (*NotScaledReason) SetMinCapacity added in v1.44.173

func (s *NotScaledReason) SetMinCapacity(v int64) *NotScaledReason

SetMinCapacity sets the MinCapacity field's value.

func (NotScaledReason) String added in v1.44.173

func (s NotScaledReason) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ObjectNotFoundException added in v1.28.0

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

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

The specified object could not be found. For any operation that 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 operation that deletes or deregisters a resource, this exception is thrown if the resource cannot be found.

func (*ObjectNotFoundException) Code added in v1.28.0

func (s *ObjectNotFoundException) Code() string

Code returns the exception type name.

func (*ObjectNotFoundException) Error added in v1.28.0

func (s *ObjectNotFoundException) Error() string

func (ObjectNotFoundException) GoString added in v1.28.0

func (s ObjectNotFoundException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ObjectNotFoundException) Message added in v1.28.0

func (s *ObjectNotFoundException) Message() string

Message returns the exception's message.

func (*ObjectNotFoundException) OrigErr added in v1.28.0

func (s *ObjectNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ObjectNotFoundException) RequestID added in v1.28.0

func (s *ObjectNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ObjectNotFoundException) StatusCode added in v1.28.0

func (s *ObjectNotFoundException) StatusCode() int

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

func (ObjectNotFoundException) String added in v1.28.0

func (s ObjectNotFoundException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PredefinedMetricSpecification added in v1.8.42

type PredefinedMetricSpecification struct {

	// The metric type. The ALBRequestCountPerTarget metric type applies only to
	// Spot Fleets and ECS services.
	//
	// PredefinedMetricType is a required field
	PredefinedMetricType *string `type:"string" required:"true" enum:"MetricType"`

	// Identifies the resource associated with the metric type. You can't specify
	// a resource label unless the metric type is ALBRequestCountPerTarget and there
	// is a target group attached to the Spot Fleet or ECS service.
	//
	// You create the resource label by appending the final portion of the load
	// balancer ARN and the final portion of the target group ARN into a single
	// value, separated by a forward slash (/). The format of the resource label
	// is:
	//
	// app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff.
	//
	// Where:
	//
	//    * app/<load-balancer-name>/<load-balancer-id> is the final portion of
	//    the load balancer ARN
	//
	//    * targetgroup/<target-group-name>/<target-group-id> is the final portion
	//    of the target group ARN.
	//
	// To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers
	// (https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html)
	// API operation. To find the ARN for the target group, use the DescribeTargetGroups
	// (https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeTargetGroups.html)
	// API operation.
	ResourceLabel *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Represents a predefined metric for a target tracking scaling policy to use with Application Auto Scaling.

Only the Amazon Web Services that you're using send metrics to Amazon CloudWatch. To determine whether a desired metric already exists by looking up its namespace and dimension using the CloudWatch metrics dashboard in the console, follow the procedure in Monitor your resources using CloudWatch (https://docs.aws.amazon.com/autoscaling/application/userguide/monitoring-cloudwatch.html) in the Application Auto Scaling User Guide.

func (PredefinedMetricSpecification) GoString added in v1.8.42

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PredefinedMetricSpecification) SetPredefinedMetricType added in v1.8.42

SetPredefinedMetricType sets the PredefinedMetricType field's value.

func (*PredefinedMetricSpecification) SetResourceLabel added in v1.8.42

SetResourceLabel sets the ResourceLabel field's value.

func (PredefinedMetricSpecification) String added in v1.8.42

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PredefinedMetricSpecification) Validate added in v1.8.42

func (s *PredefinedMetricSpecification) Validate() error

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

type PutScalingPolicyInput

type PutScalingPolicyInput struct {

	// The name of the scaling policy.
	//
	// You cannot change the name of a scaling policy, but you can delete the original
	// scaling policy and create a new scaling policy with the same settings and
	// a different name.
	//
	// PolicyName is a required field
	PolicyName *string `min:"1" type:"string" required:"true"`

	// The scaling policy type. This parameter is required if you are creating a
	// scaling policy.
	//
	// The following policy types are supported:
	//
	// TargetTrackingScaling—Not supported for Amazon EMR.
	//
	// StepScaling—Not supported for DynamoDB, Amazon Comprehend, Lambda, Amazon
	// Keyspaces, Amazon MSK, Amazon ElastiCache, or Neptune.
	//
	// For more information, see Target tracking scaling policies (https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-target-tracking.html)
	// and Step scaling policies (https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-step-scaling-policies.html)
	// in the Application Auto Scaling User Guide.
	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 - 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.
	//
	//    * DynamoDB table - The resource type is table and the unique identifier
	//    is the table name. Example: table/my-table.
	//
	//    * DynamoDB global secondary index - The resource type is index and the
	//    unique identifier is the index name. Example: table/my-table/index/my-table-index.
	//
	//    * Aurora DB cluster - The resource type is cluster and the unique identifier
	//    is the cluster name. Example: cluster:my-db-cluster.
	//
	//    * SageMaker endpoint variant - The resource type is variant and the unique
	//    identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
	//
	//    * Custom resources are not supported with a resource type. This parameter
	//    must specify the OutputValue from the CloudFormation template stack used
	//    to access the resources. The unique identifier is defined by the service
	//    provider. More information is available in our GitHub repository (https://github.com/aws/aws-auto-scaling-custom-resource).
	//
	//    * Amazon Comprehend document classification endpoint - The resource type
	//    and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.
	//
	//    * Amazon Comprehend entity recognizer endpoint - The resource type and
	//    unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE.
	//
	//    * Lambda provisioned concurrency - The resource type is function and the
	//    unique identifier is the function name with a function version or alias
	//    name suffix that is not $LATEST. Example: function:my-function:prod or
	//    function:my-function:1.
	//
	//    * Amazon Keyspaces table - The resource type is table and the unique identifier
	//    is the table name. Example: keyspace/mykeyspace/table/mytable.
	//
	//    * Amazon MSK cluster - The resource type and unique identifier are specified
	//    using the cluster ARN. Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.
	//
	//    * Amazon ElastiCache replication group - The resource type is replication-group
	//    and the unique identifier is the replication group name. Example: replication-group/mycluster.
	//
	//    * Neptune cluster - The resource type is cluster and the unique identifier
	//    is the cluster name. Example: cluster:mycluster.
	//
	//    * SageMaker Serverless endpoint - The resource type is variant and the
	//    unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
	//
	//    * SageMaker inference component - The resource type is inference-component
	//    and the unique identifier is the resource ID. Example: inference-component/my-inference-component.
	//
	// 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.
	//
	//    * elasticmapreduce:instancegroup:InstanceCount - The instance count of
	//    an EMR Instance Group.
	//
	//    * ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot
	//    Fleet.
	//
	//    * appstream:fleet:DesiredCapacity - The desired capacity of an AppStream
	//    2.0 fleet.
	//
	//    * dynamodb:table:ReadCapacityUnits - The provisioned read capacity for
	//    a DynamoDB table.
	//
	//    * dynamodb:table:WriteCapacityUnits - The provisioned write capacity for
	//    a DynamoDB table.
	//
	//    * dynamodb:index:ReadCapacityUnits - The provisioned read capacity for
	//    a DynamoDB global secondary index.
	//
	//    * dynamodb:index:WriteCapacityUnits - The provisioned write capacity for
	//    a DynamoDB global secondary index.
	//
	//    * rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora
	//    DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible
	//    edition.
	//
	//    * sagemaker:variant:DesiredInstanceCount - The number of EC2 instances
	//    for a SageMaker model endpoint variant.
	//
	//    * custom-resource:ResourceType:Property - The scalable dimension for a
	//    custom resource provided by your own application or service.
	//
	//    * comprehend:document-classifier-endpoint:DesiredInferenceUnits - The
	//    number of inference units for an Amazon Comprehend document classification
	//    endpoint.
	//
	//    * comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number
	//    of inference units for an Amazon Comprehend entity recognizer endpoint.
	//
	//    * lambda:function:ProvisionedConcurrency - The provisioned concurrency
	//    for a Lambda function.
	//
	//    * cassandra:table:ReadCapacityUnits - The provisioned read capacity for
	//    an Amazon Keyspaces table.
	//
	//    * cassandra:table:WriteCapacityUnits - The provisioned write capacity
	//    for an Amazon Keyspaces table.
	//
	//    * kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB)
	//    for brokers in an Amazon MSK cluster.
	//
	//    * elasticache:replication-group:NodeGroups - The number of node groups
	//    for an Amazon ElastiCache replication group.
	//
	//    * elasticache:replication-group:Replicas - The number of replicas per
	//    node group for an Amazon ElastiCache replication group.
	//
	//    * neptune:cluster:ReadReplicaCount - The count of read replicas in an
	//    Amazon Neptune DB cluster.
	//
	//    * sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency
	//    for a SageMaker Serverless endpoint.
	//
	//    * sagemaker:inference-component:DesiredCopyCount - The number of copies
	//    across an endpoint for a SageMaker inference component.
	//
	// ScalableDimension is a required field
	ScalableDimension *string `type:"string" required:"true" enum:"ScalableDimension"`

	// The namespace of the Amazon Web Services service that provides the resource.
	// For a resource provided by your own application or service, use custom-resource
	// instead.
	//
	// ServiceNamespace is a required field
	ServiceNamespace *string `type:"string" required:"true" enum:"ServiceNamespace"`

	// A step scaling policy.
	//
	// This parameter is required if you are creating a policy and the policy type
	// is StepScaling.
	StepScalingPolicyConfiguration *StepScalingPolicyConfiguration `type:"structure"`

	// A target tracking scaling policy. Includes support for predefined or customized
	// metrics.
	//
	// This parameter is required if you are creating a policy and the policy type
	// is TargetTrackingScaling.
	TargetTrackingScalingPolicyConfiguration *TargetTrackingScalingPolicyConfiguration `type:"structure"`
	// contains filtered or unexported fields
}

func (PutScalingPolicyInput) GoString

func (s PutScalingPolicyInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutScalingPolicyInput) SetPolicyName added in v1.5.0

func (s *PutScalingPolicyInput) SetPolicyName(v string) *PutScalingPolicyInput

SetPolicyName sets the PolicyName field's value.

func (*PutScalingPolicyInput) SetPolicyType added in v1.5.0

func (s *PutScalingPolicyInput) SetPolicyType(v string) *PutScalingPolicyInput

SetPolicyType sets the PolicyType field's value.

func (*PutScalingPolicyInput) SetResourceId added in v1.5.0

func (s *PutScalingPolicyInput) SetResourceId(v string) *PutScalingPolicyInput

SetResourceId sets the ResourceId field's value.

func (*PutScalingPolicyInput) SetScalableDimension added in v1.5.0

func (s *PutScalingPolicyInput) SetScalableDimension(v string) *PutScalingPolicyInput

SetScalableDimension sets the ScalableDimension field's value.

func (*PutScalingPolicyInput) SetServiceNamespace added in v1.5.0

func (s *PutScalingPolicyInput) SetServiceNamespace(v string) *PutScalingPolicyInput

SetServiceNamespace sets the ServiceNamespace field's value.

func (*PutScalingPolicyInput) SetStepScalingPolicyConfiguration added in v1.5.0

func (s *PutScalingPolicyInput) SetStepScalingPolicyConfiguration(v *StepScalingPolicyConfiguration) *PutScalingPolicyInput

SetStepScalingPolicyConfiguration sets the StepScalingPolicyConfiguration field's value.

func (*PutScalingPolicyInput) SetTargetTrackingScalingPolicyConfiguration added in v1.8.42

func (s *PutScalingPolicyInput) SetTargetTrackingScalingPolicyConfiguration(v *TargetTrackingScalingPolicyConfiguration) *PutScalingPolicyInput

SetTargetTrackingScalingPolicyConfiguration sets the TargetTrackingScalingPolicyConfiguration field's value.

func (PutScalingPolicyInput) String

func (s PutScalingPolicyInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 CloudWatch alarms created for the target tracking scaling policy.
	Alarms []*Alarm `type:"list"`

	// 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
}

func (PutScalingPolicyOutput) GoString

func (s PutScalingPolicyOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutScalingPolicyOutput) SetAlarms added in v1.8.42

SetAlarms sets the Alarms field's value.

func (*PutScalingPolicyOutput) SetPolicyARN added in v1.5.0

SetPolicyARN sets the PolicyARN field's value.

func (PutScalingPolicyOutput) String

func (s PutScalingPolicyOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PutScheduledActionInput added in v1.12.25

type PutScheduledActionInput struct {

	// The date and time for the recurring schedule to end, in UTC.
	EndTime *time.Time `type:"timestamp"`

	// The identifier of the resource associated with the scheduled action. 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 - 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.
	//
	//    * DynamoDB table - The resource type is table and the unique identifier
	//    is the table name. Example: table/my-table.
	//
	//    * DynamoDB global secondary index - The resource type is index and the
	//    unique identifier is the index name. Example: table/my-table/index/my-table-index.
	//
	//    * Aurora DB cluster - The resource type is cluster and the unique identifier
	//    is the cluster name. Example: cluster:my-db-cluster.
	//
	//    * SageMaker endpoint variant - The resource type is variant and the unique
	//    identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
	//
	//    * Custom resources are not supported with a resource type. This parameter
	//    must specify the OutputValue from the CloudFormation template stack used
	//    to access the resources. The unique identifier is defined by the service
	//    provider. More information is available in our GitHub repository (https://github.com/aws/aws-auto-scaling-custom-resource).
	//
	//    * Amazon Comprehend document classification endpoint - The resource type
	//    and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.
	//
	//    * Amazon Comprehend entity recognizer endpoint - The resource type and
	//    unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE.
	//
	//    * Lambda provisioned concurrency - The resource type is function and the
	//    unique identifier is the function name with a function version or alias
	//    name suffix that is not $LATEST. Example: function:my-function:prod or
	//    function:my-function:1.
	//
	//    * Amazon Keyspaces table - The resource type is table and the unique identifier
	//    is the table name. Example: keyspace/mykeyspace/table/mytable.
	//
	//    * Amazon MSK cluster - The resource type and unique identifier are specified
	//    using the cluster ARN. Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.
	//
	//    * Amazon ElastiCache replication group - The resource type is replication-group
	//    and the unique identifier is the replication group name. Example: replication-group/mycluster.
	//
	//    * Neptune cluster - The resource type is cluster and the unique identifier
	//    is the cluster name. Example: cluster:mycluster.
	//
	//    * SageMaker Serverless endpoint - The resource type is variant and the
	//    unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
	//
	//    * SageMaker inference component - The resource type is inference-component
	//    and the unique identifier is the resource ID. Example: inference-component/my-inference-component.
	//
	// 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.
	//
	//    * elasticmapreduce:instancegroup:InstanceCount - The instance count of
	//    an EMR Instance Group.
	//
	//    * ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot
	//    Fleet.
	//
	//    * appstream:fleet:DesiredCapacity - The desired capacity of an AppStream
	//    2.0 fleet.
	//
	//    * dynamodb:table:ReadCapacityUnits - The provisioned read capacity for
	//    a DynamoDB table.
	//
	//    * dynamodb:table:WriteCapacityUnits - The provisioned write capacity for
	//    a DynamoDB table.
	//
	//    * dynamodb:index:ReadCapacityUnits - The provisioned read capacity for
	//    a DynamoDB global secondary index.
	//
	//    * dynamodb:index:WriteCapacityUnits - The provisioned write capacity for
	//    a DynamoDB global secondary index.
	//
	//    * rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora
	//    DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible
	//    edition.
	//
	//    * sagemaker:variant:DesiredInstanceCount - The number of EC2 instances
	//    for a SageMaker model endpoint variant.
	//
	//    * custom-resource:ResourceType:Property - The scalable dimension for a
	//    custom resource provided by your own application or service.
	//
	//    * comprehend:document-classifier-endpoint:DesiredInferenceUnits - The
	//    number of inference units for an Amazon Comprehend document classification
	//    endpoint.
	//
	//    * comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number
	//    of inference units for an Amazon Comprehend entity recognizer endpoint.
	//
	//    * lambda:function:ProvisionedConcurrency - The provisioned concurrency
	//    for a Lambda function.
	//
	//    * cassandra:table:ReadCapacityUnits - The provisioned read capacity for
	//    an Amazon Keyspaces table.
	//
	//    * cassandra:table:WriteCapacityUnits - The provisioned write capacity
	//    for an Amazon Keyspaces table.
	//
	//    * kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB)
	//    for brokers in an Amazon MSK cluster.
	//
	//    * elasticache:replication-group:NodeGroups - The number of node groups
	//    for an Amazon ElastiCache replication group.
	//
	//    * elasticache:replication-group:Replicas - The number of replicas per
	//    node group for an Amazon ElastiCache replication group.
	//
	//    * neptune:cluster:ReadReplicaCount - The count of read replicas in an
	//    Amazon Neptune DB cluster.
	//
	//    * sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency
	//    for a SageMaker Serverless endpoint.
	//
	//    * sagemaker:inference-component:DesiredCopyCount - The number of copies
	//    across an endpoint for a SageMaker inference component.
	//
	// ScalableDimension is a required field
	ScalableDimension *string `type:"string" required:"true" enum:"ScalableDimension"`

	// The new minimum and maximum capacity. You can set both values or just one.
	// At the scheduled time, if the current capacity is below the minimum capacity,
	// Application Auto Scaling scales out to the minimum capacity. If the current
	// capacity is above the maximum capacity, Application Auto Scaling scales in
	// to the maximum capacity.
	ScalableTargetAction *ScalableTargetAction `type:"structure"`

	// The schedule for this action. The following formats are supported:
	//
	//    * At expressions - "at(yyyy-mm-ddThh:mm:ss)"
	//
	//    * Rate expressions - "rate(value unit)"
	//
	//    * Cron expressions - "cron(fields)"
	//
	// At expressions are useful for one-time schedules. Cron expressions are useful
	// for scheduled actions that run periodically at a specified date and time,
	// and rate expressions are useful for scheduled actions that run at a regular
	// interval.
	//
	// At and cron expressions use Universal Coordinated Time (UTC) by default.
	//
	// The cron format consists of six fields separated by white spaces: [Minutes]
	// [Hours] [Day_of_Month] [Month] [Day_of_Week] [Year].
	//
	// For rate expressions, value is a positive integer and unit is minute | minutes
	// | hour | hours | day | days.
	//
	// For more information and examples, see Example scheduled actions for Application
	// Auto Scaling (https://docs.aws.amazon.com/autoscaling/application/userguide/examples-scheduled-actions.html)
	// in the Application Auto Scaling User Guide.
	Schedule *string `min:"1" type:"string"`

	// The name of the scheduled action. This name must be unique among all other
	// scheduled actions on the specified scalable target.
	//
	// ScheduledActionName is a required field
	ScheduledActionName *string `min:"1" type:"string" required:"true"`

	// The namespace of the Amazon Web Services service that provides the resource.
	// For a resource provided by your own application or service, use custom-resource
	// instead.
	//
	// ServiceNamespace is a required field
	ServiceNamespace *string `type:"string" required:"true" enum:"ServiceNamespace"`

	// The date and time for this scheduled action to start, in UTC.
	StartTime *time.Time `type:"timestamp"`

	// Specifies the time zone used when setting a scheduled action by using an
	// at or cron expression. If a time zone is not provided, UTC is used by default.
	//
	// Valid values are the canonical names of the IANA time zones supported by
	// Joda-Time (such as Etc/GMT+9 or Pacific/Tahiti). For more information, see
	// https://www.joda.org/joda-time/timezones.html (https://www.joda.org/joda-time/timezones.html).
	Timezone *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (PutScheduledActionInput) GoString added in v1.12.25

func (s PutScheduledActionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutScheduledActionInput) SetEndTime added in v1.12.25

SetEndTime sets the EndTime field's value.

func (*PutScheduledActionInput) SetResourceId added in v1.12.25

SetResourceId sets the ResourceId field's value.

func (*PutScheduledActionInput) SetScalableDimension added in v1.12.25

func (s *PutScheduledActionInput) SetScalableDimension(v string) *PutScheduledActionInput

SetScalableDimension sets the ScalableDimension field's value.

func (*PutScheduledActionInput) SetScalableTargetAction added in v1.12.25

SetScalableTargetAction sets the ScalableTargetAction field's value.

func (*PutScheduledActionInput) SetSchedule added in v1.12.25

SetSchedule sets the Schedule field's value.

func (*PutScheduledActionInput) SetScheduledActionName added in v1.12.25

func (s *PutScheduledActionInput) SetScheduledActionName(v string) *PutScheduledActionInput

SetScheduledActionName sets the ScheduledActionName field's value.

func (*PutScheduledActionInput) SetServiceNamespace added in v1.12.25

func (s *PutScheduledActionInput) SetServiceNamespace(v string) *PutScheduledActionInput

SetServiceNamespace sets the ServiceNamespace field's value.

func (*PutScheduledActionInput) SetStartTime added in v1.12.25

SetStartTime sets the StartTime field's value.

func (*PutScheduledActionInput) SetTimezone added in v1.37.2

SetTimezone sets the Timezone field's value.

func (PutScheduledActionInput) String added in v1.12.25

func (s PutScheduledActionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutScheduledActionInput) Validate added in v1.12.25

func (s *PutScheduledActionInput) Validate() error

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

type PutScheduledActionOutput added in v1.12.25

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

func (PutScheduledActionOutput) GoString added in v1.12.25

func (s PutScheduledActionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (PutScheduledActionOutput) String added in v1.12.25

func (s PutScheduledActionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RegisterScalableTargetInput

type RegisterScalableTargetInput struct {

	// The maximum value that you plan to scale out to. When a scaling policy is
	// in effect, Application Auto Scaling can scale out (expand) as needed to the
	// maximum capacity limit in response to changing demand. This property is required
	// when registering a new scalable target.
	//
	// Although you can specify a large maximum capacity, note that service quotas
	// might impose lower limits. Each service has its own default quotas for the
	// maximum capacity of the resource. If you want to specify a higher limit,
	// you can request an increase. For more information, consult the documentation
	// for that service. For information about the default quotas for each service,
	// see Service endpoints and quotas (https://docs.aws.amazon.com/general/latest/gr/aws-service-information.html)
	// in the Amazon Web Services General Reference.
	MaxCapacity *int64 `type:"integer"`

	// The minimum value that you plan to scale in to. When a scaling policy is
	// in effect, Application Auto Scaling can scale in (contract) as needed to
	// the minimum capacity limit in response to changing demand. This property
	// is required when registering a new scalable target.
	//
	// For the following resources, the minimum value allowed is 0.
	//
	//    * AppStream 2.0 fleets
	//
	//    * Aurora DB clusters
	//
	//    * ECS services
	//
	//    * EMR clusters
	//
	//    * Lambda provisioned concurrency
	//
	//    * SageMaker endpoint variants
	//
	//    * SageMaker Serverless endpoint provisioned concurrency
	//
	//    * Spot Fleets
	//
	//    * custom resources
	//
	// It's strongly recommended that you specify a value greater than 0. A value
	// greater than 0 means that data points are continuously reported to CloudWatch
	// that scaling policies can use to scale on a metric like average CPU utilization.
	//
	// For all other resources, the minimum allowed value depends on the type of
	// resource that you are using. If you provide a value that is lower than what
	// a resource can accept, an error occurs. In which case, the error message
	// will provide the minimum value that the resource can accept.
	MinCapacity *int64 `type:"integer"`

	// The identifier of the resource that is 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 - 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.
	//
	//    * DynamoDB table - The resource type is table and the unique identifier
	//    is the table name. Example: table/my-table.
	//
	//    * DynamoDB global secondary index - The resource type is index and the
	//    unique identifier is the index name. Example: table/my-table/index/my-table-index.
	//
	//    * Aurora DB cluster - The resource type is cluster and the unique identifier
	//    is the cluster name. Example: cluster:my-db-cluster.
	//
	//    * SageMaker endpoint variant - The resource type is variant and the unique
	//    identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
	//
	//    * Custom resources are not supported with a resource type. This parameter
	//    must specify the OutputValue from the CloudFormation template stack used
	//    to access the resources. The unique identifier is defined by the service
	//    provider. More information is available in our GitHub repository (https://github.com/aws/aws-auto-scaling-custom-resource).
	//
	//    * Amazon Comprehend document classification endpoint - The resource type
	//    and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.
	//
	//    * Amazon Comprehend entity recognizer endpoint - The resource type and
	//    unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE.
	//
	//    * Lambda provisioned concurrency - The resource type is function and the
	//    unique identifier is the function name with a function version or alias
	//    name suffix that is not $LATEST. Example: function:my-function:prod or
	//    function:my-function:1.
	//
	//    * Amazon Keyspaces table - The resource type is table and the unique identifier
	//    is the table name. Example: keyspace/mykeyspace/table/mytable.
	//
	//    * Amazon MSK cluster - The resource type and unique identifier are specified
	//    using the cluster ARN. Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.
	//
	//    * Amazon ElastiCache replication group - The resource type is replication-group
	//    and the unique identifier is the replication group name. Example: replication-group/mycluster.
	//
	//    * Neptune cluster - The resource type is cluster and the unique identifier
	//    is the cluster name. Example: cluster:mycluster.
	//
	//    * SageMaker Serverless endpoint - The resource type is variant and the
	//    unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
	//
	//    * SageMaker inference component - The resource type is inference-component
	//    and the unique identifier is the resource ID. Example: inference-component/my-inference-component.
	//
	// ResourceId is a required field
	ResourceId *string `min:"1" type:"string" required:"true"`

	// This parameter is required for services that do not support service-linked
	// roles (such as Amazon EMR), and it must specify the ARN of an IAM role that
	// allows Application Auto Scaling to modify the scalable target on your behalf.
	//
	// If the service supports service-linked roles, Application Auto Scaling uses
	// a service-linked role, which it creates if it does not yet exist. For more
	// information, see Application Auto Scaling IAM roles (https://docs.aws.amazon.com/autoscaling/application/userguide/security_iam_service-with-iam.html#security_iam_service-with-iam-roles).
	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.
	//
	//    * elasticmapreduce:instancegroup:InstanceCount - The instance count of
	//    an EMR Instance Group.
	//
	//    * ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot
	//    Fleet.
	//
	//    * appstream:fleet:DesiredCapacity - The desired capacity of an AppStream
	//    2.0 fleet.
	//
	//    * dynamodb:table:ReadCapacityUnits - The provisioned read capacity for
	//    a DynamoDB table.
	//
	//    * dynamodb:table:WriteCapacityUnits - The provisioned write capacity for
	//    a DynamoDB table.
	//
	//    * dynamodb:index:ReadCapacityUnits - The provisioned read capacity for
	//    a DynamoDB global secondary index.
	//
	//    * dynamodb:index:WriteCapacityUnits - The provisioned write capacity for
	//    a DynamoDB global secondary index.
	//
	//    * rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora
	//    DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible
	//    edition.
	//
	//    * sagemaker:variant:DesiredInstanceCount - The number of EC2 instances
	//    for a SageMaker model endpoint variant.
	//
	//    * custom-resource:ResourceType:Property - The scalable dimension for a
	//    custom resource provided by your own application or service.
	//
	//    * comprehend:document-classifier-endpoint:DesiredInferenceUnits - The
	//    number of inference units for an Amazon Comprehend document classification
	//    endpoint.
	//
	//    * comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number
	//    of inference units for an Amazon Comprehend entity recognizer endpoint.
	//
	//    * lambda:function:ProvisionedConcurrency - The provisioned concurrency
	//    for a Lambda function.
	//
	//    * cassandra:table:ReadCapacityUnits - The provisioned read capacity for
	//    an Amazon Keyspaces table.
	//
	//    * cassandra:table:WriteCapacityUnits - The provisioned write capacity
	//    for an Amazon Keyspaces table.
	//
	//    * kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB)
	//    for brokers in an Amazon MSK cluster.
	//
	//    * elasticache:replication-group:NodeGroups - The number of node groups
	//    for an Amazon ElastiCache replication group.
	//
	//    * elasticache:replication-group:Replicas - The number of replicas per
	//    node group for an Amazon ElastiCache replication group.
	//
	//    * neptune:cluster:ReadReplicaCount - The count of read replicas in an
	//    Amazon Neptune DB cluster.
	//
	//    * sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency
	//    for a SageMaker Serverless endpoint.
	//
	//    * sagemaker:inference-component:DesiredCopyCount - The number of copies
	//    across an endpoint for a SageMaker inference component.
	//
	// ScalableDimension is a required field
	ScalableDimension *string `type:"string" required:"true" enum:"ScalableDimension"`

	// The namespace of the Amazon Web Services service that provides the resource.
	// For a resource provided by your own application or service, use custom-resource
	// instead.
	//
	// ServiceNamespace is a required field
	ServiceNamespace *string `type:"string" required:"true" enum:"ServiceNamespace"`

	// An embedded object that contains attributes and attribute values that are
	// used to suspend and resume automatic scaling. Setting the value of an attribute
	// to true suspends the specified scaling activities. Setting it to false (default)
	// resumes the specified scaling activities.
	//
	// Suspension Outcomes
	//
	//    * For DynamicScalingInSuspended, while a suspension is in effect, all
	//    scale-in activities that are triggered by a scaling policy are suspended.
	//
	//    * For DynamicScalingOutSuspended, while a suspension is in effect, all
	//    scale-out activities that are triggered by a scaling policy are suspended.
	//
	//    * For ScheduledScalingSuspended, while a suspension is in effect, all
	//    scaling activities that involve scheduled actions are suspended.
	//
	// For more information, see Suspending and resuming scaling (https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-suspend-resume-scaling.html)
	// in the Application Auto Scaling User Guide.
	SuspendedState *SuspendedState `type:"structure"`

	// Assigns one or more tags to the scalable target. Use this parameter to tag
	// the scalable target when it is created. To tag an existing scalable target,
	// use the TagResource operation.
	//
	// Each tag consists of a tag key and a tag value. Both the tag key and the
	// tag value are required. You cannot have more than one tag on a scalable target
	// with the same tag key.
	//
	// Use tags to control access to a scalable target. For more information, see
	// Tagging support for Application Auto Scaling (https://docs.aws.amazon.com/autoscaling/application/userguide/resource-tagging-support.html)
	// in the Application Auto Scaling User Guide.
	Tags map[string]*string `type:"map"`
	// contains filtered or unexported fields
}

func (RegisterScalableTargetInput) GoString

func (s RegisterScalableTargetInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RegisterScalableTargetInput) SetMaxCapacity added in v1.5.0

SetMaxCapacity sets the MaxCapacity field's value.

func (*RegisterScalableTargetInput) SetMinCapacity added in v1.5.0

SetMinCapacity sets the MinCapacity field's value.

func (*RegisterScalableTargetInput) SetResourceId added in v1.5.0

SetResourceId sets the ResourceId field's value.

func (*RegisterScalableTargetInput) SetRoleARN added in v1.5.0

SetRoleARN sets the RoleARN field's value.

func (*RegisterScalableTargetInput) SetScalableDimension added in v1.5.0

SetScalableDimension sets the ScalableDimension field's value.

func (*RegisterScalableTargetInput) SetServiceNamespace added in v1.5.0

SetServiceNamespace sets the ServiceNamespace field's value.

func (*RegisterScalableTargetInput) SetSuspendedState added in v1.23.12

SetSuspendedState sets the SuspendedState field's value.

func (*RegisterScalableTargetInput) SetTags added in v1.44.225

SetTags sets the Tags field's value.

func (RegisterScalableTargetInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 {

	// The ARN of the scalable target.
	ScalableTargetARN *string `type:"string"`
	// contains filtered or unexported fields
}

func (RegisterScalableTargetOutput) GoString

func (s RegisterScalableTargetOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RegisterScalableTargetOutput) SetScalableTargetARN added in v1.44.225

SetScalableTargetARN sets the ScalableTargetARN field's value.

func (RegisterScalableTargetOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResourceNotFoundException added in v1.44.225

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

	Message_ *string `locationName:"Message" type:"string"`

	// The name of the Application Auto Scaling resource. This value is an Amazon
	// Resource Name (ARN).
	ResourceName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

The specified resource doesn't exist.

func (*ResourceNotFoundException) Code added in v1.44.225

Code returns the exception type name.

func (*ResourceNotFoundException) Error added in v1.44.225

func (s *ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString added in v1.44.225

func (s ResourceNotFoundException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceNotFoundException) Message added in v1.44.225

func (s *ResourceNotFoundException) Message() string

Message returns the exception's message.

func (*ResourceNotFoundException) OrigErr added in v1.44.225

func (s *ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFoundException) RequestID added in v1.44.225

func (s *ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFoundException) StatusCode added in v1.44.225

func (s *ResourceNotFoundException) StatusCode() int

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

func (ResourceNotFoundException) String added in v1.44.225

func (s ResourceNotFoundException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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" required:"true"`

	// The maximum value to scale to in response to a scale-out activity.
	//
	// MaxCapacity is a required field
	MaxCapacity *int64 `type:"integer" required:"true"`

	// The minimum value to scale to in response to a scale-in activity.
	//
	// 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 - 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.
	//
	//    * DynamoDB table - The resource type is table and the unique identifier
	//    is the table name. Example: table/my-table.
	//
	//    * DynamoDB global secondary index - The resource type is index and the
	//    unique identifier is the index name. Example: table/my-table/index/my-table-index.
	//
	//    * Aurora DB cluster - The resource type is cluster and the unique identifier
	//    is the cluster name. Example: cluster:my-db-cluster.
	//
	//    * SageMaker endpoint variant - The resource type is variant and the unique
	//    identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
	//
	//    * Custom resources are not supported with a resource type. This parameter
	//    must specify the OutputValue from the CloudFormation template stack used
	//    to access the resources. The unique identifier is defined by the service
	//    provider. More information is available in our GitHub repository (https://github.com/aws/aws-auto-scaling-custom-resource).
	//
	//    * Amazon Comprehend document classification endpoint - The resource type
	//    and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.
	//
	//    * Amazon Comprehend entity recognizer endpoint - The resource type and
	//    unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE.
	//
	//    * Lambda provisioned concurrency - The resource type is function and the
	//    unique identifier is the function name with a function version or alias
	//    name suffix that is not $LATEST. Example: function:my-function:prod or
	//    function:my-function:1.
	//
	//    * Amazon Keyspaces table - The resource type is table and the unique identifier
	//    is the table name. Example: keyspace/mykeyspace/table/mytable.
	//
	//    * Amazon MSK cluster - The resource type and unique identifier are specified
	//    using the cluster ARN. Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.
	//
	//    * Amazon ElastiCache replication group - The resource type is replication-group
	//    and the unique identifier is the replication group name. Example: replication-group/mycluster.
	//
	//    * Neptune cluster - The resource type is cluster and the unique identifier
	//    is the cluster name. Example: cluster:mycluster.
	//
	//    * SageMaker Serverless endpoint - The resource type is variant and the
	//    unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
	//
	//    * SageMaker inference component - The resource type is inference-component
	//    and the unique identifier is the resource ID. Example: inference-component/my-inference-component.
	//
	// 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.
	//
	//    * elasticmapreduce:instancegroup:InstanceCount - The instance count of
	//    an EMR Instance Group.
	//
	//    * ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot
	//    Fleet.
	//
	//    * appstream:fleet:DesiredCapacity - The desired capacity of an AppStream
	//    2.0 fleet.
	//
	//    * dynamodb:table:ReadCapacityUnits - The provisioned read capacity for
	//    a DynamoDB table.
	//
	//    * dynamodb:table:WriteCapacityUnits - The provisioned write capacity for
	//    a DynamoDB table.
	//
	//    * dynamodb:index:ReadCapacityUnits - The provisioned read capacity for
	//    a DynamoDB global secondary index.
	//
	//    * dynamodb:index:WriteCapacityUnits - The provisioned write capacity for
	//    a DynamoDB global secondary index.
	//
	//    * rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora
	//    DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible
	//    edition.
	//
	//    * sagemaker:variant:DesiredInstanceCount - The number of EC2 instances
	//    for a SageMaker model endpoint variant.
	//
	//    * custom-resource:ResourceType:Property - The scalable dimension for a
	//    custom resource provided by your own application or service.
	//
	//    * comprehend:document-classifier-endpoint:DesiredInferenceUnits - The
	//    number of inference units for an Amazon Comprehend document classification
	//    endpoint.
	//
	//    * comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number
	//    of inference units for an Amazon Comprehend entity recognizer endpoint.
	//
	//    * lambda:function:ProvisionedConcurrency - The provisioned concurrency
	//    for a Lambda function.
	//
	//    * cassandra:table:ReadCapacityUnits - The provisioned read capacity for
	//    an Amazon Keyspaces table.
	//
	//    * cassandra:table:WriteCapacityUnits - The provisioned write capacity
	//    for an Amazon Keyspaces table.
	//
	//    * kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB)
	//    for brokers in an Amazon MSK cluster.
	//
	//    * elasticache:replication-group:NodeGroups - The number of node groups
	//    for an Amazon ElastiCache replication group.
	//
	//    * elasticache:replication-group:Replicas - The number of replicas per
	//    node group for an Amazon ElastiCache replication group.
	//
	//    * neptune:cluster:ReadReplicaCount - The count of read replicas in an
	//    Amazon Neptune DB cluster.
	//
	//    * sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency
	//    for a SageMaker Serverless endpoint.
	//
	//    * sagemaker:inference-component:DesiredCopyCount - The number of copies
	//    across an endpoint for a SageMaker inference component.
	//
	// ScalableDimension is a required field
	ScalableDimension *string `type:"string" required:"true" enum:"ScalableDimension"`

	// The ARN of the scalable target.
	ScalableTargetARN *string `type:"string"`

	// The namespace of the Amazon Web Services service that provides the resource,
	// or a custom-resource.
	//
	// ServiceNamespace is a required field
	ServiceNamespace *string `type:"string" required:"true" enum:"ServiceNamespace"`

	// Specifies whether the scaling activities for a scalable target are in a suspended
	// state.
	SuspendedState *SuspendedState `type:"structure"`
	// contains filtered or unexported fields
}

Represents a scalable target.

func (ScalableTarget) GoString

func (s ScalableTarget) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ScalableTarget) SetCreationTime added in v1.5.0

func (s *ScalableTarget) SetCreationTime(v time.Time) *ScalableTarget

SetCreationTime sets the CreationTime field's value.

func (*ScalableTarget) SetMaxCapacity added in v1.5.0

func (s *ScalableTarget) SetMaxCapacity(v int64) *ScalableTarget

SetMaxCapacity sets the MaxCapacity field's value.

func (*ScalableTarget) SetMinCapacity added in v1.5.0

func (s *ScalableTarget) SetMinCapacity(v int64) *ScalableTarget

SetMinCapacity sets the MinCapacity field's value.

func (*ScalableTarget) SetResourceId added in v1.5.0

func (s *ScalableTarget) SetResourceId(v string) *ScalableTarget

SetResourceId sets the ResourceId field's value.

func (*ScalableTarget) SetRoleARN added in v1.5.0

func (s *ScalableTarget) SetRoleARN(v string) *ScalableTarget

SetRoleARN sets the RoleARN field's value.

func (*ScalableTarget) SetScalableDimension added in v1.5.0

func (s *ScalableTarget) SetScalableDimension(v string) *ScalableTarget

SetScalableDimension sets the ScalableDimension field's value.

func (*ScalableTarget) SetScalableTargetARN added in v1.44.225

func (s *ScalableTarget) SetScalableTargetARN(v string) *ScalableTarget

SetScalableTargetARN sets the ScalableTargetARN field's value.

func (*ScalableTarget) SetServiceNamespace added in v1.5.0

func (s *ScalableTarget) SetServiceNamespace(v string) *ScalableTarget

SetServiceNamespace sets the ServiceNamespace field's value.

func (*ScalableTarget) SetSuspendedState added in v1.23.12

func (s *ScalableTarget) SetSuspendedState(v *SuspendedState) *ScalableTarget

SetSuspendedState sets the SuspendedState field's value.

func (ScalableTarget) String

func (s ScalableTarget) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ScalableTargetAction added in v1.12.25

type ScalableTargetAction struct {

	// The maximum capacity.
	//
	// Although you can specify a large maximum capacity, note that service quotas
	// may impose lower limits. Each service has its own default quotas for the
	// maximum capacity of the resource. If you want to specify a higher limit,
	// you can request an increase. For more information, consult the documentation
	// for that service. For information about the default quotas for each service,
	// see Service endpoints and quotas (https://docs.aws.amazon.com/general/latest/gr/aws-service-information.html)
	// in the Amazon Web Services General Reference.
	MaxCapacity *int64 `type:"integer"`

	// The minimum capacity.
	//
	// When the scheduled action runs, the resource will have at least this much
	// capacity, but it might have more depending on other settings, such as the
	// target utilization level of a target tracking scaling policy.
	MinCapacity *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Represents the minimum and maximum capacity for a scheduled action.

func (ScalableTargetAction) GoString added in v1.12.25

func (s ScalableTargetAction) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ScalableTargetAction) SetMaxCapacity added in v1.12.25

func (s *ScalableTargetAction) SetMaxCapacity(v int64) *ScalableTargetAction

SetMaxCapacity sets the MaxCapacity field's value.

func (*ScalableTargetAction) SetMinCapacity added in v1.12.25

func (s *ScalableTargetAction) SetMinCapacity(v int64) *ScalableTargetAction

SetMinCapacity sets the MinCapacity field's value.

func (ScalableTargetAction) String added in v1.12.25

func (s ScalableTargetAction) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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"`

	// Machine-readable data that describes the reason for a not scaled activity.
	// Only available when DescribeScalingActivities (https://docs.aws.amazon.com/autoscaling/application/APIReference/API_DescribeScalingActivities.html)
	// includes not scaled activities.
	NotScaledReasons []*NotScaledReason `type:"list"`

	// 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 - 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.
	//
	//    * DynamoDB table - The resource type is table and the unique identifier
	//    is the table name. Example: table/my-table.
	//
	//    * DynamoDB global secondary index - The resource type is index and the
	//    unique identifier is the index name. Example: table/my-table/index/my-table-index.
	//
	//    * Aurora DB cluster - The resource type is cluster and the unique identifier
	//    is the cluster name. Example: cluster:my-db-cluster.
	//
	//    * SageMaker endpoint variant - The resource type is variant and the unique
	//    identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
	//
	//    * Custom resources are not supported with a resource type. This parameter
	//    must specify the OutputValue from the CloudFormation template stack used
	//    to access the resources. The unique identifier is defined by the service
	//    provider. More information is available in our GitHub repository (https://github.com/aws/aws-auto-scaling-custom-resource).
	//
	//    * Amazon Comprehend document classification endpoint - The resource type
	//    and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.
	//
	//    * Amazon Comprehend entity recognizer endpoint - The resource type and
	//    unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE.
	//
	//    * Lambda provisioned concurrency - The resource type is function and the
	//    unique identifier is the function name with a function version or alias
	//    name suffix that is not $LATEST. Example: function:my-function:prod or
	//    function:my-function:1.
	//
	//    * Amazon Keyspaces table - The resource type is table and the unique identifier
	//    is the table name. Example: keyspace/mykeyspace/table/mytable.
	//
	//    * Amazon MSK cluster - The resource type and unique identifier are specified
	//    using the cluster ARN. Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.
	//
	//    * Amazon ElastiCache replication group - The resource type is replication-group
	//    and the unique identifier is the replication group name. Example: replication-group/mycluster.
	//
	//    * Neptune cluster - The resource type is cluster and the unique identifier
	//    is the cluster name. Example: cluster:mycluster.
	//
	//    * SageMaker Serverless endpoint - The resource type is variant and the
	//    unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
	//
	//    * SageMaker inference component - The resource type is inference-component
	//    and the unique identifier is the resource ID. Example: inference-component/my-inference-component.
	//
	// 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.
	//
	//    * elasticmapreduce:instancegroup:InstanceCount - The instance count of
	//    an EMR Instance Group.
	//
	//    * ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot
	//    Fleet.
	//
	//    * appstream:fleet:DesiredCapacity - The desired capacity of an AppStream
	//    2.0 fleet.
	//
	//    * dynamodb:table:ReadCapacityUnits - The provisioned read capacity for
	//    a DynamoDB table.
	//
	//    * dynamodb:table:WriteCapacityUnits - The provisioned write capacity for
	//    a DynamoDB table.
	//
	//    * dynamodb:index:ReadCapacityUnits - The provisioned read capacity for
	//    a DynamoDB global secondary index.
	//
	//    * dynamodb:index:WriteCapacityUnits - The provisioned write capacity for
	//    a DynamoDB global secondary index.
	//
	//    * rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora
	//    DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible
	//    edition.
	//
	//    * sagemaker:variant:DesiredInstanceCount - The number of EC2 instances
	//    for a SageMaker model endpoint variant.
	//
	//    * custom-resource:ResourceType:Property - The scalable dimension for a
	//    custom resource provided by your own application or service.
	//
	//    * comprehend:document-classifier-endpoint:DesiredInferenceUnits - The
	//    number of inference units for an Amazon Comprehend document classification
	//    endpoint.
	//
	//    * comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number
	//    of inference units for an Amazon Comprehend entity recognizer endpoint.
	//
	//    * lambda:function:ProvisionedConcurrency - The provisioned concurrency
	//    for a Lambda function.
	//
	//    * cassandra:table:ReadCapacityUnits - The provisioned read capacity for
	//    an Amazon Keyspaces table.
	//
	//    * cassandra:table:WriteCapacityUnits - The provisioned write capacity
	//    for an Amazon Keyspaces table.
	//
	//    * kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB)
	//    for brokers in an Amazon MSK cluster.
	//
	//    * elasticache:replication-group:NodeGroups - The number of node groups
	//    for an Amazon ElastiCache replication group.
	//
	//    * elasticache:replication-group:Replicas - The number of replicas per
	//    node group for an Amazon ElastiCache replication group.
	//
	//    * neptune:cluster:ReadReplicaCount - The count of read replicas in an
	//    Amazon Neptune DB cluster.
	//
	//    * sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency
	//    for a SageMaker Serverless endpoint.
	//
	//    * sagemaker:inference-component:DesiredCopyCount - The number of copies
	//    across an endpoint for a SageMaker inference component.
	//
	// ScalableDimension is a required field
	ScalableDimension *string `type:"string" required:"true" enum:"ScalableDimension"`

	// The namespace of the Amazon Web Services service that provides the resource,
	// or a custom-resource.
	//
	// 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" 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.

func (ScalingActivity) GoString

func (s ScalingActivity) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ScalingActivity) SetActivityId added in v1.5.0

func (s *ScalingActivity) SetActivityId(v string) *ScalingActivity

SetActivityId sets the ActivityId field's value.

func (*ScalingActivity) SetCause added in v1.5.0

func (s *ScalingActivity) SetCause(v string) *ScalingActivity

SetCause sets the Cause field's value.

func (*ScalingActivity) SetDescription added in v1.5.0

func (s *ScalingActivity) SetDescription(v string) *ScalingActivity

SetDescription sets the Description field's value.

func (*ScalingActivity) SetDetails added in v1.5.0

func (s *ScalingActivity) SetDetails(v string) *ScalingActivity

SetDetails sets the Details field's value.

func (*ScalingActivity) SetEndTime added in v1.5.0

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

SetEndTime sets the EndTime field's value.

func (*ScalingActivity) SetNotScaledReasons added in v1.44.173

func (s *ScalingActivity) SetNotScaledReasons(v []*NotScaledReason) *ScalingActivity

SetNotScaledReasons sets the NotScaledReasons field's value.

func (*ScalingActivity) SetResourceId added in v1.5.0

func (s *ScalingActivity) SetResourceId(v string) *ScalingActivity

SetResourceId sets the ResourceId field's value.

func (*ScalingActivity) SetScalableDimension added in v1.5.0

func (s *ScalingActivity) SetScalableDimension(v string) *ScalingActivity

SetScalableDimension sets the ScalableDimension field's value.

func (*ScalingActivity) SetServiceNamespace added in v1.5.0

func (s *ScalingActivity) SetServiceNamespace(v string) *ScalingActivity

SetServiceNamespace sets the ServiceNamespace field's value.

func (*ScalingActivity) SetStartTime added in v1.5.0

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

SetStartTime sets the StartTime field's value.

func (*ScalingActivity) SetStatusCode added in v1.5.0

func (s *ScalingActivity) SetStatusCode(v string) *ScalingActivity

SetStatusCode sets the StatusCode field's value.

func (*ScalingActivity) SetStatusMessage added in v1.5.0

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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" 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.
	//
	// The following policy types are supported:
	//
	// TargetTrackingScaling—Not supported for Amazon EMR
	//
	// StepScaling—Not supported for DynamoDB, Amazon Comprehend, Lambda, Amazon
	// Keyspaces, Amazon MSK, Amazon ElastiCache, or Neptune.
	//
	// 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 - 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.
	//
	//    * DynamoDB table - The resource type is table and the unique identifier
	//    is the table name. Example: table/my-table.
	//
	//    * DynamoDB global secondary index - The resource type is index and the
	//    unique identifier is the index name. Example: table/my-table/index/my-table-index.
	//
	//    * Aurora DB cluster - The resource type is cluster and the unique identifier
	//    is the cluster name. Example: cluster:my-db-cluster.
	//
	//    * SageMaker endpoint variant - The resource type is variant and the unique
	//    identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
	//
	//    * Custom resources are not supported with a resource type. This parameter
	//    must specify the OutputValue from the CloudFormation template stack used
	//    to access the resources. The unique identifier is defined by the service
	//    provider. More information is available in our GitHub repository (https://github.com/aws/aws-auto-scaling-custom-resource).
	//
	//    * Amazon Comprehend document classification endpoint - The resource type
	//    and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.
	//
	//    * Amazon Comprehend entity recognizer endpoint - The resource type and
	//    unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE.
	//
	//    * Lambda provisioned concurrency - The resource type is function and the
	//    unique identifier is the function name with a function version or alias
	//    name suffix that is not $LATEST. Example: function:my-function:prod or
	//    function:my-function:1.
	//
	//    * Amazon Keyspaces table - The resource type is table and the unique identifier
	//    is the table name. Example: keyspace/mykeyspace/table/mytable.
	//
	//    * Amazon MSK cluster - The resource type and unique identifier are specified
	//    using the cluster ARN. Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.
	//
	//    * Amazon ElastiCache replication group - The resource type is replication-group
	//    and the unique identifier is the replication group name. Example: replication-group/mycluster.
	//
	//    * Neptune cluster - The resource type is cluster and the unique identifier
	//    is the cluster name. Example: cluster:mycluster.
	//
	//    * SageMaker Serverless endpoint - The resource type is variant and the
	//    unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
	//
	//    * SageMaker inference component - The resource type is inference-component
	//    and the unique identifier is the resource ID. Example: inference-component/my-inference-component.
	//
	// 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.
	//
	//    * elasticmapreduce:instancegroup:InstanceCount - The instance count of
	//    an EMR Instance Group.
	//
	//    * ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot
	//    Fleet.
	//
	//    * appstream:fleet:DesiredCapacity - The desired capacity of an AppStream
	//    2.0 fleet.
	//
	//    * dynamodb:table:ReadCapacityUnits - The provisioned read capacity for
	//    a DynamoDB table.
	//
	//    * dynamodb:table:WriteCapacityUnits - The provisioned write capacity for
	//    a DynamoDB table.
	//
	//    * dynamodb:index:ReadCapacityUnits - The provisioned read capacity for
	//    a DynamoDB global secondary index.
	//
	//    * dynamodb:index:WriteCapacityUnits - The provisioned write capacity for
	//    a DynamoDB global secondary index.
	//
	//    * rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora
	//    DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible
	//    edition.
	//
	//    * sagemaker:variant:DesiredInstanceCount - The number of EC2 instances
	//    for a SageMaker model endpoint variant.
	//
	//    * custom-resource:ResourceType:Property - The scalable dimension for a
	//    custom resource provided by your own application or service.
	//
	//    * comprehend:document-classifier-endpoint:DesiredInferenceUnits - The
	//    number of inference units for an Amazon Comprehend document classification
	//    endpoint.
	//
	//    * comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number
	//    of inference units for an Amazon Comprehend entity recognizer endpoint.
	//
	//    * lambda:function:ProvisionedConcurrency - The provisioned concurrency
	//    for a Lambda function.
	//
	//    * cassandra:table:ReadCapacityUnits - The provisioned read capacity for
	//    an Amazon Keyspaces table.
	//
	//    * cassandra:table:WriteCapacityUnits - The provisioned write capacity
	//    for an Amazon Keyspaces table.
	//
	//    * kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB)
	//    for brokers in an Amazon MSK cluster.
	//
	//    * elasticache:replication-group:NodeGroups - The number of node groups
	//    for an Amazon ElastiCache replication group.
	//
	//    * elasticache:replication-group:Replicas - The number of replicas per
	//    node group for an Amazon ElastiCache replication group.
	//
	//    * neptune:cluster:ReadReplicaCount - The count of read replicas in an
	//    Amazon Neptune DB cluster.
	//
	//    * sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency
	//    for a SageMaker Serverless endpoint.
	//
	//    * sagemaker:inference-component:DesiredCopyCount - The number of copies
	//    across an endpoint for a SageMaker inference component.
	//
	// ScalableDimension is a required field
	ScalableDimension *string `type:"string" required:"true" enum:"ScalableDimension"`

	// The namespace of the Amazon Web Services service that provides the resource,
	// or a custom-resource.
	//
	// ServiceNamespace is a required field
	ServiceNamespace *string `type:"string" required:"true" enum:"ServiceNamespace"`

	// A step scaling policy.
	StepScalingPolicyConfiguration *StepScalingPolicyConfiguration `type:"structure"`

	// A target tracking scaling policy.
	TargetTrackingScalingPolicyConfiguration *TargetTrackingScalingPolicyConfiguration `type:"structure"`
	// contains filtered or unexported fields
}

Represents a scaling policy to use with Application Auto Scaling.

For more information about configuring scaling policies for a specific service, see Amazon Web Services services that you can use with Application Auto Scaling (https://docs.aws.amazon.com/autoscaling/application/userguide/integrated-services-list.html) in the Application Auto Scaling User Guide.

func (ScalingPolicy) GoString

func (s ScalingPolicy) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ScalingPolicy) SetAlarms added in v1.5.0

func (s *ScalingPolicy) SetAlarms(v []*Alarm) *ScalingPolicy

SetAlarms sets the Alarms field's value.

func (*ScalingPolicy) SetCreationTime added in v1.5.0

func (s *ScalingPolicy) SetCreationTime(v time.Time) *ScalingPolicy

SetCreationTime sets the CreationTime field's value.

func (*ScalingPolicy) SetPolicyARN added in v1.5.0

func (s *ScalingPolicy) SetPolicyARN(v string) *ScalingPolicy

SetPolicyARN sets the PolicyARN field's value.

func (*ScalingPolicy) SetPolicyName added in v1.5.0

func (s *ScalingPolicy) SetPolicyName(v string) *ScalingPolicy

SetPolicyName sets the PolicyName field's value.

func (*ScalingPolicy) SetPolicyType added in v1.5.0

func (s *ScalingPolicy) SetPolicyType(v string) *ScalingPolicy

SetPolicyType sets the PolicyType field's value.

func (*ScalingPolicy) SetResourceId added in v1.5.0

func (s *ScalingPolicy) SetResourceId(v string) *ScalingPolicy

SetResourceId sets the ResourceId field's value.

func (*ScalingPolicy) SetScalableDimension added in v1.5.0

func (s *ScalingPolicy) SetScalableDimension(v string) *ScalingPolicy

SetScalableDimension sets the ScalableDimension field's value.

func (*ScalingPolicy) SetServiceNamespace added in v1.5.0

func (s *ScalingPolicy) SetServiceNamespace(v string) *ScalingPolicy

SetServiceNamespace sets the ServiceNamespace field's value.

func (*ScalingPolicy) SetStepScalingPolicyConfiguration added in v1.5.0

func (s *ScalingPolicy) SetStepScalingPolicyConfiguration(v *StepScalingPolicyConfiguration) *ScalingPolicy

SetStepScalingPolicyConfiguration sets the StepScalingPolicyConfiguration field's value.

func (*ScalingPolicy) SetTargetTrackingScalingPolicyConfiguration added in v1.8.42

func (s *ScalingPolicy) SetTargetTrackingScalingPolicyConfiguration(v *TargetTrackingScalingPolicyConfiguration) *ScalingPolicy

SetTargetTrackingScalingPolicyConfiguration sets the TargetTrackingScalingPolicyConfiguration field's value.

func (ScalingPolicy) String

func (s ScalingPolicy) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ScheduledAction added in v1.12.25

type ScheduledAction struct {

	// The date and time that the scheduled action was created.
	//
	// CreationTime is a required field
	CreationTime *time.Time `type:"timestamp" required:"true"`

	// The date and time that the action is scheduled to end, in UTC.
	EndTime *time.Time `type:"timestamp"`

	// 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 - 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.
	//
	//    * DynamoDB table - The resource type is table and the unique identifier
	//    is the table name. Example: table/my-table.
	//
	//    * DynamoDB global secondary index - The resource type is index and the
	//    unique identifier is the index name. Example: table/my-table/index/my-table-index.
	//
	//    * Aurora DB cluster - The resource type is cluster and the unique identifier
	//    is the cluster name. Example: cluster:my-db-cluster.
	//
	//    * SageMaker endpoint variant - The resource type is variant and the unique
	//    identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
	//
	//    * Custom resources are not supported with a resource type. This parameter
	//    must specify the OutputValue from the CloudFormation template stack used
	//    to access the resources. The unique identifier is defined by the service
	//    provider. More information is available in our GitHub repository (https://github.com/aws/aws-auto-scaling-custom-resource).
	//
	//    * Amazon Comprehend document classification endpoint - The resource type
	//    and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.
	//
	//    * Amazon Comprehend entity recognizer endpoint - The resource type and
	//    unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE.
	//
	//    * Lambda provisioned concurrency - The resource type is function and the
	//    unique identifier is the function name with a function version or alias
	//    name suffix that is not $LATEST. Example: function:my-function:prod or
	//    function:my-function:1.
	//
	//    * Amazon Keyspaces table - The resource type is table and the unique identifier
	//    is the table name. Example: keyspace/mykeyspace/table/mytable.
	//
	//    * Amazon MSK cluster - The resource type and unique identifier are specified
	//    using the cluster ARN. Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.
	//
	//    * Amazon ElastiCache replication group - The resource type is replication-group
	//    and the unique identifier is the replication group name. Example: replication-group/mycluster.
	//
	//    * Neptune cluster - The resource type is cluster and the unique identifier
	//    is the cluster name. Example: cluster:mycluster.
	//
	//    * SageMaker Serverless endpoint - The resource type is variant and the
	//    unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
	//
	//    * SageMaker inference component - The resource type is inference-component
	//    and the unique identifier is the resource ID. Example: inference-component/my-inference-component.
	//
	// 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.
	//
	//    * elasticmapreduce:instancegroup:InstanceCount - The instance count of
	//    an EMR Instance Group.
	//
	//    * ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot
	//    Fleet.
	//
	//    * appstream:fleet:DesiredCapacity - The desired capacity of an AppStream
	//    2.0 fleet.
	//
	//    * dynamodb:table:ReadCapacityUnits - The provisioned read capacity for
	//    a DynamoDB table.
	//
	//    * dynamodb:table:WriteCapacityUnits - The provisioned write capacity for
	//    a DynamoDB table.
	//
	//    * dynamodb:index:ReadCapacityUnits - The provisioned read capacity for
	//    a DynamoDB global secondary index.
	//
	//    * dynamodb:index:WriteCapacityUnits - The provisioned write capacity for
	//    a DynamoDB global secondary index.
	//
	//    * rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora
	//    DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible
	//    edition.
	//
	//    * sagemaker:variant:DesiredInstanceCount - The number of EC2 instances
	//    for a SageMaker model endpoint variant.
	//
	//    * custom-resource:ResourceType:Property - The scalable dimension for a
	//    custom resource provided by your own application or service.
	//
	//    * comprehend:document-classifier-endpoint:DesiredInferenceUnits - The
	//    number of inference units for an Amazon Comprehend document classification
	//    endpoint.
	//
	//    * comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number
	//    of inference units for an Amazon Comprehend entity recognizer endpoint.
	//
	//    * lambda:function:ProvisionedConcurrency - The provisioned concurrency
	//    for a Lambda function.
	//
	//    * cassandra:table:ReadCapacityUnits - The provisioned read capacity for
	//    an Amazon Keyspaces table.
	//
	//    * cassandra:table:WriteCapacityUnits - The provisioned write capacity
	//    for an Amazon Keyspaces table.
	//
	//    * kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB)
	//    for brokers in an Amazon MSK cluster.
	//
	//    * elasticache:replication-group:NodeGroups - The number of node groups
	//    for an Amazon ElastiCache replication group.
	//
	//    * elasticache:replication-group:Replicas - The number of replicas per
	//    node group for an Amazon ElastiCache replication group.
	//
	//    * neptune:cluster:ReadReplicaCount - The count of read replicas in an
	//    Amazon Neptune DB cluster.
	//
	//    * sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency
	//    for a SageMaker Serverless endpoint.
	//
	//    * sagemaker:inference-component:DesiredCopyCount - The number of copies
	//    across an endpoint for a SageMaker inference component.
	ScalableDimension *string `type:"string" enum:"ScalableDimension"`

	// The new minimum and maximum capacity. You can set both values or just one.
	// At the scheduled time, if the current capacity is below the minimum capacity,
	// Application Auto Scaling scales out to the minimum capacity. If the current
	// capacity is above the maximum capacity, Application Auto Scaling scales in
	// to the maximum capacity.
	ScalableTargetAction *ScalableTargetAction `type:"structure"`

	// The schedule for this action. The following formats are supported:
	//
	//    * At expressions - "at(yyyy-mm-ddThh:mm:ss)"
	//
	//    * Rate expressions - "rate(value unit)"
	//
	//    * Cron expressions - "cron(fields)"
	//
	// At expressions are useful for one-time schedules. Cron expressions are useful
	// for scheduled actions that run periodically at a specified date and time,
	// and rate expressions are useful for scheduled actions that run at a regular
	// interval.
	//
	// At and cron expressions use Universal Coordinated Time (UTC) by default.
	//
	// The cron format consists of six fields separated by white spaces: [Minutes]
	// [Hours] [Day_of_Month] [Month] [Day_of_Week] [Year].
	//
	// For rate expressions, value is a positive integer and unit is minute | minutes
	// | hour | hours | day | days.
	//
	// For more information and examples, see Example scheduled actions for Application
	// Auto Scaling (https://docs.aws.amazon.com/autoscaling/application/userguide/examples-scheduled-actions.html)
	// in the Application Auto Scaling User Guide.
	//
	// Schedule is a required field
	Schedule *string `min:"1" type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of the scheduled action.
	//
	// ScheduledActionARN is a required field
	ScheduledActionARN *string `min:"1" type:"string" required:"true"`

	// The name of the scheduled action.
	//
	// ScheduledActionName is a required field
	ScheduledActionName *string `min:"1" type:"string" required:"true"`

	// The namespace of the Amazon Web Services service that provides the resource,
	// or a custom-resource.
	//
	// ServiceNamespace is a required field
	ServiceNamespace *string `type:"string" required:"true" enum:"ServiceNamespace"`

	// The date and time that the action is scheduled to begin, in UTC.
	StartTime *time.Time `type:"timestamp"`

	// The time zone used when referring to the date and time of a scheduled action,
	// when the scheduled action uses an at or cron expression.
	Timezone *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Represents a scheduled action.

func (ScheduledAction) GoString added in v1.12.25

func (s ScheduledAction) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ScheduledAction) SetCreationTime added in v1.12.25

func (s *ScheduledAction) SetCreationTime(v time.Time) *ScheduledAction

SetCreationTime sets the CreationTime field's value.

func (*ScheduledAction) SetEndTime added in v1.12.25

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

SetEndTime sets the EndTime field's value.

func (*ScheduledAction) SetResourceId added in v1.12.25

func (s *ScheduledAction) SetResourceId(v string) *ScheduledAction

SetResourceId sets the ResourceId field's value.

func (*ScheduledAction) SetScalableDimension added in v1.12.25

func (s *ScheduledAction) SetScalableDimension(v string) *ScheduledAction

SetScalableDimension sets the ScalableDimension field's value.

func (*ScheduledAction) SetScalableTargetAction added in v1.12.25

func (s *ScheduledAction) SetScalableTargetAction(v *ScalableTargetAction) *ScheduledAction

SetScalableTargetAction sets the ScalableTargetAction field's value.

func (*ScheduledAction) SetSchedule added in v1.12.25

func (s *ScheduledAction) SetSchedule(v string) *ScheduledAction

SetSchedule sets the Schedule field's value.

func (*ScheduledAction) SetScheduledActionARN added in v1.12.25

func (s *ScheduledAction) SetScheduledActionARN(v string) *ScheduledAction

SetScheduledActionARN sets the ScheduledActionARN field's value.

func (*ScheduledAction) SetScheduledActionName added in v1.12.25

func (s *ScheduledAction) SetScheduledActionName(v string) *ScheduledAction

SetScheduledActionName sets the ScheduledActionName field's value.

func (*ScheduledAction) SetServiceNamespace added in v1.12.25

func (s *ScheduledAction) SetServiceNamespace(v string) *ScheduledAction

SetServiceNamespace sets the ServiceNamespace field's value.

func (*ScheduledAction) SetStartTime added in v1.12.25

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

SetStartTime sets the StartTime field's value.

func (*ScheduledAction) SetTimezone added in v1.37.2

func (s *ScheduledAction) SetTimezone(v string) *ScheduledAction

SetTimezone sets the Timezone field's value.

func (ScheduledAction) String added in v1.12.25

func (s ScheduledAction) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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's 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's 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 capacity while a negative number removes from the
	// current capacity. For exact capacity, you must specify a non-negative value.
	//
	// ScalingAdjustment is a required field
	ScalingAdjustment *int64 `type:"integer" required:"true"`
	// contains filtered or unexported fields
}

Represents a step adjustment for a StepScalingPolicyConfiguration (https://docs.aws.amazon.com/autoscaling/application/APIReference/API_StepScalingPolicyConfiguration.html). 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 initiate 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 initiate 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.

func (StepAdjustment) GoString

func (s StepAdjustment) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StepAdjustment) SetMetricIntervalLowerBound added in v1.5.0

func (s *StepAdjustment) SetMetricIntervalLowerBound(v float64) *StepAdjustment

SetMetricIntervalLowerBound sets the MetricIntervalLowerBound field's value.

func (*StepAdjustment) SetMetricIntervalUpperBound added in v1.5.0

func (s *StepAdjustment) SetMetricIntervalUpperBound(v float64) *StepAdjustment

SetMetricIntervalUpperBound sets the MetricIntervalUpperBound field's value.

func (*StepAdjustment) SetScalingAdjustment added in v1.5.0

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 {

	// Specifies how the ScalingAdjustment value in a StepAdjustment (https://docs.aws.amazon.com/autoscaling/application/APIReference/API_StepAdjustment.html)
	// is interpreted (for example, an absolute number or a percentage). The valid
	// values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.
	//
	// AdjustmentType is required if you are adding a new step scaling policy configuration.
	AdjustmentType *string `type:"string" enum:"AdjustmentType"`

	// The amount of time, in seconds, to wait for a previous scaling activity to
	// take effect. If not specified, the default value is 300. For more information,
	// see Cooldown period (https://docs.aws.amazon.com/autoscaling/application/userguide/step-scaling-policy-overview.html#step-scaling-cooldown)
	// in the Application Auto Scaling User Guide.
	Cooldown *int64 `type:"integer"`

	// The aggregation type for the CloudWatch metrics. Valid values are Minimum,
	// Maximum, and Average. If the aggregation type is null, the value is treated
	// as Average.
	MetricAggregationType *string `type:"string" enum:"MetricAggregationType"`

	// The minimum value to scale by when the adjustment type is PercentChangeInCapacity.
	// For example, suppose that you create a step scaling policy to scale out an
	// Amazon ECS service by 25 percent and you specify a MinAdjustmentMagnitude
	// of 2. If the service has 4 tasks and the scaling policy is performed, 25
	// percent of 4 is 1. However, because you specified a MinAdjustmentMagnitude
	// of 2, Application Auto Scaling scales out the service by 2 tasks.
	MinAdjustmentMagnitude *int64 `type:"integer"`

	// A set of adjustments that enable you to scale based on the size of the alarm
	// breach.
	//
	// At least one step adjustment is required if you are adding a new step scaling
	// policy configuration.
	StepAdjustments []*StepAdjustment `type:"list"`
	// contains filtered or unexported fields
}

Represents a step scaling policy configuration to use with Application Auto Scaling.

For more information, see Step scaling policies (https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-step-scaling-policies.html) in the Application Auto Scaling User Guide.

func (StepScalingPolicyConfiguration) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StepScalingPolicyConfiguration) SetAdjustmentType added in v1.5.0

SetAdjustmentType sets the AdjustmentType field's value.

func (*StepScalingPolicyConfiguration) SetCooldown added in v1.5.0

SetCooldown sets the Cooldown field's value.

func (*StepScalingPolicyConfiguration) SetMetricAggregationType added in v1.5.0

SetMetricAggregationType sets the MetricAggregationType field's value.

func (*StepScalingPolicyConfiguration) SetMinAdjustmentMagnitude added in v1.5.0

func (s *StepScalingPolicyConfiguration) SetMinAdjustmentMagnitude(v int64) *StepScalingPolicyConfiguration

SetMinAdjustmentMagnitude sets the MinAdjustmentMagnitude field's value.

func (*StepScalingPolicyConfiguration) SetStepAdjustments added in v1.5.0

SetStepAdjustments sets the StepAdjustments field's value.

func (StepScalingPolicyConfiguration) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StepScalingPolicyConfiguration) Validate

func (s *StepScalingPolicyConfiguration) Validate() error

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

type SuspendedState added in v1.23.12

type SuspendedState struct {

	// Whether scale in by a target tracking scaling policy or a step scaling policy
	// is suspended. Set the value to true if you don't want Application Auto Scaling
	// to remove capacity when a scaling policy is triggered. The default is false.
	DynamicScalingInSuspended *bool `type:"boolean"`

	// Whether scale out by a target tracking scaling policy or a step scaling policy
	// is suspended. Set the value to true if you don't want Application Auto Scaling
	// to add capacity when a scaling policy is triggered. The default is false.
	DynamicScalingOutSuspended *bool `type:"boolean"`

	// Whether scheduled scaling is suspended. Set the value to true if you don't
	// want Application Auto Scaling to add or remove capacity by initiating scheduled
	// actions. The default is false.
	ScheduledScalingSuspended *bool `type:"boolean"`
	// contains filtered or unexported fields
}

Specifies whether the scaling activities for a scalable target are in a suspended state.

func (SuspendedState) GoString added in v1.23.12

func (s SuspendedState) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SuspendedState) SetDynamicScalingInSuspended added in v1.23.12

func (s *SuspendedState) SetDynamicScalingInSuspended(v bool) *SuspendedState

SetDynamicScalingInSuspended sets the DynamicScalingInSuspended field's value.

func (*SuspendedState) SetDynamicScalingOutSuspended added in v1.23.12

func (s *SuspendedState) SetDynamicScalingOutSuspended(v bool) *SuspendedState

SetDynamicScalingOutSuspended sets the DynamicScalingOutSuspended field's value.

func (*SuspendedState) SetScheduledScalingSuspended added in v1.23.12

func (s *SuspendedState) SetScheduledScalingSuspended(v bool) *SuspendedState

SetScheduledScalingSuspended sets the ScheduledScalingSuspended field's value.

func (SuspendedState) String added in v1.23.12

func (s SuspendedState) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TagResourceInput added in v1.44.225

type TagResourceInput struct {

	// Identifies the Application Auto Scaling scalable target that you want to
	// apply tags to.
	//
	// For example: arn:aws:application-autoscaling:us-east-1:123456789012:scalable-target/1234abcd56ab78cd901ef1234567890ab123
	//
	// To get the ARN for a scalable target, use DescribeScalableTargets.
	//
	// ResourceARN is a required field
	ResourceARN *string `min:"1" type:"string" required:"true"`

	// The tags assigned to the resource. A tag is a label that you assign to an
	// Amazon Web Services resource.
	//
	// Each tag consists of a tag key and a tag value.
	//
	// You cannot have more than one tag on an Application Auto Scaling scalable
	// target with the same tag key. If you specify an existing tag key with a different
	// tag value, Application Auto Scaling replaces the current tag value with the
	// specified one.
	//
	// For information about the rules that apply to tag keys and tag values, see
	// User-defined tag restrictions (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html)
	// in the Amazon Web Services Billing and Cost Management User Guide.
	//
	// Tags is a required field
	Tags map[string]*string `type:"map" required:"true"`
	// contains filtered or unexported fields
}

func (TagResourceInput) GoString added in v1.44.225

func (s TagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) SetResourceARN added in v1.44.225

func (s *TagResourceInput) SetResourceARN(v string) *TagResourceInput

SetResourceARN sets the ResourceARN field's value.

func (*TagResourceInput) SetTags added in v1.44.225

func (s *TagResourceInput) SetTags(v map[string]*string) *TagResourceInput

SetTags sets the Tags field's value.

func (TagResourceInput) String added in v1.44.225

func (s TagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) Validate added in v1.44.225

func (s *TagResourceInput) Validate() error

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

type TagResourceOutput added in v1.44.225

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

func (TagResourceOutput) GoString added in v1.44.225

func (s TagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (TagResourceOutput) String added in v1.44.225

func (s TagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TargetTrackingMetric added in v1.44.221

type TargetTrackingMetric struct {

	// The dimensions for the metric. For the list of available dimensions, see
	// the Amazon Web Services documentation available from the table in Amazon
	// Web Services services that publish CloudWatch metrics (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html)
	// in the Amazon CloudWatch User Guide.
	//
	// Conditional: If you published your metric with dimensions, you must specify
	// the same dimensions in your scaling policy.
	Dimensions []*TargetTrackingMetricDimension `type:"list"`

	// The name of the metric.
	MetricName *string `min:"1" type:"string"`

	// The namespace of the metric. For more information, see the table in Amazon
	// Web Services services that publish CloudWatch metrics (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html)
	// in the Amazon CloudWatch User Guide.
	Namespace *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Represents a specific metric.

Metric is a property of the TargetTrackingMetricStat object.

func (TargetTrackingMetric) GoString added in v1.44.221

func (s TargetTrackingMetric) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TargetTrackingMetric) SetDimensions added in v1.44.221

SetDimensions sets the Dimensions field's value.

func (*TargetTrackingMetric) SetMetricName added in v1.44.221

func (s *TargetTrackingMetric) SetMetricName(v string) *TargetTrackingMetric

SetMetricName sets the MetricName field's value.

func (*TargetTrackingMetric) SetNamespace added in v1.44.221

func (s *TargetTrackingMetric) SetNamespace(v string) *TargetTrackingMetric

SetNamespace sets the Namespace field's value.

func (TargetTrackingMetric) String added in v1.44.221

func (s TargetTrackingMetric) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TargetTrackingMetric) Validate added in v1.44.221

func (s *TargetTrackingMetric) Validate() error

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

type TargetTrackingMetricDataQuery added in v1.44.221

type TargetTrackingMetricDataQuery struct {

	// The math expression to perform on the returned data, if this object is performing
	// a math expression. This expression can use the Id of the other metrics to
	// refer to those metrics, and can also use the Id of other expressions to use
	// the result of those expressions.
	//
	// Conditional: Within each TargetTrackingMetricDataQuery object, you must specify
	// either Expression or MetricStat, but not both.
	Expression *string `min:"1" type:"string"`

	// A short name that identifies the object's results in the response. This name
	// must be unique among all MetricDataQuery objects specified for a single scaling
	// policy. If you are performing math expressions on this set of data, this
	// name represents that data and can serve as a variable in the mathematical
	// expression. The valid characters are letters, numbers, and underscores. The
	// first character must be a lowercase letter.
	//
	// Id is a required field
	Id *string `min:"1" type:"string" required:"true"`

	// A human-readable label for this metric or expression. This is especially
	// useful if this is a math expression, so that you know what the value represents.
	Label *string `type:"string"`

	// Information about the metric data to return.
	//
	// Conditional: Within each MetricDataQuery object, you must specify either
	// Expression or MetricStat, but not both.
	MetricStat *TargetTrackingMetricStat `type:"structure"`

	// Indicates whether to return the timestamps and raw data values of this metric.
	//
	// If you use any math expressions, specify true for this value for only the
	// final math expression that the metric specification is based on. You must
	// specify false for ReturnData for all the other metrics and expressions used
	// in the metric specification.
	//
	// If you are only retrieving metrics and not performing any math expressions,
	// do not specify anything for ReturnData. This sets it to its default (true).
	ReturnData *bool `type:"boolean"`
	// contains filtered or unexported fields
}

The metric data to return. Also defines whether this call is returning data for one metric only, or whether it is performing a math expression on the values of returned metric statistics to create a new time series. A time series is a series of data points, each of which is associated with a timestamp.

For more information and examples, see Create a target tracking scaling policy for Application Auto Scaling using metric math (https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-target-tracking-metric-math.html) in the Application Auto Scaling User Guide.

func (TargetTrackingMetricDataQuery) GoString added in v1.44.221

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TargetTrackingMetricDataQuery) SetExpression added in v1.44.221

SetExpression sets the Expression field's value.

func (*TargetTrackingMetricDataQuery) SetId added in v1.44.221

SetId sets the Id field's value.

func (*TargetTrackingMetricDataQuery) SetLabel added in v1.44.221

SetLabel sets the Label field's value.

func (*TargetTrackingMetricDataQuery) SetMetricStat added in v1.44.221

SetMetricStat sets the MetricStat field's value.

func (*TargetTrackingMetricDataQuery) SetReturnData added in v1.44.221

SetReturnData sets the ReturnData field's value.

func (TargetTrackingMetricDataQuery) String added in v1.44.221

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TargetTrackingMetricDataQuery) Validate added in v1.44.221

func (s *TargetTrackingMetricDataQuery) Validate() error

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

type TargetTrackingMetricDimension added in v1.44.221

type TargetTrackingMetricDimension struct {

	// The name of the dimension.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

	// The value of the dimension.
	//
	// Value is a required field
	Value *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Describes the dimension of a metric.

func (TargetTrackingMetricDimension) GoString added in v1.44.221

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TargetTrackingMetricDimension) SetName added in v1.44.221

SetName sets the Name field's value.

func (*TargetTrackingMetricDimension) SetValue added in v1.44.221

SetValue sets the Value field's value.

func (TargetTrackingMetricDimension) String added in v1.44.221

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TargetTrackingMetricDimension) Validate added in v1.44.221

func (s *TargetTrackingMetricDimension) Validate() error

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

type TargetTrackingMetricStat added in v1.44.221

type TargetTrackingMetricStat struct {

	// The CloudWatch metric to return, including the metric name, namespace, and
	// dimensions. To get the exact metric name, namespace, and dimensions, inspect
	// the Metric (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_Metric.html)
	// object that is returned by a call to ListMetrics (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_ListMetrics.html).
	//
	// Metric is a required field
	Metric *TargetTrackingMetric `type:"structure" required:"true"`

	// The statistic to return. It can include any CloudWatch statistic or extended
	// statistic. For a list of valid values, see the table in Statistics (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Statistic)
	// in the Amazon CloudWatch User Guide.
	//
	// The most commonly used metric for scaling is Average.
	//
	// Stat is a required field
	Stat *string `type:"string" required:"true"`

	// The unit to use for the returned data points. For a complete list of the
	// units that CloudWatch supports, see the MetricDatum (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html)
	// data type in the Amazon CloudWatch API Reference.
	Unit *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

This structure defines the CloudWatch metric to return, along with the statistic, period, and unit.

For more information about the CloudWatch terminology below, see Amazon CloudWatch concepts (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html) in the Amazon CloudWatch User Guide.

func (TargetTrackingMetricStat) GoString added in v1.44.221

func (s TargetTrackingMetricStat) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TargetTrackingMetricStat) SetMetric added in v1.44.221

SetMetric sets the Metric field's value.

func (*TargetTrackingMetricStat) SetStat added in v1.44.221

SetStat sets the Stat field's value.

func (*TargetTrackingMetricStat) SetUnit added in v1.44.221

SetUnit sets the Unit field's value.

func (TargetTrackingMetricStat) String added in v1.44.221

func (s TargetTrackingMetricStat) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TargetTrackingMetricStat) Validate added in v1.44.221

func (s *TargetTrackingMetricStat) Validate() error

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

type TargetTrackingScalingPolicyConfiguration added in v1.8.42

type TargetTrackingScalingPolicyConfiguration struct {

	// A customized metric. You can specify either a predefined metric or a customized
	// metric.
	CustomizedMetricSpecification *CustomizedMetricSpecification `type:"structure"`

	// Indicates whether scale in by the target tracking scaling policy is disabled.
	// If the value is true, scale in is disabled and the target tracking scaling
	// policy won't remove capacity from the scalable target. Otherwise, scale in
	// is enabled and the target tracking scaling policy can remove capacity from
	// the scalable target. The default value is false.
	DisableScaleIn *bool `type:"boolean"`

	// A predefined metric. You can specify either a predefined metric or a customized
	// metric.
	PredefinedMetricSpecification *PredefinedMetricSpecification `type:"structure"`

	// The amount of time, in seconds, after a scale-in activity completes before
	// another scale-in activity can start. For more information and for default
	// values, see Define cooldown periods (https://docs.aws.amazon.com/autoscaling/application/userguide/target-tracking-scaling-policy-overview.html#target-tracking-cooldown)
	// in the Application Auto Scaling User Guide.
	ScaleInCooldown *int64 `type:"integer"`

	// The amount of time, in seconds, to wait for a previous scale-out activity
	// to take effect. For more information and for default values, see Define cooldown
	// periods (https://docs.aws.amazon.com/autoscaling/application/userguide/target-tracking-scaling-policy-overview.html#target-tracking-cooldown)
	// in the Application Auto Scaling User Guide.
	ScaleOutCooldown *int64 `type:"integer"`

	// The target value for the metric. Although this property accepts numbers of
	// type Double, it won't accept values that are either too small or too large.
	// Values must be in the range of -2^360 to 2^360. The value must be a valid
	// number based on the choice of metric. For example, if the metric is CPU utilization,
	// then the target value is a percent value that represents how much of the
	// CPU can be used before scaling out.
	//
	// If the scaling policy specifies the ALBRequestCountPerTarget predefined metric,
	// specify the target utilization as the optimal average request count per target
	// during any one-minute interval.
	//
	// TargetValue is a required field
	TargetValue *float64 `type:"double" required:"true"`
	// contains filtered or unexported fields
}

Represents a target tracking scaling policy configuration to use with Application Auto Scaling.

For more information, see Target tracking scaling policies (https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-target-tracking.html) in the Application Auto Scaling User Guide.

func (TargetTrackingScalingPolicyConfiguration) GoString added in v1.8.42

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TargetTrackingScalingPolicyConfiguration) SetCustomizedMetricSpecification added in v1.8.42

SetCustomizedMetricSpecification sets the CustomizedMetricSpecification field's value.

func (*TargetTrackingScalingPolicyConfiguration) SetDisableScaleIn added in v1.10.35

SetDisableScaleIn sets the DisableScaleIn field's value.

func (*TargetTrackingScalingPolicyConfiguration) SetPredefinedMetricSpecification added in v1.8.42

SetPredefinedMetricSpecification sets the PredefinedMetricSpecification field's value.

func (*TargetTrackingScalingPolicyConfiguration) SetScaleInCooldown added in v1.8.42

SetScaleInCooldown sets the ScaleInCooldown field's value.

func (*TargetTrackingScalingPolicyConfiguration) SetScaleOutCooldown added in v1.8.42

SetScaleOutCooldown sets the ScaleOutCooldown field's value.

func (*TargetTrackingScalingPolicyConfiguration) SetTargetValue added in v1.8.42

SetTargetValue sets the TargetValue field's value.

func (TargetTrackingScalingPolicyConfiguration) String added in v1.8.42

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TargetTrackingScalingPolicyConfiguration) Validate added in v1.8.42

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

type TooManyTagsException added in v1.44.225

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

	Message_ *string `locationName:"Message" type:"string"`

	// The name of the Application Auto Scaling resource. This value is an Amazon
	// Resource Name (ARN).
	ResourceName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

The request contains too many tags. Try the request again with fewer tags.

func (*TooManyTagsException) Code added in v1.44.225

func (s *TooManyTagsException) Code() string

Code returns the exception type name.

func (*TooManyTagsException) Error added in v1.44.225

func (s *TooManyTagsException) Error() string

func (TooManyTagsException) GoString added in v1.44.225

func (s TooManyTagsException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TooManyTagsException) Message added in v1.44.225

func (s *TooManyTagsException) Message() string

Message returns the exception's message.

func (*TooManyTagsException) OrigErr added in v1.44.225

func (s *TooManyTagsException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*TooManyTagsException) RequestID added in v1.44.225

func (s *TooManyTagsException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*TooManyTagsException) StatusCode added in v1.44.225

func (s *TooManyTagsException) StatusCode() int

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

func (TooManyTagsException) String added in v1.44.225

func (s TooManyTagsException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UntagResourceInput added in v1.44.225

type UntagResourceInput struct {

	// Identifies the Application Auto Scaling scalable target from which to remove
	// tags.
	//
	// For example: arn:aws:application-autoscaling:us-east-1:123456789012:scalable-target/1234abcd56ab78cd901ef1234567890ab123
	//
	// To get the ARN for a scalable target, use DescribeScalableTargets.
	//
	// ResourceARN is a required field
	ResourceARN *string `min:"1" type:"string" required:"true"`

	// One or more tag keys. Specify only the tag keys, not the tag values.
	//
	// TagKeys is a required field
	TagKeys []*string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (UntagResourceInput) GoString added in v1.44.225

func (s UntagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceInput) SetResourceARN added in v1.44.225

func (s *UntagResourceInput) SetResourceARN(v string) *UntagResourceInput

SetResourceARN sets the ResourceARN field's value.

func (*UntagResourceInput) SetTagKeys added in v1.44.225

func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput

SetTagKeys sets the TagKeys field's value.

func (UntagResourceInput) String added in v1.44.225

func (s UntagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceInput) Validate added in v1.44.225

func (s *UntagResourceInput) Validate() error

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

type UntagResourceOutput added in v1.44.225

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

func (UntagResourceOutput) GoString added in v1.44.225

func (s UntagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UntagResourceOutput) String added in v1.44.225

func (s UntagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ValidationException added in v1.28.0

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

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

An exception was thrown for a validation issue. Review the available parameters for the API request.

func (*ValidationException) Code added in v1.28.0

func (s *ValidationException) Code() string

Code returns the exception type name.

func (*ValidationException) Error added in v1.28.0

func (s *ValidationException) Error() string

func (ValidationException) GoString added in v1.28.0

func (s ValidationException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ValidationException) Message added in v1.28.0

func (s *ValidationException) Message() string

Message returns the exception's message.

func (*ValidationException) OrigErr added in v1.28.0

func (s *ValidationException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ValidationException) RequestID added in v1.28.0

func (s *ValidationException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ValidationException) StatusCode added in v1.28.0

func (s *ValidationException) StatusCode() int

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

func (ValidationException) String added in v1.28.0

func (s ValidationException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL