Class: Aws::CloudWatchLogs::Types::DescribeLogStreamsRequest

Inherits:

Struct

• Object
• Struct
• Aws::CloudWatchLogs::Types::DescribeLogStreamsRequest

Defined in:

gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #descending ⇒ Boolean

  If the value is true, results are returned in descending order.

• #limit ⇒ Integer

  The maximum number of items returned.

• #log_group_identifier ⇒ String

  Specify either the name or ARN of the log group to view.

• #log_group_name ⇒ String

  The name of the log group.

• #log_stream_name_prefix ⇒ String

  The prefix to match.

• #next_token ⇒ String

  The token for the next set of items to return.

• #order_by ⇒ String

  If the value is LogStreamName, the results are ordered by log stream name.

Instance Attribute Details

#descending ⇒ Boolean

If the value is true, results are returned in descending order. If the value is to false, results are returned in ascending order. The default value is false.

Returns:

• (Boolean)

# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb', line 2168

class DescribeLogStreamsRequest < Struct.new(
  :log_group_name,
  :log_group_identifier,
  :log_stream_name_prefix,
  :order_by,
  :descending,
  :next_token,
  :limit)
  SENSITIVE = []
  include Aws::Structure
end

#limit ⇒ Integer

The maximum number of items returned. If you don't specify a value, the default is up to 50 items.

Returns:

• (Integer)

# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb', line 2168

class DescribeLogStreamsRequest < Struct.new(
  :log_group_name,
  :log_group_identifier,
  :log_stream_name_prefix,
  :order_by,
  :descending,
  :next_token,
  :limit)
  SENSITIVE = []
  include Aws::Structure
end

#log_group_identifier ⇒ String

Specify either the name or ARN of the log group to view. If the log group is in a source account and you are using a monitoring account, you must use the log group ARN.

You must include either logGroupIdentifier or logGroupName, but not both.

Returns:

• (String)

# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb', line 2168

class DescribeLogStreamsRequest < Struct.new(
  :log_group_name,
  :log_group_identifier,
  :log_stream_name_prefix,
  :order_by,
  :descending,
  :next_token,
  :limit)
  SENSITIVE = []
  include Aws::Structure
end

#log_group_name ⇒ String

The name of the log group.

You must include either logGroupIdentifier or logGroupName, but not both.

Returns:

• (String)

# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb', line 2168

class DescribeLogStreamsRequest < Struct.new(
  :log_group_name,
  :log_group_identifier,
  :log_stream_name_prefix,
  :order_by,
  :descending,
  :next_token,
  :limit)
  SENSITIVE = []
  include Aws::Structure
end

#log_stream_name_prefix ⇒ String

The prefix to match.

If orderBy is LastEventTime, you cannot specify this parameter.

Returns:

• (String)

# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb', line 2168

class DescribeLogStreamsRequest < Struct.new(
  :log_group_name,
  :log_group_identifier,
  :log_stream_name_prefix,
  :order_by,
  :descending,
  :next_token,
  :limit)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

The token for the next set of items to return. (You received this token from a previous call.)

Returns:

• (String)

# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb', line 2168

class DescribeLogStreamsRequest < Struct.new(
  :log_group_name,
  :log_group_identifier,
  :log_stream_name_prefix,
  :order_by,
  :descending,
  :next_token,
  :limit)
  SENSITIVE = []
  include Aws::Structure
end

#order_by ⇒ String

If the value is LogStreamName, the results are ordered by log stream name. If the value is LastEventTime, the results are ordered by the event time. The default value is LogStreamName.

If you order the results by event time, you cannot specify the logStreamNamePrefix parameter.

lastEventTimestamp represents the time of the most recent log event in the log stream in CloudWatch Logs. This number is expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. lastEventTimestamp updates on an eventual consistency basis. It typically updates in less than an hour from ingestion, but in rare situations might take longer.

Returns:

• (String)

# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb', line 2168

class DescribeLogStreamsRequest < Struct.new(
  :log_group_name,
  :log_group_identifier,
  :log_stream_name_prefix,
  :order_by,
  :descending,
  :next_token,
  :limit)
  SENSITIVE = []
  include Aws::Structure
end