openapi: 3.1.0
info:
title: 'Amazon Step Functions Executions #X Amz Target=AWSStepFunctions.DescribeActivity 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.DescribeActivity'
paths:
/#X-Amz-Target=AWSStepFunctions.DescribeActivity:
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: DescribeActivity
description:
Describes an activity.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeActivityOutput'
examples:
DescribeActivity200Example:
summary: Default DescribeActivity 200
x-microcks-default: true
value:
activityArn: arn:aws:service:us-east-1:123456789012:resource/example
name: MyResource
creationDate: example-value
'480':
description: ActivityDoesNotExist
content:
application/json:
schema:
$ref: '#/components/schemas/ActivityDoesNotExist'
examples:
DescribeActivity480Example:
summary: Default DescribeActivity 480
x-microcks-default: true
value: example-value
'481':
description: InvalidArn
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidArn'
examples:
DescribeActivity481Example:
summary: Default DescribeActivity 481
x-microcks-default: true
value: example-value
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeActivityInput'
examples:
DescribeActivityRequestExample:
summary: Default DescribeActivity request
x-microcks-default: true
value:
activityArn: arn:aws:service:us-east-1:123456789012:resource/example
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSStepFunctions.DescribeActivity
summary: Amazon Describe Activity
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- '#X Amz Target=AWSStepFunctions.DescribeActivity'
components:
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-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-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
schemas:
DescribeActivityInput:
type: object
required:
- activityArn
title: DescribeActivityInput
properties:
activityArn:
allOf:
- $ref: '#/components/schemas/Arn'
- description: The Amazon Resource Name (ARN) of the activity to describe.
ActivityDoesNotExist: {}
Arn:
type: string
minLength: 1
maxLength: 256
InvalidArn: {}
Timestamp:
type: string
format: date-time
DescribeActivityOutput:
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.
Name:
type: string
minLength: 1
maxLength: 80
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/