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

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

ToJSON DescribeActivityType

Defined in Amazonka.SWF.DescribeActivityType

Methods

toJSON :: DescribeActivityType -> Value

toEncoding :: DescribeActivityType -> Encoding

toJSONList :: [DescribeActivityType] -> Value

toEncodingList :: [DescribeActivityType] -> Encoding

ToHeaders DescribeActivityType

Defined in Amazonka.SWF.DescribeActivityType

Methods

toHeaders :: DescribeActivityType -> [Header]

ToPath DescribeActivityType

Defined in Amazonka.SWF.DescribeActivityType

Methods

toPath :: DescribeActivityType -> ByteString

ToQuery DescribeActivityType

Defined in Amazonka.SWF.DescribeActivityType

Methods

toQuery :: DescribeActivityType -> QueryString

AWSRequest DescribeActivityType

Defined in Amazonka.SWF.DescribeActivityType

Associated Types

type AWSResponse DescribeActivityType

Methods

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

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

Generic DescribeActivityType

Defined in Amazonka.SWF.DescribeActivityType

Associated Types

type Rep DescribeActivityType :: Type -> Type

Methods

from :: DescribeActivityType -> Rep DescribeActivityType x

to :: Rep DescribeActivityType x -> DescribeActivityType

Read DescribeActivityType

Defined in Amazonka.SWF.DescribeActivityType

Methods

readsPrec :: Int -> ReadS DescribeActivityType

readList :: ReadS [DescribeActivityType]

readPrec :: ReadPrec DescribeActivityType

readListPrec :: ReadPrec [DescribeActivityType]

Show DescribeActivityType

Defined in Amazonka.SWF.DescribeActivityType

Methods

showsPrec :: Int -> DescribeActivityType -> ShowS

show :: DescribeActivityType -> String

showList :: [DescribeActivityType] -> ShowS

NFData DescribeActivityType

Defined in Amazonka.SWF.DescribeActivityType

Methods

rnf :: DescribeActivityType -> ()

Eq DescribeActivityType

Defined in Amazonka.SWF.DescribeActivityType

Methods

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

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

Hashable DescribeActivityType

Defined in Amazonka.SWF.DescribeActivityType

Methods

hashWithSalt :: Int -> DescribeActivityType -> Int

hash :: DescribeActivityType -> Int

type AWSResponse DescribeActivityType

Defined in Amazonka.SWF.DescribeActivityType

type AWSResponse DescribeActivityType = DescribeActivityTypeResponse

type Rep DescribeActivityType

Defined in Amazonka.SWF.DescribeActivityType

type Rep DescribeActivityType = D1 ('MetaData "DescribeActivityType" "Amazonka.SWF.DescribeActivityType" "amazonka-swf-2.0-DdTBZQl9wbxDbv1sov8BbM" 'False) (C1 ('MetaCons "DescribeActivityType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "domain") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "activityType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ActivityType)))

newDescribeActivityType

Arguments

:: Text

$sel:domain:DescribeActivityType'

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

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

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

describeActivityType_activityType :: 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

data DescribeActivityTypeResponse

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

Generic DescribeActivityTypeResponse

Defined in Amazonka.SWF.DescribeActivityType

Associated Types

type Rep DescribeActivityTypeResponse :: Type -> Type

Methods

from :: DescribeActivityTypeResponse -> Rep DescribeActivityTypeResponse x

to :: Rep DescribeActivityTypeResponse x -> DescribeActivityTypeResponse

Read DescribeActivityTypeResponse

Defined in Amazonka.SWF.DescribeActivityType

Methods

readsPrec :: Int -> ReadS DescribeActivityTypeResponse

readList :: ReadS [DescribeActivityTypeResponse]

readPrec :: ReadPrec DescribeActivityTypeResponse

readListPrec :: ReadPrec [DescribeActivityTypeResponse]

Show DescribeActivityTypeResponse

Defined in Amazonka.SWF.DescribeActivityType

Methods

showsPrec :: Int -> DescribeActivityTypeResponse -> ShowS

show :: DescribeActivityTypeResponse -> String

showList :: [DescribeActivityTypeResponse] -> ShowS

NFData DescribeActivityTypeResponse

Defined in Amazonka.SWF.DescribeActivityType

Methods

rnf :: DescribeActivityTypeResponse -> ()

Eq DescribeActivityTypeResponse

Defined in Amazonka.SWF.DescribeActivityType

Methods

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

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

type Rep DescribeActivityTypeResponse

Defined in Amazonka.SWF.DescribeActivityType

type Rep DescribeActivityTypeResponse = D1 ('MetaData "DescribeActivityTypeResponse" "Amazonka.SWF.DescribeActivityType" "amazonka-swf-2.0-DdTBZQl9wbxDbv1sov8BbM" '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

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

The response's http status code.

describeActivityTypeResponse_typeInfo :: 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.

describeActivityTypeResponse_configuration :: Lens' DescribeActivityTypeResponse ActivityTypeConfiguration

The configuration settings registered with the activity type.