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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-athena/types.rb

Overview

Note:

When making an API call, you may pass ListTableMetadataInput data as a hash:

{
  catalog_name: "CatalogNameString", # required
  database_name: "NameString", # required
  expression: "ExpressionString",
  next_token: "Token",
  max_results: 1,
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#catalog_nameString

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

Returns:

  • (String)

1424
1425
1426
1427
1428
1429
1430
1431
1432
# File 'lib/aws-sdk-athena/types.rb', line 1424

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

#database_nameString

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

Returns:

  • (String)

1424
1425
1426
1427
1428
1429
1430
1431
1432
# File 'lib/aws-sdk-athena/types.rb', line 1424

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

#expressionString

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

Returns:

  • (String)

1424
1425
1426
1427
1428
1429
1430
1431
1432
# File 'lib/aws-sdk-athena/types.rb', line 1424

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

#max_resultsInteger

Specifies the maximum number of results to return.

Returns:

  • (Integer)

1424
1425
1426
1427
1428
1429
1430
1431
1432
# File 'lib/aws-sdk-athena/types.rb', line 1424

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

#next_tokenString

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)

1424
1425
1426
1427
1428
1429
1430
1431
1432
# File 'lib/aws-sdk-athena/types.rb', line 1424

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