AWS API Changes

2024/04/01 - Amazon DataZone - 4 new 1 updated api methods

Changes This release supports the feature of AI recommendations for descriptions to enrich the business data catalog in Amazon DataZone.

StartMetadataGenerationRun (new)

Link ¶

Starts the metadata generation run.

See also: AWS API Documentation

Request Syntax

client.start_metadata_generation_run(
    clientToken='string',
    domainIdentifier='string',
    owningProjectIdentifier='string',
    target={
        'identifier': 'string',
        'revision': 'string',
        'type': 'ASSET'
    },
    type='BUSINESS_DESCRIPTIONS'
)

type clientToken

string

param clientToken

A unique, case-sensitive identifier to ensure idempotency of the request. This field is automatically populated if not provided.

This field is autopopulated if not provided.

type domainIdentifier

string

param domainIdentifier

[REQUIRED]

The ID of the Amazon DataZone domain where you want to start a metadata generation run.

type owningProjectIdentifier

string

param owningProjectIdentifier

[REQUIRED]

The ID of the project that owns the asset for which you want to start a metadata generation run.

type target

dict

param target

[REQUIRED]

The asset for which you want to start a metadata generation run.

identifier (string) -- [REQUIRED]

The ID of the metadata generation run's target.
revision (string) --

The revision of the asset for which metadata was generated.
type (string) -- [REQUIRED]

The type of the asset for which metadata was generated.

type type

string

param type

[REQUIRED]

The type of the metadata generation run.

rtype

dict

returns

Response Syntax

{
    'createdAt': datetime(2015, 1, 1),
    'createdBy': 'string',
    'domainId': 'string',
    'id': 'string',
    'owningProjectId': 'string',
    'status': 'SUBMITTED'|'IN_PROGRESS'|'CANCELED'|'SUCCEEDED'|'FAILED',
    'type': 'BUSINESS_DESCRIPTIONS'
}

Response Structure

(dict) --
- createdAt (datetime) --
  
  The timestamp at which the metadata generation run was started.
- createdBy (string) --
  
  The ID of the user who started the metadata generation run.
- domainId (string) --
  
  The ID of the Amazon DataZone domain in which the metadata generation run was started.
- id (string) --
  
  The ID of the metadata generation run.
- owningProjectId (string) --
  
  The ID of the project that owns the asset for which the metadata generation run was started.
- status (string) --
  
  The status of the metadata generation run.
- type (string) --
  
  The type of the metadata generation run.

CancelMetadataGenerationRun (new)

Link ¶

Cancels the metadata generation run.

See also: AWS API Documentation

Request Syntax

client.cancel_metadata_generation_run(
    domainIdentifier='string',
    identifier='string'
)

type domainIdentifier

string

param domainIdentifier

[REQUIRED]

The ID of the Amazon DataZone domain in which the metadata generation run is to be cancelled.

type identifier

string

param identifier

[REQUIRED]

The ID of the metadata generation run.

rtype

dict

returns

Response Syntax

{}

Response Structure

(dict) --

GetMetadataGenerationRun (new)

Link ¶

Gets a metadata generation run in Amazon DataZone.

See also: AWS API Documentation

Request Syntax

client.get_metadata_generation_run(
    domainIdentifier='string',
    identifier='string'
)

type domainIdentifier

string

param domainIdentifier

[REQUIRED]

The ID of the Amazon DataZone domain the metadata generation run of which you want to get.

type identifier

string

param identifier

[REQUIRED]

The identifier of the metadata generation run.

rtype

dict

returns

Response Syntax

{
    'createdAt': datetime(2015, 1, 1),
    'createdBy': 'string',
    'domainId': 'string',
    'id': 'string',
    'owningProjectId': 'string',
    'status': 'SUBMITTED'|'IN_PROGRESS'|'CANCELED'|'SUCCEEDED'|'FAILED',
    'target': {
        'identifier': 'string',
        'revision': 'string',
        'type': 'ASSET'
    },
    'type': 'BUSINESS_DESCRIPTIONS'
}

Response Structure

(dict) --
- createdAt (datetime) --
  
  The timestamp of when the metadata generation run was start.
- createdBy (string) --
  
  The Amazon DataZone user who started the metadata generation run.
- domainId (string) --
  
  The ID of the Amazon DataZone domain the metadata generation run of which you want to get.
- id (string) --
  
  The ID of the metadata generation run.
- owningProjectId (string) --
  
  The ID of the project that owns the assets for which you're running metadata generation.
- status (string) --
  
  The status of the metadata generation run.
- target (dict) --
  
  The asset for which you're generating metadata.
  - identifier (string) --
    
    The ID of the metadata generation run's target.
  - revision (string) --
    
    The revision of the asset for which metadata was generated.
  - type (string) --
    
    The type of the asset for which metadata was generated.
- type (string) --
  
  The type of metadata generation run.

ListMetadataGenerationRuns (new)

