Class: Aws::Lightsail::Types::GetContainerLogRequest

Inherits:

Struct

• Object
• Struct
• Aws::Lightsail::Types::GetContainerLogRequest

Includes:

Structure

Defined in:

lib/aws-sdk-lightsail/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #container_name ⇒ String

  The name of the container that is either running or previously ran on the container service for which to return a log.

• #end_time ⇒ Time

  The end of the time interval for which to get log data.

• #filter_pattern ⇒ String

  The pattern to use to filter the returned log events to a specific term.

• #page_token ⇒ String

  The token to advance to the next page of results from your request.

• #service_name ⇒ String

  The name of the container service for which to get a container log.

• #start_time ⇒ Time

  The start of the time interval for which to get log data.

Instance Attribute Details

#container_name ⇒ String

The name of the container that is either running or previously ran on the container service for which to return a log.

Returns:

• (String)

# File 'lib/aws-sdk-lightsail/types.rb', line 7120

class GetContainerLogRequest < Struct.new(
  :service_name,
  :container_name,
  :start_time,
  :end_time,
  :filter_pattern,
  :page_token)
  SENSITIVE = []
  include Aws::Structure
end

#end_time ⇒ Time

The end of the time interval for which to get log data.

Constraints:

• Specified in Coordinated Universal Time (UTC).

• Specified in the Unix time format.

  For example, if you wish to use an end time of October 1, 2018, at 9 PM UTC, specify ‘1538427600` as the end time.

You can convert a human-friendly time to Unix time format using a converter like [Epoch converter].

[1]: www.epochconverter.com/

Returns:

• (Time)

# File 'lib/aws-sdk-lightsail/types.rb', line 7120

class GetContainerLogRequest < Struct.new(
  :service_name,
  :container_name,
  :start_time,
  :end_time,
  :filter_pattern,
  :page_token)
  SENSITIVE = []
  include Aws::Structure
end

#filter_pattern ⇒ String

The pattern to use to filter the returned log events to a specific term.

The following are a few examples of filter patterns that you can specify:

• To return all log events, specify a filter pattern of ‘“”`.

• To exclude log events that contain the ‘ERROR` term, and return all other log events, specify a filter pattern of `“-ERROR”`.

• To return log events that contain the ‘ERROR` term, specify a filter pattern of `“ERROR”`.

• To return log events that contain both the ‘ERROR` and `Exception` terms, specify a filter pattern of `“ERROR Exception”`.

• To return log events that contain the ‘ERROR` or the `Exception` term, specify a filter pattern of `“?ERROR ?Exception”`.

Returns:

• (String)

# File 'lib/aws-sdk-lightsail/types.rb', line 7120

class GetContainerLogRequest < Struct.new(
  :service_name,
  :container_name,
  :start_time,
  :end_time,
  :filter_pattern,
  :page_token)
  SENSITIVE = []
  include Aws::Structure
end

#page_token ⇒ String

The token to advance to the next page of results from your request.

To get a page token, perform an initial ‘GetContainerLog` request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

Returns:

• (String)

# File 'lib/aws-sdk-lightsail/types.rb', line 7120

class GetContainerLogRequest < Struct.new(
  :service_name,
  :container_name,
  :start_time,
  :end_time,
  :filter_pattern,
  :page_token)
  SENSITIVE = []
  include Aws::Structure
end

#service_name ⇒ String

The name of the container service for which to get a container log.

Returns:

• (String)

# File 'lib/aws-sdk-lightsail/types.rb', line 7120

class GetContainerLogRequest < Struct.new(
  :service_name,
  :container_name,
  :start_time,
  :end_time,
  :filter_pattern,
  :page_token)
  SENSITIVE = []
  include Aws::Structure
end

#start_time ⇒ Time

The start of the time interval for which to get log data.

Constraints:

• Specified in Coordinated Universal Time (UTC).

• Specified in the Unix time format.

  For example, if you wish to use a start time of October 1, 2018, at 8 PM UTC, specify ‘1538424000` as the start time.

You can convert a human-friendly time to Unix time format using a converter like [Epoch converter].

[1]: www.epochconverter.com/

Returns:

• (Time)

# File 'lib/aws-sdk-lightsail/types.rb', line 7120

class GetContainerLogRequest < Struct.new(
  :service_name,
  :container_name,
  :start_time,
  :end_time,
  :filter_pattern,
  :page_token)
  SENSITIVE = []
  include Aws::Structure
end