Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.SWF.DescribeWorkflowType

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns information about the specified workflow type. This includes configuration settings specified when the type was registered and other information such as creation date, current status, etc.

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 DescribeWorkflowType Source #

See: newDescribeWorkflowType smart constructor.

Constructors

DescribeWorkflowType'
Fields domain :: Text The name of the domain in which this workflow type is registered. workflowType :: WorkflowType The workflow type to describe.

Instances

Instances details

Eq DescribeWorkflowType Source #
Instance details Defined in Amazonka.SWF.DescribeWorkflowType Methods (==) :: DescribeWorkflowType -> DescribeWorkflowType -> Bool # (/=) :: DescribeWorkflowType -> DescribeWorkflowType -> Bool #
Read DescribeWorkflowType Source #
Instance details Defined in Amazonka.SWF.DescribeWorkflowType Methods readsPrec :: Int -> ReadS DescribeWorkflowType # readList :: ReadS [DescribeWorkflowType] # readPrec :: ReadPrec DescribeWorkflowType # readListPrec :: ReadPrec [DescribeWorkflowType] #
Show DescribeWorkflowType Source #
Instance details Defined in Amazonka.SWF.DescribeWorkflowType Methods showsPrec :: Int -> DescribeWorkflowType -> ShowS # show :: DescribeWorkflowType -> String # showList :: [DescribeWorkflowType] -> ShowS #
Generic DescribeWorkflowType Source #
Instance details Defined in Amazonka.SWF.DescribeWorkflowType Associated Types type Rep DescribeWorkflowType :: Type -> Type # Methods from :: DescribeWorkflowType -> Rep DescribeWorkflowType x # to :: Rep DescribeWorkflowType x -> DescribeWorkflowType #
NFData DescribeWorkflowType Source #
Instance details Defined in Amazonka.SWF.DescribeWorkflowType Methods rnf :: DescribeWorkflowType -> () #
Hashable DescribeWorkflowType Source #
Instance details Defined in Amazonka.SWF.DescribeWorkflowType Methods hashWithSalt :: Int -> DescribeWorkflowType -> Int # hash :: DescribeWorkflowType -> Int #
ToJSON DescribeWorkflowType Source #
Instance details Defined in Amazonka.SWF.DescribeWorkflowType Methods toJSON :: DescribeWorkflowType -> Value # toEncoding :: DescribeWorkflowType -> Encoding # toJSONList :: [DescribeWorkflowType] -> Value # toEncodingList :: [DescribeWorkflowType] -> Encoding #
AWSRequest DescribeWorkflowType Source #
Instance details Defined in Amazonka.SWF.DescribeWorkflowType Associated Types type AWSResponse DescribeWorkflowType # Methods request :: DescribeWorkflowType -> Request DescribeWorkflowType # response :: MonadResource m => Logger -> Service -> Proxy DescribeWorkflowType -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeWorkflowType))) #
ToHeaders DescribeWorkflowType Source #
Instance details Defined in Amazonka.SWF.DescribeWorkflowType Methods toHeaders :: DescribeWorkflowType -> [Header] #
ToPath DescribeWorkflowType Source #
Instance details Defined in Amazonka.SWF.DescribeWorkflowType Methods toPath :: DescribeWorkflowType -> ByteString #
ToQuery DescribeWorkflowType Source #
Instance details Defined in Amazonka.SWF.DescribeWorkflowType Methods toQuery :: DescribeWorkflowType -> QueryString #
type Rep DescribeWorkflowType Source #
Instance details Defined in Amazonka.SWF.DescribeWorkflowType type Rep DescribeWorkflowType = D1 ('MetaData "DescribeWorkflowType" "Amazonka.SWF.DescribeWorkflowType" "libZSservicesZSamazonka-swfZSamazonka-swf" 'False) (C1 ('MetaCons "DescribeWorkflowType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "domain") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "workflowType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 WorkflowType)))
type AWSResponse DescribeWorkflowType Source #
Instance details Defined in Amazonka.SWF.DescribeWorkflowType type AWSResponse DescribeWorkflowType = DescribeWorkflowTypeResponse

newDescribeWorkflowType Source #

Arguments

:: Text	`$sel:domain:DescribeWorkflowType'`
-> WorkflowType	`$sel:workflowType:DescribeWorkflowType'`
-> DescribeWorkflowType

Create a value of DescribeWorkflowType 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:DescribeWorkflowType', describeWorkflowType_domain - The name of the domain in which this workflow type is registered.

$sel:workflowType:DescribeWorkflowType', describeWorkflowType_workflowType - The workflow type to describe.

Request Lenses

describeWorkflowType_domain :: Lens' DescribeWorkflowType Text Source #

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

describeWorkflowType_workflowType :: Lens' DescribeWorkflowType WorkflowType Source #

The workflow type to describe.

Destructuring the Response

data DescribeWorkflowTypeResponse Source #

Contains details about a workflow type.

See: newDescribeWorkflowTypeResponse smart constructor.

Constructors

DescribeWorkflowTypeResponse'

Fields

httpStatus :: Int
The response's http status code.
typeInfo :: WorkflowTypeInfo
General information about the workflow type.
The status of the workflow type (returned in the WorkflowTypeInfo structure) can be one of the following.
- REGISTERED – The type is registered and available. Workers supporting this type should be running.
- DEPRECATED – The type was deprecated using DeprecateWorkflowType, but is still in use. You should keep workers supporting this type running. You cannot create new workflow executions of this type.
configuration :: WorkflowTypeConfiguration
Configuration settings of the workflow type registered through RegisterWorkflowType

Instances

Instances details

Eq DescribeWorkflowTypeResponse Source #
Instance details Defined in Amazonka.SWF.DescribeWorkflowType Methods (==) :: DescribeWorkflowTypeResponse -> DescribeWorkflowTypeResponse -> Bool # (/=) :: DescribeWorkflowTypeResponse -> DescribeWorkflowTypeResponse -> Bool #
Read DescribeWorkflowTypeResponse Source #
Instance details Defined in Amazonka.SWF.DescribeWorkflowType Methods readsPrec :: Int -> ReadS DescribeWorkflowTypeResponse # readList :: ReadS [DescribeWorkflowTypeResponse] # readPrec :: ReadPrec DescribeWorkflowTypeResponse # readListPrec :: ReadPrec [DescribeWorkflowTypeResponse] #
Show DescribeWorkflowTypeResponse Source #
Instance details Defined in Amazonka.SWF.DescribeWorkflowType Methods showsPrec :: Int -> DescribeWorkflowTypeResponse -> ShowS # show :: DescribeWorkflowTypeResponse -> String # showList :: [DescribeWorkflowTypeResponse] -> ShowS #
Generic DescribeWorkflowTypeResponse Source #
Instance details Defined in Amazonka.SWF.DescribeWorkflowType Associated Types type Rep DescribeWorkflowTypeResponse :: Type -> Type # Methods from :: DescribeWorkflowTypeResponse -> Rep DescribeWorkflowTypeResponse x # to :: Rep DescribeWorkflowTypeResponse x -> DescribeWorkflowTypeResponse #
NFData DescribeWorkflowTypeResponse Source #
Instance details Defined in Amazonka.SWF.DescribeWorkflowType Methods rnf :: DescribeWorkflowTypeResponse -> () #
type Rep DescribeWorkflowTypeResponse Source #
Instance details Defined in Amazonka.SWF.DescribeWorkflowType type Rep DescribeWorkflowTypeResponse = D1 ('MetaData "DescribeWorkflowTypeResponse" "Amazonka.SWF.DescribeWorkflowType" "libZSservicesZSamazonka-swfZSamazonka-swf" 'False) (C1 ('MetaCons "DescribeWorkflowTypeResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: (S1 ('MetaSel ('Just "typeInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 WorkflowTypeInfo) :: S1 ('MetaSel ('Just "configuration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 WorkflowTypeConfiguration))))

newDescribeWorkflowTypeResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeWorkflowTypeResponse'`
-> WorkflowTypeInfo	`$sel:typeInfo:DescribeWorkflowTypeResponse'`
-> WorkflowTypeConfiguration	`$sel:configuration:DescribeWorkflowTypeResponse'`
-> DescribeWorkflowTypeResponse

Create a value of DescribeWorkflowTypeResponse 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:httpStatus:DescribeWorkflowTypeResponse', describeWorkflowTypeResponse_httpStatus - The response's http status code.

$sel:typeInfo:DescribeWorkflowTypeResponse', describeWorkflowTypeResponse_typeInfo - General information about the workflow type.

The status of the workflow type (returned in the WorkflowTypeInfo structure) can be one of the following.

REGISTERED – The type is registered and available. Workers supporting this type should be running.
DEPRECATED – The type was deprecated using DeprecateWorkflowType, but is still in use. You should keep workers supporting this type running. You cannot create new workflow executions of this type.

$sel:configuration:DescribeWorkflowTypeResponse', describeWorkflowTypeResponse_configuration - Configuration settings of the workflow type registered through RegisterWorkflowType

Response Lenses

describeWorkflowTypeResponse_httpStatus :: Lens' DescribeWorkflowTypeResponse Int Source #

The response's http status code.

describeWorkflowTypeResponse_typeInfo :: Lens' DescribeWorkflowTypeResponse WorkflowTypeInfo Source #

General information about the workflow type.

The status of the workflow type (returned in the WorkflowTypeInfo structure) can be one of the following.

REGISTERED – The type is registered and available. Workers supporting this type should be running.
DEPRECATED – The type was deprecated using DeprecateWorkflowType, but is still in use. You should keep workers supporting this type running. You cannot create new workflow executions of this type.

describeWorkflowTypeResponse_configuration :: Lens' DescribeWorkflowTypeResponse WorkflowTypeConfiguration Source #

Configuration settings of the workflow type registered through RegisterWorkflowType