Amazonka.Glue.GetTables

Retrieves the definitions of some or all of the tables in a given Database.

This operation returns paginated results.

Creating a Request

data GetTables

See: newGetTables smart constructor.

Constructors

GetTables'

Fields

• catalogId :: Maybe Text

  The ID of the Data Catalog where the tables reside. If none is provided, the Amazon Web Services account ID is used by default.

• expression :: Maybe Text

  A regular expression pattern. If present, only those tables whose names match the pattern are returned.

• maxResults :: Maybe Natural

  The maximum number of tables to return in a single response.

• nextToken :: Maybe Text

  A continuation token, included if this is a continuation call.

• queryAsOfTime :: Maybe POSIX

  The time as of when to read the table contents. If not set, the most recent transaction commit time will be used. Cannot be specified along with TransactionId.

• transactionId :: Maybe Text

  The transaction ID at which to read the table contents.

• databaseName :: Text

  The database in the catalog whose tables to list. For Hive compatibility, this name is entirely lowercase.

Instances

ToJSON GetTables

Defined in Amazonka.Glue.GetTables

Methods

toJSON :: GetTables -> Value

toEncoding :: GetTables -> Encoding

toJSONList :: [GetTables] -> Value

toEncodingList :: [GetTables] -> Encoding

ToHeaders GetTables

Defined in Amazonka.Glue.GetTables

Methods

toHeaders :: GetTables -> [Header]

ToPath GetTables

Defined in Amazonka.Glue.GetTables

Methods

toPath :: GetTables -> ByteString

ToQuery GetTables

Defined in Amazonka.Glue.GetTables

Methods

toQuery :: GetTables -> QueryString

AWSPager GetTables

Defined in Amazonka.Glue.GetTables

Methods

page :: GetTables -> AWSResponse GetTables -> Maybe GetTables

AWSRequest GetTables

Defined in Amazonka.Glue.GetTables

Associated Types

type AWSResponse GetTables

Methods

request :: (Service -> Service) -> GetTables -> Request GetTables

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetTables -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetTables)))

Generic GetTables

Defined in Amazonka.Glue.GetTables

Associated Types

type Rep GetTables :: Type -> Type

Methods

from :: GetTables -> Rep GetTables x

to :: Rep GetTables x -> GetTables

Read GetTables

Defined in Amazonka.Glue.GetTables

Methods

readsPrec :: Int -> ReadS GetTables

readList :: ReadS [GetTables]

readPrec :: ReadPrec GetTables

readListPrec :: ReadPrec [GetTables]

Show GetTables

Defined in Amazonka.Glue.GetTables

Methods

showsPrec :: Int -> GetTables -> ShowS

show :: GetTables -> String

showList :: [GetTables] -> ShowS

NFData GetTables

Defined in Amazonka.Glue.GetTables

Methods

rnf :: GetTables -> ()

Eq GetTables

Defined in Amazonka.Glue.GetTables

Methods

(==) :: GetTables -> GetTables -> Bool

(/=) :: GetTables -> GetTables -> Bool

Hashable GetTables

Defined in Amazonka.Glue.GetTables

Methods

hashWithSalt :: Int -> GetTables -> Int

hash :: GetTables -> Int

type AWSResponse GetTables

Defined in Amazonka.Glue.GetTables

type AWSResponse GetTables = GetTablesResponse

type Rep GetTables

Defined in Amazonka.Glue.GetTables

