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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Onboard the specific Amazon Connect instance to Connect Campaigns.

Synopsis

Creating a Request

data StartInstanceOnboardingJob Source #

The request for StartInstanceOnboardingJob API.

See: newStartInstanceOnboardingJob smart constructor.

Constructors

StartInstanceOnboardingJob'
Fields connectInstanceId :: Text encryptionConfig :: EncryptionConfig

Instances

Instances details

ToJSON StartInstanceOnboardingJob Source #
Instance details Defined in Amazonka.ConnectCampaigns.StartInstanceOnboardingJob Methods toJSON :: StartInstanceOnboardingJob -> Value # toEncoding :: StartInstanceOnboardingJob -> Encoding # toJSONList :: [StartInstanceOnboardingJob] -> Value # toEncodingList :: [StartInstanceOnboardingJob] -> Encoding #
ToHeaders StartInstanceOnboardingJob Source #
Instance details Defined in Amazonka.ConnectCampaigns.StartInstanceOnboardingJob Methods toHeaders :: StartInstanceOnboardingJob -> [Header] #
ToPath StartInstanceOnboardingJob Source #
Instance details Defined in Amazonka.ConnectCampaigns.StartInstanceOnboardingJob Methods toPath :: StartInstanceOnboardingJob -> ByteString #
ToQuery StartInstanceOnboardingJob Source #
Instance details Defined in Amazonka.ConnectCampaigns.StartInstanceOnboardingJob Methods toQuery :: StartInstanceOnboardingJob -> QueryString #
AWSRequest StartInstanceOnboardingJob Source #
Instance details Defined in Amazonka.ConnectCampaigns.StartInstanceOnboardingJob Associated Types type AWSResponse StartInstanceOnboardingJob # Methods request :: (Service -> Service) -> StartInstanceOnboardingJob -> Request StartInstanceOnboardingJob # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy StartInstanceOnboardingJob -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse StartInstanceOnboardingJob))) #
Generic StartInstanceOnboardingJob Source #
Instance details Defined in Amazonka.ConnectCampaigns.StartInstanceOnboardingJob Associated Types type Rep StartInstanceOnboardingJob :: Type -> Type # Methods from :: StartInstanceOnboardingJob -> Rep StartInstanceOnboardingJob x # to :: Rep StartInstanceOnboardingJob x -> StartInstanceOnboardingJob #
Read StartInstanceOnboardingJob Source #
Instance details Defined in Amazonka.ConnectCampaigns.StartInstanceOnboardingJob Methods readsPrec :: Int -> ReadS StartInstanceOnboardingJob # readList :: ReadS [StartInstanceOnboardingJob] # readPrec :: ReadPrec StartInstanceOnboardingJob # readListPrec :: ReadPrec [StartInstanceOnboardingJob] #
Show StartInstanceOnboardingJob Source #
Instance details Defined in Amazonka.ConnectCampaigns.StartInstanceOnboardingJob Methods showsPrec :: Int -> StartInstanceOnboardingJob -> ShowS # show :: StartInstanceOnboardingJob -> String # showList :: [StartInstanceOnboardingJob] -> ShowS #
NFData StartInstanceOnboardingJob Source #
Instance details Defined in Amazonka.ConnectCampaigns.StartInstanceOnboardingJob Methods rnf :: StartInstanceOnboardingJob -> () #
Eq StartInstanceOnboardingJob Source #
Instance details Defined in Amazonka.ConnectCampaigns.StartInstanceOnboardingJob Methods (==) :: StartInstanceOnboardingJob -> StartInstanceOnboardingJob -> Bool # (/=) :: StartInstanceOnboardingJob -> StartInstanceOnboardingJob -> Bool #
Hashable StartInstanceOnboardingJob Source #
Instance details Defined in Amazonka.ConnectCampaigns.StartInstanceOnboardingJob Methods hashWithSalt :: Int -> StartInstanceOnboardingJob -> Int # hash :: StartInstanceOnboardingJob -> Int #
type AWSResponse StartInstanceOnboardingJob Source #
Instance details Defined in Amazonka.ConnectCampaigns.StartInstanceOnboardingJob type AWSResponse StartInstanceOnboardingJob = StartInstanceOnboardingJobResponse
type Rep StartInstanceOnboardingJob Source #
Instance details Defined in Amazonka.ConnectCampaigns.StartInstanceOnboardingJob type Rep StartInstanceOnboardingJob = D1 ('MetaData "StartInstanceOnboardingJob" "Amazonka.ConnectCampaigns.StartInstanceOnboardingJob" "amazonka-connectcampaigns-2.0-LuqNK744MOoGiJJNiISqNX" 'False) (C1 ('MetaCons "StartInstanceOnboardingJob'" 'PrefixI 'True) (S1 ('MetaSel ('Just "connectInstanceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "encryptionConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 EncryptionConfig)))

newStartInstanceOnboardingJob Source #

Arguments

:: Text	`StartInstanceOnboardingJob`
-> EncryptionConfig	`StartInstanceOnboardingJob`
-> StartInstanceOnboardingJob

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

StartInstanceOnboardingJob, startInstanceOnboardingJob_connectInstanceId - Undocumented member.

StartInstanceOnboardingJob, startInstanceOnboardingJob_encryptionConfig - Undocumented member.

Request Lenses

startInstanceOnboardingJob_connectInstanceId :: Lens' StartInstanceOnboardingJob Text Source #

Undocumented member.

startInstanceOnboardingJob_encryptionConfig :: Lens' StartInstanceOnboardingJob EncryptionConfig Source #

Undocumented member.

Destructuring the Response

data StartInstanceOnboardingJobResponse Source #

The response for StartInstanceOnboardingJob API.

See: newStartInstanceOnboardingJobResponse smart constructor.

Constructors

StartInstanceOnboardingJobResponse'
Fields connectInstanceOnboardingJobStatus :: Maybe InstanceOnboardingJobStatus httpStatus :: Int The response's http status code.

Instances

Instances details

Generic StartInstanceOnboardingJobResponse Source #
Instance details Defined in Amazonka.ConnectCampaigns.StartInstanceOnboardingJob Associated Types type Rep StartInstanceOnboardingJobResponse :: Type -> Type # Methods from :: StartInstanceOnboardingJobResponse -> Rep StartInstanceOnboardingJobResponse x # to :: Rep StartInstanceOnboardingJobResponse x -> StartInstanceOnboardingJobResponse #
Read StartInstanceOnboardingJobResponse Source #
Instance details Defined in Amazonka.ConnectCampaigns.StartInstanceOnboardingJob Methods readsPrec :: Int -> ReadS StartInstanceOnboardingJobResponse # readList :: ReadS [StartInstanceOnboardingJobResponse] # readPrec :: ReadPrec StartInstanceOnboardingJobResponse # readListPrec :: ReadPrec [StartInstanceOnboardingJobResponse] #
Show StartInstanceOnboardingJobResponse Source #
Instance details Defined in Amazonka.ConnectCampaigns.StartInstanceOnboardingJob Methods showsPrec :: Int -> StartInstanceOnboardingJobResponse -> ShowS # show :: StartInstanceOnboardingJobResponse -> String # showList :: [StartInstanceOnboardingJobResponse] -> ShowS #
NFData StartInstanceOnboardingJobResponse Source #
Instance details Defined in Amazonka.ConnectCampaigns.StartInstanceOnboardingJob Methods rnf :: StartInstanceOnboardingJobResponse -> () #
Eq StartInstanceOnboardingJobResponse Source #
Instance details Defined in Amazonka.ConnectCampaigns.StartInstanceOnboardingJob Methods (==) :: StartInstanceOnboardingJobResponse -> StartInstanceOnboardingJobResponse -> Bool # (/=) :: StartInstanceOnboardingJobResponse -> StartInstanceOnboardingJobResponse -> Bool #
type Rep StartInstanceOnboardingJobResponse Source #
Instance details Defined in Amazonka.ConnectCampaigns.StartInstanceOnboardingJob type Rep StartInstanceOnboardingJobResponse = D1 ('MetaData "StartInstanceOnboardingJobResponse" "Amazonka.ConnectCampaigns.StartInstanceOnboardingJob" "amazonka-connectcampaigns-2.0-LuqNK744MOoGiJJNiISqNX" 'False) (C1 ('MetaCons "StartInstanceOnboardingJobResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "connectInstanceOnboardingJobStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InstanceOnboardingJobStatus)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newStartInstanceOnboardingJobResponse Source #

Arguments

:: Int	`$sel:httpStatus:StartInstanceOnboardingJobResponse'`
-> StartInstanceOnboardingJobResponse

Create a value of StartInstanceOnboardingJobResponse 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:connectInstanceOnboardingJobStatus:StartInstanceOnboardingJobResponse', startInstanceOnboardingJobResponse_connectInstanceOnboardingJobStatus - Undocumented member.

$sel:httpStatus:StartInstanceOnboardingJobResponse', startInstanceOnboardingJobResponse_httpStatus - The response's http status code.

Response Lenses

startInstanceOnboardingJobResponse_connectInstanceOnboardingJobStatus :: Lens' StartInstanceOnboardingJobResponse (Maybe InstanceOnboardingJobStatus) Source #

Undocumented member.

startInstanceOnboardingJobResponse_httpStatus :: Lens' StartInstanceOnboardingJobResponse Int Source #

The response's http status code.