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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a campaign for the specified Amazon Connect account. This API is idempotent.

Synopsis

data CreateCampaign = CreateCampaign' {
- tags :: Maybe (HashMap Text Text)
- connectInstanceId :: Text
- dialerConfig :: DialerConfig
- name :: Text
- outboundCallConfig :: OutboundCallConfig
}
newCreateCampaign :: Text -> DialerConfig -> Text -> OutboundCallConfig -> CreateCampaign
createCampaign_tags :: Lens' CreateCampaign (Maybe (HashMap Text Text))
createCampaign_connectInstanceId :: Lens' CreateCampaign Text
createCampaign_dialerConfig :: Lens' CreateCampaign DialerConfig
createCampaign_name :: Lens' CreateCampaign Text
createCampaign_outboundCallConfig :: Lens' CreateCampaign OutboundCallConfig
data CreateCampaignResponse = CreateCampaignResponse' {
- arn :: Maybe Text
- id :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- httpStatus :: Int
}
newCreateCampaignResponse :: Int -> CreateCampaignResponse
createCampaignResponse_arn :: Lens' CreateCampaignResponse (Maybe Text)
createCampaignResponse_id :: Lens' CreateCampaignResponse (Maybe Text)
createCampaignResponse_tags :: Lens' CreateCampaignResponse (Maybe (HashMap Text Text))
createCampaignResponse_httpStatus :: Lens' CreateCampaignResponse Int

Creating a Request

data CreateCampaign Source #

The request for Create Campaign API.

See: newCreateCampaign smart constructor.

Constructors

CreateCampaign'
Fields tags :: Maybe (HashMap Text Text) connectInstanceId :: Text dialerConfig :: DialerConfig name :: Text outboundCallConfig :: OutboundCallConfig

Instances

Instances details

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

newCreateCampaign Source #

Arguments

:: Text	`CreateCampaign`
-> DialerConfig	`CreateCampaign`
-> Text	`CreateCampaign`
-> OutboundCallConfig	`CreateCampaign`
-> CreateCampaign

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

CreateCampaign, createCampaign_tags - Undocumented member.

CreateCampaign, createCampaign_connectInstanceId - Undocumented member.

CreateCampaign, createCampaign_dialerConfig - Undocumented member.

CreateCampaign, createCampaign_name - Undocumented member.

CreateCampaign, createCampaign_outboundCallConfig - Undocumented member.

Request Lenses

createCampaign_tags :: Lens' CreateCampaign (Maybe (HashMap Text Text)) Source #

Undocumented member.

createCampaign_connectInstanceId :: Lens' CreateCampaign Text Source #

Undocumented member.

createCampaign_dialerConfig :: Lens' CreateCampaign DialerConfig Source #

Undocumented member.

createCampaign_name :: Lens' CreateCampaign Text Source #

Undocumented member.

createCampaign_outboundCallConfig :: Lens' CreateCampaign OutboundCallConfig Source #

Undocumented member.

Destructuring the Response

data CreateCampaignResponse Source #

The response for Create Campaign API

See: newCreateCampaignResponse smart constructor.

Constructors

CreateCampaignResponse'
Fields arn :: Maybe Text id :: Maybe Text tags :: Maybe (HashMap Text Text) httpStatus :: Int The response's http status code.

Instances

Instances details

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