healthlake

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

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

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

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

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 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 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 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 struct {

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

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

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

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

type EndpointResolverOptions = internalendpoints.Options

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,
	)
}

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

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 interface {
	GetIdempotencyToken() (string, error)
}

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

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

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
}

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

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

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
}

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

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

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
}

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

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

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 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 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 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 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 struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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 struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}