download_db_log_file_portion¶
Operation¶
download_db_log_file_portion
¶
download_db_log_file_portion(request: DownloadDBLogFilePortionInput | DownloadDBLogFilePortionInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DownloadDBLogFilePortionInputDict]) -> DownloadDBLogFilePortionOutput
Downloads all or a portion of the specified log file, up to 1 MB in size.
This command doesn't apply to RDS Custom.
Note
This operation uses resources on database instances. Because of this, we recommend publishing database logs to CloudWatch and then using the GetLogEvents operation. For more information, see GetLogEvents in the Amazon CloudWatch Logs API Reference.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
DownloadDBLogFilePortionInput | DownloadDBLogFilePortionInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[DownloadDBLogFilePortionInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DownloadDBLogFilePortionOutput
|
An instance of |
download_db_log_file_portion
async
¶
download_db_log_file_portion(request: DownloadDBLogFilePortionInput | DownloadDBLogFilePortionInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DownloadDBLogFilePortionInputDict]) -> DownloadDBLogFilePortionOutput
Downloads all or a portion of the specified log file, up to 1 MB in size.
This command doesn't apply to RDS Custom.
Note
This operation uses resources on database instances. Because of this, we recommend publishing database logs to CloudWatch and then using the GetLogEvents operation. For more information, see GetLogEvents in the Amazon CloudWatch Logs API Reference.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
DownloadDBLogFilePortionInput | DownloadDBLogFilePortionInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[DownloadDBLogFilePortionInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DownloadDBLogFilePortionOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
DownloadDBLogFilePortionInputDict
¶
Bases: TypedDict
Dictionary form of DownloadDBLogFilePortionInput.
Attributes¶
db_instance_identifier
instance-attribute
¶
The customer-assigned name of the DB instance that contains the log files you want to list.
Constraints:
- Must match the identifier of an existing DBInstance.
log_file_name
instance-attribute
¶
The name of the log file to be downloaded.
marker
instance-attribute
¶
marker: str | None
The pagination token provided in the previous request or "0". If the Marker parameter is specified the response includes only records beyond the marker until the end of the file or up to NumberOfLines.
number_of_lines
instance-attribute
¶
number_of_lines: int | None
The number of lines to download. If the number of lines specified results in a file over 1 MB in size, the file is truncated at 1 MB in size.
If the NumberOfLines parameter is specified, then the block of lines returned can be from the beginning or the end of the log file, depending on the value of the Marker parameter.
-
If neither Marker or NumberOfLines are specified, the entire log file is returned up to a maximum of 10000 lines, starting with the most recent log entries first.
-
If NumberOfLines is specified and Marker isn't specified, then the most recent lines from the end of the log file are returned.
-
If Marker is specified as "0", then the specified number of lines from the beginning of the log file are returned.
-
You can download the log file in blocks of lines by specifying the size of the block using the NumberOfLines parameter, and by specifying a value of "0" for the Marker parameter in your first request. Include the Marker value returned in the response as the Marker value for the next request, continuing until the AdditionalDataPending response element returns false.
DownloadDBLogFilePortionInput
dataclass
¶
Bases: _SerdeShape
Attributes¶
db_instance_identifier
class-attribute
instance-attribute
¶
db_instance_identifier: str | None = ...
The customer-assigned name of the DB instance that contains the log files you want to list.
Constraints:
- Must match the identifier of an existing DBInstance.
log_file_name
class-attribute
instance-attribute
¶
log_file_name: str | None = ...
The name of the log file to be downloaded.
marker
class-attribute
instance-attribute
¶
marker: str | None = ...
The pagination token provided in the previous request or "0". If the Marker parameter is specified the response includes only records beyond the marker until the end of the file or up to NumberOfLines.
number_of_lines
class-attribute
instance-attribute
¶
number_of_lines: int | None = ...
The number of lines to download. If the number of lines specified results in a file over 1 MB in size, the file is truncated at 1 MB in size.
If the NumberOfLines parameter is specified, then the block of lines returned can be from the beginning or the end of the log file, depending on the value of the Marker parameter.
-
If neither Marker or NumberOfLines are specified, the entire log file is returned up to a maximum of 10000 lines, starting with the most recent log entries first.
-
If NumberOfLines is specified and Marker isn't specified, then the most recent lines from the end of the log file are returned.
-
If Marker is specified as "0", then the specified number of lines from the beginning of the log file are returned.
-
You can download the log file in blocks of lines by specifying the size of the block using the NumberOfLines parameter, and by specifying a value of "0" for the Marker parameter in your first request. Include the Marker value returned in the response as the Marker value for the next request, continuing until the AdditionalDataPending response element returns false.
Output¶
DownloadDBLogFilePortionOutput
dataclass
¶
Bases: _SerdeShape
This data type is used as a response element to
DownloadDBLogFilePortion.
Attributes¶
additional_data_pending
class-attribute
instance-attribute
¶
additional_data_pending: bool | None = ...
A Boolean value that, if true, indicates there is more data to be downloaded.
log_file_data
class-attribute
instance-attribute
¶
log_file_data: str | None = ...
Entries from the specified log file.
marker
class-attribute
instance-attribute
¶
marker: str | None = ...
A pagination token that can be used in a later
DownloadDBLogFilePortion request.
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.