SPspot
Connect Workflows

Update Workflow

Update a selected workflow by creating a new version. New workflow is created off of the latest version in SSM.

put/connect/workflows/{workflow_name}

Request

  • Base URL
    https://api.spotinst.io
  • URL
    https://api.spotinst.io/connect/workflows/{workflow_name}
  • Auth
    HTTP bearer

Path parameters

workflow_namestring required

Unique workflow name

Parameters

#/paths/~1connect~1workflows/get/parameters/0 (unresolved $ref)

Request body

Content0 required(unresolved $ref)
Tagsstring[]

List of workflow tags.

Response

Success

Descriptionstring required

Workflow description.

DocumentVersionstring required

Version of the SSM document.

Editorstring

Editor of the workflow.

EditorIdstring

ID of the workflow editor.

Namestring required

Name to display to owner

ReadOnlyboolean

True for read only workflows else false.

Tagsstring[]

List of workflow tags.

UpdatedDatestring

Last updated date of the SSM document.

WorkflowIdstring

Unique ID for a workflow document version.

WorkflowOwnerstring

Owner of the workflow.

WorkflowOwnerIdstring

ID of the workflow owner.

WorkspaceIdstring

Workspace the workflow belongs to.

CreatedDatestring required

Date when workflow was created.

DefaultVersionstring required

Current default version in SSM.

DisplayNamestring required

Display name of the workflow.

DocumentFormatstring required

SSM document format.

DocumentTypestring required

SSM document type.

HashTypestring required

Hash type of the SSM.

IsDefaultboolean required

Tells the default version of the SSM.(true for default version and false for not default version.)

LatestVersionstring required

Newest version of the document.

Parametersobject[]

Runtime parameters for the workflow.

PlatformTypesstring required

SSM document platforms.

SSMDocumentstring required

Original SSM document.

SchemaVersionstring required

SSM schema.

SsmHashstring required

Hash value of the SSM.

SsmNamestring required

Name of the workflow in ssm.

Statusstring required

Ssm document status

StepDocumentsItems[] (unresolved $ref)

List of step documents used in the SSM document.

TenantIdstring required

Cognito ID of the owner.

Versionsobject[]

List of available versions.

Changes

No recorded changes to this operation across all 12 revisions of this API.