AppRunner / Client / list_auto_scaling_configurations

list_auto_scaling_configurations#

AppRunner.Client.list_auto_scaling_configurations(**kwargs)#

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

Request Syntax

response = client.list_auto_scaling_configurations(
    AutoScalingConfigurationName='string',
    LatestOnly=True|False,
    MaxResults=123,
    NextToken='string'
)
Parameters:

  • AutoScalingConfigurationName (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.

  • LatestOnly (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

  • MaxResults (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.

  • NextToken (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.

Return type:

dict

Returns:

Response Syntax

{
    'AutoScalingConfigurationSummaryList': [
        {
            'AutoScalingConfigurationArn': 'string',
            'AutoScalingConfigurationName': 'string',
            'AutoScalingConfigurationRevision': 123,
            'Status': 'ACTIVE'|'INACTIVE',
            'CreatedAt': datetime(2015, 1, 1),
            'HasAssociatedService': True|False,
            'IsDefault': True|False
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • 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.

      • (dict) –

        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.

        • Status (string) –

          The current state of the auto scaling configuration. If the status of a configuration revision is INACTIVE, it was deleted and can’t be used. Inactive configuration revisions are permanently removed some time after they are deleted.

        • CreatedAt (datetime) –

          The time when the auto scaling configuration was created. It’s in Unix time stamp format.

        • HasAssociatedService (boolean) –

          Indicates if this auto scaling configuration has an App Runner service associated with it. A value of true indicates one or more services are associated. A value of false indicates no services are associated.

        • IsDefault (boolean) –

          Indicates if this auto scaling configuration should be used as the default for a new App Runner service that does not have an auto scaling configuration ARN specified during creation. Each account can have only one default AutoScalingConfiguration per region. The default AutoScalingConfiguration can be any revision under 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.

Exceptions