Network.AWS.SWF.DescribeActivityType

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 does not 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 will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

Creating a Request

describeActivityType

Arguments

:: Text

datDomain

-> ActivityType

datActivityType

-> DescribeActivityType

Creates a value of DescribeActivityType with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• datDomain
• datActivityType

data DescribeActivityType

See: describeActivityType smart constructor.

Instances

Eq DescribeActivityType

Methods

(==) :: DescribeActivityType -> DescribeActivityType -> Bool

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

Data DescribeActivityType

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeActivityType -> c DescribeActivityType

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeActivityType

toConstr :: DescribeActivityType -> Constr

dataTypeOf :: DescribeActivityType -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeActivityType)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeActivityType)

gmapT :: (forall b. Data b => b -> b) -> DescribeActivityType -> DescribeActivityType

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeActivityType -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeActivityType -> r

gmapQ :: (forall d. Data d => d -> u) -> DescribeActivityType -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeActivityType -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeActivityType -> m DescribeActivityType

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeActivityType -> m DescribeActivityType

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeActivityType -> m DescribeActivityType

Read DescribeActivityType

Methods

readsPrec :: Int -> ReadS DescribeActivityType

readList :: ReadS [DescribeActivityType]

readPrec :: ReadPrec DescribeActivityType

readListPrec :: ReadPrec [DescribeActivityType]

Show DescribeActivityType

Methods

showsPrec :: Int -> DescribeActivityType -> ShowS

show :: DescribeActivityType -> String

showList :: [DescribeActivityType] -> ShowS

Generic DescribeActivityType

Associated Types

type Rep DescribeActivityType :: * -> *

Methods

from :: DescribeActivityType -> Rep DescribeActivityType x

to :: Rep DescribeActivityType x -> DescribeActivityType

Hashable DescribeActivityType

Methods

hashWithSalt :: Int -> DescribeActivityType -> Int

hash :: DescribeActivityType -> Int

ToJSON DescribeActivityType

Methods

toJSON :: DescribeActivityType -> Value

toEncoding :: DescribeActivityType -> Encoding

toJSONList :: [DescribeActivityType] -> Value

toEncodingList :: [DescribeActivityType] -> Encoding

NFData DescribeActivityType

Methods

rnf :: DescribeActivityType -> ()

AWSRequest DescribeActivityType

Associated Types

type Rs DescribeActivityType :: *

Methods

request :: DescribeActivityType -> Request DescribeActivityType

response :: MonadResource m => Logger -> Service -> Proxy * DescribeActivityType -> ClientResponse -> m (Response DescribeActivityType)

ToQuery DescribeActivityType

Methods

toQuery :: DescribeActivityType -> QueryString

ToPath DescribeActivityType

Methods

toPath :: DescribeActivityType -> ByteString

ToHeaders DescribeActivityType

Methods

toHeaders :: DescribeActivityType -> [Header]

type Rep DescribeActivityType

type Rep DescribeActivityType = D1 (MetaData "DescribeActivityType" "Network.AWS.SWF.DescribeActivityType" "amazonka-swf-1.4.3-CUgUcKlV8EhcLLfbuVW5c" False) (C1 (MetaCons "DescribeActivityType'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_datDomain") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_datActivityType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 ActivityType))))

type Rs DescribeActivityType

type Rs DescribeActivityType = DescribeActivityTypeResponse

Request Lenses

datDomain :: Lens' DescribeActivityType Text

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

datActivityType :: Lens' 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.

Destructuring the Response

describeActivityTypeResponse

Arguments

:: Int

datrsResponseStatus

-> ActivityTypeInfo

datrsTypeInfo

-> ActivityTypeConfiguration

datrsConfiguration

-> DescribeActivityTypeResponse

Creates a value of DescribeActivityTypeResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• datrsResponseStatus
• datrsTypeInfo
• datrsConfiguration

data DescribeActivityTypeResponse

Detailed information about an activity type.

See: describeActivityTypeResponse smart constructor.

Instances

Eq DescribeActivityTypeResponse

Methods

(==) :: DescribeActivityTypeResponse -> DescribeActivityTypeResponse -> Bool

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

Data DescribeActivityTypeResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeActivityTypeResponse -> c DescribeActivityTypeResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeActivityTypeResponse

toConstr :: DescribeActivityTypeResponse -> Constr

dataTypeOf :: DescribeActivityTypeResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeActivityTypeResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeActivityTypeResponse)

gmapT :: (forall b. Data b => b -> b) -> DescribeActivityTypeResponse -> DescribeActivityTypeResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeActivityTypeResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeActivityTypeResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> DescribeActivityTypeResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeActivityTypeResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeActivityTypeResponse -> m DescribeActivityTypeResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeActivityTypeResponse -> m DescribeActivityTypeResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeActivityTypeResponse -> m DescribeActivityTypeResponse

Read DescribeActivityTypeResponse

Methods

readsPrec :: Int -> ReadS DescribeActivityTypeResponse

readList :: ReadS [DescribeActivityTypeResponse]

readPrec :: ReadPrec DescribeActivityTypeResponse

readListPrec :: ReadPrec [DescribeActivityTypeResponse]

Show DescribeActivityTypeResponse

Methods

showsPrec :: Int -> DescribeActivityTypeResponse -> ShowS

show :: DescribeActivityTypeResponse -> String

showList :: [DescribeActivityTypeResponse] -> ShowS

Generic DescribeActivityTypeResponse

Associated Types

type Rep DescribeActivityTypeResponse :: * -> *

Methods

from :: DescribeActivityTypeResponse -> Rep DescribeActivityTypeResponse x

to :: Rep DescribeActivityTypeResponse x -> DescribeActivityTypeResponse

NFData DescribeActivityTypeResponse

Methods

rnf :: DescribeActivityTypeResponse -> ()

type Rep DescribeActivityTypeResponse

type Rep DescribeActivityTypeResponse = D1 (MetaData "DescribeActivityTypeResponse" "Network.AWS.SWF.DescribeActivityType" "amazonka-swf-1.4.3-CUgUcKlV8EhcLLfbuVW5c" False) (C1 (MetaCons "DescribeActivityTypeResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_datrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)) ((:*:) (S1 (MetaSel (Just Symbol "_datrsTypeInfo") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 ActivityTypeInfo)) (S1 (MetaSel (Just Symbol "_datrsConfiguration") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 ActivityTypeConfiguration)))))

Response Lenses

datrsResponseStatus :: Lens' DescribeActivityTypeResponse Int

The response status code.

datrsTypeInfo :: Lens' DescribeActivityTypeResponse 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.

datrsConfiguration :: Lens' DescribeActivityTypeResponse ActivityTypeConfiguration

The configuration settings registered with the activity type.