/AWS1/CL_OUTSTARTCAPTASKOUTPUT¶
StartCapacityTaskOutput
CONSTRUCTOR¶
IMPORTING¶
Optional arguments:¶
iv_capacitytaskid TYPE /AWS1/OUTCAPACITYTASKID /AWS1/OUTCAPACITYTASKID¶
ID of the capacity task that you want to start.
iv_outpostid TYPE /AWS1/OUTOUTPOSTID /AWS1/OUTOUTPOSTID¶
ID of the Outpost associated with the capacity task.
iv_orderid TYPE /AWS1/OUTORDERID /AWS1/OUTORDERID¶
ID of the Amazon Web Services Outposts order of the host associated with the capacity task.
iv_assetid TYPE /AWS1/OUTASSETID /AWS1/OUTASSETID¶
The ID of the asset. An Outpost asset can be a single server within an Outposts rack or an Outposts server configuration.
it_requestedinstancepools TYPE /AWS1/CL_OUTINSTANCETYPECAP=>TT_REQUESTEDINSTANCEPOOLS TT_REQUESTEDINSTANCEPOOLS¶
List of the instance pools requested in the specified capacity task.
io_instancestoexclude TYPE REF TO /AWS1/CL_OUTINSTANCESTOEXCLUDE /AWS1/CL_OUTINSTANCESTOEXCLUDE¶
User-specified instances that must not be stopped in order to free up the capacity needed to run the capacity task.
iv_dryrun TYPE /AWS1/OUTDRYRUN /AWS1/OUTDRYRUN¶
Results of the dry run showing if the specified capacity task is above or below the available instance capacity.
iv_capacitytaskstatus TYPE /AWS1/OUTCAPACITYTASKSTATUS /AWS1/OUTCAPACITYTASKSTATUS¶
Status of the specified capacity task.
io_failed TYPE REF TO /AWS1/CL_OUTCAPTASKFAILURE /AWS1/CL_OUTCAPTASKFAILURE¶
Reason that the specified capacity task failed.
iv_creationdate TYPE /AWS1/OUTISO8601TIMESTAMP /AWS1/OUTISO8601TIMESTAMP¶
Date that the specified capacity task was created.
iv_completiondate TYPE /AWS1/OUTISO8601TIMESTAMP /AWS1/OUTISO8601TIMESTAMP¶
Date that the specified capacity task ran successfully.
iv_lastmodifieddate TYPE /AWS1/OUTISO8601TIMESTAMP /AWS1/OUTISO8601TIMESTAMP¶
Date that the specified capacity task was last modified.
iv_taskactiononblockinginsts TYPE /AWS1/OUTTSKACTONBLOCKINGINSTS /AWS1/OUTTSKACTONBLOCKINGINSTS¶
User-specified option in case an instance is blocking the capacity task from running.
WAIT_FOR_EVACUATION- Checks every 10 minutes over 48 hours to determine if instances have stopped and capacity is available to complete the task.
FAIL_TASK- The capacity task fails.
Queryable Attributes¶
CapacityTaskId¶
ID of the capacity task that you want to start.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CAPACITYTASKID() |
Getter for CAPACITYTASKID, with configurable default |
ASK_CAPACITYTASKID() |
Getter for CAPACITYTASKID w/ exceptions if field has no valu |
HAS_CAPACITYTASKID() |
Determine if CAPACITYTASKID has a value |
OutpostId¶
ID of the Outpost associated with the capacity task.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_OUTPOSTID() |
Getter for OUTPOSTID, with configurable default |
ASK_OUTPOSTID() |
Getter for OUTPOSTID w/ exceptions if field has no value |
HAS_OUTPOSTID() |
Determine if OUTPOSTID has a value |
OrderId¶
ID of the Amazon Web Services Outposts order of the host associated with the capacity task.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ORDERID() |
Getter for ORDERID, with configurable default |
ASK_ORDERID() |
Getter for ORDERID w/ exceptions if field has no value |
HAS_ORDERID() |
Determine if ORDERID has a value |
AssetId¶
The ID of the asset. An Outpost asset can be a single server within an Outposts rack or an Outposts server configuration.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ASSETID() |
Getter for ASSETID, with configurable default |
ASK_ASSETID() |
Getter for ASSETID w/ exceptions if field has no value |
HAS_ASSETID() |
Determine if ASSETID has a value |
RequestedInstancePools¶
List of the instance pools requested in the specified capacity task.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_REQUESTEDINSTANCEPOOLS() |
Getter for REQUESTEDINSTANCEPOOLS, with configurable default |
ASK_REQUESTEDINSTANCEPOOLS() |
Getter for REQUESTEDINSTANCEPOOLS w/ exceptions if field has |
HAS_REQUESTEDINSTANCEPOOLS() |
Determine if REQUESTEDINSTANCEPOOLS has a value |
InstancesToExclude¶
User-specified instances that must not be stopped in order to free up the capacity needed to run the capacity task.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_INSTANCESTOEXCLUDE() |
Getter for INSTANCESTOEXCLUDE |
DryRun¶
Results of the dry run showing if the specified capacity task is above or below the available instance capacity.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DRYRUN() |
Getter for DRYRUN |
CapacityTaskStatus¶
Status of the specified capacity task.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CAPACITYTASKSTATUS() |
Getter for CAPACITYTASKSTATUS, with configurable default |
ASK_CAPACITYTASKSTATUS() |
Getter for CAPACITYTASKSTATUS w/ exceptions if field has no |
HAS_CAPACITYTASKSTATUS() |
Determine if CAPACITYTASKSTATUS has a value |
Failed¶
Reason that the specified capacity task failed.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_FAILED() |
Getter for FAILED |
CreationDate¶
Date that the specified capacity task was created.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CREATIONDATE() |
Getter for CREATIONDATE, with configurable default |
ASK_CREATIONDATE() |
Getter for CREATIONDATE w/ exceptions if field has no value |
HAS_CREATIONDATE() |
Determine if CREATIONDATE has a value |
CompletionDate¶
Date that the specified capacity task ran successfully.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_COMPLETIONDATE() |
Getter for COMPLETIONDATE, with configurable default |
ASK_COMPLETIONDATE() |
Getter for COMPLETIONDATE w/ exceptions if field has no valu |
HAS_COMPLETIONDATE() |
Determine if COMPLETIONDATE has a value |
LastModifiedDate¶
Date that the specified capacity task was last modified.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_LASTMODIFIEDDATE() |
Getter for LASTMODIFIEDDATE, with configurable default |
ASK_LASTMODIFIEDDATE() |
Getter for LASTMODIFIEDDATE w/ exceptions if field has no va |
HAS_LASTMODIFIEDDATE() |
Determine if LASTMODIFIEDDATE has a value |
TaskActionOnBlockingInstances¶
User-specified option in case an instance is blocking the capacity task from running.
WAIT_FOR_EVACUATION- Checks every 10 minutes over 48 hours to determine if instances have stopped and capacity is available to complete the task.
FAIL_TASK- The capacity task fails.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TASKACTONBLOCKINGINSTS() |
Getter for TASKACTIONONBLOCKINGINSTS, with configurable defa |
ASK_TASKACTONBLOCKINGINSTS() |
Getter for TASKACTIONONBLOCKINGINSTS w/ exceptions if field |
HAS_TASKACTONBLOCKINGINSTS() |
Determine if TASKACTIONONBLOCKINGINSTS has a value |