Skip to content

GetContainerLogRequest

Source code in docs_src/capo_lightsail/types/get_container_log_request.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
class GetContainerLogRequest(TypedDict, closed=True):
    service_name: "capo_lightsail.types.container_service_name.ContainerServiceName"
    """<p>The name of the container service for which to get a container log.</p>"""
    container_name: "capo_lightsail.types.string.string"
    """<p>The name of the container that is either running or previously ran on the container service for which to return a log.</p>"""
    start_time: NotRequired["capo_lightsail.types.iso_date.IsoDate"]
    """<p>The start of the time interval for which to get log data.</p> <p>Constraints:</p> <ul> <li> <p>Specified in Coordinated Universal Time (UTC).</p> </li> <li> <p>Specified in the Unix time format.</p> <p>For example, if you wish to use a start time of October 1, 2018, at 8 PM UTC, specify <code>1538424000</code> as the start time.</p> </li> </ul> <p>You can convert a human-friendly time to Unix time format using a converter like <a href="https://www.epochconverter.com/">Epoch converter</a>.</p>"""
    end_time: NotRequired["capo_lightsail.types.iso_date.IsoDate"]
    """<p>The end of the time interval for which to get log data.</p> <p>Constraints:</p> <ul> <li> <p>Specified in Coordinated Universal Time (UTC).</p> </li> <li> <p>Specified in the Unix time format.</p> <p>For example, if you wish to use an end time of October 1, 2018, at 9 PM UTC, specify <code>1538427600</code> as the end time.</p> </li> </ul> <p>You can convert a human-friendly time to Unix time format using a converter like <a href="https://www.epochconverter.com/">Epoch converter</a>.</p>"""
    filter_pattern: NotRequired["capo_lightsail.types.string.string"]
    """<p>The pattern to use to filter the returned log events to a specific term.</p> <p>The following are a few examples of filter patterns that you can specify:</p> <ul> <li> <p>To return all log events, specify a filter pattern of <code>""</code>.</p> </li> <li> <p>To exclude log events that contain the <code>ERROR</code> term, and return all other log events, specify a filter pattern of <code>"-ERROR"</code>.</p> </li> <li> <p>To return log events that contain the <code>ERROR</code> term, specify a filter pattern of <code>"ERROR"</code>.</p> </li> <li> <p>To return log events that contain both the <code>ERROR</code> and <code>Exception</code> terms, specify a filter pattern of <code>"ERROR Exception"</code>.</p> </li> <li> <p>To return log events that contain the <code>ERROR</code> <i>or</i> the <code>Exception</code> term, specify a filter pattern of <code>"?ERROR ?Exception"</code>.</p> </li> </ul>"""
    page_token: NotRequired["capo_lightsail.types.string.string"]
    """<p>The token to advance to the next page of results from your request.</p> <p>To get a page token, perform an initial <code>GetContainerLog</code> 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.</p>"""

container_name instance-attribute 

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 instance-attribute 

end_time: NotRequired[IsoDate]

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.

filter_pattern instance-attribute 

filter_pattern: NotRequired[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".

page_token instance-attribute 

page_token: NotRequired[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.

service_name instance-attribute 

service_name: ContainerServiceName

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

start_time instance-attribute 

start_time: NotRequired[IsoDate]

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.