« blib/lib/Paws/IoT/StartSigningJobParameter.pm
↑ Summary
blib/lib/Paws/IoT/StartThingRegistrationTaskResponse.pm »
| 1 | |||
| 2 | package Paws::IoT::StartThingRegistrationTask; | ||
| 3 | use Moose; | ||
| 4 | has InputFileBucket => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'inputFileBucket', required => 1); | ||
| 5 | has InputFileKey => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'inputFileKey', required => 1); | ||
| 6 | has RoleArn => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'roleArn', required => 1); | ||
| 7 | has TemplateBody => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'templateBody', required => 1); | ||
| 8 | |||
| 9 | use MooseX::ClassAttribute; | ||
| 10 | |||
| 11 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'StartThingRegistrationTask'); | ||
| 12 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/thing-registration-tasks'); | ||
| 13 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 14 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::IoT::StartThingRegistrationTaskResponse'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::IoT::StartThingRegistrationTask - Arguments for method StartThingRegistrationTask on L<Paws::IoT> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method StartThingRegistrationTask on the | ||
| 26 | L<AWS IoT|Paws::IoT> service. Use the attributes of this class | ||
| 27 | as arguments to method StartThingRegistrationTask. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to StartThingRegistrationTask. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $iot = Paws->service('IoT'); | ||
| 34 | my $StartThingRegistrationTaskResponse = $iot->StartThingRegistrationTask( | ||
| 35 | InputFileBucket => 'MyRegistryS3BucketName', | ||
| 36 | InputFileKey => 'MyRegistryS3KeyName', | ||
| 37 | RoleArn => 'MyRoleArn', | ||
| 38 | TemplateBody => 'MyTemplateBody', | ||
| 39 | |||
| 40 | ); | ||
| 41 | |||
| 42 | # Results: | ||
| 43 | my $TaskId = $StartThingRegistrationTaskResponse->TaskId; | ||
| 44 | |||
| 45 | # Returns a L<Paws::IoT::StartThingRegistrationTaskResponse> object. | ||
| 46 | |||
| 47 | 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. | ||
| 48 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/iot/StartThingRegistrationTask> | ||
| 49 | |||
| 50 | =head1 ATTRIBUTES | ||
| 51 | |||
| 52 | |||
| 53 | =head2 B<REQUIRED> InputFileBucket => Str | ||
| 54 | |||
| 55 | The S3 bucket that contains the input file. | ||
| 56 | |||
| 57 | |||
| 58 | |||
| 59 | =head2 B<REQUIRED> InputFileKey => Str | ||
| 60 | |||
| 61 | The name of input file within the S3 bucket. This file contains a | ||
| 62 | newline delimited JSON file. Each line contains the parameter values to | ||
| 63 | provision one device (thing). | ||
| 64 | |||
| 65 | |||
| 66 | |||
| 67 | =head2 B<REQUIRED> RoleArn => Str | ||
| 68 | |||
| 69 | The IAM role ARN that grants permission the input file. | ||
| 70 | |||
| 71 | |||
| 72 | |||
| 73 | =head2 B<REQUIRED> TemplateBody => Str | ||
| 74 | |||
| 75 | The provisioning template. | ||
| 76 | |||
| 77 | |||
| 78 | |||
| 79 | |||
| 80 | =head1 SEE ALSO | ||
| 81 | |||
| 82 | This class forms part of L<Paws>, documenting arguments for method StartThingRegistrationTask in L<Paws::IoT> | ||
| 83 | |||
| 84 | =head1 BUGS and CONTRIBUTIONS | ||
| 85 | |||
| 86 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 87 | |||
| 88 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 89 | |||
| 90 | =cut | ||
| 91 |