AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Chime::Types::ListChannelMessagesRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing ListChannelMessagesRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  channel_arn: "ChimeArn", # required
  sort_order: "ASCENDING", # accepts ASCENDING, DESCENDING
  not_before: Time.now,
  not_after: Time.now,
  max_results: 1,
  next_token: "NextToken",
}

Instance Attribute Summary collapse

Instance Attribute Details

#channel_arnString

The ARN of the channel.

Returns:

  • (String)

    The ARN of the channel.

#max_resultsInteger

The maximum number of messages that you want returned.

Returns:

  • (Integer)

    The maximum number of messages that you want returned.

#next_tokenString

The token passed by previous API calls until all requested messages are returned.

Returns:

  • (String)

    The token passed by previous API calls until all requested messages are returned.

#not_afterTime

The final or ending time stamp for your requested messages.

Returns:

  • (Time)

    The final or ending time stamp for your requested messages.

#not_beforeTime

The initial or starting time stamp for your requested messages.

Returns:

  • (Time)

    The initial or starting time stamp for your requested messages.

#sort_orderString

The order in which you want messages sorted. Default is Descending, based on time created.

Possible values:

  • ASCENDING
  • DESCENDING

Returns:

  • (String)

    The order in which you want messages sorted.