# WARNING: DO NOT EDIT, AUTO-GENERATED CODE!
# See https://github.com/aws-beam/aws-codegen for more details.
defmodule AWS.S3Tables do
@moduledoc """
An Amazon S3 table represents a structured dataset consisting of tabular data in
[Apache Parquet](https://parquet.apache.org/docs/) format and related metadata. This data is stored inside an S3 table as a subresource. All tables in a table
bucket are stored in the [Apache
Iceberg](https://iceberg.apache.org/docs/latest/) table format. Through
integration with the [AWS Glue Data Catalog](https://docs.aws.amazon.com/https:/docs.aws.amazon.com/glue/latest/dg/catalog-and-crawler.html)
you can interact with your tables using AWS analytics services, such as [Amazon Athena](https://docs.aws.amazon.com/https:/docs.aws.amazon.com/athena/) and
[Amazon Redshift](https://docs.aws.amazon.com/https:/docs.aws.amazon.com/redshift/).
Amazon S3 manages maintenance of your tables through automatic file compaction
and snapshot management. For more information, see [Amazon S3 table buckets](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-buckets.html).
"""
alias AWS.Client
alias AWS.Request
@typedoc """
## Example:
put_table_maintenance_configuration_request() :: %{
required("value") => table_maintenance_configuration_value()
}
"""
@type put_table_maintenance_configuration_request() :: %{String.t() => any()}
@typedoc """
## Example:
get_table_bucket_policy_request() :: %{}
"""
@type get_table_bucket_policy_request() :: %{}
@typedoc """
## Example:
list_table_buckets_request() :: %{
optional("continuationToken") => String.t(),
optional("maxBuckets") => integer(),
optional("prefix") => [String.t()]
}
"""
@type list_table_buckets_request() :: %{String.t() => any()}
@typedoc """
## Example:
iceberg_snapshot_management_settings() :: %{
"maxSnapshotAgeHours" => integer(),
"minSnapshotsToKeep" => integer()
}
"""
@type iceberg_snapshot_management_settings() :: %{String.t() => any()}
@typedoc """
## Example:
delete_table_policy_request() :: %{}
"""
@type delete_table_policy_request() :: %{}
@typedoc """
## Example:
update_table_metadata_location_request() :: %{
required("metadataLocation") => String.t(),
required("versionToken") => String.t()
}
"""
@type update_table_metadata_location_request() :: %{String.t() => any()}
@typedoc """
## Example:
put_table_bucket_policy_request() :: %{
required("resourcePolicy") => String.t()
}
"""
@type put_table_bucket_policy_request() :: %{String.t() => any()}
@typedoc """
## Example:
get_table_bucket_policy_response() :: %{
"resourcePolicy" => String.t()
}
"""
@type get_table_bucket_policy_response() :: %{String.t() => any()}
@typedoc """
## Example:
list_namespaces_request() :: %{
optional("continuationToken") => String.t(),
optional("maxNamespaces") => integer(),
optional("prefix") => [String.t()]
}
"""
@type list_namespaces_request() :: %{String.t() => any()}
@typedoc """
## Example:
delete_table_request() :: %{
optional("versionToken") => String.t()
}
"""
@type delete_table_request() :: %{String.t() => any()}
@typedoc """
## Example:
forbidden_exception() :: %{
"message" => String.t()
}
"""
@type forbidden_exception() :: %{String.t() => any()}
@typedoc """
## Example:
namespace_summary() :: %{
"createdAt" => [non_neg_integer()],
"createdBy" => String.t(),
"namespace" => list(String.t()()),
"ownerAccountId" => String.t()
}
"""
@type namespace_summary() :: %{String.t() => any()}
@typedoc """
## Example:
table_summary() :: %{
"createdAt" => [non_neg_integer()],
"modifiedAt" => [non_neg_integer()],
"name" => String.t(),
"namespace" => list(String.t()()),
"tableARN" => String.t(),
"type" => list(any())
}
"""
@type table_summary() :: %{String.t() => any()}
@typedoc """
## Example:
get_table_request() :: %{}
"""
@type get_table_request() :: %{}
@typedoc """
## Example:
get_table_maintenance_configuration_response() :: %{
"configuration" => map(),
"tableARN" => String.t()
}
"""
@type get_table_maintenance_configuration_response() :: %{String.t() => any()}
@typedoc """
## Example:
update_table_metadata_location_response() :: %{
"metadataLocation" => String.t(),
"name" => String.t(),
"namespace" => list(String.t()()),
"tableARN" => String.t(),
"versionToken" => String.t()
}
"""
@type update_table_metadata_location_response() :: %{String.t() => any()}
@typedoc """
## Example:
create_table_request() :: %{
required("format") => list(any()),
required("name") => String.t()
}
"""
@type create_table_request() :: %{String.t() => any()}
@typedoc """
## Example:
get_table_response() :: %{
"createdAt" => [non_neg_integer()],
"createdBy" => String.t(),
"format" => list(any()),
"managedByService" => [String.t()],
"metadataLocation" => String.t(),
"modifiedAt" => [non_neg_integer()],
"modifiedBy" => String.t(),
"name" => String.t(),
"namespace" => list(String.t()()),
"ownerAccountId" => String.t(),
"tableARN" => String.t(),
"type" => list(any()),
"versionToken" => String.t(),
"warehouseLocation" => String.t()
}
"""
@type get_table_response() :: %{String.t() => any()}
@typedoc """
## Example:
get_table_policy_request() :: %{}
"""
@type get_table_policy_request() :: %{}
@typedoc """
## Example:
get_table_maintenance_job_status_response() :: %{
"status" => map(),
"tableARN" => String.t()
}
"""
@type get_table_maintenance_job_status_response() :: %{String.t() => any()}
@typedoc """
## Example:
too_many_requests_exception() :: %{
"message" => String.t()
}
"""
@type too_many_requests_exception() :: %{String.t() => any()}
@typedoc """
## Example:
table_maintenance_configuration_value() :: %{
"settings" => list(),
"status" => list(any())
}
"""
@type table_maintenance_configuration_value() :: %{String.t() => any()}
@typedoc """
## Example:
get_table_maintenance_configuration_request() :: %{}
"""
@type get_table_maintenance_configuration_request() :: %{}
@typedoc """
## Example:
get_namespace_response() :: %{
"createdAt" => [non_neg_integer()],
"createdBy" => String.t(),
"namespace" => list(String.t()()),
"ownerAccountId" => String.t()
}
"""
@type get_namespace_response() :: %{String.t() => any()}
@typedoc """
## Example:
create_namespace_request() :: %{
required("namespace") => list(String.t()())
}
"""
@type create_namespace_request() :: %{String.t() => any()}
@typedoc """
## Example:
conflict_exception() :: %{
"message" => String.t()
}
"""
@type conflict_exception() :: %{String.t() => any()}
@typedoc """
## Example:
list_tables_response() :: %{
"continuationToken" => String.t(),
"tables" => list(table_summary()())
}
"""
@type list_tables_response() :: %{String.t() => any()}
@typedoc """
## Example:
create_table_response() :: %{
"tableARN" => String.t(),
"versionToken" => String.t()
}
"""
@type create_table_response() :: %{String.t() => any()}
@typedoc """
## Example:
get_table_bucket_maintenance_configuration_request() :: %{}
"""
@type get_table_bucket_maintenance_configuration_request() :: %{}
@typedoc """
## Example:
delete_table_bucket_policy_request() :: %{}
"""
@type delete_table_bucket_policy_request() :: %{}
@typedoc """
## Example:
put_table_bucket_maintenance_configuration_request() :: %{
required("value") => table_bucket_maintenance_configuration_value()
}
"""
@type put_table_bucket_maintenance_configuration_request() :: %{String.t() => any()}
@typedoc """
## Example:
not_found_exception() :: %{
"message" => String.t()
}
"""
@type not_found_exception() :: %{String.t() => any()}
@typedoc """
## Example:
create_table_bucket_response() :: %{
"arn" => String.t()
}
"""
@type create_table_bucket_response() :: %{String.t() => any()}
@typedoc """
## Example:
get_table_bucket_request() :: %{}
"""
@type get_table_bucket_request() :: %{}
@typedoc """
## Example:
get_table_metadata_location_request() :: %{}
"""
@type get_table_metadata_location_request() :: %{}
@typedoc """
## Example:
create_table_bucket_request() :: %{
required("name") => String.t()
}
"""
@type create_table_bucket_request() :: %{String.t() => any()}
@typedoc """
## Example:
get_table_maintenance_job_status_request() :: %{}
"""
@type get_table_maintenance_job_status_request() :: %{}
@typedoc """
## Example:
iceberg_unreferenced_file_removal_settings() :: %{
"nonCurrentDays" => integer(),
"unreferencedDays" => integer()
}
"""
@type iceberg_unreferenced_file_removal_settings() :: %{String.t() => any()}
@typedoc """
## Example:
table_maintenance_job_status_value() :: %{
"failureMessage" => [String.t()],
"lastRunTimestamp" => [non_neg_integer()],
"status" => list(any())
}
"""
@type table_maintenance_job_status_value() :: %{String.t() => any()}
@typedoc """
## Example:
get_table_policy_response() :: %{
"resourcePolicy" => String.t()
}
"""
@type get_table_policy_response() :: %{String.t() => any()}
@typedoc """
## Example:
list_table_buckets_response() :: %{
"continuationToken" => String.t(),
"tableBuckets" => list(table_bucket_summary()())
}
"""
@type list_table_buckets_response() :: %{String.t() => any()}
@typedoc """
## Example:
access_denied_exception() :: %{
"message" => String.t()
}
"""
@type access_denied_exception() :: %{String.t() => any()}
@typedoc """
## Example:
create_namespace_response() :: %{
"namespace" => list(String.t()()),
"tableBucketARN" => String.t()
}
"""
@type create_namespace_response() :: %{String.t() => any()}
@typedoc """
## Example:
get_table_bucket_maintenance_configuration_response() :: %{
"configuration" => map(),
"tableBucketARN" => String.t()
}
"""
@type get_table_bucket_maintenance_configuration_response() :: %{String.t() => any()}
@typedoc """
## Example:
iceberg_compaction_settings() :: %{
"targetFileSizeMB" => integer()
}
"""
@type iceberg_compaction_settings() :: %{String.t() => any()}
@typedoc """
## Example:
rename_table_request() :: %{
optional("newName") => String.t(),
optional("newNamespaceName") => String.t(),
optional("versionToken") => String.t()
}
"""
@type rename_table_request() :: %{String.t() => any()}
@typedoc """
## Example:
internal_server_error_exception() :: %{
"message" => String.t()
}
"""
@type internal_server_error_exception() :: %{String.t() => any()}
@typedoc """
## Example:
list_namespaces_response() :: %{
"continuationToken" => String.t(),
"namespaces" => list(namespace_summary()())
}
"""
@type list_namespaces_response() :: %{String.t() => any()}
@typedoc """
## Example:
delete_namespace_request() :: %{}
"""
@type delete_namespace_request() :: %{}
@typedoc """
## Example:
get_table_metadata_location_response() :: %{
"metadataLocation" => String.t(),
"versionToken" => String.t(),
"warehouseLocation" => String.t()
}
"""
@type get_table_metadata_location_response() :: %{String.t() => any()}
@typedoc """
## Example:
bad_request_exception() :: %{
"message" => String.t()
}
"""
@type bad_request_exception() :: %{String.t() => any()}
@typedoc """
## Example:
get_table_bucket_response() :: %{
"arn" => String.t(),
"createdAt" => [non_neg_integer()],
"name" => String.t(),
"ownerAccountId" => String.t()
}
"""
@type get_table_bucket_response() :: %{String.t() => any()}
@typedoc """
## Example:
table_bucket_maintenance_configuration_value() :: %{
"settings" => list(),
"status" => list(any())
}
"""
@type table_bucket_maintenance_configuration_value() :: %{String.t() => any()}
@typedoc """
## Example:
put_table_policy_request() :: %{
required("resourcePolicy") => String.t()
}
"""
@type put_table_policy_request() :: %{String.t() => any()}
@typedoc """
## Example:
delete_table_bucket_request() :: %{}
"""
@type delete_table_bucket_request() :: %{}
@typedoc """
## Example:
table_bucket_summary() :: %{
"arn" => String.t(),
"createdAt" => [non_neg_integer()],
"name" => String.t(),
"ownerAccountId" => String.t()
}
"""
@type table_bucket_summary() :: %{String.t() => any()}
@typedoc """
## Example:
get_namespace_request() :: %{}
"""
@type get_namespace_request() :: %{}
@typedoc """
## Example:
list_tables_request() :: %{
optional("continuationToken") => String.t(),
optional("maxTables") => integer(),
optional("namespace") => String.t(),
optional("prefix") => [String.t()]
}
"""
@type list_tables_request() :: %{String.t() => any()}
@type create_namespace_errors() ::
bad_request_exception()
| internal_server_error_exception()
| not_found_exception()
| conflict_exception()
| too_many_requests_exception()
| forbidden_exception()
@type create_table_errors() ::
bad_request_exception()
| internal_server_error_exception()
| not_found_exception()
| conflict_exception()
| too_many_requests_exception()
| forbidden_exception()
@type create_table_bucket_errors() ::
bad_request_exception()
| internal_server_error_exception()
| not_found_exception()
| conflict_exception()
| too_many_requests_exception()
| forbidden_exception()
@type delete_namespace_errors() ::
bad_request_exception()
| internal_server_error_exception()
| not_found_exception()
| conflict_exception()
| too_many_requests_exception()
| forbidden_exception()
@type delete_table_errors() ::
bad_request_exception()
| internal_server_error_exception()
| not_found_exception()
| conflict_exception()
| too_many_requests_exception()
| forbidden_exception()
@type delete_table_bucket_errors() ::
bad_request_exception()
| internal_server_error_exception()
| not_found_exception()
| conflict_exception()
| too_many_requests_exception()
| forbidden_exception()
@type delete_table_bucket_policy_errors() ::
bad_request_exception()
| internal_server_error_exception()
| not_found_exception()
| conflict_exception()
| too_many_requests_exception()
| forbidden_exception()
@type delete_table_policy_errors() ::
bad_request_exception()
| internal_server_error_exception()
| not_found_exception()
| conflict_exception()
| too_many_requests_exception()
| forbidden_exception()
@type get_namespace_errors() ::
bad_request_exception()
| internal_server_error_exception()
| access_denied_exception()
| not_found_exception()
| conflict_exception()
| too_many_requests_exception()
| forbidden_exception()
@type get_table_errors() ::
bad_request_exception()
| internal_server_error_exception()
| access_denied_exception()
| not_found_exception()
| conflict_exception()
| too_many_requests_exception()
| forbidden_exception()
@type get_table_bucket_errors() ::
bad_request_exception()
| internal_server_error_exception()
| access_denied_exception()
| not_found_exception()
| conflict_exception()
| too_many_requests_exception()
| forbidden_exception()
@type get_table_bucket_maintenance_configuration_errors() ::
bad_request_exception()
| internal_server_error_exception()
| not_found_exception()
| conflict_exception()
| too_many_requests_exception()
| forbidden_exception()
@type get_table_bucket_policy_errors() ::
bad_request_exception()
| internal_server_error_exception()
| not_found_exception()
| conflict_exception()
| too_many_requests_exception()
| forbidden_exception()
@type get_table_maintenance_configuration_errors() ::
bad_request_exception()
| internal_server_error_exception()
| not_found_exception()
| conflict_exception()
| too_many_requests_exception()
| forbidden_exception()
@type get_table_maintenance_job_status_errors() ::
bad_request_exception()
| internal_server_error_exception()
| not_found_exception()
| conflict_exception()
| too_many_requests_exception()
| forbidden_exception()
@type get_table_metadata_location_errors() ::
bad_request_exception()
| internal_server_error_exception()
| not_found_exception()
| conflict_exception()
| too_many_requests_exception()
| forbidden_exception()
@type get_table_policy_errors() ::
bad_request_exception()
| internal_server_error_exception()
| not_found_exception()
| conflict_exception()
| too_many_requests_exception()
| forbidden_exception()
@type list_namespaces_errors() ::
bad_request_exception()
| internal_server_error_exception()
| access_denied_exception()
| not_found_exception()
| conflict_exception()
| too_many_requests_exception()
| forbidden_exception()
@type list_table_buckets_errors() ::
bad_request_exception()
| internal_server_error_exception()
| access_denied_exception()
| not_found_exception()
| conflict_exception()
| too_many_requests_exception()
| forbidden_exception()
@type list_tables_errors() ::
bad_request_exception()
| internal_server_error_exception()
| not_found_exception()
| conflict_exception()
| too_many_requests_exception()
| forbidden_exception()
@type put_table_bucket_maintenance_configuration_errors() ::
bad_request_exception()
| internal_server_error_exception()
| not_found_exception()
| conflict_exception()
| too_many_requests_exception()
| forbidden_exception()
@type put_table_bucket_policy_errors() ::
bad_request_exception()
| internal_server_error_exception()
| not_found_exception()
| conflict_exception()
| too_many_requests_exception()
| forbidden_exception()
@type put_table_maintenance_configuration_errors() ::
bad_request_exception()
| internal_server_error_exception()
| not_found_exception()
| conflict_exception()
| too_many_requests_exception()
| forbidden_exception()
@type put_table_policy_errors() ::
bad_request_exception()
| internal_server_error_exception()
| not_found_exception()
| conflict_exception()
| too_many_requests_exception()
| forbidden_exception()
@type rename_table_errors() ::
bad_request_exception()
| internal_server_error_exception()
| not_found_exception()
| conflict_exception()
| too_many_requests_exception()
| forbidden_exception()
@type update_table_metadata_location_errors() ::
bad_request_exception()
| internal_server_error_exception()
| not_found_exception()
| conflict_exception()
| too_many_requests_exception()
| forbidden_exception()
def metadata do
%{
api_version: "2018-05-10",
content_type: "application/x-amz-json-1.1",
credential_scope: nil,
endpoint_prefix: "s3tables",
global?: false,
hostname: nil,
protocol: "rest-json",
service_id: "S3Tables",
signature_version: "v4",
signing_name: "s3tables",
target_prefix: nil
}
end
@doc """
Creates a namespace.
A namespace is a logical grouping of tables within your table bucket, which you
can use to organize tables. For more information, see [Table namespaces](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-namespace.html).
"""
@spec create_namespace(map(), String.t(), create_namespace_request(), list()) ::
{:ok, create_namespace_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, create_namespace_errors()}
def create_namespace(%Client{} = client, table_bucket_arn, input, options \\ []) do
url_path = "/namespaces/#{AWS.Util.encode_uri(table_bucket_arn)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Creates a new table associated with the given namespace in a table bucket.
"""
@spec create_table(map(), String.t(), String.t(), create_table_request(), list()) ::
{:ok, create_table_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, create_table_errors()}
def create_table(%Client{} = client, namespace, table_bucket_arn, input, options \\ []) do
url_path =
"/tables/#{AWS.Util.encode_uri(table_bucket_arn)}/#{AWS.Util.encode_uri(namespace)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Creates a table bucket.
"""
@spec create_table_bucket(map(), create_table_bucket_request(), list()) ::
{:ok, create_table_bucket_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, create_table_bucket_errors()}
def create_table_bucket(%Client{} = client, input, options \\ []) do
url_path = "/buckets"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Deletes a namespace.
"""
@spec delete_namespace(map(), String.t(), String.t(), delete_namespace_request(), list()) ::
{:ok, nil, any()}
| {:error, {:unexpected_response, any()}}
| {:error, delete_namespace_errors()}
def delete_namespace(%Client{} = client, namespace, table_bucket_arn, input, options \\ []) do
url_path =
"/namespaces/#{AWS.Util.encode_uri(table_bucket_arn)}/#{AWS.Util.encode_uri(namespace)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
204
)
end
@doc """
Deletes a table.
"""
@spec delete_table(map(), String.t(), String.t(), String.t(), delete_table_request(), list()) ::
{:ok, nil, any()}
| {:error, {:unexpected_response, any()}}
| {:error, delete_table_errors()}
def delete_table(%Client{} = client, name, namespace, table_bucket_arn, input, options \\ []) do
url_path =
"/tables/#{AWS.Util.encode_uri(table_bucket_arn)}/#{AWS.Util.encode_uri(namespace)}/#{AWS.Util.encode_uri(name)}"
headers = []
custom_headers = []
{query_params, input} =
[
{"versionToken", "versionToken"}
]
|> Request.build_params(input)
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
204
)
end
@doc """
Deletes a table bucket.
"""
@spec delete_table_bucket(map(), String.t(), delete_table_bucket_request(), list()) ::
{:ok, nil, any()}
| {:error, {:unexpected_response, any()}}
| {:error, delete_table_bucket_errors()}
def delete_table_bucket(%Client{} = client, table_bucket_arn, input, options \\ []) do
url_path = "/buckets/#{AWS.Util.encode_uri(table_bucket_arn)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
204
)
end
@doc """
Deletes a table bucket policy.
"""
@spec delete_table_bucket_policy(
map(),
String.t(),
delete_table_bucket_policy_request(),
list()
) ::
{:ok, nil, any()}
| {:error, {:unexpected_response, any()}}
| {:error, delete_table_bucket_policy_errors()}
def delete_table_bucket_policy(%Client{} = client, table_bucket_arn, input, options \\ []) do
url_path = "/buckets/#{AWS.Util.encode_uri(table_bucket_arn)}/policy"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
204
)
end
@doc """
Deletes a table policy.
"""
@spec delete_table_policy(
map(),
String.t(),
String.t(),
String.t(),
delete_table_policy_request(),
list()
) ::
{:ok, nil, any()}
| {:error, {:unexpected_response, any()}}
| {:error, delete_table_policy_errors()}
def delete_table_policy(
%Client{} = client,
name,
namespace,
table_bucket_arn,
input,
options \\ []
) do
url_path =
"/tables/#{AWS.Util.encode_uri(table_bucket_arn)}/#{AWS.Util.encode_uri(namespace)}/#{AWS.Util.encode_uri(name)}/policy"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
204
)
end
@doc """
Gets details about a namespace.
"""
@spec get_namespace(map(), String.t(), String.t(), list()) ::
{:ok, get_namespace_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, get_namespace_errors()}
def get_namespace(%Client{} = client, namespace, table_bucket_arn, options \\ []) do
url_path =
"/namespaces/#{AWS.Util.encode_uri(table_bucket_arn)}/#{AWS.Util.encode_uri(namespace)}"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Gets details about a table.
"""
@spec get_table(map(), String.t(), String.t(), String.t(), list()) ::
{:ok, get_table_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, get_table_errors()}
def get_table(%Client{} = client, name, namespace, table_bucket_arn, options \\ []) do
url_path =
"/tables/#{AWS.Util.encode_uri(table_bucket_arn)}/#{AWS.Util.encode_uri(namespace)}/#{AWS.Util.encode_uri(name)}"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Gets details on a table bucket.
"""
@spec get_table_bucket(map(), String.t(), list()) ::
{:ok, get_table_bucket_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, get_table_bucket_errors()}
def get_table_bucket(%Client{} = client, table_bucket_arn, options \\ []) do
url_path = "/buckets/#{AWS.Util.encode_uri(table_bucket_arn)}"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Gets details about a maintenance configuration for a given table bucket.
"""
@spec get_table_bucket_maintenance_configuration(map(), String.t(), list()) ::
{:ok, get_table_bucket_maintenance_configuration_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, get_table_bucket_maintenance_configuration_errors()}
def get_table_bucket_maintenance_configuration(
%Client{} = client,
table_bucket_arn,
options \\ []
) do
url_path = "/buckets/#{AWS.Util.encode_uri(table_bucket_arn)}/maintenance"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Gets details about a table bucket policy.
"""
@spec get_table_bucket_policy(map(), String.t(), list()) ::
{:ok, get_table_bucket_policy_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, get_table_bucket_policy_errors()}
def get_table_bucket_policy(%Client{} = client, table_bucket_arn, options \\ []) do
url_path = "/buckets/#{AWS.Util.encode_uri(table_bucket_arn)}/policy"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Gets details about the maintenance configuration of a table.
"""
@spec get_table_maintenance_configuration(map(), String.t(), String.t(), String.t(), list()) ::
{:ok, get_table_maintenance_configuration_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, get_table_maintenance_configuration_errors()}
def get_table_maintenance_configuration(
%Client{} = client,
name,
namespace,
table_bucket_arn,
options \\ []
) do
url_path =
"/tables/#{AWS.Util.encode_uri(table_bucket_arn)}/#{AWS.Util.encode_uri(namespace)}/#{AWS.Util.encode_uri(name)}/maintenance"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Gets the status of a maintenance job for a table.
"""
@spec get_table_maintenance_job_status(map(), String.t(), String.t(), String.t(), list()) ::
{:ok, get_table_maintenance_job_status_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, get_table_maintenance_job_status_errors()}
def get_table_maintenance_job_status(
%Client{} = client,
name,
namespace,
table_bucket_arn,
options \\ []
) do
url_path =
"/tables/#{AWS.Util.encode_uri(table_bucket_arn)}/#{AWS.Util.encode_uri(namespace)}/#{AWS.Util.encode_uri(name)}/maintenance-job-status"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Gets the location of the table metadata.
"""
@spec get_table_metadata_location(map(), String.t(), String.t(), String.t(), list()) ::
{:ok, get_table_metadata_location_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, get_table_metadata_location_errors()}
def get_table_metadata_location(
%Client{} = client,
name,
namespace,
table_bucket_arn,
options \\ []
) do
url_path =
"/tables/#{AWS.Util.encode_uri(table_bucket_arn)}/#{AWS.Util.encode_uri(namespace)}/#{AWS.Util.encode_uri(name)}/metadata-location"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Gets details about a table policy.
"""
@spec get_table_policy(map(), String.t(), String.t(), String.t(), list()) ::
{:ok, get_table_policy_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, get_table_policy_errors()}
def get_table_policy(%Client{} = client, name, namespace, table_bucket_arn, options \\ []) do
url_path =
"/tables/#{AWS.Util.encode_uri(table_bucket_arn)}/#{AWS.Util.encode_uri(namespace)}/#{AWS.Util.encode_uri(name)}/policy"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Lists the namespaces within a table bucket.
"""
@spec list_namespaces(
map(),
String.t(),
String.t() | nil,
String.t() | nil,
String.t() | nil,
list()
) ::
{:ok, list_namespaces_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, list_namespaces_errors()}
def list_namespaces(
%Client{} = client,
table_bucket_arn,
continuation_token \\ nil,
max_namespaces \\ nil,
prefix \\ nil,
options \\ []
) do
url_path = "/namespaces/#{AWS.Util.encode_uri(table_bucket_arn)}"
headers = []
query_params = []
query_params =
if !is_nil(prefix) do
[{"prefix", prefix} | query_params]
else
query_params
end
query_params =
if !is_nil(max_namespaces) do
[{"maxNamespaces", max_namespaces} | query_params]
else
query_params
end
query_params =
if !is_nil(continuation_token) do
[{"continuationToken", continuation_token} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Lists table buckets for your account.
"""
@spec list_table_buckets(map(), String.t() | nil, String.t() | nil, String.t() | nil, list()) ::
{:ok, list_table_buckets_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, list_table_buckets_errors()}
def list_table_buckets(
%Client{} = client,
continuation_token \\ nil,
max_buckets \\ nil,
prefix \\ nil,
options \\ []
) do
url_path = "/buckets"
headers = []
query_params = []
query_params =
if !is_nil(prefix) do
[{"prefix", prefix} | query_params]
else
query_params
end
query_params =
if !is_nil(max_buckets) do
[{"maxBuckets", max_buckets} | query_params]
else
query_params
end
query_params =
if !is_nil(continuation_token) do
[{"continuationToken", continuation_token} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
List tables in the given table bucket.
"""
@spec list_tables(
map(),
String.t(),
String.t() | nil,
String.t() | nil,
String.t() | nil,
String.t() | nil,
list()
) ::
{:ok, list_tables_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, list_tables_errors()}
def list_tables(
%Client{} = client,
table_bucket_arn,
continuation_token \\ nil,
max_tables \\ nil,
namespace \\ nil,
prefix \\ nil,
options \\ []
) do
url_path = "/tables/#{AWS.Util.encode_uri(table_bucket_arn)}"
headers = []
query_params = []
query_params =
if !is_nil(prefix) do
[{"prefix", prefix} | query_params]
else
query_params
end
query_params =
if !is_nil(namespace) do
[{"namespace", namespace} | query_params]
else
query_params
end
query_params =
if !is_nil(max_tables) do
[{"maxTables", max_tables} | query_params]
else
query_params
end
query_params =
if !is_nil(continuation_token) do
[{"continuationToken", continuation_token} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Creates a new maintenance configuration or replaces an existing maintenance
configuration
for a table bucket.
"""
@spec put_table_bucket_maintenance_configuration(
map(),
String.t(),
String.t(),
put_table_bucket_maintenance_configuration_request(),
list()
) ::
{:ok, nil, any()}
| {:error, {:unexpected_response, any()}}
| {:error, put_table_bucket_maintenance_configuration_errors()}
def put_table_bucket_maintenance_configuration(
%Client{} = client,
table_bucket_arn,
type,
input,
options \\ []
) do
url_path =
"/buckets/#{AWS.Util.encode_uri(table_bucket_arn)}/maintenance/#{AWS.Util.encode_uri(type)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
204
)
end
@doc """
Creates a new maintenance configuration or replaces an existing table bucket
policy for a
table bucket.
"""
@spec put_table_bucket_policy(map(), String.t(), put_table_bucket_policy_request(), list()) ::
{:ok, nil, any()}
| {:error, {:unexpected_response, any()}}
| {:error, put_table_bucket_policy_errors()}
def put_table_bucket_policy(%Client{} = client, table_bucket_arn, input, options \\ []) do
url_path = "/buckets/#{AWS.Util.encode_uri(table_bucket_arn)}/policy"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Creates a new maintenance configuration or replaces an existing maintenance
configuration
for a table.
"""
@spec put_table_maintenance_configuration(
map(),
String.t(),
String.t(),
String.t(),
String.t(),
put_table_maintenance_configuration_request(),
list()
) ::
{:ok, nil, any()}
| {:error, {:unexpected_response, any()}}
| {:error, put_table_maintenance_configuration_errors()}
def put_table_maintenance_configuration(
%Client{} = client,
name,
namespace,
table_bucket_arn,
type,
input,
options \\ []
) do
url_path =
"/tables/#{AWS.Util.encode_uri(table_bucket_arn)}/#{AWS.Util.encode_uri(namespace)}/#{AWS.Util.encode_uri(name)}/maintenance/#{AWS.Util.encode_uri(type)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
204
)
end
@doc """
Creates a new maintenance configuration or replaces an existing table policy for
a table.
"""
@spec put_table_policy(
map(),
String.t(),
String.t(),
String.t(),
put_table_policy_request(),
list()
) ::
{:ok, nil, any()}
| {:error, {:unexpected_response, any()}}
| {:error, put_table_policy_errors()}
def put_table_policy(
%Client{} = client,
name,
namespace,
table_bucket_arn,
input,
options \\ []
) do
url_path =
"/tables/#{AWS.Util.encode_uri(table_bucket_arn)}/#{AWS.Util.encode_uri(namespace)}/#{AWS.Util.encode_uri(name)}/policy"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Renames a table or a namespace.
"""
@spec rename_table(map(), String.t(), String.t(), String.t(), rename_table_request(), list()) ::
{:ok, nil, any()}
| {:error, {:unexpected_response, any()}}
| {:error, rename_table_errors()}
def rename_table(%Client{} = client, name, namespace, table_bucket_arn, input, options \\ []) do
url_path =
"/tables/#{AWS.Util.encode_uri(table_bucket_arn)}/#{AWS.Util.encode_uri(namespace)}/#{AWS.Util.encode_uri(name)}/rename"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
204
)
end
@doc """
Updates the metadata location for a table.
"""
@spec update_table_metadata_location(
map(),
String.t(),
String.t(),
String.t(),
update_table_metadata_location_request(),
list()
) ::
{:ok, update_table_metadata_location_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, update_table_metadata_location_errors()}
def update_table_metadata_location(
%Client{} = client,
name,
namespace,
table_bucket_arn,
input,
options \\ []
) do
url_path =
"/tables/#{AWS.Util.encode_uri(table_bucket_arn)}/#{AWS.Util.encode_uri(namespace)}/#{AWS.Util.encode_uri(name)}/metadata-location"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
end
