Amazonka.SWF.DeprecateDomain

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.

Creating a Request

data DeprecateDomain

See: newDeprecateDomain smart constructor.

Constructors

DeprecateDomain'

Fields

• name :: Text

  The name of the domain to deprecate.

Instances

ToJSON DeprecateDomain

Defined in Amazonka.SWF.DeprecateDomain

Methods

toJSON :: DeprecateDomain -> Value

toEncoding :: DeprecateDomain -> Encoding

toJSONList :: [DeprecateDomain] -> Value

toEncodingList :: [DeprecateDomain] -> Encoding

ToHeaders DeprecateDomain

Defined in Amazonka.SWF.DeprecateDomain

Methods

toHeaders :: DeprecateDomain -> [Header]

ToPath DeprecateDomain

Defined in Amazonka.SWF.DeprecateDomain

Methods

toPath :: DeprecateDomain -> ByteString

ToQuery DeprecateDomain

Defined in Amazonka.SWF.DeprecateDomain

Methods

toQuery :: DeprecateDomain -> QueryString

AWSRequest DeprecateDomain

Defined in Amazonka.SWF.DeprecateDomain

Associated Types

type AWSResponse DeprecateDomain

Methods

request :: (Service -> Service) -> DeprecateDomain -> Request DeprecateDomain

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DeprecateDomain -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DeprecateDomain)))

Generic DeprecateDomain

Defined in Amazonka.SWF.DeprecateDomain

Associated Types

type Rep DeprecateDomain :: Type -> Type

Methods

from :: DeprecateDomain -> Rep DeprecateDomain x

to :: Rep DeprecateDomain x -> DeprecateDomain

Read DeprecateDomain

Defined in Amazonka.SWF.DeprecateDomain

Methods

readsPrec :: Int -> ReadS DeprecateDomain

readList :: ReadS [DeprecateDomain]

readPrec :: ReadPrec DeprecateDomain

readListPrec :: ReadPrec [DeprecateDomain]

Show DeprecateDomain

Defined in Amazonka.SWF.DeprecateDomain

Methods

showsPrec :: Int -> DeprecateDomain -> ShowS

show :: DeprecateDomain -> String

showList :: [DeprecateDomain] -> ShowS

NFData DeprecateDomain

Defined in Amazonka.SWF.DeprecateDomain

Methods

rnf :: DeprecateDomain -> ()

Eq DeprecateDomain

Defined in Amazonka.SWF.DeprecateDomain

Methods

(==) :: DeprecateDomain -> DeprecateDomain -> Bool

(/=) :: DeprecateDomain -> DeprecateDomain -> Bool

Hashable DeprecateDomain

Defined in Amazonka.SWF.DeprecateDomain

Methods

hashWithSalt :: Int -> DeprecateDomain -> Int

hash :: DeprecateDomain -> Int

type AWSResponse DeprecateDomain

Defined in Amazonka.SWF.DeprecateDomain

type AWSResponse DeprecateDomain = DeprecateDomainResponse

type Rep DeprecateDomain

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

Arguments

:: Text

DeprecateDomain

-> DeprecateDomain

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

The name of the domain to deprecate.

Destructuring the Response

data DeprecateDomainResponse

See: newDeprecateDomainResponse smart constructor.

Constructors

DeprecateDomainResponse'

Instances

Generic DeprecateDomainResponse

Defined in Amazonka.SWF.DeprecateDomain

Associated Types

type Rep DeprecateDomainResponse :: Type -> Type

Methods

from :: DeprecateDomainResponse -> Rep DeprecateDomainResponse x

to :: Rep DeprecateDomainResponse x -> DeprecateDomainResponse

Read DeprecateDomainResponse

Defined in Amazonka.SWF.DeprecateDomain

Methods

readsPrec :: Int -> ReadS DeprecateDomainResponse

readList :: ReadS [DeprecateDomainResponse]

readPrec :: ReadPrec DeprecateDomainResponse

readListPrec :: ReadPrec [DeprecateDomainResponse]

Show DeprecateDomainResponse

Defined in Amazonka.SWF.DeprecateDomain

Methods

showsPrec :: Int -> DeprecateDomainResponse -> ShowS

show :: DeprecateDomainResponse -> String

showList :: [DeprecateDomainResponse] -> ShowS

NFData DeprecateDomainResponse

Defined in Amazonka.SWF.DeprecateDomain

Methods

rnf :: DeprecateDomainResponse -> ()

Eq DeprecateDomainResponse

Defined in Amazonka.SWF.DeprecateDomain

Methods

(==) :: DeprecateDomainResponse -> DeprecateDomainResponse -> Bool

(/=) :: DeprecateDomainResponse -> DeprecateDomainResponse -> Bool

type Rep DeprecateDomainResponse

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

Create a value of DeprecateDomainResponse with all optional fields omitted.

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