@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api AWS Step Functions
@version 2016-11-23
@auth AWS SigV4
@endpoints 37
@hint download_for_search
@toc root(37)

@endpoint POST /
@required {name: str}
@optional {tags: [Tag], encryptionConfiguration: EncryptionConfiguration}
@returns(200) {activityArn: str, creationDate: str(timestamp)}

@endpoint POST /
@required {name: str, definition: str, roleArn: str}
@optional {type: str, loggingConfiguration: LoggingConfiguration, tags: [Tag], tracingConfiguration: TracingConfiguration, publish: bool, versionDescription: str, encryptionConfiguration: EncryptionConfiguration}
@returns(200) {stateMachineArn: str, creationDate: str(timestamp), stateMachineVersionArn: str?}

@endpoint POST /
@required {name: str, routingConfiguration: [RoutingConfigurationListItem]}
@optional {description: str}
@returns(200) {stateMachineAliasArn: str, creationDate: str(timestamp)}

@endpoint POST /
@required {activityArn: str}

@endpoint POST /
@required {stateMachineArn: str}

@endpoint POST /
@required {stateMachineAliasArn: str}

@endpoint POST /
@required {stateMachineVersionArn: str}

@endpoint POST /
@required {activityArn: str}
@returns(200) {activityArn: str, name: str, creationDate: str(timestamp), encryptionConfiguration: EncryptionConfiguration?{kmsKeyId: str?, kmsDataKeyReusePeriodSeconds: int?, type: str}}

@endpoint POST /
@required {executionArn: str}
@optional {includedData: str}
@returns(200) {executionArn: str, stateMachineArn: str, name: str?, status: str, startDate: str(timestamp), stopDate: str(timestamp)?, input: str?, inputDetails: CloudWatchEventsExecutionDataDetails?{included: bool?}, output: str?, outputDetails: CloudWatchEventsExecutionDataDetails?{included: bool?}, traceHeader: str?, mapRunArn: str?, error: str?, cause: str?, stateMachineVersionArn: str?, stateMachineAliasArn: str?, redriveCount: int?, redriveDate: str(timestamp)?, redriveStatus: str?, redriveStatusReason: str?}

@endpoint POST /
@required {mapRunArn: str}
@returns(200) {mapRunArn: str, executionArn: str, status: str, startDate: str(timestamp), stopDate: str(timestamp)?, maxConcurrency: int, toleratedFailurePercentage: num(f32), toleratedFailureCount: int(i64), itemCounts: MapRunItemCounts{pending: int(i64), running: int(i64), succeeded: int(i64), failed: int(i64), timedOut: int(i64), aborted: int(i64), total: int(i64), resultsWritten: int(i64), failuresNotRedrivable: int(i64)?, pendingRedrive: int(i64)?}, executionCounts: MapRunExecutionCounts{pending: int(i64), running: int(i64), succeeded: int(i64), failed: int(i64), timedOut: int(i64), aborted: int(i64), total: int(i64), resultsWritten: int(i64), failuresNotRedrivable: int(i64)?, pendingRedrive: int(i64)?}, redriveCount: int?, redriveDate: str(timestamp)?}

@endpoint POST /
@required {stateMachineArn: str}
@optional {includedData: str}
@returns(200) {stateMachineArn: str, name: str, status: str?, definition: str, roleArn: str, type: str, creationDate: str(timestamp), loggingConfiguration: LoggingConfiguration?{level: str?, includeExecutionData: bool?, destinations: [LogDestination]?}, tracingConfiguration: TracingConfiguration?{enabled: bool?}, label: str?, revisionId: str?, description: str?, encryptionConfiguration: EncryptionConfiguration?{kmsKeyId: str?, kmsDataKeyReusePeriodSeconds: int?, type: str}}

@endpoint POST /
@required {stateMachineAliasArn: str}
@returns(200) {stateMachineAliasArn: str?, name: str?, description: str?, routingConfiguration: [RoutingConfigurationListItem]?, creationDate: str(timestamp)?, updateDate: str(timestamp)?}

@endpoint POST /
@required {executionArn: str}
@optional {includedData: str}
@returns(200) {stateMachineArn: str, name: str, definition: str, roleArn: str, updateDate: str(timestamp), loggingConfiguration: LoggingConfiguration?{level: str?, includeExecutionData: bool?, destinations: [LogDestination]?}, tracingConfiguration: TracingConfiguration?{enabled: bool?}, mapRunArn: str?, label: str?, revisionId: str?, encryptionConfiguration: EncryptionConfiguration?{kmsKeyId: str?, kmsDataKeyReusePeriodSeconds: int?, type: str}}

@endpoint POST /
@required {activityArn: str}
@optional {workerName: str}
@returns(200) {taskToken: str?, input: str?}

