Amazonka.Glue.SearchTables

Searches a set of tables based on properties in the table metadata as well as on the parent database. You can search against text or filter conditions.

You can only get tables that you have access to based on the security policies defined in Lake Formation. You need at least a read-only access to the table for it to be returned. If you do not have access to all the columns in the table, these columns will not be searched against when returning the list of tables back to you. If you have access to the columns but not the data in the columns, those columns and the associated metadata for those columns will be included in the search.

Creating a Request

data SearchTables

See: newSearchTables smart constructor.

Constructors

SearchTables'

Fields

• catalogId :: Maybe Text

  A unique identifier, consisting of account_id .

• filters :: Maybe [PropertyPredicate]

  A list of key-value pairs, and a comparator used to filter the search results. Returns all entities matching the predicate.

  The Comparator member of the PropertyPredicate struct is used only for time fields, and can be omitted for other field types. Also, when comparing string values, such as when Key=Name, a fuzzy match algorithm is used. The Key field (for example, the value of the Name field) is split on certain punctuation characters, for example, -, :, #, etc. into tokens. Then each token is exact-match compared with the Value member of PropertyPredicate. For example, if Key=Name and Value=link, tables named customer-link and xx-link-yy are returned, but xxlinkyy is not 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.

• resourceShareType :: Maybe ResourceShareType

  Allows you to specify that you want to search the tables shared with your account. The allowable values are FOREIGN or ALL.

  • If set to FOREIGN, will search the tables shared with your account.
  • If set to ALL, will search the tables shared with your account, as well as the tables in yor local account.
• searchText :: Maybe Text

  A string used for a text search.

  Specifying a value in quotes filters based on an exact match to the value.

• sortCriteria :: Maybe [SortCriterion]

  A list of criteria for sorting the results by a field name, in an ascending or descending order.

Instances

ToJSON SearchTables

Defined in Amazonka.Glue.SearchTables

Methods

toJSON :: SearchTables -> Value

toEncoding :: SearchTables -> Encoding

toJSONList :: [SearchTables] -> Value

toEncodingList :: [SearchTables] -> Encoding

ToHeaders SearchTables

Defined in Amazonka.Glue.SearchTables

Methods

toHeaders :: SearchTables -> [Header]

ToPath SearchTables

Defined in Amazonka.Glue.SearchTables

Methods

toPath :: SearchTables -> ByteString

ToQuery SearchTables

Defined in Amazonka.Glue.SearchTables

Methods

toQuery :: SearchTables -> QueryString

AWSRequest SearchTables

Defined in Amazonka.Glue.SearchTables

Associated Types

type AWSResponse SearchTables

Methods

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

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

Generic SearchTables

Defined in Amazonka.Glue.SearchTables

Associated Types

type Rep SearchTables :: Type -> Type

Methods

from :: SearchTables -> Rep SearchTables x

to :: Rep SearchTables x -> SearchTables

Read SearchTables

Defined in Amazonka.Glue.SearchTables

Methods

readsPrec :: Int -> ReadS SearchTables

readList :: ReadS [SearchTables]

readPrec :: ReadPrec SearchTables

readListPrec :: ReadPrec [SearchTables]

Show SearchTables

Defined in Amazonka.Glue.SearchTables

Methods

showsPrec :: Int -> SearchTables -> ShowS

show :: SearchTables -> String

showList :: [SearchTables] -> ShowS

NFData SearchTables

Defined in Amazonka.Glue.SearchTables

Methods

rnf :: SearchTables -> ()

Eq SearchTables

Defined in Amazonka.Glue.SearchTables

Methods

(==) :: SearchTables -> SearchTables -> Bool

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

Hashable SearchTables

Defined in Amazonka.Glue.SearchTables

Methods

hashWithSalt :: Int -> SearchTables -> Int

hash :: SearchTables -> Int

type AWSResponse SearchTables

Defined in Amazonka.Glue.SearchTables

type AWSResponse SearchTables = SearchTablesResponse

type Rep SearchTables

Defined in Amazonka.Glue.SearchTables

type Rep SearchTables = D1 ('MetaData "SearchTables" "Amazonka.Glue.SearchTables" "amazonka-glue-2.0-7miPWwBHdfn8N8SvbpLgE0" 'False) (C1 ('MetaCons "SearchTables'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "catalogId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PropertyPredicate])) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))) :*: ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "resourceShareType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ResourceShareType))) :*: (S1 ('MetaSel ('Just "searchText") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "sortCriteria") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SortCriterion]))))))

newSearchTables :: SearchTables

Create a value of SearchTables 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:

SearchTables, searchTables_catalogId - A unique identifier, consisting of account_id .

SearchTables, searchTables_filters - A list of key-value pairs, and a comparator used to filter the search results. Returns all entities matching the predicate.

The Comparator member of the PropertyPredicate struct is used only for time fields, and can be omitted for other field types. Also, when comparing string values, such as when Key=Name, a fuzzy match algorithm is used. The Key field (for example, the value of the Name field) is split on certain punctuation characters, for example, -, :, #, etc. into tokens. Then each token is exact-match compared with the Value member of PropertyPredicate. For example, if Key=Name and Value=link, tables named customer-link and xx-link-yy are returned, but xxlinkyy is not returned.

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

