1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658
|
// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
package iotjobsdataplane
import (
"fmt"
"github.com/aws/aws-sdk-go/aws"
"github.com/aws/aws-sdk-go/aws/awsutil"
"github.com/aws/aws-sdk-go/aws/request"
"github.com/aws/aws-sdk-go/private/protocol"
)
const opDescribeJobExecution = "DescribeJobExecution"
// DescribeJobExecutionRequest generates a "aws/request.Request" representing the
// client's request for the DescribeJobExecution operation. The "output" return
// value will be populated with the request's response once the request completes
// successfully.
//
// Use "Send" method on the returned Request to send the API call to the service.
// the "output" return value is not valid until after Send returns without error.
//
// See DescribeJobExecution for more information on using the DescribeJobExecution
// API call, and error handling.
//
// This method is useful when you want to inject custom logic or configuration
// into the SDK's request lifecycle. Such as custom headers, or retry logic.
//
// // Example sending a request using the DescribeJobExecutionRequest method.
// req, resp := client.DescribeJobExecutionRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/iot-jobs-data-2017-09-29/DescribeJobExecution
func (c *IoTJobsDataPlane) DescribeJobExecutionRequest(input *DescribeJobExecutionInput) (req *request.Request, output *DescribeJobExecutionOutput) {
op := &request.Operation{
Name: opDescribeJobExecution,
HTTPMethod: "GET",
HTTPPath: "/things/{thingName}/jobs/{jobId}",
}
if input == nil {
input = &DescribeJobExecutionInput{}
}
output = &DescribeJobExecutionOutput{}
req = c.newRequest(op, input, output)
return
}
// DescribeJobExecution API operation for AWS IoT Jobs Data Plane.
//
// Gets details of a job execution.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
// the error.
//
// See the AWS API reference guide for AWS IoT Jobs Data Plane's
// API operation DescribeJobExecution for usage and error information.
//
// Returned Error Types:
//
// - InvalidRequestException
// The contents of the request were invalid. For example, this code is returned
// when an UpdateJobExecution request contains invalid status details. The message
// contains details about the error.
//
// - ResourceNotFoundException
// The specified resource does not exist.
//
// - ThrottlingException
// The rate exceeds the limit.
//
// - ServiceUnavailableException
// The service is temporarily unavailable.
//
// - CertificateValidationException
// The certificate is invalid.
//
// - TerminalStateException
// The job is in a terminal state.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/iot-jobs-data-2017-09-29/DescribeJobExecution
func (c *IoTJobsDataPlane) DescribeJobExecution(input *DescribeJobExecutionInput) (*DescribeJobExecutionOutput, error) {
req, out := c.DescribeJobExecutionRequest(input)
return out, req.Send()
}
// DescribeJobExecutionWithContext is the same as DescribeJobExecution with the addition of
// the ability to pass a context and additional request options.
//
// See DescribeJobExecution for details on how to use this API operation.
//
// The context must be non-nil and will be used for request cancellation. If
// the context is nil a panic will occur. In the future the SDK may create
// sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *IoTJobsDataPlane) DescribeJobExecutionWithContext(ctx aws.Context, input *DescribeJobExecutionInput, opts ...request.Option) (*DescribeJobExecutionOutput, error) {
req, out := c.DescribeJobExecutionRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
const opGetPendingJobExecutions = "GetPendingJobExecutions"
// GetPendingJobExecutionsRequest generates a "aws/request.Request" representing the
// client's request for the GetPendingJobExecutions operation. The "output" return
// value will be populated with the request's response once the request completes
// successfully.
//
// Use "Send" method on the returned Request to send the API call to the service.
// the "output" return value is not valid until after Send returns without error.
//
// See GetPendingJobExecutions for more information on using the GetPendingJobExecutions
// API call, and error handling.
//
// This method is useful when you want to inject custom logic or configuration
// into the SDK's request lifecycle. Such as custom headers, or retry logic.
//
// // Example sending a request using the GetPendingJobExecutionsRequest method.
// req, resp := client.GetPendingJobExecutionsRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/iot-jobs-data-2017-09-29/GetPendingJobExecutions
func (c *IoTJobsDataPlane) GetPendingJobExecutionsRequest(input *GetPendingJobExecutionsInput) (req *request.Request, output *GetPendingJobExecutionsOutput) {
op := &request.Operation{
Name: opGetPendingJobExecutions,
HTTPMethod: "GET",
HTTPPath: "/things/{thingName}/jobs",
}
if input == nil {
input = &GetPendingJobExecutionsInput{}
}
output = &GetPendingJobExecutionsOutput{}
req = c.newRequest(op, input, output)
return
}
// GetPendingJobExecutions API operation for AWS IoT Jobs Data Plane.
//
// Gets the list of all jobs for a thing that are not in a terminal status.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
// the error.
//
// See the AWS API reference guide for AWS IoT Jobs Data Plane's
// API operation GetPendingJobExecutions for usage and error information.
//
// Returned Error Types:
//
// - InvalidRequestException
// The contents of the request were invalid. For example, this code is returned
// when an UpdateJobExecution request contains invalid status details. The message
// contains details about the error.
//
// - ResourceNotFoundException
// The specified resource does not exist.
//
// - ThrottlingException
// The rate exceeds the limit.
//
// - ServiceUnavailableException
// The service is temporarily unavailable.
//
// - CertificateValidationException
// The certificate is invalid.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/iot-jobs-data-2017-09-29/GetPendingJobExecutions
func (c *IoTJobsDataPlane) GetPendingJobExecutions(input *GetPendingJobExecutionsInput) (*GetPendingJobExecutionsOutput, error) {
req, out := c.GetPendingJobExecutionsRequest(input)
return out, req.Send()
}
// GetPendingJobExecutionsWithContext is the same as GetPendingJobExecutions with the addition of
// the ability to pass a context and additional request options.
//
// See GetPendingJobExecutions for details on how to use this API operation.
//
// The context must be non-nil and will be used for request cancellation. If
// the context is nil a panic will occur. In the future the SDK may create
// sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *IoTJobsDataPlane) GetPendingJobExecutionsWithContext(ctx aws.Context, input *GetPendingJobExecutionsInput, opts ...request.Option) (*GetPendingJobExecutionsOutput, error) {
req, out := c.GetPendingJobExecutionsRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
const opStartNextPendingJobExecution = "StartNextPendingJobExecution"
// StartNextPendingJobExecutionRequest generates a "aws/request.Request" representing the
// client's request for the StartNextPendingJobExecution operation. The "output" return
// value will be populated with the request's response once the request completes
// successfully.
//
// Use "Send" method on the returned Request to send the API call to the service.
// the "output" return value is not valid until after Send returns without error.
//
// See StartNextPendingJobExecution for more information on using the StartNextPendingJobExecution
// API call, and error handling.
//
// This method is useful when you want to inject custom logic or configuration
// into the SDK's request lifecycle. Such as custom headers, or retry logic.
//
// // Example sending a request using the StartNextPendingJobExecutionRequest method.
// req, resp := client.StartNextPendingJobExecutionRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/iot-jobs-data-2017-09-29/StartNextPendingJobExecution
func (c *IoTJobsDataPlane) StartNextPendingJobExecutionRequest(input *StartNextPendingJobExecutionInput) (req *request.Request, output *StartNextPendingJobExecutionOutput) {
op := &request.Operation{
Name: opStartNextPendingJobExecution,
HTTPMethod: "PUT",
HTTPPath: "/things/{thingName}/jobs/$next",
}
if input == nil {
input = &StartNextPendingJobExecutionInput{}
}
output = &StartNextPendingJobExecutionOutput{}
req = c.newRequest(op, input, output)
return
}
// StartNextPendingJobExecution API operation for AWS IoT Jobs Data Plane.
//
// Gets and starts the next pending (status IN_PROGRESS or QUEUED) job execution
// for a thing.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
// the error.
//
// See the AWS API reference guide for AWS IoT Jobs Data Plane's
// API operation StartNextPendingJobExecution for usage and error information.
//
// Returned Error Types:
//
// - InvalidRequestException
// The contents of the request were invalid. For example, this code is returned
// when an UpdateJobExecution request contains invalid status details. The message
// contains details about the error.
//
// - ResourceNotFoundException
// The specified resource does not exist.
//
// - ThrottlingException
// The rate exceeds the limit.
//
// - ServiceUnavailableException
// The service is temporarily unavailable.
//
// - CertificateValidationException
// The certificate is invalid.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/iot-jobs-data-2017-09-29/StartNextPendingJobExecution
func (c *IoTJobsDataPlane) StartNextPendingJobExecution(input *StartNextPendingJobExecutionInput) (*StartNextPendingJobExecutionOutput, error) {
req, out := c.StartNextPendingJobExecutionRequest(input)
return out, req.Send()
}
// StartNextPendingJobExecutionWithContext is the same as StartNextPendingJobExecution with the addition of
// the ability to pass a context and additional request options.
//
// See StartNextPendingJobExecution for details on how to use this API operation.
//
// The context must be non-nil and will be used for request cancellation. If
// the context is nil a panic will occur. In the future the SDK may create
// sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *IoTJobsDataPlane) StartNextPendingJobExecutionWithContext(ctx aws.Context, input *StartNextPendingJobExecutionInput, opts ...request.Option) (*StartNextPendingJobExecutionOutput, error) {
req, out := c.StartNextPendingJobExecutionRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
const opUpdateJobExecution = "UpdateJobExecution"
// UpdateJobExecutionRequest generates a "aws/request.Request" representing the
// client's request for the UpdateJobExecution operation. The "output" return
// value will be populated with the request's response once the request completes
// successfully.
//
// Use "Send" method on the returned Request to send the API call to the service.
// the "output" return value is not valid until after Send returns without error.
//
// See UpdateJobExecution for more information on using the UpdateJobExecution
// API call, and error handling.
//
// This method is useful when you want to inject custom logic or configuration
// into the SDK's request lifecycle. Such as custom headers, or retry logic.
//
// // Example sending a request using the UpdateJobExecutionRequest method.
// req, resp := client.UpdateJobExecutionRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/iot-jobs-data-2017-09-29/UpdateJobExecution
func (c *IoTJobsDataPlane) UpdateJobExecutionRequest(input *UpdateJobExecutionInput) (req *request.Request, output *UpdateJobExecutionOutput) {
op := &request.Operation{
Name: opUpdateJobExecution,
HTTPMethod: "POST",
HTTPPath: "/things/{thingName}/jobs/{jobId}",
}
if input == nil {
input = &UpdateJobExecutionInput{}
}
output = &UpdateJobExecutionOutput{}
req = c.newRequest(op, input, output)
return
}
// UpdateJobExecution API operation for AWS IoT Jobs Data Plane.
//
// Updates the status of a job execution.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
// the error.
//
// See the AWS API reference guide for AWS IoT Jobs Data Plane's
// API operation UpdateJobExecution for usage and error information.
//
// Returned Error Types:
//
// - InvalidRequestException
// The contents of the request were invalid. For example, this code is returned
// when an UpdateJobExecution request contains invalid status details. The message
// contains details about the error.
//
// - ResourceNotFoundException
// The specified resource does not exist.
//
// - ThrottlingException
// The rate exceeds the limit.
//
// - ServiceUnavailableException
// The service is temporarily unavailable.
//
// - CertificateValidationException
// The certificate is invalid.
//
// - InvalidStateTransitionException
// An update attempted to change the job execution to a state that is invalid
// because of the job execution's current state (for example, an attempt to
// change a request in state SUCCESS to state IN_PROGRESS). In this case, the
// body of the error message also contains the executionState field.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/iot-jobs-data-2017-09-29/UpdateJobExecution
func (c *IoTJobsDataPlane) UpdateJobExecution(input *UpdateJobExecutionInput) (*UpdateJobExecutionOutput, error) {
req, out := c.UpdateJobExecutionRequest(input)
return out, req.Send()
}
// UpdateJobExecutionWithContext is the same as UpdateJobExecution with the addition of
// the ability to pass a context and additional request options.
//
// See UpdateJobExecution for details on how to use this API operation.
//
// The context must be non-nil and will be used for request cancellation. If
// the context is nil a panic will occur. In the future the SDK may create
// sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *IoTJobsDataPlane) UpdateJobExecutionWithContext(ctx aws.Context, input *UpdateJobExecutionInput, opts ...request.Option) (*UpdateJobExecutionOutput, error) {
req, out := c.UpdateJobExecutionRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
// The certificate is invalid.
type CertificateValidationException struct {
_ struct{} `type:"structure"`
RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
// Additional information about the exception.
Message_ *string `locationName:"message" type:"string"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s CertificateValidationException) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s CertificateValidationException) GoString() string {
return s.String()
}
func newErrorCertificateValidationException(v protocol.ResponseMetadata) error {
return &CertificateValidationException{
RespMetadata: v,
}
}
// Code returns the exception type name.
func (s *CertificateValidationException) Code() string {
return "CertificateValidationException"
}
// Message returns the exception's message.
func (s *CertificateValidationException) Message() string {
if s.Message_ != nil {
return *s.Message_
}
return ""
}
// OrigErr always returns nil, satisfies awserr.Error interface.
func (s *CertificateValidationException) OrigErr() error {
return nil
}
func (s *CertificateValidationException) Error() string {
return fmt.Sprintf("%s: %s", s.Code(), s.Message())
}
// Status code returns the HTTP status code for the request's response error.
func (s *CertificateValidationException) StatusCode() int {
return s.RespMetadata.StatusCode
}
// RequestID returns the service's response RequestID for request.
func (s *CertificateValidationException) RequestID() string {
return s.RespMetadata.RequestID
}
type DescribeJobExecutionInput struct {
_ struct{} `type:"structure" nopayload:"true"`
// Optional. A number that identifies a particular job execution on a particular
// device. If not specified, the latest job execution is returned.
ExecutionNumber *int64 `location:"querystring" locationName:"executionNumber" type:"long"`
// Optional. When set to true, the response contains the job document. The default
// is false.
IncludeJobDocument *bool `location:"querystring" locationName:"includeJobDocument" type:"boolean"`
// The unique identifier assigned to this job when it was created.
//
// JobId is a required field
JobId *string `location:"uri" locationName:"jobId" type:"string" required:"true"`
// The thing name associated with the device the job execution is running on.
//
// ThingName is a required field
ThingName *string `location:"uri" locationName:"thingName" min:"1" type:"string" required:"true"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DescribeJobExecutionInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DescribeJobExecutionInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *DescribeJobExecutionInput) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "DescribeJobExecutionInput"}
if s.JobId == nil {
invalidParams.Add(request.NewErrParamRequired("JobId"))
}
if s.JobId != nil && len(*s.JobId) < 1 {
invalidParams.Add(request.NewErrParamMinLen("JobId", 1))
}
if s.ThingName == nil {
invalidParams.Add(request.NewErrParamRequired("ThingName"))
}
if s.ThingName != nil && len(*s.ThingName) < 1 {
invalidParams.Add(request.NewErrParamMinLen("ThingName", 1))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetExecutionNumber sets the ExecutionNumber field's value.
func (s *DescribeJobExecutionInput) SetExecutionNumber(v int64) *DescribeJobExecutionInput {
s.ExecutionNumber = &v
return s
}
// SetIncludeJobDocument sets the IncludeJobDocument field's value.
func (s *DescribeJobExecutionInput) SetIncludeJobDocument(v bool) *DescribeJobExecutionInput {
s.IncludeJobDocument = &v
return s
}
// SetJobId sets the JobId field's value.
func (s *DescribeJobExecutionInput) SetJobId(v string) *DescribeJobExecutionInput {
s.JobId = &v
return s
}
// SetThingName sets the ThingName field's value.
func (s *DescribeJobExecutionInput) SetThingName(v string) *DescribeJobExecutionInput {
s.ThingName = &v
return s
}
type DescribeJobExecutionOutput struct {
_ struct{} `type:"structure"`
// Contains data about a job execution.
Execution *JobExecution `locationName:"execution" type:"structure"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DescribeJobExecutionOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DescribeJobExecutionOutput) GoString() string {
return s.String()
}
// SetExecution sets the Execution field's value.
func (s *DescribeJobExecutionOutput) SetExecution(v *JobExecution) *DescribeJobExecutionOutput {
s.Execution = v
return s
}
type GetPendingJobExecutionsInput struct {
_ struct{} `type:"structure" nopayload:"true"`
// The name of the thing that is executing the job.
//
// ThingName is a required field
ThingName *string `location:"uri" locationName:"thingName" min:"1" type:"string" required:"true"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s GetPendingJobExecutionsInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s GetPendingJobExecutionsInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *GetPendingJobExecutionsInput) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "GetPendingJobExecutionsInput"}
if s.ThingName == nil {
invalidParams.Add(request.NewErrParamRequired("ThingName"))
}
if s.ThingName != nil && len(*s.ThingName) < 1 {
invalidParams.Add(request.NewErrParamMinLen("ThingName", 1))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetThingName sets the ThingName field's value.
func (s *GetPendingJobExecutionsInput) SetThingName(v string) *GetPendingJobExecutionsInput {
s.ThingName = &v
return s
}
type GetPendingJobExecutionsOutput struct {
_ struct{} `type:"structure"`
// A list of JobExecutionSummary objects with status IN_PROGRESS.
InProgressJobs []*JobExecutionSummary `locationName:"inProgressJobs" type:"list"`
// A list of JobExecutionSummary objects with status QUEUED.
QueuedJobs []*JobExecutionSummary `locationName:"queuedJobs" type:"list"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s GetPendingJobExecutionsOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s GetPendingJobExecutionsOutput) GoString() string {
return s.String()
}
// SetInProgressJobs sets the InProgressJobs field's value.
func (s *GetPendingJobExecutionsOutput) SetInProgressJobs(v []*JobExecutionSummary) *GetPendingJobExecutionsOutput {
s.InProgressJobs = v
return s
}
// SetQueuedJobs sets the QueuedJobs field's value.
func (s *GetPendingJobExecutionsOutput) SetQueuedJobs(v []*JobExecutionSummary) *GetPendingJobExecutionsOutput {
s.QueuedJobs = v
return s
}
// The contents of the request were invalid. For example, this code is returned
// when an UpdateJobExecution request contains invalid status details. The message
// contains details about the error.
type InvalidRequestException struct {
_ struct{} `type:"structure"`
RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
// The message for the exception.
Message_ *string `locationName:"message" type:"string"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s InvalidRequestException) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s InvalidRequestException) GoString() string {
return s.String()
}
func newErrorInvalidRequestException(v protocol.ResponseMetadata) error {
return &InvalidRequestException{
RespMetadata: v,
}
}
// Code returns the exception type name.
func (s *InvalidRequestException) Code() string {
return "InvalidRequestException"
}
// Message returns the exception's message.
func (s *InvalidRequestException) Message() string {
if s.Message_ != nil {
return *s.Message_
}
return ""
}
// OrigErr always returns nil, satisfies awserr.Error interface.
func (s *InvalidRequestException) OrigErr() error {
return nil
}
func (s *InvalidRequestException) Error() string {
return fmt.Sprintf("%s: %s", s.Code(), s.Message())
}
// Status code returns the HTTP status code for the request's response error.
func (s *InvalidRequestException) StatusCode() int {
return s.RespMetadata.StatusCode
}
// RequestID returns the service's response RequestID for request.
func (s *InvalidRequestException) RequestID() string {
return s.RespMetadata.RequestID
}
// An update attempted to change the job execution to a state that is invalid
// because of the job execution's current state (for example, an attempt to
// change a request in state SUCCESS to state IN_PROGRESS). In this case, the
// body of the error message also contains the executionState field.
type InvalidStateTransitionException struct {
_ struct{} `type:"structure"`
RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
Message_ *string `locationName:"message" type:"string"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s InvalidStateTransitionException) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s InvalidStateTransitionException) GoString() string {
return s.String()
}
func newErrorInvalidStateTransitionException(v protocol.ResponseMetadata) error {
return &InvalidStateTransitionException{
RespMetadata: v,
}
}
// Code returns the exception type name.
func (s *InvalidStateTransitionException) Code() string {
return "InvalidStateTransitionException"
}
// Message returns the exception's message.
func (s *InvalidStateTransitionException) Message() string {
if s.Message_ != nil {
return *s.Message_
}
return ""
}
// OrigErr always returns nil, satisfies awserr.Error interface.
func (s *InvalidStateTransitionException) OrigErr() error {
return nil
}
func (s *InvalidStateTransitionException) Error() string {
return fmt.Sprintf("%s: %s", s.Code(), s.Message())
}
// Status code returns the HTTP status code for the request's response error.
func (s *InvalidStateTransitionException) StatusCode() int {
return s.RespMetadata.StatusCode
}
// RequestID returns the service's response RequestID for request.
func (s *InvalidStateTransitionException) RequestID() string {
return s.RespMetadata.RequestID
}
// Contains data about a job execution.
type JobExecution struct {
_ struct{} `type:"structure"`
// The estimated number of seconds that remain before the job execution status
// will be changed to TIMED_OUT.
ApproximateSecondsBeforeTimedOut *int64 `locationName:"approximateSecondsBeforeTimedOut" type:"long"`
// A number that identifies a particular job execution on a particular device.
// It can be used later in commands that return or update job execution information.
ExecutionNumber *int64 `locationName:"executionNumber" type:"long"`
// The content of the job document.
JobDocument *string `locationName:"jobDocument" type:"string"`
// The unique identifier you assigned to this job when it was created.
JobId *string `locationName:"jobId" min:"1" type:"string"`
// The time, in milliseconds since the epoch, when the job execution was last
// updated.
LastUpdatedAt *int64 `locationName:"lastUpdatedAt" type:"long"`
// The time, in milliseconds since the epoch, when the job execution was enqueued.
QueuedAt *int64 `locationName:"queuedAt" type:"long"`
// The time, in milliseconds since the epoch, when the job execution was started.
StartedAt *int64 `locationName:"startedAt" type:"long"`
// The status of the job execution. Can be one of: "QUEUED", "IN_PROGRESS",
// "FAILED", "SUCCESS", "CANCELED", "REJECTED", or "REMOVED".
Status *string `locationName:"status" type:"string" enum:"JobExecutionStatus"`
// A collection of name/value pairs that describe the status of the job execution.
StatusDetails map[string]*string `locationName:"statusDetails" type:"map"`
// The name of the thing that is executing the job.
ThingName *string `locationName:"thingName" min:"1" type:"string"`
// The version of the job execution. Job execution versions are incremented
// each time they are updated by a device.
VersionNumber *int64 `locationName:"versionNumber" type:"long"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s JobExecution) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s JobExecution) GoString() string {
return s.String()
}
// SetApproximateSecondsBeforeTimedOut sets the ApproximateSecondsBeforeTimedOut field's value.
func (s *JobExecution) SetApproximateSecondsBeforeTimedOut(v int64) *JobExecution {
s.ApproximateSecondsBeforeTimedOut = &v
return s
}
// SetExecutionNumber sets the ExecutionNumber field's value.
func (s *JobExecution) SetExecutionNumber(v int64) *JobExecution {
s.ExecutionNumber = &v
return s
}
// SetJobDocument sets the JobDocument field's value.
func (s *JobExecution) SetJobDocument(v string) *JobExecution {
s.JobDocument = &v
return s
}
// SetJobId sets the JobId field's value.
func (s *JobExecution) SetJobId(v string) *JobExecution {
s.JobId = &v
return s
}
// SetLastUpdatedAt sets the LastUpdatedAt field's value.
func (s *JobExecution) SetLastUpdatedAt(v int64) *JobExecution {
s.LastUpdatedAt = &v
return s
}
// SetQueuedAt sets the QueuedAt field's value.
func (s *JobExecution) SetQueuedAt(v int64) *JobExecution {
s.QueuedAt = &v
return s
}
// SetStartedAt sets the StartedAt field's value.
func (s *JobExecution) SetStartedAt(v int64) *JobExecution {
s.StartedAt = &v
return s
}
// SetStatus sets the Status field's value.
func (s *JobExecution) SetStatus(v string) *JobExecution {
s.Status = &v
return s
}
// SetStatusDetails sets the StatusDetails field's value.
func (s *JobExecution) SetStatusDetails(v map[string]*string) *JobExecution {
s.StatusDetails = v
return s
}
// SetThingName sets the ThingName field's value.
func (s *JobExecution) SetThingName(v string) *JobExecution {
s.ThingName = &v
return s
}
// SetVersionNumber sets the VersionNumber field's value.
func (s *JobExecution) SetVersionNumber(v int64) *JobExecution {
s.VersionNumber = &v
return s
}
// Contains data about the state of a job execution.
type JobExecutionState struct {
_ struct{} `type:"structure"`
// The status of the job execution. Can be one of: "QUEUED", "IN_PROGRESS",
// "FAILED", "SUCCESS", "CANCELED", "REJECTED", or "REMOVED".
Status *string `locationName:"status" type:"string" enum:"JobExecutionStatus"`
// A collection of name/value pairs that describe the status of the job execution.
StatusDetails map[string]*string `locationName:"statusDetails" type:"map"`
// The version of the job execution. Job execution versions are incremented
// each time they are updated by a device.
VersionNumber *int64 `locationName:"versionNumber" type:"long"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s JobExecutionState) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s JobExecutionState) GoString() string {
return s.String()
}
// SetStatus sets the Status field's value.
func (s *JobExecutionState) SetStatus(v string) *JobExecutionState {
s.Status = &v
return s
}
// SetStatusDetails sets the StatusDetails field's value.
func (s *JobExecutionState) SetStatusDetails(v map[string]*string) *JobExecutionState {
s.StatusDetails = v
return s
}
// SetVersionNumber sets the VersionNumber field's value.
func (s *JobExecutionState) SetVersionNumber(v int64) *JobExecutionState {
s.VersionNumber = &v
return s
}
// Contains a subset of information about a job execution.
type JobExecutionSummary struct {
_ struct{} `type:"structure"`
// A number that identifies a particular job execution on a particular device.
ExecutionNumber *int64 `locationName:"executionNumber" type:"long"`
// The unique identifier you assigned to this job when it was created.
JobId *string `locationName:"jobId" min:"1" type:"string"`
// The time, in milliseconds since the epoch, when the job execution was last
// updated.
LastUpdatedAt *int64 `locationName:"lastUpdatedAt" type:"long"`
// The time, in milliseconds since the epoch, when the job execution was enqueued.
QueuedAt *int64 `locationName:"queuedAt" type:"long"`
// The time, in milliseconds since the epoch, when the job execution started.
StartedAt *int64 `locationName:"startedAt" type:"long"`
// The version of the job execution. Job execution versions are incremented
// each time AWS IoT Jobs receives an update from a device.
VersionNumber *int64 `locationName:"versionNumber" type:"long"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s JobExecutionSummary) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s JobExecutionSummary) GoString() string {
return s.String()
}
// SetExecutionNumber sets the ExecutionNumber field's value.
func (s *JobExecutionSummary) SetExecutionNumber(v int64) *JobExecutionSummary {
s.ExecutionNumber = &v
return s
}
// SetJobId sets the JobId field's value.
func (s *JobExecutionSummary) SetJobId(v string) *JobExecutionSummary {
s.JobId = &v
return s
}
// SetLastUpdatedAt sets the LastUpdatedAt field's value.
func (s *JobExecutionSummary) SetLastUpdatedAt(v int64) *JobExecutionSummary {
s.LastUpdatedAt = &v
return s
}
// SetQueuedAt sets the QueuedAt field's value.
func (s *JobExecutionSummary) SetQueuedAt(v int64) *JobExecutionSummary {
s.QueuedAt = &v
return s
}
// SetStartedAt sets the StartedAt field's value.
func (s *JobExecutionSummary) SetStartedAt(v int64) *JobExecutionSummary {
s.StartedAt = &v
return s
}
// SetVersionNumber sets the VersionNumber field's value.
func (s *JobExecutionSummary) SetVersionNumber(v int64) *JobExecutionSummary {
s.VersionNumber = &v
return s
}
// The specified resource does not exist.
type ResourceNotFoundException struct {
_ struct{} `type:"structure"`
RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
// The message for the exception.
Message_ *string `locationName:"message" type:"string"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s ResourceNotFoundException) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s ResourceNotFoundException) GoString() string {
return s.String()
}
func newErrorResourceNotFoundException(v protocol.ResponseMetadata) error {
return &ResourceNotFoundException{
RespMetadata: v,
}
}
// Code returns the exception type name.
func (s *ResourceNotFoundException) Code() string {
return "ResourceNotFoundException"
}
// Message returns the exception's message.
func (s *ResourceNotFoundException) Message() string {
if s.Message_ != nil {
return *s.Message_
}
return ""
}
// OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ResourceNotFoundException) OrigErr() error {
return nil
}
func (s *ResourceNotFoundException) Error() string {
return fmt.Sprintf("%s: %s", s.Code(), s.Message())
}
// Status code returns the HTTP status code for the request's response error.
func (s *ResourceNotFoundException) StatusCode() int {
return s.RespMetadata.StatusCode
}
// RequestID returns the service's response RequestID for request.
func (s *ResourceNotFoundException) RequestID() string {
return s.RespMetadata.RequestID
}
// The service is temporarily unavailable.
type ServiceUnavailableException struct {
_ struct{} `type:"structure"`
RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
// The message for the exception.
Message_ *string `locationName:"message" type:"string"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s ServiceUnavailableException) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s ServiceUnavailableException) GoString() string {
return s.String()
}
func newErrorServiceUnavailableException(v protocol.ResponseMetadata) error {
return &ServiceUnavailableException{
RespMetadata: v,
}
}
// Code returns the exception type name.
func (s *ServiceUnavailableException) Code() string {
return "ServiceUnavailableException"
}
// Message returns the exception's message.
func (s *ServiceUnavailableException) Message() string {
if s.Message_ != nil {
return *s.Message_
}
return ""
}
// OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ServiceUnavailableException) OrigErr() error {
return nil
}
func (s *ServiceUnavailableException) Error() string {
return fmt.Sprintf("%s: %s", s.Code(), s.Message())
}
// Status code returns the HTTP status code for the request's response error.
func (s *ServiceUnavailableException) StatusCode() int {
return s.RespMetadata.StatusCode
}
// RequestID returns the service's response RequestID for request.
func (s *ServiceUnavailableException) RequestID() string {
return s.RespMetadata.RequestID
}
type StartNextPendingJobExecutionInput struct {
_ struct{} `type:"structure"`
// A collection of name/value pairs that describe the status of the job execution.
// If not specified, the statusDetails are unchanged.
StatusDetails map[string]*string `locationName:"statusDetails" type:"map"`
// Specifies the amount of time this device has to finish execution of this
// job. If the job execution status is not set to a terminal state before this
// timer expires, or before the timer is reset (by calling UpdateJobExecution,
// setting the status to IN_PROGRESS and specifying a new timeout value in field
// stepTimeoutInMinutes) the job execution status will be automatically set
// to TIMED_OUT. Note that setting this timeout has no effect on that job execution
// timeout which may have been specified when the job was created (CreateJob
// using field timeoutConfig).
StepTimeoutInMinutes *int64 `locationName:"stepTimeoutInMinutes" type:"long"`
// The name of the thing associated with the device.
//
// ThingName is a required field
ThingName *string `location:"uri" locationName:"thingName" min:"1" type:"string" required:"true"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s StartNextPendingJobExecutionInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s StartNextPendingJobExecutionInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *StartNextPendingJobExecutionInput) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "StartNextPendingJobExecutionInput"}
if s.ThingName == nil {
invalidParams.Add(request.NewErrParamRequired("ThingName"))
}
if s.ThingName != nil && len(*s.ThingName) < 1 {
invalidParams.Add(request.NewErrParamMinLen("ThingName", 1))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetStatusDetails sets the StatusDetails field's value.
func (s *StartNextPendingJobExecutionInput) SetStatusDetails(v map[string]*string) *StartNextPendingJobExecutionInput {
s.StatusDetails = v
return s
}
// SetStepTimeoutInMinutes sets the StepTimeoutInMinutes field's value.
func (s *StartNextPendingJobExecutionInput) SetStepTimeoutInMinutes(v int64) *StartNextPendingJobExecutionInput {
s.StepTimeoutInMinutes = &v
return s
}
// SetThingName sets the ThingName field's value.
func (s *StartNextPendingJobExecutionInput) SetThingName(v string) *StartNextPendingJobExecutionInput {
s.ThingName = &v
return s
}
type StartNextPendingJobExecutionOutput struct {
_ struct{} `type:"structure"`
// A JobExecution object.
Execution *JobExecution `locationName:"execution" type:"structure"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s StartNextPendingJobExecutionOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s StartNextPendingJobExecutionOutput) GoString() string {
return s.String()
}
// SetExecution sets the Execution field's value.
func (s *StartNextPendingJobExecutionOutput) SetExecution(v *JobExecution) *StartNextPendingJobExecutionOutput {
s.Execution = v
return s
}
// The job is in a terminal state.
type TerminalStateException struct {
_ struct{} `type:"structure"`
RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
Message_ *string `locationName:"message" type:"string"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s TerminalStateException) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s TerminalStateException) GoString() string {
return s.String()
}
func newErrorTerminalStateException(v protocol.ResponseMetadata) error {
return &TerminalStateException{
RespMetadata: v,
}
}
// Code returns the exception type name.
func (s *TerminalStateException) Code() string {
return "TerminalStateException"
}
// Message returns the exception's message.
func (s *TerminalStateException) Message() string {
if s.Message_ != nil {
return *s.Message_
}
return ""
}
// OrigErr always returns nil, satisfies awserr.Error interface.
func (s *TerminalStateException) OrigErr() error {
return nil
}
func (s *TerminalStateException) Error() string {
return fmt.Sprintf("%s: %s", s.Code(), s.Message())
}
// Status code returns the HTTP status code for the request's response error.
func (s *TerminalStateException) StatusCode() int {
return s.RespMetadata.StatusCode
}
// RequestID returns the service's response RequestID for request.
func (s *TerminalStateException) RequestID() string {
return s.RespMetadata.RequestID
}
// The rate exceeds the limit.
type ThrottlingException struct {
_ struct{} `type:"structure"`
RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
// The message associated with the exception.
Message_ *string `locationName:"message" type:"string"`
// The payload associated with the exception.
// Payload is automatically base64 encoded/decoded by the SDK.
Payload []byte `locationName:"payload" type:"blob"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s ThrottlingException) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s ThrottlingException) GoString() string {
return s.String()
}
func newErrorThrottlingException(v protocol.ResponseMetadata) error {
return &ThrottlingException{
RespMetadata: v,
}
}
// Code returns the exception type name.
func (s *ThrottlingException) Code() string {
return "ThrottlingException"
}
// Message returns the exception's message.
func (s *ThrottlingException) Message() string {
if s.Message_ != nil {
return *s.Message_
}
return ""
}
// OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ThrottlingException) OrigErr() error {
return nil
}
func (s *ThrottlingException) Error() string {
return fmt.Sprintf("%s: %s\n%s", s.Code(), s.Message(), s.String())
}
// Status code returns the HTTP status code for the request's response error.
func (s *ThrottlingException) StatusCode() int {
return s.RespMetadata.StatusCode
}
// RequestID returns the service's response RequestID for request.
func (s *ThrottlingException) RequestID() string {
return s.RespMetadata.RequestID
}
type UpdateJobExecutionInput struct {
_ struct{} `type:"structure"`
// Optional. A number that identifies a particular job execution on a particular
// device.
ExecutionNumber *int64 `locationName:"executionNumber" type:"long"`
// Optional. The expected current version of the job execution. Each time you
// update the job execution, its version is incremented. If the version of the
// job execution stored in Jobs does not match, the update is rejected with
// a VersionMismatch error, and an ErrorResponse that contains the current job
// execution status data is returned. (This makes it unnecessary to perform
// a separate DescribeJobExecution request in order to obtain the job execution
// status data.)
ExpectedVersion *int64 `locationName:"expectedVersion" type:"long"`
// Optional. When set to true, the response contains the job document. The default
// is false.
IncludeJobDocument *bool `locationName:"includeJobDocument" type:"boolean"`
// Optional. When included and set to true, the response contains the JobExecutionState
// data. The default is false.
IncludeJobExecutionState *bool `locationName:"includeJobExecutionState" type:"boolean"`
// The unique identifier assigned to this job when it was created.
//
// JobId is a required field
JobId *string `location:"uri" locationName:"jobId" min:"1" type:"string" required:"true"`
// The new status for the job execution (IN_PROGRESS, FAILED, SUCCESS, or REJECTED).
// This must be specified on every update.
//
// Status is a required field
Status *string `locationName:"status" type:"string" required:"true" enum:"JobExecutionStatus"`
// Optional. A collection of name/value pairs that describe the status of the
// job execution. If not specified, the statusDetails are unchanged.
StatusDetails map[string]*string `locationName:"statusDetails" type:"map"`
// Specifies the amount of time this device has to finish execution of this
// job. If the job execution status is not set to a terminal state before this
// timer expires, or before the timer is reset (by again calling UpdateJobExecution,
// setting the status to IN_PROGRESS and specifying a new timeout value in this
// field) the job execution status will be automatically set to TIMED_OUT. Note
// that setting or resetting this timeout has no effect on that job execution
// timeout which may have been specified when the job was created (CreateJob
// using field timeoutConfig).
StepTimeoutInMinutes *int64 `locationName:"stepTimeoutInMinutes" type:"long"`
// The name of the thing associated with the device.
//
// ThingName is a required field
ThingName *string `location:"uri" locationName:"thingName" min:"1" type:"string" required:"true"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s UpdateJobExecutionInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s UpdateJobExecutionInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *UpdateJobExecutionInput) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "UpdateJobExecutionInput"}
if s.JobId == nil {
invalidParams.Add(request.NewErrParamRequired("JobId"))
}
if s.JobId != nil && len(*s.JobId) < 1 {
invalidParams.Add(request.NewErrParamMinLen("JobId", 1))
}
if s.Status == nil {
invalidParams.Add(request.NewErrParamRequired("Status"))
}
if s.ThingName == nil {
invalidParams.Add(request.NewErrParamRequired("ThingName"))
}
if s.ThingName != nil && len(*s.ThingName) < 1 {
invalidParams.Add(request.NewErrParamMinLen("ThingName", 1))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetExecutionNumber sets the ExecutionNumber field's value.
func (s *UpdateJobExecutionInput) SetExecutionNumber(v int64) *UpdateJobExecutionInput {
s.ExecutionNumber = &v
return s
}
// SetExpectedVersion sets the ExpectedVersion field's value.
func (s *UpdateJobExecutionInput) SetExpectedVersion(v int64) *UpdateJobExecutionInput {
s.ExpectedVersion = &v
return s
}
// SetIncludeJobDocument sets the IncludeJobDocument field's value.
func (s *UpdateJobExecutionInput) SetIncludeJobDocument(v bool) *UpdateJobExecutionInput {
s.IncludeJobDocument = &v
return s
}
// SetIncludeJobExecutionState sets the IncludeJobExecutionState field's value.
func (s *UpdateJobExecutionInput) SetIncludeJobExecutionState(v bool) *UpdateJobExecutionInput {
s.IncludeJobExecutionState = &v
return s
}
// SetJobId sets the JobId field's value.
func (s *UpdateJobExecutionInput) SetJobId(v string) *UpdateJobExecutionInput {
s.JobId = &v
return s
}
// SetStatus sets the Status field's value.
func (s *UpdateJobExecutionInput) SetStatus(v string) *UpdateJobExecutionInput {
s.Status = &v
return s
}
// SetStatusDetails sets the StatusDetails field's value.
func (s *UpdateJobExecutionInput) SetStatusDetails(v map[string]*string) *UpdateJobExecutionInput {
s.StatusDetails = v
return s
}
// SetStepTimeoutInMinutes sets the StepTimeoutInMinutes field's value.
func (s *UpdateJobExecutionInput) SetStepTimeoutInMinutes(v int64) *UpdateJobExecutionInput {
s.StepTimeoutInMinutes = &v
return s
}
// SetThingName sets the ThingName field's value.
func (s *UpdateJobExecutionInput) SetThingName(v string) *UpdateJobExecutionInput {
s.ThingName = &v
return s
}
type UpdateJobExecutionOutput struct {
_ struct{} `type:"structure"`
// A JobExecutionState object.
ExecutionState *JobExecutionState `locationName:"executionState" type:"structure"`
// The contents of the Job Documents.
JobDocument *string `locationName:"jobDocument" type:"string"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s UpdateJobExecutionOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s UpdateJobExecutionOutput) GoString() string {
return s.String()
}
// SetExecutionState sets the ExecutionState field's value.
func (s *UpdateJobExecutionOutput) SetExecutionState(v *JobExecutionState) *UpdateJobExecutionOutput {
s.ExecutionState = v
return s
}
// SetJobDocument sets the JobDocument field's value.
func (s *UpdateJobExecutionOutput) SetJobDocument(v string) *UpdateJobExecutionOutput {
s.JobDocument = &v
return s
}
const (
// JobExecutionStatusQueued is a JobExecutionStatus enum value
JobExecutionStatusQueued = "QUEUED"
// JobExecutionStatusInProgress is a JobExecutionStatus enum value
JobExecutionStatusInProgress = "IN_PROGRESS"
// JobExecutionStatusSucceeded is a JobExecutionStatus enum value
JobExecutionStatusSucceeded = "SUCCEEDED"
// JobExecutionStatusFailed is a JobExecutionStatus enum value
JobExecutionStatusFailed = "FAILED"
// JobExecutionStatusTimedOut is a JobExecutionStatus enum value
JobExecutionStatusTimedOut = "TIMED_OUT"
// JobExecutionStatusRejected is a JobExecutionStatus enum value
JobExecutionStatusRejected = "REJECTED"
// JobExecutionStatusRemoved is a JobExecutionStatus enum value
JobExecutionStatusRemoved = "REMOVED"
// JobExecutionStatusCanceled is a JobExecutionStatus enum value
JobExecutionStatusCanceled = "CANCELED"
)
// JobExecutionStatus_Values returns all elements of the JobExecutionStatus enum
func JobExecutionStatus_Values() []string {
return []string{
JobExecutionStatusQueued,
JobExecutionStatusInProgress,
JobExecutionStatusSucceeded,
JobExecutionStatusFailed,
JobExecutionStatusTimedOut,
JobExecutionStatusRejected,
JobExecutionStatusRemoved,
JobExecutionStatusCanceled,
}
}
|