Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Kendra.Types.ServiceNowConfiguration

Description

Synopsis

Documentation

data ServiceNowConfiguration Source #

Provides the configuration information to connect to ServiceNow as your data source.

See: newServiceNowConfiguration smart constructor.

Constructors

ServiceNowConfiguration'

Fields

authenticationType :: Maybe ServiceNowAuthenticationType
The type of authentication used to connect to the ServiceNow instance. If you choose HTTP_BASIC, Amazon Kendra is authenticated using the user name and password provided in the Secrets Manager secret in the SecretArn field. If you choose OAUTH2, Amazon Kendra is authenticated using the credentials of client ID, client secret, user name and password.
When you use OAUTH2 authentication, you must generate a token and a client secret using the ServiceNow console. For more information, see Using a ServiceNow data source.
knowledgeArticleConfiguration :: Maybe ServiceNowKnowledgeArticleConfiguration
Configuration information for crawling knowledge articles in the ServiceNow site.
serviceCatalogConfiguration :: Maybe ServiceNowServiceCatalogConfiguration
Configuration information for crawling service catalogs in the ServiceNow site.
hostUrl :: Text
The ServiceNow instance that the data source connects to. The host endpoint should look like the following: {instance}.service-now.com.
secretArn :: Text
The Amazon Resource Name (ARN) of the Secrets Manager secret that contains the user name and password required to connect to the ServiceNow instance. You can also provide OAuth authentication credentials of user name, password, client ID, and client secret. For more information, see Using a ServiceNow data source.
serviceNowBuildVersion :: ServiceNowBuildVersionType
The identifier of the release that the ServiceNow host is running. If the host is not running the LONDON release, use OTHERS.

Instances

Instances details

