libZSservicesZSamazonka-ssmZSamazonka-ssm
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.SSM.UpdateServiceSetting

Description

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.

Synopsis

Creating a Request

data UpdateServiceSetting Source #

The request body of the UpdateServiceSetting API operation.

See: newUpdateServiceSetting smart constructor.

Constructors

UpdateServiceSetting' 

Fields

  • settingId :: Text

    The Amazon Resource Name (ARN) of the service setting to reset. 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/automation/customer-script-log-destination
    • /ssm/automation/customer-script-log-group-name
    • /ssm/documents/console/public-sharing-permission
    • /ssm/parameter-store/default-parameter-tier
    • /ssm/parameter-store/high-throughput-enabled
    • /ssm/managed-instance/activation-tier
  • settingValue :: Text

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

    • /ssm/parameter-store/default-parameter-tier: Standard, Advanced, Intelligent-Tiering
    • /ssm/parameter-store/high-throughput-enabled: true or false
    • /ssm/managed-instance/activation-tier: true or false
    • /ssm/automation/customer-script-log-destination: CloudWatch
    • /ssm/automation/customer-script-log-group-name: the name of an Amazon CloudWatch Logs log group
    • /ssm/documents/console/public-sharing-permission: Enable or Disable
    • /ssm/managed-instance/activation-tier: standard or advanced

Instances

Instances details
Eq UpdateServiceSetting Source # 
Instance details

Defined in Amazonka.SSM.UpdateServiceSetting

Methods

(==) :: UpdateServiceSetting -> UpdateServiceSetting -> Bool #

(/=) :: UpdateServiceSetting -> UpdateServiceSetting -> Bool #

Read UpdateServiceSetting Source # 
Instance details

Defined in Amazonka.SSM.UpdateServiceSetting

Methods

readsPrec :: Int -> ReadS UpdateServiceSetting #

readList :: ReadS [UpdateServiceSetting] #

readPrec :: ReadPrec UpdateServiceSetting #

readListPrec :: ReadPrec [UpdateServiceSetting] #

Show UpdateServiceSetting Source # 
Instance details

Defined in Amazonka.SSM.UpdateServiceSetting

Methods

showsPrec :: Int -> UpdateServiceSetting -> ShowS #

show :: UpdateServiceSetting -> String #

showList :: [UpdateServiceSetting] -> ShowS #

Generic UpdateServiceSetting Source # 
Instance details

Defined in Amazonka.SSM.UpdateServiceSetting

Associated Types

type Rep UpdateServiceSetting :: Type -> Type #

Methods

from :: UpdateServiceSetting -> Rep UpdateServiceSetting x #

to :: Rep UpdateServiceSetting x -> UpdateServiceSetting #

NFData UpdateServiceSetting Source # 
Instance details

Defined in Amazonka.SSM.UpdateServiceSetting

Methods

rnf :: UpdateServiceSetting -> () #

Hashable UpdateServiceSetting Source # 
Instance details

Defined in Amazonka.SSM.UpdateServiceSetting

Methods

hashWithSalt :: Int -> UpdateServiceSetting -> Int #

hash :: UpdateServiceSetting -> Int #

ToJSON UpdateServiceSetting Source # 
Instance details

Defined in Amazonka.SSM.UpdateServiceSetting

Methods

toJSON :: UpdateServiceSetting -> Value #

toEncoding :: UpdateServiceSetting -> Encoding #

toJSONList :: [UpdateServiceSetting] -> Value #

toEncodingList :: [UpdateServiceSetting] -> Encoding #

AWSRequest UpdateServiceSetting Source # 
Instance details

Defined in Amazonka.SSM.UpdateServiceSetting

Associated Types

type AWSResponse UpdateServiceSetting #

Methods

request :: UpdateServiceSetting -> Request UpdateServiceSetting #

response :: MonadResource m => Logger -> Service -> Proxy UpdateServiceSetting -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateServiceSetting))) #

ToHeaders UpdateServiceSetting Source # 
Instance details

Defined in Amazonka.SSM.UpdateServiceSetting

Methods

toHeaders :: UpdateServiceSetting -> [Header] #

ToPath UpdateServiceSetting Source # 
Instance details

Defined in Amazonka.SSM.UpdateServiceSetting

Methods

toPath :: UpdateServiceSetting -> ByteString #

ToQuery UpdateServiceSetting Source # 
Instance details

Defined in Amazonka.SSM.UpdateServiceSetting

Methods

toQuery :: UpdateServiceSetting -> QueryString #

type Rep UpdateServiceSetting Source # 
Instance details

Defined in Amazonka.SSM.UpdateServiceSetting