SearchTables, searchTables_nextToken - A continuation token, included if this is a continuation call.

$sel:resourceShareType:SearchTables', searchTables_resourceShareType - Allows you to specify that you want to search the tables shared with your account. The allowable values are FOREIGN or ALL.

• If set to FOREIGN, will search the tables shared with your account.
• If set to ALL, will search the tables shared with your account, as well as the tables in yor local account.

$sel:searchText:SearchTables', searchTables_searchText - A string used for a text search.

Specifying a value in quotes filters based on an exact match to the value.

$sel:sortCriteria:SearchTables', searchTables_sortCriteria - A list of criteria for sorting the results by a field name, in an ascending or descending order.

Request Lenses

searchTables_catalogId :: Lens' SearchTables (Maybe Text)

A unique identifier, consisting of account_id .

searchTables_filters :: Lens' SearchTables (Maybe [PropertyPredicate])

A list of key-value pairs, and a comparator used to filter the search results. Returns all entities matching the predicate.

The Comparator member of the PropertyPredicate struct is used only for time fields, and can be omitted for other field types. Also, when comparing string values, such as when Key=Name, a fuzzy match algorithm is used. The Key field (for example, the value of the Name field) is split on certain punctuation characters, for example, -, :, #, etc. into tokens. Then each token is exact-match compared with the Value member of PropertyPredicate. For example, if Key=Name and Value=link, tables named customer-link and xx-link-yy are returned, but xxlinkyy is not returned.

searchTables_maxResults :: Lens' SearchTables (Maybe Natural)

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

searchTables_nextToken :: Lens' SearchTables (Maybe Text)

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

searchTables_resourceShareType :: Lens' SearchTables (Maybe ResourceShareType)

Allows you to specify that you want to search the tables shared with your account. The allowable values are FOREIGN or ALL.

• If set to FOREIGN, will search the tables shared with your account.
• If set to ALL, will search the tables shared with your account, as well as the tables in yor local account.

searchTables_searchText :: Lens' SearchTables (Maybe Text)

A string used for a text search.

Specifying a value in quotes filters based on an exact match to the value.

searchTables_sortCriteria :: Lens' SearchTables (Maybe [SortCriterion])

A list of criteria for sorting the results by a field name, in an ascending or descending order.

Destructuring the Response

data SearchTablesResponse

See: newSearchTablesResponse smart constructor.

Constructors

SearchTablesResponse'

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. The SearchTables response returns only the tables that you have access to.

• httpStatus :: Int

  The response's http status code.

Instances

Generic SearchTablesResponse

Defined in Amazonka.Glue.SearchTables

Associated Types

type Rep SearchTablesResponse :: Type -> Type

Methods

from :: SearchTablesResponse -> Rep SearchTablesResponse x

to :: Rep SearchTablesResponse x -> SearchTablesResponse

Read SearchTablesResponse

Defined in Amazonka.Glue.SearchTables

Methods

readsPrec :: Int -> ReadS SearchTablesResponse

readList :: ReadS [SearchTablesResponse]

readPrec :: ReadPrec SearchTablesResponse

readListPrec :: ReadPrec [SearchTablesResponse]

Show SearchTablesResponse

Defined in Amazonka.Glue.SearchTables

Methods

showsPrec :: Int -> SearchTablesResponse -> ShowS

show :: SearchTablesResponse -> String

showList :: [SearchTablesResponse] -> ShowS

NFData SearchTablesResponse

Defined in Amazonka.Glue.SearchTables

Methods

rnf :: SearchTablesResponse -> ()

Eq SearchTablesResponse

Defined in Amazonka.Glue.SearchTables

Methods

(==) :: SearchTablesResponse -> SearchTablesResponse -> Bool

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

type Rep SearchTablesResponse

Defined in Amazonka.Glue.SearchTables

type Rep SearchTablesResponse = D1 ('MetaData "SearchTablesResponse" "Amazonka.Glue.SearchTables" "amazonka-glue-2.0-7miPWwBHdfn8N8SvbpLgE0" 'False) (C1 ('MetaCons "SearchTablesResponse'" '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))))

newSearchTablesResponse

Arguments

:: Int

$sel:httpStatus:SearchTablesResponse'

-> SearchTablesResponse

Create a value of SearchTablesResponse 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:

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

$sel:tableList:SearchTablesResponse', searchTablesResponse_tableList - A list of the requested Table objects. The SearchTables response returns only the tables that you have access to.

$sel:httpStatus:SearchTablesResponse', searchTablesResponse_httpStatus - The response's http status code.

Response Lenses

searchTablesResponse_nextToken :: Lens' SearchTablesResponse (Maybe Text)

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

searchTablesResponse_tableList :: Lens' SearchTablesResponse (Maybe [Table])

A list of the requested Table objects. The SearchTables response returns only the tables that you have access to.

searchTablesResponse_httpStatus :: Lens' SearchTablesResponse Int

The response's http status code.