Skip to content

/AWS1/CL_R5AGETPLANEXECRSP

GetPlanExecutionResponse

CONSTRUCTOR

IMPORTING

Required arguments:

iv_planarn TYPE /AWS1/R5APLANARN /AWS1/R5APLANARN

The Amazon Resource Name (ARN) of the plan.

iv_executionid TYPE /AWS1/R5AEXECUTIONID /AWS1/R5AEXECUTIONID

The execution identifier of a plan execution.

iv_starttime TYPE /AWS1/R5ATIMESTAMP /AWS1/R5ATIMESTAMP

The time (UTC) when the plan execution started.

iv_mode TYPE /AWS1/R5AEXECUTIONMODE /AWS1/R5AEXECUTIONMODE

The plan execution mode. Valid values are Practice, for testing without making actual changes, or Recovery, for actual traffic shifting and application recovery.

iv_executionstate TYPE /AWS1/R5AEXECUTIONSTATE /AWS1/R5AEXECUTIONSTATE

The plan execution state. Provides the state of a plan execution, for example, In Progress or Paused by Operator.

iv_executionaction TYPE /AWS1/R5AEXECUTIONACTION /AWS1/R5AEXECUTIONACTION

The plan execution action. Valid values are Activate, to activate an Amazon Web Services Region, or Deactivate, to deactivate a Region.

iv_executionregion TYPE /AWS1/R5ASTRING /AWS1/R5ASTRING

The Amazon Web Services Region for a plan execution.

Optional arguments:

iv_version TYPE /AWS1/R5ASTRING /AWS1/R5ASTRING

The version for the plan.

iv_updatedat TYPE /AWS1/R5ATIMESTAMP /AWS1/R5ATIMESTAMP

The timestamp when the plan execution was last updated.

iv_comment TYPE /AWS1/R5ASTRING /AWS1/R5ASTRING

A comment included on the plan execution.

iv_endtime TYPE /AWS1/R5ATIMESTAMP /AWS1/R5ATIMESTAMP

The time (UTC) when the plan execution ended.

it_stepstates TYPE /AWS1/CL_R5ASTEPSTATE=>TT_STEPSTATES TT_STEPSTATES

The states of the steps in the plan execution.

io_plan TYPE REF TO /AWS1/CL_R5APLAN /AWS1/CL_R5APLAN

The details of the Region switch plan.

iv_actualrecoverytime TYPE /AWS1/R5ADURATION /AWS1/R5ADURATION

The actual recovery time that Region switch calculates for a plan execution. Actual recovery time includes the time for the plan to run added to the time elapsed until the application health alarms that you've specified are healthy again.

iv_nexttoken TYPE /AWS1/R5ASTRING /AWS1/R5ASTRING

Specifies that you want to receive the next page of results. Valid only if you received a nextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's nextToken response to request the next page of results.


Queryable Attributes

planArn

The Amazon Resource Name (ARN) of the plan.

Accessible with the following methods

Method Description
GET_PLANARN() Getter for PLANARN, with configurable default
ASK_PLANARN() Getter for PLANARN w/ exceptions if field has no value
HAS_PLANARN() Determine if PLANARN has a value

executionId

The execution identifier of a plan execution.

Accessible with the following methods

Method Description
GET_EXECUTIONID() Getter for EXECUTIONID, with configurable default
ASK_EXECUTIONID() Getter for EXECUTIONID w/ exceptions if field has no value
HAS_EXECUTIONID() Determine if EXECUTIONID has a value

version

The version for the plan.

Accessible with the following methods

Method Description
GET_VERSION() Getter for VERSION, with configurable default
ASK_VERSION() Getter for VERSION w/ exceptions if field has no value
HAS_VERSION() Determine if VERSION has a value

updatedAt

The timestamp when the plan execution was last updated.

Accessible with the following methods

Method Description
GET_UPDATEDAT() Getter for UPDATEDAT, with configurable default
ASK_UPDATEDAT() Getter for UPDATEDAT w/ exceptions if field has no value
HAS_UPDATEDAT() Determine if UPDATEDAT has a value

