AWS Step Functions #X Amz Target=AWSStepFunctions.StartSyncExecution API

openapi: 3.0.0
info:
  version: '2016-11-23'
  x-release: v4
  title: 'AWS Step Functions #X Amz Target=AWSStepFunctions.CreateActivity #X Amz Target=AWSStepFunctions.CreateActivity #X Amz Target=AWSStepFunctions.StartSyncExecution API'
  description: <fullname>Step Functions</fullname> <p>Step Functions is a service that lets you coordinate the components of distributed applications and microservices using visual workflows.</p> <p>You can use Step Functions to build applications from individual components, each of which performs a discrete function, or <i>task</i>, allowing you to scale and change applications quickly. Step Functions provides a console that helps visualize the components of your application as a series of steps. Step Functions automatically triggers and tracks each step, and retries steps when there are errors, so your application executes predictably and in the right order every time. Step Functions logs the state of each step, so you can quickly diagnose and debug any issues.</p> <p>Step Functions manages operations and underlying infrastructure to ensure your application is available at any scale. You can run tasks on Amazon Web Services, your own servers, or any system that has access to Amazon Web Services. You can access and use Step Functions using the console, the Amazon Web Services SDKs, or an HTTP API. For more information about Step Functions, see the <i> <a href="https://docs.aws.amazon.com/step-functions/latest/dg/welcome.html">Step Functions Developer Guide</a> </i>.</p>
  x-logo:
    url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png
    backgroundColor: '#FFFFFF'
  termsOfService: https://aws.amazon.com/service-terms/
  contact:
    name: Mike Ralphson
    email: mike.ralphson@gmail.com
    url: https://github.com/mermade/aws2openapi
    x-twitter: PermittedSoc
  license:
    name: Apache 2.0 License
    url: http://www.apache.org/licenses/
  x-providerName: amazonaws.com
  x-serviceName: states
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/states-2016-11-23.normal.json
    converter:
      url: https://github.com/mermade/aws2openapi
      version: 1.0.0
    x-apisguru-driver: external
  x-apiClientRegistration:
    url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
  x-apisguru-categories:
  - cloud
  x-preferred: true
