amazonka-ssm-2.0: Amazon Simple Systems Manager (SSM) SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.SSM.GetServiceSetting

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 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.

Synopsis

Creating a Request

data GetServiceSetting Source #

The request body of the GetServiceSetting API operation.

See: newGetServiceSetting smart constructor.

Constructors

GetServiceSetting' 

Fields

  • settingId :: Text

    The ID of the service setting to get. 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/managed-instance/activation-tier
    • /ssm/opsinsights/opscenter
    • /ssm/parameter-store/default-parameter-tier
    • /ssm/parameter-store/high-throughput-enabled

Instances

Instances details
ToJSON GetServiceSetting Source # 
Instance details

Defined in Amazonka.SSM.GetServiceSetting

Methods

toJSON :: GetServiceSetting -> Value #

toEncoding :: GetServiceSetting -> Encoding #

toJSONList :: [GetServiceSetting] -> Value #

toEncodingList :: [GetServiceSetting] -> Encoding #

ToHeaders GetServiceSetting Source # 
Instance details

Defined in Amazonka.SSM.GetServiceSetting

Methods

toHeaders :: GetServiceSetting -> [Header] #

ToPath GetServiceSetting Source # 
Instance details

Defined in Amazonka.SSM.GetServiceSetting

Methods

toPath :: GetServiceSetting -> ByteString #

ToQuery GetServiceSetting Source # 
Instance details

Defined in Amazonka.SSM.GetServiceSetting

Methods

toQuery :: GetServiceSetting -> QueryString #

AWSRequest GetServiceSetting Source # 
Instance details

Defined in Amazonka.SSM.GetServiceSetting

Associated Types

type AWSResponse GetServiceSetting #

Methods

request :: (Service -> Service) -> GetServiceSetting -> Request GetServiceSetting #

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetServiceSetting -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetServiceSetting))) #

Generic GetServiceSetting Source # 
Instance details

Defined in Amazonka.SSM.GetServiceSetting

Associated Types

type Rep GetServiceSetting :: Type -> Type #

Methods

from :: GetServiceSetting -> Rep GetServiceSetting x #

to :: Rep GetServiceSetting x -> GetServiceSetting #

Read GetServiceSetting Source # 
Instance details

Defined in Amazonka.SSM.GetServiceSetting

Methods

readsPrec :: Int -> ReadS GetServiceSetting #

readList :: ReadS [GetServiceSetting] #

readPrec :: ReadPrec GetServiceSetting #

readListPrec :: ReadPrec [GetServiceSetting] #

Show GetServiceSetting Source # 
Instance details

Defined in Amazonka.SSM.GetServiceSetting

Methods

showsPrec :: Int -> GetServiceSetting -> ShowS #

show :: GetServiceSetting -> String #

showList :: [GetServiceSetting] -> ShowS #

NFData GetServiceSetting Source # 
Instance details

Defined in Amazonka.SSM.GetServiceSetting

Methods

rnf :: GetServiceSetting -> () #

Eq GetServiceSetting Source # 
Instance details

Defined in Amazonka.SSM.GetServiceSetting

Methods

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

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

Hashable GetServiceSetting Source # 
Instance details

Defined in Amazonka.SSM.GetServiceSetting

Methods

hashWithSalt :: Int -> GetServiceSetting -> Int #

hash :: GetServiceSetting -> Int #

type AWSResponse GetServiceSetting Source # 
Instance details

Defined in Amazonka.SSM.GetServiceSetting

type AWSResponse GetServiceSetting = GetServiceSettingResponse
type Rep GetServiceSetting Source # 
Instance details

Defined in Amazonka.SSM.GetServiceSetting

type Rep GetServiceSetting = D1 ('MetaData "GetServiceSetting" "Amazonka.SSM.GetServiceSetting" "amazonka-ssm-2.0-Ak65QSGRhJDC5x7UvsCpi8" 'False) (C1 ('MetaCons "GetServiceSetting'" 'PrefixI 'True) (S1 ('MetaSel ('Just "settingId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newGetServiceSetting Source #

Arguments

:: Text

GetServiceSetting

-> GetServiceSetting 

Create a value of GetServiceSetting 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:

GetServiceSetting, getServiceSetting_settingId - The ID of the service setting to get. 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/managed-instance/activation-tier
  • /ssm/opsinsights/opscenter
  • /ssm/parameter-store/default-parameter-tier
  • /ssm/parameter-store/high-throughput-enabled

Request Lenses

getServiceSetting_settingId :: Lens' GetServiceSetting Text Source #

The ID of the service setting to get. 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/managed-instance/activation-tier
  • /ssm/opsinsights/opscenter
  • /ssm/parameter-store/default-parameter-tier
  • /ssm/parameter-store/high-throughput-enabled

Destructuring the Response

data GetServiceSettingResponse Source #

The query result body of the GetServiceSetting API operation.

See: newGetServiceSettingResponse smart constructor.

Constructors

GetServiceSettingResponse' 

Fields

Instances

Instances details
Generic GetServiceSettingResponse Source # 
Instance details

Defined in Amazonka.SSM.GetServiceSetting

Associated Types

type Rep GetServiceSettingResponse :: Type -> Type #

Methods

from :: GetServiceSettingResponse -> Rep GetServiceSettingResponse x #

to :: Rep GetServiceSettingResponse x -> GetServiceSettingResponse #

Read GetServiceSettingResponse Source # 
Instance details

Defined in Amazonka.SSM.GetServiceSetting

Methods

readsPrec :: Int -> ReadS GetServiceSettingResponse #

readList :: ReadS [GetServiceSettingResponse] #

readPrec :: ReadPrec GetServiceSettingResponse #

readListPrec :: ReadPrec [GetServiceSettingResponse] #

Show GetServiceSettingResponse Source # 
Instance details

Defined in Amazonka.SSM.GetServiceSetting

Methods

showsPrec :: Int -> GetServiceSettingResponse -> ShowS #

show :: GetServiceSettingResponse -> String #

showList :: [GetServiceSettingResponse] -> ShowS #

NFData GetServiceSettingResponse Source # 
Instance details

Defined in Amazonka.SSM.GetServiceSetting

Methods

rnf :: GetServiceSettingResponse -> () #

Eq GetServiceSettingResponse Source # 
Instance details

Defined in Amazonka.SSM.GetServiceSetting

Methods

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

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

type Rep GetServiceSettingResponse Source # 
Instance details

Defined in Amazonka.SSM.GetServiceSetting

type Rep GetServiceSettingResponse = D1 ('MetaData "GetServiceSettingResponse" "Amazonka.SSM.GetServiceSetting" "amazonka-ssm-2.0-Ak65QSGRhJDC5x7UvsCpi8" 'False) (C1 ('MetaCons "GetServiceSettingResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "serviceSetting") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ServiceSetting)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newGetServiceSettingResponse Source #

Arguments

:: Int

$sel:httpStatus:GetServiceSettingResponse'

-> GetServiceSettingResponse 

Create a value of GetServiceSettingResponse 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:serviceSetting:GetServiceSettingResponse', getServiceSettingResponse_serviceSetting - The query result of the current service setting.

$sel:httpStatus:GetServiceSettingResponse', getServiceSettingResponse_httpStatus - The response's http status code.

Response Lenses

getServiceSettingResponse_serviceSetting :: Lens' GetServiceSettingResponse (Maybe ServiceSetting) Source #

The query result of the current service setting.

getServiceSettingResponse_httpStatus :: Lens' GetServiceSettingResponse Int Source #

The response's http status code.