Amazon Simple Workflow Service

2024/05/28 - Amazon Simple Workflow Service - 2 new api methods

Changes  This release adds new APIs for deleting activity type and workflow type resources.

DeleteWorkflowType (new) Link ¶

Deletes the specified workflow type .

Note: Prior to deletion, workflow types must first be deprecated .

After a workflow type has been deleted, you cannot create new executions of that type. Executions that started before the type was deleted will continue to run.

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.

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

    • workflowType.version : String constraint. The key is swf:workflowType.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 .

See also: AWS API Documentation

Request Syntax

client.delete_workflow_type(
    domain='string',
    workflowType={
        'name': 'string',
        'version': 'string'
    }
)
type domain

string

param domain

[REQUIRED]

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

type workflowType

dict

param workflowType

[REQUIRED]

The workflow type to delete.

  • name (string) -- [REQUIRED]

    The name of the workflow type.

    Note

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

  • version (string) -- [REQUIRED]

    The version of the workflow type.

    Note

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

returns

None

DeleteActivityType (new) Link ¶

Deletes the specified activity type .

Note: Prior to deletion, activity types must first be deprecated .

After an activity type has been deleted, you cannot schedule new activities of that type. Activities that started before the type was deleted will continue to run.

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 .

See also: AWS API Documentation

Request Syntax

client.delete_activity_type(
    domain='string',
    activityType={
        'name': 'string',
        'version': 'string'
    }
)
type domain

string

param domain

[REQUIRED]

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

type activityType

dict

param activityType

[REQUIRED]

The activity type to delete.

  • name (string) -- [REQUIRED]

    The name of this activity.

    Note

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

  • version (string) -- [REQUIRED]

    The version of this activity.

    Note

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

returns

None