amazonka-swf-2.0: Amazon Simple Workflow Service SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.SWF.DeprecateDomain

Description

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.

Synopsis

Creating a Request

data DeprecateDomain Source #

See: newDeprecateDomain smart constructor.

Constructors

DeprecateDomain' 

Fields

  • name :: Text

    The name of the domain to deprecate.

Instances

Instances details
ToJSON DeprecateDomain Source # 
Instance details

Defined in Amazonka.SWF.DeprecateDomain

ToHeaders DeprecateDomain Source # 
Instance details

Defined in Amazonka.SWF.DeprecateDomain

ToPath DeprecateDomain Source # 
Instance details

Defined in Amazonka.SWF.DeprecateDomain

ToQuery DeprecateDomain Source # 
Instance details

Defined in Amazonka.SWF.DeprecateDomain

AWSRequest DeprecateDomain Source # 
Instance details

Defined in Amazonka.SWF.DeprecateDomain

Associated Types

type AWSResponse DeprecateDomain #

Generic DeprecateDomain Source # 
Instance details

Defined in Amazonka.SWF.DeprecateDomain

Associated Types

type Rep DeprecateDomain :: Type -> Type #

Read DeprecateDomain Source # 
Instance details

Defined in Amazonka.SWF.DeprecateDomain

Show DeprecateDomain Source # 
Instance details

Defined in Amazonka.SWF.DeprecateDomain

NFData DeprecateDomain Source # 
Instance details

Defined in Amazonka.SWF.DeprecateDomain

Methods

rnf :: DeprecateDomain -> () #

Eq DeprecateDomain Source # 
Instance details

Defined in Amazonka.SWF.DeprecateDomain

Hashable DeprecateDomain Source # 
Instance details

Defined in Amazonka.SWF.DeprecateDomain

type AWSResponse DeprecateDomain Source # 
Instance details

Defined in Amazonka.SWF.DeprecateDomain

type Rep DeprecateDomain Source # 
Instance details

Defined in Amazonka.SWF.DeprecateDomain

type Rep DeprecateDomain = D1 ('MetaData "DeprecateDomain" "Amazonka.SWF.DeprecateDomain" "amazonka-swf-2.0-DdTBZQl9wbxDbv1sov8BbM" 'False) (C1 ('MetaCons "DeprecateDomain'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDeprecateDomain Source #

Create a value of DeprecateDomain 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:

DeprecateDomain, deprecateDomain_name - The name of the domain to deprecate.

Request Lenses

deprecateDomain_name :: Lens' DeprecateDomain Text Source #

The name of the domain to deprecate.

Destructuring the Response

data DeprecateDomainResponse Source #

See: newDeprecateDomainResponse smart constructor.

Instances

Instances details
Generic DeprecateDomainResponse Source # 
Instance details

Defined in Amazonka.SWF.DeprecateDomain

Associated Types

type Rep DeprecateDomainResponse :: Type -> Type #

Read DeprecateDomainResponse Source # 
Instance details

Defined in Amazonka.SWF.DeprecateDomain

Show DeprecateDomainResponse Source # 
Instance details

Defined in Amazonka.SWF.DeprecateDomain

NFData DeprecateDomainResponse Source # 
Instance details

Defined in Amazonka.SWF.DeprecateDomain

Methods

rnf :: DeprecateDomainResponse -> () #

Eq DeprecateDomainResponse Source # 
Instance details

Defined in Amazonka.SWF.DeprecateDomain

type Rep DeprecateDomainResponse Source # 
Instance details

Defined in Amazonka.SWF.DeprecateDomain

type Rep DeprecateDomainResponse = D1 ('MetaData "DeprecateDomainResponse" "Amazonka.SWF.DeprecateDomain" "amazonka-swf-2.0-DdTBZQl9wbxDbv1sov8BbM" 'False) (C1 ('MetaCons "DeprecateDomainResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newDeprecateDomainResponse :: DeprecateDomainResponse Source #

Create a value of DeprecateDomainResponse with all optional fields omitted.

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