healthlake

package module
v1.28.8 Latest Latest
Warning

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

 Go to latest Published: Dec 19, 2024 License: Apache-2.0 Imports: 46 Imported by: 7

Documentation

Overview

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

AWS 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 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 added in v1.17.0 

func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)

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

func WithSigV4SigningName added in v1.19.2 

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

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

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

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 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, when the data store was created, data store type version, and the data store's 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) ListFHIRExportJobs added in v1.5.0 

func (c *Client) ListFHIRExportJobs(ctx context.Context, params *ListFHIRExportJobsInput, optFns ...func(*Options)) (*ListFHIRExportJobsOutput, error)

Lists all FHIR export jobs associated with an account and their statuses.

func (*Client) ListFHIRImportJobs added in v1.5.0 

func (c *Client) ListFHIRImportJobs(ctx context.Context, params *ListFHIRImportJobsInput, optFns ...func(*Options)) (*ListFHIRImportJobsOutput, error)

Lists all FHIR import jobs associated with an account and their statuses.

func (*Client) ListTagsForResource added in v1.5.0 

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

Returns a list of all existing tags associated with a data store.

func (*Client) Options added in v1.20.0 

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

func (*Client) TagResource added in v1.5.0 

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

Adds a user specified key and value tag to a data store.

func (*Client) UntagResource added in v1.5.0 

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

Removes tags from a data store.

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

	// The configuration of the identity provider that you want to use for your data
	// store.
	IdentityProviderConfiguration *types.IdentityProviderConfiguration

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

	//  The server-side encryption key configuration for a customer provided
	// encryption key specified for creating a data store.
	SseConfiguration *types.SseConfiguration

	//  Resource tags that are applied to a data store when it is created.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateFHIRDatastoreOutput 

