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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a contact with the specified details.

Synopsis

data CreateContact = CreateContact' {
- clientRequestToken :: Maybe Text
- displayName :: Maybe Text
- lastName :: Maybe Text
- phoneNumber :: Maybe (Sensitive Text)
- phoneNumbers :: Maybe [PhoneNumber]
- sipAddresses :: Maybe [SipAddress]
- tags :: Maybe [Tag]
- firstName :: Text
}
newCreateContact :: Text -> CreateContact
createContact_clientRequestToken :: Lens' CreateContact (Maybe Text)
createContact_displayName :: Lens' CreateContact (Maybe Text)
createContact_lastName :: Lens' CreateContact (Maybe Text)
createContact_phoneNumber :: Lens' CreateContact (Maybe Text)
createContact_phoneNumbers :: Lens' CreateContact (Maybe [PhoneNumber])
createContact_sipAddresses :: Lens' CreateContact (Maybe [SipAddress])
createContact_tags :: Lens' CreateContact (Maybe [Tag])
createContact_firstName :: Lens' CreateContact Text
data CreateContactResponse = CreateContactResponse' {
- contactArn :: Maybe Text
- httpStatus :: Int
}
newCreateContactResponse :: Int -> CreateContactResponse
createContactResponse_contactArn :: Lens' CreateContactResponse (Maybe Text)
createContactResponse_httpStatus :: Lens' CreateContactResponse Int

Creating a Request

data CreateContact Source #

See: newCreateContact smart constructor.

Constructors

CreateContact'

Fields

clientRequestToken :: Maybe Text
A unique, user-specified identifier for this request that ensures idempotency.
displayName :: Maybe Text
The name of the contact to display on the console.
lastName :: Maybe Text
The last name of the contact that is used to call the contact on the device.
phoneNumber :: Maybe (Sensitive Text)
The phone number of the contact in E.164 format. The phone number type defaults to WORK. You can specify PhoneNumber or PhoneNumbers. We recommend that you use PhoneNumbers, which lets you specify the phone number type and multiple numbers.
phoneNumbers :: Maybe [PhoneNumber]
The list of phone numbers for the contact.
sipAddresses :: Maybe [SipAddress]
The list of SIP addresses for the contact.
tags :: Maybe [Tag]
The tags to be added to the specified resource. Do not provide system tags.
firstName :: Text
The first name of the contact that is used to call the contact on the device.

Instances

Instances details

