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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb

Overview

Note:

When making an API call, you may pass GetContainerLogRequest data as a hash:

{
  service_name: "ContainerServiceName", # required
  container_name: "string", # required
  start_time: Time.now,
  end_time: Time.now,
  filter_pattern: "string",
  page_token: "string",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#container_nameString

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

Returns:

  • (String)


7598
7599
7600
7601
7602
7603
7604
7605
7606
7607
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 7598

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

#end_timeTime

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.

Returns:

  • (Time)


7598
7599
7600
7601
7602
7603
7604
7605
7606
7607
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 7598

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

#filter_patternString

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)


7598
7599
7600
7601
7602
7603
7604
7605
7606
7607
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 7598

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

#page_tokenString

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)


7598
7599
7600
7601
7602
7603
7604
7605
7606
7607
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 7598

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

#service_nameString

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

Returns:

  • (String)


7598
7599
7600
7601
7602
7603
7604
7605
7606
7607
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 7598

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

#start_timeTime

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.

Returns:

  • (Time)


7598
7599
7600
7601
7602
7603
7604
7605
7606
7607
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 7598

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