AWS API Changes

2024/07/12 - Amazon DataZone - 1 updated api methods

Search (updated)

Link ¶
Changes (response)

{'items': {'dataProductItem': {'dataProductItems': [{'domainId': 'string',
                                                     'itemId': 'string'}],
                               'updatedAt': 'timestamp',
                               'updatedBy': 'string'}}}

Searches for assets in Amazon DataZone.

See also: AWS API Documentation

Request Syntax

client.search(
    additionalAttributes=[
        'FORMS'|'TIME_SERIES_DATA_POINT_FORMS',
    ],
    domainIdentifier='string',
    filters={
        'and': [
            {'... recursive ...'},
        ],
        'filter': {
            'attribute': 'string',
            'value': 'string'
        },
        'or': [
            {'... recursive ...'},
        ]
    },
    maxResults=123,
    nextToken='string',
    owningProjectIdentifier='string',
    searchIn=[
        {
            'attribute': 'string'
        },
    ],
    searchScope='ASSET'|'GLOSSARY'|'GLOSSARY_TERM',
    searchText='string',
    sort={
        'attribute': 'string',
        'order': 'ASCENDING'|'DESCENDING'
    }
)

type additionalAttributes:

list

param additionalAttributes:

Specifies additional attributes for the Search action.

(string) --

type domainIdentifier:

string

param domainIdentifier:

[REQUIRED]

The identifier of the Amazon DataZone domain.

type filters:

dict

param filters:

Specifies the search filters.

and (list) --

The 'and' search filter clause in Amazon DataZone.
- (dict) --
  
  A search filter clause in Amazon DataZone.
  
  Note
  
  This is a Tagged Union structure. Only one of the following top level keys can be set: and, filter, or.
filter (dict) --

A search filter in Amazon DataZone.
- attribute (string) -- [REQUIRED]
  
  A search filter attribute in Amazon DataZone.
- value (string) -- [REQUIRED]
  
  A search filter value in Amazon DataZone.
or (list) --

The 'or' search filter clause in Amazon DataZone.
- (dict) --
  
  A search filter clause in Amazon DataZone.
  
  Note
  
  This is a Tagged Union structure. Only one of the following top level keys can be set: and, filter, or.

type maxResults:

integer

param maxResults:

The maximum number of results to return in a single call to Search. When the number of results to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to Search to list the next set of results.

type nextToken:

string

param nextToken:

When the number of results is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of results, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to Search to list the next set of results.

type owningProjectIdentifier:

string

param owningProjectIdentifier:

The identifier of the owning project specified for the search.

type searchIn:

list

param searchIn:

The details of the search.

(dict) --

The details of the search.
- attribute (string) -- [REQUIRED]
  
  The search attribute.

type searchScope:

string

param searchScope:

[REQUIRED]

The scope of the search.

type searchText:

string

param searchText:

Specifies the text for which to search.

type sort:

dict

param sort:

Specifies the way in which the search results are to be sorted.

attribute (string) -- [REQUIRED]

The attribute detail of the way to sort search results.
order (string) --

The order detail of the wya to sort search results.

rtype:

dict

returns:

Response Syntax

