« blib/lib/Paws/IoTWireless/CreateWirelessGatewayTask.pm
↑ Summary
blib/lib/Paws/IoTWireless/CreateWirelessGatewayTaskDefinitionResponse.pm »
| 1 | |||
| 2 | package Paws::IoTWireless::CreateWirelessGatewayTaskDefinition; | ||
| 3 | use Moose; | ||
| 4 | has AutoCreateTasks => (is => 'ro', isa => 'Bool', required => 1); | ||
| 5 | has ClientRequestToken => (is => 'ro', isa => 'Str'); | ||
| 6 | has Name => (is => 'ro', isa => 'Str'); | ||
| 7 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::IoTWireless::Tag]'); | ||
| 8 | has Update => (is => 'ro', isa => 'Paws::IoTWireless::UpdateWirelessGatewayTaskCreate'); | ||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateWirelessGatewayTaskDefinition'); | ||
| 13 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/wireless-gateway-task-definitions'); | ||
| 14 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 15 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::IoTWireless::CreateWirelessGatewayTaskDefinitionResponse'); | ||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::IoTWireless::CreateWirelessGatewayTaskDefinition - Arguments for method CreateWirelessGatewayTaskDefinition on L<Paws::IoTWireless> | ||
| 23 | |||
| 24 | =head1 DESCRIPTION | ||
| 25 | |||
| 26 | This class represents the parameters used for calling the method CreateWirelessGatewayTaskDefinition on the | ||
| 27 | L<AWS IoT Wireless|Paws::IoTWireless> service. Use the attributes of this class | ||
| 28 | as arguments to method CreateWirelessGatewayTaskDefinition. | ||
| 29 | |||
| 30 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateWirelessGatewayTaskDefinition. | ||
| 31 | |||
| 32 | =head1 SYNOPSIS | ||
| 33 | |||
| 34 | my $api.iotwireless = Paws->service('IoTWireless'); | ||
| 35 | my $CreateWirelessGatewayTaskDefinitionResponse = | ||
| 36 | $api . iotwireless->CreateWirelessGatewayTaskDefinition( | ||
| 37 | AutoCreateTasks => 1, | ||
| 38 | ClientRequestToken => 'MyClientRequestToken', # OPTIONAL | ||
| 39 | Name => 'MyWirelessGatewayTaskName', # OPTIONAL | ||
| 40 | Tags => [ | ||
| 41 | { | ||
| 42 | Key => 'MyTagKey', # min: 1, max: 128 | ||
| 43 | Value => 'MyTagValue', # max: 256 | ||
| 44 | |||
| 45 | }, | ||
| 46 | ... | ||
| 47 | ], # OPTIONAL | ||
| 48 | Update => { | ||
| 49 | LoRaWAN => { | ||
| 50 | CurrentVersion => { | ||
| 51 | Model => 'MyModel', # min: 1, max: 4096; OPTIONAL | ||
| 52 | PackageVersion => 'MyPackageVersion', # min: 1, max: 32; OPTIONAL | ||
| 53 | Station => 'MyStation', # min: 1, max: 4096; OPTIONAL | ||
| 54 | }, # OPTIONAL | ||
| 55 | SigKeyCrc => 1, # min: 1, max: 4294967295; OPTIONAL | ||
| 56 | UpdateSignature => 'MyUpdateSignature', # min: 1, max: 4096; OPTIONAL | ||
| 57 | UpdateVersion => { | ||
| 58 | Model => 'MyModel', # min: 1, max: 4096; OPTIONAL | ||
| 59 | PackageVersion => 'MyPackageVersion', # min: 1, max: 32; OPTIONAL | ||
| 60 | Station => 'MyStation', # min: 1, max: 4096; OPTIONAL | ||
| 61 | }, # OPTIONAL | ||
| 62 | }, # OPTIONAL | ||
| 63 | UpdateDataRole => 'MyUpdateDataSource', # min: 1, max: 4096; OPTIONAL | ||
| 64 | UpdateDataSource => 'MyUpdateDataSource', # min: 1, max: 4096; OPTIONAL | ||
| 65 | }, # OPTIONAL | ||
| 66 | ); | ||
| 67 | |||
| 68 | # Results: | ||
| 69 | my $Arn = $CreateWirelessGatewayTaskDefinitionResponse->Arn; | ||
| 70 | my $Id = $CreateWirelessGatewayTaskDefinitionResponse->Id; | ||
| 71 | |||
| 72 | # Returns a L<Paws::IoTWireless::CreateWirelessGatewayTaskDefinitionResponse> object. | ||
| 73 | |||
| 74 | 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. | ||
| 75 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/api.iotwireless/CreateWirelessGatewayTaskDefinition> | ||
| 76 | |||
| 77 | =head1 ATTRIBUTES | ||
| 78 | |||
| 79 | |||
| 80 | =head2 B<REQUIRED> AutoCreateTasks => Bool | ||
| 81 | |||
| 82 | Whether to automatically create tasks using this task definition for | ||
| 83 | all gateways with the specified current version. If C<false>, the task | ||
| 84 | must me created by calling C<CreateWirelessGatewayTask>. | ||
| 85 | |||
| 86 | |||
| 87 | |||
| 88 | =head2 ClientRequestToken => Str | ||
| 89 | |||
| 90 | Each resource must have a unique client request token. If you try to | ||
| 91 | create a new resource with the same token as a resource that already | ||
| 92 | exists, an exception occurs. If you omit this value, AWS SDKs will | ||
| 93 | automatically generate a unique client request. | ||
| 94 | |||
| 95 | |||
| 96 | |||
| 97 | =head2 Name => Str | ||
| 98 | |||
| 99 | The name of the new resource. | ||
| 100 | |||
| 101 | |||
| 102 | |||
| 103 | =head2 Tags => ArrayRef[L<Paws::IoTWireless::Tag>] | ||
| 104 | |||
| 105 | The tags to attach to the specified resource. Tags are metadata that | ||
| 106 | you can use to manage a resource. | ||
| 107 | |||
| 108 | |||
| 109 | |||
| 110 | =head2 Update => L<Paws::IoTWireless::UpdateWirelessGatewayTaskCreate> | ||
| 111 | |||
| 112 | Information about the gateways to update. | ||
| 113 | |||
| 114 | |||
| 115 | |||
| 116 | |||
| 117 | =head1 SEE ALSO | ||
| 118 | |||
| 119 | This class forms part of L<Paws>, documenting arguments for method CreateWirelessGatewayTaskDefinition in L<Paws::IoTWireless> | ||
| 120 | |||
| 121 | =head1 BUGS and CONTRIBUTIONS | ||
| 122 | |||
| 123 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 124 | |||
| 125 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 126 | |||
| 127 | =cut | ||
| 128 |