Skip to content

/AWS1/CL_KNSCHANNELSUMMARY

A summary of a channel, returned by ListChannels.

CONSTRUCTOR

IMPORTING

Required arguments:

iv_channelname TYPE /AWS1/KNSCHANNELNAME /AWS1/KNSCHANNELNAME

The name of the channel.

iv_channelarn TYPE /AWS1/KNSCHANNELARN /AWS1/KNSCHANNELARN

The Amazon Resource Name (ARN) of the channel.

iv_channelid TYPE /AWS1/KNSCHANNELID /AWS1/KNSCHANNELID

The unique identifier of the channel.

iv_channelstatus TYPE /AWS1/KNSCHANNELSTATUS /AWS1/KNSCHANNELSTATUS

The current status of the channel. Valid values:

  • CREATING - The channel is being created.

  • ACTIVE - The channel is ready to deliver records.

  • UPDATING - The channel configuration is being updated.

  • DELETING - The channel is being deleted.

  • FAILED - See ChannelStatusReason for the failure cause.

iv_channelcreationtimestamp TYPE /AWS1/KNSTIMESTAMP /AWS1/KNSTIMESTAMP

The time at which the channel was created.

iv_channeldestinationtype TYPE /AWS1/KNSCHANNELDSTTYPE /AWS1/KNSCHANNELDSTTYPE

The destination type of the channel. Valid values:

  • S3 - Delivery to a general purpose Amazon S3 bucket.

  • S3_TABLES - Delivery to streaming tables on Apache Iceberg.

it_streams TYPE /AWS1/CL_KNSCHANNELSTREAMID=>TT_CHANNELSTREAMIDENTIFIERLIST TT_CHANNELSTREAMIDENTIFIERLIST

The source streams associated with the channel.

Optional arguments:

iv_channelstatusreason TYPE /AWS1/KNSCHANNELSTATUSREASON /AWS1/KNSCHANNELSTATUSREASON

A message describing the reason for a FAILED status.

Queryable Attributes

ChannelName

The name of the channel.

Accessible with the following methods

Method Description
GET_CHANNELNAME() Getter for CHANNELNAME, with configurable default
ASK_CHANNELNAME() Getter for CHANNELNAME w/ exceptions if field has no value
HAS_CHANNELNAME() Determine if CHANNELNAME has a value

ChannelARN

The Amazon Resource Name (ARN) of the channel.

Accessible with the following methods

Method Description
GET_CHANNELARN() Getter for CHANNELARN, with configurable default
ASK_CHANNELARN() Getter for CHANNELARN w/ exceptions if field has no value
HAS_CHANNELARN() Determine if CHANNELARN has a value

ChannelId

The unique identifier of the channel.

Accessible with the following methods

Method Description
GET_CHANNELID() Getter for CHANNELID, with configurable default
ASK_CHANNELID() Getter for CHANNELID w/ exceptions if field has no value
HAS_CHANNELID() Determine if CHANNELID has a value

ChannelStatus

The current status of the channel. Valid values:

  • CREATING - The channel is being created.

  • ACTIVE - The channel is ready to deliver records.

  • UPDATING - The channel configuration is being updated.

  • DELETING - The channel is being deleted.

  • FAILED - See ChannelStatusReason for the failure cause.

Accessible with the following methods

Method Description
GET_CHANNELSTATUS() Getter for CHANNELSTATUS, with configurable default
ASK_CHANNELSTATUS() Getter for CHANNELSTATUS w/ exceptions if field has no value
HAS_CHANNELSTATUS() Determine if CHANNELSTATUS has a value

ChannelStatusReason

A message describing the reason for a FAILED status.

Accessible with the following methods

Method Description
GET_CHANNELSTATUSREASON() Getter for CHANNELSTATUSREASON, with configurable default
ASK_CHANNELSTATUSREASON() Getter for CHANNELSTATUSREASON w/ exceptions if field has no
HAS_CHANNELSTATUSREASON() Determine if CHANNELSTATUSREASON has a value

ChannelCreationTimestamp

The time at which the channel was created.

Accessible with the following methods

Method Description
GET_CHANNELCREATIONTIMESTAMP() Getter for CHANNELCREATIONTIMESTAMP, with configurable defau
ASK_CHANNELCREATIONTIMESTAMP() Getter for CHANNELCREATIONTIMESTAMP w/ exceptions if field h
HAS_CHANNELCREATIONTIMESTAMP() Determine if CHANNELCREATIONTIMESTAMP has a value

ChannelDestinationType

The destination type of the channel. Valid values:

  • S3 - Delivery to a general purpose Amazon S3 bucket.

  • S3_TABLES - Delivery to streaming tables on Apache Iceberg.

Accessible with the following methods

Method Description
GET_CHANNELDESTINATIONTYPE() Getter for CHANNELDESTINATIONTYPE, with configurable default
ASK_CHANNELDESTINATIONTYPE() Getter for CHANNELDESTINATIONTYPE w/ exceptions if field has
HAS_CHANNELDESTINATIONTYPE() Determine if CHANNELDESTINATIONTYPE has a value

Streams

The source streams associated with the channel.

Accessible with the following methods

Method Description
GET_STREAMS() Getter for STREAMS, with configurable default
ASK_STREAMS() Getter for STREAMS w/ exceptions if field has no value
HAS_STREAMS() Determine if STREAMS has a value

Public Local Types In This Class

Internal table types, representing arrays and maps of this class, are defined as local types:

TT_CHANNELSUMMARYLIST

TYPES TT_CHANNELSUMMARYLIST TYPE STANDARD TABLE OF REF TO /AWS1/CL_KNSCHANNELSUMMARY WITH DEFAULT KEY
.