Skip to content
AWS for Query.Farm

aws.swf.describe_activity_type

Example SQL Queries

SELECT * FROM
aws.swf.describe_activity_type
WHERE
"domain" = 'VALUE'
AND "activity_type" = 'VALUE';

Description

Returns information about the specified activity type. This includes configuration settings provided when the type was registered and other general information about the type.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.

  • Use an Action element to allow or deny permission to call this action.

  • Constrain the following parameters by using a Condition element with the appropriate keys.

    • activityType.name: String constraint. The key is swf:activityType.name.

    • activityType.version: String constraint. The key is swf:activityType.version.

If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

Table Definition

Column NameColumn Data Type
activity_type Required Input Column

The activity type to get information about. Activity types are identified by the name and version that were supplied when the activity was registered.

STRUCT(
    "name" VARCHAR,
    "version" VARCHAR
)
Show child fields
activity_type.name

The name of this activity.

The combination of activity type name and version must be unique within a domain.

activity_type.version

The version of this activity.

The combination of activity type name and version must be unique with in a domain.

domain Required Input Column

The name of the domain in which the activity type is registered.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
configuration

The configuration settings registered with the activity type.

STRUCT(
    "default_task_start_to_close_timeout" VARCHAR,
    "default_task_heartbeat_timeout" VARCHAR,
    "default_task_list" STRUCT(
        "name" VARCHAR
    ),
    "default_task_priority" VARCHAR,
    "default_task_schedule_to_start_timeout" VARCHAR,
    "default_task_schedule_to_close_timeout" VARCHAR
)
Show child fields
configuration.default_task_heartbeat_timeout

The default maximum time, in seconds, before which a worker processing a task must report progress by calling RecordActivityTaskHeartbeat.

You can specify this value only when registering an activity type. The registered default value can be overridden when you schedule a task through the ScheduleActivityTask Decision. If the activity worker subsequently attempts to record a heartbeat or returns a result, the activity worker receives an UnknownResource fault. In this case, Amazon SWF no longer considers the activity task to be valid; the activity worker should clean up the activity task.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

configuration.default_task_list

The default task list specified for this activity type at registration. This default is used if a task list isn't provided when a task is scheduled through the ScheduleActivityTask Decision. You can override the default registered task list when scheduling a task through the ScheduleActivityTask Decision.

Show child fields
configuration.default_task_list.name

The name of the task list.

configuration.default_task_priority

The default task priority for tasks of this activity type, specified at registration. If not set, then 0 is used as the default priority. This default can be overridden when scheduling an activity task.

Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.

configuration.default_task_schedule_to_close_timeout

The default maximum duration, specified when registering the activity type, for tasks of this activity type. You can override this default when scheduling a task through the ScheduleActivityTask Decision.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

configuration.default_task_schedule_to_start_timeout

The default maximum duration, specified when registering the activity type, that a task of an activity type can wait before being assigned to a worker. You can override this default when scheduling a task through the ScheduleActivityTask Decision.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

configuration.default_task_start_to_close_timeout

The default maximum duration for tasks of an activity type specified when registering the activity type. You can override this default when scheduling a task through the ScheduleActivityTask Decision.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

type_info

General information about the activity type.

The status of activity type (returned in the ActivityTypeInfo structure) can be one of the following.

  • REGISTERED – The type is registered and available. Workers supporting this type should be running.

  • DEPRECATED – The type was deprecated using DeprecateActivityType, but is still in use. You should keep workers supporting this type running. You cannot create new tasks of this type. 

STRUCT(
    "activity_type" STRUCT(
        "name" VARCHAR,
        "version" VARCHAR
    ),
    "status" VARCHAR,
    "description" VARCHAR,
    "creation_date" TIMESTAMP_S,
    "deprecation_date" TIMESTAMP_S
)
Show child fields
type_info.activity_type

The ActivityType type structure representing the activity type.

Show child fields
type_info.activity_type.name

The name of this activity.

The combination of activity type name and version must be unique within a domain.

type_info.activity_type.version

The version of this activity.

The combination of activity type name and version must be unique with in a domain.

type_info.creation_date

The date and time this activity type was created through RegisterActivityType.

type_info.deprecation_date

If DEPRECATED, the date and time DeprecateActivityType was called.

type_info.description

The description of the activity type provided in RegisterActivityType.

type_info.status

The current status of the activity type.