type Rep GetTables = D1 ('MetaData "GetTables" "Amazonka.Glue.GetTables" "amazonka-glue-2.0-7miPWwBHdfn8N8SvbpLgE0" 'False) (C1 ('MetaCons "GetTables'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "catalogId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "expression") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))) :*: ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "queryAsOfTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :*: (S1 ('MetaSel ('Just "transactionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "databaseName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newGetTables

Arguments

:: Text

GetTables

-> GetTables

Create a value of GetTables with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

GetTables, getTables_catalogId - The ID of the Data Catalog where the tables reside. If none is provided, the Amazon Web Services account ID is used by default.

$sel:expression:GetTables', getTables_expression - A regular expression pattern. If present, only those tables whose names match the pattern are returned.

$sel:maxResults:GetTables', getTables_maxResults - The maximum number of tables to return in a single response.

GetTables, getTables_nextToken - A continuation token, included if this is a continuation call.

$sel:queryAsOfTime:GetTables', getTables_queryAsOfTime - The time as of when to read the table contents. If not set, the most recent transaction commit time will be used. Cannot be specified along with TransactionId.

$sel:transactionId:GetTables', getTables_transactionId - The transaction ID at which to read the table contents.

GetTables, getTables_databaseName - The database in the catalog whose tables to list. For Hive compatibility, this name is entirely lowercase.

Request Lenses

getTables_catalogId :: Lens' GetTables (Maybe Text)

The ID of the Data Catalog where the tables reside. If none is provided, the Amazon Web Services account ID is used by default.

getTables_expression :: Lens' GetTables (Maybe Text)

A regular expression pattern. If present, only those tables whose names match the pattern are returned.

getTables_maxResults :: Lens' GetTables (Maybe Natural)

The maximum number of tables to return in a single response.

getTables_nextToken :: Lens' GetTables (Maybe Text)

A continuation token, included if this is a continuation call.

getTables_queryAsOfTime :: Lens' GetTables (Maybe UTCTime)

The time as of when to read the table contents. If not set, the most recent transaction commit time will be used. Cannot be specified along with TransactionId.

getTables_transactionId :: Lens' GetTables (Maybe Text)

The transaction ID at which to read the table contents.

getTables_databaseName :: Lens' GetTables Text

The database in the catalog whose tables to list. For Hive compatibility, this name is entirely lowercase.

Destructuring the Response

data GetTablesResponse

See: newGetTablesResponse smart constructor.

Constructors

GetTablesResponse'

Fields

• nextToken :: Maybe Text

  A continuation token, present if the current list segment is not the last.

• tableList :: Maybe [Table]

  A list of the requested Table objects.

• httpStatus :: Int

  The response's http status code.

Instances

Generic GetTablesResponse

Defined in Amazonka.Glue.GetTables

Associated Types

type Rep GetTablesResponse :: Type -> Type

Methods

from :: GetTablesResponse -> Rep GetTablesResponse x

to :: Rep GetTablesResponse x -> GetTablesResponse

Read GetTablesResponse

Defined in Amazonka.Glue.GetTables

Methods

readsPrec :: Int -> ReadS GetTablesResponse

readList :: ReadS [GetTablesResponse]

readPrec :: ReadPrec GetTablesResponse

readListPrec :: ReadPrec [GetTablesResponse]

Show GetTablesResponse

Defined in Amazonka.Glue.GetTables

Methods

showsPrec :: Int -> GetTablesResponse -> ShowS

show :: GetTablesResponse -> String

showList :: [GetTablesResponse] -> ShowS

NFData GetTablesResponse

Defined in Amazonka.Glue.GetTables

Methods

rnf :: GetTablesResponse -> ()

Eq GetTablesResponse

Defined in Amazonka.Glue.GetTables

Methods

(==) :: GetTablesResponse -> GetTablesResponse -> Bool

(/=) :: GetTablesResponse -> GetTablesResponse -> Bool

type Rep GetTablesResponse

Defined in Amazonka.Glue.GetTables

type Rep GetTablesResponse = D1 ('MetaData "GetTablesResponse" "Amazonka.Glue.GetTables" "amazonka-glue-2.0-7miPWwBHdfn8N8SvbpLgE0" 'False) (C1 ('MetaCons "GetTablesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "tableList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Table])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetTablesResponse

Arguments

:: Int

$sel:httpStatus:GetTablesResponse'

-> GetTablesResponse

Create a value of GetTablesResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

GetTables, getTablesResponse_nextToken - A continuation token, present if the current list segment is not the last.

$sel:tableList:GetTablesResponse', getTablesResponse_tableList - A list of the requested Table objects.

$sel:httpStatus:GetTablesResponse', getTablesResponse_httpStatus - The response's http status code.

Response Lenses

getTablesResponse_nextToken :: Lens' GetTablesResponse (Maybe Text)

A continuation token, present if the current list segment is not the last.

getTablesResponse_tableList :: Lens' GetTablesResponse (Maybe [Table])

A list of the requested Table objects.

getTablesResponse_httpStatus :: Lens' GetTablesResponse Int

The response's http status code.