Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DescribeScalingPlanResources

Describes the scalable resources in the specified scaling plan.

Request Syntax


{
   "MaxResults": number,
   "NextToken": "string",
   "ScalingPlanName": "string",
   "ScalingPlanVersion": number
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

MaxResults

The maximum number of scalable resources to return. The value must be between 1 and 50. The default value is 50.

Type: Integer

Required: No

NextToken

The token for the next set of results.

Type: String

Required: No

ScalingPlanName

The name of the scaling plan.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [\p{Print}&&[^|:/]]+

Required: Yes

ScalingPlanVersion

The version number of the scaling plan. Currently, the only valid value is 1.

Type: Long

Required: Yes

Response Syntax


{
   "NextToken": "string",
   "ScalingPlanResources": [ 
      { 
         "ResourceId": "string",
         "ScalableDimension": "string",
         "ScalingPlanName": "string",
         "ScalingPlanVersion": number,
         "ScalingPolicies": [ 
            { 
               "PolicyName": "string",
               "PolicyType": "string",
               "TargetTrackingConfiguration": { 
                  "CustomizedScalingMetricSpecification": { 
                     "Dimensions": [ 
                        { 
                           "Name": "string",
                           "Value": "string"
                        }
                     ],
                     "MetricName": "string",
                     "Namespace": "string",
                     "Statistic": "string",
                     "Unit": "string"
                  },
                  "DisableScaleIn": boolean,
                  "EstimatedInstanceWarmup": number,
                  "PredefinedScalingMetricSpecification": { 
                     "PredefinedScalingMetricType": "string",
                     "ResourceLabel": "string"
                  },
                  "ScaleInCooldown": number,
                  "ScaleOutCooldown": number,
                  "TargetValue": number
               }
            }
         ],
         "ScalingStatusCode": "string",
         "ScalingStatusMessage": "string",
         "ServiceNamespace": "string"
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

NextToken

The token required to get the next set of results. This value is null if there are no more results to return.

Type: String

ScalingPlanResources

Information about the scalable resources.

Type: Array of ScalingPlanResource objects

Errors

For information about the errors that are common to all actions, see Common Errors.

ConcurrentUpdateException

Concurrent updates caused an exception, for example, if you request an update to a scaling plan that already has a pending update.

HTTP Status Code: 400

InternalServiceException

The service encountered an internal error.

HTTP Status Code: 400

InvalidNextTokenException

The token provided is not valid.

HTTP Status Code: 400

ValidationException

An exception was thrown for a validation issue. Review the parameters provided.

HTTP Status Code: 400