{
    'items': [
        {
            'assetItem': {
                'additionalAttributes': {
                    'formsOutput': [
                        {
                            'content': 'string',
                            'formName': 'string',
                            'typeName': 'string',
                            'typeRevision': 'string'
                        },
                    ],
                    'latestTimeSeriesDataPointFormsOutput': [
                        {
                            'contentSummary': 'string',
                            'formName': 'string',
                            'id': 'string',
                            'timestamp': datetime(2015, 1, 1),
                            'typeIdentifier': 'string',
                            'typeRevision': 'string'
                        },
                    ],
                    'readOnlyFormsOutput': [
                        {
                            'content': 'string',
                            'formName': 'string',
                            'typeName': 'string',
                            'typeRevision': 'string'
                        },
                    ]
                },
                'createdAt': datetime(2015, 1, 1),
                'createdBy': 'string',
                'description': 'string',
                'domainId': 'string',
                'externalIdentifier': 'string',
                'firstRevisionCreatedAt': datetime(2015, 1, 1),
                'firstRevisionCreatedBy': 'string',
                'glossaryTerms': [
                    'string',
                ],
                'identifier': 'string',
                'name': 'string',
                'owningProjectId': 'string',
                'typeIdentifier': 'string',
                'typeRevision': 'string'
            },
            'dataProductItem': {
                'createdAt': datetime(2015, 1, 1),
                'createdBy': 'string',
                'dataProductItems': [
                    {
                        'domainId': 'string',
                        'itemId': 'string'
                    },
                ],
                'description': 'string',
                'domainId': 'string',
                'glossaryTerms': [
                    'string',
                ],
                'id': 'string',
                'name': 'string',
                'owningProjectId': 'string',
                'updatedAt': datetime(2015, 1, 1),
                'updatedBy': 'string'
            },
            'glossaryItem': {
                'createdAt': datetime(2015, 1, 1),
                'createdBy': 'string',
                'description': 'string',
                'domainId': 'string',
                'id': 'string',
                'name': 'string',
                'owningProjectId': 'string',
                'status': 'DISABLED'|'ENABLED',
                'updatedAt': datetime(2015, 1, 1),
                'updatedBy': 'string'
            },
            'glossaryTermItem': {
                'createdAt': datetime(2015, 1, 1),
                'createdBy': 'string',
                'domainId': 'string',
                'glossaryId': 'string',
                'id': 'string',
                'longDescription': 'string',
                'name': 'string',
                'shortDescription': 'string',
                'status': 'ENABLED'|'DISABLED',
                'termRelations': {
                    'classifies': [
                        'string',
                    ],
                    'isA': [
                        'string',
                    ]
                },
                'updatedAt': datetime(2015, 1, 1),
                'updatedBy': 'string'
            }
        },
    ],
    'nextToken': 'string',
    'totalMatchCount': 123
}

Response Structure

(dict) --
- items (list) --
  
  The results of the Search action.
  - (dict) --
    
    The details of the search results.
    Note
    
    This is a Tagged Union structure. Only one of the following top level keys will be set: assetItem, dataProductItem, glossaryItem, glossaryTermItem. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
