Skip to content

Commit 77d7240

Browse files
author
awstools
committed
feat(client-healthlake): This release adds a new response parameter, JobProgressReport, to the DescribeFHIRImportJob and ListFHIRImportJobs API operation. JobProgressReport provides details on the progress of the import job on the server.
1 parent bfe260b commit 77d7240

File tree

5 files changed

+174
-6
lines changed

5 files changed

+174
-6
lines changed

‎clients/client-healthlake/src/commands/DescribeFHIRImportJobCommand.ts

+10
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,16 @@ export interface DescribeFHIRImportJobCommandOutput extends DescribeFHIRImportJo
5858
* // KmsKeyId: "STRING_VALUE", // required
5959
* // },
6060
* // },
61+
* // JobProgressReport: { // JobProgressReport
62+
* // TotalNumberOfScannedFiles: Number("long"),
63+
* // TotalSizeOfScannedFilesInMB: Number("double"),
64+
* // TotalNumberOfImportedFiles: Number("long"),
65+
* // TotalNumberOfResourcesScanned: Number("long"),
66+
* // TotalNumberOfResourcesImported: Number("long"),
67+
* // TotalNumberOfResourcesWithCustomerError: Number("long"),
68+
* // TotalNumberOfFilesReadWithCustomerError: Number("long"),
69+
* // Throughput: Number("double"),
70+
* // },
6171
* // DataAccessRoleArn: "STRING_VALUE",
6272
* // Message: "STRING_VALUE",
6373
* // },

‎clients/client-healthlake/src/commands/ListFHIRImportJobsCommand.ts

+10
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,16 @@ export interface ListFHIRImportJobsCommandOutput extends ListFHIRImportJobsRespo
6666
* // KmsKeyId: "STRING_VALUE", // required
6767
* // },
6868
* // },
69+
* // JobProgressReport: { // JobProgressReport
70+
* // TotalNumberOfScannedFiles: Number("long"),
71+
* // TotalSizeOfScannedFilesInMB: Number("double"),
72+
* // TotalNumberOfImportedFiles: Number("long"),
73+
* // TotalNumberOfResourcesScanned: Number("long"),
74+
* // TotalNumberOfResourcesImported: Number("long"),
75+
* // TotalNumberOfResourcesWithCustomerError: Number("long"),
76+
* // TotalNumberOfFilesReadWithCustomerError: Number("long"),
77+
* // Throughput: Number("double"),
78+
* // },
6979
* // DataAccessRoleArn: "STRING_VALUE",
7080
* // Message: "STRING_VALUE",
7181
* // },

‎clients/client-healthlake/src/models/models_0.ts

