{ "smithy": "2.0", "shapes": { "com.amazonaws.medicalimaging#AHIGatewayService": { "type": "service", "version": "2023-07-19", "operations": [ { "target": "com.amazonaws.medicalimaging#CopyImageSet" }, { "target": "com.amazonaws.medicalimaging#DeleteImageSet" }, { "target": "com.amazonaws.medicalimaging#GetDICOMImportJob" }, { "target": "com.amazonaws.medicalimaging#GetImageFrame" }, { "target": "com.amazonaws.medicalimaging#GetImageSet" }, { "target": "com.amazonaws.medicalimaging#GetImageSetMetadata" }, { "target": "com.amazonaws.medicalimaging#ListDICOMImportJobs" }, { "target": "com.amazonaws.medicalimaging#ListImageSetVersions" }, { "target": "com.amazonaws.medicalimaging#ListTagsForResource" }, { "target": "com.amazonaws.medicalimaging#SearchImageSets" }, { "target": "com.amazonaws.medicalimaging#StartDICOMImportJob" }, { "target": "com.amazonaws.medicalimaging#TagResource" }, { "target": "com.amazonaws.medicalimaging#UntagResource" }, { "target": "com.amazonaws.medicalimaging#UpdateImageSetMetadata" } ], "resources": [ { "target": "com.amazonaws.medicalimaging#DatastoreResource" }, { "target": "com.amazonaws.medicalimaging#ImageSetResource" } ], "traits": { "aws.api#service": { "sdkId": "Medical Imaging", "arnNamespace": "medical-imaging", "endpointPrefix": "medical-imaging" }, "aws.auth#sigv4": { "name": "medical-imaging" }, "aws.iam#defineConditionKeys": { "aws:ResourceTag/${TagKey}": { "type": "String", "documentation": "Filters access by a tag key and value pair of a resource" }, "aws:RequestTag/${TagKey}": { "type": "String", "documentation": "Filters access by a tag key and value pair that is allowed in the request" }, "aws:TagKeys": { "type": "String", "documentation": "Filters access by a list of tag keys that are allowed in the request" } }, "aws.protocols#restJson1": {}, "smithy.api#documentation": "
This is the AWS HealthImaging API Reference. For an introduction to the service, see What is AWS HealthImaging? in the AWS HealthImaging Developer Guide.
", "smithy.api#title": "AWS Health Imaging", "smithy.rules#endpointBdd": { "version": "1.1", "parameters": { "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" } }, "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] }, { "fn": "isSet", "argv": [ { "ref": "Region" } ] }, { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "results": [ { "conditions": [], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://medical-imaging-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://medical-imaging-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://medical-imaging.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://medical-imaging.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "root": 2, "nodeCount": 13, "nodes": "/////wAAAAH/////AAAAAAAAAAwAAAADAAAAAQAAAAQF9eELAAAAAgAAAAUF9eELAAAAAwAAAAgAAAAGAAAABAAAAAcF9eEKAAAABQX14QgF9eEJAAAABAAAAAoAAAAJAAAABgX14QYF9eEHAAAABQAAAAsF9eEFAAAABgX14QQF9eEFAAAAAwX14QEAAAANAAAABAX14QIF9eED" }, "smithy.rules#endpointRuleSet": { "version": "1.0", "parameters": { "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" } }, "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Region" } ] } ], "rules": [ { "conditions": [ { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] } ] }, { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "rules": [ { "conditions": [], "endpoint": { "url": "https://medical-imaging-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "rules": [ { "conditions": [], "rules": [ { "conditions": [], "endpoint": { "url": "https://medical-imaging-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "rules": [ { "conditions": [], "endpoint": { "url": "https://medical-imaging.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } ], "type": "tree" }, { "conditions": [], "rules": [ { "conditions": [], "endpoint": { "url": "https://medical-imaging.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "type": "tree" } ] }, "smithy.rules#endpointTests": { "testCases": [ { "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://medical-imaging-fips.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://medical-imaging-fips.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://medical-imaging.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://medical-imaging.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://medical-imaging-fips.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://medical-imaging-fips.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://medical-imaging.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://medical-imaging.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://medical-imaging-fips.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://medical-imaging-fips.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://medical-imaging.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://medical-imaging.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://medical-imaging-fips.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://medical-imaging.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://medical-imaging-fips.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://medical-imaging.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with fips enabled and dualstack disabled", "expect": { "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with fips disabled and dualstack enabled", "expect": { "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true, "Endpoint": "https://example.com" } }, { "documentation": "Missing region", "expect": { "error": "Invalid Configuration: Missing Region" } } ], "version": "1.0" } } }, "com.amazonaws.medicalimaging#AccessDeniedException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The user does not have sufficient access to perform this action.
", "smithy.api#error": "client", "smithy.api#httpError": 403 } }, "com.amazonaws.medicalimaging#Arn": { "type": "string", "traits": { "smithy.api#pattern": "^arn:aws((-us-gov)|(-iso)|(-iso-b)|(-cn))?:medical-imaging:[a-z0-9-]+:[0-9]{12}:datastore/[0-9a-z]{32}(/imageset/[0-9a-z]{32})?$" } }, "com.amazonaws.medicalimaging#AwsAccountId": { "type": "string", "traits": { "smithy.api#length": { "min": 12, "max": 12 }, "smithy.api#pattern": "^\\d+$" } }, "com.amazonaws.medicalimaging#BadRequestException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The request is invalid or malformed.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.medicalimaging#ClientToken": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^[A-Za-z0-9._-]+$" } }, "com.amazonaws.medicalimaging#ConflictException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Updating or deleting a resource can cause an inconsistent state.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.medicalimaging#CopiableAttributes": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 260000 }, "smithy.api#sensitive": {} } }, "com.amazonaws.medicalimaging#CopyDestinationImageSet": { "type": "structure", "members": { "imageSetId": { "target": "com.amazonaws.medicalimaging#ImageSetId", "traits": { "smithy.api#documentation": "The image set identifier for the destination image set.
", "smithy.api#required": {} } }, "latestVersionId": { "target": "com.amazonaws.medicalimaging#ImageSetExternalVersionId", "traits": { "smithy.api#documentation": "The latest version identifier for the destination image set.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Copy the destination image set.
" } }, "com.amazonaws.medicalimaging#CopyDestinationImageSetProperties": { "type": "structure", "members": { "imageSetId": { "target": "com.amazonaws.medicalimaging#ImageSetId", "traits": { "smithy.api#documentation": "The image set identifier of the copied image set properties.
", "smithy.api#required": {} } }, "latestVersionId": { "target": "com.amazonaws.medicalimaging#ImageSetExternalVersionId", "traits": { "smithy.api#documentation": "The latest version identifier for the destination image set properties.
", "smithy.api#required": {} } }, "imageSetState": { "target": "com.amazonaws.medicalimaging#ImageSetState", "traits": { "smithy.api#documentation": "The image set state of the destination image set properties.
" } }, "imageSetWorkflowStatus": { "target": "com.amazonaws.medicalimaging#ImageSetWorkflowStatus", "traits": { "smithy.api#documentation": "The image set workflow status of the destination image set properties.
" } }, "createdAt": { "target": "com.amazonaws.medicalimaging#Date", "traits": { "smithy.api#documentation": "The timestamp when the destination image set properties were created.
" } }, "updatedAt": { "target": "com.amazonaws.medicalimaging#Date", "traits": { "smithy.api#documentation": "The timestamp when the destination image set properties were last updated.
" } }, "imageSetArn": { "target": "com.amazonaws.medicalimaging#Arn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) assigned to the destination image set.
" } } }, "traits": { "smithy.api#documentation": "Copy the image set properties of the destination image set.
" } }, "com.amazonaws.medicalimaging#CopyImageSet": { "type": "operation", "input": { "target": "com.amazonaws.medicalimaging#CopyImageSetRequest" }, "output": { "target": "com.amazonaws.medicalimaging#CopyImageSetResponse" }, "errors": [ { "target": "com.amazonaws.medicalimaging#AccessDeniedException" }, { "target": "com.amazonaws.medicalimaging#ConflictException" }, { "target": "com.amazonaws.medicalimaging#InternalServerException" }, { "target": "com.amazonaws.medicalimaging#ResourceNotFoundException" }, { "target": "com.amazonaws.medicalimaging#ServiceQuotaExceededException" }, { "target": "com.amazonaws.medicalimaging#ThrottlingException" }, { "target": "com.amazonaws.medicalimaging#ValidationException" } ], "traits": { "smithy.api#documentation": "Copy an image set.
", "smithy.api#endpoint": { "hostPrefix": "runtime-" }, "smithy.api#http": { "uri": "/datastore/{datastoreId}/imageSet/{sourceImageSetId}/copyImageSet", "method": "POST" } } }, "com.amazonaws.medicalimaging#CopyImageSetInformation": { "type": "structure", "members": { "sourceImageSet": { "target": "com.amazonaws.medicalimaging#CopySourceImageSetInformation", "traits": { "smithy.api#documentation": "The source image set.
", "smithy.api#required": {} } }, "destinationImageSet": { "target": "com.amazonaws.medicalimaging#CopyDestinationImageSet", "traits": { "smithy.api#documentation": "The destination image set.
" } } }, "traits": { "smithy.api#documentation": "Copy image set information.
" } }, "com.amazonaws.medicalimaging#CopyImageSetRequest": { "type": "structure", "members": { "datastoreId": { "target": "com.amazonaws.medicalimaging#DatastoreId", "traits": { "smithy.api#documentation": "The data store identifier.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "sourceImageSetId": { "target": "com.amazonaws.medicalimaging#ImageSetId", "traits": { "smithy.api#documentation": "The source image set identifier.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "copyImageSetInformation": { "target": "com.amazonaws.medicalimaging#CopyImageSetInformation", "traits": { "smithy.api#documentation": "Copy image set information.
", "smithy.api#httpPayload": {}, "smithy.api#required": {} } }, "force": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "Providing this parameter will force completion of the CopyImageSet operation, even if there are inconsistent Patient, Study, and/or Series level metadata elements between the sourceImageSet and destinationImageSet.
Providing this parameter will configure the CopyImageSet operation to promote the given image set to the primary DICOM hierarchy. If successful, a new primary image set ID will be returned as the destination image set.
The data store identifier.
", "smithy.api#required": {} } }, "sourceImageSetProperties": { "target": "com.amazonaws.medicalimaging#CopySourceImageSetProperties", "traits": { "smithy.api#documentation": "The properties of the source image set.
", "smithy.api#required": {} } }, "destinationImageSetProperties": { "target": "com.amazonaws.medicalimaging#CopyDestinationImageSetProperties", "traits": { "smithy.api#documentation": "The properties of the destination image set.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.medicalimaging#CopySourceImageSetInformation": { "type": "structure", "members": { "latestVersionId": { "target": "com.amazonaws.medicalimaging#ImageSetExternalVersionId", "traits": { "smithy.api#documentation": "The latest version identifier for the source image set.
", "smithy.api#required": {} } }, "DICOMCopies": { "target": "com.amazonaws.medicalimaging#MetadataCopies", "traits": { "smithy.api#documentation": "Contains MetadataCopies structure and wraps information related to specific copy use cases. For example, when copying subsets.
Copy source image set information.
" } }, "com.amazonaws.medicalimaging#CopySourceImageSetProperties": { "type": "structure", "members": { "imageSetId": { "target": "com.amazonaws.medicalimaging#ImageSetId", "traits": { "smithy.api#documentation": "The image set identifier for the copied source image set.
", "smithy.api#required": {} } }, "latestVersionId": { "target": "com.amazonaws.medicalimaging#ImageSetExternalVersionId", "traits": { "smithy.api#documentation": "The latest version identifier for the copied source image set.
", "smithy.api#required": {} } }, "imageSetState": { "target": "com.amazonaws.medicalimaging#ImageSetState", "traits": { "smithy.api#documentation": "The image set state of the copied source image set.
" } }, "imageSetWorkflowStatus": { "target": "com.amazonaws.medicalimaging#ImageSetWorkflowStatus", "traits": { "smithy.api#documentation": "The workflow status of the copied source image set.
" } }, "createdAt": { "target": "com.amazonaws.medicalimaging#Date", "traits": { "smithy.api#documentation": "The timestamp when the source image set properties were created.
" } }, "updatedAt": { "target": "com.amazonaws.medicalimaging#Date", "traits": { "smithy.api#documentation": "The timestamp when the source image set properties were updated.
" } }, "imageSetArn": { "target": "com.amazonaws.medicalimaging#Arn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) assigned to the source image set.
" } } }, "traits": { "smithy.api#documentation": "Copy source image set properties.
" } }, "com.amazonaws.medicalimaging#CreateDatastore": { "type": "operation", "input": { "target": "com.amazonaws.medicalimaging#CreateDatastoreRequest" }, "output": { "target": "com.amazonaws.medicalimaging#CreateDatastoreResponse" }, "errors": [ { "target": "com.amazonaws.medicalimaging#AccessDeniedException" }, { "target": "com.amazonaws.medicalimaging#ConflictException" }, { "target": "com.amazonaws.medicalimaging#InternalServerException" }, { "target": "com.amazonaws.medicalimaging#ResourceNotFoundException" }, { "target": "com.amazonaws.medicalimaging#ServiceQuotaExceededException" }, { "target": "com.amazonaws.medicalimaging#ThrottlingException" }, { "target": "com.amazonaws.medicalimaging#ValidationException" } ], "traits": { "aws.iam#conditionKeys": [ "aws:RequestTag/${TagKey}", "aws:TagKeys" ], "smithy.api#documentation": "Create a data store.
", "smithy.api#http": { "method": "POST", "uri": "/datastore" }, "smithy.api#idempotent": {} } }, "com.amazonaws.medicalimaging#CreateDatastoreRequest": { "type": "structure", "members": { "datastoreName": { "target": "com.amazonaws.medicalimaging#DatastoreName", "traits": { "smithy.api#documentation": "The data store name.
" } }, "clientToken": { "target": "com.amazonaws.medicalimaging#ClientToken", "traits": { "smithy.api#documentation": "A unique identifier for API idempotency.
", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.medicalimaging#TagMap", "traits": { "smithy.api#documentation": "The tags provided when creating a data store.
" } }, "kmsKeyArn": { "target": "com.amazonaws.medicalimaging#KmsKeyArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) assigned to the Key Management Service (KMS) key for accessing encrypted data.
" } }, "lambdaAuthorizerArn": { "target": "com.amazonaws.medicalimaging#LambdaArn", "traits": { "smithy.api#documentation": "The ARN of the authorizer's Lambda function.
" } }, "losslessStorageFormat": { "target": "com.amazonaws.medicalimaging#LosslessStorageFormat", "traits": { "smithy.api#documentation": "The lossless storage format for the datastore.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.medicalimaging#CreateDatastoreResponse": { "type": "structure", "members": { "datastoreId": { "target": "com.amazonaws.medicalimaging#DatastoreId", "traits": { "smithy.api#documentation": "The data store identifier.
", "smithy.api#required": {} } }, "datastoreStatus": { "target": "com.amazonaws.medicalimaging#DatastoreStatus", "traits": { "smithy.api#documentation": "The data store status.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.medicalimaging#DICOMAccessionNumber": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 512 }, "smithy.api#sensitive": {} } }, "com.amazonaws.medicalimaging#DICOMAttribute": { "type": "blob", "traits": { "smithy.api#length": { "min": 1, "max": 30000 }, "smithy.api#sensitive": {} } }, "com.amazonaws.medicalimaging#DICOMImportJobProperties": { "type": "structure", "members": { "jobId": { "target": "com.amazonaws.medicalimaging#JobId", "traits": { "smithy.api#documentation": "The import job identifier.
", "smithy.api#required": {} } }, "jobName": { "target": "com.amazonaws.medicalimaging#JobName", "traits": { "smithy.api#documentation": "The import job name.
", "smithy.api#required": {} } }, "jobStatus": { "target": "com.amazonaws.medicalimaging#JobStatus", "traits": { "smithy.api#documentation": "The filters for listing import jobs based on status.
", "smithy.api#required": {} } }, "datastoreId": { "target": "com.amazonaws.medicalimaging#DatastoreId", "traits": { "smithy.api#documentation": "The data store identifier.
", "smithy.api#required": {} } }, "dataAccessRoleArn": { "target": "com.amazonaws.medicalimaging#RoleArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) that grants permissions to access medical imaging resources.
", "smithy.api#required": {} } }, "endedAt": { "target": "com.amazonaws.medicalimaging#Date", "traits": { "smithy.api#documentation": "The timestamp for when the import job was ended.
" } }, "submittedAt": { "target": "com.amazonaws.medicalimaging#Date", "traits": { "smithy.api#documentation": "The timestamp for when the import job was submitted.
" } }, "inputS3Uri": { "target": "com.amazonaws.medicalimaging#S3Uri", "traits": { "smithy.api#documentation": "The input prefix path for the S3 bucket that contains the DICOM P10 files to be imported.
", "smithy.api#required": {} } }, "outputS3Uri": { "target": "com.amazonaws.medicalimaging#S3Uri", "traits": { "smithy.api#documentation": "The output prefix of the S3 bucket to upload the results of the DICOM import job.
", "smithy.api#required": {} } }, "message": { "target": "com.amazonaws.medicalimaging#Message", "traits": { "smithy.api#documentation": "The error message thrown if an import job fails.
" } }, "importConfiguration": { "target": "com.amazonaws.medicalimaging#ImportConfiguration", "traits": { "smithy.api#documentation": "The object containing DicomJsonMetadataImportConfiguration.
Properties of the import job.
" } }, "com.amazonaws.medicalimaging#DICOMImportJobSummaries": { "type": "list", "member": { "target": "com.amazonaws.medicalimaging#DICOMImportJobSummary" } }, "com.amazonaws.medicalimaging#DICOMImportJobSummary": { "type": "structure", "members": { "jobId": { "target": "com.amazonaws.medicalimaging#JobId", "traits": { "smithy.api#documentation": "The import job identifier.
", "smithy.api#required": {} } }, "jobName": { "target": "com.amazonaws.medicalimaging#JobName", "traits": { "smithy.api#documentation": "The import job name.
", "smithy.api#required": {} } }, "jobStatus": { "target": "com.amazonaws.medicalimaging#JobStatus", "traits": { "smithy.api#documentation": "The filters for listing import jobs based on status.
", "smithy.api#required": {} } }, "datastoreId": { "target": "com.amazonaws.medicalimaging#DatastoreId", "traits": { "smithy.api#documentation": "The data store identifier.
", "smithy.api#required": {} } }, "dataAccessRoleArn": { "target": "com.amazonaws.medicalimaging#RoleArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) that grants permissions to access medical imaging resources.
" } }, "endedAt": { "target": "com.amazonaws.medicalimaging#Date", "traits": { "smithy.api#documentation": "The timestamp when an import job ended.
" } }, "submittedAt": { "target": "com.amazonaws.medicalimaging#Date", "traits": { "smithy.api#documentation": "The timestamp when an import job was submitted.
" } }, "message": { "target": "com.amazonaws.medicalimaging#Message", "traits": { "smithy.api#documentation": "The error message thrown if an import job fails.
" } } }, "traits": { "smithy.api#documentation": "Summary of import job.
" } }, "com.amazonaws.medicalimaging#DICOMNumberOfStudyRelatedInstances": { "type": "integer", "traits": { "smithy.api#default": 0, "smithy.api#range": { "min": 0, "max": 1000000 } } }, "com.amazonaws.medicalimaging#DICOMNumberOfStudyRelatedSeries": { "type": "integer", "traits": { "smithy.api#default": 0, "smithy.api#range": { "min": 0, "max": 1000000 } } }, "com.amazonaws.medicalimaging#DICOMPatientBirthDate": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 36 }, "smithy.api#sensitive": {} } }, "com.amazonaws.medicalimaging#DICOMPatientId": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 512 }, "smithy.api#sensitive": {} } }, "com.amazonaws.medicalimaging#DICOMPatientName": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 512 }, "smithy.api#sensitive": {} } }, "com.amazonaws.medicalimaging#DICOMPatientSex": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 16 }, "smithy.api#sensitive": {} } }, "com.amazonaws.medicalimaging#DICOMSeriesBodyPart": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 128 }, "smithy.api#sensitive": {} } }, "com.amazonaws.medicalimaging#DICOMSeriesInstanceUID": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 512 }, "smithy.api#pattern": "^[0-9.]+$", "smithy.api#sensitive": {} } }, "com.amazonaws.medicalimaging#DICOMSeriesModality": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 32 }, "smithy.api#sensitive": {} } }, "com.amazonaws.medicalimaging#DICOMSeriesNumber": { "type": "integer", "traits": { "smithy.api#range": { "min": -2147483648, "max": 2147483647 }, "smithy.api#sensitive": {} } }, "com.amazonaws.medicalimaging#DICOMStudyDate": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 36 }, "smithy.api#sensitive": {} } }, "com.amazonaws.medicalimaging#DICOMStudyDateAndTime": { "type": "structure", "members": { "DICOMStudyDate": { "target": "com.amazonaws.medicalimaging#DICOMStudyDate", "traits": { "smithy.api#documentation": "The DICOM study date provided in yyMMdd format.
The DICOM study time provided in HHmmss.FFFFFF format.
The aggregated structure to store DICOM study date and study time for search capabilities.
" } }, "com.amazonaws.medicalimaging#DICOMStudyDescription": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 512 }, "smithy.api#sensitive": {} } }, "com.amazonaws.medicalimaging#DICOMStudyId": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 512 }, "smithy.api#sensitive": {} } }, "com.amazonaws.medicalimaging#DICOMStudyInstanceUID": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 512 }, "smithy.api#pattern": "^[0-9.]+$", "smithy.api#sensitive": {} } }, "com.amazonaws.medicalimaging#DICOMStudyTime": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 56 }, "smithy.api#sensitive": {} } }, "com.amazonaws.medicalimaging#DICOMTags": { "type": "structure", "members": { "DICOMPatientId": { "target": "com.amazonaws.medicalimaging#DICOMPatientId", "traits": { "smithy.api#documentation": "The unique identifier for a patient in a DICOM Study.
" } }, "DICOMPatientName": { "target": "com.amazonaws.medicalimaging#DICOMPatientName", "traits": { "smithy.api#documentation": "The patient name.
" } }, "DICOMPatientBirthDate": { "target": "com.amazonaws.medicalimaging#DICOMPatientBirthDate", "traits": { "smithy.api#documentation": "The patient birth date.
" } }, "DICOMPatientSex": { "target": "com.amazonaws.medicalimaging#DICOMPatientSex", "traits": { "smithy.api#documentation": "The patient sex.
" } }, "DICOMStudyInstanceUID": { "target": "com.amazonaws.medicalimaging#DICOMStudyInstanceUID", "traits": { "smithy.api#documentation": "The DICOM provided identifier for the Study Instance UID.
" } }, "DICOMStudyId": { "target": "com.amazonaws.medicalimaging#DICOMStudyId", "traits": { "smithy.api#documentation": "The DICOM provided identifier for the Study ID.
" } }, "DICOMStudyDescription": { "target": "com.amazonaws.medicalimaging#DICOMStudyDescription", "traits": { "smithy.api#documentation": "The DICOM provided Study Description.
" } }, "DICOMNumberOfStudyRelatedSeries": { "target": "com.amazonaws.medicalimaging#DICOMNumberOfStudyRelatedSeries", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "The total number of series in the DICOM study.
" } }, "DICOMNumberOfStudyRelatedInstances": { "target": "com.amazonaws.medicalimaging#DICOMNumberOfStudyRelatedInstances", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "The total number of instances in the DICOM study.
" } }, "DICOMAccessionNumber": { "target": "com.amazonaws.medicalimaging#DICOMAccessionNumber", "traits": { "smithy.api#documentation": "The accession number for the DICOM study.
" } }, "DICOMSeriesInstanceUID": { "target": "com.amazonaws.medicalimaging#DICOMSeriesInstanceUID", "traits": { "smithy.api#documentation": "The DICOM provided identifier for the Series Instance UID.
" } }, "DICOMSeriesModality": { "target": "com.amazonaws.medicalimaging#DICOMSeriesModality", "traits": { "smithy.api#documentation": "The DICOM provided identifier for the series Modality.
" } }, "DICOMSeriesBodyPart": { "target": "com.amazonaws.medicalimaging#DICOMSeriesBodyPart", "traits": { "smithy.api#documentation": "The DICOM provided identifier for the series Body Part Examined.
" } }, "DICOMSeriesNumber": { "target": "com.amazonaws.medicalimaging#DICOMSeriesNumber", "traits": { "smithy.api#documentation": "The DICOM provided identifier for the Series Number.
" } }, "DICOMStudyDate": { "target": "com.amazonaws.medicalimaging#DICOMStudyDate", "traits": { "smithy.api#documentation": "The study date.
" } }, "DICOMStudyTime": { "target": "com.amazonaws.medicalimaging#DICOMStudyTime", "traits": { "smithy.api#documentation": "The study time.
" } } }, "traits": { "smithy.api#documentation": "The DICOM attributes returned as a part of a response. Each image set has these properties as part of a search result.
" } }, "com.amazonaws.medicalimaging#DICOMUpdates": { "type": "structure", "members": { "removableAttributes": { "target": "com.amazonaws.medicalimaging#DICOMAttribute", "traits": { "smithy.api#documentation": "The DICOM tags to be removed from ImageSetMetadata.
The DICOM tags that need to be updated in ImageSetMetadata.
The object containing removableAttributes and updatableAttributes.
The data store identifier.
", "smithy.api#required": {} } }, "datastoreName": { "target": "com.amazonaws.medicalimaging#DatastoreName", "traits": { "smithy.api#documentation": "The data store name.
", "smithy.api#required": {} } }, "datastoreStatus": { "target": "com.amazonaws.medicalimaging#DatastoreStatus", "traits": { "smithy.api#documentation": "The data store status.
", "smithy.api#required": {} } }, "kmsKeyArn": { "target": "com.amazonaws.medicalimaging#KmsKeyArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) assigned to the Key Management Service (KMS) key for accessing encrypted data.
" } }, "lambdaAuthorizerArn": { "target": "com.amazonaws.medicalimaging#LambdaArn", "traits": { "smithy.api#documentation": "The ARN of the authorizer's Lambda function.
" } }, "losslessStorageFormat": { "target": "com.amazonaws.medicalimaging#LosslessStorageFormat", "traits": { "smithy.api#documentation": "The datastore's lossless storage format.
" } }, "datastoreArn": { "target": "com.amazonaws.medicalimaging#Arn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) for the data store.
" } }, "createdAt": { "target": "com.amazonaws.medicalimaging#Date", "traits": { "smithy.api#documentation": "The timestamp when the data store was created.
" } }, "updatedAt": { "target": "com.amazonaws.medicalimaging#Date", "traits": { "smithy.api#documentation": "The timestamp when the data store was last updated.
" } } }, "traits": { "smithy.api#documentation": "The properties associated with the data store.
" } }, "com.amazonaws.medicalimaging#DatastoreResource": { "type": "resource", "identifiers": { "datastoreId": { "target": "com.amazonaws.medicalimaging#DatastoreId" } }, "create": { "target": "com.amazonaws.medicalimaging#CreateDatastore" }, "read": { "target": "com.amazonaws.medicalimaging#GetDatastore" }, "delete": { "target": "com.amazonaws.medicalimaging#DeleteDatastore" }, "list": { "target": "com.amazonaws.medicalimaging#ListDatastores" }, "traits": { "aws.api#arn": { "template": "datastore/{datastoreId}" }, "aws.iam#conditionKeys": [ "aws:ResourceTag/${TagKey}" ], "aws.iam#disableConditionKeyInference": {} } }, "com.amazonaws.medicalimaging#DatastoreStatus": { "type": "enum", "members": { "CREATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CREATING" } }, "CREATE_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CREATE_FAILED" } }, "ACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACTIVE" } }, "DELETING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETING" } }, "DELETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETED" } } } }, "com.amazonaws.medicalimaging#DatastoreSummaries": { "type": "list", "member": { "target": "com.amazonaws.medicalimaging#DatastoreSummary" } }, "com.amazonaws.medicalimaging#DatastoreSummary": { "type": "structure", "members": { "datastoreId": { "target": "com.amazonaws.medicalimaging#DatastoreId", "traits": { "smithy.api#documentation": "The data store identifier.
", "smithy.api#required": {} } }, "datastoreName": { "target": "com.amazonaws.medicalimaging#DatastoreName", "traits": { "smithy.api#documentation": "The data store name.
", "smithy.api#required": {} } }, "datastoreStatus": { "target": "com.amazonaws.medicalimaging#DatastoreStatus", "traits": { "smithy.api#documentation": "The data store status.
", "smithy.api#required": {} } }, "datastoreArn": { "target": "com.amazonaws.medicalimaging#Arn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) for the data store.
" } }, "createdAt": { "target": "com.amazonaws.medicalimaging#Date", "traits": { "smithy.api#documentation": "The timestamp when the data store was created.
" } }, "updatedAt": { "target": "com.amazonaws.medicalimaging#Date", "traits": { "smithy.api#documentation": "The timestamp when the data store was last updated.
" } } }, "traits": { "smithy.api#documentation": "List of summaries of data stores.
" } }, "com.amazonaws.medicalimaging#Date": { "type": "timestamp" }, "com.amazonaws.medicalimaging#DeleteDatastore": { "type": "operation", "input": { "target": "com.amazonaws.medicalimaging#DeleteDatastoreRequest" }, "output": { "target": "com.amazonaws.medicalimaging#DeleteDatastoreResponse" }, "errors": [ { "target": "com.amazonaws.medicalimaging#AccessDeniedException" }, { "target": "com.amazonaws.medicalimaging#ConflictException" }, { "target": "com.amazonaws.medicalimaging#InternalServerException" }, { "target": "com.amazonaws.medicalimaging#ResourceNotFoundException" }, { "target": "com.amazonaws.medicalimaging#ThrottlingException" }, { "target": "com.amazonaws.medicalimaging#ValidationException" } ], "traits": { "smithy.api#documentation": "Delete a data store.
Before a data store can be deleted, you must first delete all image sets within it.
The data store identifier.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.medicalimaging#DeleteDatastoreResponse": { "type": "structure", "members": { "datastoreId": { "target": "com.amazonaws.medicalimaging#DatastoreId", "traits": { "smithy.api#documentation": "The data store identifier.
", "smithy.api#required": {} } }, "datastoreStatus": { "target": "com.amazonaws.medicalimaging#DatastoreStatus", "traits": { "smithy.api#documentation": "The data store status.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.medicalimaging#DeleteImageSet": { "type": "operation", "input": { "target": "com.amazonaws.medicalimaging#DeleteImageSetRequest" }, "output": { "target": "com.amazonaws.medicalimaging#DeleteImageSetResponse" }, "errors": [ { "target": "com.amazonaws.medicalimaging#AccessDeniedException" }, { "target": "com.amazonaws.medicalimaging#ConflictException" }, { "target": "com.amazonaws.medicalimaging#InternalServerException" }, { "target": "com.amazonaws.medicalimaging#ResourceNotFoundException" }, { "target": "com.amazonaws.medicalimaging#ThrottlingException" }, { "target": "com.amazonaws.medicalimaging#ValidationException" } ], "traits": { "smithy.api#documentation": "Delete an image set.
", "smithy.api#endpoint": { "hostPrefix": "runtime-" }, "smithy.api#http": { "uri": "/datastore/{datastoreId}/imageSet/{imageSetId}/deleteImageSet", "method": "POST" }, "smithy.api#idempotent": {} } }, "com.amazonaws.medicalimaging#DeleteImageSetRequest": { "type": "structure", "members": { "datastoreId": { "target": "com.amazonaws.medicalimaging#DatastoreId", "traits": { "smithy.api#documentation": "The data store identifier.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "imageSetId": { "target": "com.amazonaws.medicalimaging#ImageSetId", "traits": { "smithy.api#documentation": "The image set identifier.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.medicalimaging#DeleteImageSetResponse": { "type": "structure", "members": { "datastoreId": { "target": "com.amazonaws.medicalimaging#DatastoreId", "traits": { "smithy.api#documentation": "The data store identifier.
", "smithy.api#required": {} } }, "imageSetId": { "target": "com.amazonaws.medicalimaging#ImageSetId", "traits": { "smithy.api#documentation": "The image set identifier.
", "smithy.api#required": {} } }, "imageSetState": { "target": "com.amazonaws.medicalimaging#ImageSetState", "traits": { "smithy.api#documentation": "The image set state.
", "smithy.api#required": {} } }, "imageSetWorkflowStatus": { "target": "com.amazonaws.medicalimaging#ImageSetWorkflowStatus", "traits": { "smithy.api#documentation": "The image set workflow status.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.medicalimaging#DicomJsonMetadataImportConfiguration": { "type": "structure", "members": { "dicomMetadataMappings": { "target": "com.amazonaws.medicalimaging#DicomMetadataMappings", "traits": { "smithy.api#documentation": "Maps DCM files to their metadata.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The configuration parameters that are specific to DICOM JSON metadata import operations.
" } }, "com.amazonaws.medicalimaging#DicomMetadataMapping": { "type": "structure", "members": { "studyInstanceUID": { "target": "com.amazonaws.medicalimaging#DICOMStudyInstanceUID", "traits": { "smithy.api#documentation": "The Study Instance UID that identifies the study.
", "smithy.api#required": {} } }, "seriesInstanceUID": { "target": "com.amazonaws.medicalimaging#DICOMSeriesInstanceUID", "traits": { "smithy.api#documentation": "The Series Instance UID that identifies the series. This parameter is optional because the mapping might be at the study level.
" } }, "metadataFilePath": { "target": "com.amazonaws.medicalimaging#MetadataFilePath", "traits": { "smithy.api#documentation": "The path to the JSON metadata file relative to inputS3Uri.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Maps DCM files to their metadata.
" } }, "com.amazonaws.medicalimaging#DicomMetadataMappings": { "type": "list", "member": { "target": "com.amazonaws.medicalimaging#DicomMetadataMapping" }, "traits": { "smithy.api#length": { "min": 1, "max": 1000 } } }, "com.amazonaws.medicalimaging#GetDICOMImportJob": { "type": "operation", "input": { "target": "com.amazonaws.medicalimaging#GetDICOMImportJobRequest" }, "output": { "target": "com.amazonaws.medicalimaging#GetDICOMImportJobResponse" }, "errors": [ { "target": "com.amazonaws.medicalimaging#AccessDeniedException" }, { "target": "com.amazonaws.medicalimaging#ConflictException" }, { "target": "com.amazonaws.medicalimaging#InternalServerException" }, { "target": "com.amazonaws.medicalimaging#ResourceNotFoundException" }, { "target": "com.amazonaws.medicalimaging#ThrottlingException" }, { "target": "com.amazonaws.medicalimaging#ValidationException" } ], "traits": { "smithy.api#documentation": "Get the import job properties to learn more about the job or job progress.
The jobStatus refers to the execution of the import job. Therefore, an import job can return a jobStatus as COMPLETED even if validation issues are discovered during the import process. If a jobStatus returns as COMPLETED, we still recommend you review the output manifests written to S3, as they provide details on the success or failure of individual P10 object imports.
The data store identifier.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "jobId": { "target": "com.amazonaws.medicalimaging#JobId", "traits": { "smithy.api#documentation": "The import job identifier.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.medicalimaging#GetDICOMImportJobResponse": { "type": "structure", "members": { "jobProperties": { "target": "com.amazonaws.medicalimaging#DICOMImportJobProperties", "traits": { "smithy.api#documentation": "The properties of the import job.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.medicalimaging#GetDatastore": { "type": "operation", "input": { "target": "com.amazonaws.medicalimaging#GetDatastoreRequest" }, "output": { "target": "com.amazonaws.medicalimaging#GetDatastoreResponse" }, "errors": [ { "target": "com.amazonaws.medicalimaging#AccessDeniedException" }, { "target": "com.amazonaws.medicalimaging#InternalServerException" }, { "target": "com.amazonaws.medicalimaging#ResourceNotFoundException" }, { "target": "com.amazonaws.medicalimaging#ThrottlingException" }, { "target": "com.amazonaws.medicalimaging#ValidationException" } ], "traits": { "smithy.api#documentation": "Get data store properties.
", "smithy.api#http": { "method": "GET", "uri": "/datastore/{datastoreId}" }, "smithy.api#readonly": {} } }, "com.amazonaws.medicalimaging#GetDatastoreRequest": { "type": "structure", "members": { "datastoreId": { "target": "com.amazonaws.medicalimaging#DatastoreId", "traits": { "smithy.api#documentation": "The data store identifier.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.medicalimaging#GetDatastoreResponse": { "type": "structure", "members": { "datastoreProperties": { "target": "com.amazonaws.medicalimaging#DatastoreProperties", "traits": { "smithy.api#documentation": "The data store properties.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.medicalimaging#GetImageFrame": { "type": "operation", "input": { "target": "com.amazonaws.medicalimaging#GetImageFrameRequest" }, "output": { "target": "com.amazonaws.medicalimaging#GetImageFrameResponse" }, "errors": [ { "target": "com.amazonaws.medicalimaging#AccessDeniedException" }, { "target": "com.amazonaws.medicalimaging#BadRequestException" }, { "target": "com.amazonaws.medicalimaging#ConflictException" }, { "target": "com.amazonaws.medicalimaging#InternalServerException" }, { "target": "com.amazonaws.medicalimaging#NotAcceptableException" }, { "target": "com.amazonaws.medicalimaging#ResourceNotFoundException" }, { "target": "com.amazonaws.medicalimaging#ThrottlingException" }, { "target": "com.amazonaws.medicalimaging#ValidationException" } ], "traits": { "smithy.api#documentation": "Get an image frame (pixel data) for an image set.
", "smithy.api#endpoint": { "hostPrefix": "runtime-" }, "smithy.api#http": { "uri": "/datastore/{datastoreId}/imageSet/{imageSetId}/getImageFrame", "method": "POST" }, "smithy.api#readonly": {} } }, "com.amazonaws.medicalimaging#GetImageFrameRequest": { "type": "structure", "members": { "datastoreId": { "target": "com.amazonaws.medicalimaging#DatastoreId", "traits": { "smithy.api#documentation": "The data store identifier.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "imageSetId": { "target": "com.amazonaws.medicalimaging#ImageSetId", "traits": { "smithy.api#documentation": "The image set identifier.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "imageFrameInformation": { "target": "com.amazonaws.medicalimaging#ImageFrameInformation", "traits": { "smithy.api#documentation": "Information about the image frame (pixel data) identifier.
", "smithy.api#httpPayload": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.medicalimaging#GetImageFrameResponse": { "type": "structure", "members": { "imageFrameBlob": { "target": "com.amazonaws.medicalimaging#PayloadBlob", "traits": { "smithy.api#documentation": "The blob containing the aggregated image frame information.
", "smithy.api#httpPayload": {}, "smithy.api#required": {} } }, "contentType": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The format in which the image frame information is returned to the customer. Default is application/octet-stream.
If the stored transfer syntax is 1.2.840.10008.1.2.1, the returned contentType is application/octet-stream.
If the stored transfer syntax is 1.2.840.10008.1.2.4.50, the returned contentType is image/jpeg.
If the stored transfer syntax is 1.2.840.10008.1.2.4.91, the returned contentType is image/j2c.
If the stored transfer syntax is MPEG2, 1.2.840.10008.1.2.4.100, 1.2.840.10008.1.2.4.100.1, 1.2.840.10008.1.2.4.101, or 1.2.840.10008.1.2.4.101.1, the returned contentType is video/mpeg.
If the stored transfer syntax is MPEG-4 AVC/H.264, UID 1.2.840.10008.1.2.4.102, 1.2.840.10008.1.2.4.102.1, 1.2.840.10008.1.2.4.103, 1.2.840.10008.1.2.4.103.1, 1.2.840.10008.1.2.4.104, 1.2.840.10008.1.2.4.104.1, 1.2.840.10008.1.2.4.105, 1.2.840.10008.1.2.4.105.1, 1.2.840.10008.1.2.4.106, or 1.2.840.10008.1.2.4.106.1, the returned contentType is video/mp4.
If the stored transfer syntax is HEVC/H.265, UID 1.2.840.10008.1.2.4.107 or 1.2.840.10008.1.2.4.108, the returned contentType is video/H256.
If the stored transfer syntax is 1.2.840.10008.1.2.4.202 or if the stored transfer syntax is missing, the returned contentType is image/jph.
If the stored transfer syntax is 1.2.840.10008.1.2.4.203, the returned contentType is image/jphc.
If the stored transfer syntax is 1.2.840.10008.1.2.4.112 the returned contentType is image/jxl.
Get image set properties.
", "smithy.api#endpoint": { "hostPrefix": "runtime-" }, "smithy.api#http": { "uri": "/datastore/{datastoreId}/imageSet/{imageSetId}/getImageSet", "method": "POST" }, "smithy.api#readonly": {} } }, "com.amazonaws.medicalimaging#GetImageSetMetadata": { "type": "operation", "input": { "target": "com.amazonaws.medicalimaging#GetImageSetMetadataRequest" }, "output": { "target": "com.amazonaws.medicalimaging#GetImageSetMetadataResponse" }, "errors": [ { "target": "com.amazonaws.medicalimaging#AccessDeniedException" }, { "target": "com.amazonaws.medicalimaging#ConflictException" }, { "target": "com.amazonaws.medicalimaging#InternalServerException" }, { "target": "com.amazonaws.medicalimaging#ResourceNotFoundException" }, { "target": "com.amazonaws.medicalimaging#ThrottlingException" }, { "target": "com.amazonaws.medicalimaging#ValidationException" } ], "traits": { "smithy.api#documentation": "Get metadata attributes for an image set.
", "smithy.api#endpoint": { "hostPrefix": "runtime-" }, "smithy.api#http": { "uri": "/datastore/{datastoreId}/imageSet/{imageSetId}/getImageSetMetadata", "method": "POST" }, "smithy.api#readonly": {} } }, "com.amazonaws.medicalimaging#GetImageSetMetadataRequest": { "type": "structure", "members": { "datastoreId": { "target": "com.amazonaws.medicalimaging#DatastoreId", "traits": { "smithy.api#documentation": "The data store identifier.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "imageSetId": { "target": "com.amazonaws.medicalimaging#ImageSetId", "traits": { "smithy.api#documentation": "The image set identifier.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "versionId": { "target": "com.amazonaws.medicalimaging#ImageSetExternalVersionId", "traits": { "smithy.api#documentation": "The image set version identifier.
", "smithy.api#httpQuery": "version" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.medicalimaging#GetImageSetMetadataResponse": { "type": "structure", "members": { "imageSetMetadataBlob": { "target": "com.amazonaws.medicalimaging#ImageSetMetadataBlob", "traits": { "smithy.api#documentation": "The blob containing the aggregated metadata information for the image set.
", "smithy.api#httpPayload": {}, "smithy.api#required": {} } }, "contentType": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The format in which the study metadata is returned to the customer. Default is text/plain.
The compression format in which image set metadata attributes are returned.
", "smithy.api#httpHeader": "Content-Encoding" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.medicalimaging#GetImageSetRequest": { "type": "structure", "members": { "datastoreId": { "target": "com.amazonaws.medicalimaging#DatastoreId", "traits": { "smithy.api#documentation": "The data store identifier.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "imageSetId": { "target": "com.amazonaws.medicalimaging#ImageSetId", "traits": { "smithy.api#documentation": "The image set identifier.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "versionId": { "target": "com.amazonaws.medicalimaging#ImageSetExternalVersionId", "traits": { "smithy.api#documentation": "The image set version identifier.
", "smithy.api#httpQuery": "version" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.medicalimaging#GetImageSetResponse": { "type": "structure", "members": { "datastoreId": { "target": "com.amazonaws.medicalimaging#DatastoreId", "traits": { "smithy.api#documentation": "The data store identifier.
", "smithy.api#required": {} } }, "imageSetId": { "target": "com.amazonaws.medicalimaging#ImageSetId", "traits": { "smithy.api#documentation": "The image set identifier.
", "smithy.api#required": {} } }, "versionId": { "target": "com.amazonaws.medicalimaging#ImageSetExternalVersionId", "traits": { "smithy.api#documentation": "The image set version identifier.
", "smithy.api#required": {} } }, "imageSetState": { "target": "com.amazonaws.medicalimaging#ImageSetState", "traits": { "smithy.api#documentation": "The image set state.
", "smithy.api#required": {} } }, "imageSetWorkflowStatus": { "target": "com.amazonaws.medicalimaging#ImageSetWorkflowStatus", "traits": { "smithy.api#documentation": "The image set workflow status.
" } }, "createdAt": { "target": "com.amazonaws.medicalimaging#Date", "traits": { "smithy.api#documentation": "The timestamp when image set properties were created.
" } }, "updatedAt": { "target": "com.amazonaws.medicalimaging#Date", "traits": { "smithy.api#documentation": "The timestamp when image set properties were updated.
" } }, "deletedAt": { "target": "com.amazonaws.medicalimaging#Date", "traits": { "smithy.api#documentation": "The timestamp when the image set properties were deleted.
" } }, "message": { "target": "com.amazonaws.medicalimaging#Message", "traits": { "smithy.api#documentation": "The error message thrown if an image set action fails.
" } }, "imageSetArn": { "target": "com.amazonaws.medicalimaging#Arn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) assigned to the image set.
" } }, "overrides": { "target": "com.amazonaws.medicalimaging#Overrides", "traits": { "smithy.api#documentation": "This object contains the details of any overrides used while creating a specific image set version. If an image set was copied or updated using the force flag, this object will contain the forced flag.
The flag to determine whether the image set is primary or not.
" } }, "lastAccessedAt": { "target": "com.amazonaws.medicalimaging#Date", "traits": { "smithy.api#documentation": "When the image set was last accessed.
" } }, "storageTier": { "target": "com.amazonaws.medicalimaging#StorageTier", "traits": { "smithy.api#documentation": "The storage tier of the image set.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.medicalimaging#ImageFrameId": { "type": "string", "traits": { "smithy.api#pattern": "^[0-9a-z]{32}$" } }, "com.amazonaws.medicalimaging#ImageFrameInformation": { "type": "structure", "members": { "imageFrameId": { "target": "com.amazonaws.medicalimaging#ImageFrameId", "traits": { "smithy.api#documentation": "The image frame (pixel data) identifier.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Information about the image frame (pixel data) identifier.
" } }, "com.amazonaws.medicalimaging#ImageSetExternalVersionId": { "type": "string", "traits": { "smithy.api#pattern": "^\\d+$" } }, "com.amazonaws.medicalimaging#ImageSetId": { "type": "string", "traits": { "smithy.api#pattern": "^[0-9a-z]{32}$" } }, "com.amazonaws.medicalimaging#ImageSetMetadataBlob": { "type": "blob", "traits": { "smithy.api#streaming": {} } }, "com.amazonaws.medicalimaging#ImageSetProperties": { "type": "structure", "members": { "imageSetId": { "target": "com.amazonaws.medicalimaging#ImageSetId", "traits": { "smithy.api#documentation": "The image set identifier.
", "smithy.api#required": {} } }, "versionId": { "target": "com.amazonaws.medicalimaging#ImageSetExternalVersionId", "traits": { "smithy.api#documentation": "The image set version identifier.
", "smithy.api#required": {} } }, "imageSetState": { "target": "com.amazonaws.medicalimaging#ImageSetState", "traits": { "smithy.api#documentation": "The image set state.
", "smithy.api#required": {} } }, "ImageSetWorkflowStatus": { "target": "com.amazonaws.medicalimaging#ImageSetWorkflowStatus", "traits": { "smithy.api#documentation": "The image set workflow status.
" } }, "createdAt": { "target": "com.amazonaws.medicalimaging#Date", "traits": { "smithy.api#documentation": "The timestamp when the image set properties were created.
" } }, "updatedAt": { "target": "com.amazonaws.medicalimaging#Date", "traits": { "smithy.api#documentation": "The timestamp when the image set properties were updated.
" } }, "deletedAt": { "target": "com.amazonaws.medicalimaging#Date", "traits": { "smithy.api#documentation": "The timestamp when the image set properties were deleted.
" } }, "message": { "target": "com.amazonaws.medicalimaging#Message", "traits": { "smithy.api#documentation": "The error message thrown if an image set action fails.
" } }, "overrides": { "target": "com.amazonaws.medicalimaging#Overrides", "traits": { "smithy.api#documentation": "Contains details on overrides used when creating the returned version of an image set. For example, if forced exists, the forced flag was used when creating the image set.
The flag to determine whether the image set is primary or not.
" } } }, "traits": { "smithy.api#documentation": "The image set properties.
" } }, "com.amazonaws.medicalimaging#ImageSetPropertiesList": { "type": "list", "member": { "target": "com.amazonaws.medicalimaging#ImageSetProperties" } }, "com.amazonaws.medicalimaging#ImageSetResource": { "type": "resource", "identifiers": { "datastoreId": { "target": "com.amazonaws.medicalimaging#DatastoreId" }, "imageSetId": { "target": "com.amazonaws.medicalimaging#ImageSetId" } }, "traits": { "aws.api#arn": { "template": "datastore/{datastoreId}/imageset/{imageSetId}" }, "aws.iam#conditionKeys": [ "aws:ResourceTag/${TagKey}" ], "aws.iam#disableConditionKeyInference": {} } }, "com.amazonaws.medicalimaging#ImageSetState": { "type": "enum", "members": { "ACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACTIVE" } }, "LOCKED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "LOCKED" } }, "DELETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETED" } } } }, "com.amazonaws.medicalimaging#ImageSetWorkflowStatus": { "type": "enum", "members": { "CREATED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CREATED" } }, "COPIED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "COPIED" } }, "COPYING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "COPYING" } }, "COPYING_WITH_READ_ONLY_ACCESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "COPYING_WITH_READ_ONLY_ACCESS" } }, "COPY_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "COPY_FAILED" } }, "UPDATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UPDATING" } }, "UPDATING_FOR_STUDY_CONSISTENCY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UPDATING_FOR_STUDY_CONSISTENCY" } }, "UPDATED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UPDATED" } }, "UPDATE_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UPDATE_FAILED" } }, "DELETING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETING" } }, "DELETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETED" } }, "IMPORTING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IMPORTING" } }, "IMPORTED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IMPORTED" } }, "IMPORT_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IMPORT_FAILED" } } } }, "com.amazonaws.medicalimaging#ImageSetsMetadataSummaries": { "type": "list", "member": { "target": "com.amazonaws.medicalimaging#ImageSetsMetadataSummary" } }, "com.amazonaws.medicalimaging#ImageSetsMetadataSummary": { "type": "structure", "members": { "imageSetId": { "target": "com.amazonaws.medicalimaging#ImageSetId", "traits": { "smithy.api#documentation": "The image set identifier.
", "smithy.api#required": {} } }, "version": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The image set version.
" } }, "createdAt": { "target": "com.amazonaws.medicalimaging#Date", "traits": { "smithy.api#documentation": "The time an image set is created. Sample creation date is provided in 1985-04-12T23:20:50.52Z format.
The time an image set was last updated.
" } }, "lastAccessedAt": { "target": "com.amazonaws.medicalimaging#Date", "traits": { "smithy.api#documentation": "When the image set was last accessed.
" } }, "storageTier": { "target": "com.amazonaws.medicalimaging#StorageTier", "traits": { "smithy.api#documentation": "The image set's storage tier.
" } }, "DICOMTags": { "target": "com.amazonaws.medicalimaging#DICOMTags", "traits": { "smithy.api#documentation": "The DICOM tags associated with the image set.
" } }, "isPrimary": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "The flag to determine whether the image set is primary or not.
" } } }, "traits": { "smithy.api#documentation": "Summary of the image set metadata.
" } }, "com.amazonaws.medicalimaging#ImportConfiguration": { "type": "union", "members": { "dicomJsonMetadataImportConfiguration": { "target": "com.amazonaws.medicalimaging#DicomJsonMetadataImportConfiguration" } }, "traits": { "smithy.api#documentation": "The configuration options for different types of import operations.
" } }, "com.amazonaws.medicalimaging#InternalServerException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "An unexpected error occurred during processing of the request.
", "smithy.api#error": "server", "smithy.api#httpError": 500 } }, "com.amazonaws.medicalimaging#JobId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 32 }, "smithy.api#pattern": "^[0-9a-z]+$" } }, "com.amazonaws.medicalimaging#JobName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^[A-Za-z0-9._/#-]+$" } }, "com.amazonaws.medicalimaging#JobStatus": { "type": "enum", "members": { "SUBMITTED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SUBMITTED" } }, "IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IN_PROGRESS" } }, "COMPLETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "COMPLETED" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } } } }, "com.amazonaws.medicalimaging#KmsKeyArn": { "type": "string", "traits": { "aws.api#arnReference": {}, "smithy.api#documentation": "ARN referencing a KMS key or KMS key alias.", "smithy.api#length": { "min": 1, "max": 512 }, "smithy.api#pattern": "^arn:aws[a-zA-Z-]{0,16}:kms:[a-z]{2}(-[a-z]{1,16}){1,3}-\\d{1}:\\d{12}:((key/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12})|(alias/[a-zA-Z0-9:/_-]{1,256}))$" } }, "com.amazonaws.medicalimaging#LambdaArn": { "type": "string", "traits": { "smithy.api#pattern": "^arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1}:\\d{12}:function:[a-zA-Z0-9-_]+(:(\\$LATEST|[a-zA-Z0-9-_]+))?$" } }, "com.amazonaws.medicalimaging#ListDICOMImportJobs": { "type": "operation", "input": { "target": "com.amazonaws.medicalimaging#ListDICOMImportJobsRequest" }, "output": { "target": "com.amazonaws.medicalimaging#ListDICOMImportJobsResponse" }, "errors": [ { "target": "com.amazonaws.medicalimaging#AccessDeniedException" }, { "target": "com.amazonaws.medicalimaging#ConflictException" }, { "target": "com.amazonaws.medicalimaging#InternalServerException" }, { "target": "com.amazonaws.medicalimaging#ResourceNotFoundException" }, { "target": "com.amazonaws.medicalimaging#ThrottlingException" }, { "target": "com.amazonaws.medicalimaging#ValidationException" } ], "traits": { "smithy.api#documentation": "List import jobs created for a specific data store.
", "smithy.api#http": { "method": "GET", "uri": "/listDICOMImportJobs/datastore/{datastoreId}" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "jobSummaries" }, "smithy.api#readonly": {} } }, "com.amazonaws.medicalimaging#ListDICOMImportJobsRequest": { "type": "structure", "members": { "datastoreId": { "target": "com.amazonaws.medicalimaging#DatastoreId", "traits": { "smithy.api#documentation": "The data store identifier.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "jobStatus": { "target": "com.amazonaws.medicalimaging#JobStatus", "traits": { "smithy.api#documentation": "The filters for listing import jobs based on status.
", "smithy.api#httpQuery": "jobStatus" } }, "nextToken": { "target": "com.amazonaws.medicalimaging#NextToken", "traits": { "smithy.api#documentation": "The pagination token used to request the list of import jobs on the next page.
", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The max results count. The upper bound is determined by load testing.
", "smithy.api#httpQuery": "maxResults", "smithy.api#range": { "min": 1, "max": 50 } } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.medicalimaging#ListDICOMImportJobsResponse": { "type": "structure", "members": { "jobSummaries": { "target": "com.amazonaws.medicalimaging#DICOMImportJobSummaries", "traits": { "smithy.api#documentation": "A list of job summaries.
", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.medicalimaging#NextToken", "traits": { "smithy.api#documentation": "The pagination token used to retrieve the list of import jobs on the next page.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.medicalimaging#ListDatastores": { "type": "operation", "input": { "target": "com.amazonaws.medicalimaging#ListDatastoresRequest" }, "output": { "target": "com.amazonaws.medicalimaging#ListDatastoresResponse" }, "errors": [ { "target": "com.amazonaws.medicalimaging#AccessDeniedException" }, { "target": "com.amazonaws.medicalimaging#InternalServerException" }, { "target": "com.amazonaws.medicalimaging#ThrottlingException" }, { "target": "com.amazonaws.medicalimaging#ValidationException" } ], "traits": { "smithy.api#documentation": "List data stores.
", "smithy.api#http": { "method": "GET", "uri": "/datastore" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "datastoreSummaries" }, "smithy.api#readonly": {} } }, "com.amazonaws.medicalimaging#ListDatastoresRequest": { "type": "structure", "members": { "datastoreStatus": { "target": "com.amazonaws.medicalimaging#DatastoreStatus", "traits": { "smithy.api#documentation": "The data store status.
", "smithy.api#httpQuery": "datastoreStatus" } }, "nextToken": { "target": "com.amazonaws.medicalimaging#NextToken", "traits": { "smithy.api#documentation": "The pagination token used to request the list of data stores on the next page.
", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "Valid Range: Minimum value of 1. Maximum value of 50.
", "smithy.api#httpQuery": "maxResults", "smithy.api#range": { "min": 1, "max": 50 } } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.medicalimaging#ListDatastoresResponse": { "type": "structure", "members": { "datastoreSummaries": { "target": "com.amazonaws.medicalimaging#DatastoreSummaries", "traits": { "smithy.api#documentation": "The list of summaries of data stores.
" } }, "nextToken": { "target": "com.amazonaws.medicalimaging#NextToken", "traits": { "smithy.api#documentation": "The pagination token used to retrieve the list of data stores on the next page.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.medicalimaging#ListImageSetVersions": { "type": "operation", "input": { "target": "com.amazonaws.medicalimaging#ListImageSetVersionsRequest" }, "output": { "target": "com.amazonaws.medicalimaging#ListImageSetVersionsResponse" }, "errors": [ { "target": "com.amazonaws.medicalimaging#AccessDeniedException" }, { "target": "com.amazonaws.medicalimaging#ConflictException" }, { "target": "com.amazonaws.medicalimaging#InternalServerException" }, { "target": "com.amazonaws.medicalimaging#ResourceNotFoundException" }, { "target": "com.amazonaws.medicalimaging#ThrottlingException" }, { "target": "com.amazonaws.medicalimaging#ValidationException" } ], "traits": { "smithy.api#documentation": "List image set versions.
", "smithy.api#endpoint": { "hostPrefix": "runtime-" }, "smithy.api#http": { "uri": "/datastore/{datastoreId}/imageSet/{imageSetId}/listImageSetVersions", "method": "POST" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "imageSetPropertiesList" }, "smithy.api#readonly": {} } }, "com.amazonaws.medicalimaging#ListImageSetVersionsRequest": { "type": "structure", "members": { "datastoreId": { "target": "com.amazonaws.medicalimaging#DatastoreId", "traits": { "smithy.api#documentation": "The data store identifier.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "imageSetId": { "target": "com.amazonaws.medicalimaging#ImageSetId", "traits": { "smithy.api#documentation": "The image set identifier.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.medicalimaging#NextToken", "traits": { "smithy.api#documentation": "The pagination token used to request the list of image set versions on the next page.
", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The max results count.
", "smithy.api#httpQuery": "maxResults", "smithy.api#range": { "min": 1, "max": 50 } } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.medicalimaging#ListImageSetVersionsResponse": { "type": "structure", "members": { "imageSetPropertiesList": { "target": "com.amazonaws.medicalimaging#ImageSetPropertiesList", "traits": { "smithy.api#documentation": "Lists all properties associated with an image set.
", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.medicalimaging#NextToken", "traits": { "smithy.api#documentation": "The pagination token used to retrieve the list of image set versions on the next page.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.medicalimaging#ListTagsForResource": { "type": "operation", "input": { "target": "com.amazonaws.medicalimaging#ListTagsForResourceRequest" }, "output": { "target": "com.amazonaws.medicalimaging#ListTagsForResourceResponse" }, "errors": [ { "target": "com.amazonaws.medicalimaging#AccessDeniedException" }, { "target": "com.amazonaws.medicalimaging#InternalServerException" }, { "target": "com.amazonaws.medicalimaging#ResourceNotFoundException" }, { "target": "com.amazonaws.medicalimaging#ThrottlingException" }, { "target": "com.amazonaws.medicalimaging#ValidationException" } ], "traits": { "smithy.api#documentation": "Lists all tags associated with a medical imaging resource.
", "smithy.api#http": { "method": "GET", "uri": "/tags/{resourceArn}" }, "smithy.api#readonly": {} } }, "com.amazonaws.medicalimaging#ListTagsForResourceRequest": { "type": "structure", "members": { "resourceArn": { "target": "com.amazonaws.medicalimaging#Arn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the medical imaging resource to list tags for.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.medicalimaging#ListTagsForResourceResponse": { "type": "structure", "members": { "tags": { "target": "com.amazonaws.medicalimaging#TagMap", "traits": { "smithy.api#documentation": "A list of all tags associated with a medical imaging resource.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.medicalimaging#LosslessStorageFormat": { "type": "enum", "members": { "HTJ2K": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "HTJ2K" } }, "JPEG_2000_LOSSLESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "JPEG_2000_LOSSLESS" } } } }, "com.amazonaws.medicalimaging#Message": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 2048 }, "smithy.api#pattern": "^[\\w -:`]+$" } }, "com.amazonaws.medicalimaging#MetadataCopies": { "type": "structure", "members": { "copiableAttributes": { "target": "com.amazonaws.medicalimaging#CopiableAttributes", "traits": { "smithy.api#documentation": "The JSON string used to specify a subset of SOP Instances to copy from source to destination image set.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Contains copiable Attributes structure and wraps information related to specific copy use cases. For example, when copying subsets.
The object containing removableAttributes and updatableAttributes.
Specifies the previous image set version ID to revert the current image set back to.
You must provide either revertToVersionId or DICOMUpdates in your request. A ValidationException error is thrown if both parameters are provided at the same time.
Contains DICOMUpdates.
" } }, "com.amazonaws.medicalimaging#NextToken": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 8192 }, "smithy.api#pattern": "^\\p{ASCII}{0,8192}$" } }, "com.amazonaws.medicalimaging#NotAcceptableException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The request content type or accept header is not supported.
", "smithy.api#error": "client", "smithy.api#httpError": 406 } }, "com.amazonaws.medicalimaging#Operator": { "type": "enum", "members": { "EQUAL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EQUAL" } }, "BETWEEN": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BETWEEN" } } } }, "com.amazonaws.medicalimaging#Overrides": { "type": "structure", "members": { "forced": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "Providing this parameter will force completion of the CopyImageSet and UpdateImageSetMetadata actions, even if metadata is inconsistent at the Patient, Study, and/or Series levels.
Specifies the overrides used in image set modification calls to CopyImageSet and UpdateImageSetMetadata.
The request references a resource which does not exist.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.medicalimaging#RoleArn": { "type": "string", "traits": { "aws.api#arnReference": { "type": "AWS::IAM::Role" }, "smithy.api#length": { "min": 20, "max": 2048 }, "smithy.api#pattern": "^arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+$" } }, "com.amazonaws.medicalimaging#S3Uri": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1024 }, "smithy.api#pattern": "^s3://[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9](/.*)?$" } }, "com.amazonaws.medicalimaging#SearchByAttributeValue": { "type": "union", "members": { "DICOMPatientId": { "target": "com.amazonaws.medicalimaging#DICOMPatientId", "traits": { "smithy.api#documentation": "The patient ID input for search.
" } }, "DICOMAccessionNumber": { "target": "com.amazonaws.medicalimaging#DICOMAccessionNumber", "traits": { "smithy.api#documentation": "The DICOM accession number for search.
" } }, "DICOMStudyId": { "target": "com.amazonaws.medicalimaging#DICOMStudyId", "traits": { "smithy.api#documentation": "The DICOM study ID for search.
" } }, "DICOMStudyInstanceUID": { "target": "com.amazonaws.medicalimaging#DICOMStudyInstanceUID", "traits": { "smithy.api#documentation": "The DICOM study instance UID for search.
" } }, "DICOMSeriesInstanceUID": { "target": "com.amazonaws.medicalimaging#DICOMSeriesInstanceUID", "traits": { "smithy.api#documentation": "The Series Instance UID input for search.
" } }, "createdAt": { "target": "com.amazonaws.medicalimaging#Date", "traits": { "smithy.api#documentation": "The created at time of the image set provided for search.
" } }, "updatedAt": { "target": "com.amazonaws.medicalimaging#Date", "traits": { "smithy.api#documentation": "The timestamp input for search.
" } }, "DICOMStudyDateAndTime": { "target": "com.amazonaws.medicalimaging#DICOMStudyDateAndTime", "traits": { "smithy.api#documentation": "The aggregated structure containing DICOM study date and study time for search.
" } }, "isPrimary": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "The primary image set flag provided for search.
" } } }, "traits": { "smithy.api#documentation": "The search input attribute value.
" } }, "com.amazonaws.medicalimaging#SearchByAttributeValues": { "type": "list", "member": { "target": "com.amazonaws.medicalimaging#SearchByAttributeValue" } }, "com.amazonaws.medicalimaging#SearchCriteria": { "type": "structure", "members": { "filters": { "target": "com.amazonaws.medicalimaging#SearchFilters", "traits": { "smithy.api#documentation": "The filters for the search criteria.
", "smithy.api#length": { "min": 1, "max": 2 } } }, "sort": { "target": "com.amazonaws.medicalimaging#Sort", "traits": { "smithy.api#documentation": "The sort input for search criteria.
" } } }, "traits": { "smithy.api#documentation": "The search criteria.
", "smithy.api#sensitive": {} } }, "com.amazonaws.medicalimaging#SearchFilter": { "type": "structure", "members": { "values": { "target": "com.amazonaws.medicalimaging#SearchByAttributeValues", "traits": { "smithy.api#documentation": "The search filter values.
", "smithy.api#length": { "min": 1, "max": 2 }, "smithy.api#required": {} } }, "operator": { "target": "com.amazonaws.medicalimaging#Operator", "traits": { "smithy.api#documentation": "The search filter operator for imageSetDateTime.
The search filter.
" } }, "com.amazonaws.medicalimaging#SearchFilters": { "type": "list", "member": { "target": "com.amazonaws.medicalimaging#SearchFilter" } }, "com.amazonaws.medicalimaging#SearchImageSets": { "type": "operation", "input": { "target": "com.amazonaws.medicalimaging#SearchImageSetsRequest" }, "output": { "target": "com.amazonaws.medicalimaging#SearchImageSetsResponse" }, "errors": [ { "target": "com.amazonaws.medicalimaging#AccessDeniedException" }, { "target": "com.amazonaws.medicalimaging#ConflictException" }, { "target": "com.amazonaws.medicalimaging#InternalServerException" }, { "target": "com.amazonaws.medicalimaging#ResourceNotFoundException" }, { "target": "com.amazonaws.medicalimaging#ThrottlingException" }, { "target": "com.amazonaws.medicalimaging#ValidationException" } ], "traits": { "smithy.api#documentation": "Search image sets based on defined input attributes.
SearchImageSets accepts a single search query parameter and returns a paginated response of all image sets that have the matching criteria. All date range queries must be input as (lowerBound, upperBound).
By default, SearchImageSets uses the updatedAt field for sorting in descending order from newest to oldest.
The identifier of the data store where the image sets reside.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "searchCriteria": { "target": "com.amazonaws.medicalimaging#SearchCriteria", "traits": { "smithy.api#documentation": "The search criteria that filters by applying a maximum of 1 item to SearchByAttribute.
The maximum number of results that can be returned in a search.
", "smithy.api#httpQuery": "maxResults", "smithy.api#range": { "min": 1, "max": 50 } } }, "nextToken": { "target": "com.amazonaws.medicalimaging#NextToken", "traits": { "smithy.api#documentation": "The token used for pagination of results returned in the response. Use the token returned from the previous request to continue results where the previous request ended.
", "smithy.api#httpQuery": "nextToken" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.medicalimaging#SearchImageSetsResponse": { "type": "structure", "members": { "imageSetsMetadataSummaries": { "target": "com.amazonaws.medicalimaging#ImageSetsMetadataSummaries", "traits": { "smithy.api#documentation": "The model containing the image set results.
", "smithy.api#required": {} } }, "sort": { "target": "com.amazonaws.medicalimaging#Sort", "traits": { "smithy.api#documentation": "The sort order for image set search results.
" } }, "nextToken": { "target": "com.amazonaws.medicalimaging#NextToken", "traits": { "smithy.api#documentation": "The token for pagination results.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.medicalimaging#ServiceQuotaExceededException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The request caused a service quota to be exceeded.
", "smithy.api#error": "client", "smithy.api#httpError": 402 } }, "com.amazonaws.medicalimaging#Sort": { "type": "structure", "members": { "sortOrder": { "target": "com.amazonaws.medicalimaging#SortOrder", "traits": { "smithy.api#documentation": "The sort order for search criteria.
", "smithy.api#required": {} } }, "sortField": { "target": "com.amazonaws.medicalimaging#SortField", "traits": { "smithy.api#documentation": "The sort field for search criteria.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Sort search results.
" } }, "com.amazonaws.medicalimaging#SortField": { "type": "enum", "members": { "updatedAt": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "updatedAt" } }, "createdAt": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "createdAt" } }, "DICOMStudyDateAndTime": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DICOMStudyDateAndTime" } } } }, "com.amazonaws.medicalimaging#SortOrder": { "type": "enum", "members": { "ASC": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ASC" } }, "DESC": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DESC" } } } }, "com.amazonaws.medicalimaging#StartDICOMImportJob": { "type": "operation", "input": { "target": "com.amazonaws.medicalimaging#StartDICOMImportJobRequest" }, "output": { "target": "com.amazonaws.medicalimaging#StartDICOMImportJobResponse" }, "errors": [ { "target": "com.amazonaws.medicalimaging#AccessDeniedException" }, { "target": "com.amazonaws.medicalimaging#ConflictException" }, { "target": "com.amazonaws.medicalimaging#InternalServerException" }, { "target": "com.amazonaws.medicalimaging#ResourceNotFoundException" }, { "target": "com.amazonaws.medicalimaging#ServiceQuotaExceededException" }, { "target": "com.amazonaws.medicalimaging#ThrottlingException" }, { "target": "com.amazonaws.medicalimaging#ValidationException" } ], "traits": { "smithy.api#documentation": "Start importing bulk data into an ACTIVE data store. The import job imports DICOM P10 files or enhances existing DICOM files with JSON metadata. The importConfiguration parameter specifies the import type. The data is found in the S3 prefix specified by the inputS3Uri parameter. The import job stores processing results in the file specified by the outputS3Uri parameter.
The import job name.
" } }, "dataAccessRoleArn": { "target": "com.amazonaws.medicalimaging#RoleArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role that grants permission to access medical imaging resources.
", "smithy.api#required": {} } }, "clientToken": { "target": "com.amazonaws.medicalimaging#ClientToken", "traits": { "smithy.api#documentation": "A unique identifier for API idempotency.
", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } }, "datastoreId": { "target": "com.amazonaws.medicalimaging#DatastoreId", "traits": { "smithy.api#documentation": "The data store identifier.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "inputS3Uri": { "target": "com.amazonaws.medicalimaging#S3Uri", "traits": { "smithy.api#documentation": "The input prefix path for the S3 bucket that contains the DICOM files to be imported.
", "smithy.api#required": {} } }, "outputS3Uri": { "target": "com.amazonaws.medicalimaging#S3Uri", "traits": { "smithy.api#documentation": "The output prefix of the S3 bucket to upload the results of the DICOM import job.
", "smithy.api#required": {} } }, "inputOwnerAccountId": { "target": "com.amazonaws.medicalimaging#AwsAccountId", "traits": { "smithy.api#documentation": "The account ID of the source S3 bucket owner.
" } }, "importConfiguration": { "target": "com.amazonaws.medicalimaging#ImportConfiguration", "traits": { "smithy.api#documentation": "The import configuration for the import job.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.medicalimaging#StartDICOMImportJobResponse": { "type": "structure", "members": { "datastoreId": { "target": "com.amazonaws.medicalimaging#DatastoreId", "traits": { "smithy.api#documentation": "The data store identifier.
", "smithy.api#required": {} } }, "jobId": { "target": "com.amazonaws.medicalimaging#JobId", "traits": { "smithy.api#documentation": "The import job identifier.
", "smithy.api#required": {} } }, "jobStatus": { "target": "com.amazonaws.medicalimaging#JobStatus", "traits": { "smithy.api#documentation": "The import job status.
", "smithy.api#required": {} } }, "submittedAt": { "target": "com.amazonaws.medicalimaging#Date", "traits": { "smithy.api#documentation": "The timestamp when the import job was submitted.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.medicalimaging#StorageTier": { "type": "enum", "members": { "FREQUENT_ACCESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Frequent access storage tier for image sets that are accessed regularly", "smithy.api#enumValue": "FREQUENT_ACCESS" } }, "ARCHIVE_INSTANT_ACCESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Archive instant access storage tier for image sets that are accessed infrequently", "smithy.api#enumValue": "ARCHIVE_INSTANT_ACCESS" } } }, "traits": { "smithy.api#documentation": "Storage tier for image sets" } }, "com.amazonaws.medicalimaging#TagKey": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$" } }, "com.amazonaws.medicalimaging#TagKeyList": { "type": "list", "member": { "target": "com.amazonaws.medicalimaging#TagKey" }, "traits": { "smithy.api#length": { "min": 0, "max": 200 } } }, "com.amazonaws.medicalimaging#TagMap": { "type": "map", "key": { "target": "com.amazonaws.medicalimaging#TagKey" }, "value": { "target": "com.amazonaws.medicalimaging#TagValue" } }, "com.amazonaws.medicalimaging#TagResource": { "type": "operation", "input": { "target": "com.amazonaws.medicalimaging#TagResourceRequest" }, "output": { "target": "com.amazonaws.medicalimaging#TagResourceResponse" }, "errors": [ { "target": "com.amazonaws.medicalimaging#AccessDeniedException" }, { "target": "com.amazonaws.medicalimaging#InternalServerException" }, { "target": "com.amazonaws.medicalimaging#ResourceNotFoundException" }, { "target": "com.amazonaws.medicalimaging#ThrottlingException" }, { "target": "com.amazonaws.medicalimaging#ValidationException" } ], "traits": { "aws.iam#conditionKeys": [ "aws:RequestTag/${TagKey}", "aws:TagKeys" ], "smithy.api#documentation": "Adds a user-specifed key and value tag to a medical imaging resource.
", "smithy.api#http": { "method": "POST", "uri": "/tags/{resourceArn}" }, "smithy.api#idempotent": {} } }, "com.amazonaws.medicalimaging#TagResourceRequest": { "type": "structure", "members": { "resourceArn": { "target": "com.amazonaws.medicalimaging#Arn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the medical imaging resource that tags are being added to.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.medicalimaging#TagMap", "traits": { "smithy.api#documentation": "The user-specified key and value tag pairs added to a medical imaging resource.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {}, "smithy.api#references": [ { "resource": "com.amazonaws.medicalimaging#DatastoreResource", "ids": { "datastoreId": "resourceArn" } }, { "resource": "com.amazonaws.medicalimaging#ImageSetResource", "ids": { "datastoreId": "resourceArn", "imageSetId": "resourceArn" } } ] } }, "com.amazonaws.medicalimaging#TagResourceResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.medicalimaging#TagValue": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 } } }, "com.amazonaws.medicalimaging#ThrottlingException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The request was denied due to throttling.
", "smithy.api#error": "client", "smithy.api#httpError": 429 } }, "com.amazonaws.medicalimaging#UntagResource": { "type": "operation", "input": { "target": "com.amazonaws.medicalimaging#UntagResourceRequest" }, "output": { "target": "com.amazonaws.medicalimaging#UntagResourceResponse" }, "errors": [ { "target": "com.amazonaws.medicalimaging#AccessDeniedException" }, { "target": "com.amazonaws.medicalimaging#InternalServerException" }, { "target": "com.amazonaws.medicalimaging#ResourceNotFoundException" }, { "target": "com.amazonaws.medicalimaging#ThrottlingException" }, { "target": "com.amazonaws.medicalimaging#ValidationException" } ], "traits": { "aws.iam#conditionKeys": [ "aws:TagKeys" ], "smithy.api#documentation": "Removes tags from a medical imaging resource.
", "smithy.api#http": { "method": "DELETE", "uri": "/tags/{resourceArn}" }, "smithy.api#idempotent": {} } }, "com.amazonaws.medicalimaging#UntagResourceRequest": { "type": "structure", "members": { "resourceArn": { "target": "com.amazonaws.medicalimaging#Arn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the medical imaging resource that tags are being removed from.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "tagKeys": { "target": "com.amazonaws.medicalimaging#TagKeyList", "traits": { "smithy.api#documentation": "The keys for the tags to be removed from the medical imaging resource.
", "smithy.api#httpQuery": "tagKeys", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {}, "smithy.api#references": [ { "resource": "com.amazonaws.medicalimaging#DatastoreResource", "ids": { "datastoreId": "resourceArn" } }, { "resource": "com.amazonaws.medicalimaging#ImageSetResource", "ids": { "datastoreId": "resourceArn", "imageSetId": "resourceArn" } } ] } }, "com.amazonaws.medicalimaging#UntagResourceResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.medicalimaging#UpdateImageSetMetadata": { "type": "operation", "input": { "target": "com.amazonaws.medicalimaging#UpdateImageSetMetadataRequest" }, "output": { "target": "com.amazonaws.medicalimaging#UpdateImageSetMetadataResponse" }, "errors": [ { "target": "com.amazonaws.medicalimaging#AccessDeniedException" }, { "target": "com.amazonaws.medicalimaging#ConflictException" }, { "target": "com.amazonaws.medicalimaging#InternalServerException" }, { "target": "com.amazonaws.medicalimaging#ResourceNotFoundException" }, { "target": "com.amazonaws.medicalimaging#ServiceQuotaExceededException" }, { "target": "com.amazonaws.medicalimaging#ThrottlingException" }, { "target": "com.amazonaws.medicalimaging#ValidationException" } ], "traits": { "smithy.api#documentation": "Update image set metadata attributes.
", "smithy.api#endpoint": { "hostPrefix": "runtime-" }, "smithy.api#http": { "uri": "/datastore/{datastoreId}/imageSet/{imageSetId}/updateImageSetMetadata", "method": "POST" } } }, "com.amazonaws.medicalimaging#UpdateImageSetMetadataRequest": { "type": "structure", "members": { "datastoreId": { "target": "com.amazonaws.medicalimaging#DatastoreId", "traits": { "smithy.api#documentation": "The data store identifier.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "imageSetId": { "target": "com.amazonaws.medicalimaging#ImageSetId", "traits": { "smithy.api#documentation": "The image set identifier.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "latestVersionId": { "target": "com.amazonaws.medicalimaging#ImageSetExternalVersionId", "traits": { "smithy.api#documentation": "The latest image set version identifier.
", "smithy.api#httpQuery": "latestVersion", "smithy.api#required": {} } }, "force": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "Setting this flag will force the UpdateImageSetMetadata operation for the following attributes:
Tag.StudyInstanceUID, Tag.SeriesInstanceUID, Tag.SOPInstanceUID, and Tag.StudyID
Adding, removing, or updating private tags for an individual SOP Instance
Flag to apply the metadata updates to all image sets in the same Study as the requested image set ID.
", "smithy.api#httpQuery": "includeStudyImageSets" } }, "updateImageSetMetadataUpdates": { "target": "com.amazonaws.medicalimaging#MetadataUpdates", "traits": { "smithy.api#documentation": "Update image set metadata updates.
", "smithy.api#httpPayload": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.medicalimaging#UpdateImageSetMetadataResponse": { "type": "structure", "members": { "datastoreId": { "target": "com.amazonaws.medicalimaging#DatastoreId", "traits": { "smithy.api#documentation": "The data store identifier.
", "smithy.api#required": {} } }, "imageSetId": { "target": "com.amazonaws.medicalimaging#ImageSetId", "traits": { "smithy.api#documentation": "The image set identifier.
", "smithy.api#required": {} } }, "latestVersionId": { "target": "com.amazonaws.medicalimaging#ImageSetExternalVersionId", "traits": { "smithy.api#documentation": "The latest image set version identifier.
", "smithy.api#required": {} } }, "imageSetState": { "target": "com.amazonaws.medicalimaging#ImageSetState", "traits": { "smithy.api#documentation": "The image set state.
", "smithy.api#required": {} } }, "imageSetWorkflowStatus": { "target": "com.amazonaws.medicalimaging#ImageSetWorkflowStatus", "traits": { "smithy.api#documentation": "The image set workflow status.
" } }, "createdAt": { "target": "com.amazonaws.medicalimaging#Date", "traits": { "smithy.api#documentation": "The timestamp when image set metadata was created.
" } }, "updatedAt": { "target": "com.amazonaws.medicalimaging#Date", "traits": { "smithy.api#documentation": "The timestamp when image set metadata was updated.
" } }, "message": { "target": "com.amazonaws.medicalimaging#Message", "traits": { "smithy.api#documentation": "The error message thrown if an update image set metadata action fails.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.medicalimaging#ValidationException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The input fails to satisfy the constraints set by the service.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } } } }