types

package
v1.14.18 Latest Latest
Warning

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

 Go to latest Published: Oct 21, 2022 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AccessDeniedException 

type AccessDeniedException struct {
	Message *string
	// contains filtered or unexported fields
}

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

func (*AccessDeniedException) Error 

func (e *AccessDeniedException) Error() string

func (*AccessDeniedException) ErrorCode 

func (e *AccessDeniedException) ErrorCode() string

func (*AccessDeniedException) ErrorFault 

func (e *AccessDeniedException) ErrorFault() smithy.ErrorFault

func (*AccessDeniedException) ErrorMessage 

func (e *AccessDeniedException) ErrorMessage() string

type CmkType added in v1.5.0 

type CmkType string
const (
	CmkTypeCmCmk CmkType = "CUSTOMER_MANAGED_KMS_KEY"
	CmkTypeAoCmk CmkType = "AWS_OWNED_KMS_KEY"
)

Enum values for CmkType

func (CmkType) Values added in v1.5.0 

func (CmkType) Values() []CmkType

Values returns all known values for CmkType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ConflictException 

type ConflictException struct {
	Message *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) Error 

func (e *ConflictException) Error() string

func (*ConflictException) ErrorCode 

func (e *ConflictException) ErrorCode() string

func (*ConflictException) ErrorFault 

func (e *ConflictException) ErrorFault() smithy.ErrorFault

func (*ConflictException) ErrorMessage 

func (e *ConflictException) ErrorMessage() string

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

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

	// Allows the user to filter Data Store results by name.
	DatastoreName *string

	// Allows the user to filter Data Store results by status.
	DatastoreStatus DatastoreStatus
	// contains filtered or unexported fields
}

The filters applied to Data Store query.

type DatastoreProperties 

type DatastoreProperties struct {

	// The Amazon Resource Name used in the creation of the Data Store.
	//
	// This member is required.
	DatastoreArn *string

	// The AWS endpoint for the Data Store. Each Data Store will have it's own endpoint
	// with Data Store ID in the endpoint URL.
	//
	// This member is required.
	DatastoreEndpoint *string

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

	// The status of the Data Store. Possible statuses are 'CREATING', 'ACTIVE',
	// 'DELETING', or 'DELETED'.
	//
	// This member is required.
	DatastoreStatus DatastoreStatus

	// The FHIR version. Only R4 version data is supported.
	//
	// This member is required.
	DatastoreTypeVersion FHIRVersion

	// The time that a Data Store was created.
	CreatedAt *time.Time

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

	// The preloaded data configuration for the Data Store. Only data preloaded from
	// Synthea is supported.
	PreloadDataConfig *PreloadDataConfig

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

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

type DatastoreStatus 

type DatastoreStatus string
const (
	DatastoreStatusCreating DatastoreStatus = "CREATING"
	DatastoreStatusActive   DatastoreStatus = "ACTIVE"
	DatastoreStatusDeleting DatastoreStatus = "DELETING"
	DatastoreStatusDeleted  DatastoreStatus = "DELETED"
)

Enum values for DatastoreStatus

func (DatastoreStatus) Values 

func (DatastoreStatus) Values() []DatastoreStatus

Values returns all known values for DatastoreStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ExportJobProperties added in v1.2.0 

type ExportJobProperties struct {

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

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

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

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

	// The time an export job was initiated.
	//
	// This member is required.
	SubmitTime *time.Time

	// The Amazon Resource Name used during the initiation of the job.
	DataAccessRoleArn *string

	// The time an export job completed.
	EndTime *time.Time

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

	// An explanation of any errors that may have occurred during the export job.
	Message *string
	// contains filtered or unexported fields
}

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

type FHIRVersion 

type FHIRVersion string
const (
	FHIRVersionR4 FHIRVersion = "R4"
)

Enum values for FHIRVersion

func (FHIRVersion) Values 

func (FHIRVersion) Values() []FHIRVersion

Values returns all known values for FHIRVersion. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ImportJobProperties 

type ImportJobProperties struct {

	// The datastore id used when the Import job was created.
	//
	// This member is required.
	DatastoreId *string

	// The input data configuration that was supplied when the Import job was created.
	//
	// This member is required.
	InputDataConfig InputDataConfig

	// The AWS-generated id number for the Import job.
	//
	// This member is required.
	JobId *string

	// The job status for an Import job. Possible statuses are SUBMITTED, IN_PROGRESS,
	// COMPLETED, FAILED.
	//
	// This member is required.
	JobStatus JobStatus

	// The time that the Import job was submitted for processing.
	//
	// This member is required.
	SubmitTime *time.Time

	// The Amazon Resource Name (ARN) that gives Amazon HealthLake access to your input
	// data.
	DataAccessRoleArn *string

	// The time that the Import job was completed.
	EndTime *time.Time

	// The user-generated name for an Import job.
	JobName *string

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

	// An explanation of any errors that may have occurred during the FHIR import job.
	Message *string
	// contains filtered or unexported fields
}

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

type InputDataConfig 

type InputDataConfig interface {
	// contains filtered or unexported methods
}

The input properties for an import job.

The following types satisfy this interface: 

InputDataConfigMemberS3Uri
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/healthlake/types"
)

