DataZone / Client / list_metadata_generation_runs

list_metadata_generation_runs#

DataZone.Client.list_metadata_generation_runs(**kwargs)#

Lists all metadata generation runs.

Request Syntax

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

Parameters:

domainIdentifier (string) –
[REQUIRED]

The ID of the Amazon DataZone domain where you want to list metadata generation runs.
maxResults (integer) – 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.
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.
status (string) – The status of the metadata generation runs.
type (string) – The type of the metadata generation runs.

Return type:

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.

Exceptions

DataZone.Client.exceptions.InternalServerException
DataZone.Client.exceptions.ResourceNotFoundException
DataZone.Client.exceptions.AccessDeniedException
DataZone.Client.exceptions.ThrottlingException
DataZone.Client.exceptions.ValidationException
DataZone.Client.exceptions.UnauthorizedException