amazonka-swf-2.0: Amazon Simple Workflow Service SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.SWF.DescribeActivityType

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
ToJSON DescribeActivityType Source # 
Instance details

Defined in Amazonka.SWF.DescribeActivityType

ToHeaders DescribeActivityType Source # 
Instance details

Defined in Amazonka.SWF.DescribeActivityType

ToPath DescribeActivityType Source # 
Instance details

Defined in Amazonka.SWF.DescribeActivityType

ToQuery DescribeActivityType Source # 
Instance details

Defined in Amazonka.SWF.DescribeActivityType

AWSRequest DescribeActivityType Source # 
Instance details

Defined in Amazonka.SWF.DescribeActivityType

Associated Types

type AWSResponse DescribeActivityType #

Generic DescribeActivityType Source # 
Instance details

Defined in Amazonka.SWF.DescribeActivityType

Associated Types

type Rep DescribeActivityType :: Type -> Type #

Read DescribeActivityType Source # 
Instance details

Defined in Amazonka.SWF.DescribeActivityType

Show DescribeActivityType Source # 
Instance details

Defined in Amazonka.SWF.DescribeActivityType

NFData DescribeActivityType Source # 
Instance details

Defined in Amazonka.SWF.DescribeActivityType

Methods

rnf :: DescribeActivityType -> () #

Eq DescribeActivityType Source # 
Instance details

Defined in Amazonka.SWF.DescribeActivityType

Hashable DescribeActivityType Source # 
Instance details

Defined in Amazonka.SWF.DescribeActivityType

type AWSResponse DescribeActivityType Source # 
Instance details

Defined in Amazonka.SWF.DescribeActivityType

type Rep DescribeActivityType Source # 
Instance details

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

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 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
Generic DescribeActivityTypeResponse Source # 
Instance details

Defined in Amazonka.SWF.DescribeActivityType

Associated Types

type Rep DescribeActivityTypeResponse :: Type -> Type #

Read DescribeActivityTypeResponse Source # 
Instance details

Defined in Amazonka.SWF.DescribeActivityType

Show DescribeActivityTypeResponse Source # 
Instance details

Defined in Amazonka.SWF.DescribeActivityType

NFData DescribeActivityTypeResponse Source # 
Instance details

Defined in Amazonka.SWF.DescribeActivityType

Eq DescribeActivityTypeResponse Source # 
Instance details

Defined in Amazonka.SWF.DescribeActivityType

type Rep DescribeActivityTypeResponse Source # 
Instance details

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

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