servers:
- url: http://states.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The AWS SFN multi-region endpoint
- url: https://states.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The AWS SFN multi-region endpoint
- url: http://states.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The AWS SFN endpoint for China (Beijing) and China (Ningxia)
- url: https://states.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The AWS SFN endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: '#X Amz Target=AWSStepFunctions.StartSyncExecution'
paths:
  /#X-Amz-Target=AWSStepFunctions.StartSyncExecution:
    parameters:
    - $ref: '#/components/parameters/X-Amz-Content-Sha256'
    - $ref: '#/components/parameters/X-Amz-Date'
    - $ref: '#/components/parameters/X-Amz-Algorithm'
    - $ref: '#/components/parameters/X-Amz-Credential'
    - $ref: '#/components/parameters/X-Amz-Security-Token'
    - $ref: '#/components/parameters/X-Amz-Signature'
    - $ref: '#/components/parameters/X-Amz-SignedHeaders'
    post:
      operationId: StartSyncExecution
      description: <p>Starts a Synchronous Express state machine execution. <code>StartSyncExecution</code> is not available for <code>STANDARD</code> workflows.</p> <note> <p> <code>StartSyncExecution</code> will return a <code>200 OK</code> response, even if your execution fails, because the status code in the API response doesn't reflect function errors. Error codes are reserved for errors that prevent your execution from running, such as permissions errors, limit errors, or issues with your state machine code and configuration. </p> </note> <note> <p>This API action isn't logged in CloudTrail.</p> </note>
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StartSyncExecutionOutput'
        '480':
          description: InvalidArn
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidArn'
        '481':
          description: InvalidExecutionInput
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidExecutionInput'
        '482':
          description: InvalidName
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidName'
        '483':
          description: StateMachineDoesNotExist
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StateMachineDoesNotExist'
        '484':
          description: StateMachineDeleting
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StateMachineDeleting'
        '485':
          description: StateMachineTypeNotSupported
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StateMachineTypeNotSupported'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StartSyncExecutionInput'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSStepFunctions.StartSyncExecution
      summary: AWS Step Functions - Start Sync Execution
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - '#X Amz Target=AWSStepFunctions.StartSyncExecution'
components:
  schemas:
    StateMachineDoesNotExist: {}
    InvalidName: {}
    BilledMemoryUsed:
      type: integer
      minimum: 0
    TraceHeader:
      type: string
      pattern: \p{ASCII}*
      minLength: 0
      maxLength: 256
    StateMachineTypeNotSupported: {}
    CloudWatchEventsExecutionDataDetails:
      type: object
      properties:
        included:
          allOf:
          - $ref: '#/components/schemas/includedDetails'
          - description: 'Indicates whether input or output was included in the response. Always <code>true</code> for API calls. '
      description: Provides details about execution input or output.
    StartSyncExecutionInput:
      type: object
      required:
      - stateMachineArn
      title: StartSyncExecutionInput
      properties:
        stateMachineArn:
          allOf:
          - $ref: '#/components/schemas/Arn'
          - description: The Amazon Resource Name (ARN) of the state machine to execute.
        name:
          allOf:
          - $ref: '#/components/schemas/Name'
          - description: The name of the execution.
        input:
          allOf:
          - $ref: '#/components/schemas/SensitiveData'
          - description: '<p>The string that contains the JSON input data for the execution, for example:</p> <p> <code>"input": "{\"first_name\" : \"test\"}"</code> </p> <note> <p>If you don''t include any JSON input data, you still must include the two braces, for example: <code>"input": "{}"</code> </p> </note> <p>Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.</p>'
        traceHeader:
          allOf:
          - $ref: '#/components/schemas/TraceHeader'
          - description: Passes the X-Ray trace header. The trace header can also be passed in the request payload.
    StateMachineDeleting: {}
    BillingDetails:
      type: object
      properties:
        billedMemoryUsedInMB:
          allOf:
          - $ref: '#/components/schemas/BilledMemoryUsed'
          - description: Billed memory consumption of your workflow, in MB.
        billedDurationInMilliseconds:
          allOf:
          - $ref: '#/components/schemas/BilledDuration'
          - description: Billed duration of your workflow, in milliseconds.
      description: An object that describes workflow billing details.
    StartSyncExecutionOutput:
      type: object
      required:
      - executionArn
      - startDate
      - stopDate
      - status
      properties:
        executionArn:
          allOf:
          - $ref: '#/components/schemas/Arn'
          - description: The Amazon Resource Name (ARN) that identifies the execution.
        stateMachineArn:
          allOf:
          - $ref: '#/components/schemas/Arn'
          - description: The Amazon Resource Name (ARN) that identifies the state machine.
        name:
          allOf:
          - $ref: '#/components/schemas/Name'
          - description: The name of the execution.
        startDate:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: The date the execution is started.
        stopDate:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: If the execution has already ended, the date the execution stopped.
        status:
          allOf:
          - $ref: '#/components/schemas/SyncExecutionStatus'
          - description: The current status of the execution.
        error:
          allOf:
          - $ref: '#/components/schemas/SensitiveError'
          - description: The error code of the failure.
        cause:
          allOf:
          - $ref: '#/components/schemas/SensitiveCause'
          - description: A more detailed explanation of the cause of the failure.
        input:
          allOf:
          - $ref: '#/components/schemas/SensitiveData'
          - description: The string that contains the JSON input data of the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.
        inputDetails:
          $ref: '#/components/schemas/CloudWatchEventsExecutionDataDetails'
        output:
          allOf:
          - $ref: '#/components/schemas/SensitiveData'
          - description: <p>The JSON output data of the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.</p> <note> <p>This field is set only if the execution succeeds. If the execution fails, this field is null.</p> </note>
        outputDetails:
          $ref: '#/components/schemas/CloudWatchEventsExecutionDataDetails'
        traceHeader:
          allOf:
          - $ref: '#/components/schemas/TraceHeader'
          - description: The X-Ray trace header that was passed to the execution.
        billingDetails:
          allOf:
          - $ref: '#/components/schemas/BillingDetails'
          - description: An object that describes workflow billing details, including billed duration and memory use.
    SensitiveCause:
      type: string
      minLength: 0
      maxLength: 32768
      format: password
    InvalidExecutionInput: {}
    SensitiveData:
      type: string
      maxLength: 262144
      format: password
    SyncExecutionStatus:
      type: string
      enum:
      - SUCCEEDED
      - FAILED
      - TIMED_OUT
    BilledDuration:
      type: integer
      minimum: 0
    includedDetails:
      type: boolean
    Arn:
      type: string
      minLength: 1
      maxLength: 256
    Timestamp:
      type: string
      format: date-time
    Name:
      type: string
      minLength: 1
      maxLength: 80
    SensitiveError:
      type: string
      minLength: 0
      maxLength: 256
      format: password
    InvalidArn: {}
  parameters:
    X-Amz-Credential:
      name: X-Amz-Credential
      in: header
      schema:
        type: string
      required: false
    X-Amz-Algorithm:
      name: X-Amz-Algorithm
      in: header
      schema:
        type: string
      required: false
    X-Amz-Content-Sha256:
      name: X-Amz-Content-Sha256
      in: header
      schema:
        type: string
      required: false
    X-Amz-Security-Token:
      name: X-Amz-Security-Token
      in: header
      schema:
        type: string
      required: false
    X-Amz-SignedHeaders:
      name: X-Amz-SignedHeaders
      in: header
      schema:
        type: string
      required: false
    X-Amz-Date:
      name: X-Amz-Date
      in: header
      schema:
        type: string
      required: false
    X-Amz-Signature:
      name: X-Amz-Signature
      in: header
      schema:
        type: string
      required: false
  securitySchemes:
    hmac:
      type: apiKey
      name: Authorization
      in: header
      description: Amazon Signature authorization v4
      x-amazon-apigateway-authtype: awsSigv4
externalDocs:
  description: Amazon Web Services documentation
  url: https://docs.aws.amazon.com/states/
x-hasEquivalentPaths: true