AWS Step Functions AWS Step Functions #X Amz Target=AWSStepFunctions.PublishSta… API

openapi: 3.2.0
info:
  title: 'AWS Step Functions #X Amz Target=AWSStepFunctions.PublishSta…'
  version: '2016-11-23'
  x-refined-note:
  - x-apiClientRegistration differs across the merged source definitions and was not carried
  - x-apisguru-categories differs across the merged source definitions and was not carried
  - x-logo differs across the merged source definitions and was not carried
  - x-origin differs across the merged source definitions and was not carried
  - x-preferred differs across the merged source definitions and was not carried
  - x-providerName differs across the merged source definitions and was not carried
  - x-release differs across the merged source definitions and was not carried
  - x-serviceName differs across the merged source definitions and was not carried
  description: 'Operations tagged AWS Step Functions #X Amz Target=AWSStepFunctions.PublishSta… across 2 of this provider''s published API definitions: amazon-step-functions-x-amz-target-awsstepfunctions-publishstatemachineversion-api-openapi.yml, aws-step-functions-aws-step-functions-x-amz-target-awsstepfunctions-publishsta-api-openapi.yml. Each path carries the servers of the definition it was published in.'
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)
tags:
- name: 'AWS Step Functions #X Amz Target=AWSStepFunctions.PublishSta…'
paths:
  /#X-Amz-Target=AWSStepFunctions.PublishStateMachineVersion:
    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: PublishStateMachineVersion
      description: 'Creates a version from the current revision of a state machine. Use versions to create immutable snapshots of your state machine. You can start executions from versions either directly or with an alias. To create an alias, use CreateStateMachineAlias.


        You can publish up to 1000 versions for each state machine. You must manually delete unused versions using the DeleteStateMachineVersion API action.


        PublishStateMachineVersion is an idempotent API. It doesn''t create a duplicate state machine version if it already exists for the current revision. Step Functions bases PublishStateMachineVersion''s idempotency check on the stateMachineArn, name, and revisionId parameters. Requests with the same parameters return a successful idempotent response. If you don''t specify a revisionId, Step Functions checks for a previously published version of the state machine''s current revision.


        Related operations:


        DeleteStateMachineVersion


        ListStateMachineVersions'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublishStateMachineVersionOutput'
              examples:
                PublishStateMachineVersion200Example:
                  summary: Default PublishStateMachineVersion 200
                  x-microcks-default: true
                  value:
                    creationDate: example-value
                    stateMachineVersionArn: arn:aws:service:us-east-1:123456789012:resource/example
        '480':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
              examples:
                PublishStateMachineVersion480Example:
                  summary: Default PublishStateMachineVersion 480
                  x-microcks-default: true
                  value: example-value
        '481':
          description: StateMachineDeleting
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StateMachineDeleting'
              examples:
                PublishStateMachineVersion481Example:
                  summary: Default PublishStateMachineVersion 481
                  x-microcks-default: true
                  value: example-value
        '482':
          description: StateMachineDoesNotExist
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StateMachineDoesNotExist'
              examples:
                PublishStateMachineVersion482Example:
                  summary: Default PublishStateMachineVersion 482
                  x-microcks-default: true
                  value: example-value
        '483':
          description: ServiceQuotaExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceQuotaExceededException'
              examples:
                PublishStateMachineVersion483Example:
                  summary: Default PublishStateMachineVersion 483
                  x-microcks-default: true
                  value: example-value
        '484':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
              examples:
                PublishStateMachineVersion484Example:
                  summary: Default PublishStateMachineVersion 484
                  x-microcks-default: true
                  value: example-value
        '485':
          description: InvalidArn
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidArn'
              examples:
                PublishStateMachineVersion485Example:
                  summary: Default PublishStateMachineVersion 485
                  x-microcks-default: true
                  value: example-value
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PublishStateMachineVersionInput'
            examples:
              PublishStateMachineVersionRequestExample:
                summary: Default PublishStateMachineVersion request
                x-microcks-default: true
                value:
                  stateMachineArn: arn:aws:service:us-east-1:123456789012:resource/example
                  revisionId: example-value
                  description: example-value
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSStepFunctions.PublishStateMachineVersion
      summary: Amazon Publish State Machine Version
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - 'AWS Step Functions #X Amz Target=AWSStepFunctions.PublishSta…'
      security:
      - hmac: []
    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)
  /#PublishStateMachineVersion:
    post:
      operationId: post#PublishStateMachineVersion
      summary: Publish State Machine Version
      description: 'Creates a version from the current revision of a state machine. Use versions to create immutable snapshots of your state machine. You can start executions from versions either directly or with an alias. To create an alias, use CreateStateMachineAlias. You can publish up to 1000 versions for each state machine. You must manually delete unused versions using the DeleteStateMachineVersion API action. PublishStateMachineVersion is an idempotent API. It doesn''t create a duplicate state machine version if it already exists for the current revision. Step Functions bases PublishStateMachineVersion''s idempotency check on the stateMachineArn, name, and revisionId parameters. Requests with the same parameters return a successful idempotent response. If you don''t specify a revisionId, Step Functions checks for a previously published version of the state machine''s current revision. Related operations: DeleteStateMachineVersion ListStateMachineVersions'
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/PublishStateMachineVersionOutput_2'
        '409':
          description: ConflictException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ConflictException_2'
        '400':
          description: InvalidArn; StateMachineDeleting; StateMachineDoesNotExist; ValidationException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InvalidArn_2'
        '402':
          description: ServiceQuotaExceededException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ServiceQuotaExceededException_2'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSStepFunctions.PublishStateMachineVersion
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/PublishStateMachineVersionInput_2'
      tags:
      - 'AWS Step Functions #X Amz Target=AWSStepFunctions.PublishSta…'
      security:
      - sigv4: []
      x-operation-id-source: normalized
      x-operation-id-original: PublishStateMachineVersion
    servers:
    - url: https://states.{region}.amazonaws.com
      variables:
        region:
          default: us-east-1
