Skip to content

get_table

get_table(
    *,
    config_overrides: Optional[S3TablesClientConfig] = None,
    table_bucket_arn: Optional[TableBucketARN] = None,
    namespace: Optional[NamespaceName] = None,
    name: Optional[TableName] = None,
    table_arn: Optional[TableARN] = None,
) -> GetTableResponse

Gets details about a table. For more information, see S3 Tables in the Amazon Simple Storage Service User Guide.

Permissions

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

Parameters:

  • table_bucket_arn (Optional[TableBucketARN], default: None ) –

    The Amazon Resource Name (ARN) of the table bucket associated with the table.

  • namespace (Optional[NamespaceName], default: None ) –

    The name of the namespace the table is associated with.

  • name (Optional[TableName], default: None ) –

    The name of the table.

  • table_arn (Optional[TableARN], default: None ) –

    The Amazon Resource Name (ARN) of the table.

Raises:

Source code in docs_src/capo_s3tables/_services/s3_tables.py
def get_table(
    self,
    *,
    config_overrides: Optional[S3TablesClientConfig] = None,
    table_bucket_arn: Optional[
        "capo_s3tables.types.table_bucket_arn.TableBucketARN"
    ] = None,
    namespace: Optional["capo_s3tables.types.namespace_name.NamespaceName"] = None,
    name: Optional["capo_s3tables.types.table_name.TableName"] = None,
    table_arn: Optional["capo_s3tables.types.table_arn.TableARN"] = None,
) -> "capo_s3tables.types.get_table_response.GetTableResponse":
    """<p>Gets details about a table. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-tables.html">S3 Tables</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p> <dl> <dt>Permissions</dt> <dd> <p>You must have the <code>s3tables:GetTable</code> permission to use this operation. </p> </dd> </dl>

    Args:
        table_bucket_arn: <p>The Amazon Resource Name (ARN) of the table bucket associated with the table.</p>
        namespace: <p>The name of the namespace the table is associated with.</p>
        name: <p>The name of the table.</p>
        table_arn: <p>The Amazon Resource Name (ARN) of the table.</p>

    Raises:
        capo_s3tables.errors.access_denied_exception.AccessDeniedException: <p>The action cannot be performed because you do not have the required permission.</p>
        capo_s3tables.errors.bad_request_exception.BadRequestException: <p>The request is invalid or malformed.</p>
        capo_s3tables.errors.conflict_exception.ConflictException: <p>The request failed because there is a conflict with a previous write. You can retry the request.</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.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_request.GetTableRequest]",
    ) -> OperationResponse[
        "capo_s3tables.types.get_table_response.GetTableResponse"
    ]:
        import capo_s3tables._operations.s3_table_buckets.get_table

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetTable")
    )
    input_: capo_s3tables.types.get_table_request.GetTableRequest = {}
    if table_bucket_arn is not None:
        input_["table_bucket_arn"] = table_bucket_arn
    if namespace is not None:
        input_["namespace"] = namespace
    if name is not None:
        input_["name"] = name
    if table_arn is not None:
        input_["table_arn"] = table_arn

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