ToJSON CreateContact Source #
Instance details Defined in Amazonka.AlexaBusiness.CreateContact Methods toJSON :: CreateContact -> Value # toEncoding :: CreateContact -> Encoding # toJSONList :: [CreateContact] -> Value # toEncodingList :: [CreateContact] -> Encoding #
ToHeaders CreateContact Source #
Instance details Defined in Amazonka.AlexaBusiness.CreateContact Methods toHeaders :: CreateContact -> [Header] #
ToPath CreateContact Source #
Instance details Defined in Amazonka.AlexaBusiness.CreateContact Methods toPath :: CreateContact -> ByteString #
ToQuery CreateContact Source #
Instance details Defined in Amazonka.AlexaBusiness.CreateContact Methods toQuery :: CreateContact -> QueryString #
AWSRequest CreateContact Source #
Instance details Defined in Amazonka.AlexaBusiness.CreateContact Associated Types type AWSResponse CreateContact # Methods request :: (Service -> Service) -> CreateContact -> Request CreateContact # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateContact -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateContact))) #
Generic CreateContact Source #
Instance details Defined in Amazonka.AlexaBusiness.CreateContact Associated Types type Rep CreateContact :: Type -> Type # Methods from :: CreateContact -> Rep CreateContact x # to :: Rep CreateContact x -> CreateContact #
Show CreateContact Source #
Instance details Defined in Amazonka.AlexaBusiness.CreateContact Methods showsPrec :: Int -> CreateContact -> ShowS # show :: CreateContact -> String # showList :: [CreateContact] -> ShowS #
NFData CreateContact Source #
Instance details Defined in Amazonka.AlexaBusiness.CreateContact Methods rnf :: CreateContact -> () #
Eq CreateContact Source #
Instance details Defined in Amazonka.AlexaBusiness.CreateContact Methods (==) :: CreateContact -> CreateContact -> Bool # (/=) :: CreateContact -> CreateContact -> Bool #
Hashable CreateContact Source #
Instance details Defined in Amazonka.AlexaBusiness.CreateContact Methods hashWithSalt :: Int -> CreateContact -> Int # hash :: CreateContact -> Int #
type AWSResponse CreateContact Source #
Instance details Defined in Amazonka.AlexaBusiness.CreateContact type AWSResponse CreateContact = CreateContactResponse
type Rep CreateContact Source #
Instance details Defined in Amazonka.AlexaBusiness.CreateContact type Rep CreateContact = D1 ('MetaData "CreateContact" "Amazonka.AlexaBusiness.CreateContact" "amazonka-alexa-business-2.0-BWvKfxFukoyBarGovAkdOS" 'False) (C1 ('MetaCons "CreateContact'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "clientRequestToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "displayName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "lastName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "phoneNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))))) :: ((S1 ('MetaSel ('Just "phoneNumbers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PhoneNumber])) :: S1 ('MetaSel ('Just "sipAddresses") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SipAddress]))) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :*: S1 ('MetaSel ('Just "firstName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newCreateContact Source #

Arguments

:: Text	`CreateContact`
-> CreateContact

Create a value of CreateContact 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:clientRequestToken:CreateContact', createContact_clientRequestToken - A unique, user-specified identifier for this request that ensures idempotency.

CreateContact, createContact_displayName - The name of the contact to display on the console.

CreateContact, createContact_lastName - The last name of the contact that is used to call the contact on the device.

CreateContact, createContact_phoneNumber - The phone number of the contact in E.164 format. The phone number type defaults to WORK. You can specify PhoneNumber or PhoneNumbers. We recommend that you use PhoneNumbers, which lets you specify the phone number type and multiple numbers.

CreateContact, createContact_phoneNumbers - The list of phone numbers for the contact.

CreateContact, createContact_sipAddresses - The list of SIP addresses for the contact.

$sel:tags:CreateContact', createContact_tags - The tags to be added to the specified resource. Do not provide system tags.

CreateContact, createContact_firstName - The first name of the contact that is used to call the contact on the device.

Request Lenses

createContact_clientRequestToken :: Lens' CreateContact (Maybe Text) Source #

A unique, user-specified identifier for this request that ensures idempotency.

createContact_displayName :: Lens' CreateContact (Maybe Text) Source #

The name of the contact to display on the console.

createContact_lastName :: Lens' CreateContact (Maybe Text) Source #

The last name of the contact that is used to call the contact on the device.

createContact_phoneNumber :: Lens' CreateContact (Maybe Text) Source #

The phone number of the contact in E.164 format. The phone number type defaults to WORK. You can specify PhoneNumber or PhoneNumbers. We recommend that you use PhoneNumbers, which lets you specify the phone number type and multiple numbers.

createContact_phoneNumbers :: Lens' CreateContact (Maybe [PhoneNumber]) Source #

The list of phone numbers for the contact.

createContact_sipAddresses :: Lens' CreateContact (Maybe [SipAddress]) Source #

The list of SIP addresses for the contact.

createContact_tags :: Lens' CreateContact (Maybe [Tag]) Source #

The tags to be added to the specified resource. Do not provide system tags.

createContact_firstName :: Lens' CreateContact Text Source #

The first name of the contact that is used to call the contact on the device.

Destructuring the Response

data CreateContactResponse Source #

See: newCreateContactResponse smart constructor.

Constructors

CreateContactResponse'
Fields contactArn :: Maybe Text The ARN of the newly created address book. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newCreateContactResponse Source #

Arguments

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

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

CreateContactResponse, createContactResponse_contactArn - The ARN of the newly created address book.

$sel:httpStatus:CreateContactResponse', createContactResponse_httpStatus - The response's http status code.

Response Lenses

createContactResponse_contactArn :: Lens' CreateContactResponse (Maybe Text) Source #

The ARN of the newly created address book.

createContactResponse_httpStatus :: Lens' CreateContactResponse Int Source #

The response's http status code.