libZSservicesZSamazonka-swfZSamazonka-swf
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.SWF.DeprecateWorkflowType

Description

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.

Synopsis

Creating a Request

data DeprecateWorkflowType Source #

See: newDeprecateWorkflowType smart constructor.

Constructors

DeprecateWorkflowType' 

Fields

Instances

Instances details
Eq DeprecateWorkflowType Source # 
Instance details

Defined in Amazonka.SWF.DeprecateWorkflowType

Read DeprecateWorkflowType Source # 
Instance details

Defined in Amazonka.SWF.DeprecateWorkflowType

Show DeprecateWorkflowType Source # 
Instance details

Defined in Amazonka.SWF.DeprecateWorkflowType

Generic DeprecateWorkflowType Source # 
Instance details

Defined in Amazonka.SWF.DeprecateWorkflowType

Associated Types

type Rep DeprecateWorkflowType :: Type -> Type #

NFData DeprecateWorkflowType Source # 
Instance details

Defined in Amazonka.SWF.DeprecateWorkflowType

Methods

rnf :: DeprecateWorkflowType -> () #

Hashable DeprecateWorkflowType Source # 
Instance details

Defined in Amazonka.SWF.DeprecateWorkflowType

ToJSON DeprecateWorkflowType Source # 
Instance details

Defined in Amazonka.SWF.DeprecateWorkflowType

AWSRequest DeprecateWorkflowType Source # 
Instance details

Defined in Amazonka.SWF.DeprecateWorkflowType

Associated Types

type AWSResponse DeprecateWorkflowType #

ToHeaders DeprecateWorkflowType Source # 
Instance details

Defined in Amazonka.SWF.DeprecateWorkflowType

ToPath DeprecateWorkflowType Source # 
Instance details

Defined in Amazonka.SWF.DeprecateWorkflowType

ToQuery DeprecateWorkflowType Source # 
Instance details

Defined in Amazonka.SWF.DeprecateWorkflowType

type Rep DeprecateWorkflowType Source # 
Instance details

Defined in Amazonka.SWF.DeprecateWorkflowType

type Rep DeprecateWorkflowType = D1 ('MetaData "DeprecateWorkflowType" "Amazonka.SWF.DeprecateWorkflowType" "libZSservicesZSamazonka-swfZSamazonka-swf" 'False) (C1 ('MetaCons "DeprecateWorkflowType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "domain") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "workflowType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 WorkflowType)))
type AWSResponse DeprecateWorkflowType Source # 
Instance details

Defined in Amazonka.SWF.DeprecateWorkflowType

newDeprecateWorkflowType Source #

Create a value of DeprecateWorkflowType with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:domain:DeprecateWorkflowType', deprecateWorkflowType_domain - The name of the domain in which the workflow type is registered.

$sel:workflowType:DeprecateWorkflowType', deprecateWorkflowType_workflowType - The workflow type to deprecate.

Request Lenses

deprecateWorkflowType_domain :: Lens' DeprecateWorkflowType Text Source #

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

Destructuring the Response

data DeprecateWorkflowTypeResponse Source #

See: newDeprecateWorkflowTypeResponse smart constructor.

Instances

Instances details
Eq DeprecateWorkflowTypeResponse Source # 
Instance details

Defined in Amazonka.SWF.DeprecateWorkflowType

Read DeprecateWorkflowTypeResponse Source # 
Instance details

Defined in Amazonka.SWF.DeprecateWorkflowType

Show DeprecateWorkflowTypeResponse Source # 
Instance details

Defined in Amazonka.SWF.DeprecateWorkflowType

Generic DeprecateWorkflowTypeResponse Source # 
Instance details

Defined in Amazonka.SWF.DeprecateWorkflowType

Associated Types

type Rep DeprecateWorkflowTypeResponse :: Type -> Type #

NFData DeprecateWorkflowTypeResponse Source # 
Instance details

Defined in Amazonka.SWF.DeprecateWorkflowType

type Rep DeprecateWorkflowTypeResponse Source # 
Instance details

Defined in Amazonka.SWF.DeprecateWorkflowType

type Rep DeprecateWorkflowTypeResponse = D1 ('MetaData "DeprecateWorkflowTypeResponse" "Amazonka.SWF.DeprecateWorkflowType" "libZSservicesZSamazonka-swfZSamazonka-swf" 'False) (C1 ('MetaCons "DeprecateWorkflowTypeResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newDeprecateWorkflowTypeResponse :: DeprecateWorkflowTypeResponse Source #

Create a value of DeprecateWorkflowTypeResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.