AppRunner / Client / describe_auto_scaling_configuration

describe_auto_scaling_configuration#

AppRunner.Client.describe_auto_scaling_configuration(**kwargs)#

Return a full description of an App Runner automatic scaling configuration resource.

See also: AWS API Documentation

Request Syntax

response = client.describe_auto_scaling_configuration(
    AutoScalingConfigurationArn='string'
)
Parameters:

AutoScalingConfigurationArn (string) –

[REQUIRED]

The Amazon Resource Name (ARN) of the App Runner auto scaling configuration that you want a description for.

The ARN can be a full auto scaling configuration ARN, or a partial ARN ending with either .../name or ``…/name/revision ``. If a revision isn’t specified, the latest active revision is described.

Return type:

dict

Returns:

Response Syntax

{
    'AutoScalingConfiguration': {
        'AutoScalingConfigurationArn': 'string',
        'AutoScalingConfigurationName': 'string',
        'AutoScalingConfigurationRevision': 123,
        'Latest': True|False,
        'Status': 'ACTIVE'|'INACTIVE',
        'MaxConcurrency': 123,
        'MinSize': 123,
        'MaxSize': 123,
        'CreatedAt': datetime(2015, 1, 1),
        'DeletedAt': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) –

    • AutoScalingConfiguration (dict) –

      A full description of the App Runner auto scaling configuration that you specified in this request.

      • 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") that share the same AutoScalingConfigurationName.

      • Latest (boolean) –

        It’s set to true for the configuration with the highest Revision among all configurations that share the same AutoScalingConfigurationName. It’s set to false otherwise.

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

      • MaxConcurrency (integer) –

        The maximum number of concurrent requests that an instance processes. If the number of concurrent requests exceeds this limit, App Runner scales the service up.

      • MinSize (integer) –

        The minimum number of instances that App Runner provisions for a service. The service always has at least MinSize provisioned instances. Some of them actively serve traffic. The rest of them (provisioned and inactive instances) are a cost-effective compute capacity reserve and are ready to be quickly activated. You pay for memory usage of all the provisioned instances. You pay for CPU usage of only the active subset.

        App Runner temporarily doubles the number of provisioned instances during deployments, to maintain the same capacity for both old and new code.

      • MaxSize (integer) –

        The maximum number of instances that a service scales up to. At most MaxSize instances actively serve traffic for your service.

      • CreatedAt (datetime) –

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

      • DeletedAt (datetime) –

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

Exceptions

  • AppRunner.Client.exceptions.InvalidRequestException

  • AppRunner.Client.exceptions.InternalServiceErrorException

  • AppRunner.Client.exceptions.ResourceNotFoundException