get_table_record_expiration_configuration ¶

get_table_record_expiration_configuration(
    table_arn: TableARN, *, config_overrides: Optional[S3TablesClientConfig] = None
) -> GetTableRecordExpirationConfigurationResponse

Retrieves the expiration configuration settings for records in a table, and the status of the configuration. If the status of the configuration is enabled, records expire and are automatically removed from the table after the specified number of days.

Permissions: You must have the s3tables:GetTableRecordExpirationConfiguration permission to use this operation.

Parameters:

table_arn (TableARN) –

The Amazon Resource Name (ARN) of the table.

Raises:

BadRequestException –

The request is invalid or malformed.
ForbiddenException –

The caller isn't authorized to make the request.
InternalServerErrorException –

The request failed due to an internal server error.
MethodNotAllowedException –

The requested operation is not allowed on this resource. This may occur when attempting to modify a resource that is managed by a service or has restrictions that prevent the operation.
NotFoundException –

The request was rejected because the specified resource could not be found.
TooManyRequestsException –

The limit on the number of requests per second was exceeded.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_s3tables/_services/s3_tables.py

def get_table_record_expiration_configuration(
    self,
    table_arn: "capo_s3tables.types.table_arn.TableARN",
    *,
    config_overrides: Optional[S3TablesClientConfig] = None,
) -> "capo_s3tables.types.get_table_record_expiration_configuration_response.GetTableRecordExpirationConfigurationResponse":
    """<p>Retrieves the expiration configuration settings for records in a table, and the status of the configuration. If the status of the configuration is <code>enabled</code>, records expire and are automatically removed from the table after the specified number of days.</p> <dl> <dt>Permissions</dt> <dd> <p>You must have the <code>s3tables:GetTableRecordExpirationConfiguration</code> permission to use this operation.</p> </dd> </dl>

    Args:
        table_arn: <p>The Amazon Resource Name (ARN) of the table.</p>

    Raises:
        capo_s3tables.errors.bad_request_exception.BadRequestException: <p>The request is invalid or malformed.</p>
        capo_s3tables.errors.forbidden_exception.ForbiddenException: <p>The caller isn't authorized to make the request.</p>
        capo_s3tables.errors.internal_server_error_exception.InternalServerErrorException: <p>The request failed due to an internal server error.</p>
        capo_s3tables.errors.method_not_allowed_exception.MethodNotAllowedException: <p>The requested operation is not allowed on this resource. This may occur when attempting to modify a resource that is managed by a service or has restrictions that prevent the operation.</p>
        capo_s3tables.errors.not_found_exception.NotFoundException: <p>The request was rejected because the specified resource could not be found.</p>
        capo_s3tables.errors.too_many_requests_exception.TooManyRequestsException: <p>The limit on the number of requests per second was exceeded.</p>
        capo_s3tables.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_s3tables.types.get_table_record_expiration_configuration_request.GetTableRecordExpirationConfigurationRequest]",
    ) -> OperationResponse[
        "capo_s3tables.types.get_table_record_expiration_configuration_response.GetTableRecordExpirationConfigurationResponse"
    ]:
        import capo_s3tables._operations.s3_table_buckets.get_table_record_expiration_configuration

        output, http_response = (
            capo_s3tables._operations.s3_table_buckets.get_table_record_expiration_configuration.get_table_record_expiration_configuration(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetTableRecordExpirationConfiguration")
    )
    input_: capo_s3tables.types.get_table_record_expiration_configuration_request.GetTableRecordExpirationConfigurationRequest = {
        "table_arn": table_arn
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output