Copyright | (c) 2013-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Provides descriptive information for scaling activities with a specified service namespace.
You can filter the results in a service namespace with the ResourceId
and ScalableDimension
parameters.
Scaling activities are triggered by CloudWatch alarms that are associated with scaling policies. To view the existing scaling policies for a service namespace, see DescribeScalingPolicies. To create a new scaling policy or update an existing one, see PutScalingPolicy.
- describeScalingActivities :: ServiceNamespace -> DescribeScalingActivities
- data DescribeScalingActivities
- dsaScalableDimension :: Lens' DescribeScalingActivities (Maybe ScalableDimension)
- dsaResourceId :: Lens' DescribeScalingActivities (Maybe Text)
- dsaNextToken :: Lens' DescribeScalingActivities (Maybe Text)
- dsaMaxResults :: Lens' DescribeScalingActivities (Maybe Int)
- dsaServiceNamespace :: Lens' DescribeScalingActivities ServiceNamespace
- describeScalingActivitiesResponse :: Int -> DescribeScalingActivitiesResponse
- data DescribeScalingActivitiesResponse
- dsarsScalingActivities :: Lens' DescribeScalingActivitiesResponse [ScalingActivity]
- dsarsNextToken :: Lens' DescribeScalingActivitiesResponse (Maybe Text)
- dsarsResponseStatus :: Lens' DescribeScalingActivitiesResponse Int
Creating a Request
describeScalingActivities Source #
Creates a value of DescribeScalingActivities
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data DescribeScalingActivities Source #
See: describeScalingActivities
smart constructor.
Request Lenses
dsaScalableDimension :: Lens' DescribeScalingActivities (Maybe ScalableDimension) Source #
The scalable dimension associated with the scaling activity. The scalable dimension contains the service namespace, resource type, and scaling property, such as 'ecs:service:DesiredCount' for the desired task count of an Amazon ECS service. If you specify a scalable dimension, you must also specify a resource ID.
dsaResourceId :: Lens' DescribeScalingActivities (Maybe Text) Source #
The unique identifier string for the resource associated with the scaling activity. For Amazon ECS services, this value is the resource type, followed by the cluster name and service name, such as 'service\/default\/sample-webapp'. If you specify a scalable dimension, you must also specify a resource ID.
dsaNextToken :: Lens' DescribeScalingActivities (Maybe Text) Source #
The NextToken
value returned from a previous paginated DescribeScalingActivities
request. Pagination continues from the end of the previous results that returned the NextToken
value. This value is null
when there are no more results to return.
dsaMaxResults :: Lens' DescribeScalingActivities (Maybe Int) Source #
The maximum number of scaling activity results returned by DescribeScalingActivities
in paginated output. When this parameter is used, DescribeScalingActivities
returns up to MaxResults
results in a single page along with a NextToken
response element. The remaining results of the initial request can be seen by sending another DescribeScalingActivities
request with the returned NextToken
value. This value can be between 1 and 50. If this parameter is not used, then DescribeScalingActivities
returns up to 50 results and a NextToken
value, if applicable.
dsaServiceNamespace :: Lens' DescribeScalingActivities ServiceNamespace Source #
The namespace for the AWS service that the scaling activity is associated with. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.
Destructuring the Response
describeScalingActivitiesResponse Source #
Creates a value of DescribeScalingActivitiesResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data DescribeScalingActivitiesResponse Source #
See: describeScalingActivitiesResponse
smart constructor.
Response Lenses
dsarsScalingActivities :: Lens' DescribeScalingActivitiesResponse [ScalingActivity] Source #
A list of scaling activity objects.
dsarsNextToken :: Lens' DescribeScalingActivitiesResponse (Maybe Text) Source #
The NextToken
value to include in a future DescribeScalingActivities
request. When the results of a DescribeScalingActivities
request exceed MaxResults
, this value can be used to retrieve the next page of results. This value is null
when there are no more results to return.
dsarsResponseStatus :: Lens' DescribeScalingActivitiesResponse Int Source #
The response status code.