openapi: 3.2.0 info: title: 'AWS Step Functions #X Amz Target=AWSStepFunctions.ListStateM…' version: '2016-11-23' 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/ termsOfService: https://aws.amazon.com/service-terms/ x-apiClientRegistration: url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct x-apisguru-categories: - cloud x-logo: url: https://twitter.com/awscloud/profile_image?size=original backgroundColor: '#FFFFFF' 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-preferred: true x-providerName: amazonaws.com x-release: v4 x-serviceName: states description: 'Operations tagged AWS Step Functions #X Amz Target=AWSStepFunctions.ListStateM… across 2 of this provider''s published API definitions: amazon-step-functions-x-amz-target-awsstepfunctions-liststatemachinealiases-api-openapi.yml, amazon-step-functions-x-amz-target-awsstepfunctions-liststatemachineversions-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) security: - hmac: [] tags: - name: 'AWS Step Functions #X Amz Target=AWSStepFunctions.ListStateM…' paths: /#X-Amz-Target=AWSStepFunctions.ListStateMachineAliases: 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: ListStateMachineAliases description: 'Lists aliases for a specified state machine ARN. Results are sorted by time, with the most recently created aliases listed first. To list aliases that reference a state machine version, you can specify the version ARN in the stateMachineArn parameter. If nextToken is returned, there are more results available. The value of nextToken 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 HTTP 400 InvalidToken error. Related operations: CreateStateMachineAlias DescribeStateMachineAlias UpdateStateMachineAlias DeleteStateMachineAlias' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListStateMachineAliasesOutput' examples: ListStateMachineAliases200Example: summary: Default ListStateMachineAliases 200 x-microcks-default: true value: stateMachineAliases: example-value nextToken: example-value '480': description: InvalidArn content: application/json: schema: $ref: '#/components/schemas/InvalidArn' examples: ListStateMachineAliases480Example: summary: Default ListStateMachineAliases 480 x-microcks-default: true value: example-value '481': description: InvalidToken content: application/json: schema: $ref: '#/components/schemas/InvalidToken' examples: ListStateMachineAliases481Example: summary: Default ListStateMachineAliases 481 x-microcks-default: true value: example-value '482': description: ResourceNotFound content: application/json: schema: $ref: '#/components/schemas/ResourceNotFound' examples: ListStateMachineAliases482Example: summary: Default ListStateMachineAliases 482 x-microcks-default: true value: example-value '483': description: StateMachineDoesNotExist content: application/json: schema: $ref: '#/components/schemas/StateMachineDoesNotExist' examples: ListStateMachineAliases483Example: summary: Default ListStateMachineAliases 483 x-microcks-default: true value: example-value '484': description: StateMachineDeleting content: application/json: schema: $ref: '#/components/schemas/StateMachineDeleting' examples: ListStateMachineAliases484Example: summary: Default ListStateMachineAliases 484 x-microcks-default: true value: example-value requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ListStateMachineAliasesInput' examples: ListStateMachineAliasesRequestExample: summary: Default ListStateMachineAliases request x-microcks-default: true value: stateMachineArn: arn:aws:service:us-east-1:123456789012:resource/example nextToken: example-value maxResults: example-value parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSStepFunctions.ListStateMachineAliases summary: Amazon List State Machine Aliases x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - 'AWS Step Functions #X Amz Target=AWSStepFunctions.ListStateM…' 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) /#X-Amz-Target=AWSStepFunctions.ListStateMachineVersions: 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: ListStateMachineVersions description: 'Lists versions for the specified state machine Amazon Resource Name (ARN). The results are sorted in descending order of the version creation time. If nextToken is returned, there are more results available. The value of nextToken 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 HTTP 400 InvalidToken error. Related operations: PublishStateMachineVersion DeleteStateMachineVersion' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListStateMachineVersionsOutput' examples: ListStateMachineVersions200Example: summary: Default ListStateMachineVersions 200 x-microcks-default: true value: stateMachineVersions: example-value nextToken: example-value '480': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' examples: ListStateMachineVersions480Example: summary: Default ListStateMachineVersions 480 x-microcks-default: true value: example-value '481': description: InvalidArn content: application/json: schema: $ref: '#/components/schemas/InvalidArn' examples: ListStateMachineVersions481Example: summary: Default ListStateMachineVersions 481 x-microcks-default: true value: example-value '482': description: InvalidToken content: application/json: schema: $ref: '#/components/schemas/InvalidToken' examples: ListStateMachineVersions482Example: summary: Default ListStateMachineVersions 482 x-microcks-default: true value: example-value requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ListStateMachineVersionsInput' examples: ListStateMachineVersionsRequestExample: summary: Default ListStateMachineVersions request x-microcks-default: true value: stateMachineArn: arn:aws:service:us-east-1:123456789012:resource/example nextToken: example-value maxResults: example-value parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSStepFunctions.ListStateMachineVersions summary: Amazon List State Machine Versions x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - 'AWS Step Functions #X Amz Target=AWSStepFunctions.ListStateM…' 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) components: parameters: X-Amz-Security-Token: name: X-Amz-Security-Token in: header schema: type: string required: false X-Amz-Date: name: X-Amz-Date in: header schema: type: string required: false X-Amz-SignedHeaders: name: X-Amz-SignedHeaders in: header schema: type: string required: false X-Amz-Credential: name: X-Amz-Credential in: header schema: type: string required: false 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-Algorithm: name: X-Amz-Algorithm in: header schema: type: string required: false schemas: StateMachineAliasList: type: array items: $ref: '#/components/schemas/StateMachineAliasListItem' InvalidToken: {} PageToken: type: string minLength: 1 maxLength: 1024 Timestamp: type: string format: date-time StateMachineDeleting: {} ListStateMachineAliasesInput: type: object required: - stateMachineArn title: ListStateMachineAliasesInput properties: stateMachineArn: allOf: - $ref: '#/components/schemas/Arn' - description:

The Amazon Resource Name (ARN) of the state machine for which you want to list aliases.

If you specify a state machine version ARN, this API returns a list of aliases for that version.

nextToken: allOf: - $ref: '#/components/schemas/PageToken' - description: If nextToken is returned, there are more results available. The value of nextToken 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 HTTP 400 InvalidToken error. maxResults: allOf: - $ref: '#/components/schemas/PageSize' - description:

The maximum number of results that are returned per call. You can use nextToken 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.

This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.

LongArn: type: string minLength: 1 maxLength: 2000 ResourceNotFound: {} StateMachineAliasListItem: type: object required: - stateMachineAliasArn - creationDate properties: stateMachineAliasArn: allOf: - $ref: '#/components/schemas/LongArn' - description: The Amazon Resource Name (ARN) that identifies a state machine alias. The alias ARN is a combination of state machine ARN and the alias name separated by a colon (:). For example, stateMachineARN:PROD. creationDate: allOf: - $ref: '#/components/schemas/Timestamp' - description: The creation date of a state machine alias. description: Contains details about a specific state machine alias. InvalidArn: {} PageSize: type: integer minimum: 0 maximum: 1000 StateMachineDoesNotExist: {} Arn: type: string minLength: 1 maxLength: 256 ListStateMachineAliasesOutput: type: object required: - stateMachineAliases properties: stateMachineAliases: allOf: - $ref: '#/components/schemas/StateMachineAliasList' - description: Aliases for the state machine. nextToken: allOf: - $ref: '#/components/schemas/PageToken' - description: If nextToken is returned, there are more results available. The value of nextToken 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 HTTP 400 InvalidToken error. ListStateMachineVersionsInput: type: object required: - stateMachineArn title: ListStateMachineVersionsInput properties: stateMachineArn: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) of the state machine. nextToken: allOf: - $ref: '#/components/schemas/PageToken' - description: If nextToken is returned, there are more results available. The value of nextToken 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 HTTP 400 InvalidToken error. maxResults: allOf: - $ref: '#/components/schemas/PageSize' - description:

The maximum number of results that are returned per call. You can use nextToken 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.

This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.

ListStateMachineVersionsOutput: type: object required: - stateMachineVersions properties: stateMachineVersions: allOf: - $ref: '#/components/schemas/StateMachineVersionList' - description: Versions for the state machine. nextToken: allOf: - $ref: '#/components/schemas/PageToken' - description: If nextToken is returned, there are more results available. The value of nextToken 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 HTTP 400 InvalidToken error. ValidationException: {} StateMachineVersionList: type: array items: $ref: '#/components/schemas/StateMachineVersionListItem' StateMachineVersionListItem: type: object required: - stateMachineVersionArn - creationDate properties: stateMachineVersionArn: allOf: - $ref: '#/components/schemas/LongArn' - description: The Amazon Resource Name (ARN) that identifies a state machine version. The version ARN is a combination of state machine ARN and the version number separated by a colon (:). For example, stateMachineARN:1. creationDate: allOf: - $ref: '#/components/schemas/Timestamp' - description: The creation date of a state machine version. description: Contains details about a specific state machine version. 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-refined-from: - amazon-step-functions-x-amz-target-awsstepfunctions-liststatemachinealiases-api-openapi.yml - amazon-step-functions-x-amz-target-awsstepfunctions-liststatemachineversions-api-openapi.yml x-hasEquivalentPaths: true