From 840f49b37571f0d0e8621588712496cdc41a2bab Mon Sep 17 00:00:00 2001 From: Hiroki Yamazaki <121911537+ymhiroki@users.noreply.github.com> Date: Sat, 23 Mar 2024 03:33:02 +0900 Subject: [PATCH] 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* --- .../aws-stepfunctions-tasks/README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/packages/aws-cdk-lib/aws-stepfunctions-tasks/README.md b/packages/aws-cdk-lib/aws-stepfunctions-tasks/README.md index 17ab14275f6bb..789529547b6d6 100644 --- a/packages/aws-cdk-lib/aws-stepfunctions-tasks/README.md +++ b/packages/aws-cdk-lib/aws-stepfunctions-tasks/README.md @@ -61,8 +61,12 @@ This module is part of the [AWS Cloud Development Kit](https://github.com/aws/aw - [EventBridge](#eventbridge) - [Put Events](#put-events) - [Glue](#glue) + - [Start Job Run](#start-job-run) + - [Start Crawler Run](#startcrawlerrun) - [Glue DataBrew](#glue-databrew) + - [Start Job Run](#start-job-run-1) - [Lambda](#lambda) + - [Invoke](#invoke) - [SageMaker](#sagemaker) - [Create Training Job](#create-training-job) - [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 - [Create Model](#create-model) - [Update Endpoint](#update-endpoint) - [SNS](#sns) + - [Publish](#publish) - [Step Functions](#step-functions) - [Start Execution](#start-execution) - [Invoke Activity](#invoke-activity) - [SQS](#sqs) + - [Send Message](#send-message) ## Paths @@ -1119,6 +1125,8 @@ new tasks.GlueStartCrawlerRun(this, 'Task2', { Step Functions supports [AWS Glue DataBrew](https://docs.aws.amazon.com/step-functions/latest/dg/connect-databrew.html) through the service integration pattern. +### Start Job Run + You can call the [`StartJobRun`](https://docs.aws.amazon.com/databrew/latest/dg/API_StartJobRun.html) API from a `Task` state. ```ts @@ -1129,6 +1137,10 @@ new tasks.GlueDataBrewStartJobRun(this, 'Task', { ## Lambda +Step Functions supports [AWS Lambda](https://docs.aws.amazon.com/step-functions/latest/dg/connect-lambda.html) through the service integration pattern. + +### Invoke + [Invoke](https://docs.aws.amazon.com/lambda/latest/dg/API_Invoke.html) a Lambda function. You can specify the input to your Lambda function through the `payload` attribute. @@ -1363,6 +1375,8 @@ new tasks.SageMakerUpdateEndpoint(this, 'SagemakerEndpoint', { Step Functions supports [Amazon SNS](https://docs.aws.amazon.com/step-functions/latest/dg/connect-sns.html) through the service integration pattern. +### Publish + 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. ```ts @@ -1404,6 +1418,8 @@ const task2 = new tasks.SnsPublish(this, 'Publish2', { ## Step Functions +Step Functions supports [AWS Step Functions](https://docs.aws.amazon.com/step-functions/latest/dg/connect-stepfunctions.html) through the service integration pattern. + ### Start Execution 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', { Step Functions supports [Amazon SQS](https://docs.aws.amazon.com/step-functions/latest/dg/connect-sqs.html) +### Send Message + You can call the [`SendMessage`](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_SendMessage.html) API from a `Task` state to send a message to an SQS queue.