{-# LANGUAGE DeriveDataTypeable #-} {-# LANGUAGE DeriveGeneric #-} {-# LANGUAGE OverloadedStrings #-} {-# LANGUAGE RecordWildCards #-} {-# LANGUAGE TypeFamilies #-} {-# OPTIONS_GHC -fno-warn-unused-imports #-} {-# OPTIONS_GHC -fno-warn-unused-binds #-} {-# OPTIONS_GHC -fno-warn-unused-matches #-} -- Derived from AWS service descriptions, licensed under Apache 2.0. -- | -- Module : Network.AWS.SWF.DescribeActivityType -- Copyright : (c) 2013-2015 Brendan Hay -- License : Mozilla Public License, v. 2.0. -- Maintainer : Brendan Hay -- Stability : auto-generated -- Portability : non-portable (GHC extensions) -- -- 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 -- . -- -- /See:/ for DescribeActivityType. module Network.AWS.SWF.DescribeActivityType ( -- * Creating a Request describeActivityType , DescribeActivityType -- * Request Lenses , datDomain , datActivityType -- * Destructuring the Response , describeActivityTypeResponse , DescribeActivityTypeResponse -- * Response Lenses , datrsStatus , datrsTypeInfo , datrsConfiguration ) where import Network.AWS.Prelude import Network.AWS.Request import Network.AWS.Response import Network.AWS.SWF.Types import Network.AWS.SWF.Types.Product -- | /See:/ 'describeActivityType' smart constructor. data DescribeActivityType = DescribeActivityType' { _datDomain :: !Text , _datActivityType :: !ActivityType } deriving (Eq,Read,Show,Data,Typeable,Generic) -- | 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' describeActivityType :: Text -- ^ 'datDomain' -> ActivityType -- ^ 'datActivityType' -> DescribeActivityType describeActivityType pDomain_ pActivityType_ = DescribeActivityType' { _datDomain = pDomain_ , _datActivityType = pActivityType_ } -- | The name of the domain in which the activity type is registered. datDomain :: Lens' DescribeActivityType Text datDomain = lens _datDomain (\ s a -> s{_datDomain = a}); -- | The activity type to get information about. Activity types are -- identified by the 'name' and 'version' that were supplied when the -- activity was registered. datActivityType :: Lens' DescribeActivityType ActivityType datActivityType = lens _datActivityType (\ s a -> s{_datActivityType = a}); instance AWSRequest DescribeActivityType where type Sv DescribeActivityType = SWF type Rs DescribeActivityType = DescribeActivityTypeResponse request = postJSON response = receiveJSON (\ s h x -> DescribeActivityTypeResponse' <$> (pure (fromEnum s)) <*> (x .:> "typeInfo") <*> (x .:> "configuration")) instance ToHeaders DescribeActivityType where toHeaders = const (mconcat ["X-Amz-Target" =# ("SimpleWorkflowService.DescribeActivityType" :: ByteString), "Content-Type" =# ("application/x-amz-json-1.0" :: ByteString)]) instance ToJSON DescribeActivityType where toJSON DescribeActivityType'{..} = object ["domain" .= _datDomain, "activityType" .= _datActivityType] instance ToPath DescribeActivityType where toPath = const "/" instance ToQuery DescribeActivityType where toQuery = const mempty -- | Detailed information about an activity type. -- -- /See:/ 'describeActivityTypeResponse' smart constructor. data DescribeActivityTypeResponse = DescribeActivityTypeResponse' { _datrsStatus :: !Int , _datrsTypeInfo :: !ActivityTypeInfo , _datrsConfiguration :: !ActivityTypeConfiguration } deriving (Eq,Read,Show,Data,Typeable,Generic) -- | 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: -- -- * 'datrsStatus' -- -- * 'datrsTypeInfo' -- -- * 'datrsConfiguration' describeActivityTypeResponse :: Int -- ^ 'datrsStatus' -> ActivityTypeInfo -- ^ 'datrsTypeInfo' -> ActivityTypeConfiguration -- ^ 'datrsConfiguration' -> DescribeActivityTypeResponse describeActivityTypeResponse pStatus_ pTypeInfo_ pConfiguration_ = DescribeActivityTypeResponse' { _datrsStatus = pStatus_ , _datrsTypeInfo = pTypeInfo_ , _datrsConfiguration = pConfiguration_ } -- | The response status code. datrsStatus :: Lens' DescribeActivityTypeResponse Int datrsStatus = lens _datrsStatus (\ s a -> s{_datrsStatus = a}); -- | 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. datrsTypeInfo :: Lens' DescribeActivityTypeResponse ActivityTypeInfo datrsTypeInfo = lens _datrsTypeInfo (\ s a -> s{_datrsTypeInfo = a}); -- | The configuration settings registered with the activity type. datrsConfiguration :: Lens' DescribeActivityTypeResponse ActivityTypeConfiguration datrsConfiguration = lens _datrsConfiguration (\ s a -> s{_datrsConfiguration = a});