Link ¶

Lists all metadata generation runs.

See also: AWS API Documentation

Request Syntax

client.list_metadata_generation_runs(
    domainIdentifier='string',
    maxResults=123,
    nextToken='string',
    status='SUBMITTED'|'IN_PROGRESS'|'CANCELED'|'SUCCEEDED'|'FAILED',
    type='BUSINESS_DESCRIPTIONS'
)

type domainIdentifier

string

param domainIdentifier

[REQUIRED]

The ID of the Amazon DataZone domain where you want to list metadata generation runs.

type maxResults

integer

param maxResults

The maximum number of metadata generation runs to return in a single call to ListMetadataGenerationRuns. When the number of metadata generation runs 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 ListMetadataGenerationRuns to list the next set of revisions.

type nextToken

string

param nextToken

When the number of metadata generation runs 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 metadata generation runs, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListMetadataGenerationRuns to list the next set of revisions.

type status

string

param status

The status of the metadata generation runs.

type type

string

param type

The type of the metadata generation runs.

rtype

dict

returns

Response Syntax

{
    'items': [
        {
            'createdAt': datetime(2015, 1, 1),
            'createdBy': 'string',
            'domainId': 'string',
            'id': 'string',
            'owningProjectId': 'string',
            'status': 'SUBMITTED'|'IN_PROGRESS'|'CANCELED'|'SUCCEEDED'|'FAILED',
            'target': {
                'identifier': 'string',
                'revision': 'string',
                'type': 'ASSET'
            },
            'type': 'BUSINESS_DESCRIPTIONS'
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) --
- items (list) --
  
  The results of the ListMetadataGenerationRuns action.
  - (dict) --
    
    The metadata generation run.
    - createdAt (datetime) --
      
      The timestamp at which the metadata generation run was created.
    - createdBy (string) --
      
      The user who created the metadata generation run.
    - domainId (string) --
      
      The ID of the Amazon DataZone domain in which the metadata generation run was created.
    - id (string) --
      
      The ID of the metadata generation run.
    - owningProjectId (string) --
      
      The ID of the project that owns the asset for which the metadata generation was ran.
    - status (string) --
      
      The status of the metadata generation run.
    - target (dict) --
      
      The asset for which metadata was generated.
      - identifier (string) --
        
        The ID of the metadata generation run's target.
      - revision (string) --
        
        The revision of the asset for which metadata was generated.
      - type (string) --
        
        The type of the asset for which metadata was generated.
    - type (string) --
      
      The type of the metadata generation run.
- nextToken (string) --
  
  When the number of metadata generation runs 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 metadata generation runs, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListMetadataGenerationRuns to list the next set of revisions.

AcceptPredictions (updated)

Link ¶
Changes (request)

{'acceptChoices': {'editedValue': 'string'}}

Accepts automatically generated business-friendly metadata for your Amazon DataZone assets.

See also: AWS API Documentation

Request Syntax

client.accept_predictions(
    acceptChoices=[
        {
            'editedValue': 'string',
            'predictionChoice': 123,
            'predictionTarget': 'string'
        },
    ],
    acceptRule={
        'rule': 'ALL'|'NONE',
        'threshold': ...
    },
    clientToken='string',
    domainIdentifier='string',
    identifier='string',
    revision='string'
)

type acceptChoices

list

param acceptChoices

Specifies the prediction (aka, the automatically generated piece of metadata) and the target (for example, a column name) that can be accepted.

(dict) --

Specifies the prediction (aka, the automatically generated piece of metadata) and the target (for example, a column name) that can be accepted.
- editedValue (string) --
  
  The edit of the prediction.
- predictionChoice (integer) --
  
  Specifies the prediction (aka, the automatically generated piece of metadata) that can be accepted.
- predictionTarget (string) -- [REQUIRED]
  
  Specifies the target (for example, a column name) where a prediction can be accepted.

type acceptRule

dict

param acceptRule

Specifies the rule (or the conditions) under which a prediction can be accepted.

rule (string) --

Specifies whether you want to accept the top prediction for all targets or none.
threshold (float) --

The confidence score that specifies the condition at which a prediction can be accepted.

type clientToken

string

param clientToken

A unique, case-sensitive identifier to ensure idempotency of the request. This field is automatically populated if not provided.

This field is autopopulated if not provided.

type domainIdentifier

string

param domainIdentifier

[REQUIRED]

The identifier of the Amazon DataZone domain.

type identifier

string

param identifier

[REQUIRED]

The identifier of the asset.

type revision

string

param revision

The revision that is to be made to the asset.

rtype

dict

returns

Response Syntax

{
    'assetId': 'string',
    'domainId': 'string',
    'revision': 'string'
}

Response Structure

(dict) --
- assetId (string) --
  
  The ID of the asset.
- domainId (string) --
  
  The identifier of the Amazon DataZone domain.
- revision (string) --
  
  The revision that is to be made to the asset.