Amazonka.StepFunctions.DescribeMapRun

Provides information about a Map Run's configuration, progress, and results. For more information, see Examining Map Run in the Step Functions Developer Guide.

Creating a Request

data DescribeMapRun

See: newDescribeMapRun smart constructor.

Constructors

DescribeMapRun'

Fields

• mapRunArn :: Text

  The Amazon Resource Name (ARN) that identifies a Map Run.

Instances

ToJSON DescribeMapRun

Defined in Amazonka.StepFunctions.DescribeMapRun

Methods

toJSON :: DescribeMapRun -> Value

toEncoding :: DescribeMapRun -> Encoding

toJSONList :: [DescribeMapRun] -> Value

toEncodingList :: [DescribeMapRun] -> Encoding

ToHeaders DescribeMapRun

Defined in Amazonka.StepFunctions.DescribeMapRun

Methods

toHeaders :: DescribeMapRun -> [Header]

ToPath DescribeMapRun

Defined in Amazonka.StepFunctions.DescribeMapRun

Methods

toPath :: DescribeMapRun -> ByteString

ToQuery DescribeMapRun

Defined in Amazonka.StepFunctions.DescribeMapRun

Methods

toQuery :: DescribeMapRun -> QueryString

AWSRequest DescribeMapRun

Defined in Amazonka.StepFunctions.DescribeMapRun

Associated Types

type AWSResponse DescribeMapRun

Methods

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

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

Generic DescribeMapRun

Defined in Amazonka.StepFunctions.DescribeMapRun

Associated Types

type Rep DescribeMapRun :: Type -> Type

Methods

from :: DescribeMapRun -> Rep DescribeMapRun x

to :: Rep DescribeMapRun x -> DescribeMapRun

Read DescribeMapRun

Defined in Amazonka.StepFunctions.DescribeMapRun

Methods

readsPrec :: Int -> ReadS DescribeMapRun

readList :: ReadS [DescribeMapRun]

readPrec :: ReadPrec DescribeMapRun

readListPrec :: ReadPrec [DescribeMapRun]

Show DescribeMapRun

Defined in Amazonka.StepFunctions.DescribeMapRun

Methods

showsPrec :: Int -> DescribeMapRun -> ShowS

show :: DescribeMapRun -> String

showList :: [DescribeMapRun] -> ShowS

NFData DescribeMapRun

Defined in Amazonka.StepFunctions.DescribeMapRun

Methods

rnf :: DescribeMapRun -> ()

Eq DescribeMapRun

Defined in Amazonka.StepFunctions.DescribeMapRun

Methods

(==) :: DescribeMapRun -> DescribeMapRun -> Bool

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

Hashable DescribeMapRun

Defined in Amazonka.StepFunctions.DescribeMapRun

Methods

hashWithSalt :: Int -> DescribeMapRun -> Int

hash :: DescribeMapRun -> Int

type AWSResponse DescribeMapRun

Defined in Amazonka.StepFunctions.DescribeMapRun

type AWSResponse DescribeMapRun = DescribeMapRunResponse

type Rep DescribeMapRun

Defined in Amazonka.StepFunctions.DescribeMapRun

