AWS Glue

Searches for assets in Glue Data Catalog using full-text search, filters, sorting, and aggregations. Returns matching assets with relevance-ranked results.

See also: AWS API Documentation

Request Syntax

client.search_assets(
    SearchText='string',
    MaxResults=123,
    NextToken='string',
    Sort={
        'Attribute': 'string',
        'Order': 'ASCENDING'|'DESCENDING'
    },
    FilterClause={
        'AndAllFilters': [
            {'... recursive ...'},
        ],
        'OrAnyFilters': [
            {'... recursive ...'},
        ],
        'AttributeFilter': {
            'Attribute': 'string',
            'Operator': 'equals'|'greaterThan'|'greaterThanOrEquals'|'lessThan'|'lessThanOrEquals'|'notExists',
            'Value': {
                'StringValue': 'string',
                'LongValue': 123
            }
        },
        'MapFilter': {
            'Attribute': 'string',
            'Key': 'string',
            'Value': {
                'StringValue': 'string'
            }
        }
    }
)

type SearchText:

string

param SearchText:

The text to search for. At least one of searchText or filterClause must be provided.

type MaxResults:

integer

param MaxResults:

The maximum number of results to return in the response.

type NextToken:

string

param NextToken:

A continuation token, if this is a continuation call.

type Sort:

dict

param Sort:

The sort criteria for the search results.

• Attribute (string) -- [REQUIRED]

  The attribute to sort by.

• Order (string) --

  The sort order. Valid values are ASCENDING and DESCENDING.

type FilterClause:

dict

param FilterClause:

The filter clause to apply to the search. Supports nested AND/OR logic with attribute-level and map-level filters.

• AndAllFilters (list) --

  A list of filter clauses that must all match (logical AND).

  • (dict) --

    A filter clause that supports nested boolean logic. Exactly one of andAllFilters, orAnyFilters, attributeFilter, or mapFilter must be specified.

• OrAnyFilters (list) --

  A list of filter clauses where at least one must match (logical OR).

  • (dict) --

    A filter clause that supports nested boolean logic. Exactly one of andAllFilters, orAnyFilters, attributeFilter, or mapFilter must be specified.

• AttributeFilter (dict) --

  A filter on a single attribute value.

  • Attribute (string) -- [REQUIRED]

    The attribute name to filter on.

  • Operator (string) -- [REQUIRED]

    The comparison operator. Valid values are equals, greaterThan, greaterThanOrEquals, lessThan, lessThanOrEquals, and notExists.

  • Value (dict) --

    The value to compare against.

    • StringValue (string) --

      A string filter value.

    • LongValue (integer) --

      A long integer filter value.

• MapFilter (dict) --

  A filter on a map attribute's key-value pair.

  • Attribute (string) -- [REQUIRED]

    The map attribute name to filter on.

  • Key (string) -- [REQUIRED]

    The key within the map attribute to filter on.

  • Value (dict) -- [REQUIRED]

    The value to compare against.

    • StringValue (string) --

      A string filter value.

rtype:

dict

returns:

Response Syntax

