activities

Creates, updates, deletes, gets or lists an activities resource.

Overview

Name	activities
Type	Resource
Id	aws.stepfunctions.activities

Fields

The following fields are returned by SELECT queries:

describe_activity

Name	Datatype	Description
name	string	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, U+FFFE-FFFF) surrogates (U+D800-DFFF) invalid characters ( U+10FFFF) To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.
activity_arn	string	The Amazon Resource Name (ARN) that identifies the activity.
creation_date	string (date-time)	The date the activity is created.
encryption_configuration	object	Settings for configured server-side encryption.

list_activities

Name	Datatype	Description
name	string	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, U+FFFE-FFFF) surrogates (U+D800-DFFF) invalid characters ( U+10FFFF) To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.
activity_arn	string	The Amazon Resource Name (ARN) that identifies the activity.
creation_date	string (date-time)	The date the activity is created.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_activity	select	region		Describes an activity. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
list_activities	select	region		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.
create_activity	insert	region, name		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 GetActivityTask 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. CreateActivity is an idempotent API. Subsequent requests won’t create a duplicate resource if it was already created. CreateActivity'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.
delete_activity	delete	region		Deletes an activity.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_activity

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

SELECT
name,
activity_arn,
creation_date,
encryption_configuration
FROM aws.stepfunctions.activities
WHERE region = '{{ region }}' -- required
;

list_activities

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.

SELECT
name,
activity_arn,
creation_date
FROM aws.stepfunctions.activities
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_activity

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 GetActivityTask 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. CreateActivity is an idempotent API. Subsequent requests won’t create a duplicate resource if it was already created. CreateActivity'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.

INSERT INTO aws.stepfunctions.activities (
name,
tags,
encryptionConfiguration,
region
)
SELECT 
'{{ name }}' /* required */,
'{{ tags }}',
'{{ encryptionConfiguration }}',
'{{ region }}'
RETURNING
activity_arn,
creation_date
;

Manifest

# Description fields are for documentation purposes
- name: activities
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the activities resource.
  - name: name
    value: "{{ name }}"
    description: |
      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, U+FFFE-FFFF) surrogates (U+D800-DFFF) invalid characters ( U+10FFFF) To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.
  - name: tags
    description: |
      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: _ . : / = + - @.
    value:
      - key: "{{ key }}"
        value: "{{ value }}"
  - name: encryptionConfiguration
    description: |
      Settings to configure server-side encryption.
    value:
      kmsKeyId: "{{ kmsKeyId }}"
      kmsDataKeyReusePeriodSeconds: {{ kmsDataKeyReusePeriodSeconds }}
      type_: "{{ type_ }}"

DELETE examples

delete_activity

Deletes an activity.

DELETE FROM aws.stepfunctions.activities
WHERE region = '{{ region }}' --required
;