dprevot/python-botocore
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity
python-botocore/botocore/data/application-autoscaling/2016-02-06/service-2.json

767 lines
48 KiB
JSON
Raw Normal View History

Import python-botocore_1.4.60.orig.tar.gz
2016-10-11 02:22:54 +02:00
{
"version":"2.0",
"metadata":{
"apiVersion":"2016-02-06",
"endpointPrefix":"autoscaling",
"jsonVersion":"1.1",
"protocol":"json",
"serviceFullName":"Application Auto Scaling",
"signatureVersion":"v4",
"signingName":"application-autoscaling",
"targetPrefix":"AnyScaleFrontendService"
},
"operations":{
"DeleteScalingPolicy":{
"name":"DeleteScalingPolicy",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteScalingPolicyRequest"},
"output":{"shape":"DeleteScalingPolicyResponse"},
"errors":[
{"shape":"ValidationException"},
{"shape":"ObjectNotFoundException"},
{"shape":"ConcurrentUpdateException"},
{"shape":"InternalServiceException"}
],
"documentation":"<p>Deletes an Application Auto Scaling scaling policy that was previously created. If you are no longer using a scaling policy, you can delete it with this operation.</p> <p>Deleting a policy deletes the underlying alarm action, but does not delete the CloudWatch alarm associated with the scaling policy, even if it no longer has an associated action.</p> <p>To create a new scaling policy or update an existing one, see <a>PutScalingPolicy</a>.</p>"
},
"DeregisterScalableTarget":{
"name":"DeregisterScalableTarget",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeregisterScalableTargetRequest"},
"output":{"shape":"DeregisterScalableTargetResponse"},
"errors":[
{"shape":"ValidationException"},
{"shape":"ObjectNotFoundException"},
{"shape":"ConcurrentUpdateException"},
{"shape":"InternalServiceException"}
],
"documentation":"<p>Deregisters a scalable target that was previously registered. If you are no longer using a scalable target, you can delete it with this operation. When you deregister a scalable target, all of the scaling policies that are associated with that scalable target are deleted.</p> <p>To create a new scalable target or update an existing one, see <a>RegisterScalableTarget</a>.</p>"
},
"DescribeScalableTargets":{
"name":"DescribeScalableTargets",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeScalableTargetsRequest"},
"output":{"shape":"DescribeScalableTargetsResponse"},
"errors":[
{"shape":"ValidationException"},
{"shape":"InvalidNextTokenException"},
{"shape":"ConcurrentUpdateException"},
{"shape":"InternalServiceException"}
],
"documentation":"<p>Provides descriptive information for scalable targets with a specified service namespace.</p> <p>You can filter the results in a service namespace with the <code>ResourceIds</code> and <code>ScalableDimension</code> parameters.</p> <p>To create a new scalable target or update an existing one, see <a>RegisterScalableTarget</a>. If you are no longer using a scalable target, you can deregister it with <a>DeregisterScalableTarget</a>.</p>"
},
"DescribeScalingActivities":{
"name":"DescribeScalingActivities",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeScalingActivitiesRequest"},
"output":{"shape":"DescribeScalingActivitiesResponse"},
"errors":[
{"shape":"ValidationException"},
{"shape":"InvalidNextTokenException"},
{"shape":"ConcurrentUpdateException"},
{"shape":"InternalServiceException"}
],
"documentation":"<p>Provides descriptive information for scaling activities with a specified service namespace for the previous six weeks.</p> <p>You can filter the results in a service namespace with the <code>ResourceId</code> and <code>ScalableDimension</code> parameters.</p> <p>Scaling activities are triggered by CloudWatch alarms that are associated with scaling policies. To view the existing scaling policies for a service namespace, see <a>DescribeScalingPolicies</a>. To create a new scaling policy or update an existing one, see <a>PutScalingPolicy</a>.</p>"
},
"DescribeScalingPolicies":{
"name":"DescribeScalingPolicies",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeScalingPoliciesRequest"},
"output":{"shape":"DescribeScalingPoliciesResponse"},
"errors":[
{"shape":"ValidationException"},
{"shape":"FailedResourceAccessException"},
{"shape":"InvalidNextTokenException"},
{"shape":"ConcurrentUpdateException"},
{"shape":"InternalServiceException"}
],
"documentation":"<p>Provides descriptive information for scaling policies with a specified service namespace.</p> <p>You can filter the results in a service namespace with the <code>ResourceId</code>, <code>ScalableDimension</code>, and <code>PolicyNames</code> parameters.</p> <p>To create a new scaling policy or update an existing one, see <a>PutScalingPolicy</a>. If you are no longer using a scaling policy, you can delete it with <a>DeleteScalingPolicy</a>.</p>"
},
"PutScalingPolicy":{
"name":"PutScalingPolicy",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"PutScalingPolicyRequest"},
"output":{"shape":"PutScalingPolicyResponse"},
"errors":[
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"ObjectNotFoundException"},
{"shape":"ConcurrentUpdateException"},
{"shape":"InternalServiceException"}
],
"documentation":"<p>Creates or updates a policy for an existing Application Auto Scaling scalable target. Each scalable target is identified by service namespace, a resource ID, and a scalable dimension, and a scaling policy applies to a scalable target that is identified by those three attributes. You cannot create a scaling policy without first registering a scalable target with <a>RegisterScalableTarget</a>.</p> <p>To update an existing policy, use the existing policy name and set the parameters you want to change. Any existing parameter not changed in an update to an existing policy is not changed in this update request.</p> <p>You can view the existing scaling policies for a service namespace with <a>DescribeScalingPolicies</a>. If you are no longer using a scaling policy, you can delete it with <a>DeleteScalingPolicy</a>.</p>"
},
"RegisterScalableTarget":{
"name":"RegisterScalableTarget",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"RegisterScalableTargetRequest"},
"output":{"shape":"RegisterScalableTargetResponse"},
"errors":[
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"ConcurrentUpdateException"},
{"shape":"InternalServiceException"}
],
"documentation":"<p>Registers or updates a scalable target. A scalable target is a resource that can be scaled out or in with Application Auto Scaling. After you have registered a scalable target, you can use this operation to update the minimum and maximum values for your scalable dimension.</p> <p>After you register a scalable target with Application Auto Scaling, you can create and apply scaling policies to it with <a>PutScalingPolicy</a>. You can view the existing scaling policies for a service namespace with <a>DescribeScalableTargets</a>. If you are no longer using a scalable target, you can deregister it with <a>DeregisterScalableTarget</a>.</p>"
}
},
"shapes":{
"AdjustmentType":{
"type":"string",
"enum":[
"ChangeInCapacity",
"PercentChangeInCapacity",
"ExactCapacity"
]
},
"Alarm":{
"type":"structure",
"required":[
"AlarmName",
"AlarmARN"
],
"members":{
"AlarmName":{
"shape":"ResourceId",
"documentation":"<p>The name of the alarm.</p>"
},
"AlarmARN":{
"shape":"ResourceId",
"documentation":"<p>The Amazon Resource Name (ARN) of the alarm.</p>"
}
},
"documentation":"<p>An object representing a CloudWatch alarm associated with a scaling policy.</p>"
},
"Alarms":{
"type":"list",
"member":{"shape":"Alarm"}
},
"ConcurrentUpdateException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"}
},
"documentation":"<p>Concurrent updates caused an exception, for example, if you request an update to an Application Auto Scaling resource that already has a pending update.</p>",
"exception":true
},
"Cooldown":{"type":"integer"},
"DeleteScalingPolicyRequest":{
"type":"structure",
"required":[
"PolicyName",
"ServiceNamespace",
"ResourceId",
"ScalableDimension"
],
"members":{
"PolicyName":{
"shape":"ResourceIdMaxLen1600",
"documentation":"<p>The name of the scaling policy to delete.</p>"
},
"ServiceNamespace":{
"shape":"ServiceNamespace",
"documentation":"<p>The namespace for the AWS service that the scaling policy is associated with. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the Amazon Web Services General Reference.</p>"
},
"ResourceId":{
"shape":"ResourceIdMaxLen1600",
"documentation":"<p>The resource type and unique identifier string for the resource associated with the scaling policy. For Amazon ECS services, the resource type is <code>services</code>, and the identifier is the cluster name and service name; for example, <code>service/default/sample-webapp</code>. For Amazon EC2 Spot fleet requests, the resource type is <code>spot-fleet-request</code>, and the identifier is the Spot fleet request ID; for example, <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p>"
},
"ScalableDimension":{
"shape":"ScalableDimension",
"documentation":"<p>The scalable dimension associated with the scaling policy. The scalable dimension contains the service namespace, resource type, and scaling property, such as <code>ecs:service:DesiredCount</code> for the desired task count of an Amazon ECS service, or <code>ec2:spot-fleet-request:TargetCapacity</code> for the target capacity of an Amazon EC2 Spot fleet request.</p>"
}
}
},
"DeleteScalingPolicyResponse":{
"type":"structure",
"members":{
}
},
"DeregisterScalableTargetRequest":{
"type":"structure",
"required":[
"ServiceNamespace",
"ResourceId",
"ScalableDimension"
],
"members":{
"ServiceNamespace":{
"shape":"ServiceNamespace",
"documentation":"<p>The namespace for the AWS service that the scalable target is associated with. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the Amazon Web Services General Reference.</p>"
},
"ResourceId":{
"shape":"ResourceIdMaxLen1600",
"documentation":"<p>The resource type and unique identifier string for the resource associated with the scalable target. For Amazon ECS services, the resource type is <code>services</code>, and the identifier is the cluster name and service name; for example, <code>service/default/sample-webapp</code>. For Amazon EC2 Spot fleet requests, the resource type is <code>spot-fleet-request</code>, and the identifier is the Spot fleet request ID; for example, <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p>"
},
"ScalableDimension":{
"shape":"ScalableDimension",
"documentation":"<p>The scalable dimension associated with the scalable target. The scalable dimension contains the service namespace, resource type, and scaling property, such as <code>ecs:service:DesiredCount</code> for the desired task count of an Amazon ECS service, or <code>ec2:spot-fleet-request:TargetCapacity</code> for the target capacity of an Amazon EC2 Spot fleet request.</p>"
}
}
},
"DeregisterScalableTargetResponse":{
"type":"structure",
"members":{
}
},
"DescribeScalableTargetsRequest":{
"type":"structure",
"required":["ServiceNamespace"],
"members":{
"ServiceNamespace":{
"shape":"ServiceNamespace",
"documentation":"<p>The namespace for the AWS service that the scalable target is associated with. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the Amazon Web Services General Reference.</p>"
},
"ResourceIds":{
"shape":"ResourceIdsMaxLen1600",
"documentation":"<p>The resource type and unique identifier string for the resource associated with the scalable target. For Amazon ECS services, the resource type is <code>services</code>, and the identifier is the cluster name and service name; for example, <code>service/default/sample-webapp</code>. For Amazon EC2 Spot fleet requests, the resource type is <code>spot-fleet-request</code>, and the identifier is the Spot fleet request ID; for example, <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>. If you specify a scalable dimension, you must also specify a resource ID.</p>"
},
"ScalableDimension":{
"shape":"ScalableDimension",
"documentation":"<p>The scalable dimension associated with the scalable target. The scalable dimension contains the service namespace, resource type, and scaling property, such as <code>ecs:service:DesiredCount</code> for the desired task count of an Amazon ECS service, or <code>ec2:spot-fleet-request:TargetCapacity</code> for the target capacity of an Amazon EC2 Spot fleet request. If you specify a scalable dimension, you must also specify a resource ID.</p>"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of scalable target results returned by <code>DescribeScalableTargets</code> in paginated output. When this parameter is used, <code>DescribeScalableTargets</code> returns up to <code>MaxResults</code> results in a single page along with a <code>NextToken</code> response element. The remaining results of the initial request can be seen by sending another <code>DescribeScalableTargets</code> request with the returned <code>NextToken</code> value. This value can be between 1 and 50. If this parameter is not used, then <code>DescribeScalableTargets</code> returns up to 50 results and a <code>NextToken</code> value, if applicable.</p>"
},
"NextToken":{
"shape":"XmlString",
"documentation":"<p>The <code>NextToken</code> value returned from a previous paginated <code>DescribeScalableTargets</code> request. Pagination continues from the end of the previous results that returned the <code>NextToken</code> value. This value is <code>null</code> when there are no more results to return.</p>"
}
}
},
"DescribeScalableTargetsResponse":{
"type":"structure",
"members":{
"ScalableTargets":{
"shape":"ScalableTargets",
"documentation":"<p>The list of scalable targets that matches the request parameters.</p>"
},
"NextToken":{
"shape":"XmlString",
"documentation":"<p>The <code>NextToken</code> value to include in a future <code>DescribeScalableTargets</code> request. When the results of a <code>DescribeScalableTargets</code> request exceed <code>MaxResults</code>, this value can be used to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>"
}
}
},
"DescribeScalingActivitiesRequest":{
"type":"structure",
"required":["ServiceNamespace"],
"members":{
"ServiceNamespace":{
"shape":"ServiceNamespace",
"documentation":"<p>The namespace for the AWS service that the scaling activity is associated with. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the Amazon Web Services General Reference.</p>"
},
"ResourceId":{
"shape":"ResourceIdMaxLen1600",
"documentation":"<p>The resource type and unique identifier string for the resource associated with the scaling activity. For Amazon ECS services, the resource type is <code>services</code>, and the identifier is the cluster name and service name; for example, <code>service/default/sample-webapp</code>. For Amazon EC2 Spot fleet requests, the resource type is <code>spot-fleet-request</code>, and the identifier is the Spot fleet request ID; for example, <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>. If you specify a scalable dimension, you must also specify a resource ID.</p>"
},
"ScalableDimension":{
"shape":"ScalableDimension",
"documentation":"<p>The scalable dimension associated with the scaling activity. The scalable dimension contains the service namespace, resource type, and scaling property, such as <code>ecs:service:DesiredCount</code> for the desired task count of an Amazon ECS service, or <code>ec2:spot-fleet-request:TargetCapacity</code> for the target capacity of an Amazon EC2 Spot fleet request. If you specify a scalable dimension, you must also specify a resource ID.</p>"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of scaling activity results returned by <code>DescribeScalingActivities</code> in paginated output. When this parameter is used, <code>DescribeScalingActivities</code> returns up to <code>MaxResults</code> results in a single page along with a <code>NextToken</code> response element. The remaining results of the initial request can be seen by sending another <code>DescribeScalingActivities</code> request with the returned <code>NextToken</code> value. This value can be between 1 and 50. If this parameter is not used, then <code>DescribeScalingActivities</code> returns up to 50 results and a <code>NextToken</code> value, if applicable.</p>"
},
"NextToken":{
"shape":"XmlString",
"documentation":"<p>The <code>NextToken</code> value returned from a previous paginated <code>DescribeScalingActivities</code> request. Pagination continues from the end of the previous results that returned the <code>NextToken</code> value. This value is <code>null</code> when there are no more results to return.</p>"
}
}
},
"DescribeScalingActivitiesResponse":{
"type":"structure",
"members":{
"ScalingActivities":{
"shape":"ScalingActivities",
"documentation":"<p>A list of scaling activity objects.</p>"
},
"NextToken":{
"shape":"XmlString",
"documentation":"<p>The <code>NextToken</code> value to include in a future <code>DescribeScalingActivities</code> request. When the results of a <code>DescribeScalingActivities</code> request exceed <code>MaxResults</code>, this value can be used to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>"
}
}
},
"DescribeScalingPoliciesRequest":{
"type":"structure",
"required":["ServiceNamespace"],
"members":{
"PolicyNames":{
"shape":"ResourceIdsMaxLen1600",
"documentation":"<p>The names of the scaling policies to describe.</p>"
},
"ServiceNamespace":{
"shape":"ServiceNamespace",
"documentation":"<p>The AWS service namespace of the scalable target that the scaling policy is associated with. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the Amazon Web Services General Reference.</p>"
},
"ResourceId":{
"shape":"ResourceIdMaxLen1600",
"documentation":"<p>The unique resource identifier string of the scalable target that the scaling policy is associated with. For Amazon ECS services, the resource type is <code>services</code>, and the identifier is the cluster name and service name; for example, <code>service/default/sample-webapp</code>. For Amazon EC2 Spot fleet requests, the resource type is <code>spot-fleet-request</code>, and the identifier is the Spot fleet request ID; for example, <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>. If you specify a scalable dimension, you must also specify a resource ID.</p>"
},
"ScalableDimension":{
"shape":"ScalableDimension",
"documentation":"<p>The scalable dimension of the scalable target that the scaling policy is associated with. The scalable dimension contains the service namespace, resource type, and scaling property, such as <code>ecs:service:DesiredCount</code> for the desired task count of an Amazon ECS service, or <code>ec2:spot-fleet-request:TargetCapacity</code> for the target capacity of an Amazon EC2 Spot fleet request. If you specify a scalable dimension, you must also specify a resource ID.</p>"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of scaling policy results returned by <code>DescribeScalingPolicies</code> in paginated output. When this parameter is used, <code>DescribeScalingPolicies</code> returns up to <code>MaxResults</code> results in a single page along with a <code>NextToken</code> response element. The remaining results of the initial request can be seen by sending another <code>DescribeScalingPolicies</code> request with the returned <code>NextToken</code> value. This value can be between 1 and 50. If this parameter is not used, then <code>DescribeScalingPolicies</code> returns up to 50 results and a <code>NextToken</code> value, if applicable.</p>"
},
"NextToken":{
"shape":"XmlString",
"documentation":"<p>The <code>NextToken</code> value returned from a previous paginated <code>DescribeScalingPolicies</code> request. Pagination continues from the end of the previous results that returned the <code>NextToken</code> value. This value is <code>null</code> when there are no more results to return.</p>"
}
}
},
"DescribeScalingPoliciesResponse":{
"type":"structure",
"members":{
"ScalingPolicies":{
"shape":"ScalingPolicies",
"documentation":"<p>A list of scaling policy objects.</p>"
},
"NextToken":{
"shape":"XmlString",
"documentation":"<p>The <code>NextToken</code> value to include in a future <code>DescribeScalingPolicies</code> request. When the results of a <code>DescribeScalingPolicies</code> request exceed <code>MaxResults</code>, this value can be used to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>"
}
}
},
"ErrorMessage":{"type":"string"},
"FailedResourceAccessException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"}
},
"documentation":"<p>Failed access to resources caused an exception. This exception currently only applies to <a>DescribeScalingPolicies</a>. It is thrown when Application Auto Scaling is unable to retrieve the alarms associated with a scaling policy due to a client error, for example, if the role ARN specified for a scalable target does not have the proper permissions to call the CloudWatch <a href=\"http://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_DescribeAlarms.html\">DescribeAlarms</a> API operation on behalf of your account.</p>",
"exception":true
},
"InternalServiceException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"}
},
"documentation":"<p>The service encountered an internal error.</p>",
"exception":true
},
"InvalidNextTokenException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"}
},
"documentation":"<p>The next token supplied was invalid.</p>",
"exception":true
},
"LimitExceededException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"}
},
"documentation":"<p>Your account exceeded a limit. This exception is thrown when a per-account resource limit is exceeded. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html#limits_as-app\">Application Auto Scaling Limits</a>.</p>",
"exception":true
},
"MaxResults":{"type":"integer"},
"MetricAggregationType":{
"type":"string",
"enum":[
"Average",
"Minimum",
"Maximum"
]
},
"MetricScale":{"type":"double"},
"MinAdjustmentMagnitude":{"type":"integer"},
"ObjectNotFoundException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"}
},
"documentation":"<p>The specified object could not be found. For any <code>Put</code> or <code>Register</code> API operation, which depends on the existence of a scalable target, this exception is thrown if the scalable target with the specified service namespace, resource ID, and scalable dimension does not exist. For any <code>Delete</code> or <code>Deregister</code> API operation, this exception is thrown if the resource that is to be deleted or deregistered cannot be found.</p>",
"exception":true
},
"PolicyName":{
"type":"string",
"max":256,
"min":1,
"pattern":"\\p{Print}+"
},
"PolicyType":{
"type":"string",
"enum":["StepScaling"]
},
"PutScalingPolicyRequest":{
"type":"structure",
"required":[
"PolicyName",
"ServiceNamespace",
"ResourceId",
"ScalableDimension"
],
"members":{
"PolicyName":{
"shape":"PolicyName",
"documentation":"<p>The name of the scaling policy.</p>"
},
"ServiceNamespace":{
"shape":"ServiceNamespace",
"documentation":"<p>The AWS service namespace of the scalable target that this scaling policy applies to. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the Amazon Web Services General Reference.</p>"
},
"ResourceId":{
"shape":"ResourceIdMaxLen1600",
"documentation":"<p>The unique resource identifier string for the scalable target that this scaling policy applies to. For Amazon ECS services, the resource type is <code>services</code>, and the identifier is the cluster name and service name; for example, <code>service/default/sample-webapp</code>. For Amazon EC2 Spot fleet requests, the resource type is <code>spot-fleet-request</code>, and the identifier is the Spot fleet request ID; for example, <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p>"
},
"ScalableDimension":{
"shape":"ScalableDimension",
"documentation":"<p>The scalable dimension of the scalable target that this scaling policy applies to. The scalable dimension contains the service namespace, resource type, and scaling property, such as <code>ecs:service:DesiredCount</code> for the desired task count of an Amazon ECS service, or <code>ec2:spot-fleet-request:TargetCapacity</code> for the target capacity of an Amazon EC2 Spot fleet request.</p>"
},
"PolicyType":{
"shape":"PolicyType",
"documentation":"<p>The policy type. If you are creating a new policy, this parameter is required. If you are updating an existing policy, this parameter is not required.</p>"
},
"StepScalingPolicyConfiguration":{
"shape":"StepScalingPolicyConfiguration",
"documentation":"<p>The configuration for the step scaling policy. If you are creating a new policy, this parameter is required. If you are updating an existing policy, this parameter is not required. For more information, see <a>StepScalingPolicyConfiguration</a> and <a>StepAdjustment</a>.</p>"
}
}
},
"PutScalingPolicyResponse":{
"type":"structure",
"required":["PolicyARN"],
"members":{
"PolicyARN":{
"shape":"ResourceIdMaxLen1600",
"documentation":"<p>The Amazon Resource Name (ARN) of the resulting scaling policy.</p>"
}
}
},
"RegisterScalableTargetRequest":{
"type":"structure",
"required":[
"ServiceNamespace",
"ResourceId",
"ScalableDimension"
],
"members":{
"ServiceNamespace":{
"shape":"ServiceNamespace",
"documentation":"<p>The namespace for the AWS service that the scalable target is associated with. For Amazon ECS services, the namespace value is <code>ecs</code>. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the Amazon Web Services General Reference.</p>"
},
"ResourceId":{
"shape":"ResourceIdMaxLen1600",
"documentation":"<p>The resource type and unique identifier string for the resource to associate with the scalable target. For Amazon ECS services, the resource type is <code>services</code>, and the identifier is the cluster name and service name; for example, <code>service/default/sample-webapp</code>. For Amazon EC2 Spot fleet requests, the resource type is <code>spot-fleet-request</code>, and the identifier is the Spot fleet request ID; for example, <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p>"
},
"ScalableDimension":{
"shape":"ScalableDimension",
"documentation":"<p>The scalable dimension associated with the scalable target. The scalable dimension contains the service namespace, resource type, and scaling property, such as <code>ecs:service:DesiredCount</code> for the desired task count of an Amazon ECS service, or <code>ec2:spot-fleet-request:TargetCapacity</code> for the target capacity of an Amazon EC2 Spot fleet request.</p>"
},
"MinCapacity":{
"shape":"ResourceCapacity",
"documentation":"<p>The minimum value for this scalable target to scale in to in response to scaling activities. This parameter is required if you are registering a new scalable target, and it is optional if you are updating an existing one.</p>"
},
"MaxCapacity":{
"shape":"ResourceCapacity",
"documentation":"<p>The maximum value for this scalable target to scale out to in response to scaling activities. This parameter is required if you are registering a new scalable target, and it is optional if you are updating an existing one.</p>"
},
"RoleARN":{
"shape":"ResourceIdMaxLen1600",
"documentation":"<p>The ARN of the IAM role that allows Application Auto Scaling to modify your scalable target on your behalf. This parameter is required if you are registering a new scalable target, and it is optional if you are updating an existing one.</p>"
}
}
},
"RegisterScalableTargetResponse":{
"type":"structure",
"members":{
}
},
"ResourceCapacity":{"type":"integer"},
"ResourceId":{
"type":"string",
"pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*"
},
"ResourceIdMaxLen1600":{
"type":"string",
"max":1600,
"min":1,
"pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*"
},
"ResourceIdsMaxLen1600":{
"type":"list",
"member":{"shape":"ResourceIdMaxLen1600"}
},
"ScalableDimension":{
"type":"string",
"enum":[
"ecs:service:DesiredCount",
"ec2:spot-fleet-request:TargetCapacity"
]
},
"ScalableTarget":{
"type":"structure",
"required":[
"ServiceNamespace",
"ResourceId",
"ScalableDimension",
"MinCapacity",
"MaxCapacity",
"RoleARN",
"CreationTime"
],
"members":{
"ServiceNamespace":{
"shape":"ServiceNamespace",
"documentation":"<p>The namespace for the AWS service that the scalable target is associated with. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the Amazon Web Services General Reference.</p>"
},
"ResourceId":{
"shape":"ResourceIdMaxLen1600",
"documentation":"<p>The resource type and unique identifier string for the resource associated with the scalable target. For Amazon ECS services, the resource type is <code>services</code>, and the identifier is the cluster name and service name; for example, <code>service/default/sample-webapp</code>. For Amazon EC2 Spot fleet requests, the resource type is <code>spot-fleet-request</code>, and the identifier is the Spot fleet request ID; for example, <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p>"
},
"ScalableDimension":{
"shape":"ScalableDimension",
"documentation":"<p>The scalable dimension associated with the scalable target. The scalable dimension contains the service namespace, resource type, and scaling property, such as <code>ecs:service:DesiredCount</code> for the desired task count of an Amazon ECS service, or <code>ec2:spot-fleet-request:TargetCapacity</code> for the target capacity of an Amazon EC2 Spot fleet request.</p>"
},
"MinCapacity":{
"shape":"ResourceCapacity",
"documentation":"<p>The minimum value for this scalable target to scale in to in response to scaling activities.</p>"
},
"MaxCapacity":{
"shape":"ResourceCapacity",
"documentation":"<p>The maximum value for this scalable target to scale out to in response to scaling activities.</p>"
},
"RoleARN":{
"shape":"ResourceIdMaxLen1600",
"documentation":"<p>The ARN of the IAM role that allows Application Auto Scaling to modify your scalable target on your behalf.</p>"
},
"CreationTime":{
"shape":"TimestampType",
"documentation":"<p>The Unix timestamp for when the scalable target was created.</p>"
}
},
"documentation":"<p>An object representing a scalable target.</p>"
},
"ScalableTargets":{
"type":"list",
"member":{"shape":"ScalableTarget"}
},
"ScalingActivities":{
"type":"list",
"member":{"shape":"ScalingActivity"}
},
"ScalingActivity":{
"type":"structure",
"required":[
"ActivityId",
"ServiceNamespace",
"ResourceId",
"ScalableDimension",
"Description",
"Cause",
"StartTime",
"StatusCode"
],
"members":{
"ActivityId":{
"shape":"ResourceId",
"documentation":"<p>The unique identifier string for the scaling activity.</p>"
},
"ServiceNamespace":{
"shape":"ServiceNamespace",
"documentation":"<p>The namespace for the AWS service that the scaling activity is associated with. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the Amazon Web Services General Reference.</p>"
},
"ResourceId":{
"shape":"ResourceIdMaxLen1600",
"documentation":"<p>The resource type and unique identifier string for the resource associated with the scaling activity. For Amazon ECS services, the resource type is <code>services</code>, and the identifier is the cluster name and service name; for example, <code>service/default/sample-webapp</code>. For Amazon EC2 Spot fleet requests, the resource type is <code>spot-fleet-request</code>, and the identifier is the Spot fleet request ID; for example, <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p>"
},
"ScalableDimension":{
"shape":"ScalableDimension",
"documentation":"<p>The scalable dimension associated with the scaling activity. The scalable dimension contains the service namespace, resource type, and scaling property, such as <code>ecs:service:DesiredCount</code> for the desired task count of an Amazon ECS service, or <code>ec2:spot-fleet-request:TargetCapacity</code> for the target capacity of an Amazon EC2 Spot fleet request.</p>"
},
"Description":{
"shape":"XmlString",
"documentation":"<p>A simple description of what action the scaling activity intends to accomplish.</p>"
},
"Cause":{
"shape":"XmlString",
"documentation":"<p>A simple description of what caused the scaling activity to happen.</p>"
},
"StartTime":{
"shape":"TimestampType",
"documentation":"<p>The Unix timestamp for when the scaling activity began.</p>"
},
"EndTime":{
"shape":"TimestampType",
"documentation":"<p>The Unix timestamp for when the scaling activity ended.</p>"
},
"StatusCode":{
"shape":"ScalingActivityStatusCode",
"documentation":"<p>Indicates the status of the scaling activity.</p>"
},
"StatusMessage":{
"shape":"XmlString",
"documentation":"<p>A simple message about the current status of the scaling activity.</p>"
},
"Details":{
"shape":"XmlString",
"documentation":"<p>The details about the scaling activity.</p>"
}
},
"documentation":"<p>An object representing a scaling activity.</p>"
},
"ScalingActivityStatusCode":{
"type":"string",
"enum":[
"Pending",
"InProgress",
"Successful",
"Overridden",
"Unfulfilled",
"Failed"
]
},
"ScalingAdjustment":{"type":"integer"},
"ScalingPolicies":{
"type":"list",
"member":{"shape":"ScalingPolicy"}
},
"ScalingPolicy":{
"type":"structure",
"required":[
"PolicyARN",
"PolicyName",
"ServiceNamespace",
"ResourceId",
"ScalableDimension",
"PolicyType",
"CreationTime"
],
"members":{
"PolicyARN":{
"shape":"ResourceIdMaxLen1600",
"documentation":"<p>The Amazon Resource Name (ARN) of the scaling policy.</p>"
},
"PolicyName":{
"shape":"PolicyName",
"documentation":"<p>The name of the scaling policy.</p>"
},
"ServiceNamespace":{
"shape":"ServiceNamespace",
"documentation":"<p>The namespace for the AWS service that the scaling policy is associated with. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the Amazon Web Services General Reference.</p>"
},
"ResourceId":{
"shape":"ResourceIdMaxLen1600",
"documentation":"<p>The resource type and unique identifier string for the resource associated with the scaling policy. For Amazon ECS services, the resource type is <code>services</code>, and the identifier is the cluster name and service name; for example, <code>service/default/sample-webapp</code>. For Amazon EC2 Spot fleet requests, the resource type is <code>spot-fleet-request</code>, and the identifier is the Spot fleet request ID; for example, <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p>"
},
"ScalableDimension":{
"shape":"ScalableDimension",
"documentation":"<p>The scalable dimension associated with the scaling policy. The scalable dimension contains the service namespace, resource type, and scaling property, such as <code>ecs:service:DesiredCount</code> for the desired task count of an Amazon ECS service, or <code>ec2:spot-fleet-request:TargetCapacity</code> for the target capacity of an Amazon EC2 Spot fleet request.</p>"
},
"PolicyType":{
"shape":"PolicyType",
"documentation":"<p>The scaling policy type.</p>"
},
"StepScalingPolicyConfiguration":{
"shape":"StepScalingPolicyConfiguration",
"documentation":"<p>The configuration for the step scaling policy.</p>"
},
"Alarms":{
"shape":"Alarms",
"documentation":"<p>The CloudWatch alarms that are associated with the scaling policy.</p>"
},
"CreationTime":{
"shape":"TimestampType",
"documentation":"<p>The Unix timestamp for when the scaling policy was created.</p>"
}
},
"documentation":"<p>An object representing a scaling policy.</p>"
},
"ServiceNamespace":{
"type":"string",
"enum":[
"ecs",
"ec2"
]
},
"StepAdjustment":{
"type":"structure",
"required":["ScalingAdjustment"],
"members":{
"MetricIntervalLowerBound":{
"shape":"MetricScale",
"documentation":"<p>The lower bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the lower bound is inclusive (the metric must be greater than or equal to the threshold plus the lower bound). Otherwise, it is exclusive (the metric must be greater than the threshold plus the lower bound). A null value indicates negative infinity.</p>"
},
"MetricIntervalUpperBound":{
"shape":"MetricScale",
"documentation":"<p>The upper bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the upper bound is exclusive (the metric must be less than the threshold plus the upper bound). Otherwise, it is inclusive (the metric must be less than or equal to the threshold plus the upper bound). A null value indicates positive infinity.</p> <p>The upper bound must be greater than the lower bound.</p>"
},
"ScalingAdjustment":{
"shape":"ScalingAdjustment",
"documentation":"<p>The amount by which to scale, based on the specified adjustment type. A positive value adds to the current scalable dimension while a negative number removes from the current scalable dimension.</p>"
}
},
"documentation":"<p>An object representing a step adjustment for a <a>StepScalingPolicyConfiguration</a>. 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. </p> <p>For the following examples, suppose that you have an alarm with a breach threshold of 50:</p> <ul> <li> <p>If you want the adjustment to be triggered 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.</p> </li> <li> <p>If you want the adjustment to be triggered 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.</p> </li> </ul> <p>There are a few rules for the step adjustments for your step policy:</p> <ul> <li> <p>The ranges of your step adjustments can't overlap or have a gap.</p> </li> <li> <p>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.</p> </li> <li> <p>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.</p> </li> <li> <p>The upper and lower bound can't be null in the same step adjustment.</p> </li> </ul>"
},
"StepAdjustments":{
"type":"list",
"member":{"shape":"StepAdjustment"}
},
"StepScalingPolicyConfiguration":{
"type":"structure",
"members":{
"AdjustmentType":{
"shape":"AdjustmentType",
"documentation":"<p>The adjustment type, which specifies how the <code>ScalingAdjustment</code> parameter in a <a>StepAdjustment</a> is interpreted.</p>"
},
"StepAdjustments":{
"shape":"StepAdjustments",
"documentation":"<p>A set of adjustments that enable you to scale based on the size of the alarm breach.</p>"
},
"MinAdjustmentMagnitude":{
"shape":"MinAdjustmentMagnitude",
"documentation":"<p>The minimum number to adjust your scalable dimension as a result of a scaling activity. If the adjustment type is <code>PercentChangeInCapacity</code>, the scaling policy changes the scalable dimension of the scalable target by this amount.</p>"
},
"Cooldown":{
"shape":"Cooldown",
"documentation":"<p>The amount of time, in seconds, after a scaling activity completes where previous trigger-related scaling activities can influence future scaling events.</p> <p>For scale out policies, while <code>Cooldown</code> is in effect, the capacity that has been added by the previous scale out event that initiated the <code>Cooldown</code> is calculated as part of the desired capacity for the next scale out. The intention is to continuously (but not excessively) scale out. For example, an alarm triggers a step scaling policy to scale out an Amazon ECS service by 2 tasks, the scaling activity completes successfully, and a <code>Cooldown</code> period of 5 minutes starts. During the <code>Cooldown</code> period, if the alarm triggers the same policy again but at a more aggressive step adjustment to scale out the service by 3 tasks, the 2 tasks that were added in the previous scale out event are considered part of that capacity and only 1 additional task is added to the desired count.</p> <p>For scale in policies, the <code>Cooldown</code> period is used to block subsequent scale in requests until it has expired. The intention is to scale in conservatively to protect your application's availability. However, if another alarm triggers a scale out policy during the <code>Cooldown</code> period after a scale-in, Application Auto Scaling scales out your scalable target immediately.</p>"
},
"MetricAggregationType":{
"shape":"MetricAggregationType",
"documentation":"<p>The aggregation type for the CloudWatch metrics. Valid values are <code>Minimum</code>, <code>Maximum</code>, and <code>Average</code>.</p>"
}
},
"documentation":"<p>An object representing a step scaling policy configuration.</p>"
},
"TimestampType":{"type":"timestamp"},
"ValidationException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"}
},
"documentation":"<p>An exception was thrown for a validation issue. Review the available parameters for the API request.</p>",
"exception":true
},
"XmlString":{
"type":"string",
"pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*"
}
},
"documentation":"<p>Application Auto Scaling is a general purpose Auto Scaling service for supported elastic AWS resources. With Application Auto Scaling, you can automatically scale your AWS resources, with an experience similar to that of Auto Scaling.</p> <p>Application Auto Scaling supports scaling the following AWS resources:</p> <ul> <li> <p>Amazon ECS services</p> </li> <li> <p>Amazon EC2 Spot fleet instances</p> </li> </ul> <p>You can use Application Auto Scaling to accomplish the following tasks:</p> <ul> <li> <p>Define scaling policies for automatically adjusting your AWS resources</p> </li> <li> <p>Scale your resources in response to CloudWatch alarms</p> </li> <li> <p>View history of your scaling events </p> </li> </ul> <p>Application Auto Scaling is available in the following regions:</p> <ul> <li> <p> <code>us-east-1</code> </p> </li> <li> <p> <code>us-west-1</code> </p> </li> <li> <p> <code>us-west-2</code> </p> </li> <li> <p> <code>ap-southeast-1</code> </p> </li> <li> <p> <code>ap-southeast-2</code> </p> </li> <li> <p> <code>ap-northeast-1</code> </p> </li> <li> <p> <code>eu-central-1</code> </p> </li> <li> <p> <code>eu-west-1</code> </p> </li> </ul>"
}
Reference in a new issue Copy permalink