@endpoint POST /
@required {executionArn: str}
@optional {maxResults: int, reverseOrder: bool, nextToken: str, includeExecutionData: bool}
@returns(200) {events: [HistoryEvent], nextToken: str?}

@endpoint POST /
@optional {maxResults: int, nextToken: str}
@returns(200) {activities: [ActivityListItem], nextToken: str?}

@endpoint POST /
@optional {stateMachineArn: str, statusFilter: str, maxResults: int, nextToken: str, mapRunArn: str, redriveFilter: str}
@returns(200) {executions: [ExecutionListItem], nextToken: str?}

@endpoint POST /
@required {executionArn: str}
@optional {maxResults: int, nextToken: str}
@returns(200) {mapRuns: [MapRunListItem], nextToken: str?}

@endpoint POST /
@required {stateMachineArn: str}
@optional {nextToken: str, maxResults: int}
@returns(200) {stateMachineAliases: [StateMachineAliasListItem], nextToken: str?}

@endpoint POST /
@required {stateMachineArn: str}
@optional {nextToken: str, maxResults: int}
@returns(200) {stateMachineVersions: [StateMachineVersionListItem], nextToken: str?}

@endpoint POST /
@optional {maxResults: int, nextToken: str}
@returns(200) {stateMachines: [StateMachineListItem], nextToken: str?}

@endpoint POST /
@required {resourceArn: str}
@returns(200) {tags: [Tag]?}

@endpoint POST /
@required {stateMachineArn: str}
@optional {revisionId: str, description: str}
@returns(200) {creationDate: str(timestamp), stateMachineVersionArn: str}

@endpoint POST /
@required {executionArn: str}
@optional {clientToken: str}
@returns(200) {redriveDate: str(timestamp)}

@endpoint POST /
@required {taskToken: str}
@optional {error: str, cause: str}

@endpoint POST /
@required {taskToken: str}

@endpoint POST /
@required {taskToken: str, output: str}

@endpoint POST /
@required {stateMachineArn: str}
@optional {name: str, input: str, traceHeader: str}
@returns(200) {executionArn: str, startDate: str(timestamp)}

@endpoint POST /
@required {stateMachineArn: str}
@optional {name: str, input: str, traceHeader: str, includedData: str}
@returns(200) {executionArn: str, stateMachineArn: str?, name: str?, startDate: str(timestamp), stopDate: str(timestamp), status: str, error: str?, cause: str?, input: str?, inputDetails: CloudWatchEventsExecutionDataDetails?{included: bool?}, output: str?, outputDetails: CloudWatchEventsExecutionDataDetails?{included: bool?}, traceHeader: str?, billingDetails: BillingDetails?{billedMemoryUsedInMB: int(i64)?, billedDurationInMilliseconds: int(i64)?}}

@endpoint POST /
@required {executionArn: str}
@optional {error: str, cause: str}
@returns(200) {stopDate: str(timestamp)}

@endpoint POST /
@required {resourceArn: str, tags: [Tag]}

@endpoint POST /
@required {definition: str, roleArn: str}
@optional {input: str, inspectionLevel: str, revealSecrets: bool}
@returns(200) {output: str?, error: str?, cause: str?, inspectionData: InspectionData?{input: str?, afterInputPath: str?, afterParameters: str?, result: str?, afterResultSelector: str?, afterResultPath: str?, request: InspectionDataRequest?{protocol: str?, method: str?, url: str?, headers: str?, body: str?}, response: InspectionDataResponse?{protocol: str?, statusCode: str?, statusMessage: str?, headers: str?, body: str?}}, nextState: str?, status: str?}

@endpoint POST /
@required {resourceArn: str, tagKeys: [str]}

@endpoint POST /
@required {mapRunArn: str}
@optional {maxConcurrency: int, toleratedFailurePercentage: num(f32), toleratedFailureCount: int(i64)}

@endpoint POST /
@required {stateMachineArn: str}
@optional {definition: str, roleArn: str, loggingConfiguration: LoggingConfiguration, tracingConfiguration: TracingConfiguration, publish: bool, versionDescription: str, encryptionConfiguration: EncryptionConfiguration}
@returns(200) {updateDate: str(timestamp), revisionId: str?, stateMachineVersionArn: str?}

@endpoint POST /
@required {stateMachineAliasArn: str}
@optional {description: str, routingConfiguration: [RoutingConfigurationListItem]}
@returns(200) {updateDate: str(timestamp)}

@endpoint POST /
@required {definition: str}
@optional {type: str, severity: str, maxResults: int}
@returns(200) {result: str, diagnostics: [ValidateStateMachineDefinitionDiagnostic], truncated: bool?}

@end