func main() {
	var union types.InputDataConfig
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.InputDataConfigMemberS3Uri:
		_ = v.Value // Value is string

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

Output:

type InputDataConfigMemberS3Uri 

type InputDataConfigMemberS3Uri struct {
	Value string
	// contains filtered or unexported fields
}

The S3Uri is the user specified S3 location of the FHIR data to be imported into Amazon HealthLake.

type InternalServerException 

type InternalServerException struct {
	Message *string
	// contains filtered or unexported fields
}

Unknown error occurs in the service.

func (*InternalServerException) Error 

func (e *InternalServerException) Error() string

func (*InternalServerException) ErrorCode 

func (e *InternalServerException) ErrorCode() string

func (*InternalServerException) ErrorFault 

func (e *InternalServerException) ErrorFault() smithy.ErrorFault

func (*InternalServerException) ErrorMessage 

func (e *InternalServerException) ErrorMessage() string

type JobStatus 

type JobStatus string
const (
	JobStatusSubmitted           JobStatus = "SUBMITTED"
	JobStatusInProgress          JobStatus = "IN_PROGRESS"
	JobStatusCompletedWithErrors JobStatus = "COMPLETED_WITH_ERRORS"
	JobStatusCompleted           JobStatus = "COMPLETED"
	JobStatusFailed              JobStatus = "FAILED"
)

Enum values for JobStatus

func (JobStatus) Values 

func (JobStatus) Values() []JobStatus

Values returns all known values for JobStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type KmsEncryptionConfig added in v1.5.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.
	//
	// This member is required.
	CmkType CmkType

	// The KMS encryption key id/alias used to encrypt the Data Store contents at rest.
	KmsKeyId *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.

type OutputDataConfig added in v1.2.0 

type OutputDataConfig interface {
	// contains filtered or unexported methods
}

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

The following types satisfy this interface: 

OutputDataConfigMemberS3Configuration
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/healthlake/types"
)

func main() {
	var union types.OutputDataConfig
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.OutputDataConfigMemberS3Configuration:
		_ = v.Value // Value is types.S3Configuration

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

Output:

type OutputDataConfigMemberS3Configuration added in v1.5.0 

type OutputDataConfigMemberS3Configuration struct {
	Value S3Configuration
	// contains filtered or unexported fields
}

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

type PreloadDataConfig 

type PreloadDataConfig struct {

	// The type of preloaded data. Only Synthea preloaded data is supported.
	//
	// This member is required.
	PreloadDataType PreloadDataType
	// contains filtered or unexported fields
}

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

type PreloadDataType 

type PreloadDataType string
const (
	PreloadDataTypeSynthea PreloadDataType = "SYNTHEA"
)

Enum values for PreloadDataType

func (PreloadDataType) Values 

func (PreloadDataType) Values() []PreloadDataType

Values returns all known values for PreloadDataType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ResourceNotFoundException 

type ResourceNotFoundException struct {
	Message *string
	// contains filtered or unexported fields
}

The requested Data Store was not found.

func (*ResourceNotFoundException) Error 

func (e *ResourceNotFoundException) Error() string

func (*ResourceNotFoundException) ErrorCode 

func (e *ResourceNotFoundException) ErrorCode() string

func (*ResourceNotFoundException) ErrorFault 

func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault

func (*ResourceNotFoundException) ErrorMessage 

func (e *ResourceNotFoundException) ErrorMessage() string

type S3Configuration added in v1.5.0 

type S3Configuration struct {

	// The KMS key ID used to access the S3 bucket.
	//
	// This member is required.
	KmsKeyId *string

	// The S3Uri is the user specified S3 location of the FHIR data to be imported into
	// Amazon HealthLake.
	//
	// This member is required.
	S3Uri *string
	// contains filtered or unexported fields
}

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

type SseConfiguration added in v1.5.0 

type SseConfiguration struct {

	// The KMS encryption configuration used to provide details for data encryption.
	//
	// This member is required.
	KmsEncryptionConfig *KmsEncryptionConfig
	// contains filtered or unexported fields
}

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

type Tag added in v1.5.0 

type Tag struct {

	// The key portion of a tag. Tag keys are case sensitive.
	//
	// This member is required.
	Key *string

	// The value portion of tag. Tag values are case sensitive.
	//
	// This member is required.
	Value *string
	// 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"}

type ThrottlingException 

type ThrottlingException struct {
	Message *string
	// contains filtered or unexported fields
}

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

func (*ThrottlingException) Error 

func (e *ThrottlingException) Error() string

func (*ThrottlingException) ErrorCode 

func (e *ThrottlingException) ErrorCode() string

func (*ThrottlingException) ErrorFault 

func (e *ThrottlingException) ErrorFault() smithy.ErrorFault

func (*ThrottlingException) ErrorMessage 

func (e *ThrottlingException) ErrorMessage() string

type UnknownUnionMember 

type UnknownUnionMember struct {
	Tag   string
	Value []byte
	// contains filtered or unexported fields
}

UnknownUnionMember is returned when a union member is returned over the wire, but has an unknown tag.

type ValidationException 

type ValidationException struct {
	Message *string
	// contains filtered or unexported fields
}

The user input parameter was invalid.

func (*ValidationException) Error 

func (e *ValidationException) Error() string

func (*ValidationException) ErrorCode 

func (e *ValidationException) ErrorCode() string

func (*ValidationException) ErrorFault 

func (e *ValidationException) ErrorFault() smithy.ErrorFault

func (*ValidationException) ErrorMessage 

func (e *ValidationException) ErrorMessage() string

Source Files

View all Source files

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.