libZSservicesZSamazonka-stepfunctionsZSamazonka-stepfunctions
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.StepFunctions.DescribeActivity

Description

Describes an activity.

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

Synopsis

Creating a Request

data DescribeActivity Source #

See: newDescribeActivity smart constructor.

Constructors

DescribeActivity' 

Fields

  • activityArn :: Text

    The Amazon Resource Name (ARN) of the activity to describe.

Instances

Instances details
Eq DescribeActivity Source # 
Instance details

Defined in Amazonka.StepFunctions.DescribeActivity

Methods

(==) :: DescribeActivity -> DescribeActivity -> Bool #

(/=) :: DescribeActivity -> DescribeActivity -> Bool #

Read DescribeActivity Source # 
Instance details

Defined in Amazonka.StepFunctions.DescribeActivity

Methods

readsPrec :: Int -> ReadS DescribeActivity #

readList :: ReadS [DescribeActivity] #

readPrec :: ReadPrec DescribeActivity #

readListPrec :: ReadPrec [DescribeActivity] #

Show DescribeActivity Source # 
Instance details

Defined in Amazonka.StepFunctions.DescribeActivity

Methods

showsPrec :: Int -> DescribeActivity -> ShowS #

show :: DescribeActivity -> String #

showList :: [DescribeActivity] -> ShowS #

Generic DescribeActivity Source # 
Instance details

Defined in Amazonka.StepFunctions.DescribeActivity

Associated Types

type Rep DescribeActivity :: Type -> Type #

Methods

from :: DescribeActivity -> Rep DescribeActivity x #

to :: Rep DescribeActivity x -> DescribeActivity #

NFData DescribeActivity Source # 
Instance details

Defined in Amazonka.StepFunctions.DescribeActivity

Methods

rnf :: DescribeActivity -> () #

Hashable DescribeActivity Source # 
Instance details

Defined in Amazonka.StepFunctions.DescribeActivity

Methods

hashWithSalt :: Int -> DescribeActivity -> Int #

hash :: DescribeActivity -> Int #

ToJSON DescribeActivity Source # 
Instance details

Defined in Amazonka.StepFunctions.DescribeActivity

Methods

toJSON :: DescribeActivity -> Value #

toEncoding :: DescribeActivity -> Encoding #

toJSONList :: [DescribeActivity] -> Value #

toEncodingList :: [DescribeActivity] -> Encoding #

AWSRequest DescribeActivity Source # 
Instance details

Defined in Amazonka.StepFunctions.DescribeActivity

Associated Types

type AWSResponse DescribeActivity #

Methods

request :: DescribeActivity -> Request DescribeActivity #

response :: MonadResource m => Logger -> Service -> Proxy DescribeActivity -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeActivity))) #

ToHeaders DescribeActivity Source # 
Instance details

Defined in Amazonka.StepFunctions.DescribeActivity

Methods

toHeaders :: DescribeActivity -> [Header] #

ToPath DescribeActivity Source # 
Instance details

Defined in Amazonka.StepFunctions.DescribeActivity

Methods

toPath :: DescribeActivity -> ByteString #

ToQuery DescribeActivity Source # 
Instance details

Defined in Amazonka.StepFunctions.DescribeActivity

Methods

toQuery :: DescribeActivity -> QueryString #

type Rep DescribeActivity Source # 
Instance details

Defined in Amazonka.StepFunctions.DescribeActivity

type Rep DescribeActivity = D1 ('MetaData "DescribeActivity" "Amazonka.StepFunctions.DescribeActivity" "libZSservicesZSamazonka-stepfunctionsZSamazonka-stepfunctions" 'False) (C1 ('MetaCons "DescribeActivity'" 'PrefixI 'True) (S1 ('MetaSel ('Just "activityArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DescribeActivity Source # 
Instance details

Defined in Amazonka.StepFunctions.DescribeActivity

type AWSResponse DescribeActivity = DescribeActivityResponse

newDescribeActivity Source #

Arguments

:: Text

$sel:activityArn:DescribeActivity'

-> DescribeActivity 

Create a value of DescribeActivity 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:activityArn:DescribeActivity', describeActivity_activityArn - The Amazon Resource Name (ARN) of the activity to describe.

Request Lenses

describeActivity_activityArn :: Lens' DescribeActivity Text Source #

The Amazon Resource Name (ARN) of the activity to describe.

Destructuring the Response

data DescribeActivityResponse Source #

See: newDescribeActivityResponse smart constructor.

Constructors

DescribeActivityResponse' 

Fields

  • httpStatus :: Int

    The response's http status code.

  • activityArn :: Text

    The Amazon Resource Name (ARN) that identifies the activity.

  • name :: Text

    The name of the activity.

    A name must not contain:

    • white space
    • brackets < > { } [ ]
    • wildcard characters ? *
    • special characters " # % \ ^ | ~ ` $ & , ; : /
    • control characters (U+0000-001F, U+007F-009F)

    To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

  • creationDate :: POSIX

    The date the activity is created.

Instances

Instances details
Eq DescribeActivityResponse Source # 
Instance details

Defined in Amazonka.StepFunctions.DescribeActivity

Methods

(==) :: DescribeActivityResponse -> DescribeActivityResponse -> Bool #

(/=) :: DescribeActivityResponse -> DescribeActivityResponse -> Bool #

Read DescribeActivityResponse Source # 
Instance details

Defined in Amazonka.StepFunctions.DescribeActivity

Methods

readsPrec :: Int -> ReadS DescribeActivityResponse #

readList :: ReadS [DescribeActivityResponse] #

readPrec :: ReadPrec DescribeActivityResponse #

readListPrec :: ReadPrec [DescribeActivityResponse] #

Show DescribeActivityResponse Source # 
Instance details

Defined in Amazonka.StepFunctions.DescribeActivity

Methods

showsPrec :: Int -> DescribeActivityResponse -> ShowS #

show :: DescribeActivityResponse -> String #

showList :: [DescribeActivityResponse] -> ShowS #

Generic DescribeActivityResponse Source # 
Instance details

Defined in Amazonka.StepFunctions.DescribeActivity

Associated Types

type Rep DescribeActivityResponse :: Type -> Type #

Methods

from :: DescribeActivityResponse -> Rep DescribeActivityResponse x #

to :: Rep DescribeActivityResponse x -> DescribeActivityResponse #

NFData DescribeActivityResponse Source # 
Instance details

Defined in Amazonka.StepFunctions.DescribeActivity

Methods

rnf :: DescribeActivityResponse -> () #

type Rep DescribeActivityResponse Source # 
Instance details

Defined in Amazonka.StepFunctions.DescribeActivity

type Rep DescribeActivityResponse = D1 ('MetaData "DescribeActivityResponse" "Amazonka.StepFunctions.DescribeActivity" "libZSservicesZSamazonka-stepfunctionsZSamazonka-stepfunctions" 'False) (C1 ('MetaCons "DescribeActivityResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "activityArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "creationDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX))))

newDescribeActivityResponse Source #

Arguments

:: Int

$sel:httpStatus:DescribeActivityResponse'

-> Text

$sel:activityArn:DescribeActivity'

-> Text

$sel:name:DescribeActivityResponse'

-> UTCTime

$sel:creationDate:DescribeActivityResponse'

-> DescribeActivityResponse 

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

$sel:activityArn:DescribeActivity', describeActivityResponse_activityArn - The Amazon Resource Name (ARN) that identifies the activity.

$sel:name:DescribeActivityResponse', describeActivityResponse_name - The name of the activity.

A name must not contain:

  • white space
  • brackets < > { } [ ]
  • wildcard characters ? *
  • special characters " # % \ ^ | ~ ` $ & , ; : /
  • control characters (U+0000-001F, U+007F-009F)

To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

$sel:creationDate:DescribeActivityResponse', describeActivityResponse_creationDate - The date the activity is created.

Response Lenses

describeActivityResponse_httpStatus :: Lens' DescribeActivityResponse Int Source #

The response's http status code.

describeActivityResponse_activityArn :: Lens' DescribeActivityResponse Text Source #

The Amazon Resource Name (ARN) that identifies the activity.

describeActivityResponse_name :: Lens' DescribeActivityResponse Text Source #

The name of the activity.

A name must not contain:

  • white space
  • brackets < > { } [ ]
  • wildcard characters ? *
  • special characters " # % \ ^ | ~ ` $ & , ; : /
  • control characters (U+0000-001F, U+007F-009F)

To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

describeActivityResponse_creationDate :: Lens' DescribeActivityResponse UTCTime Source #

The date the activity is created.