```
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
```
    - assetItem (dict) --
      
      The asset item included in the search results.
      - additionalAttributes (dict) --
        
        The additional attributes of a Amazon DataZone inventory asset.
        
        formsOutput (list) --
        
        The forms included in the additional attributes of an inventory asset.
        
        (dict) --
        
        The details of a metadata form.
        
        content (string) --
        
        The content of the metadata form.
        
        formName (string) --
        
        The name of the metadata form.
        
        typeName (string) --
        
        The name of the metadata form type.
        
        typeRevision (string) --
        
        The revision of the metadata form type.
        
        latestTimeSeriesDataPointFormsOutput (list) --
        
        The latest time series data points forms included in the additional attributes of an asset.
        
        (dict) --
        
        The summary of the time series data points form.
        
        contentSummary (string) --
        
        The content of the summary of the time series data points form.
        
        formName (string) --
        
        The name of the time series data points summary form.
        
        id (string) --
        
        The ID of the time series data points summary form.
        
        timestamp (datetime) --
        
        The timestamp of the time series data points summary form.
        
        typeIdentifier (string) --
        
        The type ID of the time series data points summary form.
        
        typeRevision (string) --
        
        The type revision of the time series data points summary form.
        
        readOnlyFormsOutput (list) --
        
        The read-only forms included in the additional attributes of an inventory asset.
        
        (dict) --
        
        The details of a metadata form.
        
        content (string) --
        
        The content of the metadata form.
        
        formName (string) --
        
        The name of the metadata form.
        
        typeName (string) --
        
        The name of the metadata form type.
        
        typeRevision (string) --
        
        The revision of the metadata form type.
      - createdAt (datetime) --
        
        The timestamp of when the Amazon DataZone inventory asset was created.
      - createdBy (string) --
        
        The Amazon DataZone user who created the inventory asset.
      - description (string) --
        
        The description of an Amazon DataZone inventory asset.
      - domainId (string) --
        
        The identifier of the Amazon DataZone domain in which the inventory asset exists.
      - externalIdentifier (string) --
        
        The external identifier of the Amazon DataZone inventory asset.
      - firstRevisionCreatedAt (datetime) --
        
        The timestamp of when the first revision of the inventory asset was created.
      - firstRevisionCreatedBy (string) --
        
        The Amazon DataZone user who created the first revision of the inventory asset.
      - glossaryTerms (list) --
        
        The glossary terms attached to the Amazon DataZone inventory asset.
        
        (string) --
      - identifier (string) --
        
        the identifier of the Amazon DataZone inventory asset.
      - name (string) --
        
        The name of the Amazon DataZone inventory asset.
      - owningProjectId (string) --
        
        The identifier of the Amazon DataZone project that owns the inventory asset.
      - typeIdentifier (string) --
        
        The identifier of the asset type of the specified Amazon DataZone inventory asset.
      - typeRevision (string) --
        
        The revision of the inventory asset type.
    - dataProductItem (dict) --
      
      The data product item included in the search results.
      - createdAt (datetime) --
      - createdBy (string) --
      - dataProductItems (list) --
        
        (dict) --
        
        domainId (string) --
        
        itemId (string) --
      - description (string) --
      - domainId (string) --
      - glossaryTerms (list) --
        
        (string) --
      - id (string) --
      - name (string) --
      - owningProjectId (string) --
      - updatedAt (datetime) --
      - updatedBy (string) --
    - glossaryItem (dict) --
      
      The glossary item included in the search results.
      - createdAt (datetime) --
        
        The timestamp of when the glossary was created.
      - createdBy (string) --
        
        The Amazon DataZone user who created the glossary.
      - description (string) --
        
        The business glossary description.
      - domainId (string) --
        
        The identifier of the Amazon DataZone domain in which the business glossary exists.
      - id (string) --
        
        The identifier of the glossary.
      - name (string) --
        
        The name of the glossary.
      - owningProjectId (string) --
        
        The identifier of the project that owns the business glosary.
      - status (string) --
        
        The business glossary status.
      - updatedAt (datetime) --
        
        The timestamp of when the business glossary was updated.
      - updatedBy (string) --
        
        The Amazon DataZone user who updated the business glossary.
    - glossaryTermItem (dict) --
      
      The glossary term item included in the search results.
      - createdAt (datetime) --
        
        The timestamp of when a business glossary term was created.
      - createdBy (string) --
        
        The Amazon DataZone user who created the business glossary.
      - domainId (string) --
        
        The identifier of the Amazon DataZone domain in which the business glossary exists.
      - glossaryId (string) --
        
        The identifier of the business glossary to which the term belongs.
      - id (string) --
        
        The identifier of the business glossary term.
      - longDescription (string) --
        
        The long description of the business glossary term.
      - name (string) --
        
        The name of the business glossary term.
      - shortDescription (string) --
        
        The short description of the business glossary term.
      - status (string) --
        
        The status of the business glossary term.
      - termRelations (dict) --
        
        The relations of the business glossary term.
        
        classifies (list) --
        
        The classifies of the term relations.
        
        (string) --
        
        isA (list) --
        
        The isA property of the term relations.
        
        (string) --
      - updatedAt (datetime) --
        
        The timestamp of when a business glossary term was updated.
      - updatedBy (string) --
        
        The Amazon DataZone user who updated the business glossary term.
- nextToken (string) --
  
  When the number of results is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of results, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to Search to list the next set of results.
- totalMatchCount (integer) --
  
  Total number of search results.