ListAutoScalingConfigurations - AWS App Runner

ListAutoScalingConfigurations

Returns a list of AWS App Runner automatic scaling configurations in your AWS account. You can query the revisions for a specific configuration name or the revisions for all configurations in your account. You can optionally query only the latest revision of each requested name.

Request Syntax

{ "AutoScalingConfigurationName": "string", "LatestOnly": boolean, "MaxResults": number, "NextToken": "string" }

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.

AutoScalingConfigurationName

The name of the App Runner auto scaling configuration that you want to list. If specified, App Runner lists revisions that share this name. If not specified, App Runner returns revisions of all configurations.

Type: String

Length Constraints: Minimum length of 4. Maximum length of 32.

Pattern: [A-Za-z0-9][A-Za-z0-9\-_]{3,31}

Required: No

LatestOnly

Set to true to list only the latest revision for each requested configuration name.

Keep as false to list all revisions for each requested configuration name.

Default: false

Type: Boolean

Required: No

MaxResults

The maximum number of results to include in each response (result page). It's used for a paginated request.

If you don't specify MaxResults, the request retrieves all available results in a single response.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

NextToken

A token from a previous result page. It's used for a paginated request. The request retrieves the next result page. All other parameter values must be identical to the ones that are specified in the initial request.

If you don't specify NextToken, the request retrieves the first result page.

Type: String

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

Pattern: .*

Required: No

Response Syntax

{ "AutoScalingConfigurationSummaryList": [ { "AutoScalingConfigurationArn": "string", "AutoScalingConfigurationName": "string", "AutoScalingConfigurationRevision": number } ], "NextToken": "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.

AutoScalingConfigurationSummaryList

A list of summary information records for auto scaling configurations. In a paginated request, the request returns up to MaxResults records for each call.

Type: Array of AutoScalingConfigurationSummary objects

NextToken

The token that you can pass in a subsequent request to get the next result page. It's returned in a paginated request.

Type: String

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

Pattern: .*

Errors

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

InternalServiceErrorException

An unexpected service exception occurred.

HTTP Status Code: 500

InvalidRequestException

One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.

HTTP Status Code: 400

Examples

Paginated listing of App Runner auto scaling configurations

This example illustrates how to list all App Runner auto scaling configurations in your AWS account. Up to five auto scaling configurations are listed in each response. AutoScalingConfigurationName and LatestOnly aren't specified. Their defaults cause the latest revision of all configurations to be listed.

In this example, the response includes two results and there aren't additional ones, so no NextToken is returned.

Sample Request

$ aws apprunner list-auto-scaling-configurations --cli-input-json { "MaxResults": 5 }

Sample Response

{ "AutoScalingConfigurationSummaryList": [ { "AutoScalingConfigurationArn": "arn:aws:apprunner:us-east-1:123456789012:autoscalingconfiguration/high-availability/1/2f50e7656d7819fead0f59672e68042e", "AutoScalingConfigurationName": "high-availability", "AutoScalingConfigurationRevision": 1, }, { "AutoScalingConfigurationArn": "arn:aws:apprunner:us-east-1:123456789012:autoscalingconfiguration/low-cost/1/50d7804e7656fead0f59672e62f2e819", "AutoScalingConfigurationName": "low-cost", "AutoScalingConfigurationRevision": 1, } ] }

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: