openapi: 3.1.0 info: title: 'Amazon Step Functions Executions #X Amz Target=AWSStepFunctions.ListActivities API' description: Amazon Step Functions is a serverless workflow orchestration service that lets you coordinate distributed applications and microservices using visual workflows. This API enables you to create and manage state machines, start and monitor executions, and retrieve execution history. version: '2016-11-23' contact: name: Amazon Web Services url: https://aws.amazon.com/contact-us/ termsOfService: https://aws.amazon.com/service-terms/ servers: - url: https://states.{region}.amazonaws.com description: Amazon Step Functions Regional Endpoint variables: region: default: us-east-1 description: AWS Region security: - sigv4Auth: [] tags: - name: '#X Amz Target=AWSStepFunctions.ListActivities' paths: /#X-Amz-Target=AWSStepFunctions.ListActivities: 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: ListActivities description:
Lists the existing activities.
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.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
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.
nextToken: allOf: - $ref: '#/components/schemas/PageToken' - description: IfnextToken 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.
Arn:
type: string
minLength: 1
maxLength: 256
InvalidToken: {}
Timestamp:
type: string
format: date-time
ListActivitiesOutput:
type: object
required:
- activities
properties:
activities:
allOf:
- $ref: '#/components/schemas/ActivityList'
- description: The list of activities.
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.
PageToken:
type: string
minLength: 1
maxLength: 1024
Name:
type: string
minLength: 1
maxLength: 80
PageSize:
type: integer
minimum: 0
maximum: 1000
ActivityListItem:
type: object
required:
- activityArn
- name
- creationDate
properties:
activityArn:
allOf:
- $ref: '#/components/schemas/Arn'
- description: The Amazon Resource Name (ARN) that identifies the activity.
name:
allOf:
- $ref: '#/components/schemas/Name'
- description: 'The name of the activity.
A name must not contain:
white space
brackets < > { } [ ]
wildcard characters ? *
special characters " # % \ ^ | ~ ` $ & , ; : /
control characters (U+0000-001F, U+007F-009F)
To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.
' creationDate: allOf: - $ref: '#/components/schemas/Timestamp' - description: The date the activity is created. description: Contains details about an activity. parameters: X-Amz-Signature: name: X-Amz-Signature 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-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-Security-Token: name: X-Amz-Security-Token in: header schema: type: string required: false X-Amz-Credential: name: X-Amz-Credential in: header schema: type: string required: false securitySchemes: sigv4Auth: type: apiKey name: Authorization in: header description: AWS Signature Version 4 authentication externalDocs: description: Amazon Step Functions API Reference url: https://docs.aws.amazon.com/step-functions/latest/apireference/