medicalimaging

package module
v0.0.0-...-68f2935 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 24, 2024 License: Apache-2.0 Imports: 40 Imported by: 0

Documentation

Overview

Package medicalimaging provides the API client, operations, and parameter types for AWS Health Imaging.

This is the AWS HealthImaging API Reference. AWS HealthImaging is a HIPAA eligible service that empowers healthcare providers, life science organizations, and their software partners to store, analyze, and share medical images in the cloud at petabyte scale. For an introduction to the service, see the AWS HealthImaging Developer Guide.

We recommend using one of the AWS Software Development Kits (SDKs) for your programming language, as they take care of request authentication, serialization, and connection management. For more information, see Tools to build on AWS.

The following sections list AWS HealthImaging API actions categorized according to functionality. Links are provided to actions within this Reference, along with links back to corresponding sections in the AWS HealthImaging Developer Guide where you can view tested code examples.

Data store actions

CreateDatastore

GetDatastore

ListDatastores

DeleteDatastore

Import job actions

StartDICOMImportJob

GetDICOMImportJob

ListDICOMImportJobs

Image set access actions

SearchImageSets

GetImageSet

GetImageSetMetadata

GetImageFrame

Image set modification actions

ListImageSetVersions

UpdateImageSetMetadata

CopyImageSet

DeleteImageSet

Tagging actions

TagResource

ListTagsForResource

UntagResource

Index

Constants

View Source 
const ServiceAPIVersion = "2023-07-19"
View Source 
const ServiceID = "Medical Imaging"

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver 

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions 

func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

WithAPIOptions returns a functional option for setting the Client's APIOptions option.

func WithEndpointResolver deprecated 

func WithEndpointResolver(v EndpointResolver) func(*Options)

Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for this field will likely prevent you from using any endpoint-related service features released after the introduction of EndpointResolverV2 and BaseEndpoint.

To migrate an EndpointResolver implementation that uses a custom endpoint, set the client option BaseEndpoint instead.

func WithEndpointResolverV2 

func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)

WithEndpointResolverV2 returns a functional option for setting the Client's EndpointResolverV2 option.

func WithSigV4SigningName 

func WithSigV4SigningName(name string) func(*Options)

WithSigV4SigningName applies an override to the authentication workflow to use the given signing name for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing name from both auth scheme resolution and endpoint resolution.

func WithSigV4SigningRegion 

func WithSigV4SigningRegion(region string) func(*Options)

WithSigV4SigningRegion applies an override to the authentication workflow to use the given signing region for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing region from both auth scheme resolution and endpoint resolution.

Types

type AuthResolverParameters 

type AuthResolverParameters struct {
	// The name of the operation being invoked.
	Operation string

	// The region in which the operation is being invoked.
	Region string
}

AuthResolverParameters contains the set of inputs necessary for auth scheme resolution.

type AuthSchemeResolver 

type AuthSchemeResolver interface {
	ResolveAuthSchemes(context.Context, *AuthResolverParameters) ([]*smithyauth.Option, error)
}

AuthSchemeResolver returns a set of possible authentication options for an operation.

type Client 

type Client struct {
	// contains filtered or unexported fields
}

Client provides the API client to make operations call for AWS Health Imaging.

func New 

func New(options Options, optFns ...func(*Options)) *Client

New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

func NewFromConfig 

func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

NewFromConfig returns a new client from the provided config.

func (*Client) CopyImageSet 

func (c *Client) CopyImageSet(ctx context.Context, params *CopyImageSetInput, optFns ...func(*Options)) (*CopyImageSetOutput, error)

Copy an image set.

func (*Client) CreateDatastore 

func (c *Client) CreateDatastore(ctx context.Context, params *CreateDatastoreInput, optFns ...func(*Options)) (*CreateDatastoreOutput, error)

Create a data store.

func (*Client) DeleteDatastore 

