healthlake

package
v1.42.22 Latest Latest
Warning

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

 Go to latest Published: Dec 9, 2021 License: Apache-2.0 Imports: 10 Imported by: 13

Documentation

Overview

Package healthlake provides the client and types for making API requests to 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.

See https://docs.aws.amazon.com/goto/WebAPI/healthlake-2017-07-01 for more information on this service.

See healthlake package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/healthlake/

Using the Client

To contact Amazon HealthLake with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the Amazon HealthLake client HealthLake for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/healthlake/#New

Index

Constants

View Source 
const (
	// CmkTypeCustomerManagedKmsKey is a CmkType enum value
	CmkTypeCustomerManagedKmsKey = "CUSTOMER_MANAGED_KMS_KEY"

	// CmkTypeAwsOwnedKmsKey is a CmkType enum value
	CmkTypeAwsOwnedKmsKey = "AWS_OWNED_KMS_KEY"
)
View Source 
const (
	// DatastoreStatusCreating is a DatastoreStatus enum value
	DatastoreStatusCreating = "CREATING"

	// DatastoreStatusActive is a DatastoreStatus enum value
	DatastoreStatusActive = "ACTIVE"

	// DatastoreStatusDeleting is a DatastoreStatus enum value
	DatastoreStatusDeleting = "DELETING"

	// DatastoreStatusDeleted is a DatastoreStatus enum value
	DatastoreStatusDeleted = "DELETED"
)
View Source 
const (
	// JobStatusSubmitted is a JobStatus enum value
	JobStatusSubmitted = "SUBMITTED"

	// JobStatusInProgress is a JobStatus enum value
	JobStatusInProgress = "IN_PROGRESS"

	// JobStatusCompletedWithErrors is a JobStatus enum value
	JobStatusCompletedWithErrors = "COMPLETED_WITH_ERRORS"

	// JobStatusCompleted is a JobStatus enum value
	JobStatusCompleted = "COMPLETED"

	// JobStatusFailed is a JobStatus enum value
	JobStatusFailed = "FAILED"
)
View Source 
const (

	// ErrCodeAccessDeniedException for service response error code
	// "AccessDeniedException".
	//
	// Access is denied. Your account is not authorized to perform this operation.
	ErrCodeAccessDeniedException = "AccessDeniedException"

	// ErrCodeConflictException for service response error code
	// "ConflictException".
	//
	// The Data Store is in a transition state and the user requested action can
	// not be performed.
	ErrCodeConflictException = "ConflictException"

	// ErrCodeInternalServerException for service response error code
	// "InternalServerException".
	//
	// Unknown error occurs in the service.
	ErrCodeInternalServerException = "InternalServerException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// The requested Data Store was not found.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// ErrCodeThrottlingException for service response error code
	// "ThrottlingException".
	//
	// The user has exceeded their maximum number of allowed calls to the given
	// API.
	ErrCodeThrottlingException = "ThrottlingException"

	// ErrCodeValidationException for service response error code
	// "ValidationException".
	//
	// The user input parameter was invalid.
	ErrCodeValidationException = "ValidationException"
)
View Source 
const (
	ServiceName = "HealthLake" // Name of service.
	EndpointsID = "healthlake" // ID to lookup a service endpoint with.
	ServiceID   = "HealthLake" // ServiceID is a unique identifier of a specific service.
)

Service information constants

View Source 
const (
	// FHIRVersionR4 is a FHIRVersion enum value
	FHIRVersionR4 = "R4"
)
View Source 
const (
	// PreloadDataTypeSynthea is a PreloadDataType enum value
	PreloadDataTypeSynthea = "SYNTHEA"
)

Variables

This section is empty.

Functions

func CmkType_Values added in v1.40.0 

func CmkType_Values() []string

CmkType_Values returns all elements of the CmkType enum

func DatastoreStatus_Values 

func DatastoreStatus_Values() []string

DatastoreStatus_Values returns all elements of the DatastoreStatus enum

func FHIRVersion_Values 

func FHIRVersion_Values() []string

FHIRVersion_Values returns all elements of the FHIRVersion enum

func JobStatus_Values 

func JobStatus_Values() []string

JobStatus_Values returns all elements of the JobStatus enum

func PreloadDataType_Values 

func PreloadDataType_Values() []string

PreloadDataType_Values returns all elements of the PreloadDataType enum

Types

type AccessDeniedException 

type AccessDeniedException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

Access is denied. Your account is not authorized to perform this operation.

func (*AccessDeniedException) Code 

func (s *AccessDeniedException) Code() string

Code returns the exception type name.

func (*AccessDeniedException) Error 

func (s *AccessDeniedException) Error() string

func (AccessDeniedException) GoString 

func (s AccessDeniedException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AccessDeniedException) Message 

func (s *AccessDeniedException) Message() string

Message returns the exception's message.

func (*AccessDeniedException) OrigErr 

func (s *AccessDeniedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*AccessDeniedException) RequestID 

func (s *AccessDeniedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*AccessDeniedException) StatusCode 

