Skip to content

Commit 3091c8f

Browse files
authored
docs(stepfunctions-tasks): update the table of contents and headers in README (#29545)
### Reason for this change I didn't know which APIs are implemented at a glance because some headers are omitted in the README. ### Description of changes I added headers for all APIs and updated the table of contents to show all headers. ### Description of how you validated changes I checked the preview of the markdown format. ### Checklist - [x] My code adheres to the [CONTRIBUTING GUIDE](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) and [DESIGN GUIDELINES](https://github.com/aws/aws-cdk/blob/main/docs/DESIGN_GUIDELINES.md) ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
1 parent 56a4122 commit 3091c8f

File tree

1 file changed

+18
-0
lines changed
  • packages/aws-cdk-lib/aws-stepfunctions-tasks

1 file changed

+18
-0
lines changed

packages/aws-cdk-lib/aws-stepfunctions-tasks/README.md

+18
Original file line numberDiff line numberDiff line change
@@ -61,8 +61,12 @@ This module is part of the [AWS Cloud Development Kit](https://github.com/aws/aw
6161
- [EventBridge](#eventbridge)
6262
- [Put Events](#put-events)
6363
- [Glue](#glue)
64+
- [Start Job Run](#start-job-run)
65+
- [Start Crawler Run](#startcrawlerrun)
6466
- [Glue DataBrew](#glue-databrew)
67+
- [Start Job Run](#start-job-run-1)
6568
- [Lambda](#lambda)
69+
- [Invoke](#invoke)
6670
- [SageMaker](#sagemaker)
6771
- [Create Training Job](#create-training-job)
6872
- [Create Transform Job](#create-transform-job)
@@ -71,10 +75,12 @@ This module is part of the [AWS Cloud Development Kit](https://github.com/aws/aw
7175
- [Create Model](#create-model)
7276
- [Update Endpoint](#update-endpoint)
7377
- [SNS](#sns)
78+
- [Publish](#publish)
7479
- [Step Functions](#step-functions)
7580
- [Start Execution](#start-execution)
7681
- [Invoke Activity](#invoke-activity)
7782
- [SQS](#sqs)
83+
- [Send Message](#send-message)
7884

7985
## Paths
8086

@@ -1119,6 +1125,8 @@ new tasks.GlueStartCrawlerRun(this, 'Task2', {
11191125

11201126
Step Functions supports [AWS Glue DataBrew](https://docs.aws.amazon.com/step-functions/latest/dg/connect-databrew.html) through the service integration pattern.
11211127

1128+
### Start Job Run
1129+
11221130
You can call the [`StartJobRun`](https://docs.aws.amazon.com/databrew/latest/dg/API_StartJobRun.html) API from a `Task` state.
11231131

11241132
```ts
@@ -1129,6 +1137,10 @@ new tasks.GlueDataBrewStartJobRun(this, 'Task', {
11291137

11301138
## Lambda
11311139

1140+
Step Functions supports [AWS Lambda](https://docs.aws.amazon.com/step-functions/latest/dg/connect-lambda.html) through the service integration pattern.
1141+
1142+
### Invoke
1143+
11321144
[Invoke](https://docs.aws.amazon.com/lambda/latest/dg/API_Invoke.html) a Lambda function.
11331145

11341146
You can specify the input to your Lambda function through the `payload` attribute.
@@ -1363,6 +1375,8 @@ new tasks.SageMakerUpdateEndpoint(this, 'SagemakerEndpoint', {
13631375

13641376
Step Functions supports [Amazon SNS](https://docs.aws.amazon.com/step-functions/latest/dg/connect-sns.html) through the service integration pattern.
13651377

1378+
### Publish
1379+
13661380
You can call the [`Publish`](https://docs.aws.amazon.com/sns/latest/api/API_Publish.html) API from a `Task` state to publish to an SNS topic.
13671381

13681382
```ts
@@ -1404,6 +1418,8 @@ const task2 = new tasks.SnsPublish(this, 'Publish2', {
14041418

14051419
## Step Functions
14061420

1421+
Step Functions supports [AWS Step Functions](https://docs.aws.amazon.com/step-functions/latest/dg/connect-stepfunctions.html) through the service integration pattern.
1422+
14071423
### Start Execution
14081424

14091425
You can manage [AWS Step Functions](https://docs.aws.amazon.com/step-functions/latest/dg/connect-stepfunctions.html) executions.
@@ -1499,6 +1515,8 @@ new tasks.StepFunctionsInvokeActivity(this, 'Submit Job', {
14991515

15001516
Step Functions supports [Amazon SQS](https://docs.aws.amazon.com/step-functions/latest/dg/connect-sqs.html)
15011517

1518+
### Send Message
1519+
15021520
You can call the [`SendMessage`](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_SendMessage.html) API from a `Task` state
15031521
to send a message to an SQS queue.
15041522

0 commit comments

Comments
 (0)