Skip to main content

List IcebergTables​

Returns a list of Iceberg Tables.

Query Parameters
  • limit int64

    Limits the size of the response on each page to the specified number of items.

  • start string

    Sets the page number used to browse the collection. Pages are indexed starting from 1 (i.e., ?start=1).

  • filter string

    Narrows down the results to only the items that satisfy the filter criteria. The following table lists the supported filter fields for this resource and the filter conditions that can be applied on those fields:

    FieldFilter ConditionDescription
    environment_id$eqThe Clumio-assigned ID of the AWS environment.
    deactivated$eqFilter assets protected by a deactivated policy.
    protection_info.policy_id$eqThe Clumio-assigned ID of the policy protecting this resource.
    protection_status$inThe protection status of this resource. Possible values include protected, unprotected, and unsupported.
    backup_status$inThe backup status of this resource. Possible values include success, partial_success, failure and no_backup.
    is_deleted$eq,$inThe deletion status of this resource. If not specified, retrieves only active Iceberg tables. ?filter={"is_deleted":{"$in":["true","false"]}}
    account_native_id$eq,$inThe AWS-assigned ID of the account to which this resource belongs. For example, ?filter={"account_native_id":{"$in":["789901323485"]}} retrieves Iceberg tables across all regions in account 789901323485.
    table_name$contains,$eqThe name of the table. For example, ?filter={"table_name":{"$contains":"dev"}} retrieves all Iceberg tables with "dev" in their name.
    catalog_type$inThe type of catalog. Possible values include aws_iceberg_glue_table and aws_iceberg_s3_table. For example, ?filter={"catalog_type":{"$in":["aws_iceberg_glue_table"]}} retrieves all Iceberg tables whose catalog type is Glue.
    catalog$contains,$eqThe name of the catalog. For example, ?filter={"catalog":{"$contains":"dev"}} retrieves all Iceberg tables in the catalog containing "dev".
    namespace$contains,$eqFor example, ?filter={"namespace":{"$contains":"dev"}} retrieves all Iceberg tables in the namespace containing "dev".
    For more information about filtering, refer to the Filtering section of this guide.
  • lookback_days int64

    Calculate backup status for the last lookback_days days.

Responses

Success

Schema
  • _embedded object

    Embedded responses related to the resource.

  • items object[]

    A collection of requested items.

  • account_native_id string

    The AWS-assigned ID of the account associated with the Iceberg Table.

  • aws_region string

    The AWS region associated with the Iceberg Table.

  • backup_status_info object

    The backup status information applied to this resource.

  • backup_status string

    BackupStatus is the status of the backup. Possible values are success, partial_success, failure, no_backup, and unknown. This value depends on lookback_days. If not specified, then this field has a value of unknown.

  • last_failed_policy_start_timestamp string

    The last failed policy start time. Represented in RFC-3339 format.

  • last_successful_policy_start_timestamp string

    The last successful policy start time. Represented in RFC-3339 format.

  • operation_info_list object[]

    The policy operation information of the backups.

  • backup_status string

    BackupStatus is the status of the backup. Possible values are success, partial_success, failure, no_backup, and unknown. This value depends on lookback_days. If not specified, then this field has a value of unknown.

  • last_failed_policy_start_timestamp string

    The last failed policy start time. Represented in RFC-3339 format.

  • last_successful_policy_start_timestamp string

    The last successful policy start time. Represented in RFC-3339 format.

  • operation string

    The policy operation type.

  • catalog string

    The catalog name of the Iceberg Table.

  • catalog_type string

    Type is mostly an asset type or the type of Entity. Some examples are "restored_file", "aws_ebs_volume", etc.

  • creation_timestamp string

    The timestamp of when the Iceberg Table was created. Represented in RFC-3339 format.

  • deletion_timestamp string

    The timestamp of when the table was deleted. Represented in RFC-3339 format. If this table has not been deleted, then this field has a value of null.

  • direct_assignment_policy_id string

    The Clumio-assigned ID of the policy directly assigned to the entity.

  • environment_id string

    The Clumio-assigned ID of the AWS environment associated with the Iceberg Table.

  • has_direct_assignment boolean

    Determines whether the table has a direct assignment.

  • id string

    The Clumio-assigned ID of the Iceberg Table.

  • is_deleted boolean

    Determines whether the Iceberg Table has been deleted. If true, the table has been deleted.

  • is_supported boolean

    Determines whether the Iceberg Table is supported for backups.

  • last_backup_timestamp string

    The timestamp of the most recent backup of the Iceberg Table. Represented in RFC-3339 format. If the table has never been backed up, then this field has a value of null.

  • name string

    The AWS-assigned name of the Iceberg Table.

  • namespace string

    The namespace of the Iceberg Table.

  • organizational_unit_id string

    The Clumio-assigned ID of the organizational unit associated with the Iceberg Table.

  • protection_info object

    The protection policy applied to this resource. If the resource is not protected, then this field has a value of null.

  • inheriting_entity_id string

    The ID of the entity from which protection was inherited. If protection was not inherited, then this field has a value of null.

  • inheriting_entity_type string

    The type of entity from which protection was inherited. If protection was not inherited, then this field has a value of null.
    Entities from which protection can be inherited include the following:

    Inheriting Entity TypeDetails
    aws_tagAWS tag.
  • policy_id string

    A system-generated ID assigned to the policy protecting this resource.

  • protection_status string

    The protection status of the Iceberg Table. Possible values include "protected", "unprotected", and "unsupported". If the Iceberg Table does not support backups, then this field has a value of unsupported. If the table has been deleted, then this field has a value of null.

  • unsupported_reason string

    The reason why protection is not available. If the table is supported, then this field has a value of null.

  • current_count int64

    The number of items listed on the current page.

  • limit int64

    The maximum number of items displayed per page in the response.

  • start string

    The page number used to get this response. Pages are indexed starting from 1 (i.e., "start": "1").

  • total_count int64

    The total number of items, summed across all pages.

  • total_pages_count int64

    The total number of pages of results.

Loading...