AutoScaling / Client / describe_account_settings

describe_account_settings

AutoScaling.Client.describe_account_settings(**kwargs)

Describes the current Amazon EC2 Auto Scaling account settings for your account. Account settings are a framework that allows you to enable or disable features for your account. The framework also gives you visibility into features that will be enforced by a given date, providing a time window to prepare for backwards-incompatible changes.

See also: AWS API Documentation

Request Syntax

response = client.describe_account_settings(
    Name='string',
    NextToken='string',
    MaxRecords=123
)
Parameters:

  • Name (string) – The name of the account setting to describe. If you omit this parameter, all account settings are described.

  • NextToken (string) – The token for the next set of items to return. (You received this token from a previous call.)

  • MaxRecords (integer) – The maximum number of items to return with this call. The default value is 50 and the maximum value is 100.

Return type:

dict

Returns:

Response Syntax

{
    'Settings': [
        {
            'Name': 'string',
            'Value': 'string',
            'EnforcementType': 'string',
            'EnforcementDate': datetime(2015, 1, 1),
            'DefaultValue': 'string',
            'EnforcedValue': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • Settings (list) –

      Information about the account settings.

      • (dict) –

        Describes an account setting for Amazon EC2 Auto Scaling. Account settings control how certain features behave for your account. Some settings can be enforced after a specified date, meaning that after the enforcement date, you can no longer modify the setting.

        • Name (string) –

          The name of the account setting. Each account setting has a unique name that identifies the specific feature it controls.

        • Value (string) –

          The current value of the account setting.

        • EnforcementType (string) –

          The type of enforcement for the account setting. Valid values include: hard (the setting has a hard enforcement date after which the setting will be enforced and cannot be modified), flexible (the setting has a flexible enforcement where you can always modify the setting value), and none (the setting has no enforcement and can always be modified).

        • EnforcementDate (datetime) –

          The date when the account setting will be enforced. After this date, for settings with hard enforcement type, you can no longer modify the setting value. This parameter is only returned for settings with hard or flexible enforcement types.

        • DefaultValue (string) –

          The default value of the account setting before the enforcement date. Valid values are enabled and disabled. This parameter is only returned for settings with hard or flexible enforcement types.

        • EnforcedValue (string) –

          The value that will be enforced after the enforcement date. Valid values are enabled and disabled. This parameter is only returned for settings with hard or flexible enforcement types.

    • NextToken (string) –

      A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return.

Exceptions