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 domain. After a domain has been deprecated it cannot be used
to create new workflow executions or register new types. However, you can still use
visibility actions on this domain. Deprecating a domain also deprecates all activity
and workflow types registered in the domain. Executions that were started before the
domain was deprecated continues to run.
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.
You cannot use an IAM policy to constrain this action's parameters.
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 DeprecateDomainAsync.
Namespace: Amazon.SimpleWorkflow
Assembly: AWSSDK.SimpleWorkflow.dll
Version: 3.x.y.z
public abstract DeprecateDomainResponse DeprecateDomain( DeprecateDomainRequest request )
Container for the necessary parameters to execute the DeprecateDomain service method.
Exception | Condition |
---|---|
DomainDeprecatedException | Returned when the specified domain has been deprecated. |
OperationNotPermittedException | Returned when the caller doesn't have sufficient permissions to invoke the action. |
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 and newer, 3.5