Class: Aws::Athena::Types::ListTableMetadataInput

Inherits:

Struct

• Object
• Struct
• Aws::Athena::Types::ListTableMetadataInput

Defined in:

gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #catalog_name ⇒ String

  The name of the data catalog for which table metadata should be returned.

• #database_name ⇒ String

  The name of the database for which table metadata should be returned.

• #expression ⇒ String

  A regex filter that pattern-matches table names.

• #max_results ⇒ Integer

  Specifies the maximum number of results to return.

• #next_token ⇒ String

  A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated.

• #work_group ⇒ String

  The name of the workgroup for which the metadata is being fetched.

Instance Attribute Details

#catalog_name ⇒ String

The name of the data catalog for which table metadata should be returned.

Returns:

• (String)

# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 2719

class ListTableMetadataInput < Struct.new(
  :catalog_name,
  :database_name,
  :expression,
  :next_token,
  :max_results,
  :work_group)
  SENSITIVE = []
  include Aws::Structure
end

#database_name ⇒ String

The name of the database for which table metadata should be returned.

Returns:

• (String)

# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 2719

class ListTableMetadataInput < Struct.new(
  :catalog_name,
  :database_name,
  :expression,
  :next_token,
  :max_results,
  :work_group)
  SENSITIVE = []
  include Aws::Structure
end

#expression ⇒ String

A regex filter that pattern-matches table names. If no expression is supplied, metadata for all tables are listed.

Returns:

• (String)

# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 2719

class ListTableMetadataInput < Struct.new(
  :catalog_name,
  :database_name,
  :expression,
  :next_token,
  :max_results,
  :work_group)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ Integer

Specifies the maximum number of results to return.

Returns:

• (Integer)

# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 2719

class ListTableMetadataInput < Struct.new(
  :catalog_name,
  :database_name,
  :expression,
  :next_token,
  :max_results,
  :work_group)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.

Returns:

• (String)

# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 2719

class ListTableMetadataInput < Struct.new(
  :catalog_name,
  :database_name,
  :expression,
  :next_token,
  :max_results,
  :work_group)
  SENSITIVE = []
  include Aws::Structure
end

#work_group ⇒ String

The name of the workgroup for which the metadata is being fetched. Required if requesting an IAM Identity Center enabled Glue Data Catalog.

Returns:

• (String)

# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 2719

class ListTableMetadataInput < Struct.new(
  :catalog_name,
  :database_name,
  :expression,
  :next_token,
  :max_results,
  :work_group)
  SENSITIVE = []
  include Aws::Structure
end