AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Deprecates the specified workflow type. After a workflow type has been deprecated,
you cannot create new executions of that type. Executions that were started before
the type was deprecated continues to run. A deprecated workflow type may still be
used when calling visibility actions.
This operation is eventually consistent. The results are best effort and may not exactly
reflect recent updates and changes.
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.
For .NET Core this operation is only available in asynchronous form. Please refer to DeprecateWorkflowTypeAsync.
Namespace: Amazon.SimpleWorkflow
Assembly: AWSSDK.SimpleWorkflow.dll
Version: 3.x.y.z
public abstract DeprecateWorkflowTypeResponse DeprecateWorkflowType( DeprecateWorkflowTypeRequest request )
Container for the necessary parameters to execute the DeprecateWorkflowType service method.
Exception | Condition |
---|---|
OperationNotPermittedException | Returned when the caller doesn't have sufficient permissions to invoke the action. |
TypeDeprecatedException | Returned when the specified activity or workflow type was already deprecated. |
UnknownResourceException | Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation. |
.NET Framework:
Supported in: 4.5, 4.0, 3.5