+63-3
Original file line numberDiff line numberDiff line change
@@ -798,7 +798,61 @@ export namespace InputDataConfig {
798798

799799
/**
800800
* @public
801-
* <p>Displays the properties of the import job, including the ID, Arn, Name, and the status of the data store.</p>
801+
* <p>The progress report of an import job.</p>
802+
*/
803+
export interface JobProgressReport {
804+
/**
805+
* @public
806+
* <p>The number of files scanned from input S3 bucket.</p>
807+
*/
808+
TotalNumberOfScannedFiles?: number;
809+
810+
/**
811+
* @public
812+
* <p>The size (in MB) of the files scanned from the input S3 bucket.</p>
813+
*/
814+
TotalSizeOfScannedFilesInMB?: number;
815+
816+
/**
817+
* @public
818+
* <p>The number of files imported so far.</p>
819+
*/
820+
TotalNumberOfImportedFiles?: number;
821+
822+
/**
823+
* @public
824+
* <p>The number of resources scanned from the input S3 bucket.</p>
825+
*/
826+
TotalNumberOfResourcesScanned?: number;
827+
828+
/**
829+
* @public
830+
* <p>The number of resources imported so far.</p>
831+
*/
832+
TotalNumberOfResourcesImported?: number;
833+
834+
/**
835+
* @public
836+
* <p>The number of resources that failed due to customer error.</p>
837+
*/
838+
TotalNumberOfResourcesWithCustomerError?: number;
839+
840+
/**
841+
* @public
842+
* <p>The number of files that failed to be read from the input S3 bucket due to customer error.</p>
843+
*/
844+
TotalNumberOfFilesReadWithCustomerError?: number;
845+
846+
/**
847+
* @public
848+
* <p>The throughput (in MB/sec) of the import job.</p>
849+
*/
850+
Throughput?: number;
851+
}
852+
853+
/**
854+
* @public
855+
* <p>Displays the properties of the import job, including the ID, Arn, Name, the status of the job, and the progress report of the job.</p>
802856
*/
803857
export interface ImportJobProperties {
804858
/**
@@ -849,6 +903,12 @@ export interface ImportJobProperties {
849903
*/
850904
JobOutputDataConfig?: OutputDataConfig;
851905

906+
/**
907+
* @public
908+
* <p>Displays the progress of the import job, including total resources scanned, total resources ingested, and total size of data ingested.</p>
909+
*/
910+
JobProgressReport?: JobProgressReport;
911+
852912
/**
853913
* @public
854914
* <p>The Amazon Resource Name (ARN) that gives AWS HealthLake access to your input data.</p>
@@ -868,7 +928,7 @@ export interface ImportJobProperties {
868928
export interface DescribeFHIRImportJobResponse {
869929
/**
870930
* @public
871-
* <p>The properties of the Import job request, including the ID, ARN, name, and the status of the job.</p>
931+
* <p>The properties of the Import job request, including the ID, ARN, name, status of the job, and the progress report of the job.</p>
872932
*/
873933
ImportJobProperties: ImportJobProperties | undefined;
874934
}
@@ -1063,7 +1123,7 @@ export interface ListFHIRImportJobsResponse {
10631123
/**
10641124
* @public
10651125
* <p>
1066-
* The properties of a listed FHIR import jobs, including the ID, ARN, name, and the status of the job.
1126+
* The properties of a listed FHIR import jobs, including the ID, ARN, name, the status of the job, and the progress report of the job.
10671127
* </p>
10681128
*/
10691129
ImportJobPropertiesList: ImportJobProperties[] | undefined;

‎clients/client-healthlake/src/protocols/Aws_json1_0.ts

+20
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,11 @@ import {
55
_json,
66
collectBody,
77
decorateServiceException as __decorateServiceException,
8+
expectLong as __expectLong,
89
expectNonNull as __expectNonNull,
910
expectNumber as __expectNumber,
1011
expectString as __expectString,
12+
limitedParseDouble as __limitedParseDouble,
1113
parseEpochTimestamp as __parseEpochTimestamp,
1214
take,
1315
withBaseException,
@@ -70,6 +72,7 @@ import {
7072
ImportJobProperties,
7173
InputDataConfig,
7274
InternalServerException,
75+
JobProgressReport,
7376
KmsEncryptionConfig,
7477
ListFHIRDatastoresRequest,
7578
ListFHIRDatastoresResponse,
@@ -883,6 +886,7 @@ const de_ImportJobProperties = (output: any, context: __SerdeContext): ImportJob
883886
JobId: __expectString,
884887
JobName: __expectString,
885888
JobOutputDataConfig: (_: any) => _json(__expectUnion(_)),
889+
JobProgressReport: (_: any) => de_JobProgressReport(_, context),
886890
JobStatus: __expectString,
887891
Message: __expectString,
888892
SubmitTime: (_: any) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
@@ -905,6 +909,22 @@ const de_ImportJobPropertiesList = (output: any, context: __SerdeContext): Impor
905909

906910
// de_InternalServerException omitted.
907911

912+
/**
913+
* deserializeAws_json1_0JobProgressReport
914+
*/
915+
const de_JobProgressReport = (output: any, context: __SerdeContext): JobProgressReport => {
916+
return take(output, {
917+
Throughput: __limitedParseDouble,
918+
TotalNumberOfFilesReadWithCustomerError: __expectLong,
919+
TotalNumberOfImportedFiles: __expectLong,
920+
TotalNumberOfResourcesImported: __expectLong,
921+
TotalNumberOfResourcesScanned: __expectLong,
922+
TotalNumberOfResourcesWithCustomerError: __expectLong,
923+
TotalNumberOfScannedFiles: __expectLong,
924+
TotalSizeOfScannedFilesInMB: __limitedParseDouble,
925+
}) as any;
926+
};
927+
908928
// de_KmsEncryptionConfig omitted.
909929

910930
/**

‎codegen/sdk-codegen/aws-models/healthlake.json

+71-3
Original file line numberDiff line numberDiff line change
@@ -664,7 +664,7 @@
664664
"ImportJobProperties": {
665665
"target": "com.amazonaws.healthlake#ImportJobProperties",
666666
"traits": {
667-
"smithy.api#documentation": "<p>The properties of the Import job request, including the ID, ARN, name, and the status of the job.</p>",
667+
"smithy.api#documentation": "<p>The properties of the Import job request, including the ID, ARN, name, status of the job, and the progress report of the job.</p>",
668668
"smithy.api#required": {}
669669
}
670670
}
@@ -767,6 +767,12 @@
767767
}
768768
}
769769
},
770+
"com.amazonaws.healthlake#GenericDouble": {
771+
"type": "double"
772+
},
773+
"com.amazonaws.healthlake#GenericLong": {
774+
"type": "long"
775+
},
770776
"com.amazonaws.healthlake#HealthLake": {
771777
"type": "service",
772778
"version": "2017-07-01",
@@ -1578,6 +1584,12 @@
15781584
"JobOutputDataConfig": {
15791585
"target": "com.amazonaws.healthlake#OutputDataConfig"
15801586
},
1587+
"JobProgressReport": {
1588+
"target": "com.amazonaws.healthlake#JobProgressReport",
1589+
"traits": {
1590+
"smithy.api#documentation": "<p>Displays the progress of the import job, including total resources scanned, total resources ingested, and total size of data ingested.</p>"
1591+
}
1592+
},
15811593
"DataAccessRoleArn": {
15821594
"target": "com.amazonaws.healthlake#IamRoleArn",
15831595
"traits": {
@@ -1592,7 +1604,7 @@
15921604
}
15931605
},
15941606
"traits": {
1595-
"smithy.api#documentation": "<p>Displays the properties of the import job, including the ID, Arn, Name, and the status of the data store.</p>"
1607+
"smithy.api#documentation": "<p>Displays the properties of the import job, including the ID, Arn, Name, the status of the job, and the progress report of the job.</p>"
15961608
}
15971609
},
15981610
"com.amazonaws.healthlake#ImportJobPropertiesList": {
@@ -1648,6 +1660,62 @@
16481660
"smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-%@]*)$"
16491661
}
16501662
},
1663+
"com.amazonaws.healthlake#JobProgressReport": {
1664+
"type": "structure",
1665+
"members": {
1666+
"TotalNumberOfScannedFiles": {
1667+
"target": "com.amazonaws.healthlake#GenericLong",
1668+
"traits": {
1669+
"smithy.api#documentation": "<p>The number of files scanned from input S3 bucket.</p>"
1670+
}
1671+
},
1672+
"TotalSizeOfScannedFilesInMB": {
1673+
"target": "com.amazonaws.healthlake#GenericDouble",
1674+
"traits": {
1675+
"smithy.api#documentation": "<p>The size (in MB) of the files scanned from the input S3 bucket.</p>"
1676+
}
1677+
},
1678+
"TotalNumberOfImportedFiles": {
1679+
"target": "com.amazonaws.healthlake#GenericLong",
1680+
"traits": {
1681+
"smithy.api#documentation": "<p>The number of files imported so far.</p>"
1682+
}
1683+
},
1684+
"TotalNumberOfResourcesScanned": {
1685+
"target": "com.amazonaws.healthlake#GenericLong",
1686+
"traits": {
1687+
"smithy.api#documentation": "<p>The number of resources scanned from the input S3 bucket.</p>"
1688+
}
1689+
},
1690+
"TotalNumberOfResourcesImported": {
1691+
"target": "com.amazonaws.healthlake#GenericLong",
1692+
"traits": {
1693+
"smithy.api#documentation": "<p>The number of resources imported so far.</p>"
1694+
}
1695+
},
1696+
"TotalNumberOfResourcesWithCustomerError": {
1697+
"target": "com.amazonaws.healthlake#GenericLong",
1698+
"traits": {
1699+
"smithy.api#documentation": "<p>The number of resources that failed due to customer error.</p>"
1700+
}
1701+
},
1702+
"TotalNumberOfFilesReadWithCustomerError": {
1703+
"target": "com.amazonaws.healthlake#GenericLong",
1704+
"traits": {
1705+
"smithy.api#documentation": "<p>The number of files that failed to be read from the input S3 bucket due to customer error.</p>"
1706+
}
1707+
},
1708+
"Throughput": {
1709+
"target": "com.amazonaws.healthlake#GenericDouble",
1710+
"traits": {
1711+
"smithy.api#documentation": "<p>The throughput (in MB/sec) of the import job.</p>"
1712+
}
1713+
}
1714+
},
1715+
"traits": {
1716+
"smithy.api#documentation": "<p>The progress report of an import job.</p>"
1717+
}
1718+
},
16511719
"com.amazonaws.healthlake#JobStatus": {
16521720
"type": "enum",
16531721
"members": {
@@ -2010,7 +2078,7 @@
20102078
"ImportJobPropertiesList": {
20112079
"target": "com.amazonaws.healthlake#ImportJobPropertiesList",
20122080
"traits": {
2013-
"smithy.api#documentation": "<p>\n The properties of a listed FHIR import jobs, including the ID, ARN, name, and the status of the job.\n </p>",
2081+
"smithy.api#documentation": "<p>\n The properties of a listed FHIR import jobs, including the ID, ARN, name, the status of the job, and the progress report of the job.\n </p>",
20142082
"smithy.api#required": {}
20152083
}
20162084
},

0 commit comments

Comments
 (0)