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.DescribeActivityType

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns information about the specified activity type. This includes configuration settings provided when the type was registered and other general information about the type.

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.
- activityType.name: String constraint. The key is swf:activityType.name.
- activityType.version: String constraint. The key is swf:activityType.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 DescribeActivityType Source #

See: newDescribeActivityType smart constructor.

Constructors

DescribeActivityType'
Fields domain :: Text The name of the domain in which the activity type is registered. activityType :: ActivityType The activity type to get information about. Activity types are identified by the `name` and `version` that were supplied when the activity was registered.

Instances

Instances details

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

newDescribeActivityType Source #

Arguments

:: Text	`$sel:domain:DescribeActivityType'`
-> ActivityType	`$sel:activityType:DescribeActivityType'`
-> DescribeActivityType

Create a value of DescribeActivityType 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:DescribeActivityType', describeActivityType_domain - The name of the domain in which the activity type is registered.

$sel:activityType:DescribeActivityType', describeActivityType_activityType - The activity type to get information about. Activity types are identified by the name and version that were supplied when the activity was registered.

Request Lenses

describeActivityType_domain :: Lens' DescribeActivityType Text Source #

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

describeActivityType_activityType :: Lens' DescribeActivityType ActivityType Source #

The activity type to get information about. Activity types are identified by the name and version that were supplied when the activity was registered.

Destructuring the Response

data DescribeActivityTypeResponse Source #

Detailed information about an activity type.

See: newDescribeActivityTypeResponse smart constructor.

Constructors

DescribeActivityTypeResponse'

Fields

httpStatus :: Int
The response's http status code.
typeInfo :: ActivityTypeInfo
General information about the activity type.
The status of activity type (returned in the ActivityTypeInfo 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 DeprecateActivityType, but is still in use. You should keep workers supporting this type running. You cannot create new tasks of this type.
configuration :: ActivityTypeConfiguration
The configuration settings registered with the activity type.

Instances

Instances details

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

newDescribeActivityTypeResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeActivityTypeResponse'`
-> ActivityTypeInfo	`$sel:typeInfo:DescribeActivityTypeResponse'`
-> ActivityTypeConfiguration	`$sel:configuration:DescribeActivityTypeResponse'`
-> DescribeActivityTypeResponse

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

$sel:typeInfo:DescribeActivityTypeResponse', describeActivityTypeResponse_typeInfo - General information about the activity type.

The status of activity type (returned in the ActivityTypeInfo 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 DeprecateActivityType, but is still in use. You should keep workers supporting this type running. You cannot create new tasks of this type.

$sel:configuration:DescribeActivityTypeResponse', describeActivityTypeResponse_configuration - The configuration settings registered with the activity type.

Response Lenses

describeActivityTypeResponse_httpStatus :: Lens' DescribeActivityTypeResponse Int Source #

The response's http status code.

describeActivityTypeResponse_typeInfo :: Lens' DescribeActivityTypeResponse ActivityTypeInfo Source #

General information about the activity type.

The status of activity type (returned in the ActivityTypeInfo 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 DeprecateActivityType, but is still in use. You should keep workers supporting this type running. You cannot create new tasks of this type.

describeActivityTypeResponse_configuration :: Lens' DescribeActivityTypeResponse ActivityTypeConfiguration Source #

The configuration settings registered with the activity type.