« blib/lib/Paws/IoT/ReplaceDefaultPolicyVersionParams.pm
↑ Summary
blib/lib/Paws/IoT/RepublishAction.pm »
| 1 | |||
| 2 | package Paws::IoT::ReplaceTopicRule; | ||
| 3 | use Moose; | ||
| 4 | has RuleName => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'ruleName', required => 1); | ||
| 5 | has TopicRulePayload => (is => 'ro', isa => 'Paws::IoT::TopicRulePayload', traits => ['NameInRequest'], request_name => 'topicRulePayload', required => 1); | ||
| 6 | |||
| 7 | use MooseX::ClassAttribute; | ||
| 8 | class_has _stream_param => (is => 'ro', default => 'TopicRulePayload'); | ||
| 9 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ReplaceTopicRule'); | ||
| 10 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/rules/{ruleName}'); | ||
| 11 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'PATCH'); | ||
| 12 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::API::Response'); | ||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::IoT::ReplaceTopicRule - Arguments for method ReplaceTopicRule on L<Paws::IoT> | ||
| 20 | |||
| 21 | =head1 DESCRIPTION | ||
| 22 | |||
| 23 | This class represents the parameters used for calling the method ReplaceTopicRule on the | ||
| 24 | L<AWS IoT|Paws::IoT> service. Use the attributes of this class | ||
| 25 | as arguments to method ReplaceTopicRule. | ||
| 26 | |||
| 27 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ReplaceTopicRule. | ||
| 28 | |||
| 29 | =head1 SYNOPSIS | ||
| 30 | |||
| 31 | my $iot = Paws->service('IoT'); | ||
| 32 | $iot->ReplaceTopicRule( | ||
| 33 | RuleName => 'MyRuleName', | ||
| 34 | TopicRulePayload => { | ||
| 35 | Actions => [ | ||
| 36 | { | ||
| 37 | CloudwatchAlarm => { | ||
| 38 | AlarmName => 'MyAlarmName', | ||
| 39 | RoleArn => 'MyAwsArn', | ||
| 40 | StateReason => 'MyStateReason', | ||
| 41 | StateValue => 'MyStateValue', | ||
| 42 | |||
| 43 | }, # OPTIONAL | ||
| 44 | CloudwatchLogs => { | ||
| 45 | LogGroupName => 'MyLogGroupName', | ||
| 46 | RoleArn => 'MyAwsArn', | ||
| 47 | |||
| 48 | }, # OPTIONAL | ||
| 49 | CloudwatchMetric => { | ||
| 50 | MetricName => 'MyString', | ||
| 51 | MetricNamespace => 'MyString', | ||
| 52 | MetricUnit => 'MyString', | ||
| 53 | MetricValue => 'MyString', | ||
| 54 | RoleArn => 'MyAwsArn', | ||
| 55 | MetricTimestamp => 'MyString', | ||
| 56 | }, # OPTIONAL | ||
| 57 | DynamoDB => { | ||
| 58 | HashKeyField => 'MyHashKeyField', | ||
| 59 | HashKeyValue => 'MyHashKeyValue', | ||
| 60 | RoleArn => 'MyAwsArn', | ||
| 61 | TableName => 'MyTableName', | ||
| 62 | HashKeyType => 'STRING', # values: STRING, NUMBER; OPTIONAL | ||
| 63 | Operation => 'MyDynamoOperation', # OPTIONAL | ||
| 64 | PayloadField => 'MyPayloadField', # OPTIONAL | ||
| 65 | RangeKeyField => 'MyRangeKeyField', # OPTIONAL | ||
| 66 | RangeKeyType => 'STRING', # values: STRING, NUMBER; OPTIONAL | ||
| 67 | RangeKeyValue => 'MyRangeKeyValue', # OPTIONAL | ||
| 68 | }, # OPTIONAL | ||
| 69 | DynamoDBv2 => { | ||
| 70 | PutItem => { | ||
| 71 | TableName => 'MyTableName', | ||
| 72 | |||
| 73 | }, | ||
| 74 | RoleArn => 'MyAwsArn', | ||
| 75 | |||
| 76 | }, # OPTIONAL | ||
| 77 | Elasticsearch => { | ||
| 78 | Endpoint => 'MyElasticsearchEndpoint', | ||
| 79 | Id => 'MyElasticsearchId', | ||
| 80 | Index => 'MyElasticsearchIndex', | ||
| 81 | RoleArn => 'MyAwsArn', | ||
| 82 | Type => 'MyElasticsearchType', | ||
| 83 | |||
| 84 | }, # OPTIONAL | ||
| 85 | Firehose => { | ||
| 86 | DeliveryStreamName => 'MyDeliveryStreamName', | ||
| 87 | RoleArn => 'MyAwsArn', | ||
| 88 | BatchMode => 1, # OPTIONAL | ||
| 89 | Separator => 'MyFirehoseSeparator', # OPTIONAL | ||
| 90 | }, # OPTIONAL | ||
| 91 | Http => { | ||
| 92 | Url => 'MyUrl', # max: 2000 | ||
| 93 | Auth => { | ||
| 94 | Sigv4 => { | ||
| 95 | RoleArn => 'MyAwsArn', | ||
| 96 | ServiceName => 'MyServiceName', | ||
| 97 | SigningRegion => 'MySigningRegion', | ||
| 98 | |||
| 99 | }, # OPTIONAL | ||
| 100 | }, # OPTIONAL | ||
| 101 | ConfirmationUrl => 'MyUrl', # max: 2000 | ||
| 102 | Headers => [ | ||
| 103 | { | ||
| 104 | Key => 'MyHeaderKey', # min: 1, max: 256 | ||
| 105 | Value => 'MyHeaderValue', | ||
| 106 | |||
| 107 | }, | ||
| 108 | ... | ||
| 109 | ], # max: 100; OPTIONAL | ||
| 110 | }, # OPTIONAL | ||
| 111 | IotAnalytics => { | ||
| 112 | BatchMode => 1, # OPTIONAL | ||
| 113 | ChannelArn => 'MyAwsArn', | ||
| 114 | ChannelName => 'MyChannelName', # OPTIONAL | ||
| 115 | RoleArn => 'MyAwsArn', | ||
| 116 | }, # OPTIONAL | ||
| 117 | IotEvents => { | ||
| 118 | InputName => 'MyInputName', # min: 1, max: 128 | ||
| 119 | RoleArn => 'MyAwsArn', | ||
| 120 | BatchMode => 1, # OPTIONAL | ||
| 121 | MessageId => 'MyMessageId', # max: 128; OPTIONAL | ||
| 122 | }, # OPTIONAL | ||
| 123 | IotSiteWise => { | ||
| 124 | PutAssetPropertyValueEntries => [ | ||
| 125 | { | ||
| 126 | PropertyValues => [ | ||
| 127 | { | ||
| 128 | Timestamp => { | ||
| 129 | TimeInSeconds => 'MyAssetPropertyTimeInSeconds', | ||
| 130 | OffsetInNanos => | ||
| 131 | 'MyAssetPropertyOffsetInNanos', # OPTIONAL | ||
| 132 | }, | ||
| 133 | Value => { | ||
| 134 | BooleanValue => | ||
| 135 | 'MyAssetPropertyBooleanValue', # OPTIONAL | ||
| 136 | DoubleValue => 'MyAssetPropertyDoubleValue', # OPTIONAL | ||
| 137 | IntegerValue => | ||
| 138 | 'MyAssetPropertyIntegerValue', # OPTIONAL | ||
| 139 | StringValue => 'MyAssetPropertyStringValue' | ||
| 140 | , # min: 1, max: 1024; OPTIONAL | ||
| 141 | }, | ||
| 142 | Quality => 'MyAssetPropertyQuality', # OPTIONAL | ||
| 143 | }, | ||
| 144 | ... | ||
| 145 | ], # min: 1 | ||
| 146 | AssetId => 'MyAssetId', # OPTIONAL | ||
| 147 | EntryId => 'MyAssetPropertyEntryId', # OPTIONAL | ||
| 148 | PropertyAlias => 'MyAssetPropertyAlias', # min: 1; OPTIONAL | ||
| 149 | PropertyId => 'MyAssetPropertyId', # OPTIONAL | ||
| 150 | }, | ||
| 151 | ... | ||
| 152 | ], # min: 1 | ||
| 153 | RoleArn => 'MyAwsArn', | ||
| 154 | |||
| 155 | }, # OPTIONAL | ||
| 156 | Kafka => { | ||
| 157 | ClientProperties => { 'MyString' => 'MyString', }, | ||
| 158 | DestinationArn => 'MyAwsArn', | ||
| 159 | Topic => 'MyString', | ||
| 160 | Key => 'MyString', | ||
| 161 | Partition => 'MyString', | ||
| 162 | }, # OPTIONAL | ||
| 163 | Kinesis => { | ||
| 164 | RoleArn => 'MyAwsArn', | ||
| 165 | StreamName => 'MyStreamName', | ||
| 166 | PartitionKey => 'MyPartitionKey', # OPTIONAL | ||
| 167 | }, # OPTIONAL | ||
| 168 | Lambda => { | ||
| 169 | FunctionArn => 'MyFunctionArn', | ||
| 170 | |||
| 171 | }, # OPTIONAL | ||
| 172 | Republish => { | ||
| 173 | RoleArn => 'MyAwsArn', | ||
| 174 | Topic => 'MyTopicPattern', | ||
| 175 | Qos => 1, # max: 1; OPTIONAL | ||
| 176 | }, # OPTIONAL | ||
| 177 | S3 => { | ||
| 178 | BucketName => 'MyBucketName', | ||
| 179 | Key => 'MyKey', | ||
| 180 | RoleArn => 'MyAwsArn', | ||
| 181 | CannedAcl => 'private' | ||
| 182 | , # values: private, public-read, public-read-write, aws-exec-read, authenticated-read, bucket-owner-read, bucket-owner-full-control, log-delivery-write; OPTIONAL | ||
| 183 | }, # OPTIONAL | ||
| 184 | Salesforce => { | ||
| 185 | Token => 'MySalesforceToken', # min: 40 | ||
| 186 | Url => 'MySalesforceEndpoint', # max: 2000 | ||
| 187 | |||
| 188 | }, # OPTIONAL | ||
| 189 | Sns => { | ||
| 190 | RoleArn => 'MyAwsArn', | ||
| 191 | TargetArn => 'MyAwsArn', | ||
| 192 | MessageFormat => 'RAW', # values: RAW, JSON; OPTIONAL | ||
| 193 | }, # OPTIONAL | ||
| 194 | Sqs => { | ||
| 195 | QueueUrl => 'MyQueueUrl', | ||
| 196 | RoleArn => 'MyAwsArn', | ||
| 197 | UseBase64 => 1, # OPTIONAL | ||
| 198 | }, # OPTIONAL | ||
| 199 | StepFunctions => { | ||
| 200 | RoleArn => 'MyAwsArn', | ||
| 201 | StateMachineName => 'MyStateMachineName', | ||
| 202 | ExecutionNamePrefix => 'MyExecutionNamePrefix', # OPTIONAL | ||
| 203 | }, # OPTIONAL | ||
| 204 | Timestream => { | ||
| 205 | DatabaseName => 'MyTimestreamDatabaseName', | ||
| 206 | Dimensions => [ | ||
| 207 | { | ||
| 208 | Name => 'MyTimestreamDimensionName', | ||
| 209 | Value => 'MyTimestreamDimensionValue', | ||
| 210 | |||
| 211 | }, | ||
| 212 | ... | ||
| 213 | ], # min: 1, max: 128 | ||
| 214 | RoleArn => 'MyAwsArn', | ||
| 215 | TableName => 'MyTimestreamTableName', | ||
| 216 | Timestamp => { | ||
| 217 | Unit => 'MyTimestreamTimestampUnit', | ||
| 218 | Value => 'MyTimestreamTimestampValue', | ||
| 219 | |||
| 220 | }, # OPTIONAL | ||
| 221 | }, # OPTIONAL | ||
| 222 | }, | ||
| 223 | ... | ||
| 224 | ], # max: 10 | ||
| 225 | Sql => 'MySQL', | ||
| 226 | AwsIotSqlVersion => 'MyAwsIotSqlVersion', # OPTIONAL | ||
| 227 | Description => 'MyDescription', # OPTIONAL | ||
| 228 | ErrorAction => { | ||
| 229 | CloudwatchAlarm => { | ||
| 230 | AlarmName => 'MyAlarmName', | ||
| 231 | RoleArn => 'MyAwsArn', | ||
| 232 | StateReason => 'MyStateReason', | ||
| 233 | StateValue => 'MyStateValue', | ||
| 234 | |||
| 235 | }, # OPTIONAL | ||
| 236 | CloudwatchLogs => { | ||
| 237 | LogGroupName => 'MyLogGroupName', | ||
| 238 | RoleArn => 'MyAwsArn', | ||
| 239 | |||
| 240 | }, # OPTIONAL | ||
| 241 | CloudwatchMetric => { | ||
| 242 | MetricName => 'MyString', | ||
| 243 | MetricNamespace => 'MyString', | ||
| 244 | MetricUnit => 'MyString', | ||
| 245 | MetricValue => 'MyString', | ||
| 246 | RoleArn => 'MyAwsArn', | ||
| 247 | MetricTimestamp => 'MyString', | ||
| 248 | }, # OPTIONAL | ||
| 249 | DynamoDB => { | ||
| 250 | HashKeyField => 'MyHashKeyField', | ||
| 251 | HashKeyValue => 'MyHashKeyValue', | ||
| 252 | RoleArn => 'MyAwsArn', | ||
| 253 | TableName => 'MyTableName', | ||
| 254 | HashKeyType => 'STRING', # values: STRING, NUMBER; OPTIONAL | ||
| 255 | Operation => 'MyDynamoOperation', # OPTIONAL | ||
| 256 | PayloadField => 'MyPayloadField', # OPTIONAL | ||
| 257 | RangeKeyField => 'MyRangeKeyField', # OPTIONAL | ||
| 258 | RangeKeyType => 'STRING', # values: STRING, NUMBER; OPTIONAL | ||
| 259 | RangeKeyValue => 'MyRangeKeyValue', # OPTIONAL | ||
| 260 | }, # OPTIONAL | ||
| 261 | DynamoDBv2 => { | ||
| 262 | PutItem => { | ||
| 263 | TableName => 'MyTableName', | ||
| 264 | |||
| 265 | }, | ||
| 266 | RoleArn => 'MyAwsArn', | ||
| 267 | |||
| 268 | }, # OPTIONAL | ||
| 269 | Elasticsearch => { | ||
| 270 | Endpoint => 'MyElasticsearchEndpoint', | ||
| 271 | Id => 'MyElasticsearchId', | ||
| 272 | Index => 'MyElasticsearchIndex', | ||
| 273 | RoleArn => 'MyAwsArn', | ||
| 274 | Type => 'MyElasticsearchType', | ||
| 275 | |||
| 276 | }, # OPTIONAL | ||
| 277 | Firehose => { | ||
| 278 | DeliveryStreamName => 'MyDeliveryStreamName', | ||
| 279 | RoleArn => 'MyAwsArn', | ||
| 280 | BatchMode => 1, # OPTIONAL | ||
| 281 | Separator => 'MyFirehoseSeparator', # OPTIONAL | ||
| 282 | }, # OPTIONAL | ||
| 283 | Http => { | ||
| 284 | Url => 'MyUrl', # max: 2000 | ||
| 285 | Auth => { | ||
| 286 | Sigv4 => { | ||
| 287 | RoleArn => 'MyAwsArn', | ||
| 288 | ServiceName => 'MyServiceName', | ||
| 289 | SigningRegion => 'MySigningRegion', | ||
| 290 | |||
| 291 | }, # OPTIONAL | ||
| 292 | }, # OPTIONAL | ||
| 293 | ConfirmationUrl => 'MyUrl', # max: 2000 | ||
| 294 | Headers => [ | ||
| 295 | { | ||
| 296 | Key => 'MyHeaderKey', # min: 1, max: 256 | ||
| 297 | Value => 'MyHeaderValue', | ||
| 298 | |||
| 299 | }, | ||
| 300 | ... | ||
| 301 | ], # max: 100; OPTIONAL | ||
| 302 | }, # OPTIONAL | ||
| 303 | IotAnalytics => { | ||
| 304 | BatchMode => 1, # OPTIONAL | ||
| 305 | ChannelArn => 'MyAwsArn', | ||
| 306 | ChannelName => 'MyChannelName', # OPTIONAL | ||
| 307 | RoleArn => 'MyAwsArn', | ||
| 308 | }, # OPTIONAL | ||
| 309 | IotEvents => { | ||
| 310 | InputName => 'MyInputName', # min: 1, max: 128 | ||
| 311 | RoleArn => 'MyAwsArn', | ||
| 312 | BatchMode => 1, # OPTIONAL | ||
| 313 | MessageId => 'MyMessageId', # max: 128; OPTIONAL | ||
| 314 | }, # OPTIONAL | ||
| 315 | IotSiteWise => { | ||
| 316 | PutAssetPropertyValueEntries => [ | ||
| 317 | { | ||
| 318 | PropertyValues => [ | ||
| 319 | { | ||
| 320 | Timestamp => { | ||
| 321 | TimeInSeconds => 'MyAssetPropertyTimeInSeconds', | ||
| 322 | OffsetInNanos => | ||
| 323 | 'MyAssetPropertyOffsetInNanos', # OPTIONAL | ||
| 324 | }, | ||
| 325 | Value => { | ||
| 326 | BooleanValue => 'MyAssetPropertyBooleanValue', # OPTIONAL | ||
| 327 | DoubleValue => 'MyAssetPropertyDoubleValue', # OPTIONAL | ||
| 328 | IntegerValue => 'MyAssetPropertyIntegerValue', # OPTIONAL | ||
| 329 | StringValue => 'MyAssetPropertyStringValue' | ||
| 330 | , # min: 1, max: 1024; OPTIONAL | ||
| 331 | }, | ||
| 332 | Quality => 'MyAssetPropertyQuality', # OPTIONAL | ||
| 333 | }, | ||
| 334 | ... | ||
| 335 | ], # min: 1 | ||
| 336 | AssetId => 'MyAssetId', # OPTIONAL | ||
| 337 | EntryId => 'MyAssetPropertyEntryId', # OPTIONAL | ||
| 338 | PropertyAlias => 'MyAssetPropertyAlias', # min: 1; OPTIONAL | ||
| 339 | PropertyId => 'MyAssetPropertyId', # OPTIONAL | ||
| 340 | }, | ||
| 341 | ... | ||
| 342 | ], # min: 1 | ||
| 343 | RoleArn => 'MyAwsArn', | ||
| 344 | |||
| 345 | }, # OPTIONAL | ||
| 346 | Kafka => { | ||
| 347 | ClientProperties => { 'MyString' => 'MyString', }, | ||
| 348 | DestinationArn => 'MyAwsArn', | ||
| 349 | Topic => 'MyString', | ||
| 350 | Key => 'MyString', | ||
| 351 | Partition => 'MyString', | ||
| 352 | }, # OPTIONAL | ||
| 353 | Kinesis => { | ||
| 354 | RoleArn => 'MyAwsArn', | ||
| 355 | StreamName => 'MyStreamName', | ||
| 356 | PartitionKey => 'MyPartitionKey', # OPTIONAL | ||
| 357 | }, # OPTIONAL | ||
| 358 | Lambda => { | ||
| 359 | FunctionArn => 'MyFunctionArn', | ||
| 360 | |||
| 361 | }, # OPTIONAL | ||
| 362 | Republish => { | ||
| 363 | RoleArn => 'MyAwsArn', | ||
| 364 | Topic => 'MyTopicPattern', | ||
| 365 | Qos => 1, # max: 1; OPTIONAL | ||
| 366 | }, # OPTIONAL | ||
| 367 | S3 => { | ||
| 368 | BucketName => 'MyBucketName', | ||
| 369 | Key => 'MyKey', | ||
| 370 | RoleArn => 'MyAwsArn', | ||
| 371 | CannedAcl => 'private' | ||
| 372 | , # values: private, public-read, public-read-write, aws-exec-read, authenticated-read, bucket-owner-read, bucket-owner-full-control, log-delivery-write; OPTIONAL | ||
| 373 | }, # OPTIONAL | ||
| 374 | Salesforce => { | ||
| 375 | Token => 'MySalesforceToken', # min: 40 | ||
| 376 | Url => 'MySalesforceEndpoint', # max: 2000 | ||
| 377 | |||
| 378 | }, # OPTIONAL | ||
| 379 | Sns => { | ||
| 380 | RoleArn => 'MyAwsArn', | ||
| 381 | TargetArn => 'MyAwsArn', | ||
| 382 | MessageFormat => 'RAW', # values: RAW, JSON; OPTIONAL | ||
| 383 | }, # OPTIONAL | ||
| 384 | Sqs => { | ||
| 385 | QueueUrl => 'MyQueueUrl', | ||
| 386 | RoleArn => 'MyAwsArn', | ||
| 387 | UseBase64 => 1, # OPTIONAL | ||
| 388 | }, # OPTIONAL | ||
| 389 | StepFunctions => { | ||
| 390 | RoleArn => 'MyAwsArn', | ||
| 391 | StateMachineName => 'MyStateMachineName', | ||
| 392 | ExecutionNamePrefix => 'MyExecutionNamePrefix', # OPTIONAL | ||
| 393 | }, # OPTIONAL | ||
| 394 | Timestream => { | ||
| 395 | DatabaseName => 'MyTimestreamDatabaseName', | ||
| 396 | Dimensions => [ | ||
| 397 | { | ||
| 398 | Name => 'MyTimestreamDimensionName', | ||
| 399 | Value => 'MyTimestreamDimensionValue', | ||
| 400 | |||
| 401 | }, | ||
| 402 | ... | ||
| 403 | ], # min: 1, max: 128 | ||
| 404 | RoleArn => 'MyAwsArn', | ||
| 405 | TableName => 'MyTimestreamTableName', | ||
| 406 | Timestamp => { | ||
| 407 | Unit => 'MyTimestreamTimestampUnit', | ||
| 408 | Value => 'MyTimestreamTimestampValue', | ||
| 409 | |||
| 410 | }, # OPTIONAL | ||
| 411 | }, # OPTIONAL | ||
| 412 | }, | ||
| 413 | RuleDisabled => 1, # OPTIONAL | ||
| 414 | }, | ||
| 415 | |||
| 416 | ); | ||
| 417 | |||
| 418 | 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. | ||
| 419 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/iot/ReplaceTopicRule> | ||
| 420 | |||
| 421 | =head1 ATTRIBUTES | ||
| 422 | |||
| 423 | |||
| 424 | =head2 B<REQUIRED> RuleName => Str | ||
| 425 | |||
| 426 | The name of the rule. | ||
| 427 | |||
| 428 | |||
| 429 | |||
| 430 | =head2 B<REQUIRED> TopicRulePayload => L<Paws::IoT::TopicRulePayload> | ||
| 431 | |||
| 432 | The rule payload. | ||
| 433 | |||
| 434 | |||
| 435 | |||
| 436 | |||
| 437 | =head1 SEE ALSO | ||
| 438 | |||
| 439 | This class forms part of L<Paws>, documenting arguments for method ReplaceTopicRule in L<Paws::IoT> | ||
| 440 | |||
| 441 | =head1 BUGS and CONTRIBUTIONS | ||
| 442 | |||
| 443 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 444 | |||
| 445 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 446 | |||
| 447 | =cut | ||
| 448 |