comment

A comment included on the plan execution.

Accessible with the following methods

Method Description
GET_COMMENT() Getter for COMMENT, with configurable default
ASK_COMMENT() Getter for COMMENT w/ exceptions if field has no value
HAS_COMMENT() Determine if COMMENT has a value

startTime

The time (UTC) when the plan execution started.

Accessible with the following methods

Method Description
GET_STARTTIME() Getter for STARTTIME, with configurable default
ASK_STARTTIME() Getter for STARTTIME w/ exceptions if field has no value
HAS_STARTTIME() Determine if STARTTIME has a value

endTime

The time (UTC) when the plan execution ended.

Accessible with the following methods

Method Description
GET_ENDTIME() Getter for ENDTIME, with configurable default
ASK_ENDTIME() Getter for ENDTIME w/ exceptions if field has no value
HAS_ENDTIME() Determine if ENDTIME has a value

mode

The plan execution mode. Valid values are Practice, for testing without making actual changes, or Recovery, for actual traffic shifting and application recovery.

Accessible with the following methods

Method Description
GET_MODE() Getter for MODE, with configurable default
ASK_MODE() Getter for MODE w/ exceptions if field has no value
HAS_MODE() Determine if MODE has a value

executionState

The plan execution state. Provides the state of a plan execution, for example, In Progress or Paused by Operator.

Accessible with the following methods

Method Description
GET_EXECUTIONSTATE() Getter for EXECUTIONSTATE, with configurable default
ASK_EXECUTIONSTATE() Getter for EXECUTIONSTATE w/ exceptions if field has no valu
HAS_EXECUTIONSTATE() Determine if EXECUTIONSTATE has a value

executionAction

The plan execution action. Valid values are Activate, to activate an Amazon Web Services Region, or Deactivate, to deactivate a Region.

Accessible with the following methods

Method Description
GET_EXECUTIONACTION() Getter for EXECUTIONACTION, with configurable default
ASK_EXECUTIONACTION() Getter for EXECUTIONACTION w/ exceptions if field has no val
HAS_EXECUTIONACTION() Determine if EXECUTIONACTION has a value

executionRegion

The Amazon Web Services Region for a plan execution.

Accessible with the following methods

Method Description
GET_EXECUTIONREGION() Getter for EXECUTIONREGION, with configurable default
ASK_EXECUTIONREGION() Getter for EXECUTIONREGION w/ exceptions if field has no val
HAS_EXECUTIONREGION() Determine if EXECUTIONREGION has a value

stepStates

The states of the steps in the plan execution.

Accessible with the following methods

Method Description
GET_STEPSTATES() Getter for STEPSTATES, with configurable default
ASK_STEPSTATES() Getter for STEPSTATES w/ exceptions if field has no value
HAS_STEPSTATES() Determine if STEPSTATES has a value

plan

The details of the Region switch plan.

Accessible with the following methods

Method Description
GET_PLAN() Getter for PLAN

actualRecoveryTime

The actual recovery time that Region switch calculates for a plan execution. Actual recovery time includes the time for the plan to run added to the time elapsed until the application health alarms that you've specified are healthy again.

Accessible with the following methods

Method Description
GET_ACTUALRECOVERYTIME() Getter for ACTUALRECOVERYTIME, with configurable default
ASK_ACTUALRECOVERYTIME() Getter for ACTUALRECOVERYTIME w/ exceptions if field has no
HAS_ACTUALRECOVERYTIME() Determine if ACTUALRECOVERYTIME has a value

nextToken

Specifies that you want to receive the next page of results. Valid only if you received a nextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's nextToken response to request the next page of results.

Accessible with the following methods

Method Description
GET_NEXTTOKEN() Getter for NEXTTOKEN, with configurable default
ASK_NEXTTOKEN() Getter for NEXTTOKEN w/ exceptions if field has no value
HAS_NEXTTOKEN() Determine if NEXTTOKEN has a value