HealthLake / Client / list_data_transformation_profiles

list_data_transformation_profiles¶

HealthLake.Client.list_data_transformation_profiles(**kwargs)¶

Lists all data transformation profiles in your account, returning the latest version summary for each. Use GetDataTransformationProfile to retrieve profile content. Results are paginated. Use the NextToken parameter to retrieve additional results.

Request Syntax

response = client.list_data_transformation_profiles(
    SourceFormat='CCDA'|'CSV',
    MaxResults=123,
    NextToken='string'
)

Parameters:

SourceFormat (string) –
[REQUIRED]

Filters the results by source data format.
MaxResults (integer) – The maximum number of profiles to return per page. If you don’t specify a value, the service returns up to 100 results.
NextToken (string) – The pagination token from a previous response. Pass this value to retrieve the next page of results.

Return type:

dict

Returns:

Response Syntax

{
    'Items': [
        {
            'ProfileId': 'string',
            'Version': 123,
            'SourceFormat': 'CCDA'|'CSV',
            'TargetFormat': 'FHIR_R4',
            'ProfileName': 'string',
            'ProfileDescription': 'string',
            'LastUpdatedAt': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –

The response from the ListDataTransformationProfiles operation.
- Items (list) –
  
  The list of data transformation profile summaries.
  - (dict) –
    
    Contains summary information about a data transformation profile. To retrieve profile content, call GetDataTransformationProfile.
    - ProfileId (string) –
      
      The unique identifier of the profile.
    - Version (integer) –
      
      The latest version number of the profile.
    - SourceFormat (string) –
      
      The source data format that this profile converts from.
    - TargetFormat (string) –
      
      The target output format of the profile.
    - ProfileName (string) –
      
      The name of the profile.
    - ProfileDescription (string) –
      
      A description of the profile’s purpose.
    - LastUpdatedAt (datetime) –
      
      The timestamp when the profile was last updated.
- NextToken (string) –
  
  The pagination token to use in the next request. If this value is null, there are no more results.

Exceptions

HealthLake.Client.exceptions.ThrottlingException
HealthLake.Client.exceptions.AccessDeniedException
HealthLake.Client.exceptions.ValidationException
HealthLake.Client.exceptions.InternalServerException