Class: Aws::HealthLake::Types::StartFHIRExportJobRequest

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 StartFHIRExportJobRequest data as a hash:

{
  job_name: "JobName",
  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

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


1003
1004
1005
1006
1007
1008
1009
1010
1011
# File 'gems/aws-sdk-healthlake/lib/aws-sdk-healthlake/types.rb', line 1003

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

#data_access_role_arnString

The Amazon Resource Name used during the initiation of the job.

Returns:

  • (String)


1003
1004
1005
1006
1007
1008
1009
1010
1011
# File 'gems/aws-sdk-healthlake/lib/aws-sdk-healthlake/types.rb', line 1003

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

#datastore_idString

The AWS generated ID for the Data Store from which files are being exported for an export job.

Returns:

  • (String)


1003
1004
1005
1006
1007
1008
1009
1010
1011
# File 'gems/aws-sdk-healthlake/lib/aws-sdk-healthlake/types.rb', line 1003

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

#job_nameString

The user generated name for an export job.

Returns:

  • (String)


1003
1004
1005
1006
1007
1008
1009
1010
1011
# File 'gems/aws-sdk-healthlake/lib/aws-sdk-healthlake/types.rb', line 1003

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

#output_data_configTypes::OutputDataConfig

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



1003
1004
1005
1006
1007
1008
1009
1010
1011
# File 'gems/aws-sdk-healthlake/lib/aws-sdk-healthlake/types.rb', line 1003

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