FromJSON ServiceNowConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ServiceNowConfiguration Methods parseJSON :: Value -> Parser ServiceNowConfiguration # parseJSONList :: Value -> Parser [ServiceNowConfiguration] #
ToJSON ServiceNowConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ServiceNowConfiguration Methods toJSON :: ServiceNowConfiguration -> Value # toEncoding :: ServiceNowConfiguration -> Encoding # toJSONList :: [ServiceNowConfiguration] -> Value # toEncodingList :: [ServiceNowConfiguration] -> Encoding #
Generic ServiceNowConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ServiceNowConfiguration Associated Types type Rep ServiceNowConfiguration :: Type -> Type # Methods from :: ServiceNowConfiguration -> Rep ServiceNowConfiguration x # to :: Rep ServiceNowConfiguration x -> ServiceNowConfiguration #
Read ServiceNowConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ServiceNowConfiguration Methods readsPrec :: Int -> ReadS ServiceNowConfiguration # readList :: ReadS [ServiceNowConfiguration] # readPrec :: ReadPrec ServiceNowConfiguration # readListPrec :: ReadPrec [ServiceNowConfiguration] #
Show ServiceNowConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ServiceNowConfiguration Methods showsPrec :: Int -> ServiceNowConfiguration -> ShowS # show :: ServiceNowConfiguration -> String # showList :: [ServiceNowConfiguration] -> ShowS #
NFData ServiceNowConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ServiceNowConfiguration Methods rnf :: ServiceNowConfiguration -> () #
Eq ServiceNowConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ServiceNowConfiguration Methods (==) :: ServiceNowConfiguration -> ServiceNowConfiguration -> Bool # (/=) :: ServiceNowConfiguration -> ServiceNowConfiguration -> Bool #
Hashable ServiceNowConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ServiceNowConfiguration Methods hashWithSalt :: Int -> ServiceNowConfiguration -> Int # hash :: ServiceNowConfiguration -> Int #
type Rep ServiceNowConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ServiceNowConfiguration type Rep ServiceNowConfiguration = D1 ('MetaData "ServiceNowConfiguration" "Amazonka.Kendra.Types.ServiceNowConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "ServiceNowConfiguration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "authenticationType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ServiceNowAuthenticationType)) :: (S1 ('MetaSel ('Just "knowledgeArticleConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ServiceNowKnowledgeArticleConfiguration)) :: S1 ('MetaSel ('Just "serviceCatalogConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ServiceNowServiceCatalogConfiguration)))) :: (S1 ('MetaSel ('Just "hostUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "secretArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "serviceNowBuildVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ServiceNowBuildVersionType)))))

newServiceNowConfiguration Source #

Arguments

:: Text	`$sel:hostUrl:ServiceNowConfiguration'`
-> Text	`$sel:secretArn:ServiceNowConfiguration'`
-> ServiceNowBuildVersionType	`$sel:serviceNowBuildVersion:ServiceNowConfiguration'`
-> ServiceNowConfiguration

Create a value of ServiceNowConfiguration 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:authenticationType:ServiceNowConfiguration', serviceNowConfiguration_authenticationType - The type of authentication used to connect to the ServiceNow instance. If you choose HTTP_BASIC, Amazon Kendra is authenticated using the user name and password provided in the Secrets Manager secret in the SecretArn field. If you choose OAUTH2, Amazon Kendra is authenticated using the credentials of client ID, client secret, user name and password.

When you use OAUTH2 authentication, you must generate a token and a client secret using the ServiceNow console. For more information, see Using a ServiceNow data source.

$sel:knowledgeArticleConfiguration:ServiceNowConfiguration', serviceNowConfiguration_knowledgeArticleConfiguration - Configuration information for crawling knowledge articles in the ServiceNow site.

$sel:serviceCatalogConfiguration:ServiceNowConfiguration', serviceNowConfiguration_serviceCatalogConfiguration - Configuration information for crawling service catalogs in the ServiceNow site.

$sel:hostUrl:ServiceNowConfiguration', serviceNowConfiguration_hostUrl - The ServiceNow instance that the data source connects to. The host endpoint should look like the following: {instance}.service-now.com.

$sel:secretArn:ServiceNowConfiguration', serviceNowConfiguration_secretArn - The Amazon Resource Name (ARN) of the Secrets Manager secret that contains the user name and password required to connect to the ServiceNow instance. You can also provide OAuth authentication credentials of user name, password, client ID, and client secret. For more information, see Using a ServiceNow data source.

$sel:serviceNowBuildVersion:ServiceNowConfiguration', serviceNowConfiguration_serviceNowBuildVersion - The identifier of the release that the ServiceNow host is running. If the host is not running the LONDON release, use OTHERS.

serviceNowConfiguration_authenticationType :: Lens' ServiceNowConfiguration (Maybe ServiceNowAuthenticationType) Source #

The type of authentication used to connect to the ServiceNow instance. If you choose HTTP_BASIC, Amazon Kendra is authenticated using the user name and password provided in the Secrets Manager secret in the SecretArn field. If you choose OAUTH2, Amazon Kendra is authenticated using the credentials of client ID, client secret, user name and password.

When you use OAUTH2 authentication, you must generate a token and a client secret using the ServiceNow console. For more information, see Using a ServiceNow data source.

serviceNowConfiguration_knowledgeArticleConfiguration :: Lens' ServiceNowConfiguration (Maybe ServiceNowKnowledgeArticleConfiguration) Source #

Configuration information for crawling knowledge articles in the ServiceNow site.

serviceNowConfiguration_serviceCatalogConfiguration :: Lens' ServiceNowConfiguration (Maybe ServiceNowServiceCatalogConfiguration) Source #

Configuration information for crawling service catalogs in the ServiceNow site.

serviceNowConfiguration_hostUrl :: Lens' ServiceNowConfiguration Text Source #

The ServiceNow instance that the data source connects to. The host endpoint should look like the following: {instance}.service-now.com.

serviceNowConfiguration_secretArn :: Lens' ServiceNowConfiguration Text Source #

The Amazon Resource Name (ARN) of the Secrets Manager secret that contains the user name and password required to connect to the ServiceNow instance. You can also provide OAuth authentication credentials of user name, password, client ID, and client secret. For more information, see Using a ServiceNow data source.

serviceNowConfiguration_serviceNowBuildVersion :: Lens' ServiceNowConfiguration ServiceNowBuildVersionType Source #

The identifier of the release that the ServiceNow host is running. If the host is not running the LONDON release, use OTHERS.