SSM / Client / reset_service_setting

reset_service_setting

SSM.Client.reset_service_setting(**kwargs)

ServiceSetting is an account-level setting for an Amazon Web Services service. This setting defines how a user interacts with or uses a service or a feature of a service. For example, if an Amazon Web Services service charges money to the account based on feature or service usage, then the Amazon Web Services service team might create a default setting of “false”. This means the user can’t use this feature unless they change the setting to “true” and intentionally opt in for a paid feature.

Services map a SettingId object to a setting value. Amazon Web Services services teams define the default value for a SettingId. You can’t create a new SettingId, but you can overwrite the default value if you have the ssm:UpdateServiceSetting permission for the setting. Use the GetServiceSetting API operation to view the current value. Use the UpdateServiceSetting API operation to change the default setting.

Reset the service setting for the account to the default value as provisioned by the Amazon Web Services service team.

See also: AWS API Documentation

Request Syntax

response = client.reset_service_setting(
    SettingId='string'
)
Parameters:

SettingId (string) –

[REQUIRED]

The Amazon Resource Name (ARN) of the service setting to reset. The setting ID can be one of the following.

  • /ssm/appmanager/appmanager-enabled

  • /ssm/automation/customer-script-log-destination

  • /ssm/automation/customer-script-log-group-name

  • /ssm/automation/enable-adaptive-concurrency

  • /ssm/documents/console/public-sharing-permission

  • /ssm/managed-instance/activation-tier

  • /ssm/managed-instance/default-ec2-instance-management-role

  • /ssm/opsinsights/opscenter

  • /ssm/parameter-store/default-parameter-tier

  • /ssm/parameter-store/high-throughput-enabled

Return type:

dict

Returns:

Response Syntax

{
    'ServiceSetting': {
        'SettingId': 'string',
        'SettingValue': 'string',
        'LastModifiedDate': datetime(2015, 1, 1),
        'LastModifiedUser': 'string',
        'ARN': 'string',
        'Status': 'string'
    }
}

Response Structure

  • (dict) –

    The result body of the ResetServiceSetting API operation.

    • ServiceSetting (dict) –

      The current, effective service setting after calling the ResetServiceSetting API operation.

      • SettingId (string) –

        The ID of the service setting.

      • SettingValue (string) –

        The value of the service setting.

      • LastModifiedDate (datetime) –

        The last time the service setting was modified.

      • LastModifiedUser (string) –

        The ARN of the last modified user. This field is populated only if the setting value was overwritten.

      • ARN (string) –

        The ARN of the service setting.

      • Status (string) –

        The status of the service setting. The value can be Default, Customized or PendingUpdate.

        • Default: The current setting uses a default value provisioned by the Amazon Web Services service team.

        • Customized: The current setting use a custom value specified by the customer.

        • PendingUpdate: The current setting uses a default or custom value, but a setting change request is pending approval.

Exceptions