components:
  parameters:
    X-Amz-Signature:
      name: X-Amz-Signature
      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-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-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
  schemas:
    StateMachineDoesNotExist: {}
    ConflictException: {}
    PublishStateMachineVersionOutput:
      type: object
      required:
      - creationDate
      - stateMachineVersionArn
      properties:
        creationDate:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: The date the version was created.
        stateMachineVersionArn:
          allOf:
          - $ref: '#/components/schemas/Arn'
          - description: The Amazon Resource Name (ARN) (ARN) that identifies the state machine version.
    VersionDescription:
      type: string
      maxLength: 256
      format: password
    InvalidArn: {}
    Timestamp:
      type: string
      format: date-time
    ServiceQuotaExceededException: {}
    ValidationException: {}
    StateMachineDeleting: {}
    PublishStateMachineVersionInput:
      type: object
      required:
      - stateMachineArn
      title: PublishStateMachineVersionInput
      properties:
        stateMachineArn:
          allOf:
          - $ref: '#/components/schemas/Arn'
          - description: The Amazon Resource Name (ARN) of the state machine.
        revisionId:
          allOf:
          - $ref: '#/components/schemas/RevisionId'
          - description: <p>Only publish the state machine version if the current state machine's revision ID matches the specified ID.</p> <p>Use this option to avoid publishing a version if the state machine changed since you last updated it. If the specified revision ID doesn't match the state machine's current revision ID, the API returns <code>ConflictException</code>.</p> <note> <p>To specify an initial revision ID for a state machine with no revision ID assigned, specify the string <code>INITIAL</code> for the <code>revisionId</code> parameter. For example, you can specify a <code>revisionID</code> of <code>INITIAL</code> when you create a state machine using the <a>CreateStateMachine</a> API action.</p> </note>
        description:
          allOf:
          - $ref: '#/components/schemas/VersionDescription'
          - description: An optional description of the state machine version.
    Arn:
      type: string
      minLength: 1
      maxLength: 256
    RevisionId:
      type: string
    PublishStateMachineVersionInput_2:
      type: object
      properties:
        stateMachineArn:
          type: string
          description: The Amazon Resource Name (ARN) of the state machine.
        revisionId:
          type: string
          description: Only publish the state machine version if the current state machine's revision ID matches the specified ID. Use this option to avoid publishing a version if the state machine changed since you last updated it. If the specified revision ID doesn't match the state machine's current revision ID, the API returns ConflictException. To specify an initial revision ID for a state machine with no revision ID assigned, specify the string INITIAL for the revisionId parameter. For example, you can specify a revisionID of INITIAL when you create a state machine using the CreateStateMachine API action.
        description:
          type: string
          description: An optional description of the state machine version.
      required:
      - stateMachineArn
    ServiceQuotaExceededException_2:
      type: object
      properties:
        message:
          type: string
    PublishStateMachineVersionOutput_2:
      type: object
      properties:
        creationDate:
          type: string
          format: date-time
          description: The date the version was created.
        stateMachineVersionArn:
          type: string
          description: The Amazon Resource Name (ARN) (ARN) that identifies the state machine version.
      required:
      - creationDate
      - stateMachineVersionArn
    ConflictException_2:
      type: object
      properties:
        message:
          type: string
    InvalidArn_2:
      type: object
      properties:
        message:
          type: string
  securitySchemes:
    hmac:
      type: apiKey
      name: Authorization
      in: header
      description: Amazon Signature authorization v4
      x-amazon-apigateway-authtype: awsSigv4
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: states
externalDocs:
  description: Amazon Web Services documentation
  url: https://docs.aws.amazon.com/states/
x-refined-from:
- amazon-step-functions-x-amz-target-awsstepfunctions-publishstatemachineversion-api-openapi.yml
- aws-step-functions-aws-step-functions-x-amz-target-awsstepfunctions-publishsta-api-openapi.yml
x-hasEquivalentPaths: true