Skip to content

Create Activity

sfn_create_activity R Documentation

Creates an activity

Description

Creates an activity. An activity is a task that you write in any programming language and host on any machine that has access to Step Functions. Activities must poll Step Functions using the get_activity_task API action and respond using ⁠SendTask*⁠ API actions. This function lets Step Functions know the existence of your activity and returns an identifier for use in a state machine and when polling from the activity.

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

create_activity is an idempotent API. Subsequent requests won’t create a duplicate resource if it was already created. create_activity's idempotency check is based on the activity name. If a following request has different tags values, Step Functions will ignore these differences and treat it as an idempotent request of the previous. In this case, tags will not be updated, even if they are different.

Usage

sfn_create_activity(name, tags, encryptionConfiguration)

Arguments

name

[required] The name of the activity to create. This name must be unique for your Amazon Web Services account and region for 90 days. For more information, see Limits Related to State Machine Executions in the Step Functions Developer Guide.

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 _.

[ ]: R:%20

tags

The list of tags to add to a resource.

An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide, and Controlling Access Using IAM Tags.

Tags may only contain Unicode letters, digits, white space, or these symbols: ⁠_ . : / = + - @⁠.

encryptionConfiguration

Settings to configure server-side encryption.

Value

A list with the following syntax: 

list(
  activityArn = "string",
  creationDate = as.POSIXct(
    "2015-01-01"
  )
)

Request syntax

svc$create_activity(
  name = "string",
  tags = list(
    list(
      key = "string",
      value = "string"
    )
  ),
  encryptionConfiguration = list(
    kmsKeyId = "string",
    kmsDataKeyReusePeriodSeconds = 123,
    type = "AWS_OWNED_KEY"|"CUSTOMER_MANAGED_KMS_KEY"
  )
)