« blib/lib/Paws/IoTSiteWise/UpdateAsset.pm
↑ Summary
blib/lib/Paws/IoTSiteWise/UpdateAssetModelResponse.pm »
| 1 | |||
| 2 | package Paws::IoTSiteWise::UpdateAssetModel; | ||
| 3 | use Moose; | ||
| 4 | has AssetModelCompositeModels => (is => 'ro', isa => 'ArrayRef[Paws::IoTSiteWise::AssetModelCompositeModel]', traits => ['NameInRequest'], request_name => 'assetModelCompositeModels'); | ||
| 5 | has AssetModelDescription => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'assetModelDescription'); | ||
| 6 | has AssetModelHierarchies => (is => 'ro', isa => 'ArrayRef[Paws::IoTSiteWise::AssetModelHierarchy]', traits => ['NameInRequest'], request_name => 'assetModelHierarchies'); | ||
| 7 | has AssetModelId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'assetModelId', required => 1); | ||
| 8 | has AssetModelName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'assetModelName', required => 1); | ||
| 9 | has AssetModelProperties => (is => 'ro', isa => 'ArrayRef[Paws::IoTSiteWise::AssetModelProperty]', traits => ['NameInRequest'], request_name => 'assetModelProperties'); | ||
| 10 | has ClientToken => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'clientToken'); | ||
| 11 | |||
| 12 | use MooseX::ClassAttribute; | ||
| 13 | |||
| 14 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'UpdateAssetModel'); | ||
| 15 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/asset-models/{assetModelId}'); | ||
| 16 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'PUT'); | ||
| 17 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::IoTSiteWise::UpdateAssetModelResponse'); | ||
| 18 | 1; | ||
| 19 | |||
| 20 | ### main pod documentation begin ### | ||
| 21 | |||
| 22 | =head1 NAME | ||
| 23 | |||
| 24 | Paws::IoTSiteWise::UpdateAssetModel - Arguments for method UpdateAssetModel on L<Paws::IoTSiteWise> | ||
| 25 | |||
| 26 | =head1 DESCRIPTION | ||
| 27 | |||
| 28 | This class represents the parameters used for calling the method UpdateAssetModel on the | ||
| 29 | L<AWS IoT SiteWise|Paws::IoTSiteWise> service. Use the attributes of this class | ||
| 30 | as arguments to method UpdateAssetModel. | ||
| 31 | |||
| 32 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdateAssetModel. | ||
| 33 | |||
| 34 | =head1 SYNOPSIS | ||
| 35 | |||
| 36 | my $iotsitewise = Paws->service('IoTSiteWise'); | ||
| 37 | my $UpdateAssetModelResponse = $iotsitewise->UpdateAssetModel( | ||
| 38 | AssetModelId => 'MyID', | ||
| 39 | AssetModelName => 'MyName', | ||
| 40 | AssetModelCompositeModels => [ | ||
| 41 | { | ||
| 42 | Name => 'MyName', # min: 1, max: 256 | ||
| 43 | Type => 'MyName', # min: 1, max: 256 | ||
| 44 | Description => 'MyDescription', # min: 1, max: 2048; OPTIONAL | ||
| 45 | Properties => [ | ||
| 46 | { | ||
| 47 | DataType => | ||
| 48 | 'STRING', # values: STRING, INTEGER, DOUBLE, BOOLEAN, STRUCT | ||
| 49 | Name => 'MyName', # min: 1, max: 256 | ||
| 50 | Type => { | ||
| 51 | Attribute => { | ||
| 52 | DefaultValue => | ||
| 53 | 'MyDefaultValue', # min: 1, max: 1024; OPTIONAL | ||
| 54 | }, # OPTIONAL | ||
| 55 | Measurement => { | ||
| 56 | |||
| 57 | }, # OPTIONAL | ||
| 58 | Metric => { | ||
| 59 | Expression => 'MyExpression', # min: 1, max: 1024 | ||
| 60 | Variables => [ | ||
| 61 | { | ||
| 62 | Name => 'MyVariableName', # min: 1, max: 64 | ||
| 63 | Value => { | ||
| 64 | PropertyId => 'MyMacro', # min: 1, max: 256 | ||
| 65 | HierarchyId => 'MyMacro', # min: 1, max: 256 | ||
| 66 | }, | ||
| 67 | |||
| 68 | }, | ||
| 69 | ... | ||
| 70 | ], | ||
| 71 | Window => { | ||
| 72 | Tumbling => { | ||
| 73 | Interval => 'MyInterval', # min: 2, max: 3 | ||
| 74 | |||
| 75 | }, # OPTIONAL | ||
| 76 | }, | ||
| 77 | |||
| 78 | }, # OPTIONAL | ||
| 79 | Transform => { | ||
| 80 | Expression => 'MyExpression', # min: 1, max: 1024 | ||
| 81 | Variables => [ | ||
| 82 | { | ||
| 83 | Name => 'MyVariableName', # min: 1, max: 64 | ||
| 84 | Value => { | ||
| 85 | PropertyId => 'MyMacro', # min: 1, max: 256 | ||
| 86 | HierarchyId => 'MyMacro', # min: 1, max: 256 | ||
| 87 | }, | ||
| 88 | |||
| 89 | }, | ||
| 90 | ... | ||
| 91 | ], | ||
| 92 | |||
| 93 | }, # OPTIONAL | ||
| 94 | }, | ||
| 95 | DataTypeSpec => 'MyName', # min: 1, max: 256 | ||
| 96 | Id => 'MyID', # min: 36, max: 36 | ||
| 97 | Unit => 'MyPropertyUnit', # min: 1, max: 256; OPTIONAL | ||
| 98 | }, | ||
| 99 | ... | ||
| 100 | ], # OPTIONAL | ||
| 101 | }, | ||
| 102 | ... | ||
| 103 | ], # OPTIONAL | ||
| 104 | AssetModelDescription => 'MyDescription', # OPTIONAL | ||
| 105 | AssetModelHierarchies => [ | ||
| 106 | { | ||
| 107 | ChildAssetModelId => 'MyID', # min: 36, max: 36 | ||
| 108 | Name => 'MyName', # min: 1, max: 256 | ||
| 109 | Id => 'MyID', # min: 36, max: 36 | ||
| 110 | }, | ||
| 111 | ... | ||
| 112 | ], # OPTIONAL | ||
| 113 | AssetModelProperties => [ | ||
| 114 | { | ||
| 115 | DataType => | ||
| 116 | 'STRING', # values: STRING, INTEGER, DOUBLE, BOOLEAN, STRUCT | ||
| 117 | Name => 'MyName', # min: 1, max: 256 | ||
| 118 | Type => { | ||
| 119 | Attribute => { | ||
| 120 | DefaultValue => 'MyDefaultValue', # min: 1, max: 1024; OPTIONAL | ||
| 121 | }, # OPTIONAL | ||
| 122 | Measurement => { | ||
| 123 | |||
| 124 | }, # OPTIONAL | ||
| 125 | Metric => { | ||
| 126 | Expression => 'MyExpression', # min: 1, max: 1024 | ||
| 127 | Variables => [ | ||
| 128 | { | ||
| 129 | Name => 'MyVariableName', # min: 1, max: 64 | ||
| 130 | Value => { | ||
| 131 | PropertyId => 'MyMacro', # min: 1, max: 256 | ||
| 132 | HierarchyId => 'MyMacro', # min: 1, max: 256 | ||
| 133 | }, | ||
| 134 | |||
| 135 | }, | ||
| 136 | ... | ||
| 137 | ], | ||
| 138 | Window => { | ||
| 139 | Tumbling => { | ||
| 140 | Interval => 'MyInterval', # min: 2, max: 3 | ||
| 141 | |||
| 142 | }, # OPTIONAL | ||
| 143 | }, | ||
| 144 | |||
| 145 | }, # OPTIONAL | ||
| 146 | Transform => { | ||
| 147 | Expression => 'MyExpression', # min: 1, max: 1024 | ||
| 148 | Variables => [ | ||
| 149 | { | ||
| 150 | Name => 'MyVariableName', # min: 1, max: 64 | ||
| 151 | Value => { | ||
| 152 | PropertyId => 'MyMacro', # min: 1, max: 256 | ||
| 153 | HierarchyId => 'MyMacro', # min: 1, max: 256 | ||
| 154 | }, | ||
| 155 | |||
| 156 | }, | ||
| 157 | ... | ||
| 158 | ], | ||
| 159 | |||
| 160 | }, # OPTIONAL | ||
| 161 | }, | ||
| 162 | DataTypeSpec => 'MyName', # min: 1, max: 256 | ||
| 163 | Id => 'MyID', # min: 36, max: 36 | ||
| 164 | Unit => 'MyPropertyUnit', # min: 1, max: 256; OPTIONAL | ||
| 165 | }, | ||
| 166 | ... | ||
| 167 | ], # OPTIONAL | ||
| 168 | ClientToken => 'MyClientToken', # OPTIONAL | ||
| 169 | ); | ||
| 170 | |||
| 171 | # Results: | ||
| 172 | my $AssetModelStatus = $UpdateAssetModelResponse->AssetModelStatus; | ||
| 173 | |||
| 174 | # Returns a L<Paws::IoTSiteWise::UpdateAssetModelResponse> object. | ||
| 175 | |||
| 176 | 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. | ||
| 177 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/iotsitewise/UpdateAssetModel> | ||
| 178 | |||
| 179 | =head1 ATTRIBUTES | ||
| 180 | |||
| 181 | |||
| 182 | =head2 AssetModelCompositeModels => ArrayRef[L<Paws::IoTSiteWise::AssetModelCompositeModel>] | ||
| 183 | |||
| 184 | The composite asset models that are part of this asset model. Composite | ||
| 185 | asset models are asset models that contain specific properties. Each | ||
| 186 | composite model has a type that defines the properties that the | ||
| 187 | composite model supports. Use composite asset models to define alarms | ||
| 188 | on this asset model. | ||
| 189 | |||
| 190 | |||
| 191 | |||
| 192 | =head2 AssetModelDescription => Str | ||
| 193 | |||
| 194 | A description for the asset model. | ||
| 195 | |||
| 196 | |||
| 197 | |||
| 198 | =head2 AssetModelHierarchies => ArrayRef[L<Paws::IoTSiteWise::AssetModelHierarchy>] | ||
| 199 | |||
| 200 | The updated hierarchy definitions of the asset model. Each hierarchy | ||
| 201 | specifies an asset model whose assets can be children of any other | ||
| 202 | assets created from this asset model. For more information, see Asset | ||
| 203 | hierarchies | ||
| 204 | (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html) | ||
| 205 | in the I<AWS IoT SiteWise User Guide>. | ||
| 206 | |||
| 207 | You can specify up to 10 hierarchies per asset model. For more | ||
| 208 | information, see Quotas | ||
| 209 | (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) | ||
| 210 | in the I<AWS IoT SiteWise User Guide>. | ||
| 211 | |||
| 212 | |||
| 213 | |||
| 214 | =head2 B<REQUIRED> AssetModelId => Str | ||
| 215 | |||
| 216 | The ID of the asset model to update. | ||
| 217 | |||
| 218 | |||
| 219 | |||
| 220 | =head2 B<REQUIRED> AssetModelName => Str | ||
| 221 | |||
| 222 | A unique, friendly name for the asset model. | ||
| 223 | |||
| 224 | |||
| 225 | |||
| 226 | =head2 AssetModelProperties => ArrayRef[L<Paws::IoTSiteWise::AssetModelProperty>] | ||
| 227 | |||
| 228 | The updated property definitions of the asset model. For more | ||
| 229 | information, see Asset properties | ||
| 230 | (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-properties.html) | ||
| 231 | in the I<AWS IoT SiteWise User Guide>. | ||
| 232 | |||
| 233 | You can specify up to 200 properties per asset model. For more | ||
| 234 | information, see Quotas | ||
| 235 | (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) | ||
| 236 | in the I<AWS IoT SiteWise User Guide>. | ||
| 237 | |||
| 238 | |||
| 239 | |||
| 240 | =head2 ClientToken => Str | ||
| 241 | |||
| 242 | A unique case-sensitive identifier that you can provide to ensure the | ||
| 243 | idempotency of the request. Don't reuse this client token if a new | ||
| 244 | idempotent request is required. | ||
| 245 | |||
| 246 | |||
| 247 | |||
| 248 | |||
| 249 | =head1 SEE ALSO | ||
| 250 | |||
| 251 | This class forms part of L<Paws>, documenting arguments for method UpdateAssetModel in L<Paws::IoTSiteWise> | ||
| 252 | |||
| 253 | =head1 BUGS and CONTRIBUTIONS | ||
| 254 | |||
| 255 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 256 | |||
| 257 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 258 | |||
| 259 | =cut | ||
| 260 |