func (c *Client) DeleteDatastore(ctx context.Context, params *DeleteDatastoreInput, optFns ...func(*Options)) (*DeleteDatastoreOutput, error)

Delete a data store.

Before a data store can be deleted, you must first delete all image sets within it.

func (*Client) DeleteImageSet 

func (c *Client) DeleteImageSet(ctx context.Context, params *DeleteImageSetInput, optFns ...func(*Options)) (*DeleteImageSetOutput, error)

Delete an image set.

func (*Client) GetDICOMImportJob 

func (c *Client) GetDICOMImportJob(ctx context.Context, params *GetDICOMImportJobInput, optFns ...func(*Options)) (*GetDICOMImportJobOutput, error)

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.

func (*Client) GetDatastore 

func (c *Client) GetDatastore(ctx context.Context, params *GetDatastoreInput, optFns ...func(*Options)) (*GetDatastoreOutput, error)

Get data store properties.

func (*Client) GetImageFrame 

func (c *Client) GetImageFrame(ctx context.Context, params *GetImageFrameInput, optFns ...func(*Options)) (*GetImageFrameOutput, error)

Get an image frame (pixel data) for an image set.

func (*Client) GetImageSet 

func (c *Client) GetImageSet(ctx context.Context, params *GetImageSetInput, optFns ...func(*Options)) (*GetImageSetOutput, error)

Get image set properties.

func (*Client) GetImageSetMetadata 

func (c *Client) GetImageSetMetadata(ctx context.Context, params *GetImageSetMetadataInput, optFns ...func(*Options)) (*GetImageSetMetadataOutput, error)

Get metadata attributes for an image set.

func (*Client) ListDICOMImportJobs 

func (c *Client) ListDICOMImportJobs(ctx context.Context, params *ListDICOMImportJobsInput, optFns ...func(*Options)) (*ListDICOMImportJobsOutput, error)

List import jobs created for a specific data store.

func (*Client) ListDatastores 

func (c *Client) ListDatastores(ctx context.Context, params *ListDatastoresInput, optFns ...func(*Options)) (*ListDatastoresOutput, error)

List data stores.

func (*Client) ListImageSetVersions 

func (c *Client) ListImageSetVersions(ctx context.Context, params *ListImageSetVersionsInput, optFns ...func(*Options)) (*ListImageSetVersionsOutput, error)

List image set versions.

func (*Client) ListTagsForResource 

func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)

Lists all tags associated with a medical imaging resource.

func (*Client) Options 

func (c *Client) Options() Options

Options returns a copy of the client configuration.

Callers SHOULD NOT perform mutations on any inner structures within client config. Config overrides should instead be made on a per-operation basis through functional options.

func (*Client) SearchImageSets 

func (c *Client) SearchImageSets(ctx context.Context, params *SearchImageSetsInput, optFns ...func(*Options)) (*SearchImageSetsOutput, error)

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.

func (*Client) StartDICOMImportJob 

func (c *Client) StartDICOMImportJob(ctx context.Context, params *StartDICOMImportJobInput, optFns ...func(*Options)) (*StartDICOMImportJobOutput, error)

Start importing bulk data into an ACTIVE data store. The import job imports DICOM P10 files found in the S3 prefix specified by the inputS3Uri parameter. The import job stores processing results in the file specified by the outputS3Uri parameter.

func (*Client) TagResource 

func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)

Adds a user-specifed key and value tag to a medical imaging resource.

func (*Client) UntagResource 

func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)

Removes tags from a medical imaging resource.

func (*Client) UpdateImageSetMetadata 

func (c *Client) UpdateImageSetMetadata(ctx context.Context, params *UpdateImageSetMetadataInput, optFns ...func(*Options)) (*UpdateImageSetMetadataOutput, error)

Update image set metadata attributes.

type CopyImageSetInput 

