healthlake

package module
v1.2.3 Latest Latest
Warning

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

 Go to latest Published: May 7, 2021 License: Apache-2.0 Imports: 29 Imported by: 3

Documentation

Overview

Package healthlake provides the API client, operations, and parameter types for Amazon HealthLake.

Amazon HealthLake is a HIPAA eligibile service that allows customers to store, transform, query, and analyze their FHIR-formatted data in a consistent fashion in the cloud.

Index

Constants

View Source 
const ServiceAPIVersion = "2017-07-01"
View Source 
const ServiceID = "HealthLake"

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver 

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions added in v1.0.0 

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

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

func WithEndpointResolver 

func WithEndpointResolver(v EndpointResolver) func(*Options)

WithEndpointResolver returns a functional option for setting the Client's EndpointResolver option.

Types

type Client 

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

Client provides the API client to make operations call for Amazon HealthLake.

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) CreateFHIRDatastore 

func (c *Client) CreateFHIRDatastore(ctx context.Context, params *CreateFHIRDatastoreInput, optFns ...func(*Options)) (*CreateFHIRDatastoreOutput, error)

Creates a Data Store that can ingest and export FHIR formatted data.

func (*Client) DeleteFHIRDatastore 

func (c *Client) DeleteFHIRDatastore(ctx context.Context, params *DeleteFHIRDatastoreInput, optFns ...func(*Options)) (*DeleteFHIRDatastoreOutput, error)

Deletes a Data Store.

func (*Client) DescribeFHIRDatastore 

func (c *Client) DescribeFHIRDatastore(ctx context.Context, params *DescribeFHIRDatastoreInput, optFns ...func(*Options)) (*DescribeFHIRDatastoreOutput, error)

Gets the properties associated with the FHIR Data Store, including the Data Store ID, Data Store ARN, Data Store name, Data Store status, created at, Data Store type version, and Data Store endpoint.

func (*Client) DescribeFHIRExportJob added in v1.2.0 

func (c *Client) DescribeFHIRExportJob(ctx context.Context, params *DescribeFHIRExportJobInput, optFns ...func(*Options)) (*DescribeFHIRExportJobOutput, error)

Displays the properties of a FHIR export job, including the ID, ARN, name, and the status of the job.

func (*Client) DescribeFHIRImportJob 

func (c *Client) DescribeFHIRImportJob(ctx context.Context, params *DescribeFHIRImportJobInput, optFns ...func(*Options)) (*DescribeFHIRImportJobOutput, error)

Displays the properties of a FHIR import job, including the ID, ARN, name, and the status of the job.

func (*Client) ListFHIRDatastores 

func (c *Client) ListFHIRDatastores(ctx context.Context, params *ListFHIRDatastoresInput, optFns ...func(*Options)) (*ListFHIRDatastoresOutput, error)

Lists all FHIR Data Stores that are in the user’s account, regardless of Data Store status.

func (*Client) StartFHIRExportJob added in v1.2.0 

func (c *Client) StartFHIRExportJob(ctx context.Context, params *StartFHIRExportJobInput, optFns ...func(*Options)) (*StartFHIRExportJobOutput, error)

Begins a FHIR export job.

func (*Client) StartFHIRImportJob 

func (c *Client) StartFHIRImportJob(ctx context.Context, params *StartFHIRImportJobInput, optFns ...func(*Options)) (*StartFHIRImportJobOutput, error)

Begins a FHIR Import job.

type CreateFHIRDatastoreInput 

type CreateFHIRDatastoreInput struct {

	// The FHIR version of the Data Store. The only supported version is R4.
	//
	// This member is required.
	DatastoreTypeVersion types.FHIRVersion

	// Optional user provided token used for ensuring idempotency.
	ClientToken *string

	// The user generated name for the Data Store.
	DatastoreName *string

	// Optional parameter to preload data upon creation of the Data Store. Currently,
	// the only supported preloaded data is synthetic data generated from Synthea.
	PreloadDataConfig *types.PreloadDataConfig
}