type CreateFHIRDatastoreOutput struct {

	// The data store 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.
	//
	// 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.
	//
	// This member is required.
	DatastoreStatus types.DatastoreStatus

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

type DeleteFHIRDatastoreInput 

type DeleteFHIRDatastoreInput struct {

	//  The AWS-generated ID for the data store to be deleted.
	//
	// This member is required.
	DatastoreId *string
	// contains filtered or unexported fields
}

type DeleteFHIRDatastoreOutput 

type DeleteFHIRDatastoreOutput struct {

	// The Amazon Resource Name (ARN) that gives AWS 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
	// contains filtered or unexported fields
}

type DescribeFHIRDatastoreInput 

type DescribeFHIRDatastoreInput struct {

	// The AWS-generated data store ID.
	//
	// This member is required.
	DatastoreId *string
	// contains filtered or unexported fields
}

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, when the data store was created,
	// data store type version, and the data store's endpoint.
	//
	// This member is required.
	DatastoreProperties *types.DatastoreProperties

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

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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type DescribeFHIRImportJobOutput 

type DescribeFHIRImportJobOutput struct {

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

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

type EndpointParameters added in v1.17.0 

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

func (p EndpointParameters) ValidateRequired() error

ValidateRequired validates required parameters are set.

func (EndpointParameters) WithDefaults added in v1.17.0 

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 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 EndpointResolverV2 added in v1.17.0 

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

func NewDefaultEndpointResolverV2() EndpointResolverV2

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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

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 ListFHIRExportJobsAPIClient added in v1.5.0 

type ListFHIRExportJobsAPIClient interface {
	ListFHIRExportJobs(context.Context, *ListFHIRExportJobsInput, ...func(*Options)) (*ListFHIRExportJobsOutput, error)
}

ListFHIRExportJobsAPIClient is a client that implements the ListFHIRExportJobs operation.

type ListFHIRExportJobsInput added in v1.5.0 

type ListFHIRExportJobsInput struct {

	//  This parameter limits the response to the export job with the specified data
	// store ID.
	//
	// This member is required.
	DatastoreId *string

	//  This parameter limits the response to the export job with the specified job
	// name.
	JobName *string

	//  This parameter limits the response to the export jobs with the specified job
	// status.
	JobStatus types.JobStatus

	//  This parameter limits the number of results returned for a ListFHIRExportJobs
	// to a maximum quantity specified by the user.
	MaxResults *int32

	//  A pagination token used to identify the next page of results to return for a
	// ListFHIRExportJobs query.
	NextToken *string

	//  This parameter limits the response to FHIR export jobs submitted after a user
	// specified date.
	SubmittedAfter *time.Time

	//  This parameter limits the response to FHIR export jobs submitted before a user
	// specified date.
	SubmittedBefore *time.Time
	// contains filtered or unexported fields
}

type ListFHIRExportJobsOutput added in v1.5.0 

type ListFHIRExportJobsOutput struct {

	//  The properties of listed FHIR export jobs, including the ID, ARN, name, and
	// the status of the job.
	//
	// This member is required.
	ExportJobPropertiesList []types.ExportJobProperties

	//  A pagination token used to identify the next page of results to return for a
	// ListFHIRExportJobs query.
	NextToken *string

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

type ListFHIRExportJobsPaginator added in v1.5.0 

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

ListFHIRExportJobsPaginator is a paginator for ListFHIRExportJobs

func NewListFHIRExportJobsPaginator added in v1.5.0 

func NewListFHIRExportJobsPaginator(client ListFHIRExportJobsAPIClient, params *ListFHIRExportJobsInput, optFns ...func(*ListFHIRExportJobsPaginatorOptions)) *ListFHIRExportJobsPaginator

NewListFHIRExportJobsPaginator returns a new ListFHIRExportJobsPaginator

func (*ListFHIRExportJobsPaginator) HasMorePages added in v1.5.0 

func (p *ListFHIRExportJobsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListFHIRExportJobsPaginator) NextPage added in v1.5.0 

func (p *ListFHIRExportJobsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListFHIRExportJobsOutput, error)

NextPage retrieves the next ListFHIRExportJobs page.

type ListFHIRExportJobsPaginatorOptions added in v1.5.0 

type ListFHIRExportJobsPaginatorOptions struct {
	//  This parameter limits the number of results returned for a ListFHIRExportJobs
	// to a maximum quantity specified by the user.
	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
}

ListFHIRExportJobsPaginatorOptions is the paginator options for ListFHIRExportJobs

type ListFHIRImportJobsAPIClient added in v1.5.0 

type ListFHIRImportJobsAPIClient interface {
	ListFHIRImportJobs(context.Context, *ListFHIRImportJobsInput, ...func(*Options)) (*ListFHIRImportJobsOutput, error)
}

ListFHIRImportJobsAPIClient is a client that implements the ListFHIRImportJobs operation.

type ListFHIRImportJobsInput added in v1.5.0 

type ListFHIRImportJobsInput struct {

	//  This parameter limits the response to the import job with the specified data
	// store ID.
	//
	// This member is required.
	DatastoreId *string

	//  This parameter limits the response to the import job with the specified job
	// name.
	JobName *string

	//  This parameter limits the response to the import job with the specified job
	// status.
	JobStatus types.JobStatus

	//  This parameter limits the number of results returned for a ListFHIRImportJobs
	// to a maximum quantity specified by the user.
	MaxResults *int32

	//  A pagination token used to identify the next page of results to return for a
	// ListFHIRImportJobs query.
	NextToken *string

	//  This parameter limits the response to FHIR import jobs submitted after a user
	// specified date.
	SubmittedAfter *time.Time

	//  This parameter limits the response to FHIR import jobs submitted before a user
	// specified date.
	SubmittedBefore *time.Time
	// contains filtered or unexported fields
}

type ListFHIRImportJobsOutput added in v1.5.0 

type ListFHIRImportJobsOutput struct {

	//  The properties of a listed FHIR import jobs, including the ID, ARN, name, the
	// status of the job, and the progress report of the job.
	//
	// This member is required.
	ImportJobPropertiesList []types.ImportJobProperties

	//  A pagination token used to identify the next page of results to return for a
	// ListFHIRImportJobs query.
	NextToken *string

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

type ListFHIRImportJobsPaginator added in v1.5.0 

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

ListFHIRImportJobsPaginator is a paginator for ListFHIRImportJobs

func NewListFHIRImportJobsPaginator added in v1.5.0 

func NewListFHIRImportJobsPaginator(client ListFHIRImportJobsAPIClient, params *ListFHIRImportJobsInput, optFns ...func(*ListFHIRImportJobsPaginatorOptions)) *ListFHIRImportJobsPaginator

NewListFHIRImportJobsPaginator returns a new ListFHIRImportJobsPaginator

func (*ListFHIRImportJobsPaginator) HasMorePages added in v1.5.0 

func (p *ListFHIRImportJobsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListFHIRImportJobsPaginator) NextPage added in v1.5.0 

func (p *ListFHIRImportJobsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListFHIRImportJobsOutput, error)

NextPage retrieves the next ListFHIRImportJobs page.

type ListFHIRImportJobsPaginatorOptions added in v1.5.0 

type ListFHIRImportJobsPaginatorOptions struct {
	//  This parameter limits the number of results returned for a ListFHIRImportJobs
	// to a maximum quantity specified by the user.
	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
}

ListFHIRImportJobsPaginatorOptions is the paginator options for ListFHIRImportJobs

type ListTagsForResourceInput added in v1.5.0 

type ListTagsForResourceInput struct {

	//  The Amazon Resource Name(ARN) of the data store for which tags are being
	// added.
	//
	// This member is required.
	ResourceARN *string
	// contains filtered or unexported fields
}

type ListTagsForResourceOutput added in v1.5.0 

type ListTagsForResourceOutput struct {

	//  Returns a list of tags associated with a data store.
	Tags []types.Tag

	// 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 client meter provider.
	MeterProvider metrics.MeterProvider

	// 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 client tracer provider.
	TracerProvider tracing.TracerProvider

	// 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 added in v1.19.2 

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 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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

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 AWS 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 output data configuration that was supplied when the export job was created.
	//
	// This member is required.
	JobOutputDataConfig types.OutputDataConfig

	// The name of the FHIR Import job in the StartFHIRImport job request.
	JobName *string
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type TagResourceInput added in v1.5.0 

type TagResourceInput struct {

	//  The Amazon Resource Name(ARN)that gives AWS HealthLake access to the data
	// store which tags are being added to.
	//
	// This member is required.
	ResourceARN *string

	//  The user specified key and value pair tags being added to a data store.
	//
	// This member is required.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type TagResourceOutput added in v1.5.0 

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

type UntagResourceInput added in v1.5.0 

type UntagResourceInput struct {

	// The Amazon Resource Name(ARN) of the data store for which tags are being
	// removed.
	//
	// This member is required.
	ResourceARN *string

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

type UntagResourceOutput added in v1.5.0 

type UntagResourceOutput struct {
	// 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.