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
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package types
import (
smithydocument "github.com/aws/smithy-go/document"
"time"
)
// Contains details about an activity that failed during an execution.
type ActivityFailedEventDetails struct {
// A more detailed explanation of the cause of the failure.
Cause *string
// The error code of the failure.
Error *string
noSmithyDocumentSerde
}
// Contains details about an activity.
type ActivityListItem struct {
// The Amazon Resource Name (ARN) that identifies the activity.
//
// This member is required.
ActivityArn *string
// The date the activity is created.
//
// This member is required.
CreationDate *time.Time
// The name of the activity. A name must not contain:
// - white space
// - brackets < > { } [ ]
// - wildcard characters ? *
// - special characters " # % \ ^ | ~ ` $ & , ; : /
// - control characters ( U+0000-001F , U+007F-009F )
// To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z,
// a-z, - and _.
//
// This member is required.
Name *string
noSmithyDocumentSerde
}
// Contains details about an activity scheduled during an execution.
type ActivityScheduledEventDetails struct {
// The Amazon Resource Name (ARN) of the scheduled activity.
//
// This member is required.
Resource *string
// The maximum allowed duration between two heartbeats for the activity task.
HeartbeatInSeconds *int64
// The JSON data input to the activity task. Length constraints apply to the
// payload size, and are expressed as bytes in UTF-8 encoding.
Input *string
// Contains details about the input for an execution history event.
InputDetails *HistoryEventExecutionDataDetails
// The maximum allowed duration of the activity task.
TimeoutInSeconds *int64
noSmithyDocumentSerde
}
// Contains details about an activity schedule failure that occurred during an
// execution.
type ActivityScheduleFailedEventDetails struct {
// A more detailed explanation of the cause of the failure.
Cause *string
// The error code of the failure.
Error *string
noSmithyDocumentSerde
}
// Contains details about the start of an activity during an execution.
type ActivityStartedEventDetails struct {
// The name of the worker that the task is assigned to. These names are provided
// by the workers when calling GetActivityTask .
WorkerName *string
noSmithyDocumentSerde
}
// Contains details about an activity that successfully terminated during an
// execution.
type ActivitySucceededEventDetails struct {
// The JSON data output by the activity task. Length constraints apply to the
// payload size, and are expressed as bytes in UTF-8 encoding.
Output *string
// Contains details about the output of an execution history event.
OutputDetails *HistoryEventExecutionDataDetails
noSmithyDocumentSerde
}
// Contains details about an activity timeout that occurred during an execution.
type ActivityTimedOutEventDetails struct {
// A more detailed explanation of the cause of the timeout.
Cause *string
// The error code of the failure.
Error *string
noSmithyDocumentSerde
}
// An object that describes workflow billing details.
type BillingDetails struct {
// Billed duration of your workflow, in milliseconds.
BilledDurationInMilliseconds int64
// Billed memory consumption of your workflow, in MB.
BilledMemoryUsedInMB int64
noSmithyDocumentSerde
}
// Provides details about execution input or output.
type CloudWatchEventsExecutionDataDetails struct {
// Indicates whether input or output was included in the response. Always true for
// API calls.
Included bool
noSmithyDocumentSerde
}
type CloudWatchLogsLogGroup struct {
// The ARN of the the CloudWatch log group to which you want your logs emitted to.
// The ARN must end with :*
LogGroupArn *string
noSmithyDocumentSerde
}
// Contains details about an abort of an execution.
type ExecutionAbortedEventDetails struct {
// A more detailed explanation of the cause of the failure.
Cause *string
// The error code of the failure.
Error *string
noSmithyDocumentSerde
}
// Contains details about an execution failure event.
type ExecutionFailedEventDetails struct {
// A more detailed explanation of the cause of the failure.
Cause *string
// The error code of the failure.
Error *string
noSmithyDocumentSerde
}
// Contains details about an execution.
type ExecutionListItem struct {
// The Amazon Resource Name (ARN) that identifies the execution.
//
// This member is required.
ExecutionArn *string
// The name of the execution. A name must not contain:
// - white space
// - brackets < > { } [ ]
// - wildcard characters ? *
// - special characters " # % \ ^ | ~ ` $ & , ; : /
// - control characters ( U+0000-001F , U+007F-009F )
// To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z,
// a-z, - and _.
//
// This member is required.
Name *string
// The date the execution started.
//
// This member is required.
StartDate *time.Time
// The Amazon Resource Name (ARN) of the state machine that ran the execution.
//
// This member is required.
StateMachineArn *string
// The current status of the execution.
//
// This member is required.
Status ExecutionStatus
// The total number of items processed in a child workflow execution. This field
// is returned only if mapRunArn was specified in the ListExecutions API action.
// If stateMachineArn was specified in ListExecutions , the itemCount field isn't
// returned.
ItemCount *int32
// The Amazon Resource Name (ARN) of a Map Run. This field is returned only if
// mapRunArn was specified in the ListExecutions API action. If stateMachineArn
// was specified in ListExecutions , the mapRunArn isn't returned.
MapRunArn *string
// The number of times you've redriven an execution. If you have not yet redriven
// an execution, the redriveCount is 0. This count is only updated when you
// successfully redrive an execution.
RedriveCount *int32
// The date the execution was last redriven.
RedriveDate *time.Time
// The Amazon Resource Name (ARN) of the state machine alias used to start an
// execution. If the state machine execution was started with an unqualified ARN or
// a version ARN, it returns null.
StateMachineAliasArn *string
// The Amazon Resource Name (ARN) of the state machine version associated with the
// execution. If the state machine execution was started with an unqualified ARN,
// it returns null. If the execution was started using a stateMachineAliasArn ,
// both the stateMachineAliasArn and stateMachineVersionArn parameters contain the
// respective values.
StateMachineVersionArn *string
// If the execution already ended, the date the execution stopped.
StopDate *time.Time
noSmithyDocumentSerde
}
// Contains details about a redriven execution.
type ExecutionRedrivenEventDetails struct {
// The number of times you've redriven an execution. If you have not yet redriven
// an execution, the redriveCount is 0. This count is not updated for redrives
// that failed to start or are pending to be redriven.
RedriveCount *int32
noSmithyDocumentSerde
}
// Contains details about the start of the execution.
type ExecutionStartedEventDetails struct {
// The JSON data input to the execution. Length constraints apply to the payload
// size, and are expressed as bytes in UTF-8 encoding.
Input *string
// Contains details about the input for an execution history event.
InputDetails *HistoryEventExecutionDataDetails
// The Amazon Resource Name (ARN) of the IAM role used for executing Lambda tasks.
RoleArn *string
// The Amazon Resource Name (ARN) that identifies a state machine alias used for
// starting the state machine execution.
StateMachineAliasArn *string
// The Amazon Resource Name (ARN) that identifies a state machine version used for
// starting the state machine execution.
StateMachineVersionArn *string
noSmithyDocumentSerde
}
// Contains details about the successful termination of the execution.
type ExecutionSucceededEventDetails struct {
// The JSON data output by the execution. Length constraints apply to the payload
// size, and are expressed as bytes in UTF-8 encoding.
Output *string
// Contains details about the output of an execution history event.
OutputDetails *HistoryEventExecutionDataDetails
noSmithyDocumentSerde
}
// Contains details about the execution timeout that occurred during the execution.
type ExecutionTimedOutEventDetails struct {
// A more detailed explanation of the cause of the timeout.
Cause *string
// The error code of the failure.
Error *string
noSmithyDocumentSerde
}
// Contains details about the events of an execution.
type HistoryEvent struct {
// The id of the event. Events are numbered sequentially, starting at one.
//
// This member is required.
Id int64
// The date and time the event occurred.
//
// This member is required.
Timestamp *time.Time
// The type of the event.
//
// This member is required.
Type HistoryEventType
// Contains details about an activity that failed during an execution.
ActivityFailedEventDetails *ActivityFailedEventDetails
// Contains details about an activity schedule event that failed during an
// execution.
ActivityScheduleFailedEventDetails *ActivityScheduleFailedEventDetails
// Contains details about an activity scheduled during an execution.
ActivityScheduledEventDetails *ActivityScheduledEventDetails
// Contains details about the start of an activity during an execution.
ActivityStartedEventDetails *ActivityStartedEventDetails
// Contains details about an activity that successfully terminated during an
// execution.
ActivitySucceededEventDetails *ActivitySucceededEventDetails
// Contains details about an activity timeout that occurred during an execution.
ActivityTimedOutEventDetails *ActivityTimedOutEventDetails
// Contains details about an abort of an execution.
ExecutionAbortedEventDetails *ExecutionAbortedEventDetails
// Contains details about an execution failure event.
ExecutionFailedEventDetails *ExecutionFailedEventDetails
// Contains details about the redrive attempt of an execution.
ExecutionRedrivenEventDetails *ExecutionRedrivenEventDetails
// Contains details about the start of the execution.
ExecutionStartedEventDetails *ExecutionStartedEventDetails
// Contains details about the successful termination of the execution.
ExecutionSucceededEventDetails *ExecutionSucceededEventDetails
// Contains details about the execution timeout that occurred during the execution.
ExecutionTimedOutEventDetails *ExecutionTimedOutEventDetails
// Contains details about a Lambda function that failed during an execution.
LambdaFunctionFailedEventDetails *LambdaFunctionFailedEventDetails
// Contains details about a failed Lambda function schedule event that occurred
// during an execution.
LambdaFunctionScheduleFailedEventDetails *LambdaFunctionScheduleFailedEventDetails
// Contains details about a Lambda function scheduled during an execution.
LambdaFunctionScheduledEventDetails *LambdaFunctionScheduledEventDetails
// Contains details about a lambda function that failed to start during an
// execution.
LambdaFunctionStartFailedEventDetails *LambdaFunctionStartFailedEventDetails
// Contains details about a Lambda function that terminated successfully during an
// execution.
LambdaFunctionSucceededEventDetails *LambdaFunctionSucceededEventDetails
// Contains details about a Lambda function timeout that occurred during an
// execution.
LambdaFunctionTimedOutEventDetails *LambdaFunctionTimedOutEventDetails
// Contains details about an iteration of a Map state that was aborted.
MapIterationAbortedEventDetails *MapIterationEventDetails
// Contains details about an iteration of a Map state that failed.
MapIterationFailedEventDetails *MapIterationEventDetails
// Contains details about an iteration of a Map state that was started.
MapIterationStartedEventDetails *MapIterationEventDetails
// Contains details about an iteration of a Map state that succeeded.
MapIterationSucceededEventDetails *MapIterationEventDetails
// Contains error and cause details about a Map Run that failed.
MapRunFailedEventDetails *MapRunFailedEventDetails
// Contains details about the redrive attempt of a Map Run.
MapRunRedrivenEventDetails *MapRunRedrivenEventDetails
// Contains details, such as mapRunArn , and the start date and time of a Map Run.
// mapRunArn is the Amazon Resource Name (ARN) of the Map Run that was started.
MapRunStartedEventDetails *MapRunStartedEventDetails
// Contains details about Map state that was started.
MapStateStartedEventDetails *MapStateStartedEventDetails
// The id of the previous event.
PreviousEventId int64
// Contains details about a state entered during an execution.
StateEnteredEventDetails *StateEnteredEventDetails
// Contains details about an exit from a state during an execution.
StateExitedEventDetails *StateExitedEventDetails
// Contains details about the failure of a task.
TaskFailedEventDetails *TaskFailedEventDetails
// Contains details about a task that was scheduled.
TaskScheduledEventDetails *TaskScheduledEventDetails
// Contains details about a task that failed to start.
TaskStartFailedEventDetails *TaskStartFailedEventDetails
// Contains details about a task that was started.
TaskStartedEventDetails *TaskStartedEventDetails
// Contains details about a task that where the submit failed.
TaskSubmitFailedEventDetails *TaskSubmitFailedEventDetails
// Contains details about a submitted task.
TaskSubmittedEventDetails *TaskSubmittedEventDetails
// Contains details about a task that succeeded.
TaskSucceededEventDetails *TaskSucceededEventDetails
// Contains details about a task that timed out.
TaskTimedOutEventDetails *TaskTimedOutEventDetails
noSmithyDocumentSerde
}
// Provides details about input or output in an execution history event.
type HistoryEventExecutionDataDetails struct {
// Indicates whether input or output was truncated in the response. Always false
// for API calls.
Truncated bool
noSmithyDocumentSerde
}
// Contains additional details about the state's execution, including its input
// and output data processing flow, and HTTP request and response information.
type InspectionData struct {
// The input after Step Functions applies the InputPath (https://docs.aws.amazon.com/step-functions/latest/dg/input-output-inputpath-params.html#input-output-inputpath)
// filter.
AfterInputPath *string
// The effective input after Step Functions applies the Parameters (https://docs.aws.amazon.com/step-functions/latest/dg/input-output-inputpath-params.html#input-output-parameters)
// filter.
AfterParameters *string
// The effective result combined with the raw state input after Step Functions
// applies the ResultPath (https://docs.aws.amazon.com/step-functions/latest/dg/input-output-resultpath.html)
// filter.
AfterResultPath *string
// The effective result after Step Functions applies the ResultSelector (https://docs.aws.amazon.com/step-functions/latest/dg/input-output-inputpath-params.html#input-output-resultselector)
// filter.
AfterResultSelector *string
// The raw state input.
Input *string
// The raw HTTP request that is sent when you test an HTTP Task.
Request *InspectionDataRequest
// The raw HTTP response that is returned when you test an HTTP Task.
Response *InspectionDataResponse
// The state's raw result.
Result *string
noSmithyDocumentSerde
}
// Contains additional details about the state's execution, including its input
// and output data processing flow, and HTTP request information.
type InspectionDataRequest struct {
// The request body for the HTTP request.
Body *string
// The request headers associated with the HTTP request.
Headers *string
// The HTTP method used for the HTTP request.
Method *string
// The protocol used to make the HTTP request.
Protocol *string
// The API endpoint used for the HTTP request.
Url *string
noSmithyDocumentSerde
}
// Contains additional details about the state's execution, including its input
// and output data processing flow, and HTTP response information. The
// inspectionLevel request parameter specifies which details are returned.
type InspectionDataResponse struct {
// The HTTP response returned.
Body *string
// The response headers associated with the HTTP response.
Headers *string
// The protocol used to return the HTTP response.
Protocol *string
// The HTTP response status code for the HTTP response.
StatusCode *string
// The message associated with the HTTP status code.
StatusMessage *string
noSmithyDocumentSerde
}
// Contains details about a Lambda function that failed during an execution.
type LambdaFunctionFailedEventDetails struct {
// A more detailed explanation of the cause of the failure.
Cause *string
// The error code of the failure.
Error *string
noSmithyDocumentSerde
}
// Contains details about a Lambda function scheduled during an execution.
type LambdaFunctionScheduledEventDetails struct {
// The Amazon Resource Name (ARN) of the scheduled Lambda function.
//
// This member is required.
Resource *string
// The JSON data input to the Lambda function. Length constraints apply to the
// payload size, and are expressed as bytes in UTF-8 encoding.
Input *string
// Contains details about input for an execution history event.
InputDetails *HistoryEventExecutionDataDetails
// The credentials that Step Functions uses for the task.
TaskCredentials *TaskCredentials
// The maximum allowed duration of the Lambda function.
TimeoutInSeconds *int64
noSmithyDocumentSerde
}
// Contains details about a failed Lambda function schedule event that occurred
// during an execution.
type LambdaFunctionScheduleFailedEventDetails struct {
// A more detailed explanation of the cause of the failure.
Cause *string
// The error code of the failure.
Error *string
noSmithyDocumentSerde
}
// Contains details about a lambda function that failed to start during an
// execution.
type LambdaFunctionStartFailedEventDetails struct {
// A more detailed explanation of the cause of the failure.
Cause *string
// The error code of the failure.
Error *string
noSmithyDocumentSerde
}
// Contains details about a Lambda function that successfully terminated during an
// execution.
type LambdaFunctionSucceededEventDetails struct {
// The JSON data output by the Lambda function. Length constraints apply to the
// payload size, and are expressed as bytes in UTF-8 encoding.
Output *string
// Contains details about the output of an execution history event.
OutputDetails *HistoryEventExecutionDataDetails
noSmithyDocumentSerde
}
// Contains details about a Lambda function timeout that occurred during an
// execution.
type LambdaFunctionTimedOutEventDetails struct {
// A more detailed explanation of the cause of the timeout.
Cause *string
// The error code of the failure.
Error *string
noSmithyDocumentSerde
}
type LogDestination struct {
// An object describing a CloudWatch log group. For more information, see
// AWS::Logs::LogGroup (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loggroup.html)
// in the CloudFormation User Guide.
CloudWatchLogsLogGroup *CloudWatchLogsLogGroup
noSmithyDocumentSerde
}
// The LoggingConfiguration data type is used to set CloudWatch Logs options.
type LoggingConfiguration struct {
// An array of objects that describes where your execution history events will be
// logged. Limited to size 1. Required, if your log level is not set to OFF .
Destinations []LogDestination
// Determines whether execution data is included in your log. When set to false ,
// data is excluded.
IncludeExecutionData bool
// Defines which category of execution history events are logged.
Level LogLevel
noSmithyDocumentSerde
}
// Contains details about an iteration of a Map state.
type MapIterationEventDetails struct {
// The index of the array belonging to the Map state iteration.
Index int32
// The name of the iteration’s parent Map state.
Name *string
noSmithyDocumentSerde
}
// Contains details about all of the child workflow executions started by a Map
// Run.
type MapRunExecutionCounts struct {
// The total number of child workflow executions that were started by a Map Run
// and were running, but were either stopped by the user or by Step Functions
// because the Map Run failed.
//
// This member is required.
Aborted int64
// The total number of child workflow executions that were started by a Map Run,
// but have failed.
//
// This member is required.
Failed int64
// The total number of child workflow executions that were started by a Map Run,
// but haven't started executing yet.
//
// This member is required.
Pending int64
// Returns the count of child workflow executions whose results were written by
// ResultWriter . For more information, see ResultWriter (https://docs.aws.amazon.com/step-functions/latest/dg/input-output-resultwriter.html)
// in the Step Functions Developer Guide.
//
// This member is required.
ResultsWritten int64
// The total number of child workflow executions that were started by a Map Run
// and are currently in-progress.
//
// This member is required.
Running int64
// The total number of child workflow executions that were started by a Map Run
// and have completed successfully.
//
// This member is required.
Succeeded int64
// The total number of child workflow executions that were started by a Map Run
// and have timed out.
//
// This member is required.
TimedOut int64
// The total number of child workflow executions that were started by a Map Run.
//
// This member is required.
Total int64
// The number of FAILED , ABORTED , or TIMED_OUT child workflow executions that
// cannot be redriven because their execution status is terminal. For example,
// child workflows with an execution status of FAILED , ABORTED , or TIMED_OUT and
// a redriveStatus of NOT_REDRIVABLE .
FailuresNotRedrivable *int64
// The number of unsuccessful child workflow executions currently waiting to be
// redriven. The status of these child workflow executions could be FAILED ,
// ABORTED , or TIMED_OUT in the original execution attempt or a previous redrive
// attempt.
PendingRedrive *int64
noSmithyDocumentSerde
}
// Contains details about a Map Run failure event that occurred during a state
// machine execution.
type MapRunFailedEventDetails struct {
// A more detailed explanation of the cause of the failure.
Cause *string
// The error code of the Map Run failure.
Error *string
noSmithyDocumentSerde
}
// Contains details about items that were processed in all of the child workflow
// executions that were started by a Map Run.
type MapRunItemCounts struct {
// The total number of items processed in child workflow executions that were
// either stopped by the user or by Step Functions, because the Map Run failed.
//
// This member is required.
Aborted int64
// The total number of items processed in child workflow executions that have
// failed.
//
// This member is required.
Failed int64
// The total number of items to process in child workflow executions that haven't
// started running yet.
//
// This member is required.
Pending int64
// Returns the count of items whose results were written by ResultWriter . For more
// information, see ResultWriter (https://docs.aws.amazon.com/step-functions/latest/dg/input-output-resultwriter.html)
// in the Step Functions Developer Guide.
//
// This member is required.
ResultsWritten int64
// The total number of items being processed in child workflow executions that are
// currently in-progress.
//
// This member is required.
Running int64
// The total number of items processed in child workflow executions that have
// completed successfully.
//
// This member is required.
Succeeded int64
// The total number of items processed in child workflow executions that have
// timed out.
//
// This member is required.
TimedOut int64
// The total number of items processed in all the child workflow executions
// started by a Map Run.
//
// This member is required.
Total int64
// The number of FAILED , ABORTED , or TIMED_OUT items in child workflow
// executions that cannot be redriven because the execution status of those child
// workflows is terminal. For example, child workflows with an execution status of
// FAILED , ABORTED , or TIMED_OUT and a redriveStatus of NOT_REDRIVABLE .
FailuresNotRedrivable *int64
// The number of unsuccessful items in child workflow executions currently waiting
// to be redriven.
PendingRedrive *int64
noSmithyDocumentSerde
}
// Contains details about a specific Map Run.
type MapRunListItem struct {
// The executionArn of the execution from which the Map Run was started.
//
// This member is required.
ExecutionArn *string
// The Amazon Resource Name (ARN) of the Map Run.
//
// This member is required.
MapRunArn *string
// The date on which the Map Run started.
//
// This member is required.
StartDate *time.Time
// The Amazon Resource Name (ARN) of the executed state machine.
//
// This member is required.
StateMachineArn *string
// The date on which the Map Run stopped.
StopDate *time.Time
noSmithyDocumentSerde
}
// Contains details about a Map Run that was redriven.
type MapRunRedrivenEventDetails struct {
// The Amazon Resource Name (ARN) of a Map Run that was redriven.
MapRunArn *string
// The number of times the Map Run has been redriven at this point in the
// execution's history including this event. The redrive count for a redriven Map
// Run is always greater than 0.
RedriveCount *int32
noSmithyDocumentSerde
}
// Contains details about a Map Run that was started during a state machine
// execution.
type MapRunStartedEventDetails struct {
// The Amazon Resource Name (ARN) of a Map Run that was started.
MapRunArn *string
noSmithyDocumentSerde
}
// Details about a Map state that was started.
type MapStateStartedEventDetails struct {
// The size of the array for Map state iterations.
Length int32
noSmithyDocumentSerde
}
// Contains details about the routing configuration of a state machine alias. In a
// routing configuration, you define an array of objects that specify up to two
// state machine versions. You also specify the percentage of traffic to be routed
// to each version.
type RoutingConfigurationListItem struct {
// The Amazon Resource Name (ARN) that identifies one or two state machine
// versions defined in the routing configuration. If you specify the ARN of a
// second version, it must belong to the same state machine as the first version.
//
// This member is required.
StateMachineVersionArn *string
// The percentage of traffic you want to route to a state machine version. The sum
// of the weights in the routing configuration must be equal to 100.
//
// This member is required.
Weight int32
noSmithyDocumentSerde
}
// Contains details about a state entered during an execution.
type StateEnteredEventDetails struct {
// The name of the state.
//
// This member is required.
Name *string
// The string that contains the JSON input data for the state. Length constraints
// apply to the payload size, and are expressed as bytes in UTF-8 encoding.
Input *string
// Contains details about the input for an execution history event.
InputDetails *HistoryEventExecutionDataDetails
noSmithyDocumentSerde
}
// Contains details about an exit from a state during an execution.
type StateExitedEventDetails struct {
// The name of the state. A name must not contain:
// - white space
// - brackets < > { } [ ]
// - wildcard characters ? *
// - special characters " # % \ ^ | ~ ` $ & , ; : /
// - control characters ( U+0000-001F , U+007F-009F )
// To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z,
// a-z, - and _.
//
// This member is required.
Name *string
// The JSON output data of the state. Length constraints apply to the payload
// size, and are expressed as bytes in UTF-8 encoding.
Output *string
// Contains details about the output of an execution history event.
OutputDetails *HistoryEventExecutionDataDetails
noSmithyDocumentSerde
}
// Contains details about a specific state machine alias.
type StateMachineAliasListItem struct {
// The creation date of a state machine alias.
//
// This member is required.
CreationDate *time.Time
// The Amazon Resource Name (ARN) that identifies a state machine alias. The alias
// ARN is a combination of state machine ARN and the alias name separated by a
// colon (:). For example, stateMachineARN:PROD .
//
// This member is required.
StateMachineAliasArn *string
noSmithyDocumentSerde
}
// Contains details about the state machine.
type StateMachineListItem struct {
// The date the state machine is created.
//
// This member is required.
CreationDate *time.Time
// The name of the state machine. A name must not contain:
// - white space
// - brackets < > { } [ ]
// - wildcard characters ? *
// - special characters " # % \ ^ | ~ ` $ & , ; : /
// - control characters ( U+0000-001F , U+007F-009F )
// To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z,
// a-z, - and _.
//
// This member is required.
Name *string
// The Amazon Resource Name (ARN) that identifies the state machine.
//
// This member is required.
StateMachineArn *string
//
//
// This member is required.
Type StateMachineType
noSmithyDocumentSerde
}
// Contains details about a specific state machine version.
type StateMachineVersionListItem struct {
// The creation date of a state machine version.
//
// This member is required.
CreationDate *time.Time
// The Amazon Resource Name (ARN) that identifies a state machine version. The
// version ARN is a combination of state machine ARN and the version number
// separated by a colon (:). For example, stateMachineARN:1 .
//
// This member is required.
StateMachineVersionArn *string
noSmithyDocumentSerde
}
// Tags are key-value pairs that can be associated with Step Functions state
// machines and activities. An array of key-value pairs. For more information, see
// Using Cost Allocation Tags (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html)
// in the Amazon Web Services Billing and Cost Management User Guide, and
// Controlling Access Using IAM Tags (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_iam-tags.html)
// . Tags may only contain Unicode letters, digits, white space, or these symbols:
// _ . : / = + - @ .
type Tag struct {
// The key of a tag.
Key *string
// The value of a tag.
Value *string
noSmithyDocumentSerde
}
// Contains details about the credentials that Step Functions uses for a task.
type TaskCredentials struct {
// The ARN of an IAM role that Step Functions assumes for the task. The role can
// allow cross-account access to resources.
RoleArn *string
noSmithyDocumentSerde
}
// Contains details about a task failure event.
type TaskFailedEventDetails struct {
// The action of the resource called by a task state.
//
// This member is required.
Resource *string
// The service name of the resource in a task state.
//
// This member is required.
ResourceType *string
// A more detailed explanation of the cause of the failure.
Cause *string
// The error code of the failure.
Error *string
noSmithyDocumentSerde
}
// Contains details about a task scheduled during an execution.
type TaskScheduledEventDetails struct {
// The JSON data passed to the resource referenced in a task state. Length
// constraints apply to the payload size, and are expressed as bytes in UTF-8
// encoding.
//
// This member is required.
Parameters *string
// The region of the scheduled task
//
// This member is required.
Region *string
// The action of the resource called by a task state.
//
// This member is required.
Resource *string
// The service name of the resource in a task state.
//
// This member is required.
ResourceType *string
// The maximum allowed duration between two heartbeats for the task.
HeartbeatInSeconds *int64
// The credentials that Step Functions uses for the task.
TaskCredentials *TaskCredentials
// The maximum allowed duration of the task.
TimeoutInSeconds *int64
noSmithyDocumentSerde
}
// Contains details about the start of a task during an execution.
type TaskStartedEventDetails struct {
// The action of the resource called by a task state.
//
// This member is required.
Resource *string
// The service name of the resource in a task state.
//
// This member is required.
ResourceType *string
noSmithyDocumentSerde
}
// Contains details about a task that failed to start during an execution.
type TaskStartFailedEventDetails struct {
// The action of the resource called by a task state.
//
// This member is required.
Resource *string
// The service name of the resource in a task state.
//
// This member is required.
ResourceType *string
// A more detailed explanation of the cause of the failure.
Cause *string
// The error code of the failure.
Error *string
noSmithyDocumentSerde
}
// Contains details about a task that failed to submit during an execution.
type TaskSubmitFailedEventDetails struct {
// The action of the resource called by a task state.
//
// This member is required.
Resource *string
// The service name of the resource in a task state.
//
// This member is required.
ResourceType *string
// A more detailed explanation of the cause of the failure.
Cause *string
// The error code of the failure.
Error *string
noSmithyDocumentSerde
}
// Contains details about a task submitted to a resource .
type TaskSubmittedEventDetails struct {
// The action of the resource called by a task state.
//
// This member is required.
Resource *string
// The service name of the resource in a task state.
//
// This member is required.
ResourceType *string
// The response from a resource when a task has started. Length constraints apply
// to the payload size, and are expressed as bytes in UTF-8 encoding.
Output *string
// Contains details about the output of an execution history event.
OutputDetails *HistoryEventExecutionDataDetails
noSmithyDocumentSerde
}
// Contains details about the successful completion of a task state.
type TaskSucceededEventDetails struct {
// The action of the resource called by a task state.
//
// This member is required.
Resource *string
// The service name of the resource in a task state.
//
// This member is required.
ResourceType *string
// The full JSON response from a resource when a task has succeeded. This response
// becomes the output of the related task. Length constraints apply to the payload
// size, and are expressed as bytes in UTF-8 encoding.
Output *string
// Contains details about the output of an execution history event.
OutputDetails *HistoryEventExecutionDataDetails
noSmithyDocumentSerde
}
// Contains details about a resource timeout that occurred during an execution.
type TaskTimedOutEventDetails struct {
// The action of the resource called by a task state.
//
// This member is required.
Resource *string
// The service name of the resource in a task state.
//
// This member is required.
ResourceType *string
// A more detailed explanation of the cause of the failure.
Cause *string
// The error code of the failure.
Error *string
noSmithyDocumentSerde
}
// Selects whether or not the state machine's X-Ray tracing is enabled. Default is
// false
type TracingConfiguration struct {
// When set to true , X-Ray tracing is enabled.
Enabled bool
noSmithyDocumentSerde
}
type noSmithyDocumentSerde = smithydocument.NoSerde
|