Skip to content

Commit

Permalink
updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
meyertst-aws committed Oct 16, 2023
1 parent d28ccb8 commit 7258f60
Showing 1 changed file with 63 additions and 19 deletions.
82 changes: 63 additions & 19 deletions python/example_code/medical-imaging/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<!--Generated by WRITEME on 2023-10-13 17:49:16.323539 (UTC)-->
<!--Generated by WRITEME on 2023-10-13 15:13:29.277439 (UTC)-->
# HealthImaging code examples for the SDK for Python

## Overview
Expand Down Expand Up @@ -39,24 +39,32 @@ python -m pip install -r requirements.txt

Code excerpts that show you how to call individual service functions.

* [Add a tag to a resource](medical_imaging_basics.py#L391) (`TagResource`)
* [Copy an image set](medical_imaging_basics.py#L337) (`CopyImageSet`)
* [Create a data store](medical_imaging_basics.py#L21) (`CreateDatastore`)
* [Delete a data store](medical_imaging_basics.py#L84) (`DeleteDatastore`)
* [Delete an image set](medical_imaging_basics.py#L369) (`DeleteImageSet`)
* [Get an image frame](medical_imaging_basics.py#L257) (`GetImageFrame`)
* [Get data store properties](medical_imaging_basics.py#L41) (`GetDatastore`)
* [Get image set properties](medical_imaging_basics.py#L202) (`GetImageSet`)
* [Get import job properties](medical_imaging_basics.py#L131) (`GetDICOMImportJob`)
* [Get metadata for an image set](medical_imaging_basics.py#L225) (`GetImageSetMetadata`)
* [Import bulk data into a data store](medical_imaging_basics.py#L101) (`StartDICOMImportJob`)
* [List data stores](medical_imaging_basics.py#L61) (`ListDatastores`)
* [List image set versions](medical_imaging_basics.py#L284) (`ListImageSetVersions`)
* [List import jobs for a data store](medical_imaging_basics.py#L152) (`ListDICOMImportJobs`)
* [List tags for a resource](medical_imaging_basics.py#L427) (`ListTagsForResource`)
* [Remove a tag from a resource](medical_imaging_basics.py#L409) (`UntagResource`)
* [Search image sets](medical_imaging_basics.py#L176) (`SearchImageSets`)
* [Update image set metadata](medical_imaging_basics.py#L310) (`UpdateImageSetMetadata`)
* [Add a tag to a resource](medical_imaging_basics.py#L411) (`TagResource`)
* [Copy an image set](medical_imaging_basics.py#L351) (`CopyImageSet`)
* [Create a data store](medical_imaging_basics.py#L27) (`CreateDatastore`)
* [Delete a data store](medical_imaging_basics.py#L90) (`DeleteDatastore`)
* [Delete an image set](medical_imaging_basics.py#L389) (`DeleteImageSet`)
* [Get an image frame](medical_imaging_basics.py#L271) (`GetImageFrame`)
* [Get data store properties](medical_imaging_basics.py#L47) (`GetDatastore`)
* [Get image set properties](medical_imaging_basics.py#L208) (`GetImageSet`)
* [Get import job properties](medical_imaging_basics.py#L137) (`GetDICOMImportJob`)
* [Get metadata for an image set](medical_imaging_basics.py#L234) (`GetImageSetMetadata`)
* [Import bulk data into a data store](medical_imaging_basics.py#L107) (`StartDICOMImportJob`)
* [List data stores](medical_imaging_basics.py#L67) (`ListDatastores`)
* [List image set versions](medical_imaging_basics.py#L298) (`ListImageSetVersions`)
* [List import jobs for a data store](medical_imaging_basics.py#L158) (`ListDICOMImportJobs`)
* [List tags for a resource](medical_imaging_basics.py#L447) (`ListTagsForResource`)
* [Remove a tag from a resource](medical_imaging_basics.py#L429) (`UntagResource`)
* [Search image sets](medical_imaging_basics.py#L182) (`SearchImageSets`)
* [Update image set metadata](medical_imaging_basics.py#L234) (`UpdateImageSetMetadata`)

### Scenarios

Code examples that show you how to accomplish a specific task by calling multiple
functions within the same service.

* [Tagging a data store](medical_imaging_basics.py)
* [Tagging an image set](medical_imaging_basics.py)

## Run the examples

Expand All @@ -68,6 +76,42 @@ Code excerpts that show you how to call individual service functions.



#### Tagging a data store

This example shows you how to tag a HealthImaging data store.


<!--custom.scenario_prereqs.medical-imaging_tagging_datastores.start-->
<!--custom.scenario_prereqs.medical-imaging_tagging_datastores.end-->

Start the example by running the following at a command prompt:

```
python medical_imaging_basics.py
```


<!--custom.scenarios.medical-imaging_tagging_datastores.start-->
<!--custom.scenarios.medical-imaging_tagging_datastores.end-->

#### Tagging an image set

This example shows you how to tag a HealthImaging image set.


<!--custom.scenario_prereqs.medical-imaging_tagging_imagesets.start-->
<!--custom.scenario_prereqs.medical-imaging_tagging_imagesets.end-->

Start the example by running the following at a command prompt:

```
python medical_imaging_basics.py
```


<!--custom.scenarios.medical-imaging_tagging_imagesets.start-->
<!--custom.scenarios.medical-imaging_tagging_imagesets.end-->

### Tests

⚠ Running tests might result in charges to your AWS account.
Expand Down

0 comments on commit 7258f60

Please sign in to comment.