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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a new room profile with the specified details.

Synopsis

data CreateProfile = CreateProfile' {
- clientRequestToken :: Maybe Text
- dataRetentionOptIn :: Maybe Bool
- locale :: Maybe Text
- maxVolumeLimit :: Maybe Int
- meetingRoomConfiguration :: Maybe CreateMeetingRoomConfiguration
- pSTNEnabled :: Maybe Bool
- setupModeDisabled :: Maybe Bool
- tags :: Maybe [Tag]
- profileName :: Text
- timezone :: Text
- address :: Text
- distanceUnit :: DistanceUnit
- temperatureUnit :: TemperatureUnit
- wakeWord :: WakeWord
}
newCreateProfile :: Text -> Text -> Text -> DistanceUnit -> TemperatureUnit -> WakeWord -> CreateProfile
createProfile_clientRequestToken :: Lens' CreateProfile (Maybe Text)
createProfile_dataRetentionOptIn :: Lens' CreateProfile (Maybe Bool)
createProfile_locale :: Lens' CreateProfile (Maybe Text)
createProfile_maxVolumeLimit :: Lens' CreateProfile (Maybe Int)
createProfile_meetingRoomConfiguration :: Lens' CreateProfile (Maybe CreateMeetingRoomConfiguration)
createProfile_pSTNEnabled :: Lens' CreateProfile (Maybe Bool)
createProfile_setupModeDisabled :: Lens' CreateProfile (Maybe Bool)
createProfile_tags :: Lens' CreateProfile (Maybe [Tag])
createProfile_profileName :: Lens' CreateProfile Text
createProfile_timezone :: Lens' CreateProfile Text
createProfile_address :: Lens' CreateProfile Text
createProfile_distanceUnit :: Lens' CreateProfile DistanceUnit
createProfile_temperatureUnit :: Lens' CreateProfile TemperatureUnit
createProfile_wakeWord :: Lens' CreateProfile WakeWord
data CreateProfileResponse = CreateProfileResponse' {
- profileArn :: Maybe Text
- httpStatus :: Int
}
newCreateProfileResponse :: Int -> CreateProfileResponse
createProfileResponse_profileArn :: Lens' CreateProfileResponse (Maybe Text)
createProfileResponse_httpStatus :: Lens' CreateProfileResponse Int

Creating a Request

data CreateProfile Source #

See: newCreateProfile smart constructor.

Constructors

CreateProfile'

Fields

clientRequestToken :: Maybe Text
The user-specified token that is used during the creation of a profile.
dataRetentionOptIn :: Maybe Bool
Whether data retention of the profile is enabled.
locale :: Maybe Text
The locale of the room profile. (This is currently only available to a limited preview audience.)
maxVolumeLimit :: Maybe Int
The maximum volume limit for a room profile.
meetingRoomConfiguration :: Maybe CreateMeetingRoomConfiguration
The meeting room settings of a room profile.
pSTNEnabled :: Maybe Bool
Whether PSTN calling is enabled.
setupModeDisabled :: Maybe Bool
Whether room profile setup is enabled.
tags :: Maybe [Tag]
The tags for the profile.
profileName :: Text
The name of a room profile.
timezone :: Text
The time zone used by a room profile.
address :: Text
The valid address for the room.
distanceUnit :: DistanceUnit
The distance unit to be used by devices in the profile.
temperatureUnit :: TemperatureUnit
The temperature unit to be used by devices in the profile.
wakeWord :: WakeWord
A wake word for Alexa, Echo, Amazon, or a computer.

Instances

Instances details

