AWS API Changes

2025/12/02 - Amazon DataZone - 2 new3 updated api methods

Changes Amazon DataZone now supports exporting Catalog datasets as Amazon S3 tables, and provides automatic business glossary term suggestions for data assets.

GetDataExportConfiguration (new)

Link ¶

Gets data export configuration details.

See also: AWS API Documentation

Request Syntax

client.get_data_export_configuration(
    domainIdentifier='string'
)

type domainIdentifier:

string

param domainIdentifier:

[REQUIRED]

The ID of the domain where you want to get the data export configuration details.

rtype:

dict

returns:

Response Syntax

{
    'createdAt': datetime(2015, 1, 1),
    'encryptionConfiguration': {
        'kmsKeyArn': 'string',
        'sseAlgorithm': 'string'
    },
    'isExportEnabled': True|False,
    's3TableBucketArn': 'string',
    'status': 'COMPLETED'|'FAILED',
    'updatedAt': datetime(2015, 1, 1)
}

Response Structure

(dict) --
- createdAt (datetime) --
  
  The timestamp at which the data export configuration report was created.
- encryptionConfiguration (dict) --
  
  The encryption configuration as part of the data export configuration details.
  - kmsKeyArn (string) --
    
    The Amazon Resource Name (ARN) of the KMS key to use for encryption. This field is required only when sseAlgorithm is set to aws:kms.
  - sseAlgorithm (string) --
    
    The server-side encryption algorithm to use. Valid values are AES256 for S3-managed encryption keys, or aws:kms for Amazon Web Services KMS-managed encryption keys. If you choose SSE-KMS encryption you must grant the S3 Tables maintenance principal access to your KMS key. For more information, see Permissions requirements for S3 Tables SSE-KMS encryption.
- isExportEnabled (boolean) --
  
  Specifies whether the export is enabled.
- s3TableBucketArn (string) --
  
  The Amazon S3 table bucket ARN as part of the data export configuration details.
- status (string) --
  
  The status of the data export configuration.
- updatedAt (datetime) --
  
  The timestamp at which the data export configuration report was updated.

PutDataExportConfiguration (new)

Link ¶

Creates data export configuration details.

In the current release, you can enable exporting asset metadata only for one domain per Amazon Web Services account per region. If you disable exporting asset metadata feature for a domain where it's already enabled, you cannot enable this feature for another domain in the same Amazon Web Services account and region.

See also: AWS API Documentation

Request Syntax

client.put_data_export_configuration(
    clientToken='string',
    domainIdentifier='string',
    enableExport=True|False,
    encryptionConfiguration={
        'kmsKeyArn': 'string',
        'sseAlgorithm': 'string'
    }
)

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 domain ID where you want to create data export configuration details.

type enableExport:

boolean

param enableExport:

[REQUIRED]

Specifies that the export is to be enabled as part of creating data export configuration details.

type encryptionConfiguration:

dict

param encryptionConfiguration:

The encryption configuration as part of creating data export configuration details.

The KMS key provided here as part of encryptionConfiguration must have the required permissions as described in KMS permissions for exporting asset metadata in Amazon SageMaker Unified Studio.

kmsKeyArn (string) --

The Amazon Resource Name (ARN) of the KMS key to use for encryption. This field is required only when sseAlgorithm is set to aws:kms.
sseAlgorithm (string) --

The server-side encryption algorithm to use. Valid values are AES256 for S3-managed encryption keys, or aws:kms for Amazon Web Services KMS-managed encryption keys. If you choose SSE-KMS encryption you must grant the S3 Tables maintenance principal access to your KMS key. For more information, see Permissions requirements for S3 Tables SSE-KMS encryption.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

(dict) --

GetMetadataGenerationRun (updated)

Link ¶
Changes (request, response)
Request

{'type': 'BUSINESS_DESCRIPTIONS | BUSINESS_NAMES | '
         'BUSINESS_GLOSSARY_ASSOCIATIONS'}

Response

{'status': {'PARTIALLY_SUCCEEDED'},
 'type': {'BUSINESS_GLOSSARY_ASSOCIATIONS', 'BUSINESS_NAMES'},
 'typeStats': [{'errorMessage': 'string',
                'status': 'SUBMITTED | IN_PROGRESS | CANCELED | SUCCEEDED | '
                          'FAILED | PARTIALLY_SUCCEEDED',
                'type': 'BUSINESS_DESCRIPTIONS | BUSINESS_NAMES | '
                        'BUSINESS_GLOSSARY_ASSOCIATIONS'}],
 'types': ['BUSINESS_DESCRIPTIONS | BUSINESS_NAMES | '
           'BUSINESS_GLOSSARY_ASSOCIATIONS']}

Gets a metadata generation run in Amazon DataZone.

Prerequisites:

Valid domain and run identifier.
The metadata generation run must exist.
User must have read access to the metadata run.

See also: AWS API Documentation

Request Syntax

client.get_metadata_generation_run(
    domainIdentifier='string',
    identifier='string',
    type='BUSINESS_DESCRIPTIONS'|'BUSINESS_NAMES'|'BUSINESS_GLOSSARY_ASSOCIATIONS'
)

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.

type type:

string