{
    'Items': [
        {
            'Id': 'string',
            'AssetName': 'string',
            'AssetDescription': 'string',
            'UpdatedAt': datetime(2015, 1, 1),
            'AssetTypeId': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • Items (list) --

    The list of assets matching the search criteria.

    • (dict) --

      A single search result item representing a matched asset.

      • Id (string) --

        The unique identifier of the matched asset.

      • AssetName (string) --

        The name of the matched asset.

      • AssetDescription (string) --

        The description of the matched asset.

      • UpdatedAt (datetime) --

        The timestamp at which the matched asset was last updated.

      • AssetTypeId (string) --

        The identifier of the asset type for the matched asset.

  • NextToken (string) --

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

{'AssetIdentifier': 'string'}

Associates one or more glossary terms with an asset in Glue Data Catalog.

See also: AWS API Documentation

Request Syntax

client.associate_glossary_terms(
    AssetIdentifier='string',
    GlossaryTermIdentifiers=[
        'string',
    ],
    ClientToken='string'
)

type AssetIdentifier:

string

param AssetIdentifier:

[REQUIRED]

The unique identifier of the asset to associate glossary terms with.

type GlossaryTermIdentifiers:

list

param GlossaryTermIdentifiers:

[REQUIRED]

The list of glossary term identifiers to associate with the asset.

• (string) --

type ClientToken:

string

param ClientToken:

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

This field is autopopulated if not provided.

rtype:

dict

returns:

Response Syntax

{
    'AssetIdentifier': 'string',
    'GlossaryTerms': [
        'string',
    ]
}

Response Structure

• (dict) --

  • AssetIdentifier (string) --

    The unique identifier of the asset.

  • GlossaryTerms (list) --

    The glossary terms now associated with the asset.

    • (string) --

{'AssetIdentifier': 'string',
 'ItemIdentifier': 'string',
 'IterableFormName': 'string'}

{'AssetIdentifier': 'string'}

Deletes a form attachment from an asset in Glue Data Catalog.

See also: AWS API Documentation

Request Syntax

client.delete_attachment(
    AssetIdentifier='string',
    IterableFormName='string',
    ItemIdentifier='string',
    AttachmentName='string'
)

type AssetIdentifier:

string

param AssetIdentifier:

[REQUIRED]

The unique identifier of the asset from which to delete the attachment.

type IterableFormName:

string

param IterableFormName:

The name of the iterable form. When specified along with itemIdentifier, the attachment is deleted from an item within the iterable form rather than from the asset itself.

type ItemIdentifier:

string

param ItemIdentifier:

The identifier of the item within the iterable form. Required when iterableFormName is specified.

type AttachmentName:

string

param AttachmentName:

[REQUIRED]

The name of the attachment to delete.

rtype:

dict

returns:

Response Syntax

{
    'AssetIdentifier': 'string'
}

Response Structure

• (dict) --

  • AssetIdentifier (string) --

    The unique identifier of the asset.

{'AssetIdentifier': 'string'}

Removes the association of one or more glossary terms from an asset in Glue Data Catalog.

See also: AWS API Documentation

Request Syntax

client.disassociate_glossary_terms(
    AssetIdentifier='string',
    GlossaryTermIdentifiers=[
        'string',
    ],
    ClientToken='string'
)

type AssetIdentifier:

string

param AssetIdentifier:

[REQUIRED]

The unique identifier of the asset to disassociate glossary terms from.

type GlossaryTermIdentifiers:

list

param GlossaryTermIdentifiers:

[REQUIRED]

The list of glossary term identifiers to disassociate from the asset.

• (string) --

type ClientToken:

string

param ClientToken:

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

This field is autopopulated if not provided.

rtype:

dict

returns:

Response Syntax

{
    'AssetIdentifier': 'string',
    'GlossaryTerms': [
        'string',
    ]
}

Response Structure

• (dict) --

  • AssetIdentifier (string) --

    The unique identifier of the asset.

  • GlossaryTerms (list) --

    The remaining glossary terms associated with the asset.

    • (string) --

{'AssetIdentifier': 'string'}

Attaches a form to an asset or an iterable form item in Glue Data Catalog. If an attachment with the same name already exists, it is overwritten.

See also: AWS API Documentation

Request Syntax

client.put_attachment(
    AssetIdentifier='string',
    IterableFormName='string',
    ItemIdentifier='string',
    AttachmentName='string',
    Content='string',
    FormTypeId='string',
    ClientToken='string'
)

type AssetIdentifier:

string

param AssetIdentifier:

[REQUIRED]

The unique identifier of the asset to attach the form to.

type IterableFormName:

string

param IterableFormName:

The name of the iterable form. When specified along with itemIdentifier, the attachment targets an item within the iterable form rather than the asset itself.

type ItemIdentifier:

string

param ItemIdentifier:

The identifier of the item within the iterable form. Required when iterableFormName is specified.

type AttachmentName:

string

param AttachmentName:

[REQUIRED]

The name of the attachment.

type Content:

string

param Content:

[REQUIRED]

The JSON content of the form, conforming to the schema of the specified form type.

type FormTypeId:

string

param FormTypeId:

[REQUIRED]

The identifier of the form type for this attachment.

type ClientToken:

string

param ClientToken:

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

This field is autopopulated if not provided.

rtype:

dict

returns:

Response Syntax

{
    'AssetIdentifier': 'string',
    'IterableFormName': 'string',
    'ItemIdentifier': 'string',
    'AttachmentName': 'string',
    'FormTypeId': 'string'
}

Response Structure

• (dict) --

  • AssetIdentifier (string) --

    The unique identifier of the asset.

  • IterableFormName (string) --

    The name of the iterable form, if the attachment targets an item.

  • ItemIdentifier (string) --

    The identifier of the item within the iterable form, if applicable.

  • AttachmentName (string) --

    The name of the attachment.

  • FormTypeId (string) --

    The identifier of the form type for this attachment.