ToJSON CreateProfile Source #
Instance details Defined in Amazonka.AlexaBusiness.CreateProfile Methods toJSON :: CreateProfile -> Value # toEncoding :: CreateProfile -> Encoding # toJSONList :: [CreateProfile] -> Value # toEncodingList :: [CreateProfile] -> Encoding #
ToHeaders CreateProfile Source #
Instance details Defined in Amazonka.AlexaBusiness.CreateProfile Methods toHeaders :: CreateProfile -> [Header] #
ToPath CreateProfile Source #
Instance details Defined in Amazonka.AlexaBusiness.CreateProfile Methods toPath :: CreateProfile -> ByteString #
ToQuery CreateProfile Source #
Instance details Defined in Amazonka.AlexaBusiness.CreateProfile Methods toQuery :: CreateProfile -> QueryString #
AWSRequest CreateProfile Source #
Instance details Defined in Amazonka.AlexaBusiness.CreateProfile Associated Types type AWSResponse CreateProfile # Methods request :: (Service -> Service) -> CreateProfile -> Request CreateProfile # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateProfile -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateProfile))) #
Generic CreateProfile Source #
Instance details Defined in Amazonka.AlexaBusiness.CreateProfile Associated Types type Rep CreateProfile :: Type -> Type # Methods from :: CreateProfile -> Rep CreateProfile x # to :: Rep CreateProfile x -> CreateProfile #
Read CreateProfile Source #
Instance details Defined in Amazonka.AlexaBusiness.CreateProfile Methods readsPrec :: Int -> ReadS CreateProfile # readList :: ReadS [CreateProfile] # readPrec :: ReadPrec CreateProfile # readListPrec :: ReadPrec [CreateProfile] #
Show CreateProfile Source #
Instance details Defined in Amazonka.AlexaBusiness.CreateProfile Methods showsPrec :: Int -> CreateProfile -> ShowS # show :: CreateProfile -> String # showList :: [CreateProfile] -> ShowS #
NFData CreateProfile Source #
Instance details Defined in Amazonka.AlexaBusiness.CreateProfile Methods rnf :: CreateProfile -> () #
Eq CreateProfile Source #
Instance details Defined in Amazonka.AlexaBusiness.CreateProfile Methods (==) :: CreateProfile -> CreateProfile -> Bool # (/=) :: CreateProfile -> CreateProfile -> Bool #
Hashable CreateProfile Source #
Instance details Defined in Amazonka.AlexaBusiness.CreateProfile Methods hashWithSalt :: Int -> CreateProfile -> Int # hash :: CreateProfile -> Int #
type AWSResponse CreateProfile Source #
Instance details Defined in Amazonka.AlexaBusiness.CreateProfile type AWSResponse CreateProfile = CreateProfileResponse
type Rep CreateProfile Source #
Instance details Defined in Amazonka.AlexaBusiness.CreateProfile type Rep CreateProfile = D1 ('MetaData "CreateProfile" "Amazonka.AlexaBusiness.CreateProfile" "amazonka-alexa-business-2.0-BWvKfxFukoyBarGovAkdOS" 'False) (C1 ('MetaCons "CreateProfile'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "clientRequestToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "dataRetentionOptIn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "locale") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "maxVolumeLimit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "meetingRoomConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CreateMeetingRoomConfiguration))) :: (S1 ('MetaSel ('Just "pSTNEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "setupModeDisabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))))) :: ((S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :: (S1 ('MetaSel ('Just "profileName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "timezone") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :: ((S1 ('MetaSel ('Just "address") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "distanceUnit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DistanceUnit)) :: (S1 ('MetaSel ('Just "temperatureUnit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 TemperatureUnit) :*: S1 ('MetaSel ('Just "wakeWord") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 WakeWord))))))

newCreateProfile Source #

Arguments

:: Text	`CreateProfile`
-> Text	`CreateProfile`
-> Text	`CreateProfile`
-> DistanceUnit	`CreateProfile`
-> TemperatureUnit	`CreateProfile`
-> WakeWord	`CreateProfile`
-> CreateProfile

Create a value of CreateProfile 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:CreateProfile', createProfile_clientRequestToken - The user-specified token that is used during the creation of a profile.

CreateProfile, createProfile_dataRetentionOptIn - Whether data retention of the profile is enabled.

CreateProfile, createProfile_locale - The locale of the room profile. (This is currently only available to a limited preview audience.)

CreateProfile, createProfile_maxVolumeLimit - The maximum volume limit for a room profile.

CreateProfile, createProfile_meetingRoomConfiguration - The meeting room settings of a room profile.

CreateProfile, createProfile_pSTNEnabled - Whether PSTN calling is enabled.

CreateProfile, createProfile_setupModeDisabled - Whether room profile setup is enabled.

$sel:tags:CreateProfile', createProfile_tags - The tags for the profile.

CreateProfile, createProfile_profileName - The name of a room profile.

CreateProfile, createProfile_timezone - The time zone used by a room profile.

CreateProfile, createProfile_address - The valid address for the room.

CreateProfile, createProfile_distanceUnit - The distance unit to be used by devices in the profile.

CreateProfile, createProfile_temperatureUnit - The temperature unit to be used by devices in the profile.

CreateProfile, createProfile_wakeWord - A wake word for Alexa, Echo, Amazon, or a computer.

Request Lenses

createProfile_clientRequestToken :: Lens' CreateProfile (Maybe Text) Source #

The user-specified token that is used during the creation of a profile.

createProfile_dataRetentionOptIn :: Lens' CreateProfile (Maybe Bool) Source #

Whether data retention of the profile is enabled.

createProfile_locale :: Lens' CreateProfile (Maybe Text) Source #

The locale of the room profile. (This is currently only available to a limited preview audience.)

createProfile_maxVolumeLimit :: Lens' CreateProfile (Maybe Int) Source #

The maximum volume limit for a room profile.

createProfile_meetingRoomConfiguration :: Lens' CreateProfile (Maybe CreateMeetingRoomConfiguration) Source #

The meeting room settings of a room profile.

createProfile_pSTNEnabled :: Lens' CreateProfile (Maybe Bool) Source #

Whether PSTN calling is enabled.

createProfile_setupModeDisabled :: Lens' CreateProfile (Maybe Bool) Source #

Whether room profile setup is enabled.

createProfile_tags :: Lens' CreateProfile (Maybe [Tag]) Source #

The tags for the profile.

createProfile_profileName :: Lens' CreateProfile Text Source #

The name of a room profile.

createProfile_timezone :: Lens' CreateProfile Text Source #

The time zone used by a room profile.

createProfile_address :: Lens' CreateProfile Text Source #

The valid address for the room.

createProfile_distanceUnit :: Lens' CreateProfile DistanceUnit Source #

The distance unit to be used by devices in the profile.

createProfile_temperatureUnit :: Lens' CreateProfile TemperatureUnit Source #

The temperature unit to be used by devices in the profile.

createProfile_wakeWord :: Lens' CreateProfile WakeWord Source #

A wake word for Alexa, Echo, Amazon, or a computer.

Destructuring the Response

data CreateProfileResponse Source #

See: newCreateProfileResponse smart constructor.

Constructors

CreateProfileResponse'
Fields profileArn :: Maybe Text The ARN of the newly created room profile in the response. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newCreateProfileResponse Source #

Arguments

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

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

CreateProfileResponse, createProfileResponse_profileArn - The ARN of the newly created room profile in the response.

$sel:httpStatus:CreateProfileResponse', createProfileResponse_httpStatus - The response's http status code.

Response Lenses

createProfileResponse_profileArn :: Lens' CreateProfileResponse (Maybe Text) Source #

The ARN of the newly created room profile in the response.

createProfileResponse_httpStatus :: Lens' CreateProfileResponse Int Source #

The response's http status code.