Documentation ¶
Index ¶
- type AccessDeniedException
- type ConflictException
- type CopyDestinationImageSet
- type CopyDestinationImageSetProperties
- type CopyImageSetInformation
- type CopySourceImageSetInformation
- type CopySourceImageSetProperties
- type DICOMImportJobProperties
- type DICOMImportJobSummary
- type DICOMStudyDateAndTime
- type DICOMTags
- type DICOMUpdates
- type DatastoreProperties
- type DatastoreStatus
- type DatastoreSummary
- type ImageFrameInformation
- type ImageSetProperties
- type ImageSetState
- type ImageSetWorkflowStatus
- type ImageSetsMetadataSummary
- type InternalServerException
- type JobStatus
- type MetadataUpdates
- type MetadataUpdatesMemberDICOMUpdates
- type Operator
- type ResourceNotFoundException
- type SearchByAttributeValue
- type SearchByAttributeValueMemberCreatedAt
- type SearchByAttributeValueMemberDICOMAccessionNumber
- type SearchByAttributeValueMemberDICOMPatientId
- type SearchByAttributeValueMemberDICOMSeriesInstanceUID
- type SearchByAttributeValueMemberDICOMStudyDateAndTime
- type SearchByAttributeValueMemberDICOMStudyId
- type SearchByAttributeValueMemberDICOMStudyInstanceUID
- type SearchByAttributeValueMemberUpdatedAt
- type SearchCriteria
- type SearchFilter
- type ServiceQuotaExceededException
- type Sort
- type SortField
- type SortOrder
- type ThrottlingException
- type UnknownUnionMember
- type ValidationException
Examples ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AccessDeniedException ¶
type AccessDeniedException struct { Message *string ErrorCodeOverride *string // contains filtered or unexported fields }
The user does not have sufficient access to perform this action.
func (*AccessDeniedException) Error ¶
func (e *AccessDeniedException) Error() string
func (*AccessDeniedException) ErrorCode ¶
func (e *AccessDeniedException) ErrorCode() string
func (*AccessDeniedException) ErrorFault ¶
func (e *AccessDeniedException) ErrorFault() smithy.ErrorFault
func (*AccessDeniedException) ErrorMessage ¶
func (e *AccessDeniedException) ErrorMessage() string
type ConflictException ¶
type ConflictException struct { Message *string ErrorCodeOverride *string // contains filtered or unexported fields }
Updating or deleting a resource can cause an inconsistent state.
func (*ConflictException) Error ¶
func (e *ConflictException) Error() string
func (*ConflictException) ErrorCode ¶
func (e *ConflictException) ErrorCode() string
func (*ConflictException) ErrorFault ¶
func (e *ConflictException) ErrorFault() smithy.ErrorFault
func (*ConflictException) ErrorMessage ¶
func (e *ConflictException) ErrorMessage() string
type CopyDestinationImageSet ¶
type CopyDestinationImageSet struct { // The image set identifier for the destination image set. // // This member is required. ImageSetId *string // The latest version identifier for the destination image set. // // This member is required. LatestVersionId *string // contains filtered or unexported fields }
Copy the destination image set.
type CopyDestinationImageSetProperties ¶
type CopyDestinationImageSetProperties struct { // The image set identifier of the copied image set properties. // // This member is required. ImageSetId *string // The latest version identifier for the destination image set properties. // // This member is required. LatestVersionId *string // The timestamp when the destination image set properties were created. CreatedAt *time.Time // The Amazon Resource Name (ARN) assigned to the destination image set. ImageSetArn *string // The image set state of the destination image set properties. ImageSetState ImageSetState // The image set workflow status of the destination image set properties. ImageSetWorkflowStatus ImageSetWorkflowStatus // The timestamp when the destination image set properties were last updated. UpdatedAt *time.Time // contains filtered or unexported fields }
Copy the image set properties of the destination image set.
type CopyImageSetInformation ¶
type CopyImageSetInformation struct { // The source image set. // // This member is required. SourceImageSet *CopySourceImageSetInformation // The destination image set. DestinationImageSet *CopyDestinationImageSet // contains filtered or unexported fields }
Copy image set information.
type CopySourceImageSetInformation ¶
type CopySourceImageSetInformation struct { // The latest version identifier for the source image set. // // This member is required. LatestVersionId *string // contains filtered or unexported fields }
Copy source image set information.
type CopySourceImageSetProperties ¶
type CopySourceImageSetProperties struct { // The image set identifier for the copied source image set. // // This member is required. ImageSetId *string // The latest version identifier for the copied source image set. // // This member is required. LatestVersionId *string // The timestamp when the source image set properties were created. CreatedAt *time.Time // The Amazon Resource Name (ARN) assigned to the source image set. ImageSetArn *string // The image set state of the copied source image set. ImageSetState ImageSetState // The workflow status of the copied source image set. ImageSetWorkflowStatus ImageSetWorkflowStatus // The timestamp when the source image set properties were updated. UpdatedAt *time.Time // contains filtered or unexported fields }
Copy source image set properties.
type DICOMImportJobProperties ¶
type DICOMImportJobProperties struct { // The Amazon Resource Name (ARN) that grants permissions to access medical // imaging resources. // // This member is required. DataAccessRoleArn *string // The data store identifier. // // This member is required. DatastoreId *string // The input prefix path for the S3 bucket that contains the DICOM P10 files to be // imported. // // This member is required. InputS3Uri *string // The import job identifier. // // This member is required. JobId *string // The import job name. // // This member is required. JobName *string // The filters for listing import jobs based on status. // // This member is required. JobStatus JobStatus // The output prefix of the S3 bucket to upload the results of the DICOM import // job. // // This member is required. OutputS3Uri *string // The timestamp for when the import job was ended. EndedAt *time.Time // The error message thrown if an import job fails. Message *string // The timestamp for when the import job was submitted. SubmittedAt *time.Time // contains filtered or unexported fields }
Properties of the import job.
type DICOMImportJobSummary ¶
type DICOMImportJobSummary struct { // The data store identifier. // // This member is required. DatastoreId *string // The import job identifier. // // This member is required. JobId *string // The import job name. // // This member is required. JobName *string // The filters for listing import jobs based on status. // // This member is required. JobStatus JobStatus // The Amazon Resource Name (ARN) that grants permissions to access medical // imaging resources. DataAccessRoleArn *string // The timestamp when an import job ended. EndedAt *time.Time // The error message thrown if an import job fails. Message *string // The timestamp when an import job was submitted. SubmittedAt *time.Time // contains filtered or unexported fields }
Summary of import job.
type DICOMStudyDateAndTime ¶
type DICOMStudyDateAndTime struct { // The DICOM study date provided in yyMMdd format. // // This member is required. DICOMStudyDate *string // The DICOM study time provided in HHmmss.FFFFFF format. DICOMStudyTime *string // contains filtered or unexported fields }
The aggregated structure to store DICOM study date and study time for search capabilities.
type DICOMTags ¶
type DICOMTags struct { // The accession number for the DICOM study. DICOMAccessionNumber *string // The total number of instances in the DICOM study. DICOMNumberOfStudyRelatedInstances int32 // The total number of series in the DICOM study. DICOMNumberOfStudyRelatedSeries int32 // The patient birth date. DICOMPatientBirthDate *string // The unique identifier for a patient in a DICOM Study. DICOMPatientId *string // The patient name. DICOMPatientName *string // The patient sex. DICOMPatientSex *string // The DICOM provided identifier for the series Body Part Examined. DICOMSeriesBodyPart *string // The DICOM provided identifier for the Series Instance UID. DICOMSeriesInstanceUID *string // The DICOM provided identifier for the series Modality. DICOMSeriesModality *string // The DICOM provided identifier for the Series Number. DICOMSeriesNumber *int32 // The study date. DICOMStudyDate *string // The DICOM provided Study Description. DICOMStudyDescription *string // The DICOM provided identifier for the Study ID. DICOMStudyId *string // The DICOM provided identifier for the Study Instance UID. DICOMStudyInstanceUID *string // The study time. DICOMStudyTime *string // contains filtered or unexported fields }
The DICOM attributes returned as a part of a response. Each image set has these properties as part of a search result.
type DICOMUpdates ¶
type DICOMUpdates struct { // The DICOM tags to be removed from ImageSetMetadata . RemovableAttributes []byte // The DICOM tags that need to be updated in ImageSetMetadata . UpdatableAttributes []byte // contains filtered or unexported fields }
The object containing removableAttributes and updatableAttributes .
type DatastoreProperties ¶
type DatastoreProperties struct { // The data store identifier. // // This member is required. DatastoreId *string // The data store name. // // This member is required. DatastoreName *string // The data store status. // // This member is required. DatastoreStatus DatastoreStatus // The timestamp when the data store was created. CreatedAt *time.Time // The Amazon Resource Name (ARN) for the data store. DatastoreArn *string // The Amazon Resource Name (ARN) assigned to the Key Management Service (KMS) key // for accessing encrypted data. KmsKeyArn *string // The timestamp when the data store was last updated. UpdatedAt *time.Time // contains filtered or unexported fields }
The properties associated with the data store.
type DatastoreStatus ¶
type DatastoreStatus string
const ( DatastoreStatusCreating DatastoreStatus = "CREATING" DatastoreStatusCreateFailed DatastoreStatus = "CREATE_FAILED" DatastoreStatusActive DatastoreStatus = "ACTIVE" DatastoreStatusDeleting DatastoreStatus = "DELETING" DatastoreStatusDeleted DatastoreStatus = "DELETED" )
Enum values for DatastoreStatus
func (DatastoreStatus) Values ¶
func (DatastoreStatus) Values() []DatastoreStatus
Values returns all known values for DatastoreStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type DatastoreSummary ¶
type DatastoreSummary struct { // The data store identifier. // // This member is required. DatastoreId *string // The data store name. // // This member is required. DatastoreName *string // The data store status. // // This member is required. DatastoreStatus DatastoreStatus // The timestamp when the data store was created. CreatedAt *time.Time // The Amazon Resource Name (ARN) for the data store. DatastoreArn *string // The timestamp when the data store was last updated. UpdatedAt *time.Time // contains filtered or unexported fields }
List of summaries of data stores.
type ImageFrameInformation ¶
type ImageFrameInformation struct { // The image frame (pixel data) identifier. // // This member is required. ImageFrameId *string // contains filtered or unexported fields }
Information about the image frame (pixel data) identifier.
type ImageSetProperties ¶
type ImageSetProperties struct { // The image set identifier. // // This member is required. ImageSetId *string // The image set state. // // This member is required. ImageSetState ImageSetState // The image set version identifier. // // This member is required. VersionId *string // The timestamp when the image set properties were created. CreatedAt *time.Time // The timestamp when the image set properties were deleted. DeletedAt *time.Time // The image set workflow status. ImageSetWorkflowStatus ImageSetWorkflowStatus // The error message thrown if an image set action fails. Message *string // The timestamp when the image set properties were updated. UpdatedAt *time.Time // contains filtered or unexported fields }
The image set properties.
type ImageSetState ¶
type ImageSetState string
const ( ImageSetStateActive ImageSetState = "ACTIVE" ImageSetStateLocked ImageSetState = "LOCKED" ImageSetStateDeleted ImageSetState = "DELETED" )
Enum values for ImageSetState
func (ImageSetState) Values ¶
func (ImageSetState) Values() []ImageSetState
Values returns all known values for ImageSetState. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type ImageSetWorkflowStatus ¶
type ImageSetWorkflowStatus string
const ( ImageSetWorkflowStatusCreated ImageSetWorkflowStatus = "CREATED" ImageSetWorkflowStatusCopied ImageSetWorkflowStatus = "COPIED" ImageSetWorkflowStatusCopying ImageSetWorkflowStatus = "COPYING" ImageSetWorkflowStatusCopyingWithReadOnlyAccess ImageSetWorkflowStatus = "COPYING_WITH_READ_ONLY_ACCESS" ImageSetWorkflowStatusCopyFailed ImageSetWorkflowStatus = "COPY_FAILED" ImageSetWorkflowStatusUpdating ImageSetWorkflowStatus = "UPDATING" ImageSetWorkflowStatusUpdated ImageSetWorkflowStatus = "UPDATED" ImageSetWorkflowStatusUpdateFailed ImageSetWorkflowStatus = "UPDATE_FAILED" ImageSetWorkflowStatusDeleting ImageSetWorkflowStatus = "DELETING" ImageSetWorkflowStatusDeleted ImageSetWorkflowStatus = "DELETED" )
Enum values for ImageSetWorkflowStatus
func (ImageSetWorkflowStatus) Values ¶
func (ImageSetWorkflowStatus) Values() []ImageSetWorkflowStatus
Values returns all known values for ImageSetWorkflowStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type ImageSetsMetadataSummary ¶
type ImageSetsMetadataSummary struct { // The image set identifier. // // This member is required. ImageSetId *string // The time an image set is created. Sample creation date is provided in // 1985-04-12T23:20:50.52Z format. CreatedAt *time.Time // The DICOM tags associated with the image set. DICOMTags *DICOMTags // The time an image set was last updated. UpdatedAt *time.Time // The image set version. Version *int32 // contains filtered or unexported fields }
Summary of the image set metadata.
type InternalServerException ¶
type InternalServerException struct { Message *string ErrorCodeOverride *string // contains filtered or unexported fields }
An unexpected error occurred during processing of the request.
func (*InternalServerException) Error ¶
func (e *InternalServerException) Error() string
func (*InternalServerException) ErrorCode ¶
func (e *InternalServerException) ErrorCode() string
func (*InternalServerException) ErrorFault ¶
func (e *InternalServerException) ErrorFault() smithy.ErrorFault
func (*InternalServerException) ErrorMessage ¶
func (e *InternalServerException) ErrorMessage() string
type JobStatus ¶
type JobStatus string
type MetadataUpdates ¶
type MetadataUpdates interface {
// contains filtered or unexported methods
}
Contains DICOMUpdates.
The following types satisfy this interface:
MetadataUpdatesMemberDICOMUpdates
Example (OutputUsage) ¶
package main import ( "e.coding.net/g-nnjn4981/aito/aws-sdk-go-v2/service/medicalimaging/types" "fmt" ) func main() { var union types.MetadataUpdates // type switches can be used to check the union value switch v := union.(type) { case *types.MetadataUpdatesMemberDICOMUpdates: _ = v.Value // Value is types.DICOMUpdates case *types.UnknownUnionMember: fmt.Println("unknown tag:", v.Tag) default: fmt.Println("union is nil or unknown type") } }
Output:
type MetadataUpdatesMemberDICOMUpdates ¶
type MetadataUpdatesMemberDICOMUpdates struct { Value DICOMUpdates // contains filtered or unexported fields }
The object containing removableAttributes and updatableAttributes .
type ResourceNotFoundException ¶
type ResourceNotFoundException struct { Message *string ErrorCodeOverride *string // contains filtered or unexported fields }
The request references a resource which does not exist.
func (*ResourceNotFoundException) Error ¶
func (e *ResourceNotFoundException) Error() string
func (*ResourceNotFoundException) ErrorCode ¶
func (e *ResourceNotFoundException) ErrorCode() string
func (*ResourceNotFoundException) ErrorFault ¶
func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault
func (*ResourceNotFoundException) ErrorMessage ¶
func (e *ResourceNotFoundException) ErrorMessage() string
type SearchByAttributeValue ¶
type SearchByAttributeValue interface {
// contains filtered or unexported methods
}
The search input attribute value.
The following types satisfy this interface:
SearchByAttributeValueMemberCreatedAt SearchByAttributeValueMemberDICOMAccessionNumber SearchByAttributeValueMemberDICOMPatientId SearchByAttributeValueMemberDICOMSeriesInstanceUID SearchByAttributeValueMemberDICOMStudyDateAndTime SearchByAttributeValueMemberDICOMStudyId SearchByAttributeValueMemberDICOMStudyInstanceUID SearchByAttributeValueMemberUpdatedAt
Example (OutputUsage) ¶
package main import ( "e.coding.net/g-nnjn4981/aito/aws-sdk-go-v2/service/medicalimaging/types" "fmt" ) func main() { var union types.SearchByAttributeValue // type switches can be used to check the union value switch v := union.(type) { case *types.SearchByAttributeValueMemberCreatedAt: _ = v.Value // Value is time.Time case *types.SearchByAttributeValueMemberDICOMAccessionNumber: _ = v.Value // Value is string case *types.SearchByAttributeValueMemberDICOMPatientId: _ = v.Value // Value is string case *types.SearchByAttributeValueMemberDICOMSeriesInstanceUID: _ = v.Value // Value is string case *types.SearchByAttributeValueMemberDICOMStudyDateAndTime: _ = v.Value // Value is types.DICOMStudyDateAndTime case *types.SearchByAttributeValueMemberDICOMStudyId: _ = v.Value // Value is string case *types.SearchByAttributeValueMemberDICOMStudyInstanceUID: _ = v.Value // Value is string case *types.SearchByAttributeValueMemberUpdatedAt: _ = v.Value // Value is time.Time case *types.UnknownUnionMember: fmt.Println("unknown tag:", v.Tag) default: fmt.Println("union is nil or unknown type") } }
Output:
type SearchByAttributeValueMemberCreatedAt ¶
type SearchByAttributeValueMemberCreatedAt struct { Value time.Time // contains filtered or unexported fields }
The created at time of the image set provided for search.
type SearchByAttributeValueMemberDICOMAccessionNumber ¶
type SearchByAttributeValueMemberDICOMAccessionNumber struct { Value string // contains filtered or unexported fields }
The DICOM accession number for search.
type SearchByAttributeValueMemberDICOMPatientId ¶
type SearchByAttributeValueMemberDICOMPatientId struct { Value string // contains filtered or unexported fields }
The patient ID input for search.
type SearchByAttributeValueMemberDICOMSeriesInstanceUID ¶
type SearchByAttributeValueMemberDICOMSeriesInstanceUID struct { Value string // contains filtered or unexported fields }
The Series Instance UID input for search.
type SearchByAttributeValueMemberDICOMStudyDateAndTime ¶
type SearchByAttributeValueMemberDICOMStudyDateAndTime struct { Value DICOMStudyDateAndTime // contains filtered or unexported fields }
The aggregated structure containing DICOM study date and study time for search.
type SearchByAttributeValueMemberDICOMStudyId ¶
type SearchByAttributeValueMemberDICOMStudyId struct { Value string // contains filtered or unexported fields }
The DICOM study ID for search.
type SearchByAttributeValueMemberDICOMStudyInstanceUID ¶
type SearchByAttributeValueMemberDICOMStudyInstanceUID struct { Value string // contains filtered or unexported fields }
The DICOM study instance UID for search.
type SearchByAttributeValueMemberUpdatedAt ¶
type SearchByAttributeValueMemberUpdatedAt struct { Value time.Time // contains filtered or unexported fields }
The timestamp input for search.
type SearchCriteria ¶
type SearchCriteria struct { // The filters for the search criteria. Filters []SearchFilter // The sort input for search criteria. Sort *Sort // contains filtered or unexported fields }
The search criteria.
type SearchFilter ¶
type SearchFilter struct { // The search filter operator for imageSetDateTime . // // This member is required. Operator Operator // The search filter values. // // This member is required. Values []SearchByAttributeValue // contains filtered or unexported fields }
The search filter.
type ServiceQuotaExceededException ¶
type ServiceQuotaExceededException struct { Message *string ErrorCodeOverride *string // contains filtered or unexported fields }
The request caused a service quota to be exceeded.
func (*ServiceQuotaExceededException) Error ¶
func (e *ServiceQuotaExceededException) Error() string
func (*ServiceQuotaExceededException) ErrorCode ¶
func (e *ServiceQuotaExceededException) ErrorCode() string
func (*ServiceQuotaExceededException) ErrorFault ¶
func (e *ServiceQuotaExceededException) ErrorFault() smithy.ErrorFault
func (*ServiceQuotaExceededException) ErrorMessage ¶
func (e *ServiceQuotaExceededException) ErrorMessage() string
type Sort ¶
type Sort struct { // The sort field for search criteria. // // This member is required. SortField SortField // The sort order for search criteria. // // This member is required. SortOrder SortOrder // contains filtered or unexported fields }
Sort search results.
type SortField ¶
type SortField string
type ThrottlingException ¶
type ThrottlingException struct { Message *string ErrorCodeOverride *string // contains filtered or unexported fields }
The request was denied due to throttling.
func (*ThrottlingException) Error ¶
func (e *ThrottlingException) Error() string
func (*ThrottlingException) ErrorCode ¶
func (e *ThrottlingException) ErrorCode() string
func (*ThrottlingException) ErrorFault ¶
func (e *ThrottlingException) ErrorFault() smithy.ErrorFault
func (*ThrottlingException) ErrorMessage ¶
func (e *ThrottlingException) ErrorMessage() string
type UnknownUnionMember ¶
type UnknownUnionMember struct { Tag string Value []byte // contains filtered or unexported fields }
UnknownUnionMember is returned when a union member is returned over the wire, but has an unknown tag.
type ValidationException ¶
type ValidationException struct { Message *string ErrorCodeOverride *string // contains filtered or unexported fields }
The input fails to satisfy the constraints set by the service.
func (*ValidationException) Error ¶
func (e *ValidationException) Error() string
func (*ValidationException) ErrorCode ¶
func (e *ValidationException) ErrorCode() string
func (*ValidationException) ErrorFault ¶
func (e *ValidationException) ErrorFault() smithy.ErrorFault
func (*ValidationException) ErrorMessage ¶
func (e *ValidationException) ErrorMessage() string