func (s *AccessDeniedException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (AccessDeniedException) String 

func (s AccessDeniedException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ConflictException 

type ConflictException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The Data Store is in a transition state and the user requested action can not be performed.

func (*ConflictException) Code 

func (s *ConflictException) Code() string

Code returns the exception type name.

func (*ConflictException) Error 

func (s *ConflictException) Error() string

func (ConflictException) GoString 

func (s ConflictException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConflictException) Message 

func (s *ConflictException) Message() string

Message returns the exception's message.

func (*ConflictException) OrigErr 

func (s *ConflictException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ConflictException) RequestID 

func (s *ConflictException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ConflictException) StatusCode 

func (s *ConflictException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ConflictException) String 

func (s ConflictException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateFHIRDatastoreInput 

type CreateFHIRDatastoreInput struct {

	// Optional user provided token used for ensuring idempotency.
	ClientToken *string `min:"1" type:"string" idempotencyToken:"true"`

	// The user generated name for the Data Store.
	DatastoreName *string `min:"1" type:"string"`

	// The FHIR version of the Data Store. The only supported version is R4.
	//
	// DatastoreTypeVersion is a required field
	DatastoreTypeVersion *string `type:"string" required:"true" enum:"FHIRVersion"`

	// Optional parameter to preload data upon creation of the Data Store. Currently,
	// the only supported preloaded data is synthetic data generated from Synthea.
	PreloadDataConfig *PreloadDataConfig `type:"structure"`

	// The server-side encryption key configuration for a customer provided encryption
	// key specified for creating a Data Store.
	SseConfiguration *SseConfiguration `type:"structure"`

	// Resource tags that are applied to a Data Store when it is created.
	Tags []*Tag `type:"list"`
	// contains filtered or unexported fields
}

func (CreateFHIRDatastoreInput) GoString 

func (s CreateFHIRDatastoreInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateFHIRDatastoreInput) SetClientToken 

func (s *CreateFHIRDatastoreInput) SetClientToken(v string) *CreateFHIRDatastoreInput

SetClientToken sets the ClientToken field's value.

func (*CreateFHIRDatastoreInput) SetDatastoreName 

func (s *CreateFHIRDatastoreInput) SetDatastoreName(v string) *CreateFHIRDatastoreInput

SetDatastoreName sets the DatastoreName field's value.

func (*CreateFHIRDatastoreInput) SetDatastoreTypeVersion 

func (s *CreateFHIRDatastoreInput) SetDatastoreTypeVersion(v string) *CreateFHIRDatastoreInput

SetDatastoreTypeVersion sets the DatastoreTypeVersion field's value.

func (*CreateFHIRDatastoreInput) SetPreloadDataConfig 

func (s *CreateFHIRDatastoreInput) SetPreloadDataConfig(v *PreloadDataConfig) *CreateFHIRDatastoreInput

SetPreloadDataConfig sets the PreloadDataConfig field's value.

func (*CreateFHIRDatastoreInput) SetSseConfiguration added in v1.40.0 

func (s *CreateFHIRDatastoreInput) SetSseConfiguration(v *SseConfiguration) *CreateFHIRDatastoreInput

SetSseConfiguration sets the SseConfiguration field's value.

func (*CreateFHIRDatastoreInput) SetTags added in v1.40.0 

func (s *CreateFHIRDatastoreInput) SetTags(v []*Tag) *CreateFHIRDatastoreInput

SetTags sets the Tags field's value.

func (CreateFHIRDatastoreInput) String 

func (s CreateFHIRDatastoreInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateFHIRDatastoreInput) Validate 

func (s *CreateFHIRDatastoreInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

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.
	//
	// DatastoreArn is a required field
	DatastoreArn *string `type:"string" required:"true"`

	// The AWS endpoint for the created Data Store. For preview, only US-east-1
	// endpoints are supported.
	//
	// DatastoreEndpoint is a required field
	DatastoreEndpoint *string `min:"1" type:"string" required:"true"`

	// The AWS-generated Data Store id. This id is in the output from the initial
	// Data Store creation call.
	//
	// DatastoreId is a required field
	DatastoreId *string `min:"1" type:"string" required:"true"`

	// The status of the FHIR Data Store. Possible statuses are ‘CREATING’,
	// ‘ACTIVE’, ‘DELETING’, ‘DELETED’.
	//
	// DatastoreStatus is a required field
	DatastoreStatus *string `type:"string" required:"true" enum:"DatastoreStatus"`
	// contains filtered or unexported fields
}

func (CreateFHIRDatastoreOutput) GoString 

func (s CreateFHIRDatastoreOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateFHIRDatastoreOutput) SetDatastoreArn 

func (s *CreateFHIRDatastoreOutput) SetDatastoreArn(v string) *CreateFHIRDatastoreOutput

SetDatastoreArn sets the DatastoreArn field's value.

func (*CreateFHIRDatastoreOutput) SetDatastoreEndpoint 

func (s *CreateFHIRDatastoreOutput) SetDatastoreEndpoint(v string) *CreateFHIRDatastoreOutput

SetDatastoreEndpoint sets the DatastoreEndpoint field's value.

func (*CreateFHIRDatastoreOutput) SetDatastoreId 

func (s *CreateFHIRDatastoreOutput) SetDatastoreId(v string) *CreateFHIRDatastoreOutput

SetDatastoreId sets the DatastoreId field's value.

func (*CreateFHIRDatastoreOutput) SetDatastoreStatus 

func (s *CreateFHIRDatastoreOutput) SetDatastoreStatus(v string) *CreateFHIRDatastoreOutput

SetDatastoreStatus sets the DatastoreStatus field's value.

func (CreateFHIRDatastoreOutput) String 

func (s CreateFHIRDatastoreOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DatastoreFilter 

type DatastoreFilter struct {

	// A filter that allows the user to set cutoff dates for records. All Data Stores
	// created after the specified date will be included in the results.
	CreatedAfter *time.Time `type:"timestamp"`

	// A filter that allows the user to set cutoff dates for records. All Data Stores
	// created before the specified date will be included in the results.
	CreatedBefore *time.Time `type:"timestamp"`

	// Allows the user to filter Data Store results by name.
	DatastoreName *string `min:"1" type:"string"`

	// Allows the user to filter Data Store results by status.
	DatastoreStatus *string `type:"string" enum:"DatastoreStatus"`
	// contains filtered or unexported fields
}

The filters applied to Data Store query.

func (DatastoreFilter) GoString 

func (s DatastoreFilter) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DatastoreFilter) SetCreatedAfter 

func (s *DatastoreFilter) SetCreatedAfter(v time.Time) *DatastoreFilter

SetCreatedAfter sets the CreatedAfter field's value.

func (*DatastoreFilter) SetCreatedBefore 

func (s *DatastoreFilter) SetCreatedBefore(v time.Time) *DatastoreFilter

SetCreatedBefore sets the CreatedBefore field's value.

func (*DatastoreFilter) SetDatastoreName 

func (s *DatastoreFilter) SetDatastoreName(v string) *DatastoreFilter

SetDatastoreName sets the DatastoreName field's value.

func (*DatastoreFilter) SetDatastoreStatus 

func (s *DatastoreFilter) SetDatastoreStatus(v string) *DatastoreFilter

SetDatastoreStatus sets the DatastoreStatus field's value.

func (DatastoreFilter) String 

func (s DatastoreFilter) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DatastoreFilter) Validate 

func (s *DatastoreFilter) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DatastoreProperties 

type DatastoreProperties struct {

	// The time that a Data Store was created.
	CreatedAt *time.Time `type:"timestamp"`

	// The Amazon Resource Name used in the creation of the Data Store.
	//
	// DatastoreArn is a required field
	DatastoreArn *string `type:"string" required:"true"`

	// The AWS endpoint for the Data Store. Each Data Store will have it's own endpoint
	// with Data Store ID in the endpoint URL.
	//
	// DatastoreEndpoint is a required field
	DatastoreEndpoint *string `type:"string" required:"true"`

	// The AWS-generated ID number for the Data Store.
	//
	// DatastoreId is a required field
	DatastoreId *string `min:"1" type:"string" required:"true"`

	// The user-generated name for the Data Store.
	DatastoreName *string `min:"1" type:"string"`

	// The status of the Data Store. Possible statuses are 'CREATING', 'ACTIVE',
	// 'DELETING', or 'DELETED'.
	//
	// DatastoreStatus is a required field
	DatastoreStatus *string `type:"string" required:"true" enum:"DatastoreStatus"`

	// The FHIR version. Only R4 version data is supported.
	//
	// DatastoreTypeVersion is a required field
	DatastoreTypeVersion *string `type:"string" required:"true" enum:"FHIRVersion"`

	// The preloaded data configuration for the Data Store. Only data preloaded
	// from Synthea is supported.
	PreloadDataConfig *PreloadDataConfig `type:"structure"`

	// The server-side encryption key configuration for a customer provided encryption
	// key (CMK).
	SseConfiguration *SseConfiguration `type:"structure"`
	// contains filtered or unexported fields
}

Displays the properties of the Data Store, including the ID, Arn, name, and the status of the Data Store.

func (DatastoreProperties) GoString 

func (s DatastoreProperties) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DatastoreProperties) SetCreatedAt 

func (s *DatastoreProperties) SetCreatedAt(v time.Time) *DatastoreProperties

SetCreatedAt sets the CreatedAt field's value.

func (*DatastoreProperties) SetDatastoreArn 

func (s *DatastoreProperties) SetDatastoreArn(v string) *DatastoreProperties

SetDatastoreArn sets the DatastoreArn field's value.

func (*DatastoreProperties) SetDatastoreEndpoint 

func (s *DatastoreProperties) SetDatastoreEndpoint(v string) *DatastoreProperties

SetDatastoreEndpoint sets the DatastoreEndpoint field's value.

func (*DatastoreProperties) SetDatastoreId 

func (s *DatastoreProperties) SetDatastoreId(v string) *DatastoreProperties

SetDatastoreId sets the DatastoreId field's value.

func (*DatastoreProperties) SetDatastoreName 

func (s *DatastoreProperties) SetDatastoreName(v string) *DatastoreProperties

SetDatastoreName sets the DatastoreName field's value.

func (*DatastoreProperties) SetDatastoreStatus 

func (s *DatastoreProperties) SetDatastoreStatus(v string) *DatastoreProperties

SetDatastoreStatus sets the DatastoreStatus field's value.

func (*DatastoreProperties) SetDatastoreTypeVersion 

func (s *DatastoreProperties) SetDatastoreTypeVersion(v string) *DatastoreProperties

SetDatastoreTypeVersion sets the DatastoreTypeVersion field's value.

func (*DatastoreProperties) SetPreloadDataConfig 

func (s *DatastoreProperties) SetPreloadDataConfig(v *PreloadDataConfig) *DatastoreProperties

SetPreloadDataConfig sets the PreloadDataConfig field's value.

func (*DatastoreProperties) SetSseConfiguration added in v1.40.0 

func (s *DatastoreProperties) SetSseConfiguration(v *SseConfiguration) *DatastoreProperties

SetSseConfiguration sets the SseConfiguration field's value.

func (DatastoreProperties) String 

func (s DatastoreProperties) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteFHIRDatastoreInput 

type DeleteFHIRDatastoreInput struct {

	// The AWS-generated ID for the Data Store to be deleted.
	DatastoreId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DeleteFHIRDatastoreInput) GoString 

func (s DeleteFHIRDatastoreInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteFHIRDatastoreInput) SetDatastoreId 

func (s *DeleteFHIRDatastoreInput) SetDatastoreId(v string) *DeleteFHIRDatastoreInput

SetDatastoreId sets the DatastoreId field's value.

func (DeleteFHIRDatastoreInput) String 

func (s DeleteFHIRDatastoreInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteFHIRDatastoreInput) Validate 

func (s *DeleteFHIRDatastoreInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteFHIRDatastoreOutput 

type DeleteFHIRDatastoreOutput struct {

	// The Amazon Resource Name (ARN) that gives Amazon HealthLake access permission.
	//
	// DatastoreArn is a required field
	DatastoreArn *string `type:"string" required:"true"`

	// The AWS endpoint for the Data Store the user has requested to be deleted.
	//
	// DatastoreEndpoint is a required field
	DatastoreEndpoint *string `min:"1" type:"string" required:"true"`

	// The AWS-generated ID for the Data Store to be deleted.
	//
	// DatastoreId is a required field
	DatastoreId *string `min:"1" type:"string" required:"true"`

	// The status of the Data Store that the user has requested to be deleted.
	//
	// DatastoreStatus is a required field
	DatastoreStatus *string `type:"string" required:"true" enum:"DatastoreStatus"`
	// contains filtered or unexported fields
}

func (DeleteFHIRDatastoreOutput) GoString 

func (s DeleteFHIRDatastoreOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteFHIRDatastoreOutput) SetDatastoreArn 

func (s *DeleteFHIRDatastoreOutput) SetDatastoreArn(v string) *DeleteFHIRDatastoreOutput

SetDatastoreArn sets the DatastoreArn field's value.

func (*DeleteFHIRDatastoreOutput) SetDatastoreEndpoint 

func (s *DeleteFHIRDatastoreOutput) SetDatastoreEndpoint(v string) *DeleteFHIRDatastoreOutput

SetDatastoreEndpoint sets the DatastoreEndpoint field's value.

func (*DeleteFHIRDatastoreOutput) SetDatastoreId 

func (s *DeleteFHIRDatastoreOutput) SetDatastoreId(v string) *DeleteFHIRDatastoreOutput

SetDatastoreId sets the DatastoreId field's value.

func (*DeleteFHIRDatastoreOutput) SetDatastoreStatus 

func (s *DeleteFHIRDatastoreOutput) SetDatastoreStatus(v string) *DeleteFHIRDatastoreOutput

SetDatastoreStatus sets the DatastoreStatus field's value.

func (DeleteFHIRDatastoreOutput) String 

func (s DeleteFHIRDatastoreOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeFHIRDatastoreInput 

type DescribeFHIRDatastoreInput struct {

	// The AWS-generated Data Store id. This is part of the ‘CreateFHIRDatastore’
	// output.
	DatastoreId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeFHIRDatastoreInput) GoString 

func (s DescribeFHIRDatastoreInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeFHIRDatastoreInput) SetDatastoreId 

func (s *DescribeFHIRDatastoreInput) SetDatastoreId(v string) *DescribeFHIRDatastoreInput

SetDatastoreId sets the DatastoreId field's value.

func (DescribeFHIRDatastoreInput) String 

func (s DescribeFHIRDatastoreInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeFHIRDatastoreInput) Validate 

func (s *DescribeFHIRDatastoreInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

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.
	//
	// DatastoreProperties is a required field
	DatastoreProperties *DatastoreProperties `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeFHIRDatastoreOutput) GoString 

func (s DescribeFHIRDatastoreOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeFHIRDatastoreOutput) SetDatastoreProperties 

func (s *DescribeFHIRDatastoreOutput) SetDatastoreProperties(v *DatastoreProperties) *DescribeFHIRDatastoreOutput

SetDatastoreProperties sets the DatastoreProperties field's value.

func (DescribeFHIRDatastoreOutput) String 

func (s DescribeFHIRDatastoreOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeFHIRExportJobInput added in v1.36.20 

type DescribeFHIRExportJobInput struct {

	// The AWS generated ID for the Data Store from which files are being exported
	// from for an export job.
	//
	// DatastoreId is a required field
	DatastoreId *string `min:"1" type:"string" required:"true"`

	// The AWS generated ID for an export job.
	//
	// JobId is a required field
	JobId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeFHIRExportJobInput) GoString added in v1.36.20 

func (s DescribeFHIRExportJobInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeFHIRExportJobInput) SetDatastoreId added in v1.36.20 

func (s *DescribeFHIRExportJobInput) SetDatastoreId(v string) *DescribeFHIRExportJobInput

SetDatastoreId sets the DatastoreId field's value.

func (*DescribeFHIRExportJobInput) SetJobId added in v1.36.20 

func (s *DescribeFHIRExportJobInput) SetJobId(v string) *DescribeFHIRExportJobInput

SetJobId sets the JobId field's value.

func (DescribeFHIRExportJobInput) String added in v1.36.20 

func (s DescribeFHIRExportJobInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeFHIRExportJobInput) Validate added in v1.36.20 

func (s *DescribeFHIRExportJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeFHIRExportJobOutput added in v1.36.20 

type DescribeFHIRExportJobOutput struct {

	// Displays the properties of the export job, including the ID, Arn, Name, and
	// the status of the job.
	//
	// ExportJobProperties is a required field
	ExportJobProperties *ExportJobProperties `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeFHIRExportJobOutput) GoString added in v1.36.20 

func (s DescribeFHIRExportJobOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeFHIRExportJobOutput) SetExportJobProperties added in v1.36.20 

func (s *DescribeFHIRExportJobOutput) SetExportJobProperties(v *ExportJobProperties) *DescribeFHIRExportJobOutput

SetExportJobProperties sets the ExportJobProperties field's value.

func (DescribeFHIRExportJobOutput) String added in v1.36.20 

func (s DescribeFHIRExportJobOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeFHIRImportJobInput 

type DescribeFHIRImportJobInput struct {

	// The AWS-generated ID of the Data Store.
	//
	// DatastoreId is a required field
	DatastoreId *string `min:"1" type:"string" required:"true"`

	// The AWS-generated job ID.
	//
	// JobId is a required field
	JobId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeFHIRImportJobInput) GoString 

func (s DescribeFHIRImportJobInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeFHIRImportJobInput) SetDatastoreId 

func (s *DescribeFHIRImportJobInput) SetDatastoreId(v string) *DescribeFHIRImportJobInput

SetDatastoreId sets the DatastoreId field's value.

func (*DescribeFHIRImportJobInput) SetJobId 

func (s *DescribeFHIRImportJobInput) SetJobId(v string) *DescribeFHIRImportJobInput

SetJobId sets the JobId field's value.

func (DescribeFHIRImportJobInput) String 

func (s DescribeFHIRImportJobInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeFHIRImportJobInput) Validate 

func (s *DescribeFHIRImportJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeFHIRImportJobOutput 

type DescribeFHIRImportJobOutput struct {

	// The properties of the Import job request, including the ID, ARN, name, and
	// the status of the job.
	//
	// ImportJobProperties is a required field
	ImportJobProperties *ImportJobProperties `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeFHIRImportJobOutput) GoString 

func (s DescribeFHIRImportJobOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeFHIRImportJobOutput) SetImportJobProperties 

func (s *DescribeFHIRImportJobOutput) SetImportJobProperties(v *ImportJobProperties) *DescribeFHIRImportJobOutput

SetImportJobProperties sets the ImportJobProperties field's value.

func (DescribeFHIRImportJobOutput) String 

func (s DescribeFHIRImportJobOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ExportJobProperties added in v1.36.20 

type ExportJobProperties struct {

	// The Amazon Resource Name used during the initiation of the job.
	DataAccessRoleArn *string `min:"20" type:"string"`

	// The AWS generated ID for the Data Store from which files are being exported
	// for an export job.
	//
	// DatastoreId is a required field
	DatastoreId *string `min:"1" type:"string" required:"true"`

	// The time an export job completed.
	EndTime *time.Time `type:"timestamp"`

	// The AWS generated ID for an export job.
	//
	// JobId is a required field
	JobId *string `min:"1" type:"string" required:"true"`

	// The user generated name for an export job.
	JobName *string `min:"1" type:"string"`

	// The status of a FHIR export job. Possible statuses are SUBMITTED, IN_PROGRESS,
	// COMPLETED, or FAILED.
	//
	// JobStatus is a required field
	JobStatus *string `type:"string" required:"true" enum:"JobStatus"`

	// An explanation of any errors that may have occurred during the export job.
	Message *string `min:"1" type:"string"`

	// The output data configuration that was supplied when the export job was created.
	//
	// OutputDataConfig is a required field
	OutputDataConfig *OutputDataConfig `type:"structure" required:"true"`

	// The time an export job was initiated.
	//
	// SubmitTime is a required field
	SubmitTime *time.Time `type:"timestamp" required:"true"`
	// contains filtered or unexported fields
}

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

func (ExportJobProperties) GoString added in v1.36.20 

func (s ExportJobProperties) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExportJobProperties) SetDataAccessRoleArn added in v1.36.20 

func (s *ExportJobProperties) SetDataAccessRoleArn(v string) *ExportJobProperties

SetDataAccessRoleArn sets the DataAccessRoleArn field's value.

func (*ExportJobProperties) SetDatastoreId added in v1.36.20 

func (s *ExportJobProperties) SetDatastoreId(v string) *ExportJobProperties

SetDatastoreId sets the DatastoreId field's value.

func (*ExportJobProperties) SetEndTime added in v1.36.20 

func (s *ExportJobProperties) SetEndTime(v time.Time) *ExportJobProperties

SetEndTime sets the EndTime field's value.

func (*ExportJobProperties) SetJobId added in v1.36.20 

func (s *ExportJobProperties) SetJobId(v string) *ExportJobProperties

SetJobId sets the JobId field's value.

func (*ExportJobProperties) SetJobName added in v1.36.20 

func (s *ExportJobProperties) SetJobName(v string) *ExportJobProperties

SetJobName sets the JobName field's value.

func (*ExportJobProperties) SetJobStatus added in v1.36.20 

func (s *ExportJobProperties) SetJobStatus(v string) *ExportJobProperties

SetJobStatus sets the JobStatus field's value.

func (*ExportJobProperties) SetMessage added in v1.36.20 

func (s *ExportJobProperties) SetMessage(v string) *ExportJobProperties

SetMessage sets the Message field's value.

func (*ExportJobProperties) SetOutputDataConfig added in v1.36.20 

func (s *ExportJobProperties) SetOutputDataConfig(v *OutputDataConfig) *ExportJobProperties

SetOutputDataConfig sets the OutputDataConfig field's value.

func (*ExportJobProperties) SetSubmitTime added in v1.36.20 

func (s *ExportJobProperties) SetSubmitTime(v time.Time) *ExportJobProperties

SetSubmitTime sets the SubmitTime field's value.

func (ExportJobProperties) String added in v1.36.20 

func (s ExportJobProperties) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type HealthLake 

type HealthLake struct {
	*client.Client
}

HealthLake provides the API operation methods for making requests to Amazon HealthLake. See this package's package overview docs for details on the service.

HealthLake methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New 

func New(p client.ConfigProvider, cfgs ...*aws.Config) *HealthLake

New creates a new instance of the HealthLake client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example: 

mySession := session.Must(session.NewSession())

// Create a HealthLake client from just a session.
svc := healthlake.New(mySession)

// Create a HealthLake client with additional configuration
svc := healthlake.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*HealthLake) CreateFHIRDatastore 

func (c *HealthLake) CreateFHIRDatastore(input *CreateFHIRDatastoreInput) (*CreateFHIRDatastoreOutput, error)

CreateFHIRDatastore API operation for Amazon HealthLake.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon HealthLake's API operation CreateFHIRDatastore for usage and error information.

Returned Error Types:

  • ValidationException The user input parameter was invalid.

  • ThrottlingException The user has exceeded their maximum number of allowed calls to the given API.

  • AccessDeniedException Access is denied. Your account is not authorized to perform this operation.

  • InternalServerException Unknown error occurs in the service.

See also, https://docs.aws.amazon.com/goto/WebAPI/healthlake-2017-07-01/CreateFHIRDatastore

func (*HealthLake) CreateFHIRDatastoreRequest 

func (c *HealthLake) CreateFHIRDatastoreRequest(input *CreateFHIRDatastoreInput) (req *request.Request, output *CreateFHIRDatastoreOutput)

CreateFHIRDatastoreRequest generates a "aws/request.Request" representing the client's request for the CreateFHIRDatastore operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateFHIRDatastore for more information on using the CreateFHIRDatastore API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateFHIRDatastoreRequest method.
req, resp := client.CreateFHIRDatastoreRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/healthlake-2017-07-01/CreateFHIRDatastore

func (*HealthLake) CreateFHIRDatastoreWithContext 

func (c *HealthLake) CreateFHIRDatastoreWithContext(ctx aws.Context, input *CreateFHIRDatastoreInput, opts ...request.Option) (*CreateFHIRDatastoreOutput, error)

CreateFHIRDatastoreWithContext is the same as CreateFHIRDatastore with the addition of the ability to pass a context and additional request options.

See CreateFHIRDatastore for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*HealthLake) DeleteFHIRDatastore 

func (c *HealthLake) DeleteFHIRDatastore(input *DeleteFHIRDatastoreInput) (*DeleteFHIRDatastoreOutput, error)

DeleteFHIRDatastore API operation for Amazon HealthLake.

Deletes a Data Store.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon HealthLake's API operation DeleteFHIRDatastore for usage and error information.

Returned Error Types:

  • AccessDeniedException Access is denied. Your account is not authorized to perform this operation.

  • ConflictException The Data Store is in a transition state and the user requested action can not be performed.

  • ValidationException The user input parameter was invalid.

  • ResourceNotFoundException The requested Data Store was not found.

  • ThrottlingException The user has exceeded their maximum number of allowed calls to the given API.

  • InternalServerException Unknown error occurs in the service.

See also, https://docs.aws.amazon.com/goto/WebAPI/healthlake-2017-07-01/DeleteFHIRDatastore

func (*HealthLake) DeleteFHIRDatastoreRequest 

func (c *HealthLake) DeleteFHIRDatastoreRequest(input *DeleteFHIRDatastoreInput) (req *request.Request, output *DeleteFHIRDatastoreOutput)

DeleteFHIRDatastoreRequest generates a "aws/request.Request" representing the client's request for the DeleteFHIRDatastore operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteFHIRDatastore for more information on using the DeleteFHIRDatastore API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteFHIRDatastoreRequest method.
req, resp := client.DeleteFHIRDatastoreRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/healthlake-2017-07-01/DeleteFHIRDatastore

func (*HealthLake) DeleteFHIRDatastoreWithContext 

func (c *HealthLake) DeleteFHIRDatastoreWithContext(ctx aws.Context, input *DeleteFHIRDatastoreInput, opts ...request.Option) (*DeleteFHIRDatastoreOutput, error)

DeleteFHIRDatastoreWithContext is the same as DeleteFHIRDatastore with the addition of the ability to pass a context and additional request options.

See DeleteFHIRDatastore for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*HealthLake) DescribeFHIRDatastore 

func (c *HealthLake) DescribeFHIRDatastore(input *DescribeFHIRDatastoreInput) (*DescribeFHIRDatastoreOutput, error)

DescribeFHIRDatastore API operation for Amazon HealthLake.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon HealthLake's API operation DescribeFHIRDatastore for usage and error information.

Returned Error Types:

  • ValidationException The user input parameter was invalid.

  • ResourceNotFoundException The requested Data Store was not found.

  • ThrottlingException The user has exceeded their maximum number of allowed calls to the given API.

  • InternalServerException Unknown error occurs in the service.

See also, https://docs.aws.amazon.com/goto/WebAPI/healthlake-2017-07-01/DescribeFHIRDatastore

func (*HealthLake) DescribeFHIRDatastoreRequest 

func (c *HealthLake) DescribeFHIRDatastoreRequest(input *DescribeFHIRDatastoreInput) (req *request.Request, output *DescribeFHIRDatastoreOutput)

DescribeFHIRDatastoreRequest generates a "aws/request.Request" representing the client's request for the DescribeFHIRDatastore operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeFHIRDatastore for more information on using the DescribeFHIRDatastore API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeFHIRDatastoreRequest method.
req, resp := client.DescribeFHIRDatastoreRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/healthlake-2017-07-01/DescribeFHIRDatastore

func (*HealthLake) DescribeFHIRDatastoreWithContext 

func (c *HealthLake) DescribeFHIRDatastoreWithContext(ctx aws.Context, input *DescribeFHIRDatastoreInput, opts ...request.Option) (*DescribeFHIRDatastoreOutput, error)

DescribeFHIRDatastoreWithContext is the same as DescribeFHIRDatastore with the addition of the ability to pass a context and additional request options.

See DescribeFHIRDatastore for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*HealthLake) DescribeFHIRExportJob added in v1.36.20 

func (c *HealthLake) DescribeFHIRExportJob(input *DescribeFHIRExportJobInput) (*DescribeFHIRExportJobOutput, error)

DescribeFHIRExportJob API operation for Amazon HealthLake.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon HealthLake's API operation DescribeFHIRExportJob for usage and error information.

Returned Error Types:

  • ValidationException The user input parameter was invalid.

  • ResourceNotFoundException The requested Data Store was not found.

  • ThrottlingException The user has exceeded their maximum number of allowed calls to the given API.

  • InternalServerException Unknown error occurs in the service.

See also, https://docs.aws.amazon.com/goto/WebAPI/healthlake-2017-07-01/DescribeFHIRExportJob

func (*HealthLake) DescribeFHIRExportJobRequest added in v1.36.20 

func (c *HealthLake) DescribeFHIRExportJobRequest(input *DescribeFHIRExportJobInput) (req *request.Request, output *DescribeFHIRExportJobOutput)

DescribeFHIRExportJobRequest generates a "aws/request.Request" representing the client's request for the DescribeFHIRExportJob operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeFHIRExportJob for more information on using the DescribeFHIRExportJob API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeFHIRExportJobRequest method.
req, resp := client.DescribeFHIRExportJobRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/healthlake-2017-07-01/DescribeFHIRExportJob

func (*HealthLake) DescribeFHIRExportJobWithContext added in v1.36.20 

func (c *HealthLake) DescribeFHIRExportJobWithContext(ctx aws.Context, input *DescribeFHIRExportJobInput, opts ...request.Option) (*DescribeFHIRExportJobOutput, error)

DescribeFHIRExportJobWithContext is the same as DescribeFHIRExportJob with the addition of the ability to pass a context and additional request options.

See DescribeFHIRExportJob for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*HealthLake) DescribeFHIRImportJob 

func (c *HealthLake) DescribeFHIRImportJob(input *DescribeFHIRImportJobInput) (*DescribeFHIRImportJobOutput, error)

DescribeFHIRImportJob API operation for Amazon HealthLake.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon HealthLake's API operation DescribeFHIRImportJob for usage and error information.

Returned Error Types:

  • ValidationException The user input parameter was invalid.

  • ResourceNotFoundException The requested Data Store was not found.

  • ThrottlingException The user has exceeded their maximum number of allowed calls to the given API.

  • InternalServerException Unknown error occurs in the service.

See also, https://docs.aws.amazon.com/goto/WebAPI/healthlake-2017-07-01/DescribeFHIRImportJob

func (*HealthLake) DescribeFHIRImportJobRequest 

func (c *HealthLake) DescribeFHIRImportJobRequest(input *DescribeFHIRImportJobInput) (req *request.Request, output *DescribeFHIRImportJobOutput)

DescribeFHIRImportJobRequest generates a "aws/request.Request" representing the client's request for the DescribeFHIRImportJob operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeFHIRImportJob for more information on using the DescribeFHIRImportJob API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeFHIRImportJobRequest method.
req, resp := client.DescribeFHIRImportJobRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/healthlake-2017-07-01/DescribeFHIRImportJob

func (*HealthLake) DescribeFHIRImportJobWithContext 

func (c *HealthLake) DescribeFHIRImportJobWithContext(ctx aws.Context, input *DescribeFHIRImportJobInput, opts ...request.Option) (*DescribeFHIRImportJobOutput, error)

DescribeFHIRImportJobWithContext is the same as DescribeFHIRImportJob with the addition of the ability to pass a context and additional request options.

See DescribeFHIRImportJob for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*HealthLake) ListFHIRDatastores 

func (c *HealthLake) ListFHIRDatastores(input *ListFHIRDatastoresInput) (*ListFHIRDatastoresOutput, error)

ListFHIRDatastores API operation for Amazon HealthLake.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon HealthLake's API operation ListFHIRDatastores for usage and error information.

Returned Error Types:

  • ValidationException The user input parameter was invalid.

  • ThrottlingException The user has exceeded their maximum number of allowed calls to the given API.

  • InternalServerException Unknown error occurs in the service.

See also, https://docs.aws.amazon.com/goto/WebAPI/healthlake-2017-07-01/ListFHIRDatastores

func (*HealthLake) ListFHIRDatastoresPages 

func (c *HealthLake) ListFHIRDatastoresPages(input *ListFHIRDatastoresInput, fn func(*ListFHIRDatastoresOutput, bool) bool) error

ListFHIRDatastoresPages iterates over the pages of a ListFHIRDatastores operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListFHIRDatastores method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListFHIRDatastores operation.
pageNum := 0
err := client.ListFHIRDatastoresPages(params,
    func(page *healthlake.ListFHIRDatastoresOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*HealthLake) ListFHIRDatastoresPagesWithContext 

func (c *HealthLake) ListFHIRDatastoresPagesWithContext(ctx aws.Context, input *ListFHIRDatastoresInput, fn func(*ListFHIRDatastoresOutput, bool) bool, opts ...request.Option) error

ListFHIRDatastoresPagesWithContext same as ListFHIRDatastoresPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*HealthLake) ListFHIRDatastoresRequest 

func (c *HealthLake) ListFHIRDatastoresRequest(input *ListFHIRDatastoresInput) (req *request.Request, output *ListFHIRDatastoresOutput)

ListFHIRDatastoresRequest generates a "aws/request.Request" representing the client's request for the ListFHIRDatastores operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListFHIRDatastores for more information on using the ListFHIRDatastores API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListFHIRDatastoresRequest method.
req, resp := client.ListFHIRDatastoresRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/healthlake-2017-07-01/ListFHIRDatastores

func (*HealthLake) ListFHIRDatastoresWithContext 

func (c *HealthLake) ListFHIRDatastoresWithContext(ctx aws.Context, input *ListFHIRDatastoresInput, opts ...request.Option) (*ListFHIRDatastoresOutput, error)

ListFHIRDatastoresWithContext is the same as ListFHIRDatastores with the addition of the ability to pass a context and additional request options.

See ListFHIRDatastores for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*HealthLake) ListFHIRExportJobs added in v1.40.0 

func (c *HealthLake) ListFHIRExportJobs(input *ListFHIRExportJobsInput) (*ListFHIRExportJobsOutput, error)

ListFHIRExportJobs API operation for Amazon HealthLake.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon HealthLake's API operation ListFHIRExportJobs for usage and error information.

Returned Error Types:

  • ValidationException The user input parameter was invalid.

  • ResourceNotFoundException The requested Data Store was not found.

  • AccessDeniedException Access is denied. Your account is not authorized to perform this operation.

  • ThrottlingException The user has exceeded their maximum number of allowed calls to the given API.

  • InternalServerException Unknown error occurs in the service.

See also, https://docs.aws.amazon.com/goto/WebAPI/healthlake-2017-07-01/ListFHIRExportJobs

func (*HealthLake) ListFHIRExportJobsPages added in v1.40.0 

func (c *HealthLake) ListFHIRExportJobsPages(input *ListFHIRExportJobsInput, fn func(*ListFHIRExportJobsOutput, bool) bool) error

ListFHIRExportJobsPages iterates over the pages of a ListFHIRExportJobs operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListFHIRExportJobs method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListFHIRExportJobs operation.
pageNum := 0
err := client.ListFHIRExportJobsPages(params,
    func(page *healthlake.ListFHIRExportJobsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*HealthLake) ListFHIRExportJobsPagesWithContext added in v1.40.0 

func (c *HealthLake) ListFHIRExportJobsPagesWithContext(ctx aws.Context, input *ListFHIRExportJobsInput, fn func(*ListFHIRExportJobsOutput, bool) bool, opts ...request.Option) error

ListFHIRExportJobsPagesWithContext same as ListFHIRExportJobsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*HealthLake) ListFHIRExportJobsRequest added in v1.40.0 

func (c *HealthLake) ListFHIRExportJobsRequest(input *ListFHIRExportJobsInput) (req *request.Request, output *ListFHIRExportJobsOutput)

ListFHIRExportJobsRequest generates a "aws/request.Request" representing the client's request for the ListFHIRExportJobs operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListFHIRExportJobs for more information on using the ListFHIRExportJobs API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListFHIRExportJobsRequest method.
req, resp := client.ListFHIRExportJobsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/healthlake-2017-07-01/ListFHIRExportJobs

func (*HealthLake) ListFHIRExportJobsWithContext added in v1.40.0 

func (c *HealthLake) ListFHIRExportJobsWithContext(ctx aws.Context, input *ListFHIRExportJobsInput, opts ...request.Option) (*ListFHIRExportJobsOutput, error)

ListFHIRExportJobsWithContext is the same as ListFHIRExportJobs with the addition of the ability to pass a context and additional request options.

See ListFHIRExportJobs for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*HealthLake) ListFHIRImportJobs added in v1.40.0 

func (c *HealthLake) ListFHIRImportJobs(input *ListFHIRImportJobsInput) (*ListFHIRImportJobsOutput, error)

ListFHIRImportJobs API operation for Amazon HealthLake.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon HealthLake's API operation ListFHIRImportJobs for usage and error information.

Returned Error Types:

  • ValidationException The user input parameter was invalid.

  • ResourceNotFoundException The requested Data Store was not found.

  • AccessDeniedException Access is denied. Your account is not authorized to perform this operation.

  • ThrottlingException The user has exceeded their maximum number of allowed calls to the given API.

  • InternalServerException Unknown error occurs in the service.

See also, https://docs.aws.amazon.com/goto/WebAPI/healthlake-2017-07-01/ListFHIRImportJobs

func (*HealthLake) ListFHIRImportJobsPages added in v1.40.0 

func (c *HealthLake) ListFHIRImportJobsPages(input *ListFHIRImportJobsInput, fn func(*ListFHIRImportJobsOutput, bool) bool) error

ListFHIRImportJobsPages iterates over the pages of a ListFHIRImportJobs operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListFHIRImportJobs method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListFHIRImportJobs operation.
pageNum := 0
err := client.ListFHIRImportJobsPages(params,
    func(page *healthlake.ListFHIRImportJobsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*HealthLake) ListFHIRImportJobsPagesWithContext added in v1.40.0 

func (c *HealthLake) ListFHIRImportJobsPagesWithContext(ctx aws.Context, input *ListFHIRImportJobsInput, fn func(*ListFHIRImportJobsOutput, bool) bool, opts ...request.Option) error

ListFHIRImportJobsPagesWithContext same as ListFHIRImportJobsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*HealthLake) ListFHIRImportJobsRequest added in v1.40.0 

func (c *HealthLake) ListFHIRImportJobsRequest(input *ListFHIRImportJobsInput) (req *request.Request, output *ListFHIRImportJobsOutput)

ListFHIRImportJobsRequest generates a "aws/request.Request" representing the client's request for the ListFHIRImportJobs operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListFHIRImportJobs for more information on using the ListFHIRImportJobs API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListFHIRImportJobsRequest method.
req, resp := client.ListFHIRImportJobsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/healthlake-2017-07-01/ListFHIRImportJobs

func (*HealthLake) ListFHIRImportJobsWithContext added in v1.40.0 

func (c *HealthLake) ListFHIRImportJobsWithContext(ctx aws.Context, input *ListFHIRImportJobsInput, opts ...request.Option) (*ListFHIRImportJobsOutput, error)

ListFHIRImportJobsWithContext is the same as ListFHIRImportJobs with the addition of the ability to pass a context and additional request options.

See ListFHIRImportJobs for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*HealthLake) ListTagsForResource added in v1.40.0 

func (c *HealthLake) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)

ListTagsForResource API operation for Amazon HealthLake.

Returns a list of all existing tags associated with a Data Store.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon HealthLake's API operation ListTagsForResource for usage and error information.

Returned Error Types:

  • ValidationException The user input parameter was invalid.

  • ResourceNotFoundException The requested Data Store was not found.

See also, https://docs.aws.amazon.com/goto/WebAPI/healthlake-2017-07-01/ListTagsForResource

func (*HealthLake) ListTagsForResourceRequest added in v1.40.0 

func (c *HealthLake) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput)

ListTagsForResourceRequest generates a "aws/request.Request" representing the client's request for the ListTagsForResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListTagsForResource for more information on using the ListTagsForResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListTagsForResourceRequest method.
req, resp := client.ListTagsForResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/healthlake-2017-07-01/ListTagsForResource

func (*HealthLake) ListTagsForResourceWithContext added in v1.40.0 

func (c *HealthLake) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error)

ListTagsForResourceWithContext is the same as ListTagsForResource with the addition of the ability to pass a context and additional request options.

See ListTagsForResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*HealthLake) StartFHIRExportJob added in v1.36.20 

func (c *HealthLake) StartFHIRExportJob(input *StartFHIRExportJobInput) (*StartFHIRExportJobOutput, error)

StartFHIRExportJob API operation for Amazon HealthLake.

Begins a FHIR export job.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon HealthLake's API operation StartFHIRExportJob for usage and error information.

Returned Error Types:

  • ValidationException The user input parameter was invalid.

  • ThrottlingException The user has exceeded their maximum number of allowed calls to the given API.

  • AccessDeniedException Access is denied. Your account is not authorized to perform this operation.

  • ResourceNotFoundException The requested Data Store was not found.

  • InternalServerException Unknown error occurs in the service.

See also, https://docs.aws.amazon.com/goto/WebAPI/healthlake-2017-07-01/StartFHIRExportJob

func (*HealthLake) StartFHIRExportJobRequest added in v1.36.20 

func (c *HealthLake) StartFHIRExportJobRequest(input *StartFHIRExportJobInput) (req *request.Request, output *StartFHIRExportJobOutput)

StartFHIRExportJobRequest generates a "aws/request.Request" representing the client's request for the StartFHIRExportJob operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StartFHIRExportJob for more information on using the StartFHIRExportJob API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the StartFHIRExportJobRequest method.
req, resp := client.StartFHIRExportJobRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/healthlake-2017-07-01/StartFHIRExportJob

func (*HealthLake) StartFHIRExportJobWithContext added in v1.36.20 

func (c *HealthLake) StartFHIRExportJobWithContext(ctx aws.Context, input *StartFHIRExportJobInput, opts ...request.Option) (*StartFHIRExportJobOutput, error)

StartFHIRExportJobWithContext is the same as StartFHIRExportJob with the addition of the ability to pass a context and additional request options.

See StartFHIRExportJob for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*HealthLake) StartFHIRImportJob 

func (c *HealthLake) StartFHIRImportJob(input *StartFHIRImportJobInput) (*StartFHIRImportJobOutput, error)

StartFHIRImportJob API operation for Amazon HealthLake.

Begins a FHIR Import job.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon HealthLake's API operation StartFHIRImportJob for usage and error information.

Returned Error Types:

  • ValidationException The user input parameter was invalid.

  • ThrottlingException The user has exceeded their maximum number of allowed calls to the given API.

  • AccessDeniedException Access is denied. Your account is not authorized to perform this operation.

  • ResourceNotFoundException The requested Data Store was not found.

  • InternalServerException Unknown error occurs in the service.

See also, https://docs.aws.amazon.com/goto/WebAPI/healthlake-2017-07-01/StartFHIRImportJob

func (*HealthLake) StartFHIRImportJobRequest 

func (c *HealthLake) StartFHIRImportJobRequest(input *StartFHIRImportJobInput) (req *request.Request, output *StartFHIRImportJobOutput)

StartFHIRImportJobRequest generates a "aws/request.Request" representing the client's request for the StartFHIRImportJob operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StartFHIRImportJob for more information on using the StartFHIRImportJob API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the StartFHIRImportJobRequest method.
req, resp := client.StartFHIRImportJobRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/healthlake-2017-07-01/StartFHIRImportJob

func (*HealthLake) StartFHIRImportJobWithContext 

func (c *HealthLake) StartFHIRImportJobWithContext(ctx aws.Context, input *StartFHIRImportJobInput, opts ...request.Option) (*StartFHIRImportJobOutput, error)

StartFHIRImportJobWithContext is the same as StartFHIRImportJob with the addition of the ability to pass a context and additional request options.

See StartFHIRImportJob for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*HealthLake) TagResource added in v1.40.0 

func (c *HealthLake) TagResource(input *TagResourceInput) (*TagResourceOutput, error)

TagResource API operation for Amazon HealthLake.

Adds a user specifed key and value tag to a Data Store.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon HealthLake's API operation TagResource for usage and error information.

Returned Error Types:

  • ValidationException The user input parameter was invalid.

  • ResourceNotFoundException The requested Data Store was not found.

See also, https://docs.aws.amazon.com/goto/WebAPI/healthlake-2017-07-01/TagResource

func (*HealthLake) TagResourceRequest added in v1.40.0 

func (c *HealthLake) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput)

TagResourceRequest generates a "aws/request.Request" representing the client's request for the TagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See TagResource for more information on using the TagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the TagResourceRequest method.
req, resp := client.TagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/healthlake-2017-07-01/TagResource

func (*HealthLake) TagResourceWithContext added in v1.40.0 

func (c *HealthLake) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error)

TagResourceWithContext is the same as TagResource with the addition of the ability to pass a context and additional request options.

See TagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*HealthLake) UntagResource added in v1.40.0 

func (c *HealthLake) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)

UntagResource API operation for Amazon HealthLake.

Removes tags from a Data Store.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon HealthLake's API operation UntagResource for usage and error information.

Returned Error Types:

  • ValidationException The user input parameter was invalid.

  • ResourceNotFoundException The requested Data Store was not found.

See also, https://docs.aws.amazon.com/goto/WebAPI/healthlake-2017-07-01/UntagResource

func (*HealthLake) UntagResourceRequest added in v1.40.0 

func (c *HealthLake) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput)

UntagResourceRequest generates a "aws/request.Request" representing the client's request for the UntagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UntagResource for more information on using the UntagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UntagResourceRequest method.
req, resp := client.UntagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/healthlake-2017-07-01/UntagResource

func (*HealthLake) UntagResourceWithContext added in v1.40.0 

func (c *HealthLake) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error)

UntagResourceWithContext is the same as UntagResource with the addition of the ability to pass a context and additional request options.

See UntagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type ImportJobProperties 

type ImportJobProperties struct {

	// The Amazon Resource Name (ARN) that gives Amazon HealthLake access to your
	// input data.
	DataAccessRoleArn *string `min:"20" type:"string"`

	// The datastore id used when the Import job was created.
	//
	// DatastoreId is a required field
	DatastoreId *string `min:"1" type:"string" required:"true"`

	// The time that the Import job was completed.
	EndTime *time.Time `type:"timestamp"`

	// The input data configuration that was supplied when the Import job was created.
	//
	// InputDataConfig is a required field
	InputDataConfig *InputDataConfig `type:"structure" required:"true"`

	// The AWS-generated id number for the Import job.
	//
	// JobId is a required field
	JobId *string `min:"1" type:"string" required:"true"`

	// The user-generated name for an Import job.
	JobName *string `min:"1" type:"string"`

	// The output data configuration that was supplied when the export job was created.
	JobOutputDataConfig *OutputDataConfig `type:"structure"`

	// The job status for an Import job. Possible statuses are SUBMITTED, IN_PROGRESS,
	// COMPLETED, FAILED.
	//
	// JobStatus is a required field
	JobStatus *string `type:"string" required:"true" enum:"JobStatus"`

	// An explanation of any errors that may have occurred during the FHIR import
	// job.
	Message *string `min:"1" type:"string"`

	// The time that the Import job was submitted for processing.
	//
	// SubmitTime is a required field
	SubmitTime *time.Time `type:"timestamp" required:"true"`
	// contains filtered or unexported fields
}

Displays the properties of the import job, including the ID, Arn, Name, and the status of the Data Store.

func (ImportJobProperties) GoString 

func (s ImportJobProperties) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ImportJobProperties) SetDataAccessRoleArn 

func (s *ImportJobProperties) SetDataAccessRoleArn(v string) *ImportJobProperties

SetDataAccessRoleArn sets the DataAccessRoleArn field's value.

func (*ImportJobProperties) SetDatastoreId 

func (s *ImportJobProperties) SetDatastoreId(v string) *ImportJobProperties

SetDatastoreId sets the DatastoreId field's value.

func (*ImportJobProperties) SetEndTime 

func (s *ImportJobProperties) SetEndTime(v time.Time) *ImportJobProperties

SetEndTime sets the EndTime field's value.

func (*ImportJobProperties) SetInputDataConfig 

func (s *ImportJobProperties) SetInputDataConfig(v *InputDataConfig) *ImportJobProperties

SetInputDataConfig sets the InputDataConfig field's value.

func (*ImportJobProperties) SetJobId 

func (s *ImportJobProperties) SetJobId(v string) *ImportJobProperties

SetJobId sets the JobId field's value.

func (*ImportJobProperties) SetJobName 

func (s *ImportJobProperties) SetJobName(v string) *ImportJobProperties

SetJobName sets the JobName field's value.

func (*ImportJobProperties) SetJobOutputDataConfig added in v1.40.0 

func (s *ImportJobProperties) SetJobOutputDataConfig(v *OutputDataConfig) *ImportJobProperties

SetJobOutputDataConfig sets the JobOutputDataConfig field's value.

func (*ImportJobProperties) SetJobStatus 

func (s *ImportJobProperties) SetJobStatus(v string) *ImportJobProperties

SetJobStatus sets the JobStatus field's value.

func (*ImportJobProperties) SetMessage 

func (s *ImportJobProperties) SetMessage(v string) *ImportJobProperties

SetMessage sets the Message field's value.

func (*ImportJobProperties) SetSubmitTime 

func (s *ImportJobProperties) SetSubmitTime(v time.Time) *ImportJobProperties

SetSubmitTime sets the SubmitTime field's value.

func (ImportJobProperties) String 

func (s ImportJobProperties) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InputDataConfig 

type InputDataConfig struct {

	// The S3Uri is the user specified S3 location of the FHIR data to be imported
	// into Amazon HealthLake.
	S3Uri *string `type:"string"`
	// contains filtered or unexported fields
}

The input properties for an import job.

func (InputDataConfig) GoString 

func (s InputDataConfig) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InputDataConfig) SetS3Uri 

func (s *InputDataConfig) SetS3Uri(v string) *InputDataConfig

SetS3Uri sets the S3Uri field's value.

func (InputDataConfig) String 

func (s InputDataConfig) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InternalServerException 

type InternalServerException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

Unknown error occurs in the service.

func (*InternalServerException) Code 

func (s *InternalServerException) Code() string

Code returns the exception type name.

func (*InternalServerException) Error 

func (s *InternalServerException) Error() string

func (InternalServerException) GoString 

func (s InternalServerException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InternalServerException) Message 

func (s *InternalServerException) Message() string

Message returns the exception's message.

func (*InternalServerException) OrigErr 

func (s *InternalServerException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalServerException) RequestID 

func (s *InternalServerException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalServerException) StatusCode 

func (s *InternalServerException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InternalServerException) String 

func (s InternalServerException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type KmsEncryptionConfig added in v1.40.0 

type KmsEncryptionConfig struct {

	// The type of customer-managed-key(CMK) used for encyrption. The two types
	// of supported CMKs are customer owned CMKs and AWS owned CMKs.
	//
	// CmkType is a required field
	CmkType *string `type:"string" required:"true" enum:"CmkType"`

	// The KMS encryption key id/alias used to encrypt the Data Store contents at
	// rest.
	KmsKeyId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

The customer-managed-key(CMK) used when creating a Data Store. If a customer owned key is not specified, an AWS owned key will be used for encryption.

func (KmsEncryptionConfig) GoString added in v1.40.0 

func (s KmsEncryptionConfig) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*KmsEncryptionConfig) SetCmkType added in v1.40.0 

func (s *KmsEncryptionConfig) SetCmkType(v string) *KmsEncryptionConfig

SetCmkType sets the CmkType field's value.

func (*KmsEncryptionConfig) SetKmsKeyId added in v1.40.0 

func (s *KmsEncryptionConfig) SetKmsKeyId(v string) *KmsEncryptionConfig

SetKmsKeyId sets the KmsKeyId field's value.

func (KmsEncryptionConfig) String added in v1.40.0 

func (s KmsEncryptionConfig) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*KmsEncryptionConfig) Validate added in v1.40.0 

func (s *KmsEncryptionConfig) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListFHIRDatastoresInput 

type ListFHIRDatastoresInput struct {

	// Lists all filters associated with a FHIR Data Store request.
	Filter *DatastoreFilter `type:"structure"`

	// The maximum number of Data Stores returned in a single page of a ListFHIRDatastoresRequest
	// call.
	MaxResults *int64 `min:"1" type:"integer"`

	// Fetches the next page of Data Stores when results are paginated.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListFHIRDatastoresInput) GoString 

func (s ListFHIRDatastoresInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListFHIRDatastoresInput) SetFilter 

func (s *ListFHIRDatastoresInput) SetFilter(v *DatastoreFilter) *ListFHIRDatastoresInput

SetFilter sets the Filter field's value.

func (*ListFHIRDatastoresInput) SetMaxResults 

func (s *ListFHIRDatastoresInput) SetMaxResults(v int64) *ListFHIRDatastoresInput

SetMaxResults sets the MaxResults field's value.

func (*ListFHIRDatastoresInput) SetNextToken 

func (s *ListFHIRDatastoresInput) SetNextToken(v string) *ListFHIRDatastoresInput

SetNextToken sets the NextToken field's value.

func (ListFHIRDatastoresInput) String 

func (s ListFHIRDatastoresInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListFHIRDatastoresInput) Validate 

func (s *ListFHIRDatastoresInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListFHIRDatastoresOutput 

type ListFHIRDatastoresOutput struct {

	// All properties associated with the listed Data Stores.
	//
	// DatastorePropertiesList is a required field
	DatastorePropertiesList []*DatastoreProperties `type:"list" required:"true"`

	// Pagination token that can be used to retrieve the next page of results.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListFHIRDatastoresOutput) GoString 

func (s ListFHIRDatastoresOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListFHIRDatastoresOutput) SetDatastorePropertiesList 

func (s *ListFHIRDatastoresOutput) SetDatastorePropertiesList(v []*DatastoreProperties) *ListFHIRDatastoresOutput

SetDatastorePropertiesList sets the DatastorePropertiesList field's value.

func (*ListFHIRDatastoresOutput) SetNextToken 

func (s *ListFHIRDatastoresOutput) SetNextToken(v string) *ListFHIRDatastoresOutput

SetNextToken sets the NextToken field's value.

func (ListFHIRDatastoresOutput) String 

func (s ListFHIRDatastoresOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListFHIRExportJobsInput added in v1.40.0 

type ListFHIRExportJobsInput struct {

	// This parameter limits the response to the export job with the specified Data
	// Store ID.
	//
	// DatastoreId is a required field
	DatastoreId *string `min:"1" type:"string" required:"true"`

	// This parameter limits the response to the export job with the specified job
	// name.
	JobName *string `min:"1" type:"string"`

	// This parameter limits the response to the export jobs with the specified
	// job status.
	JobStatus *string `type:"string" enum:"JobStatus"`

	// This parameter limits the number of results returned for a ListFHIRExportJobs
	// to a maximum quantity specified by the user.
	MaxResults *int64 `min:"1" type:"integer"`

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

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

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

func (ListFHIRExportJobsInput) GoString added in v1.40.0 

func (s ListFHIRExportJobsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListFHIRExportJobsInput) SetDatastoreId added in v1.40.0 

func (s *ListFHIRExportJobsInput) SetDatastoreId(v string) *ListFHIRExportJobsInput

SetDatastoreId sets the DatastoreId field's value.

func (*ListFHIRExportJobsInput) SetJobName added in v1.40.0 

func (s *ListFHIRExportJobsInput) SetJobName(v string) *ListFHIRExportJobsInput

SetJobName sets the JobName field's value.

func (*ListFHIRExportJobsInput) SetJobStatus added in v1.40.0 

func (s *ListFHIRExportJobsInput) SetJobStatus(v string) *ListFHIRExportJobsInput

SetJobStatus sets the JobStatus field's value.

func (*ListFHIRExportJobsInput) SetMaxResults added in v1.40.0 

func (s *ListFHIRExportJobsInput) SetMaxResults(v int64) *ListFHIRExportJobsInput

SetMaxResults sets the MaxResults field's value.

func (*ListFHIRExportJobsInput) SetNextToken added in v1.40.0 

func (s *ListFHIRExportJobsInput) SetNextToken(v string) *ListFHIRExportJobsInput

SetNextToken sets the NextToken field's value.

func (*ListFHIRExportJobsInput) SetSubmittedAfter added in v1.40.0 

func (s *ListFHIRExportJobsInput) SetSubmittedAfter(v time.Time) *ListFHIRExportJobsInput

SetSubmittedAfter sets the SubmittedAfter field's value.

func (*ListFHIRExportJobsInput) SetSubmittedBefore added in v1.40.0 

func (s *ListFHIRExportJobsInput) SetSubmittedBefore(v time.Time) *ListFHIRExportJobsInput

SetSubmittedBefore sets the SubmittedBefore field's value.

func (ListFHIRExportJobsInput) String added in v1.40.0 

func (s ListFHIRExportJobsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListFHIRExportJobsInput) Validate added in v1.40.0 

func (s *ListFHIRExportJobsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListFHIRExportJobsOutput added in v1.40.0 

type ListFHIRExportJobsOutput struct {

	// The properties of listed FHIR export jobs, including the ID, ARN, name, and
	// the status of the job.
	//
	// ExportJobPropertiesList is a required field
	ExportJobPropertiesList []*ExportJobProperties `type:"list" required:"true"`

	// A pagination token used to identify the next page of results to return for
	// a ListFHIRExportJobs query.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListFHIRExportJobsOutput) GoString added in v1.40.0 

func (s ListFHIRExportJobsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListFHIRExportJobsOutput) SetExportJobPropertiesList added in v1.40.0 

func (s *ListFHIRExportJobsOutput) SetExportJobPropertiesList(v []*ExportJobProperties) *ListFHIRExportJobsOutput

SetExportJobPropertiesList sets the ExportJobPropertiesList field's value.

func (*ListFHIRExportJobsOutput) SetNextToken added in v1.40.0 

func (s *ListFHIRExportJobsOutput) SetNextToken(v string) *ListFHIRExportJobsOutput

SetNextToken sets the NextToken field's value.

func (ListFHIRExportJobsOutput) String added in v1.40.0 

func (s ListFHIRExportJobsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListFHIRImportJobsInput added in v1.40.0 

type ListFHIRImportJobsInput struct {

	// This parameter limits the response to the import job with the specified Data
	// Store ID.
	//
	// DatastoreId is a required field
	DatastoreId *string `min:"1" type:"string" required:"true"`

	// This parameter limits the response to the import job with the specified job
	// name.
	JobName *string `min:"1" type:"string"`

	// This parameter limits the response to the import job with the specified job
	// status.
	JobStatus *string `type:"string" enum:"JobStatus"`

	// This parameter limits the number of results returned for a ListFHIRImportJobs
	// to a maximum quantity specified by the user.
	MaxResults *int64 `min:"1" type:"integer"`

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

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

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

func (ListFHIRImportJobsInput) GoString added in v1.40.0 

func (s ListFHIRImportJobsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListFHIRImportJobsInput) SetDatastoreId added in v1.40.0 

func (s *ListFHIRImportJobsInput) SetDatastoreId(v string) *ListFHIRImportJobsInput

SetDatastoreId sets the DatastoreId field's value.

func (*ListFHIRImportJobsInput) SetJobName added in v1.40.0 

func (s *ListFHIRImportJobsInput) SetJobName(v string) *ListFHIRImportJobsInput

SetJobName sets the JobName field's value.

func (*ListFHIRImportJobsInput) SetJobStatus added in v1.40.0 

func (s *ListFHIRImportJobsInput) SetJobStatus(v string) *ListFHIRImportJobsInput

SetJobStatus sets the JobStatus field's value.

func (*ListFHIRImportJobsInput) SetMaxResults added in v1.40.0 

func (s *ListFHIRImportJobsInput) SetMaxResults(v int64) *ListFHIRImportJobsInput

SetMaxResults sets the MaxResults field's value.

func (*ListFHIRImportJobsInput) SetNextToken added in v1.40.0 

func (s *ListFHIRImportJobsInput) SetNextToken(v string) *ListFHIRImportJobsInput

SetNextToken sets the NextToken field's value.

func (*ListFHIRImportJobsInput) SetSubmittedAfter added in v1.40.0 

func (s *ListFHIRImportJobsInput) SetSubmittedAfter(v time.Time) *ListFHIRImportJobsInput

SetSubmittedAfter sets the SubmittedAfter field's value.

func (*ListFHIRImportJobsInput) SetSubmittedBefore added in v1.40.0 

func (s *ListFHIRImportJobsInput) SetSubmittedBefore(v time.Time) *ListFHIRImportJobsInput

SetSubmittedBefore sets the SubmittedBefore field's value.

func (ListFHIRImportJobsInput) String added in v1.40.0 

func (s ListFHIRImportJobsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListFHIRImportJobsInput) Validate added in v1.40.0 

func (s *ListFHIRImportJobsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListFHIRImportJobsOutput added in v1.40.0 

type ListFHIRImportJobsOutput struct {

	// The properties of a listed FHIR import jobs, including the ID, ARN, name,
	// and the status of the job.
	//
	// ImportJobPropertiesList is a required field
	ImportJobPropertiesList []*ImportJobProperties `type:"list" required:"true"`

	// A pagination token used to identify the next page of results to return for
	// a ListFHIRImportJobs query.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListFHIRImportJobsOutput) GoString added in v1.40.0 

func (s ListFHIRImportJobsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListFHIRImportJobsOutput) SetImportJobPropertiesList added in v1.40.0 

func (s *ListFHIRImportJobsOutput) SetImportJobPropertiesList(v []*ImportJobProperties) *ListFHIRImportJobsOutput

SetImportJobPropertiesList sets the ImportJobPropertiesList field's value.

func (*ListFHIRImportJobsOutput) SetNextToken added in v1.40.0 

func (s *ListFHIRImportJobsOutput) SetNextToken(v string) *ListFHIRImportJobsOutput

SetNextToken sets the NextToken field's value.

func (ListFHIRImportJobsOutput) String added in v1.40.0 

func (s ListFHIRImportJobsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListTagsForResourceInput added in v1.40.0 

type ListTagsForResourceInput struct {

	// The Amazon Resource Name(ARN) of the Data Store for which tags are being
	// added.
	//
	// ResourceARN is a required field
	ResourceARN *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceInput) GoString added in v1.40.0 

func (s ListTagsForResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) SetResourceARN added in v1.40.0 

func (s *ListTagsForResourceInput) SetResourceARN(v string) *ListTagsForResourceInput

SetResourceARN sets the ResourceARN field's value.

func (ListTagsForResourceInput) String added in v1.40.0 

func (s ListTagsForResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) Validate added in v1.40.0 

func (s *ListTagsForResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListTagsForResourceOutput added in v1.40.0 

type ListTagsForResourceOutput struct {

	// Returns a list of tags associated with a Data Store.
	Tags []*Tag `type:"list"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceOutput) GoString added in v1.40.0 

func (s ListTagsForResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceOutput) SetTags added in v1.40.0 

func (s *ListTagsForResourceOutput) SetTags(v []*Tag) *ListTagsForResourceOutput

SetTags sets the Tags field's value.

func (ListTagsForResourceOutput) String added in v1.40.0 

func (s ListTagsForResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type OutputDataConfig added in v1.36.20 

type OutputDataConfig struct {

	// The output data configuration that was supplied when the export job was created.
	S3Configuration *S3Configuration `type:"structure"`
	// contains filtered or unexported fields
}

The output data configuration that was supplied when the export job was created.

func (OutputDataConfig) GoString added in v1.36.20 

func (s OutputDataConfig) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*OutputDataConfig) SetS3Configuration added in v1.40.0 

func (s *OutputDataConfig) SetS3Configuration(v *S3Configuration) *OutputDataConfig

SetS3Configuration sets the S3Configuration field's value.

func (OutputDataConfig) String added in v1.36.20 

func (s OutputDataConfig) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*OutputDataConfig) Validate added in v1.40.0 

func (s *OutputDataConfig) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PreloadDataConfig 

type PreloadDataConfig struct {

	// The type of preloaded data. Only Synthea preloaded data is supported.
	//
	// PreloadDataType is a required field
	PreloadDataType *string `type:"string" required:"true" enum:"PreloadDataType"`
	// contains filtered or unexported fields
}

The input properties for the preloaded Data Store. Only data preloaded from Synthea is supported.

func (PreloadDataConfig) GoString 

func (s PreloadDataConfig) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PreloadDataConfig) SetPreloadDataType 

func (s *PreloadDataConfig) SetPreloadDataType(v string) *PreloadDataConfig

SetPreloadDataType sets the PreloadDataType field's value.

func (PreloadDataConfig) String 

func (s PreloadDataConfig) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PreloadDataConfig) Validate 

func (s *PreloadDataConfig) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ResourceNotFoundException 

type ResourceNotFoundException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The requested Data Store was not found.

func (*ResourceNotFoundException) Code 

func (s *ResourceNotFoundException) Code() string

Code returns the exception type name.

func (*ResourceNotFoundException) Error 

func (s *ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString 

func (s ResourceNotFoundException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceNotFoundException) Message 

func (s *ResourceNotFoundException) Message() string

Message returns the exception's message.

func (*ResourceNotFoundException) OrigErr 

func (s *ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFoundException) RequestID 

func (s *ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFoundException) StatusCode 

func (s *ResourceNotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceNotFoundException) String 

func (s ResourceNotFoundException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type S3Configuration added in v1.40.0 

type S3Configuration struct {

	// The KMS key ID used to access the S3 bucket.
	//
	// KmsKeyId is a required field
	KmsKeyId *string `min:"1" type:"string" required:"true"`

	// The S3Uri is the user specified S3 location of the FHIR data to be imported
	// into Amazon HealthLake.
	//
	// S3Uri is a required field
	S3Uri *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

The configuration of the S3 bucket for either an import or export job. This includes assigning permissions for access.

func (S3Configuration) GoString added in v1.40.0 

func (s S3Configuration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*S3Configuration) SetKmsKeyId added in v1.40.0 

func (s *S3Configuration) SetKmsKeyId(v string) *S3Configuration

SetKmsKeyId sets the KmsKeyId field's value.

func (*S3Configuration) SetS3Uri added in v1.40.0 

func (s *S3Configuration) SetS3Uri(v string) *S3Configuration

SetS3Uri sets the S3Uri field's value.

func (S3Configuration) String added in v1.40.0 

func (s S3Configuration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*S3Configuration) Validate added in v1.40.0 

func (s *S3Configuration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SseConfiguration added in v1.40.0 

type SseConfiguration struct {

	// The KMS encryption configuration used to provide details for data encryption.
	//
	// KmsEncryptionConfig is a required field
	KmsEncryptionConfig *KmsEncryptionConfig `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

The server-side encryption key configuration for a customer provided encryption key.

func (SseConfiguration) GoString added in v1.40.0 

func (s SseConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SseConfiguration) SetKmsEncryptionConfig added in v1.40.0 

func (s *SseConfiguration) SetKmsEncryptionConfig(v *KmsEncryptionConfig) *SseConfiguration

SetKmsEncryptionConfig sets the KmsEncryptionConfig field's value.

func (SseConfiguration) String added in v1.40.0 

func (s SseConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SseConfiguration) Validate added in v1.40.0 

func (s *SseConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StartFHIRExportJobInput added in v1.36.20 

type StartFHIRExportJobInput struct {

	// An optional user provided token used for ensuring idempotency.
	ClientToken *string `min:"1" type:"string" idempotencyToken:"true"`

	// The Amazon Resource Name used during the initiation of the job.
	//
	// DataAccessRoleArn is a required field
	DataAccessRoleArn *string `min:"20" type:"string" required:"true"`

	// The AWS generated ID for the Data Store from which files are being exported
	// for an export job.
	//
	// DatastoreId is a required field
	DatastoreId *string `min:"1" type:"string" required:"true"`

	// The user generated name for an export job.
	JobName *string `min:"1" type:"string"`

	// The output data configuration that was supplied when the export job was created.
	//
	// OutputDataConfig is a required field
	OutputDataConfig *OutputDataConfig `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (StartFHIRExportJobInput) GoString added in v1.36.20 

func (s StartFHIRExportJobInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartFHIRExportJobInput) SetClientToken added in v1.36.20 

func (s *StartFHIRExportJobInput) SetClientToken(v string) *StartFHIRExportJobInput

SetClientToken sets the ClientToken field's value.

func (*StartFHIRExportJobInput) SetDataAccessRoleArn added in v1.36.20 

func (s *StartFHIRExportJobInput) SetDataAccessRoleArn(v string) *StartFHIRExportJobInput

SetDataAccessRoleArn sets the DataAccessRoleArn field's value.

func (*StartFHIRExportJobInput) SetDatastoreId added in v1.36.20 

func (s *StartFHIRExportJobInput) SetDatastoreId(v string) *StartFHIRExportJobInput

SetDatastoreId sets the DatastoreId field's value.

func (*StartFHIRExportJobInput) SetJobName added in v1.36.20 

func (s *StartFHIRExportJobInput) SetJobName(v string) *StartFHIRExportJobInput

SetJobName sets the JobName field's value.

func (*StartFHIRExportJobInput) SetOutputDataConfig added in v1.36.20 

func (s *StartFHIRExportJobInput) SetOutputDataConfig(v *OutputDataConfig) *StartFHIRExportJobInput

SetOutputDataConfig sets the OutputDataConfig field's value.

func (StartFHIRExportJobInput) String added in v1.36.20 

func (s StartFHIRExportJobInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartFHIRExportJobInput) Validate added in v1.36.20 

func (s *StartFHIRExportJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StartFHIRExportJobOutput added in v1.36.20 

type StartFHIRExportJobOutput struct {

	// The AWS generated ID for the Data Store from which files are being exported
	// for an export job.
	DatastoreId *string `min:"1" type:"string"`

	// The AWS generated ID for an export job.
	//
	// JobId is a required field
	JobId *string `min:"1" type:"string" required:"true"`

	// The status of a FHIR export job. Possible statuses are SUBMITTED, IN_PROGRESS,
	// COMPLETED, or FAILED.
	//
	// JobStatus is a required field
	JobStatus *string `type:"string" required:"true" enum:"JobStatus"`
	// contains filtered or unexported fields
}

func (StartFHIRExportJobOutput) GoString added in v1.36.20 

func (s StartFHIRExportJobOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartFHIRExportJobOutput) SetDatastoreId added in v1.36.20 

func (s *StartFHIRExportJobOutput) SetDatastoreId(v string) *StartFHIRExportJobOutput

SetDatastoreId sets the DatastoreId field's value.

func (*StartFHIRExportJobOutput) SetJobId added in v1.36.20 

func (s *StartFHIRExportJobOutput) SetJobId(v string) *StartFHIRExportJobOutput

SetJobId sets the JobId field's value.

func (*StartFHIRExportJobOutput) SetJobStatus added in v1.36.20 

func (s *StartFHIRExportJobOutput) SetJobStatus(v string) *StartFHIRExportJobOutput

SetJobStatus sets the JobStatus field's value.

func (StartFHIRExportJobOutput) String added in v1.36.20 

func (s StartFHIRExportJobOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StartFHIRImportJobInput 

type StartFHIRImportJobInput struct {

	// Optional user provided token used for ensuring idempotency.
	ClientToken *string `min:"1" type:"string" idempotencyToken:"true"`

	// The Amazon Resource Name (ARN) that gives Amazon HealthLake access permission.
	//
	// DataAccessRoleArn is a required field
	DataAccessRoleArn *string `min:"20" type:"string" required:"true"`

	// The AWS-generated Data Store ID.
	//
	// DatastoreId is a required field
	DatastoreId *string `min:"1" type:"string" required:"true"`

	// The input properties of the FHIR Import job in the StartFHIRImport job request.
	//
	// InputDataConfig is a required field
	InputDataConfig *InputDataConfig `type:"structure" required:"true"`

	// The name of the FHIR Import job in the StartFHIRImport job request.
	JobName *string `min:"1" type:"string"`

	// The output data configuration that was supplied when the export job was created.
	//
	// JobOutputDataConfig is a required field
	JobOutputDataConfig *OutputDataConfig `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (StartFHIRImportJobInput) GoString 

func (s StartFHIRImportJobInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartFHIRImportJobInput) SetClientToken 

func (s *StartFHIRImportJobInput) SetClientToken(v string) *StartFHIRImportJobInput

SetClientToken sets the ClientToken field's value.

func (*StartFHIRImportJobInput) SetDataAccessRoleArn 

func (s *StartFHIRImportJobInput) SetDataAccessRoleArn(v string) *StartFHIRImportJobInput

SetDataAccessRoleArn sets the DataAccessRoleArn field's value.

func (*StartFHIRImportJobInput) SetDatastoreId 

func (s *StartFHIRImportJobInput) SetDatastoreId(v string) *StartFHIRImportJobInput

SetDatastoreId sets the DatastoreId field's value.

func (*StartFHIRImportJobInput) SetInputDataConfig 

func (s *StartFHIRImportJobInput) SetInputDataConfig(v *InputDataConfig) *StartFHIRImportJobInput

SetInputDataConfig sets the InputDataConfig field's value.

func (*StartFHIRImportJobInput) SetJobName 

func (s *StartFHIRImportJobInput) SetJobName(v string) *StartFHIRImportJobInput

SetJobName sets the JobName field's value.

func (*StartFHIRImportJobInput) SetJobOutputDataConfig added in v1.40.0 

func (s *StartFHIRImportJobInput) SetJobOutputDataConfig(v *OutputDataConfig) *StartFHIRImportJobInput

SetJobOutputDataConfig sets the JobOutputDataConfig field's value.

func (StartFHIRImportJobInput) String 

func (s StartFHIRImportJobInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartFHIRImportJobInput) Validate 

func (s *StartFHIRImportJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StartFHIRImportJobOutput 

type StartFHIRImportJobOutput struct {

	// The AWS-generated Data Store ID.
	DatastoreId *string `min:"1" type:"string"`

	// The AWS-generated job ID.
	//
	// JobId is a required field
	JobId *string `min:"1" type:"string" required:"true"`

	// The status of an import job.
	//
	// JobStatus is a required field
	JobStatus *string `type:"string" required:"true" enum:"JobStatus"`
	// contains filtered or unexported fields
}

func (StartFHIRImportJobOutput) GoString 

func (s StartFHIRImportJobOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartFHIRImportJobOutput) SetDatastoreId 

func (s *StartFHIRImportJobOutput) SetDatastoreId(v string) *StartFHIRImportJobOutput

SetDatastoreId sets the DatastoreId field's value.

func (*StartFHIRImportJobOutput) SetJobId 

func (s *StartFHIRImportJobOutput) SetJobId(v string) *StartFHIRImportJobOutput

SetJobId sets the JobId field's value.

func (*StartFHIRImportJobOutput) SetJobStatus 

func (s *StartFHIRImportJobOutput) SetJobStatus(v string) *StartFHIRImportJobOutput

SetJobStatus sets the JobStatus field's value.

func (StartFHIRImportJobOutput) String 

func (s StartFHIRImportJobOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Tag added in v1.40.0 

type Tag struct {

	// The key portion of a tag. Tag keys are case sensitive.
	//
	// Key is a required field
	Key *string `min:"1" type:"string" required:"true"`

	// The value portion of tag. Tag values are case sensitive.
	//
	// Value is a required field
	Value *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

A tag is a label consisting of a user-defined key and value. The form for tags is {"Key", "Value"}

func (Tag) GoString added in v1.40.0 

func (s Tag) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Tag) SetKey added in v1.40.0 

func (s *Tag) SetKey(v string) *Tag

SetKey sets the Key field's value.

func (*Tag) SetValue added in v1.40.0 

func (s *Tag) SetValue(v string) *Tag

SetValue sets the Value field's value.

func (Tag) String added in v1.40.0 

func (s Tag) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Tag) Validate added in v1.40.0 

func (s *Tag) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagResourceInput added in v1.40.0 

type TagResourceInput struct {

	// The Amazon Resource Name(ARN)that gives Amazon HealthLake access to the Data
	// Store which tags are being added to.
	//
	// ResourceARN is a required field
	ResourceARN *string `min:"1" type:"string" required:"true"`

	// The user specified key and value pair tags being added to a Data Store.
	//
	// Tags is a required field
	Tags []*Tag `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (TagResourceInput) GoString added in v1.40.0 

func (s TagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) SetResourceARN added in v1.40.0 

func (s *TagResourceInput) SetResourceARN(v string) *TagResourceInput

SetResourceARN sets the ResourceARN field's value.

func (*TagResourceInput) SetTags added in v1.40.0 

func (s *TagResourceInput) SetTags(v []*Tag) *TagResourceInput

SetTags sets the Tags field's value.

func (TagResourceInput) String added in v1.40.0 

func (s TagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) Validate added in v1.40.0 

func (s *TagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagResourceOutput added in v1.40.0 

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

func (TagResourceOutput) GoString added in v1.40.0 

func (s TagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (TagResourceOutput) String added in v1.40.0 

func (s TagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ThrottlingException 

type ThrottlingException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The user has exceeded their maximum number of allowed calls to the given API.

func (*ThrottlingException) Code 

func (s *ThrottlingException) Code() string

Code returns the exception type name.

func (*ThrottlingException) Error 

func (s *ThrottlingException) Error() string

func (ThrottlingException) GoString 

func (s ThrottlingException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ThrottlingException) Message 

func (s *ThrottlingException) Message() string

Message returns the exception's message.

func (*ThrottlingException) OrigErr 

func (s *ThrottlingException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ThrottlingException) RequestID 

func (s *ThrottlingException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ThrottlingException) StatusCode 

func (s *ThrottlingException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ThrottlingException) String 

func (s ThrottlingException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UntagResourceInput added in v1.40.0 

type UntagResourceInput struct {

	// "The Amazon Resource Name(ARN) of the Data Store for which tags are being
	// removed
	//
	// ResourceARN is a required field
	ResourceARN *string `min:"1" type:"string" required:"true"`

	// The keys for the tags to be removed from the Healthlake Data Store.
	//
	// TagKeys is a required field
	TagKeys []*string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (UntagResourceInput) GoString added in v1.40.0 

func (s UntagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceInput) SetResourceARN added in v1.40.0 

func (s *UntagResourceInput) SetResourceARN(v string) *UntagResourceInput

SetResourceARN sets the ResourceARN field's value.

func (*UntagResourceInput) SetTagKeys added in v1.40.0 

func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput

SetTagKeys sets the TagKeys field's value.

func (UntagResourceInput) String added in v1.40.0 

func (s UntagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceInput) Validate added in v1.40.0 

func (s *UntagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UntagResourceOutput added in v1.40.0 

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

func (UntagResourceOutput) GoString added in v1.40.0 

func (s UntagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UntagResourceOutput) String added in v1.40.0 

func (s UntagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ValidationException 

type ValidationException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The user input parameter was invalid.

func (*ValidationException) Code 

func (s *ValidationException) Code() string

Code returns the exception type name.

func (*ValidationException) Error 

func (s *ValidationException) Error() string

func (ValidationException) GoString 

func (s ValidationException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ValidationException) Message 

func (s *ValidationException) Message() string

Message returns the exception's message.

func (*ValidationException) OrigErr 

func (s *ValidationException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ValidationException) RequestID 

func (s *ValidationException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ValidationException) StatusCode 

func (s *ValidationException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ValidationException) String 

func (s ValidationException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

Source Files

View all Source files

Directories

Path Synopsis
Package healthlakeiface provides an interface to enable mocking the Amazon HealthLake service client for testing your code.
 Package healthlakeiface provides an interface to enable mocking the Amazon HealthLake service client for testing your code.

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.