Skip to content

/AWS1/IF_SSM=>UPDATESERVICESETTING()

About UpdateServiceSetting

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. Or, use the ResetServiceSetting to change the value back to the original value defined by the Amazon Web Services service team.

Update the service setting for the account.

Method Signature

METHODS /AWS1/IF_SSM~UPDATESERVICESETTING
  IMPORTING
    !IV_SETTINGID TYPE /AWS1/SSMSERVICESETTINGID OPTIONAL
    !IV_SETTINGVALUE TYPE /AWS1/SSMSERVICESETTINGVALUE OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ssmupdsvcsettingrslt
  RAISING
    /AWS1/CX_SSMINTERNALSERVERERR
    /AWS1/CX_SSMSVCSETTINGNOTFOUND
    /AWS1/CX_SSMTOOMANYUPDATES
    /AWS1/CX_SSMCLIENTEXC
    /AWS1/CX_SSMSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_settingid TYPE /AWS1/SSMSERVICESETTINGID /AWS1/SSMSERVICESETTINGID

The Amazon Resource Name (ARN) of the service setting to update. For example, arn:aws:ssm:us-east-1:111122223333:servicesetting/ssm/parameter-store/high-throughput-enabled. 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

Permissions to update the /ssm/managed-instance/default-ec2-instance-management-role setting should only be provided to administrators. Implement least privilege access when allowing individuals to configure or modify the Default Host Management Configuration.

iv_settingvalue TYPE /AWS1/SSMSERVICESETTINGVALUE /AWS1/SSMSERVICESETTINGVALUE

The new value to specify for the service setting. The following list specifies the available values for each setting.

  • For /ssm/appmanager/appmanager-enabled, enter True or False.

  • For /ssm/automation/customer-script-log-destination, enter CloudWatch.

  • For /ssm/automation/customer-script-log-group-name, enter the name of an Amazon CloudWatch Logs log group.

  • For /ssm/documents/console/public-sharing-permission, enter Enable or Disable.

  • For /ssm/managed-instance/activation-tier, enter standard or advanced.

  • For /ssm/managed-instance/default-ec2-instance-management-role, enter the name of an IAM role.

  • For /ssm/opsinsights/opscenter, enter Enabled or Disabled.

  • For /ssm/parameter-store/default-parameter-tier, enter Standard, Advanced, or Intelligent-Tiering

  • For /ssm/parameter-store/high-throughput-enabled, enter true or false.

RETURNING

oo_output TYPE REF TO /aws1/cl_ssmupdsvcsettingrslt /AWS1/CL_SSMUPDSVCSETTINGRSLT

Domain /AWS1/RT_ACCOUNT_ID
Primitive Type NUMC

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->updateservicesetting(
  iv_settingid = |string|
  iv_settingvalue = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
ENDIF.