2026/06/17 - AWS Glue - 28 new api methods
Changes This release adds support for Search and Discovery in AWS Glue, letting you and your applications search Data Catalog assets such as table and enrich them with business context and glossary terms.
Retrieves multiple items from an iterable form on an asset in Glue Data Catalog in a single request.
See also: AWS API Documentation
Request Syntax
client.batch_get_iterable_forms(
AssetIdentifier='string',
IterableFormName='string',
ItemIdentifiers=[
'string',
]
)
string
[REQUIRED]
The unique identifier of the asset.
string
[REQUIRED]
The name of the iterable form to retrieve items from.
list
[REQUIRED]
The list of item identifiers to retrieve. Each identifier can be an item ID or item name.
(string) --
dict
Response Syntax
{
'Items': [
{
'ItemId': 'string',
'ItemName': 'string',
'GlossaryTerms': [
'string',
],
'Forms': {
'string': {
'FormTypeId': 'string',
'Content': 'string'
}
},
'Attachments': {
'string': {
'FormTypeId': 'string',
'Content': 'string'
}
}
},
],
'Errors': [
{
'ItemIdentifier': 'string',
'Code': 'string',
'Message': 'string'
},
]
}
Response Structure
(dict) --
Items (list) --
The list of retrieved iterable form items.
(dict) --
A full iterable form item with its forms.
ItemId (string) --
The unique identifier of the item.
ItemName (string) --
The name of the item.
GlossaryTerms (list) --
The identifiers of the glossary terms associated with the item.
(string) --
Forms (dict) --
The forms on the item, keyed by form name.
(string) --
(dict) --
A form on an asset, consisting of the form type identifier and its JSON content.
FormTypeId (string) --
The identifier of the form type that defines this form's schema.
Content (string) --
The JSON content of the form, conforming to the schema of the specified form type.
Attachments (dict) --
Additional attachments on the item for more context, keyed by attachment name.
(string) --
(dict) --
A form on an asset, consisting of the form type identifier and its JSON content.
FormTypeId (string) --
The identifier of the form type that defines this form's schema.
Content (string) --
The JSON content of the form, conforming to the schema of the specified form type.
Errors (list) --
The list of errors for items that could not be retrieved.
(dict) --
An error that occurred when retrieving an iterable form item.
ItemIdentifier (string) --
The identifier of the item that caused the error.
Code (string) --
The error code.
Message (string) --
The error message.
Creates or updates an asset type in Glue Data Catalog. An asset type defines the structure of assets by specifying which forms they include. If an asset type with the given name already exists, it is updated.
See also: AWS API Documentation
Request Syntax
client.put_asset_type(
Name='string',
Forms={
'string': {
'FormTypeIdentifier': 'string'
}
},
ClientToken='string'
)
string
[REQUIRED]
The name of the asset type.
dict
[REQUIRED]
The forms that make up the asset type, keyed by form name. Each entry references the form type that defines the form's schema.
(string) --
(dict) --
A reference to a form type that is included in an asset type.
FormTypeIdentifier (string) -- [REQUIRED]
The identifier of the referenced form type.
string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
This field is autopopulated if not provided.
dict
Response Syntax
{
'Id': 'string',
'Name': 'string',
'Forms': {
'string': {
'FormTypeIdentifier': 'string'
}
}
}
Response Structure
(dict) --
Id (string) --
The identifier of the asset type.
Name (string) --
The name of the asset type.
Forms (dict) --
The forms that make up the asset type, keyed by form name.
(string) --
(dict) --
A reference to a form type that is included in an asset type.
FormTypeIdentifier (string) --
The identifier of the referenced form type.
Updates a business glossary in Glue Data Catalog.
See also: AWS API Documentation
Request Syntax
client.update_glossary(
Identifier='string',
Name='string',
Description='string',
ClientToken='string'
)
string
[REQUIRED]
The unique identifier of the glossary to update.
string
The updated name of the glossary.
string
The updated description of the glossary.
string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
This field is autopopulated if not provided.
dict
Response Syntax
{
'Id': 'string',
'Name': 'string',
'Description': 'string'
}
Response Structure
(dict) --
Id (string) --
The unique identifier of the glossary.
Name (string) --
The name of the glossary.
Description (string) --
The description of the glossary.
Creates a business glossary in Glue Data Catalog. A glossary is a container for glossary terms that define business concepts.
See also: AWS API Documentation
Request Syntax
client.create_glossary(
Name='string',
Description='string',
ClientToken='string'
)
string
[REQUIRED]
The name of the glossary.
string
The description of the glossary.
string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
This field is autopopulated if not provided.
dict
Response Syntax
{
'Id': 'string',
'Name': 'string',
'Description': 'string'
}
Response Structure
(dict) --
Id (string) --
The unique identifier of the glossary.
Name (string) --
The name of the glossary.
Description (string) --
The description of the glossary.
Deletes a glossary term from Glue Data Catalog.
See also: AWS API Documentation
Request Syntax
client.delete_glossary_term(
Identifier='string'
)
string
[REQUIRED]
The unique identifier of the glossary term to delete.
dict
Response Syntax
{}
Response Structure
(dict) --
Deletes a form attachment from an asset in Glue Data Catalog.
See also: AWS API Documentation
Request Syntax
client.delete_attachment(
Identifier='string',
AttachmentName='string'
)
string
[REQUIRED]
The unique identifier of the asset from which to delete the attachment.
string
[REQUIRED]
The name of the attachment to delete.
dict
Response Syntax
{
'Identifier': 'string'
}
Response Structure
(dict) --
Identifier (string) --
The unique identifier of the asset.
Deletes an asset from Glue Data Catalog.
See also: AWS API Documentation
Request Syntax
client.delete_asset(
Identifier='string'
)
string
[REQUIRED]
The unique identifier of the asset to delete.
dict
Response Syntax
{}
Response Structure
(dict) --
Retrieves a business glossary in Glue Data Catalog by its identifier.
See also: AWS API Documentation
Request Syntax
client.get_glossary(
Identifier='string'
)
string
[REQUIRED]
The unique identifier of the glossary to retrieve.
dict
Response Syntax
{
'Id': 'string',
'Name': 'string',
'Description': 'string'
}
Response Structure
(dict) --
Id (string) --
The unique identifier of the glossary.
Name (string) --
The name of the glossary.
Description (string) --
The description of the glossary.
Retrieves a form type in Glue Data Catalog by its identifier.
See also: AWS API Documentation
Request Syntax
client.get_form_type(
Identifier='string'
)
string
[REQUIRED]
The identifier of the form type to retrieve.
dict
Response Syntax
{
'Id': 'string',
'Name': 'string',
'Schema': 'string'
}
Response Structure
(dict) --
Id (string) --
The identifier of the form type.
Name (string) --
The name of the form type.
Schema (string) --
The Smithy IDL schema of the form type.
Deletes an asset type from Glue Data Catalog.
See also: AWS API Documentation
Request Syntax
client.delete_asset_type(
Identifier='string'
)
string
[REQUIRED]
The identifier of the asset type to delete.
dict
Response Syntax
{}
Response Structure
(dict) --
Lists the form types defined in Glue Data Catalog.
See also: AWS API Documentation
Request Syntax
client.list_form_types(
MaxResults=123,
NextToken='string'
)
integer
The maximum number of results to return in the response.
string
A continuation token, if this is a continuation call.
dict
Response Syntax
{
'Items': [
{
'Id': 'string',
'Name': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Items (list) --
The list of form type items.
(dict) --
A summary of a form type.
Id (string) --
The identifier of the form type.
Name (string) --
The name of the form type.
NextToken (string) --
A continuation token, present if the current segment is not the last.
Lists glossary terms within a business glossary in Glue Data Catalog.
See also: AWS API Documentation
Request Syntax
client.list_glossary_terms(
GlossaryIdentifier='string',
MaxResults=123,
NextToken='string'
)
string
[REQUIRED]
The unique identifier of the glossary whose terms to list.
integer
The maximum number of results to return in the response.
string
A continuation token, if this is a continuation call.
dict
Response Syntax
{
'Items': [
{
'Id': 'string',
'Name': 'string',
'ShortDescription': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Items (list) --
The list of glossary term items.
(dict) --
A summary of a glossary term.
Id (string) --
The unique identifier of the glossary term.
Name (string) --
The name of the glossary term.
ShortDescription (string) --
The short description of the glossary term.
NextToken (string) --
A continuation token, present if the current segment is not the last.
Lists the items in an iterable form on an asset in Glue Data Catalog. For example, lists the columns of a table asset.
See also: AWS API Documentation
Request Syntax
client.list_iterable_forms(
AssetIdentifier='string',
IterableFormName='string',
MaxResults=123,
NextToken='string'
)
string
[REQUIRED]
The unique identifier of the asset.
string
[REQUIRED]
The name of the iterable form to list items from.
integer
The maximum number of results to return in the response.
string
A continuation token, if this is a continuation call.
dict
Response Syntax
{
'Items': [
{
'ItemId': 'string',
'ItemName': 'string',
'Description': 'string',
'GlossaryTerms': [
'string',
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Items (list) --
The list of iterable form items.
(dict) --
A summary of an item in an iterable form.
ItemId (string) --
The unique identifier of the item.
ItemName (string) --
The name of the item.
Description (string) --
The description of the item.
GlossaryTerms (list) --
The identifiers of the glossary terms associated with the item.
(string) --
NextToken (string) --
A continuation token, present if the current segment is not the last.
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(
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'
}
}
}
)
string
The text to search for. At least one of searchText or filterClause must be provided.
integer
The maximum number of results to return in the response.
string
A continuation token, if this is a continuation call.
dict
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.
dict
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.
dict
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.
Lists business glossaries in Glue Data Catalog.
See also: AWS API Documentation
Request Syntax
client.list_glossaries(
MaxResults=123,
NextToken='string'
)
integer
The maximum number of results to return in the response.
string
A continuation token, if this is a continuation call.
dict
Response Syntax
{
'Items': [
{
'Id': 'string',
'Name': 'string',
'Description': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Items (list) --
The list of glossary items.
(dict) --
A summary of a business glossary.
Id (string) --
The unique identifier of the glossary.
Name (string) --
The name of the glossary.
Description (string) --
The description of the glossary.
NextToken (string) --
A continuation token, present if the current segment is not the last.
Associates one or more glossary terms with an asset in Glue Data Catalog.
See also: AWS API Documentation
Request Syntax
client.associate_glossary_terms(
Identifier='string',
GlossaryTermIdentifiers=[
'string',
],
ClientToken='string'
)
string
[REQUIRED]
The unique identifier of the asset to associate glossary terms with.
list
[REQUIRED]
The list of glossary term identifiers to associate with the asset.
(string) --
string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
This field is autopopulated if not provided.
dict
Response Syntax
{
'Identifier': 'string',
'GlossaryTerms': [
'string',
]
}
Response Structure
(dict) --
Identifier (string) --
The unique identifier of the asset.
GlossaryTerms (list) --
The glossary terms now associated with the asset.
(string) --
Creates or updates a form type in Glue Data Catalog. A form type defines the schema for structured metadata that can be attached to assets.
See also: AWS API Documentation
Request Syntax
client.put_form_type(
Name='string',
Schema='string',
ClientToken='string'
)
string
[REQUIRED]
The name of the form type. Must start with an uppercase letter.
string
[REQUIRED]
The Smithy IDL schema definition for the form type.
string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
This field is autopopulated if not provided.
dict
Response Syntax
{
'Id': 'string',
'Name': 'string',
'Schema': 'string'
}
Response Structure
(dict) --
Id (string) --
The identifier of the form type.
Name (string) --
The name of the form type.
Schema (string) --
The Smithy IDL schema of the form type.
Retrieves the metadata for an asset in Glue Data Catalog, including its forms, additional attachments, and associated glossary terms.
See also: AWS API Documentation
Request Syntax
client.get_asset(
Identifier='string'
)
string
[REQUIRED]
The unique identifier of the asset to retrieve.
dict
Response Syntax
{
'Id': 'string',
'Name': 'string',
'Description': 'string',
'CreatedAt': datetime(2015, 1, 1),
'UpdatedAt': datetime(2015, 1, 1),
'AssetTypeId': 'string',
'GlossaryTerms': [
'string',
],
'Forms': {
'string': {
'FormTypeId': 'string',
'Content': 'string'
}
},
'Attachments': {
'string': {
'FormTypeId': 'string',
'Content': 'string'
}
},
'IterableForms': {
'string': {
'FormTypeId': 'string'
}
}
}
Response Structure
(dict) --
Id (string) --
The unique identifier of the asset.
Name (string) --
The name of the asset.
Description (string) --
The description of the asset.
CreatedAt (datetime) --
The timestamp at which the asset was created.
UpdatedAt (datetime) --
The timestamp at which the asset was last updated.
AssetTypeId (string) --
The identifier of the asset type for this asset.
GlossaryTerms (list) --
The identifiers of the glossary terms associated with the asset.
(string) --
Forms (dict) --
The forms on the asset, keyed by form name.
(string) --
(dict) --
A form on an asset, consisting of the form type identifier and its JSON content.
FormTypeId (string) --
The identifier of the form type that defines this form's schema.
Content (string) --
The JSON content of the form, conforming to the schema of the specified form type.
Attachments (dict) --
Additional attachments on the asset for more context, keyed by attachment name.
(string) --
(dict) --
A form on an asset, consisting of the form type identifier and its JSON content.
FormTypeId (string) --
The identifier of the form type that defines this form's schema.
Content (string) --
The JSON content of the form, conforming to the schema of the specified form type.
IterableForms (dict) --
The iterable forms available on the asset, keyed by form name (for example, columns). Use the form name with ListIterableForms or BatchGetIterableForms to retrieve the form's items.
(string) --
(dict) --
An iterable form available on an asset, identified by its form type.
FormTypeId (string) --
The form type identifier of the iterable form (for example, columns), used to retrieve its items via ListIterableForms or BatchGetIterableForms.
Retrieves an asset type in Glue Data Catalog by its identifier.
See also: AWS API Documentation
Request Syntax
client.get_asset_type(
Identifier='string'
)
string
[REQUIRED]
The identifier of the asset type to retrieve.
dict
Response Syntax
{
'Id': 'string',
'Name': 'string',
'Forms': {
'string': {
'FormTypeIdentifier': 'string'
}
}
}
Response Structure
(dict) --
Id (string) --
The identifier of the asset type.
Name (string) --
The name of the asset type.
Forms (dict) --
The forms that make up the asset type, keyed by form name.
(string) --
(dict) --
A reference to a form type that is included in an asset type.
FormTypeIdentifier (string) --
The identifier of the referenced form type.
Creates or updates an asset in Glue Data Catalog. If the asset already exists, this operation updates it; otherwise, a new asset is created.
See also: AWS API Documentation
Request Syntax
client.put_asset(
AssetTypeId='string',
Identifier='string',
Name='string',
Description='string',
Forms={
'string': {
'FormTypeId': 'string',
'Content': 'string'
}
},
ClientToken='string'
)
string
[REQUIRED]
The identifier of the asset type for the asset.
string
[REQUIRED]
The unique identifier of the asset. If an asset with this identifier already exists, it is updated.
string
[REQUIRED]
The name of the asset.
string
The description of the asset.
dict
[REQUIRED]
The forms to set on the asset, keyed by form name. Each entry specifies the form type and its JSON content.
(string) --
(dict) --
A form on an asset, consisting of the form type identifier and its JSON content.
FormTypeId (string) --
The identifier of the form type that defines this form's schema.
Content (string) --
The JSON content of the form, conforming to the schema of the specified form type.
string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
This field is autopopulated if not provided.
dict
Response Syntax
{
'Id': 'string',
'Name': 'string',
'Description': 'string',
'CreatedAt': datetime(2015, 1, 1),
'Forms': {
'string': {
'FormTypeId': 'string',
'Content': 'string'
}
}
}
Response Structure
(dict) --
Id (string) --
The unique identifier of the asset.
Name (string) --
The name of the asset.
Description (string) --
The description of the asset.
CreatedAt (datetime) --
The timestamp at which the asset was created.
Forms (dict) --
The forms attached to the asset, keyed by form name.
(string) --
(dict) --
A form on an asset, consisting of the form type identifier and its JSON content.
FormTypeId (string) --
The identifier of the form type that defines this form's schema.
Content (string) --
The JSON content of the form, conforming to the schema of the specified form type.
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(
Identifier='string',
GlossaryTermIdentifiers=[
'string',
],
ClientToken='string'
)
string
[REQUIRED]
The unique identifier of the asset to disassociate glossary terms from.
list
[REQUIRED]
The list of glossary term identifiers to disassociate from the asset.
(string) --
string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
This field is autopopulated if not provided.
dict
Response Syntax
{
'Identifier': 'string',
'GlossaryTerms': [
'string',
]
}
Response Structure
(dict) --
Identifier (string) --
The unique identifier of the asset.
GlossaryTerms (list) --
The remaining glossary terms associated with the asset.
(string) --
Creates a glossary term within a business glossary in Glue Data Catalog.
See also: AWS API Documentation
Request Syntax
client.create_glossary_term(
GlossaryIdentifier='string',
Name='string',
ShortDescription='string',
LongDescription='string',
ClientToken='string'
)
string
[REQUIRED]
The unique identifier of the glossary in which to create the term.
string
[REQUIRED]
The name of the glossary term.
string
A short description of the glossary term.
string
A long description of the glossary term.
string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
This field is autopopulated if not provided.
dict
Response Syntax
{
'Id': 'string',
'GlossaryId': 'string',
'Name': 'string',
'ShortDescription': 'string',
'LongDescription': 'string'
}
Response Structure
(dict) --
Id (string) --
The unique identifier of the glossary term.
GlossaryId (string) --
The unique identifier of the glossary containing this term.
Name (string) --
The name of the glossary term.
ShortDescription (string) --
The short description of the glossary term.
LongDescription (string) --
The long description of the glossary term.
Deletes a business glossary from Glue Data Catalog. A glossary cannot be deleted if it still contains glossary terms.
See also: AWS API Documentation
Request Syntax
client.delete_glossary(
Identifier='string'
)
string
[REQUIRED]
The unique identifier of the glossary to delete.
dict
Response Syntax
{}
Response Structure
(dict) --
Deletes a form type from Glue Data Catalog. A form type cannot be deleted if it is still referenced by an asset type.
See also: AWS API Documentation
Request Syntax
client.delete_form_type(
Identifier='string'
)
string
[REQUIRED]
The identifier of the form type to delete.
dict
Response Syntax
{}
Response Structure
(dict) --
Retrieves a glossary term in Glue Data Catalog by its identifier.
See also: AWS API Documentation
Request Syntax
client.get_glossary_term(
Identifier='string'
)
string
[REQUIRED]
The unique identifier of the glossary term to retrieve.
dict
Response Syntax
{
'Id': 'string',
'GlossaryId': 'string',
'Name': 'string',
'ShortDescription': 'string',
'LongDescription': 'string'
}
Response Structure
(dict) --
Id (string) --
The unique identifier of the glossary term.
GlossaryId (string) --
The unique identifier of the glossary containing this term.
Name (string) --
The name of the glossary term.
ShortDescription (string) --
The short description of the glossary term.
LongDescription (string) --
The long description of the glossary term.
Updates a glossary term in Glue Data Catalog.
See also: AWS API Documentation
Request Syntax
client.update_glossary_term(
Identifier='string',
Name='string',
ShortDescription='string',
LongDescription='string',
ClientToken='string'
)
string
[REQUIRED]
The unique identifier of the glossary term to update.
string
The updated name of the glossary term.
string
The updated short description of the glossary term.
string
The updated long description of the glossary term.
string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
This field is autopopulated if not provided.
dict
Response Syntax
{
'Id': 'string',
'GlossaryId': 'string',
'Name': 'string',
'ShortDescription': 'string',
'LongDescription': 'string'
}
Response Structure
(dict) --
Id (string) --
The unique identifier of the glossary term.
GlossaryId (string) --
The unique identifier of the glossary containing this term.
Name (string) --
The name of the glossary term.
ShortDescription (string) --
The short description of the glossary term.
LongDescription (string) --
The long description of the glossary term.
Lists the asset types defined in Glue Data Catalog.
See also: AWS API Documentation
Request Syntax
client.list_asset_types(
MaxResults=123,
NextToken='string'
)
integer
The maximum number of results to return in the response.
string
A continuation token, if this is a continuation call.
dict
Response Syntax
{
'Items': [
{
'Id': 'string',
'Name': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Items (list) --
The list of asset type items.
(dict) --
A summary of an asset type.
Id (string) --
The identifier of the asset type.
Name (string) --
The name of the asset type.
NextToken (string) --
A continuation token, present if the current segment is not the last.
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'
)
string
[REQUIRED]
The unique identifier of the asset to attach the form to.
string
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.
string
The identifier of the item within the iterable form. Required when iterableFormName is specified.
string
[REQUIRED]
The name of the attachment.
string
[REQUIRED]
The JSON content of the form, conforming to the schema of the specified form type.
string
[REQUIRED]
The identifier of the form type for this attachment.
string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
This field is autopopulated if not provided.
dict
Response Syntax
{
'AssetId': 'string',
'IterableFormName': 'string',
'ItemIdentifier': 'string',
'AttachmentName': 'string',
'FormTypeId': 'string'
}
Response Structure
(dict) --
AssetId (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.