« blib/lib/Paws/IoTWireless/CreateServiceProfileResponse.pm
↑ Summary
blib/lib/Paws/IoTWireless/CreateWirelessDeviceResponse.pm »
| 1 | |||
| 2 | package Paws::IoTWireless::CreateWirelessDevice; | ||
| 3 | use Moose; | ||
| 4 | has ClientRequestToken => (is => 'ro', isa => 'Str'); | ||
| 5 | has Description => (is => 'ro', isa => 'Str'); | ||
| 6 | has DestinationName => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | has LoRaWAN => (is => 'ro', isa => 'Paws::IoTWireless::LoRaWANDevice'); | ||
| 8 | has Name => (is => 'ro', isa => 'Str'); | ||
| 9 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::IoTWireless::Tag]'); | ||
| 10 | has Type => (is => 'ro', isa => 'Str', required => 1); | ||
| 11 | |||
| 12 | use MooseX::ClassAttribute; | ||
| 13 | |||
| 14 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateWirelessDevice'); | ||
| 15 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/wireless-devices'); | ||
| 16 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 17 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::IoTWireless::CreateWirelessDeviceResponse'); | ||
| 18 | 1; | ||
| 19 | |||
| 20 | ### main pod documentation begin ### | ||
| 21 | |||
| 22 | =head1 NAME | ||
| 23 | |||
| 24 | Paws::IoTWireless::CreateWirelessDevice - Arguments for method CreateWirelessDevice on L<Paws::IoTWireless> | ||
| 25 | |||
| 26 | =head1 DESCRIPTION | ||
| 27 | |||
| 28 | This class represents the parameters used for calling the method CreateWirelessDevice on the | ||
| 29 | L<AWS IoT Wireless|Paws::IoTWireless> service. Use the attributes of this class | ||
| 30 | as arguments to method CreateWirelessDevice. | ||
| 31 | |||
| 32 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateWirelessDevice. | ||
| 33 | |||
| 34 | =head1 SYNOPSIS | ||
| 35 | |||
| 36 | my $api.iotwireless = Paws->service('IoTWireless'); | ||
| 37 | my $CreateWirelessDeviceResponse = $api . iotwireless->CreateWirelessDevice( | ||
| 38 | DestinationName => 'MyDestinationName', | ||
| 39 | Type => 'Sidewalk', | ||
| 40 | ClientRequestToken => 'MyClientRequestToken', # OPTIONAL | ||
| 41 | Description => 'MyDescription', # OPTIONAL | ||
| 42 | LoRaWAN => { | ||
| 43 | AbpV1_0_x => { | ||
| 44 | DevAddr => 'MyDevAddr', # OPTIONAL | ||
| 45 | SessionKeys => { | ||
| 46 | AppSKey => 'MyAppSKey', # OPTIONAL | ||
| 47 | NwkSKey => 'MyNwkSKey', # OPTIONAL | ||
| 48 | }, # OPTIONAL | ||
| 49 | }, # OPTIONAL | ||
| 50 | AbpV1_1 => { | ||
| 51 | DevAddr => 'MyDevAddr', # OPTIONAL | ||
| 52 | SessionKeys => { | ||
| 53 | AppSKey => 'MyAppSKey', # OPTIONAL | ||
| 54 | FNwkSIntKey => 'MyFNwkSIntKey', # OPTIONAL | ||
| 55 | NwkSEncKey => 'MyNwkSEncKey', # OPTIONAL | ||
| 56 | SNwkSIntKey => 'MySNwkSIntKey', # OPTIONAL | ||
| 57 | }, # OPTIONAL | ||
| 58 | }, # OPTIONAL | ||
| 59 | DevEui => 'MyDevEui', # OPTIONAL | ||
| 60 | DeviceProfileId => 'MyDeviceProfileId', # max: 256; OPTIONAL | ||
| 61 | OtaaV1_0_x => { | ||
| 62 | AppEui => 'MyAppEui', # OPTIONAL | ||
| 63 | AppKey => 'MyAppKey', # OPTIONAL | ||
| 64 | }, # OPTIONAL | ||
| 65 | OtaaV1_1 => { | ||
| 66 | AppKey => 'MyAppKey', # OPTIONAL | ||
| 67 | JoinEui => 'MyJoinEui', # OPTIONAL | ||
| 68 | NwkKey => 'MyNwkKey', # OPTIONAL | ||
| 69 | }, # OPTIONAL | ||
| 70 | ServiceProfileId => 'MyServiceProfileId', # max: 256; OPTIONAL | ||
| 71 | }, # OPTIONAL | ||
| 72 | Name => 'MyWirelessDeviceName', # OPTIONAL | ||
| 73 | Tags => [ | ||
| 74 | { | ||
| 75 | Key => 'MyTagKey', # min: 1, max: 128 | ||
| 76 | Value => 'MyTagValue', # max: 256 | ||
| 77 | |||
| 78 | }, | ||
| 79 | ... | ||
| 80 | ], # OPTIONAL | ||
| 81 | ); | ||
| 82 | |||
| 83 | # Results: | ||
| 84 | my $Arn = $CreateWirelessDeviceResponse->Arn; | ||
| 85 | my $Id = $CreateWirelessDeviceResponse->Id; | ||
| 86 | |||
| 87 | # Returns a L<Paws::IoTWireless::CreateWirelessDeviceResponse> object. | ||
| 88 | |||
| 89 | 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. | ||
| 90 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/api.iotwireless/CreateWirelessDevice> | ||
| 91 | |||
| 92 | =head1 ATTRIBUTES | ||
| 93 | |||
| 94 | |||
| 95 | =head2 ClientRequestToken => Str | ||
| 96 | |||
| 97 | Each resource must have a unique client request token. If you try to | ||
| 98 | create a new resource with the same token as a resource that already | ||
| 99 | exists, an exception occurs. If you omit this value, AWS SDKs will | ||
| 100 | automatically generate a unique client request. | ||
| 101 | |||
| 102 | |||
| 103 | |||
| 104 | =head2 Description => Str | ||
| 105 | |||
| 106 | The description of the new resource. | ||
| 107 | |||
| 108 | |||
| 109 | |||
| 110 | =head2 B<REQUIRED> DestinationName => Str | ||
| 111 | |||
| 112 | The name of the destination to assign to the new wireless device. | ||
| 113 | |||
| 114 | |||
| 115 | |||
| 116 | =head2 LoRaWAN => L<Paws::IoTWireless::LoRaWANDevice> | ||
| 117 | |||
| 118 | The device configuration information to use to create the wireless | ||
| 119 | device. | ||
| 120 | |||
| 121 | |||
| 122 | |||
| 123 | =head2 Name => Str | ||
| 124 | |||
| 125 | The name of the new resource. | ||
| 126 | |||
| 127 | |||
| 128 | |||
| 129 | =head2 Tags => ArrayRef[L<Paws::IoTWireless::Tag>] | ||
| 130 | |||
| 131 | The tags to attach to the new wireless device. Tags are metadata that | ||
| 132 | you can use to manage a resource. | ||
| 133 | |||
| 134 | |||
| 135 | |||
| 136 | =head2 B<REQUIRED> Type => Str | ||
| 137 | |||
| 138 | The wireless device type. | ||
| 139 | |||
| 140 | Valid values are: C<"Sidewalk">, C<"LoRaWAN"> | ||
| 141 | |||
| 142 | |||
| 143 | =head1 SEE ALSO | ||
| 144 | |||
| 145 | This class forms part of L<Paws>, documenting arguments for method CreateWirelessDevice in L<Paws::IoTWireless> | ||
| 146 | |||
| 147 | =head1 BUGS and CONTRIBUTIONS | ||
| 148 | |||
| 149 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 150 | |||
| 151 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 152 | |||
| 153 | =cut | ||
| 154 |