type CreateFHIRDatastoreOutput 

type CreateFHIRDatastoreOutput struct {

	// The datastore ARN is generated during the creation of the Data Store and can be
	// found in the output from the initial Data Store creation call.
	//
	// This member is required.
	DatastoreArn *string

	// The AWS endpoint for the created Data Store. For preview, only US-east-1
	// endpoints are supported.
	//
	// This member is required.
	DatastoreEndpoint *string

	// The AWS-generated Data Store id. This id is in the output from the initial Data
	// Store creation call.
	//
	// This member is required.
	DatastoreId *string

	// The status of the FHIR Data Store. Possible statuses are ‘CREATING’, ‘ACTIVE’,
	// ‘DELETING’, ‘DELETED’.
	//
	// This member is required.
	DatastoreStatus types.DatastoreStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteFHIRDatastoreInput 

type DeleteFHIRDatastoreInput struct {

	// The AWS-generated ID for the Data Store to be deleted.
	DatastoreId *string
}

type DeleteFHIRDatastoreOutput 

type DeleteFHIRDatastoreOutput struct {

	// The Amazon Resource Name (ARN) that gives Amazon HealthLake access permission.
	//
	// This member is required.
	DatastoreArn *string

	// The AWS endpoint for the Data Store the user has requested to be deleted.
	//
	// This member is required.
	DatastoreEndpoint *string

	// The AWS-generated ID for the Data Store to be deleted.
	//
	// This member is required.
	DatastoreId *string

	// The status of the Data Store that the user has requested to be deleted.
	//
	// This member is required.
	DatastoreStatus types.DatastoreStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeFHIRDatastoreInput 

type DescribeFHIRDatastoreInput struct {

	// The AWS-generated Data Store id. This is part of the ‘CreateFHIRDatastore’
	// output.
	DatastoreId *string
}

type DescribeFHIRDatastoreOutput 

type DescribeFHIRDatastoreOutput struct {

	// All properties associated with a Data Store, including the Data Store ID, Data
	// Store ARN, Data Store name, Data Store status, created at, Data Store type
	// version, and Data Store endpoint.
	//
	// This member is required.
	DatastoreProperties *types.DatastoreProperties

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeFHIRExportJobInput added in v1.2.0 

type DescribeFHIRExportJobInput struct {

	// The AWS generated ID for the Data Store from which files are being exported from
	// for an export job.
	//
	// This member is required.
	DatastoreId *string

	// The AWS generated ID for an export job.
	//
	// This member is required.
	JobId *string
}

type DescribeFHIRExportJobOutput added in v1.2.0 

type DescribeFHIRExportJobOutput struct {

	// Displays the properties of the export job, including the ID, Arn, Name, and the
	// status of the job.
	//
	// This member is required.
	ExportJobProperties *types.ExportJobProperties

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeFHIRImportJobInput 

type DescribeFHIRImportJobInput struct {

	// The AWS-generated ID of the Data Store.
	//
	// This member is required.
	DatastoreId *string

	// The AWS-generated job ID.
	//
	// This member is required.
	JobId *string
}

type DescribeFHIRImportJobOutput 

type DescribeFHIRImportJobOutput struct {

	// The properties of the Import job request, including the ID, ARN, name, and the
	// status of the job.
	//
	// This member is required.
	ImportJobProperties *types.ImportJobProperties

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type EndpointResolver 

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

EndpointResolver interface for resolving service endpoints.

func EndpointResolverFromURL added in v1.1.0 

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 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 ListFHIRDatastoresAPIClient 

type ListFHIRDatastoresAPIClient interface {
	ListFHIRDatastores(context.Context, *ListFHIRDatastoresInput, ...func(*Options)) (*ListFHIRDatastoresOutput, error)
}

ListFHIRDatastoresAPIClient is a client that implements the ListFHIRDatastores operation.

type ListFHIRDatastoresInput 

type ListFHIRDatastoresInput struct {

	// Lists all filters associated with a FHIR Data Store request.
	Filter *types.DatastoreFilter

	// The maximum number of Data Stores returned in a single page of a
	// ListFHIRDatastoresRequest call.
	MaxResults *int32

	// Fetches the next page of Data Stores when results are paginated.
	NextToken *string
}

type ListFHIRDatastoresOutput 

type ListFHIRDatastoresOutput struct {

	// All properties associated with the listed Data Stores.
	//
	// This member is required.
	DatastorePropertiesList []types.DatastoreProperties

	// Pagination token that can be used to retrieve the next page of results.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListFHIRDatastoresPaginator 

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

ListFHIRDatastoresPaginator is a paginator for ListFHIRDatastores

func NewListFHIRDatastoresPaginator 

func NewListFHIRDatastoresPaginator(client ListFHIRDatastoresAPIClient, params *ListFHIRDatastoresInput, optFns ...func(*ListFHIRDatastoresPaginatorOptions)) *ListFHIRDatastoresPaginator

NewListFHIRDatastoresPaginator returns a new ListFHIRDatastoresPaginator

func (*ListFHIRDatastoresPaginator) HasMorePages 

func (p *ListFHIRDatastoresPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListFHIRDatastoresPaginator) NextPage 

func (p *ListFHIRDatastoresPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListFHIRDatastoresOutput, error)

NextPage retrieves the next ListFHIRDatastores page.

type ListFHIRDatastoresPaginatorOptions 

type ListFHIRDatastoresPaginatorOptions struct {
	// The maximum number of Data Stores returned in a single page of a
	// ListFHIRDatastoresRequest call.
	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
}

ListFHIRDatastoresPaginatorOptions is the paginator options for ListFHIRDatastores

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

	// 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 endpoint options to be used when attempting to resolve an endpoint.
	EndpointOptions EndpointResolverOptions

	// The service endpoint resolver.
	EndpointResolver EndpointResolver

	// 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

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer.
	Retryer aws.Retryer

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

func (Options) Copy 

func (o Options) Copy() Options

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

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 StartFHIRExportJobInput added in v1.2.0 

type StartFHIRExportJobInput struct {

	// An optional user provided token used for ensuring idempotency.
	//
	// This member is required.
	ClientToken *string

	// The Amazon Resource Name used during the initiation of the job.
	//
	// This member is required.
	DataAccessRoleArn *string

	// The AWS generated ID for the Data Store from which files are being exported for
	// an export job.
	//
	// This member is required.
	DatastoreId *string

	// The output data configuration that was supplied when the export job was created.
	//
	// This member is required.
	OutputDataConfig types.OutputDataConfig

	// The user generated name for an export job.
	JobName *string
}

type StartFHIRExportJobOutput added in v1.2.0 

type StartFHIRExportJobOutput struct {

	// The AWS generated ID for an export job.
	//
	// This member is required.
	JobId *string

	// The status of a FHIR export job. Possible statuses are SUBMITTED, IN_PROGRESS,
	// COMPLETED, or FAILED.
	//
	// This member is required.
	JobStatus types.JobStatus

	// The AWS generated ID for the Data Store from which files are being exported for
	// an export job.
	DatastoreId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type StartFHIRImportJobInput 

type StartFHIRImportJobInput struct {

	// Optional user provided token used for ensuring idempotency.
	//
	// This member is required.
	ClientToken *string

	// The Amazon Resource Name (ARN) that gives Amazon HealthLake access permission.
	//
	// This member is required.
	DataAccessRoleArn *string

	// The AWS-generated Data Store ID.
	//
	// This member is required.
	DatastoreId *string

	// The input properties of the FHIR Import job in the StartFHIRImport job request.
	//
	// This member is required.
	InputDataConfig types.InputDataConfig

	// The name of the FHIR Import job in the StartFHIRImport job request.
	JobName *string
}

type StartFHIRImportJobOutput 

type StartFHIRImportJobOutput struct {

	// The AWS-generated job ID.
	//
	// This member is required.
	JobId *string

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

	// The AWS-generated Data Store ID.
	DatastoreId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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.