/AWS1/CL_IVRCOMPOSITION¶
Object specifying a Composition resource.
CONSTRUCTOR¶
IMPORTING¶
Required arguments:¶
iv_arn TYPE /AWS1/IVRCOMPOSITIONARN /AWS1/IVRCOMPOSITIONARN¶
ARN of the Composition resource.
iv_stagearn TYPE /AWS1/IVRSTAGEARN /AWS1/IVRSTAGEARN¶
ARN of the stage used as input
iv_state TYPE /AWS1/IVRCOMPOSITIONSTATE /AWS1/IVRCOMPOSITIONSTATE¶
State of the Composition.
io_layout TYPE REF TO /AWS1/CL_IVRLAYOUTCONF /AWS1/CL_IVRLAYOUTCONF¶
Layout object to configure composition parameters.
it_destinations TYPE /AWS1/CL_IVRDESTINATION=>TT_DESTINATIONLIST TT_DESTINATIONLIST¶
Array of Destination objects. A Composition can contain either one destination (
channelors3) or two (onechanneland ones3).
Optional arguments:¶
it_tags TYPE /AWS1/CL_IVRTAGS_W=>TT_TAGS TT_TAGS¶
Tags attached to the resource. Array of maps, each of the form
string:string (key:value). See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.
iv_starttime TYPE /AWS1/IVRTIME /AWS1/IVRTIME¶
UTC time of the Composition start. This is an ISO 8601 timestamp; note that this is returned as a string.
iv_endtime TYPE /AWS1/IVRTIME /AWS1/IVRTIME¶
UTC time of the Composition end. This is an ISO 8601 timestamp; note that this is returned as a string.
Queryable Attributes¶
arn¶
ARN of the Composition resource.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ARN() |
Getter for ARN, with configurable default |
ASK_ARN() |
Getter for ARN w/ exceptions if field has no value |
HAS_ARN() |
Determine if ARN has a value |
stageArn¶
ARN of the stage used as input
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STAGEARN() |
Getter for STAGEARN, with configurable default |
ASK_STAGEARN() |
Getter for STAGEARN w/ exceptions if field has no value |
HAS_STAGEARN() |
Determine if STAGEARN has a value |
state¶
State of the Composition.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STATE() |
Getter for STATE, with configurable default |
ASK_STATE() |
Getter for STATE w/ exceptions if field has no value |
HAS_STATE() |
Determine if STATE has a value |
layout¶
Layout object to configure composition parameters.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_LAYOUT() |
Getter for LAYOUT |
destinations¶
Array of Destination objects. A Composition can contain either one destination (
channelors3) or two (onechanneland ones3).
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DESTINATIONS() |
Getter for DESTINATIONS, with configurable default |
ASK_DESTINATIONS() |
Getter for DESTINATIONS w/ exceptions if field has no value |
HAS_DESTINATIONS() |
Determine if DESTINATIONS has a value |
tags¶
Tags attached to the resource. Array of maps, each of the form
string:string (key:value). See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TAGS() |
Getter for TAGS, with configurable default |
ASK_TAGS() |
Getter for TAGS w/ exceptions if field has no value |
HAS_TAGS() |
Determine if TAGS has a value |
startTime¶
UTC time of the Composition start. This is an ISO 8601 timestamp; note that this is returned as a string.
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¶
UTC time of the Composition end. This is an ISO 8601 timestamp; note that this is returned as a string.
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 |