« blib/lib/Paws/AlexaForBusiness/CreateNetworkProfileResponse.pm
↑ Summary
blib/lib/Paws/AlexaForBusiness/CreateProfileResponse.pm »
| 1 | |||
| 2 | package Paws::AlexaForBusiness::CreateProfile; | ||
| 3 | use Moose; | ||
| 4 | has Address => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has ClientRequestToken => (is => 'ro', isa => 'Str'); | ||
| 6 | has DataRetentionOptIn => (is => 'ro', isa => 'Bool'); | ||
| 7 | has DistanceUnit => (is => 'ro', isa => 'Str', required => 1); | ||
| 8 | has Locale => (is => 'ro', isa => 'Str'); | ||
| 9 | has MaxVolumeLimit => (is => 'ro', isa => 'Int'); | ||
| 10 | has MeetingRoomConfiguration => (is => 'ro', isa => 'Paws::AlexaForBusiness::CreateMeetingRoomConfiguration'); | ||
| 11 | has ProfileName => (is => 'ro', isa => 'Str', required => 1); | ||
| 12 | has PSTNEnabled => (is => 'ro', isa => 'Bool'); | ||
| 13 | has SetupModeDisabled => (is => 'ro', isa => 'Bool'); | ||
| 14 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::AlexaForBusiness::Tag]'); | ||
| 15 | has TemperatureUnit => (is => 'ro', isa => 'Str', required => 1); | ||
| 16 | has Timezone => (is => 'ro', isa => 'Str', required => 1); | ||
| 17 | has WakeWord => (is => 'ro', isa => 'Str', required => 1); | ||
| 18 | |||
| 19 | use MooseX::ClassAttribute; | ||
| 20 | |||
| 21 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateProfile'); | ||
| 22 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::AlexaForBusiness::CreateProfileResponse'); | ||
| 23 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 24 | 1; | ||
| 25 | |||
| 26 | ### main pod documentation begin ### | ||
| 27 | |||
| 28 | =head1 NAME | ||
| 29 | |||
| 30 | Paws::AlexaForBusiness::CreateProfile - Arguments for method CreateProfile on L<Paws::AlexaForBusiness> | ||
| 31 | |||
| 32 | =head1 DESCRIPTION | ||
| 33 | |||
| 34 | This class represents the parameters used for calling the method CreateProfile on the | ||
| 35 | L<Alexa For Business|Paws::AlexaForBusiness> service. Use the attributes of this class | ||
| 36 | as arguments to method CreateProfile. | ||
| 37 | |||
| 38 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateProfile. | ||
| 39 | |||
| 40 | =head1 SYNOPSIS | ||
| 41 | |||
| 42 | my $a4b = Paws->service('AlexaForBusiness'); | ||
| 43 | my $CreateProfileResponse = $a4b->CreateProfile( | ||
| 44 | Address => 'MyAddress', | ||
| 45 | DistanceUnit => 'METRIC', | ||
| 46 | ProfileName => 'MyProfileName', | ||
| 47 | TemperatureUnit => 'FAHRENHEIT', | ||
| 48 | Timezone => 'MyTimezone', | ||
| 49 | WakeWord => 'ALEXA', | ||
| 50 | ClientRequestToken => 'MyClientRequestToken', # OPTIONAL | ||
| 51 | DataRetentionOptIn => 1, # OPTIONAL | ||
| 52 | Locale => 'MyDeviceLocale', # OPTIONAL | ||
| 53 | MaxVolumeLimit => 1, # OPTIONAL | ||
| 54 | MeetingRoomConfiguration => { | ||
| 55 | EndOfMeetingReminder => { | ||
| 56 | Enabled => 1, | ||
| 57 | ReminderAtMinutes => [ 1, ... ], # min: 1, max: 1 | ||
| 58 | ReminderType => 'ANNOUNCEMENT_TIME_CHECK' | ||
| 59 | , # values: ANNOUNCEMENT_TIME_CHECK, ANNOUNCEMENT_VARIABLE_TIME_LEFT, CHIME, KNOCK | ||
| 60 | |||
| 61 | }, # OPTIONAL | ||
| 62 | InstantBooking => { | ||
| 63 | DurationInMinutes => 1, | ||
| 64 | Enabled => 1, | ||
| 65 | |||
| 66 | }, # OPTIONAL | ||
| 67 | RequireCheckIn => { | ||
| 68 | Enabled => 1, | ||
| 69 | ReleaseAfterMinutes => 1, | ||
| 70 | |||
| 71 | }, # OPTIONAL | ||
| 72 | RoomUtilizationMetricsEnabled => 1, | ||
| 73 | }, # OPTIONAL | ||
| 74 | PSTNEnabled => 1, # OPTIONAL | ||
| 75 | SetupModeDisabled => 1, # OPTIONAL | ||
| 76 | Tags => [ | ||
| 77 | { | ||
| 78 | Key => 'MyTagKey', # min: 1, max: 128 | ||
| 79 | Value => 'MyTagValue', # max: 256 | ||
| 80 | |||
| 81 | }, | ||
| 82 | ... | ||
| 83 | ], # OPTIONAL | ||
| 84 | ); | ||
| 85 | |||
| 86 | # Results: | ||
| 87 | my $ProfileArn = $CreateProfileResponse->ProfileArn; | ||
| 88 | |||
| 89 | # Returns a L<Paws::AlexaForBusiness::CreateProfileResponse> object. | ||
| 90 | |||
| 91 | Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. | ||
| 92 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/a4b/CreateProfile> | ||
| 93 | |||
| 94 | =head1 ATTRIBUTES | ||
| 95 | |||
| 96 | |||
| 97 | =head2 B<REQUIRED> Address => Str | ||
| 98 | |||
| 99 | The valid address for the room. | ||
| 100 | |||
| 101 | |||
| 102 | |||
| 103 | =head2 ClientRequestToken => Str | ||
| 104 | |||
| 105 | The user-specified token that is used during the creation of a profile. | ||
| 106 | |||
| 107 | |||
| 108 | |||
| 109 | =head2 DataRetentionOptIn => Bool | ||
| 110 | |||
| 111 | Whether data retention of the profile is enabled. | ||
| 112 | |||
| 113 | |||
| 114 | |||
| 115 | =head2 B<REQUIRED> DistanceUnit => Str | ||
| 116 | |||
| 117 | The distance unit to be used by devices in the profile. | ||
| 118 | |||
| 119 | Valid values are: C<"METRIC">, C<"IMPERIAL"> | ||
| 120 | |||
| 121 | =head2 Locale => Str | ||
| 122 | |||
| 123 | The locale of the room profile. (This is currently only available to a | ||
| 124 | limited preview audience.) | ||
| 125 | |||
| 126 | |||
| 127 | |||
| 128 | =head2 MaxVolumeLimit => Int | ||
| 129 | |||
| 130 | The maximum volume limit for a room profile. | ||
| 131 | |||
| 132 | |||
| 133 | |||
| 134 | =head2 MeetingRoomConfiguration => L<Paws::AlexaForBusiness::CreateMeetingRoomConfiguration> | ||
| 135 | |||
| 136 | The meeting room settings of a room profile. | ||
| 137 | |||
| 138 | |||
| 139 | |||
| 140 | =head2 B<REQUIRED> ProfileName => Str | ||
| 141 | |||
| 142 | The name of a room profile. | ||
| 143 | |||
| 144 | |||
| 145 | |||
| 146 | =head2 PSTNEnabled => Bool | ||
| 147 | |||
| 148 | Whether PSTN calling is enabled. | ||
| 149 | |||
| 150 | |||
| 151 | |||
| 152 | =head2 SetupModeDisabled => Bool | ||
| 153 | |||
| 154 | Whether room profile setup is enabled. | ||
| 155 | |||
| 156 | |||
| 157 | |||
| 158 | =head2 Tags => ArrayRef[L<Paws::AlexaForBusiness::Tag>] | ||
| 159 | |||
| 160 | The tags for the profile. | ||
| 161 | |||
| 162 | |||
| 163 | |||
| 164 | =head2 B<REQUIRED> TemperatureUnit => Str | ||
| 165 | |||
| 166 | The temperature unit to be used by devices in the profile. | ||
| 167 | |||
| 168 | Valid values are: C<"FAHRENHEIT">, C<"CELSIUS"> | ||
| 169 | |||
| 170 | =head2 B<REQUIRED> Timezone => Str | ||
| 171 | |||
| 172 | The time zone used by a room profile. | ||
| 173 | |||
| 174 | |||
| 175 | |||
| 176 | =head2 B<REQUIRED> WakeWord => Str | ||
| 177 | |||
| 178 | A wake word for Alexa, Echo, Amazon, or a computer. | ||
| 179 | |||
| 180 | Valid values are: C<"ALEXA">, C<"AMAZON">, C<"ECHO">, C<"COMPUTER"> | ||
| 181 | |||
| 182 | |||
| 183 | =head1 SEE ALSO | ||
| 184 | |||
| 185 | This class forms part of L<Paws>, documenting arguments for method CreateProfile in L<Paws::AlexaForBusiness> | ||
| 186 | |||
| 187 | =head1 BUGS and CONTRIBUTIONS | ||
| 188 | |||
| 189 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 190 | |||
| 191 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 192 | |||
| 193 | =cut | ||
| 194 |