/AWS1/CL_CUSGETSTRMFORSEGSRSP¶
GetStreamForSegmentsResponse
CONSTRUCTOR¶
IMPORTING¶
Optional arguments:¶
iv_associatedat TYPE /AWS1/CUSTIMESTAMP /AWS1/CUSTIMESTAMP¶
The timestamp of when the stream was associated.
it_associatedsegments TYPE /AWS1/CL_CUSASSOCIATEDSEGMENT=>TT_ASSOCIATEDSEGMENTSLIST TT_ASSOCIATEDSEGMENTSLIST¶
A list of segments currently associated with the stream and their subscription status.
iv_domainname TYPE /AWS1/CUSNAME /AWS1/CUSNAME¶
The unique name of the domain.
iv_destinationarn TYPE /AWS1/CUSDESTINATIONARNSTRING /AWS1/CUSDESTINATIONARNSTRING¶
The Amazon Resource Name (ARN) of the Amazon Kinesis data stream receiving segment membership events.
iv_destinationrolearn TYPE /AWS1/CUSDESTINATIONROLEARN /AWS1/CUSDESTINATIONROLEARN¶
The Amazon Resource Name (ARN) of the IAM role used for Amazon Kinesis and AWS Key Management Service (KMS) operations.
iv_state TYPE /AWS1/CUSEVENTSUBSCRTATE /AWS1/CUSEVENTSUBSCRTATE¶
The operational state of the destination stream. The following are valid values:
RUNNING: The stream is associated and healthy. Segment membership events are being published.
UNHEALTHY: The stream is associated but events cannot currently be published. See
FailureReasonfor details.STOPPED: The stream is no longer publishing segment membership events.
iv_disassociatedat TYPE /AWS1/CUSTIMESTAMP /AWS1/CUSTIMESTAMP¶
The timestamp of when the stream was disassociated.
iv_failurereason TYPE /AWS1/CUSSTRING1TO255 /AWS1/CUSSTRING1TO255¶
The reason why the stream is in an unhealthy state, if applicable.
Queryable Attributes¶
AssociatedAt¶
The timestamp of when the stream was associated.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ASSOCIATEDAT() |
Getter for ASSOCIATEDAT, with configurable default |
ASK_ASSOCIATEDAT() |
Getter for ASSOCIATEDAT w/ exceptions if field has no value |
HAS_ASSOCIATEDAT() |
Determine if ASSOCIATEDAT has a value |
AssociatedSegments¶
A list of segments currently associated with the stream and their subscription status.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ASSOCIATEDSEGMENTS() |
Getter for ASSOCIATEDSEGMENTS, with configurable default |
ASK_ASSOCIATEDSEGMENTS() |
Getter for ASSOCIATEDSEGMENTS w/ exceptions if field has no |
HAS_ASSOCIATEDSEGMENTS() |
Determine if ASSOCIATEDSEGMENTS has a value |
DomainName¶
The unique name of the domain.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DOMAINNAME() |
Getter for DOMAINNAME, with configurable default |
ASK_DOMAINNAME() |
Getter for DOMAINNAME w/ exceptions if field has no value |
HAS_DOMAINNAME() |
Determine if DOMAINNAME has a value |
DestinationArn¶
The Amazon Resource Name (ARN) of the Amazon Kinesis data stream receiving segment membership events.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DESTINATIONARN() |
Getter for DESTINATIONARN, with configurable default |
ASK_DESTINATIONARN() |
Getter for DESTINATIONARN w/ exceptions if field has no valu |
HAS_DESTINATIONARN() |
Determine if DESTINATIONARN has a value |
DestinationRoleArn¶
The Amazon Resource Name (ARN) of the IAM role used for Amazon Kinesis and AWS Key Management Service (KMS) operations.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DESTINATIONROLEARN() |
Getter for DESTINATIONROLEARN, with configurable default |
ASK_DESTINATIONROLEARN() |
Getter for DESTINATIONROLEARN w/ exceptions if field has no |
HAS_DESTINATIONROLEARN() |
Determine if DESTINATIONROLEARN has a value |
State¶
The operational state of the destination stream. The following are valid values:
RUNNING: The stream is associated and healthy. Segment membership events are being published.
UNHEALTHY: The stream is associated but events cannot currently be published. See
FailureReasonfor details.STOPPED: The stream is no longer publishing segment membership events.
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 |
DisassociatedAt¶
The timestamp of when the stream was disassociated.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DISASSOCIATEDAT() |
Getter for DISASSOCIATEDAT, with configurable default |
ASK_DISASSOCIATEDAT() |
Getter for DISASSOCIATEDAT w/ exceptions if field has no val |
HAS_DISASSOCIATEDAT() |
Determine if DISASSOCIATEDAT has a value |
FailureReason¶
The reason why the stream is in an unhealthy state, if applicable.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_FAILUREREASON() |
Getter for FAILUREREASON, with configurable default |
ASK_FAILUREREASON() |
Getter for FAILUREREASON w/ exceptions if field has no value |
HAS_FAILUREREASON() |
Determine if FAILUREREASON has a value |