| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::IoT::OTAUpdateInfo; | ||
| 3 | use Moose; | ||
| 4 | has AdditionalParameters => (is => 'ro', isa => 'Paws::IoT::AdditionalParameterMap', request_name => 'additionalParameters', traits => ['NameInRequest']); | ||
| 5 | has AwsIotJobArn => (is => 'ro', isa => 'Str', request_name => 'awsIotJobArn', traits => ['NameInRequest']); | ||
| 6 | has AwsIotJobId => (is => 'ro', isa => 'Str', request_name => 'awsIotJobId', traits => ['NameInRequest']); | ||
| 7 | has AwsJobExecutionsRolloutConfig => (is => 'ro', isa => 'Paws::IoT::AwsJobExecutionsRolloutConfig', request_name => 'awsJobExecutionsRolloutConfig', traits => ['NameInRequest']); | ||
| 8 | has AwsJobPresignedUrlConfig => (is => 'ro', isa => 'Paws::IoT::AwsJobPresignedUrlConfig', request_name => 'awsJobPresignedUrlConfig', traits => ['NameInRequest']); | ||
| 9 | has CreationDate => (is => 'ro', isa => 'Str', request_name => 'creationDate', traits => ['NameInRequest']); | ||
| 10 | has Description => (is => 'ro', isa => 'Str', request_name => 'description', traits => ['NameInRequest']); | ||
| 11 | has ErrorInfo => (is => 'ro', isa => 'Paws::IoT::ErrorInfo', request_name => 'errorInfo', traits => ['NameInRequest']); | ||
| 12 | has LastModifiedDate => (is => 'ro', isa => 'Str', request_name => 'lastModifiedDate', traits => ['NameInRequest']); | ||
| 13 | has OtaUpdateArn => (is => 'ro', isa => 'Str', request_name => 'otaUpdateArn', traits => ['NameInRequest']); | ||
| 14 | has OtaUpdateFiles => (is => 'ro', isa => 'ArrayRef[Paws::IoT::OTAUpdateFile]', request_name => 'otaUpdateFiles', traits => ['NameInRequest']); | ||
| 15 | has OtaUpdateId => (is => 'ro', isa => 'Str', request_name => 'otaUpdateId', traits => ['NameInRequest']); | ||
| 16 | has OtaUpdateStatus => (is => 'ro', isa => 'Str', request_name => 'otaUpdateStatus', traits => ['NameInRequest']); | ||
| 17 | has Protocols => (is => 'ro', isa => 'ArrayRef[Str|Undef]', request_name => 'protocols', traits => ['NameInRequest']); | ||
| 18 | has Targets => (is => 'ro', isa => 'ArrayRef[Str|Undef]', request_name => 'targets', traits => ['NameInRequest']); | ||
| 19 | has TargetSelection => (is => 'ro', isa => 'Str', request_name => 'targetSelection', traits => ['NameInRequest']); | ||
| 20 | |||
| 21 | 1; | ||
| 22 | |||
| 23 | ### main pod documentation begin ### | ||
| 24 | |||
| 25 | =head1 NAME | ||
| 26 | |||
| 27 | Paws::IoT::OTAUpdateInfo | ||
| 28 | |||
| 29 | =head1 USAGE | ||
| 30 | |||
| 31 | This class represents one of two things: | ||
| 32 | |||
| 33 | =head3 Arguments in a call to a service | ||
| 34 | |||
| 35 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 36 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 37 | |||
| 38 | As an example, if Att1 is expected to be a Paws::IoT::OTAUpdateInfo object: | ||
| 39 | |||
| 40 | $service_obj->Method(Att1 => { AdditionalParameters => $value, ..., TargetSelection => $value }); | ||
| 41 | |||
| 42 | =head3 Results returned from an API call | ||
| 43 | |||
| 44 | Use accessors for each attribute. If Att1 is expected to be an Paws::IoT::OTAUpdateInfo object: | ||
| 45 | |||
| 46 | $result = $service_obj->Method(...); | ||
| 47 | $result->Att1->AdditionalParameters | ||
| 48 | |||
| 49 | =head1 DESCRIPTION | ||
| 50 | |||
| 51 | Information about an OTA update. | ||
| 52 | |||
| 53 | =head1 ATTRIBUTES | ||
| 54 | |||
| 55 | |||
| 56 | =head2 AdditionalParameters => L<Paws::IoT::AdditionalParameterMap> | ||
| 57 | |||
| 58 | A collection of name/value pairs | ||
| 59 | |||
| 60 | |||
| 61 | =head2 AwsIotJobArn => Str | ||
| 62 | |||
| 63 | The AWS IoT job ARN associated with the OTA update. | ||
| 64 | |||
| 65 | |||
| 66 | =head2 AwsIotJobId => Str | ||
| 67 | |||
| 68 | The AWS IoT job ID associated with the OTA update. | ||
| 69 | |||
| 70 | |||
| 71 | =head2 AwsJobExecutionsRolloutConfig => L<Paws::IoT::AwsJobExecutionsRolloutConfig> | ||
| 72 | |||
| 73 | Configuration for the rollout of OTA updates. | ||
| 74 | |||
| 75 | |||
| 76 | =head2 AwsJobPresignedUrlConfig => L<Paws::IoT::AwsJobPresignedUrlConfig> | ||
| 77 | |||
| 78 | Configuration information for pre-signed URLs. Valid when C<protocols> | ||
| 79 | contains HTTP. | ||
| 80 | |||
| 81 | |||
| 82 | =head2 CreationDate => Str | ||
| 83 | |||
| 84 | The date when the OTA update was created. | ||
| 85 | |||
| 86 | |||
| 87 | =head2 Description => Str | ||
| 88 | |||
| 89 | A description of the OTA update. | ||
| 90 | |||
| 91 | |||
| 92 | =head2 ErrorInfo => L<Paws::IoT::ErrorInfo> | ||
| 93 | |||
| 94 | Error information associated with the OTA update. | ||
| 95 | |||
| 96 | |||
| 97 | =head2 LastModifiedDate => Str | ||
| 98 | |||
| 99 | The date when the OTA update was last updated. | ||
| 100 | |||
| 101 | |||
| 102 | =head2 OtaUpdateArn => Str | ||
| 103 | |||
| 104 | The OTA update ARN. | ||
| 105 | |||
| 106 | |||
| 107 | =head2 OtaUpdateFiles => ArrayRef[L<Paws::IoT::OTAUpdateFile>] | ||
| 108 | |||
| 109 | A list of files associated with the OTA update. | ||
| 110 | |||
| 111 | |||
| 112 | =head2 OtaUpdateId => Str | ||
| 113 | |||
| 114 | The OTA update ID. | ||
| 115 | |||
| 116 | |||
| 117 | =head2 OtaUpdateStatus => Str | ||
| 118 | |||
| 119 | The status of the OTA update. | ||
| 120 | |||
| 121 | |||
| 122 | =head2 Protocols => ArrayRef[Str|Undef] | ||
| 123 | |||
| 124 | The protocol used to transfer the OTA update image. Valid values are | ||
| 125 | [HTTP], [MQTT], [HTTP, MQTT]. When both HTTP and MQTT are specified, | ||
| 126 | the target device can choose the protocol. | ||
| 127 | |||
| 128 | |||
| 129 | =head2 Targets => ArrayRef[Str|Undef] | ||
| 130 | |||
| 131 | The targets of the OTA update. | ||
| 132 | |||
| 133 | |||
| 134 | =head2 TargetSelection => Str | ||
| 135 | |||
| 136 | Specifies whether the OTA update will continue to run (CONTINUOUS), or | ||
| 137 | will be complete after all those things specified as targets have | ||
| 138 | completed the OTA update (SNAPSHOT). If continuous, the OTA update may | ||
| 139 | also be run on a thing when a change is detected in a target. For | ||
| 140 | example, an OTA update will run on a thing when the thing is added to a | ||
| 141 | target group, even after the OTA update was completed by all things | ||
| 142 | originally in the group. | ||
| 143 | |||
| 144 | |||
| 145 | |||
| 146 | =head1 SEE ALSO | ||
| 147 | |||
| 148 | This class forms part of L<Paws>, describing an object used in L<Paws::IoT> | ||
| 149 | |||
| 150 | =head1 BUGS and CONTRIBUTIONS | ||
| 151 | |||
| 152 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 153 | |||
| 154 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 155 | |||
| 156 | =cut | ||
| 157 |