Class: Aws::HealthLake::Types::StartFHIRImportJobRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-healthlake/lib/aws-sdk-healthlake/types.rb

Overview

Note:

When making an API call, you may pass StartFHIRImportJobRequest data as a hash:

{
  job_name: "JobName",
  input_data_config: { # required
    s3_uri: "S3Uri",
  },
  job_output_data_config: { # required
    s3_configuration: {
      s3_uri: "S3Uri", # required
      kms_key_id: "EncryptionKeyID", # required
    },
  },
  datastore_id: "DatastoreId", # required
  data_access_role_arn: "IamRoleArn", # required
  client_token: "ClientTokenString", # required
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#client_tokenString

Optional user provided token used for ensuring idempotency.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

  • (String)


1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
# File 'gems/aws-sdk-healthlake/lib/aws-sdk-healthlake/types.rb', line 1088

class StartFHIRImportJobRequest < Struct.new(
  :job_name,
  :input_data_config,
  :job_output_data_config,
  :datastore_id,
  :data_access_role_arn,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#data_access_role_arnString

The Amazon Resource Name (ARN) that gives Amazon HealthLake access permission.

Returns:

  • (String)


1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
# File 'gems/aws-sdk-healthlake/lib/aws-sdk-healthlake/types.rb', line 1088

class StartFHIRImportJobRequest < Struct.new(
  :job_name,
  :input_data_config,
  :job_output_data_config,
  :datastore_id,
  :data_access_role_arn,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#datastore_idString

The AWS-generated Data Store ID.

Returns:

  • (String)


1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
# File 'gems/aws-sdk-healthlake/lib/aws-sdk-healthlake/types.rb', line 1088

class StartFHIRImportJobRequest < Struct.new(
  :job_name,
  :input_data_config,
  :job_output_data_config,
  :datastore_id,
  :data_access_role_arn,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#input_data_configTypes::InputDataConfig

The input properties of the FHIR Import job in the StartFHIRImport job request.



1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
# File 'gems/aws-sdk-healthlake/lib/aws-sdk-healthlake/types.rb', line 1088

class StartFHIRImportJobRequest < Struct.new(
  :job_name,
  :input_data_config,
  :job_output_data_config,
  :datastore_id,
  :data_access_role_arn,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#job_nameString

The name of the FHIR Import job in the StartFHIRImport job request.

Returns:

  • (String)


1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
# File 'gems/aws-sdk-healthlake/lib/aws-sdk-healthlake/types.rb', line 1088

class StartFHIRImportJobRequest < Struct.new(
  :job_name,
  :input_data_config,
  :job_output_data_config,
  :datastore_id,
  :data_access_role_arn,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#job_output_data_configTypes::OutputDataConfig

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



1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
# File 'gems/aws-sdk-healthlake/lib/aws-sdk-healthlake/types.rb', line 1088

class StartFHIRImportJobRequest < Struct.new(
  :job_name,
  :input_data_config,
  :job_output_data_config,
  :datastore_id,
  :data_access_role_arn,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end