[ aws . apprunner ]

list-auto-scaling-configurations

Description

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

To retrieve a full description of a particular configuration revision, call and provide one of the ARNs returned by ListAutoScalingConfigurations .

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  list-auto-scaling-configurations
[--auto-scaling-configuration-name <value>]
[--latest-only | --no-latest-only]
[--max-results <value>]
[--next-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--auto-scaling-configuration-name (string)

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 active configurations.

--latest-only | --no-latest-only (boolean)

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

Set to false to list all revisions for each requested configuration name.

Default: true

--max-results (integer)

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.

--next-token (string)

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.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Examples

To get a paginated listing of App Runner auto scaling configurations

The following list-auto-scaling-configurations example lists 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 active configurations to be listed.

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

aws apprunner list-auto-scaling-configurations \
    --cli-input-json file://input.json

Contents of input.json:

{
    "MaxResults": 5
}

Output:

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

Output

AutoScalingConfigurationSummaryList -> (list)

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

(structure)

Provides summary information about an App Runner automatic scaling configuration resource.

This type contains limited information about an auto scaling configuration. It includes only identification information, without configuration details. It’s returned by the ListAutoScalingConfigurations action. Complete configuration information is returned by the CreateAutoScalingConfiguration , DescribeAutoScalingConfiguration , and DeleteAutoScalingConfiguration actions using the AutoScalingConfiguration type.

AutoScalingConfigurationArn -> (string)

The Amazon Resource Name (ARN) of this auto scaling configuration.

AutoScalingConfigurationName -> (string)

The customer-provided auto scaling configuration name. It can be used in multiple revisions of a configuration.

AutoScalingConfigurationRevision -> (integer)

The revision of this auto scaling configuration. It’s unique among all the active configurations ("Status": "ACTIVE" ) with the same AutoScalingConfigurationName .

NextToken -> (string)

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