param type:

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'|'PARTIALLY_SUCCEEDED',
    'target': {
        'identifier': 'string',
        'revision': 'string',
        'type': 'ASSET'
    },
    'type': 'BUSINESS_DESCRIPTIONS'|'BUSINESS_NAMES'|'BUSINESS_GLOSSARY_ASSOCIATIONS',
    'typeStats': [
        {
            'errorMessage': 'string',
            'status': 'SUBMITTED'|'IN_PROGRESS'|'CANCELED'|'SUCCEEDED'|'FAILED'|'PARTIALLY_SUCCEEDED',
            'type': 'BUSINESS_DESCRIPTIONS'|'BUSINESS_NAMES'|'BUSINESS_GLOSSARY_ASSOCIATIONS'
        },
    ],
    'types': [
        'BUSINESS_DESCRIPTIONS'|'BUSINESS_NAMES'|'BUSINESS_GLOSSARY_ASSOCIATIONS',
    ]
}

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.
- typeStats (list) --
  
  The type stats included in the metadata generation run output details.
  - (dict) --
    
    The statistics of the metadata generation run type.
    - errorMessage (string) --
      
      The error message displayed if the action fails to run.
    - status (string) --
      
      The status of the metadata generation run type statistics.
    - type (string) --
      
      The type of the metadata generation run type statistics.
- types (list) --
  
  The types of the metadata generation run.
  - (string) --

ListMetadataGenerationRuns (updated)

Link ¶
Changes (request, response)
Request

{'status': {'PARTIALLY_SUCCEEDED'},
 'targetIdentifier': 'string',
 'type': {'BUSINESS_GLOSSARY_ASSOCIATIONS', 'BUSINESS_NAMES'}}

Response

{'items': {'status': {'PARTIALLY_SUCCEEDED'},
           'type': {'BUSINESS_GLOSSARY_ASSOCIATIONS', 'BUSINESS_NAMES'},
           'types': ['BUSINESS_DESCRIPTIONS | BUSINESS_NAMES | '
                     'BUSINESS_GLOSSARY_ASSOCIATIONS']}}

Lists all metadata generation runs.

Metadata generation runs represent automated processes that leverage AI/ML capabilities to create or enhance asset metadata at scale. This feature helps organizations maintain comprehensive and consistent metadata across large numbers of assets without manual intervention. It can automatically generate business descriptions, tags, and other metadata elements, significantly reducing the time and effort required for metadata management while improving consistency and completeness.

Prerequisites:

Valid domain identifier.
User must have access to metadata generation runs in the domain.

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'|'PARTIALLY_SUCCEEDED',
    targetIdentifier='string',
    type='BUSINESS_DESCRIPTIONS'|'BUSINESS_NAMES'|'BUSINESS_GLOSSARY_ASSOCIATIONS'
)

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 targetIdentifier:

string

param targetIdentifier:

The target ID for which you want to list 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'|'PARTIALLY_SUCCEEDED',
            'target': {
                'identifier': 'string',
                'revision': 'string',
                'type': 'ASSET'
            },
            'type': 'BUSINESS_DESCRIPTIONS'|'BUSINESS_NAMES'|'BUSINESS_GLOSSARY_ASSOCIATIONS',
            'types': [
                'BUSINESS_DESCRIPTIONS'|'BUSINESS_NAMES'|'BUSINESS_GLOSSARY_ASSOCIATIONS',
            ]
        },
    ],
    '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.
    - types (list) --
      
      The types of the metadata generation run.
      - (string) --
- 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.

StartMetadataGenerationRun (updated)

Link ¶
Changes (request, response)
Request

{'type': {'BUSINESS_GLOSSARY_ASSOCIATIONS', 'BUSINESS_NAMES'},
 'types': ['BUSINESS_DESCRIPTIONS | BUSINESS_NAMES | '
           'BUSINESS_GLOSSARY_ASSOCIATIONS']}

Response

{'status': {'PARTIALLY_SUCCEEDED'},
 'type': {'BUSINESS_GLOSSARY_ASSOCIATIONS', 'BUSINESS_NAMES'},
 'types': ['BUSINESS_DESCRIPTIONS | BUSINESS_NAMES | '
           'BUSINESS_GLOSSARY_ASSOCIATIONS']}

Starts the metadata generation run.

Prerequisites:

Asset must be created and belong to the specified domain and project.
Asset type must be supported for metadata generation (e.g., Amazon Web Services Glue table).
Asset must have a structured schema with valid rows and columns.
Valid values for --type: BUSINESS_DESCRIPTIONS, BUSINESS_NAMES, BUSINESS_GLOSSARY_ASSOCIATIONS.
The user must have permission to run metadata generation in the domain/project.

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'|'BUSINESS_NAMES'|'BUSINESS_GLOSSARY_ASSOCIATIONS',
    types=[
        'BUSINESS_DESCRIPTIONS'|'BUSINESS_NAMES'|'BUSINESS_GLOSSARY_ASSOCIATIONS',
    ]
)

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:

The type of the metadata generation run.

type types:

list

param types:

The types of the metadata generation run.

(string) --

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'|'PARTIALLY_SUCCEEDED',
    'type': 'BUSINESS_DESCRIPTIONS'|'BUSINESS_NAMES'|'BUSINESS_GLOSSARY_ASSOCIATIONS',
    'types': [
        'BUSINESS_DESCRIPTIONS'|'BUSINESS_NAMES'|'BUSINESS_GLOSSARY_ASSOCIATIONS',
    ]
}

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.
- types (list) --
  
  The types of the metadata generation run.
  - (string) --