type CopyImageSetInput struct {

	// Copy image set information.
	//
	// This member is required.
	CopyImageSetInformation *types.CopyImageSetInformation

	// The data store identifier.
	//
	// This member is required.
	DatastoreId *string

	// The source image set identifier.
	//
	// This member is required.
	SourceImageSetId *string
	// contains filtered or unexported fields
}

type CopyImageSetOutput 

type CopyImageSetOutput struct {

	// The data store identifier.
	//
	// This member is required.
	DatastoreId *string

	// The properties of the destination image set.
	//
	// This member is required.
	DestinationImageSetProperties *types.CopyDestinationImageSetProperties

	// The properties of the source image set.
	//
	// This member is required.
	SourceImageSetProperties *types.CopySourceImageSetProperties

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateDatastoreInput 

type CreateDatastoreInput struct {

	// A unique identifier for API idempotency.
	//
	// This member is required.
	ClientToken *string

	// The data store name.
	DatastoreName *string

	// The Amazon Resource Name (ARN) assigned to the Key Management Service (KMS) key
	// for accessing encrypted data.
	KmsKeyArn *string

	// The tags provided when creating a data store.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateDatastoreOutput 

type CreateDatastoreOutput struct {

	// The data store identifier.
	//
	// This member is required.
	DatastoreId *string

	// The data store status.
	//
	// This member is required.
	DatastoreStatus types.DatastoreStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteDatastoreInput 

type DeleteDatastoreInput struct {

	// The data store identifier.
	//
	// This member is required.
	DatastoreId *string
	// contains filtered or unexported fields
}

type DeleteDatastoreOutput 

type DeleteDatastoreOutput struct {

	// The data store identifier.
	//
	// This member is required.
	DatastoreId *string

	// The data store status.
	//
	// This member is required.
	DatastoreStatus types.DatastoreStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteImageSetInput 

type DeleteImageSetInput struct {

	// The data store identifier.
	//
	// This member is required.
	DatastoreId *string

	// The image set identifier.
	//
	// This member is required.
	ImageSetId *string
	// contains filtered or unexported fields
}

type DeleteImageSetOutput 

type DeleteImageSetOutput struct {

	// The data store identifier.
	//
	// This member is required.
	DatastoreId *string

	// The image set identifier.
	//
	// This member is required.
	ImageSetId *string

	// The image set state.
	//
	// This member is required.
	ImageSetState types.ImageSetState

	// The image set workflow status.
	//
	// This member is required.
	ImageSetWorkflowStatus types.ImageSetWorkflowStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type EndpointParameters 

type EndpointParameters struct {
	// The AWS region used to dispatch the request.
	//
	// Parameter is
	// required.
	//
	// AWS::Region
	Region *string

	// When true, use the dual-stack endpoint. If the configured endpoint does not
	// support dual-stack, dispatching the request MAY return an error.
	//
	// Defaults to
	// false if no value is provided.
	//
	// AWS::UseDualStack
	UseDualStack *bool

	// 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.
	//
	// Defaults to false if no value is
	// provided.
	//
	// AWS::UseFIPS
	UseFIPS *bool

	// Override the endpoint used to send this request
	//
	// Parameter is
	// required.
	//
	// SDK::Endpoint
	Endpoint *string
}

EndpointParameters provides the parameters that influence how endpoints are resolved.

func (EndpointParameters) ValidateRequired 

func (p EndpointParameters) ValidateRequired() error

ValidateRequired validates required parameters are set.

func (EndpointParameters) WithDefaults 

func (p EndpointParameters) WithDefaults() EndpointParameters

WithDefaults returns a shallow copy of EndpointParameterswith default values applied to members where applicable.

type EndpointResolver 

type EndpointResolver interface {
	ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}

EndpointResolver interface for resolving service endpoints.

func EndpointResolverFromURL 

func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

type EndpointResolverFunc 

type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)

EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

func (EndpointResolverFunc) ResolveEndpoint 

func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)

type EndpointResolverOptions 

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type EndpointResolverV2 

type EndpointResolverV2 interface {
	// ResolveEndpoint attempts to resolve the endpoint with the provided options,
	// returning the endpoint if found. Otherwise an error is returned.
	ResolveEndpoint(ctx context.Context, params EndpointParameters) (
		smithyendpoints.Endpoint, error,
	)
}

EndpointResolverV2 provides the interface for resolving service endpoints.

func NewDefaultEndpointResolverV2 

func NewDefaultEndpointResolverV2() EndpointResolverV2

type GetDICOMImportJobInput 

type GetDICOMImportJobInput struct {

	// The data store identifier.
	//
	// This member is required.
	DatastoreId *string

	// The import job identifier.
	//
	// This member is required.
	JobId *string
	// contains filtered or unexported fields
}

type GetDICOMImportJobOutput 

type GetDICOMImportJobOutput struct {

	// The properties of the import job.
	//
	// This member is required.
	JobProperties *types.DICOMImportJobProperties

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetDatastoreInput 

type GetDatastoreInput struct {

	// The data store identifier.
	//
	// This member is required.
	DatastoreId *string
	// contains filtered or unexported fields
}

type GetDatastoreOutput 

type GetDatastoreOutput struct {

	// The data store properties.
	//
	// This member is required.
	DatastoreProperties *types.DatastoreProperties

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetImageFrameInput 

type GetImageFrameInput struct {

	// The data store identifier.
	//
	// This member is required.
	DatastoreId *string

	// Information about the image frame (pixel data) identifier.
	//
	// This member is required.
	ImageFrameInformation *types.ImageFrameInformation

	// The image set identifier.
	//
	// This member is required.
	ImageSetId *string
	// contains filtered or unexported fields
}

type GetImageFrameOutput 

type GetImageFrameOutput struct {

	// The blob containing the aggregated image frame information.
	//
	// This member is required.
	ImageFrameBlob io.ReadCloser

	// The format in which the image frame information is returned to the customer.
	// Default is application/octet-stream .
	ContentType *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetImageSetInput 

type GetImageSetInput struct {

	// The data store identifier.
	//
	// This member is required.
	DatastoreId *string

	// The image set identifier.
	//
	// This member is required.
	ImageSetId *string

	// The image set version identifier.
	VersionId *string
	// contains filtered or unexported fields
}

type GetImageSetMetadataInput 

type GetImageSetMetadataInput struct {

	// The data store identifier.
	//
	// This member is required.
	DatastoreId *string

	// The image set identifier.
	//
	// This member is required.
	ImageSetId *string

	// The image set version identifier.
	VersionId *string
	// contains filtered or unexported fields
}

type GetImageSetMetadataOutput 

type GetImageSetMetadataOutput struct {

	// The blob containing the aggregated metadata information for the image set.
	//
	// This member is required.
	ImageSetMetadataBlob io.ReadCloser

	// The compression format in which image set metadata attributes are returned.
	ContentEncoding *string

	// The format in which the study metadata is returned to the customer. Default is
	// text/plain .
	ContentType *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetImageSetOutput 

type GetImageSetOutput struct {

	// The data store identifier.
	//
	// This member is required.
	DatastoreId *string

	// The image set identifier.
	//
	// This member is required.
	ImageSetId *string

	// The image set state.
	//
	// This member is required.
	ImageSetState types.ImageSetState

	// The image set version identifier.
	//
	// This member is required.
	VersionId *string

	// The timestamp when image set properties were created.
	CreatedAt *time.Time

	// The timestamp when the image set properties were deleted.
	DeletedAt *time.Time

	// The Amazon Resource Name (ARN) assigned to the image set.
	ImageSetArn *string

	// The image set workflow status.
	ImageSetWorkflowStatus types.ImageSetWorkflowStatus

	// The error message thrown if an image set action fails.
	Message *string

	// The timestamp when image set properties were updated.
	UpdatedAt *time.Time

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type HTTPClient 

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

type HTTPSignerV4 

type HTTPSignerV4 interface {
	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error
}

type IdempotencyTokenProvider 

type IdempotencyTokenProvider interface {
	GetIdempotencyToken() (string, error)
}

IdempotencyTokenProvider interface for providing idempotency token

type ListDICOMImportJobsAPIClient 

type ListDICOMImportJobsAPIClient interface {
	ListDICOMImportJobs(context.Context, *ListDICOMImportJobsInput, ...func(*Options)) (*ListDICOMImportJobsOutput, error)
}

ListDICOMImportJobsAPIClient is a client that implements the ListDICOMImportJobs operation.

type ListDICOMImportJobsInput 

type ListDICOMImportJobsInput struct {

	// The data store identifier.
	//
	// This member is required.
	DatastoreId *string

	// The filters for listing import jobs based on status.
	JobStatus types.JobStatus

	// The max results count. The upper bound is determined by load testing.
	MaxResults *int32

	// The pagination token used to request the list of import jobs on the next page.
	NextToken *string
	// contains filtered or unexported fields
}

type ListDICOMImportJobsOutput 

type ListDICOMImportJobsOutput struct {

	// A list of job summaries.
	//
	// This member is required.
	JobSummaries []types.DICOMImportJobSummary

	// The pagination token used to retrieve the list of import jobs on the next page.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListDICOMImportJobsPaginator 

type ListDICOMImportJobsPaginator struct {
	// contains filtered or unexported fields
}

ListDICOMImportJobsPaginator is a paginator for ListDICOMImportJobs

func NewListDICOMImportJobsPaginator 

func NewListDICOMImportJobsPaginator(client ListDICOMImportJobsAPIClient, params *ListDICOMImportJobsInput, optFns ...func(*ListDICOMImportJobsPaginatorOptions)) *ListDICOMImportJobsPaginator

NewListDICOMImportJobsPaginator returns a new ListDICOMImportJobsPaginator

func (*ListDICOMImportJobsPaginator) HasMorePages 

func (p *ListDICOMImportJobsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListDICOMImportJobsPaginator) NextPage 

func (p *ListDICOMImportJobsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListDICOMImportJobsOutput, error)

NextPage retrieves the next ListDICOMImportJobs page.

type ListDICOMImportJobsPaginatorOptions 

type ListDICOMImportJobsPaginatorOptions struct {
	// The max results count. The upper bound is determined by load testing.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListDICOMImportJobsPaginatorOptions is the paginator options for ListDICOMImportJobs

type ListDatastoresAPIClient 

type ListDatastoresAPIClient interface {
	ListDatastores(context.Context, *ListDatastoresInput, ...func(*Options)) (*ListDatastoresOutput, error)
}

ListDatastoresAPIClient is a client that implements the ListDatastores operation.

type ListDatastoresInput 

type ListDatastoresInput struct {

	// The data store status.
	DatastoreStatus types.DatastoreStatus

	// Valid Range: Minimum value of 1. Maximum value of 50.
	MaxResults *int32

	// The pagination token used to request the list of data stores on the next page.
	NextToken *string
	// contains filtered or unexported fields
}

type ListDatastoresOutput 

type ListDatastoresOutput struct {

	// The list of summaries of data stores.
	DatastoreSummaries []types.DatastoreSummary

	// The pagination token used to retrieve the list of data stores on the next page.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListDatastoresPaginator 

type ListDatastoresPaginator struct {
	// contains filtered or unexported fields
}

ListDatastoresPaginator is a paginator for ListDatastores

func NewListDatastoresPaginator 

func NewListDatastoresPaginator(client ListDatastoresAPIClient, params *ListDatastoresInput, optFns ...func(*ListDatastoresPaginatorOptions)) *ListDatastoresPaginator

NewListDatastoresPaginator returns a new ListDatastoresPaginator

func (*ListDatastoresPaginator) HasMorePages 

func (p *ListDatastoresPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListDatastoresPaginator) NextPage 

func (p *ListDatastoresPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListDatastoresOutput, error)

NextPage retrieves the next ListDatastores page.

type ListDatastoresPaginatorOptions 

type ListDatastoresPaginatorOptions struct {
	// Valid Range: Minimum value of 1. Maximum value of 50.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListDatastoresPaginatorOptions is the paginator options for ListDatastores

type ListImageSetVersionsAPIClient 

type ListImageSetVersionsAPIClient interface {
	ListImageSetVersions(context.Context, *ListImageSetVersionsInput, ...func(*Options)) (*ListImageSetVersionsOutput, error)
}

ListImageSetVersionsAPIClient is a client that implements the ListImageSetVersions operation.

type ListImageSetVersionsInput 

type ListImageSetVersionsInput struct {

	// The data store identifier.
	//
	// This member is required.
	DatastoreId *string

	// The image set identifier.
	//
	// This member is required.
	ImageSetId *string

	// The max results count.
	MaxResults *int32

	// The pagination token used to request the list of image set versions on the next
	// page.
	NextToken *string
	// contains filtered or unexported fields
}

type ListImageSetVersionsOutput 

type ListImageSetVersionsOutput struct {

	// Lists all properties associated with an image set.
	//
	// This member is required.
	ImageSetPropertiesList []types.ImageSetProperties

	// The pagination token used to retrieve the list of image set versions on the
	// next page.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListImageSetVersionsPaginator 

type ListImageSetVersionsPaginator struct {
	// contains filtered or unexported fields
}

ListImageSetVersionsPaginator is a paginator for ListImageSetVersions

func NewListImageSetVersionsPaginator 

func NewListImageSetVersionsPaginator(client ListImageSetVersionsAPIClient, params *ListImageSetVersionsInput, optFns ...func(*ListImageSetVersionsPaginatorOptions)) *ListImageSetVersionsPaginator

NewListImageSetVersionsPaginator returns a new ListImageSetVersionsPaginator

func (*ListImageSetVersionsPaginator) HasMorePages 

func (p *ListImageSetVersionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListImageSetVersionsPaginator) NextPage 

func (p *ListImageSetVersionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListImageSetVersionsOutput, error)

NextPage retrieves the next ListImageSetVersions page.

type ListImageSetVersionsPaginatorOptions 

type ListImageSetVersionsPaginatorOptions struct {
	// The max results count.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListImageSetVersionsPaginatorOptions is the paginator options for ListImageSetVersions

type ListTagsForResourceInput 

type ListTagsForResourceInput struct {

	// The Amazon Resource Name (ARN) of the medical imaging resource to list tags for.
	//
	// This member is required.
	ResourceArn *string
	// contains filtered or unexported fields
}

type ListTagsForResourceOutput 

type ListTagsForResourceOutput struct {

	// A list of all tags associated with a medical imaging resource.
	//
	// This member is required.
	Tags map[string]string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type Options 

type Options struct {
	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	APIOptions []func(*middleware.Stack) error

	// The optional application specific identifier appended to the User-Agent header.
	AppID string

	// This endpoint will be given as input to an EndpointResolverV2. It is used for
	// providing a custom base endpoint that is subject to modifications by the
	// processing EndpointResolverV2.
	BaseEndpoint *string

	// Configures the events that will be sent to the configured logger.
	ClientLogMode aws.ClientLogMode

	// The credentials object to use when signing requests.
	Credentials aws.CredentialsProvider

	// The configuration DefaultsMode that the SDK should use when constructing the
	// clients initial default settings.
	DefaultsMode aws.DefaultsMode

	// The endpoint options to be used when attempting to resolve an endpoint.
	EndpointOptions EndpointResolverOptions

	// The service endpoint resolver.
	//
	// Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a
	// value for this field will likely prevent you from using any endpoint-related
	// service features released after the introduction of EndpointResolverV2 and
	// BaseEndpoint.
	//
	// To migrate an EndpointResolver implementation that uses a custom endpoint, set
	// the client option BaseEndpoint instead.
	EndpointResolver EndpointResolver

	// Resolves the endpoint used for a particular service operation. This should be
	// used over the deprecated EndpointResolver.
	EndpointResolverV2 EndpointResolverV2

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// Provides idempotency tokens values that will be automatically populated into
	// idempotent API operations.
	IdempotencyTokenProvider IdempotencyTokenProvider

	// The logger writer interface to write logging messages to.
	Logger logging.Logger

	// The region to send requests to. (Required)
	Region string

	// RetryMaxAttempts specifies the maximum number attempts an API client will call
	// an operation that fails with a retryable error. A value of 0 is ignored, and
	// will not be used to configure the API client created default retryer, or modify
	// per operation call's retry max attempts.
	//
	// If specified in an operation call's functional options with a value that is
	// different than the constructed client's Options, the Client's Retryer will be
	// wrapped to use the operation's specific RetryMaxAttempts value.
	RetryMaxAttempts int

	// RetryMode specifies the retry mode the API client will be created with, if
	// Retryer option is not also specified.
	//
	// When creating a new API Clients this member will only be used if the Retryer
	// Options member is nil. This value will be ignored if Retryer is not nil.
	//
	// Currently does not support per operation call overrides, may in the future.
	RetryMode aws.RetryMode

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer. The kind of
	// default retry created by the API client can be changed with the RetryMode
	// option.
	Retryer aws.Retryer

	// The RuntimeEnvironment configuration, only populated if the DefaultsMode is set
	// to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You
	// should not populate this structure programmatically, or rely on the values here
	// within your applications.
	RuntimeEnvironment aws.RuntimeEnvironment

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient

	// The auth scheme resolver which determines how to authenticate for each
	// operation.
	AuthSchemeResolver AuthSchemeResolver

	// The list of auth schemes supported by the client.
	AuthSchemes []smithyhttp.AuthScheme
	// contains filtered or unexported fields
}

func (Options) Copy 

func (o Options) Copy() Options

Copy creates a clone where the APIOptions list is deep copied.

func (Options) GetIdentityResolver 

func (o Options) GetIdentityResolver(schemeID string) smithyauth.IdentityResolver

type ResolveEndpoint 

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

func (*ResolveEndpoint) HandleSerialize 

func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) (
	out middleware.SerializeOutput, metadata middleware.Metadata, err error,
)

func (*ResolveEndpoint) ID 

func (*ResolveEndpoint) ID() string

type SearchImageSetsAPIClient 

type SearchImageSetsAPIClient interface {
	SearchImageSets(context.Context, *SearchImageSetsInput, ...func(*Options)) (*SearchImageSetsOutput, error)
}

SearchImageSetsAPIClient is a client that implements the SearchImageSets operation.

type SearchImageSetsInput 

type SearchImageSetsInput struct {

	// The identifier of the data store where the image sets reside.
	//
	// This member is required.
	DatastoreId *string

	// The maximum number of results that can be returned in a search.
	MaxResults *int32

	// 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.
	NextToken *string

	// The search criteria that filters by applying a maximum of 1 item to
	// SearchByAttribute .
	SearchCriteria *types.SearchCriteria
	// contains filtered or unexported fields
}

type SearchImageSetsOutput 

type SearchImageSetsOutput struct {

	// The model containing the image set results.
	//
	// This member is required.
	ImageSetsMetadataSummaries []types.ImageSetsMetadataSummary

	// The token for pagination results.
	NextToken *string

	// The sort order for image set search results.
	Sort *types.Sort

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type SearchImageSetsPaginator 

type SearchImageSetsPaginator struct {
	// contains filtered or unexported fields
}

SearchImageSetsPaginator is a paginator for SearchImageSets

func NewSearchImageSetsPaginator 

func NewSearchImageSetsPaginator(client SearchImageSetsAPIClient, params *SearchImageSetsInput, optFns ...func(*SearchImageSetsPaginatorOptions)) *SearchImageSetsPaginator

NewSearchImageSetsPaginator returns a new SearchImageSetsPaginator

func (*SearchImageSetsPaginator) HasMorePages 

func (p *SearchImageSetsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*SearchImageSetsPaginator) NextPage 

func (p *SearchImageSetsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*SearchImageSetsOutput, error)

NextPage retrieves the next SearchImageSets page.

type SearchImageSetsPaginatorOptions 

type SearchImageSetsPaginatorOptions struct {
	// The maximum number of results that can be returned in a search.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

SearchImageSetsPaginatorOptions is the paginator options for SearchImageSets

type StartDICOMImportJobInput 

type StartDICOMImportJobInput struct {

	// A unique identifier for API idempotency.
	//
	// This member is required.
	ClientToken *string

	// The Amazon Resource Name (ARN) of the IAM role that grants permission 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 files to be
	// imported.
	//
	// This member is required.
	InputS3Uri *string

	// The output prefix of the S3 bucket to upload the results of the DICOM import
	// job.
	//
	// This member is required.
	OutputS3Uri *string

	// The account ID of the source S3 bucket owner.
	InputOwnerAccountId *string

	// The import job name.
	JobName *string
	// contains filtered or unexported fields
}

type StartDICOMImportJobOutput 

type StartDICOMImportJobOutput struct {

	// The data store identifier.
	//
	// This member is required.
	DatastoreId *string

	// The import job identifier.
	//
	// This member is required.
	JobId *string

	// The import job status.
	//
	// This member is required.
	JobStatus types.JobStatus

	// The timestamp when the import job was submitted.
	//
	// This member is required.
	SubmittedAt *time.Time

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type TagResourceInput 

type TagResourceInput struct {

	// The Amazon Resource Name (ARN) of the medical imaging resource that tags are
	// being added to.
	//
	// This member is required.
	ResourceArn *string

	// The user-specified key and value tag pairs added to a medical imaging resource.
	//
	// This member is required.
	Tags map[string]string
	// contains filtered or unexported fields
}

type TagResourceOutput 

type TagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UntagResourceInput 

type UntagResourceInput struct {

	// The Amazon Resource Name (ARN) of the medical imaging resource that tags are
	// being removed from.
	//
	// This member is required.
	ResourceArn *string

	// The keys for the tags to be removed from the medical imaging resource.
	//
	// This member is required.
	TagKeys []string
	// contains filtered or unexported fields
}

type UntagResourceOutput 

type UntagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateImageSetMetadataInput 

type UpdateImageSetMetadataInput struct {

	// The data store identifier.
	//
	// This member is required.
	DatastoreId *string

	// The image set identifier.
	//
	// This member is required.
	ImageSetId *string

	// The latest image set version identifier.
	//
	// This member is required.
	LatestVersionId *string

	// Update image set metadata updates.
	//
	// This member is required.
	UpdateImageSetMetadataUpdates types.MetadataUpdates
	// contains filtered or unexported fields
}

type UpdateImageSetMetadataOutput 

type UpdateImageSetMetadataOutput struct {

	// The data store identifier.
	//
	// This member is required.
	DatastoreId *string

	// The image set identifier.
	//
	// This member is required.
	ImageSetId *string

	// The image set state.
	//
	// This member is required.
	ImageSetState types.ImageSetState

	// The latest image set version identifier.
	//
	// This member is required.
	LatestVersionId *string

	// The timestamp when image set metadata was created.
	CreatedAt *time.Time

	// The image set workflow status.
	ImageSetWorkflowStatus types.ImageSetWorkflowStatus

	// The error message thrown if an update image set metadata action fails.
	Message *string

	// The timestamp when image set metadata was updated.
	UpdatedAt *time.Time

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Source Files

View all Source files

Directories

Path Synopsis
internal
endpoints

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.