type Rep DescribeMapRun = D1 ('MetaData "DescribeMapRun" "Amazonka.StepFunctions.DescribeMapRun" "amazonka-stepfunctions-2.0-K6z2kqboJVbL1MZX8DUt0f" 'False) (C1 ('MetaCons "DescribeMapRun'" 'PrefixI 'True) (S1 ('MetaSel ('Just "mapRunArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeMapRun

Arguments

:: Text

DescribeMapRun

-> DescribeMapRun

Create a value of DescribeMapRun 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:

DescribeMapRun, describeMapRun_mapRunArn - The Amazon Resource Name (ARN) that identifies a Map Run.

Request Lenses

describeMapRun_mapRunArn :: Lens' DescribeMapRun Text

The Amazon Resource Name (ARN) that identifies a Map Run.

Destructuring the Response

data DescribeMapRunResponse

See: newDescribeMapRunResponse smart constructor.

Constructors

DescribeMapRunResponse'

Fields

• stopDate :: Maybe POSIX

  The date when the Map Run was stopped.

• httpStatus :: Int

  The response's http status code.

• mapRunArn :: Text

  The Amazon Resource Name (ARN) that identifies a Map Run.

• executionArn :: Text

  The Amazon Resource Name (ARN) that identifies the execution in which the Map Run was started.

• status :: MapRunStatus

  The current status of the Map Run.

• startDate :: POSIX

  The date when the Map Run was started.

• maxConcurrency :: Natural

  The maximum number of child workflow executions configured to run in parallel for the Map Run at the same time.

• toleratedFailurePercentage :: Double

  The maximum percentage of failed child workflow executions before the Map Run fails.

• toleratedFailureCount :: Natural

  The maximum number of failed child workflow executions before the Map Run fails.

• itemCounts :: MapRunItemCounts

  A JSON object that contains information about the total number of items, and the item count for each processing status, such as pending and failed.

• executionCounts :: MapRunExecutionCounts

  A JSON object that contains information about the total number of child workflow executions for the Map Run, and the count of child workflow executions for each status, such as failed and succeeded.

Instances

Generic DescribeMapRunResponse

Defined in Amazonka.StepFunctions.DescribeMapRun

Associated Types

type Rep DescribeMapRunResponse :: Type -> Type

Methods

from :: DescribeMapRunResponse -> Rep DescribeMapRunResponse x

to :: Rep DescribeMapRunResponse x -> DescribeMapRunResponse

Read DescribeMapRunResponse

Defined in Amazonka.StepFunctions.DescribeMapRun

Methods

readsPrec :: Int -> ReadS DescribeMapRunResponse

readList :: ReadS [DescribeMapRunResponse]

readPrec :: ReadPrec DescribeMapRunResponse

readListPrec :: ReadPrec [DescribeMapRunResponse]

Show DescribeMapRunResponse

Defined in Amazonka.StepFunctions.DescribeMapRun

Methods

showsPrec :: Int -> DescribeMapRunResponse -> ShowS

show :: DescribeMapRunResponse -> String

showList :: [DescribeMapRunResponse] -> ShowS

NFData DescribeMapRunResponse

Defined in Amazonka.StepFunctions.DescribeMapRun

Methods

rnf :: DescribeMapRunResponse -> ()

Eq DescribeMapRunResponse

Defined in Amazonka.StepFunctions.DescribeMapRun

Methods

(==) :: DescribeMapRunResponse -> DescribeMapRunResponse -> Bool

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

type Rep DescribeMapRunResponse

Defined in Amazonka.StepFunctions.DescribeMapRun

type Rep DescribeMapRunResponse = D1 ('MetaData "DescribeMapRunResponse" "Amazonka.StepFunctions.DescribeMapRun" "amazonka-stepfunctions-2.0-K6z2kqboJVbL1MZX8DUt0f" 'False) (C1 ('MetaCons "DescribeMapRunResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "stopDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)) :*: (S1 ('MetaSel ('Just "mapRunArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "executionArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 MapRunStatus)))) :*: ((S1 ('MetaSel ('Just "startDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX) :*: (S1 ('MetaSel ('Just "maxConcurrency") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural) :*: S1 ('MetaSel ('Just "toleratedFailurePercentage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Double))) :*: (S1 ('MetaSel ('Just "toleratedFailureCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural) :*: (S1 ('MetaSel ('Just "itemCounts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 MapRunItemCounts) :*: S1 ('MetaSel ('Just "executionCounts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 MapRunExecutionCounts))))))

newDescribeMapRunResponse

Arguments

:: Int

$sel:httpStatus:DescribeMapRunResponse'

-> Text

DescribeMapRun

-> Text

DescribeMapRunResponse

-> MapRunStatus

DescribeMapRunResponse

-> UTCTime

DescribeMapRunResponse

-> Natural

$sel:maxConcurrency:DescribeMapRunResponse'

-> Double

$sel:toleratedFailurePercentage:DescribeMapRunResponse'

-> Natural

$sel:toleratedFailureCount:DescribeMapRunResponse'

-> MapRunItemCounts

$sel:itemCounts:DescribeMapRunResponse'

-> MapRunExecutionCounts

$sel:executionCounts:DescribeMapRunResponse'

-> DescribeMapRunResponse

Create a value of DescribeMapRunResponse 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:

DescribeMapRunResponse, describeMapRunResponse_stopDate - The date when the Map Run was stopped.

$sel:httpStatus:DescribeMapRunResponse', describeMapRunResponse_httpStatus - The response's http status code.

DescribeMapRun, describeMapRunResponse_mapRunArn - The Amazon Resource Name (ARN) that identifies a Map Run.

DescribeMapRunResponse, describeMapRunResponse_executionArn - The Amazon Resource Name (ARN) that identifies the execution in which the Map Run was started.

DescribeMapRunResponse, describeMapRunResponse_status - The current status of the Map Run.

DescribeMapRunResponse, describeMapRunResponse_startDate - The date when the Map Run was started.

$sel:maxConcurrency:DescribeMapRunResponse', describeMapRunResponse_maxConcurrency - The maximum number of child workflow executions configured to run in parallel for the Map Run at the same time.

$sel:toleratedFailurePercentage:DescribeMapRunResponse', describeMapRunResponse_toleratedFailurePercentage - The maximum percentage of failed child workflow executions before the Map Run fails.

$sel:toleratedFailureCount:DescribeMapRunResponse', describeMapRunResponse_toleratedFailureCount - The maximum number of failed child workflow executions before the Map Run fails.

$sel:itemCounts:DescribeMapRunResponse', describeMapRunResponse_itemCounts - A JSON object that contains information about the total number of items, and the item count for each processing status, such as pending and failed.

$sel:executionCounts:DescribeMapRunResponse', describeMapRunResponse_executionCounts - A JSON object that contains information about the total number of child workflow executions for the Map Run, and the count of child workflow executions for each status, such as failed and succeeded.

Response Lenses

describeMapRunResponse_stopDate :: Lens' DescribeMapRunResponse (Maybe UTCTime)

The date when the Map Run was stopped.

describeMapRunResponse_httpStatus :: Lens' DescribeMapRunResponse Int

The response's http status code.

describeMapRunResponse_mapRunArn :: Lens' DescribeMapRunResponse Text

The Amazon Resource Name (ARN) that identifies a Map Run.

describeMapRunResponse_executionArn :: Lens' DescribeMapRunResponse Text

The Amazon Resource Name (ARN) that identifies the execution in which the Map Run was started.

describeMapRunResponse_status :: Lens' DescribeMapRunResponse MapRunStatus

The current status of the Map Run.

describeMapRunResponse_startDate :: Lens' DescribeMapRunResponse UTCTime

The date when the Map Run was started.

describeMapRunResponse_maxConcurrency :: Lens' DescribeMapRunResponse Natural

The maximum number of child workflow executions configured to run in parallel for the Map Run at the same time.

describeMapRunResponse_toleratedFailurePercentage :: Lens' DescribeMapRunResponse Double

The maximum percentage of failed child workflow executions before the Map Run fails.

describeMapRunResponse_toleratedFailureCount :: Lens' DescribeMapRunResponse Natural

The maximum number of failed child workflow executions before the Map Run fails.

describeMapRunResponse_itemCounts :: Lens' DescribeMapRunResponse MapRunItemCounts

A JSON object that contains information about the total number of items, and the item count for each processing status, such as pending and failed.

describeMapRunResponse_executionCounts :: Lens' DescribeMapRunResponse MapRunExecutionCounts

A JSON object that contains information about the total number of child workflow executions for the Map Run, and the count of child workflow executions for each status, such as failed and succeeded.