GetServiceSettingCommand

Suggest an Edit

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

Query the current service setting for the Amazon Web Services account.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { SSMClient, GetServiceSettingCommand } from "@aws-sdk/client-ssm"; // ES Modules import
// const { SSMClient, GetServiceSettingCommand } = require("@aws-sdk/client-ssm"); // CommonJS import
const client = new SSMClient(config);
const input = { // GetServiceSettingRequest
  SettingId: "STRING_VALUE", // required
};
const command = new GetServiceSettingCommand(input);
const response = await client.send(command);
// { // GetServiceSettingResult
//   ServiceSetting: { // ServiceSetting
//     SettingId: "STRING_VALUE",
//     SettingValue: "STRING_VALUE",
//     LastModifiedDate: new Date("TIMESTAMP"),
//     LastModifiedUser: "STRING_VALUE",
//     ARN: "STRING_VALUE",
//     Status: "STRING_VALUE",
//   },
// };

GetServiceSettingCommand Input

See GetServiceSettingCommandInput for more details

Parameter
Type
Description
SettingId
Required
string | undefined

The ID of the service setting to get. 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

GetServiceSettingCommand Output

See GetServiceSettingCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
ServiceSetting
ServiceSetting | undefined

The query result of the current service setting.

Throws

Name
Fault
Details
InternalServerError
server

An error occurred on the server side.

ServiceSettingNotFound
client

The specified service setting wasn't found. Either the service name or the setting hasn't been provisioned by the Amazon Web Services service team.

SSMServiceException
Base exception class for all service exceptions from SSM service.