type Rep UpdateServiceSetting = D1 ('MetaData "UpdateServiceSetting" "Amazonka.SSM.UpdateServiceSetting" "libZSservicesZSamazonka-ssmZSamazonka-ssm" 'False) (C1 ('MetaCons "UpdateServiceSetting'" 'PrefixI 'True) (S1 ('MetaSel ('Just "settingId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "settingValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse UpdateServiceSetting Source # 
Instance details

Defined in Amazonka.SSM.UpdateServiceSetting

type AWSResponse UpdateServiceSetting = UpdateServiceSettingResponse

newUpdateServiceSetting Source #

Arguments

:: Text

$sel:settingId:UpdateServiceSetting'

-> Text

$sel:settingValue:UpdateServiceSetting'

-> UpdateServiceSetting 

Create a value of UpdateServiceSetting with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:settingId:UpdateServiceSetting', updateServiceSetting_settingId - The Amazon Resource Name (ARN) of the service setting to reset. 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/automation/customer-script-log-destination
  • /ssm/automation/customer-script-log-group-name
  • /ssm/documents/console/public-sharing-permission
  • /ssm/parameter-store/default-parameter-tier
  • /ssm/parameter-store/high-throughput-enabled
  • /ssm/managed-instance/activation-tier

$sel:settingValue:UpdateServiceSetting', updateServiceSetting_settingValue - The new value to specify for the service setting. The following list specifies the available values for each setting.

  • /ssm/parameter-store/default-parameter-tier: Standard, Advanced, Intelligent-Tiering
  • /ssm/parameter-store/high-throughput-enabled: true or false
  • /ssm/managed-instance/activation-tier: true or false
  • /ssm/automation/customer-script-log-destination: CloudWatch
  • /ssm/automation/customer-script-log-group-name: the name of an Amazon CloudWatch Logs log group
  • /ssm/documents/console/public-sharing-permission: Enable or Disable
  • /ssm/managed-instance/activation-tier: standard or advanced

Request Lenses

updateServiceSetting_settingId :: Lens' UpdateServiceSetting Text Source #

The Amazon Resource Name (ARN) of the service setting to reset. 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/automation/customer-script-log-destination
  • /ssm/automation/customer-script-log-group-name
  • /ssm/documents/console/public-sharing-permission
  • /ssm/parameter-store/default-parameter-tier
  • /ssm/parameter-store/high-throughput-enabled
  • /ssm/managed-instance/activation-tier

updateServiceSetting_settingValue :: Lens' UpdateServiceSetting Text Source #

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

  • /ssm/parameter-store/default-parameter-tier: Standard, Advanced, Intelligent-Tiering
  • /ssm/parameter-store/high-throughput-enabled: true or false
  • /ssm/managed-instance/activation-tier: true or false
  • /ssm/automation/customer-script-log-destination: CloudWatch
  • /ssm/automation/customer-script-log-group-name: the name of an Amazon CloudWatch Logs log group
  • /ssm/documents/console/public-sharing-permission: Enable or Disable
  • /ssm/managed-instance/activation-tier: standard or advanced

Destructuring the Response

data UpdateServiceSettingResponse Source #

The result body of the UpdateServiceSetting API operation.

See: newUpdateServiceSettingResponse smart constructor.

Constructors

UpdateServiceSettingResponse' 

Fields

Instances

Instances details
Eq UpdateServiceSettingResponse Source # 
Instance details

Defined in Amazonka.SSM.UpdateServiceSetting

Methods

(==) :: UpdateServiceSettingResponse -> UpdateServiceSettingResponse -> Bool #

(/=) :: UpdateServiceSettingResponse -> UpdateServiceSettingResponse -> Bool #

Read UpdateServiceSettingResponse Source # 
Instance details

Defined in Amazonka.SSM.UpdateServiceSetting

Methods

readsPrec :: Int -> ReadS UpdateServiceSettingResponse #

readList :: ReadS [UpdateServiceSettingResponse] #

readPrec :: ReadPrec UpdateServiceSettingResponse #

readListPrec :: ReadPrec [UpdateServiceSettingResponse] #

Show UpdateServiceSettingResponse Source # 
Instance details

Defined in Amazonka.SSM.UpdateServiceSetting

Methods

showsPrec :: Int -> UpdateServiceSettingResponse -> ShowS #

show :: UpdateServiceSettingResponse -> String #

showList :: [UpdateServiceSettingResponse] -> ShowS #

Generic UpdateServiceSettingResponse Source # 
Instance details

Defined in Amazonka.SSM.UpdateServiceSetting

Associated Types

type Rep UpdateServiceSettingResponse :: Type -> Type #

Methods

from :: UpdateServiceSettingResponse -> Rep UpdateServiceSettingResponse x #

to :: Rep UpdateServiceSettingResponse x -> UpdateServiceSettingResponse #

NFData UpdateServiceSettingResponse Source # 
Instance details

Defined in Amazonka.SSM.UpdateServiceSetting

Methods

rnf :: UpdateServiceSettingResponse -> () #

type Rep UpdateServiceSettingResponse Source # 
Instance details

Defined in Amazonka.SSM.UpdateServiceSetting

type Rep UpdateServiceSettingResponse = D1 ('MetaData "UpdateServiceSettingResponse" "Amazonka.SSM.UpdateServiceSetting" "libZSservicesZSamazonka-ssmZSamazonka-ssm" 'False) (C1 ('MetaCons "UpdateServiceSettingResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newUpdateServiceSettingResponse Source #

Arguments

:: Int

$sel:httpStatus:UpdateServiceSettingResponse'

-> UpdateServiceSettingResponse 

Create a value of UpdateServiceSettingResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:UpdateServiceSettingResponse', updateServiceSettingResponse_httpStatus - The response's http status code.

Response Lenses

updateServiceSettingResponse_httpStatus :: Lens' UpdateServiceSettingResponse Int Source #

The response's http status code.