Amazon Step Functions · JSON Structure

Amazon Step Functions List State Machine Aliases Input Structure

ListStateMachineAliasesInput schema from Amazon Step Functions API

Type: object Properties: 3 Required: 1
OrchestrationServerlessState MachineWorkflow

ListStateMachineAliasesInput is a JSON Structure definition published by Amazon Step Functions, describing 3 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

stateMachineArn nextToken maxResults

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "type": "object",
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-step-functions/refs/heads/main/json-structure/amazon-step-functions-list-state-machine-aliases-input-structure.json",
  "name": "ListStateMachineAliasesInput",
  "description": "ListStateMachineAliasesInput schema from Amazon Step Functions API",
  "properties": {
    "stateMachineArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Arn"
        },
        {
          "description": "<p>The Amazon Resource Name (ARN) of the state machine for which you want to list aliases.</p> <p>If you specify a state machine version ARN, this API returns a list of aliases for that version.</p>"
        }
      ]
    },
    "nextToken": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PageToken"
        },
        {
          "description": "If <code>nextToken</code> is returned, there are more results available. The value of <code>nextToken</code> is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an <i>HTTP 400 InvalidToken</i> error."
        }
      ]
    },
    "maxResults": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PageSize"
        },
        {
          "description": "<p>The maximum number of results that are returned per call. You can use <code>nextToken</code> to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.</p> <p>This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.</p>"
        }
      ]
    }
  },
  "required": [
    "stateMachineArn"
  ]
}