Struct Client

pub struct Client { /* private fields */ }

Client for Amazon Omics

Client for invoking operations on Amazon Omics. Each operation on Amazon Omics is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Constructing a Client

A Config is required to construct a client. For most use cases, the aws-config crate should be used to automatically resolve this config using aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared across multiple different AWS SDK clients. This config resolution process can be customized by calling aws_config::from_env() instead, which returns a ConfigLoader that uses the builder pattern to customize the default config.

In the simplest case, creating a client looks as follows:

let config = aws_config::load_from_env().await;
let client = aws_sdk_omics::Client::new(&config);

Occasionally, SDKs may have additional service-specific values that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Builder struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_omics::config::Builder::from(&sdk_config)
    .some_service_specific_setting("value")
    .build();

See the aws-config docs and Config for more information on customizing configuration.

Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.

Using the Client

A client has a function for every operation that can be performed by the service. For example, the AbortMultipartReadSetUpload operation has a Client::abort_multipart_read_set_upload, function which returns a builder for that operation. The fluent builder ultimately has a send() function that returns an async future that returns a result, as illustrated below:

let result = client.abort_multipart_read_set_upload()
    .sequence_store_id("example")
    .send()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

Waiters

This client provides wait_until methods behind the Waiters trait. To use them, simply import the trait, and then call one of the wait_until methods. This will return a waiter fluent builder that takes various parameters, which are documented on the builder type. Once parameters have been provided, the wait method can be called to initiate waiting.

For example, if there was a wait_until_thing method, it could look like:

let result = client.wait_until_thing()
    .thing_id("someId")
    .wait(Duration::from_secs(120))
    .await;

Implementations

impl Client

pub fn abort_multipart_read_set_upload( &self, ) -> AbortMultipartReadSetUploadFluentBuilder

Constructs a fluent builder for the AbortMultipartReadSetUpload operation.

• The fluent builder is configurable:
  • sequence_store_id(impl Into<String>) / set_sequence_store_id(Option<String>):
    required: true
    

    The sequence store ID for the store involved in the multipart upload.

    
    
  • upload_id(impl Into<String>) / set_upload_id(Option<String>):
    required: true
    

    The ID for the multipart upload.

    
    
• On success, responds with AbortMultipartReadSetUploadOutput
• On failure, responds with SdkError<AbortMultipartReadSetUploadError>

impl Client

pub fn accept_share(&self) -> AcceptShareFluentBuilder

Constructs a fluent builder for the AcceptShare operation.

• The fluent builder is configurable:
  • share_id(impl Into<String>) / set_share_id(Option<String>):
    required: true
    

    The ID of the resource share.

    
    
• On success, responds with AcceptShareOutput with field(s):
  • status(Option<ShareStatus>):

    The status of the resource share.

• On failure, responds with SdkError<AcceptShareError>

impl Client

pub fn batch_delete_read_set(&self) -> BatchDeleteReadSetFluentBuilder

Constructs a fluent builder for the BatchDeleteReadSet operation.

• The fluent builder is configurable:
  • ids(impl Into<String>) / set_ids(Option<Vec::<String>>):
    required: true
    

    The read sets’ IDs.

    
    
  • sequence_store_id(impl Into<String>) / set_sequence_store_id(Option<String>):
    required: true
    

    The read sets’ sequence store ID.

    
    
• On success, responds with BatchDeleteReadSetOutput with field(s):
  • errors(Option<Vec::<ReadSetBatchError>>):

    Errors returned by individual delete operations.

• On failure, responds with SdkError<BatchDeleteReadSetError>

impl Client

pub fn cancel_annotation_import_job( &self, ) -> CancelAnnotationImportJobFluentBuilder

Constructs a fluent builder for the CancelAnnotationImportJob operation.

• The fluent builder is configurable:
  • job_id(impl Into<String>) / set_job_id(Option<String>):
    required: true
    

    The job’s ID.

    
    
• On success, responds with CancelAnnotationImportJobOutput
• On failure, responds with SdkError<CancelAnnotationImportJobError>

impl Client

pub fn cancel_run(&self) -> CancelRunFluentBuilder

Constructs a fluent builder for the CancelRun operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The run’s ID.

    
    
• On success, responds with CancelRunOutput
• On failure, responds with SdkError<CancelRunError>

impl Client

pub fn cancel_variant_import_job(&self) -> CancelVariantImportJobFluentBuilder

Constructs a fluent builder for the CancelVariantImportJob operation.

• The fluent builder is configurable:
  • job_id(impl Into<String>) / set_job_id(Option<String>):
    required: true
    

    The job’s ID.

    
    
• On success, responds with CancelVariantImportJobOutput
• On failure, responds with SdkError<CancelVariantImportJobError>

impl Client

pub fn complete_multipart_read_set_upload( &self, ) -> CompleteMultipartReadSetUploadFluentBuilder

Constructs a fluent builder for the CompleteMultipartReadSetUpload operation.

• The fluent builder is configurable:
  • sequence_store_id(impl Into<String>) / set_sequence_store_id(Option<String>):
    required: true
    

    The sequence store ID for the store involved in the multipart upload.

    
    
  • upload_id(impl Into<String>) / set_upload_id(Option<String>):
    required: true
    

    The ID for the multipart upload.

    
    
  • parts(CompleteReadSetUploadPartListItem) / set_parts(Option<Vec::<CompleteReadSetUploadPartListItem>>):
    required: true
    

    The individual uploads or parts of a multipart upload.

    
    
• On success, responds with CompleteMultipartReadSetUploadOutput with field(s):
  • read_set_id(String):

    The read set ID created for an uploaded read set.

• On failure, responds with SdkError<CompleteMultipartReadSetUploadError>

impl Client

pub fn create_annotation_store(&self) -> CreateAnnotationStoreFluentBuilder

Constructs a fluent builder for the CreateAnnotationStore operation.

• The fluent builder is configurable:
  • reference(ReferenceItem) / set_reference(Option<ReferenceItem>):
    required: false
    

    The genome reference for the store’s annotations.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    A name for the store.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A description for the store.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    Tags for the store.

    
    
  • version_name(impl Into<String>) / set_version_name(Option<String>):
    required: false
    

    The name given to an annotation store version to distinguish it from other versions.

    
    
  • sse_config(SseConfig) / set_sse_config(Option<SseConfig>):
    required: false
    

    Server-side encryption (SSE) settings for the store.

    
    
  • store_format(StoreFormat) / set_store_format(Option<StoreFormat>):
    required: true
    

    The annotation file format of the store.

    
    
  • store_options(StoreOptions) / set_store_options(Option<StoreOptions>):
    required: false
    

    File parsing options for the annotation store.

    
    
• On success, responds with CreateAnnotationStoreOutput with field(s):
  • id(String):

    The store’s ID.

  • reference(Option<ReferenceItem>):

    The store’s genome reference. Required for all stores except TSV format with generic annotations.

  • store_format(Option<StoreFormat>):

    The annotation file format of the store.

  • store_options(Option<StoreOptions>):

    The store’s file parsing options.

  • status(StoreStatus):

    The store’s status.

  • name(String):

    The store’s name.

  • version_name(String):

    The name given to an annotation store version to distinguish it from other versions.

  • creation_time(DateTime):

    When the store was created.

• On failure, responds with SdkError<CreateAnnotationStoreError>

impl Client

pub fn create_annotation_store_version( &self, ) -> CreateAnnotationStoreVersionFluentBuilder

Constructs a fluent builder for the CreateAnnotationStoreVersion operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of an annotation store version from which versions are being created.

    
    
  • version_name(impl Into<String>) / set_version_name(Option<String>):
    required: true
    

    The name given to an annotation store version to distinguish it from other versions.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The description of an annotation store version.

    
    
  • version_options(VersionOptions) / set_version_options(Option<VersionOptions>):
    required: false
    

    The options for an annotation store version.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    Any tags added to annotation store version.

    
    
• On success, responds with CreateAnnotationStoreVersionOutput with field(s):
  • id(String):

    A generated ID for the annotation store

  • version_name(String):

    The name given to an annotation store version to distinguish it from other versions.

  • store_id(String):

    The ID for the annotation store from which new versions are being created.

  • version_options(Option<VersionOptions>):

    The options for an annotation store version.

  • name(String):

    The name given to an annotation store version to distinguish it from other versions.

  • status(VersionStatus):

    The status of a annotation store version.

  • creation_time(DateTime):

    The time stamp for the creation of an annotation store version.

• On failure, responds with SdkError<CreateAnnotationStoreVersionError>

impl Client

pub fn create_multipart_read_set_upload( &self, ) -> CreateMultipartReadSetUploadFluentBuilder

Constructs a fluent builder for the CreateMultipartReadSetUpload operation.

• The fluent builder is configurable:
  • sequence_store_id(impl Into<String>) / set_sequence_store_id(Option<String>):
    required: true
    

    The sequence store ID for the store that is the destination of the multipart uploads.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    An idempotency token that can be used to avoid triggering multiple multipart uploads.

    
    
  • source_file_type(FileType) / set_source_file_type(Option<FileType>):
    required: true
    

    The type of file being uploaded.

    
    
  • subject_id(impl Into<String>) / set_subject_id(Option<String>):
    required: true
    

    The source’s subject ID.

    
    
  • sample_id(impl Into<String>) / set_sample_id(Option<String>):
    required: true
    

    The source’s sample ID.

    
    
  • generated_from(impl Into<String>) / set_generated_from(Option<String>):
    required: false
    

    Where the source originated.

    
    
  • reference_arn(impl Into<String>) / set_reference_arn(Option<String>):
    required: false
    

    The ARN of the reference.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the read set.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The description of the read set.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    Any tags to add to the read set.

    
    
• On success, responds with CreateMultipartReadSetUploadOutput with field(s):
  • sequence_store_id(String):

    The sequence store ID for the store that the read set will be created in.

  • upload_id(String):

    The ID for the initiated multipart upload.

  • source_file_type(FileType):

    The file type of the read set source.

  • subject_id(String):

    The source’s subject ID.

  • sample_id(String):

    The source’s sample ID.

  • generated_from(Option<String>):

    The source of the read set.

  • reference_arn(String):

    The read set source’s reference ARN.

  • name(Option<String>):

    The name of the read set.

  • description(Option<String>):

    The description of the read set.

  • tags(Option<HashMap::<String, String>>):

    The tags to add to the read set.

  • creation_time(DateTime):

    The creation time of the multipart upload.

• On failure, responds with SdkError<CreateMultipartReadSetUploadError>

impl Client

pub fn create_reference_store(&self) -> CreateReferenceStoreFluentBuilder

Constructs a fluent builder for the CreateReferenceStore operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    A name for the store.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A description for the store.

    
    
  • sse_config(SseConfig) / set_sse_config(Option<SseConfig>):
    required: false
    

    Server-side encryption (SSE) settings for the store.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    Tags for the store.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    To ensure that requests don’t run multiple times, specify a unique token for each request.

    
    
• On success, responds with CreateReferenceStoreOutput with field(s):
  • id(String):

    The store’s ID.

  • arn(String):

    The store’s ARN.

  • name(Option<String>):

    The store’s name.

  • description(Option<String>):

    The store’s description.

  • sse_config(Option<SseConfig>):

    The store’s SSE settings.

  • creation_time(DateTime):

    When the store was created.

• On failure, responds with SdkError<CreateReferenceStoreError>

impl Client

pub fn create_run_cache(&self) -> CreateRunCacheFluentBuilder

Constructs a fluent builder for the CreateRunCache operation.

• The fluent builder is configurable:
  • cache_behavior(CacheBehavior) / set_cache_behavior(Option<CacheBehavior>):
    required: false
    

    Default cache behavior for runs that use this cache. Supported values are:

    CACHE_ON_FAILURE: Caches task outputs from completed tasks for runs that fail. This setting is useful if you’re debugging a workflow that fails after several tasks completed successfully. The subsequent run uses the cache outputs for previously-completed tasks if the task definition, inputs, and container in ECR are identical to the prior run.

    CACHE_ALWAYS: Caches task outputs from completed tasks for all runs. This setting is useful in development mode, but do not use it in a production setting.

    If you don’t specify a value, the default behavior is CACHE_ON_FAILURE. When you start a run that uses this cache, you can override the default cache behavior.

    For more information, see Run cache behavior in the Amazon Web Services HealthOmics User Guide.

    
    
  • cache_s3_location(impl Into<String>) / set_cache_s3_location(Option<String>):
    required: true
    

    Specify the S3 location for storing the cached task outputs. This data must be immediately accessible (not in an archived state).

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    Enter a description of the run cache.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    Enter a user-friendly name for the run cache.

    
    
  • request_id(impl Into<String>) / set_request_id(Option<String>):
    required: true
    

    A unique request token, to ensure idempotency. If you don’t specify a token, Amazon Web Services HealthOmics automatically generates a universally unique identifier (UUID) for the request.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    Specify one or more tags to associate with this run cache.

    
    
  • cache_bucket_owner_id(impl Into<String>) / set_cache_bucket_owner_id(Option<String>):
    required: false
    

    The Amazon Web Services account ID of the expected owner of the S3 bucket for the run cache. If not provided, your account ID is set as the owner of the bucket.

    
    
• On success, responds with CreateRunCacheOutput with field(s):
  • arn(Option<String>):

    Unique resource identifier for the run cache.

  • id(Option<String>):

    Identifier for the run cache.

  • status(Option<RunCacheStatus>):

    Run cache status.

  • tags(Option<HashMap::<String, String>>):

    The tags associated with this run cache.

• On failure, responds with SdkError<CreateRunCacheError>

impl Client

pub fn create_run_group(&self) -> CreateRunGroupFluentBuilder

Constructs a fluent builder for the CreateRunGroup operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    A name for the group.

    
    
  • max_cpus(i32) / set_max_cpus(Option<i32>):
    required: false
    

    The maximum number of CPUs that can run concurrently across all active runs in the run group.

    
    
  • max_runs(i32) / set_max_runs(Option<i32>):
    required: false
    

    The maximum number of runs that can be running at the same time.

    
    
  • max_duration(i32) / set_max_duration(Option<i32>):
    required: false
    

    The maximum time for each run (in minutes). If a run exceeds the maximum run time, the run fails automatically.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    Tags for the group.

    
    
  • request_id(impl Into<String>) / set_request_id(Option<String>):
    required: true
    

    To ensure that requests don’t run multiple times, specify a unique ID for each request.

    
    
  • max_gpus(i32) / set_max_gpus(Option<i32>):
    required: false
    

    The maximum number of GPUs that can run concurrently across all active runs in the run group.

    
    
• On success, responds with CreateRunGroupOutput with field(s):
  • arn(Option<String>):

    The group’s ARN.

  • id(Option<String>):

    The group’s ID.

  • tags(Option<HashMap::<String, String>>):

    Tags for the run group.

• On failure, responds with SdkError<CreateRunGroupError>

impl Client

pub fn create_sequence_store(&self) -> CreateSequenceStoreFluentBuilder

Constructs a fluent builder for the CreateSequenceStore operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    A name for the store.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A description for the store.

    
    
  • sse_config(SseConfig) / set_sse_config(Option<SseConfig>):
    required: false
    

    Server-side encryption (SSE) settings for the store.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    Tags for the store.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    To ensure that requests don’t run multiple times, specify a unique token for each request.

    
    
  • fallback_location(impl Into<String>) / set_fallback_location(Option<String>):
    required: false
    

    An S3 location that is used to store files that have failed a direct upload.

    
    
  • e_tag_algorithm_family(ETagAlgorithmFamily) / set_e_tag_algorithm_family(Option<ETagAlgorithmFamily>):
    required: false
    

    The ETag algorithm family to use for ingested read sets.

    
    
  • propagated_set_level_tags(impl Into<String>) / set_propagated_set_level_tags(Option<Vec::<String>>):
    required: false
    

    The tags keys to propagate to the S3 objects associated with read sets in the sequence store.

    
    
  • s3_access_config(S3AccessConfig) / set_s3_access_config(Option<S3AccessConfig>):
    required: false
    

    S3 access configuration parameters

    
    
• On success, responds with CreateSequenceStoreOutput with field(s):
  • id(String):

    The store’s ID.

  • arn(String):

    The store’s ARN.

  • name(Option<String>):

    The store’s name.

  • description(Option<String>):

    The store’s description.

  • sse_config(Option<SseConfig>):

    The store’s SSE settings.

  • creation_time(DateTime):

    When the store was created.

  • fallback_location(Option<String>):

    An S3 location that is used to store files that have failed a direct upload.

  • e_tag_algorithm_family(Option<ETagAlgorithmFamily>):

    The algorithm family of the ETag.

  • status(Option<SequenceStoreStatus>):

    The status of the sequence store.

  • status_message(Option<String>):

    The status message of the sequence store.

  • propagated_set_level_tags(Option<Vec::<String>>):

    The tags keys to propagate to the S3 objects associated with read sets in the sequence store.

  • s3_access(Option<SequenceStoreS3Access>):

    The S3 access metadata of the sequence store.

• On failure, responds with SdkError<CreateSequenceStoreError>

impl Client

pub fn create_share(&self) -> CreateShareFluentBuilder

Constructs a fluent builder for the CreateShare operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The ARN of the resource to be shared.

    
    
  • principal_subscriber(impl Into<String>) / set_principal_subscriber(Option<String>):
    required: true
    

    The principal subscriber is the account being offered shared access to the resource.

    
    
  • share_name(impl Into<String>) / set_share_name(Option<String>):
    required: false
    

    A name that the owner defines for the share.

    
    
• On success, responds with CreateShareOutput with field(s):
  • share_id(Option<String>):

    The ID that HealthOmics generates for the share.

  • status(Option<ShareStatus>):

    The status of the share.

  • share_name(Option<String>):

    The name of the share.

• On failure, responds with SdkError<CreateShareError>

impl Client

pub fn create_variant_store(&self) -> CreateVariantStoreFluentBuilder

Constructs a fluent builder for the CreateVariantStore operation.

• The fluent builder is configurable:
  • reference(ReferenceItem) / set_reference(Option<ReferenceItem>):
    required: true
    

    The genome reference for the store’s variants.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    A name for the store.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A description for the store.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    Tags for the store.

    
    
  • sse_config(SseConfig) / set_sse_config(Option<SseConfig>):
    required: false
    

    Server-side encryption (SSE) settings for the store.

    
    
• On success, responds with CreateVariantStoreOutput with field(s):
  • id(String):

    The store’s ID.

  • reference(Option<ReferenceItem>):

    The store’s genome reference.

  • status(StoreStatus):

    The store’s status.

  • name(String):

    The store’s name.

  • creation_time(DateTime):

    When the store was created.

• On failure, responds with SdkError<CreateVariantStoreError>

impl Client

pub fn create_workflow(&self) -> CreateWorkflowFluentBuilder

Constructs a fluent builder for the CreateWorkflow operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    A name for the workflow.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A description for the workflow.

    
    
  • engine(WorkflowEngine) / set_engine(Option<WorkflowEngine>):
    required: false
    

    The workflow engine for the workflow.

    
    
  • definition_zip(Blob) / set_definition_zip(Option<Blob>):
    required: false
    

    A ZIP archive for the workflow.

    
    
  • definition_uri(impl Into<String>) / set_definition_uri(Option<String>):
    required: false
    

    The URI of a definition for the workflow.

    
    
  • main(impl Into<String>) / set_main(Option<String>):
    required: false
    

    The path of the main definition file for the workflow.

    
    
  • parameter_template(impl Into<String>, WorkflowParameter) / set_parameter_template(Option<HashMap::<String, WorkflowParameter>>):
    required: false
    

    A parameter template for the workflow.

    
    
  • storage_capacity(i32) / set_storage_capacity(Option<i32>):
    required: false
    

    The default static storage capacity (in gibibytes) for runs that use this workflow or workflow version.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    Tags for the workflow.

    
    
  • request_id(impl Into<String>) / set_request_id(Option<String>):
    required: true
    

    To ensure that requests don’t run multiple times, specify a unique ID for each request.

    
    
  • accelerators(Accelerators) / set_accelerators(Option<Accelerators>):
    required: false
    

    The computational accelerator specified to run the workflow.

    
    
  • storage_type(StorageType) / set_storage_type(Option<StorageType>):
    required: false
    

    The default storage type for runs that use this workflow. STATIC storage allocates a fixed amount of storage. DYNAMIC storage dynamically scales the storage up or down, based on file system utilization. For more information about static and dynamic storage, see Running workflows in the Amazon Web Services HealthOmics User Guide.

    
    
• On success, responds with CreateWorkflowOutput with field(s):
  • arn(Option<String>):

    The workflow’s ARN.

  • id(Option<String>):

    The workflow’s ID.

  • status(Option<WorkflowStatus>):

    The workflow’s status.

  • tags(Option<HashMap::<String, String>>):

    The workflow’s tags.

  • uuid(Option<String>):

    The universally unique identifier (UUID) value for this workflow.

• On failure, responds with SdkError<CreateWorkflowError>

impl Client

pub fn create_workflow_version(&self) -> CreateWorkflowVersionFluentBuilder

Constructs a fluent builder for the CreateWorkflowVersion operation.

• The fluent builder is configurable:
  • workflow_id(impl Into<String>) / set_workflow_id(Option<String>):
    required: true
    

    The ID of the workflow where you are creating the new version.

    
    
  • version_name(impl Into<String>) / set_version_name(Option<String>):
    required: true
    

    A name for the workflow version. Provide a version name that is unique for this workflow. You cannot change the name after HealthOmics creates the version.

    The version name must start with a letter or number and it can include upper-case and lower-case letters, numbers, hyphens, periods and underscores. The maximum length is 64 characters. You can use a simple naming scheme, such as version1, version2, version3. You can also match your workflow versions with your own internal versioning conventions, such as 2.7.0, 2.7.1, 2.7.2.

    
    
  • definition_zip(Blob) / set_definition_zip(Option<Blob>):
    required: false
    

    A zip archive containing the workflow definition for this workflow version.

    
    
  • definition_uri(impl Into<String>) / set_definition_uri(Option<String>):
    required: false
    

    The URI specifies the location of the workflow definition for this workflow version.

    
    
  • accelerators(Accelerators) / set_accelerators(Option<Accelerators>):
    required: false
    

    The computational accelerator for this workflow version.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A description for this workflow version.

    
    
  • engine(WorkflowEngine) / set_engine(Option<WorkflowEngine>):
    required: false
    

    The workflow engine for this workflow version.

    
    
  • main(impl Into<String>) / set_main(Option<String>):
    required: false
    

    The path of the main definition file for this workflow version.

    
    
  • parameter_template(impl Into<String>, WorkflowParameter) / set_parameter_template(Option<HashMap::<String, WorkflowParameter>>):
    required: false
    

    The parameter template defines the input parameters for runs that use this workflow version.

    
    
  • request_id(impl Into<String>) / set_request_id(Option<String>):
    required: true
    

    To ensure that requests don’t run multiple times, specify a unique ID for each request.

    
    
  • storage_type(StorageType) / set_storage_type(Option<StorageType>):
    required: false
    

    The default storage type for runs that use this workflow. STATIC storage allocates a fixed amount of storage. DYNAMIC storage dynamically scales the storage up or down, based on file system utilization. For more information about static and dynamic storage, see Running workflows in the Amazon Web Services HealthOmics User Guide.

    
    
  • storage_capacity(i32) / set_storage_capacity(Option<i32>):
    required: false
    

    The default static storage capacity (in gibibytes) for runs that use this workflow or workflow version.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    Optional tags to associate with this workflow version.

    
    
  • workflow_bucket_owner_id(impl Into<String>) / set_workflow_bucket_owner_id(Option<String>):
    required: false
    

    Amazon Web Services Id of the owner of the S3 bucket that contains the workflow definition. You need to specify this parameter if your account is not the bucket owner.

    
    
• On success, responds with CreateWorkflowVersionOutput with field(s):
  • arn(Option<String>):

    ARN of the workflow version.

  • workflow_id(Option<String>):

    The workflow’s ID.

  • version_name(Option<String>):

    The workflow version name.

  • status(Option<WorkflowStatus>):

    The workflow version status.

  • tags(Option<HashMap::<String, String>>):

    The workflow version’s tags.

  • uuid(Option<String>):

    The universally unique identifier (UUID) value for this workflow version.

• On failure, responds with SdkError<CreateWorkflowVersionError>

impl Client

pub fn delete_annotation_store(&self) -> DeleteAnnotationStoreFluentBuilder

Constructs a fluent builder for the DeleteAnnotationStore operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The store’s name.

    
    
  • force(bool) / set_force(Option<bool>):
    required: false
    

    Whether to force deletion.

    
    
• On success, responds with DeleteAnnotationStoreOutput with field(s):
  • status(StoreStatus):

    The store’s status.

• On failure, responds with SdkError<DeleteAnnotationStoreError>

impl Client

pub fn delete_annotation_store_versions( &self, ) -> DeleteAnnotationStoreVersionsFluentBuilder

Constructs a fluent builder for the DeleteAnnotationStoreVersions operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the annotation store from which versions are being deleted.

    
    
  • versions(impl Into<String>) / set_versions(Option<Vec::<String>>):
    required: true
    

    The versions of an annotation store to be deleted.

    
    
  • force(bool) / set_force(Option<bool>):
    required: false
    

    Forces the deletion of an annotation store version when imports are in-progress..

    
    
• On success, responds with DeleteAnnotationStoreVersionsOutput with field(s):
  • errors(Option<Vec::<VersionDeleteError>>):

    Any errors that occur when attempting to delete an annotation store version.

• On failure, responds with SdkError<DeleteAnnotationStoreVersionsError>

impl Client

pub fn delete_reference(&self) -> DeleteReferenceFluentBuilder

Constructs a fluent builder for the DeleteReference operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The reference’s ID.

    
    
  • reference_store_id(impl Into<String>) / set_reference_store_id(Option<String>):
    required: true
    

    The reference’s store ID.

    
    
• On success, responds with DeleteReferenceOutput
• On failure, responds with SdkError<DeleteReferenceError>

impl Client

pub fn delete_reference_store(&self) -> DeleteReferenceStoreFluentBuilder

Constructs a fluent builder for the DeleteReferenceStore operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The store’s ID.

    
    
• On success, responds with DeleteReferenceStoreOutput
• On failure, responds with SdkError<DeleteReferenceStoreError>

impl Client

pub fn delete_run(&self) -> DeleteRunFluentBuilder

Constructs a fluent builder for the DeleteRun operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The run’s ID.

    
    
• On success, responds with DeleteRunOutput
• On failure, responds with SdkError<DeleteRunError>

impl Client

pub fn delete_run_cache(&self) -> DeleteRunCacheFluentBuilder

Constructs a fluent builder for the DeleteRunCache operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    Run cache identifier for the cache you want to delete.

    
    
• On success, responds with DeleteRunCacheOutput
• On failure, responds with SdkError<DeleteRunCacheError>

impl Client

pub fn delete_run_group(&self) -> DeleteRunGroupFluentBuilder

Constructs a fluent builder for the DeleteRunGroup operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The run group’s ID.

    
    
• On success, responds with DeleteRunGroupOutput
• On failure, responds with SdkError<DeleteRunGroupError>

impl Client

pub fn delete_s3_access_policy(&self) -> DeleteS3AccessPolicyFluentBuilder

Constructs a fluent builder for the DeleteS3AccessPolicy operation.

• The fluent builder is configurable:
  • s3_access_point_arn(impl Into<String>) / set_s3_access_point_arn(Option<String>):
    required: true
    

    The S3 access point ARN that has the access policy.

    
    
• On success, responds with DeleteS3AccessPolicyOutput
• On failure, responds with SdkError<DeleteS3AccessPolicyError>

impl Client

pub fn delete_sequence_store(&self) -> DeleteSequenceStoreFluentBuilder

Constructs a fluent builder for the DeleteSequenceStore operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The sequence store’s ID.

    
    
• On success, responds with DeleteSequenceStoreOutput
• On failure, responds with SdkError<DeleteSequenceStoreError>

impl Client

pub fn delete_share(&self) -> DeleteShareFluentBuilder

Constructs a fluent builder for the DeleteShare operation.

• The fluent builder is configurable:
  • share_id(impl Into<String>) / set_share_id(Option<String>):
    required: true
    

    The ID for the resource share to be deleted.

    
    
• On success, responds with DeleteShareOutput with field(s):
  • status(Option<ShareStatus>):

    The status of the share being deleted.

• On failure, responds with SdkError<DeleteShareError>

impl Client

pub fn delete_variant_store(&self) -> DeleteVariantStoreFluentBuilder

Constructs a fluent builder for the DeleteVariantStore operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The store’s name.

    
    
  • force(bool) / set_force(Option<bool>):
    required: false
    

    Whether to force deletion.

    
    
• On success, responds with DeleteVariantStoreOutput with field(s):
  • status(StoreStatus):

    The store’s status.

• On failure, responds with SdkError<DeleteVariantStoreError>

impl Client

pub fn delete_workflow(&self) -> DeleteWorkflowFluentBuilder

Constructs a fluent builder for the DeleteWorkflow operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The workflow’s ID.

    
    
• On success, responds with DeleteWorkflowOutput
• On failure, responds with SdkError<DeleteWorkflowError>

impl Client

pub fn delete_workflow_version(&self) -> DeleteWorkflowVersionFluentBuilder

Constructs a fluent builder for the DeleteWorkflowVersion operation.

• The fluent builder is configurable:
  • workflow_id(impl Into<String>) / set_workflow_id(Option<String>):
    required: true
    

    The workflow’s ID.

    
    
  • version_name(impl Into<String>) / set_version_name(Option<String>):
    required: true
    

    The workflow version name.

    
    
• On success, responds with DeleteWorkflowVersionOutput
• On failure, responds with SdkError<DeleteWorkflowVersionError>

impl Client

pub fn get_annotation_import_job(&self) -> GetAnnotationImportJobFluentBuilder

Constructs a fluent builder for the GetAnnotationImportJob operation.

• The fluent builder is configurable:
  • job_id(impl Into<String>) / set_job_id(Option<String>):
    required: true
    

    The job’s ID.

    
    
• On success, responds with GetAnnotationImportJobOutput with field(s):
  • id(String):

    The job’s ID.

  • destination_name(String):

    The job’s destination annotation store.

  • version_name(String):

    The name of the annotation store version.

  • role_arn(String):

    The job’s service role ARN.

  • status(JobStatus):

    The job’s status.

  • status_message(String):

    The job’s status message.

  • creation_time(DateTime):

    When the job was created.

  • update_time(DateTime):

    When the job was updated.

  • completion_time(DateTime):

    When the job completed.

  • items(Vec::<AnnotationImportItemDetail>):

    The job’s imported items.

  • run_left_normalization(bool):

    The job’s left normalization setting.

  • format_options(Option<FormatOptions>):

    Formatting options for a file.

  • annotation_fields(Option<HashMap::<String, String>>):

    The annotation schema generated by the parsed annotation data.

• On failure, responds with SdkError<GetAnnotationImportJobError>

impl Client

pub fn get_annotation_store(&self) -> GetAnnotationStoreFluentBuilder

Constructs a fluent builder for the GetAnnotationStore operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The store’s name.

    
    
• On success, responds with GetAnnotationStoreOutput with field(s):
  • id(String):

    The store’s ID.

  • reference(Option<ReferenceItem>):

    The store’s genome reference.

  • status(StoreStatus):

    The store’s status.

  • store_arn(String):

    The store’s ARN.

  • name(String):

    The store’s name.

  • description(String):

    The store’s description.

  • sse_config(Option<SseConfig>):

    The store’s server-side encryption (SSE) settings.

  • creation_time(DateTime):

    When the store was created.

  • update_time(DateTime):

    When the store was updated.

  • tags(HashMap::<String, String>):

    The store’s tags.

  • store_options(Option<StoreOptions>):

    The store’s parsing options.

  • store_format(Option<StoreFormat>):

    The store’s annotation file format.

  • status_message(String):

    A status message.

  • store_size_bytes(i64):

    The store’s size in bytes.

  • num_versions(i32):

    An integer indicating how many versions of an annotation store exist.

• On failure, responds with SdkError<GetAnnotationStoreError>

impl Client

pub fn get_annotation_store_version( &self, ) -> GetAnnotationStoreVersionFluentBuilder

Constructs a fluent builder for the GetAnnotationStoreVersion operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name given to an annotation store version to distinguish it from others.

    
    
  • version_name(impl Into<String>) / set_version_name(Option<String>):
    required: true
    

    The name given to an annotation store version to distinguish it from others.

    
    
• On success, responds with GetAnnotationStoreVersionOutput with field(s):
  • store_id(String):

    The store ID for annotation store version.

  • id(String):

    The annotation store version ID.

  • status(VersionStatus):

    The status of an annotation store version.

  • version_arn(String):

    The Arn for the annotation store.

  • name(String):

    The name of the annotation store.

  • version_name(String):

    The name given to an annotation store version to distinguish it from others.

  • description(String):

    The description for an annotation store version.

  • creation_time(DateTime):

    The time stamp for when an annotation store version was created.

  • update_time(DateTime):

    The time stamp for when an annotation store version was updated.

  • tags(HashMap::<String, String>):

    Any tags associated with an annotation store version.

  • version_options(Option<VersionOptions>):

    The options for an annotation store version.

  • status_message(String):

    The status of an annotation store version.

  • version_size_bytes(i64):

    The size of the annotation store version in Bytes.

• On failure, responds with SdkError<GetAnnotationStoreVersionError>

impl Client

pub fn get_read_set(&self) -> GetReadSetFluentBuilder

Constructs a fluent builder for the GetReadSet operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The read set’s ID.

    
    
  • sequence_store_id(impl Into<String>) / set_sequence_store_id(Option<String>):
    required: true
    

    The read set’s sequence store ID.

    
    
  • file(ReadSetFile) / set_file(Option<ReadSetFile>):
    required: false
    

    The file to retrieve.

    
    
  • part_number(i32) / set_part_number(Option<i32>):
    required: true
    

    The part number to retrieve.

    
    
• On success, responds with GetReadSetOutput with field(s):
  • payload(ByteStream):

    The read set file payload.

• On failure, responds with SdkError<GetReadSetError>

impl Client

pub fn get_read_set_activation_job( &self, ) -> GetReadSetActivationJobFluentBuilder

Constructs a fluent builder for the GetReadSetActivationJob operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The job’s ID.

    
    
  • sequence_store_id(impl Into<String>) / set_sequence_store_id(Option<String>):
    required: true
    

    The job’s sequence store ID.

    
    
• On success, responds with GetReadSetActivationJobOutput with field(s):
  • id(String):

    The job’s ID.

  • sequence_store_id(String):

    The job’s sequence store ID.

  • status(ReadSetActivationJobStatus):

    The job’s status.

  • status_message(Option<String>):

    The job’s status message.

  • creation_time(DateTime):

    When the job was created.

  • completion_time(Option<DateTime>):

    When the job completed.

  • sources(Option<Vec::<ActivateReadSetSourceItem>>):

    The job’s source files.

• On failure, responds with SdkError<GetReadSetActivationJobError>

impl Client

pub fn get_read_set_export_job(&self) -> GetReadSetExportJobFluentBuilder

Constructs a fluent builder for the GetReadSetExportJob operation.

• The fluent builder is configurable:
  • sequence_store_id(impl Into<String>) / set_sequence_store_id(Option<String>):
    required: true
    

    The job’s sequence store ID.

    
    
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The job’s ID.

    
    
• On success, responds with GetReadSetExportJobOutput with field(s):
  • id(String):

    The job’s ID.

  • sequence_store_id(String):

    The job’s sequence store ID.

  • destination(String):

    The job’s destination in Amazon S3.

  • status(ReadSetExportJobStatus):

    The job’s status.

  • status_message(Option<String>):

    The job’s status message.

  • creation_time(DateTime):

    When the job was created.

  • completion_time(Option<DateTime>):

    When the job completed.

  • read_sets(Option<Vec::<ExportReadSetDetail>>):

    The job’s read sets.

• On failure, responds with SdkError<GetReadSetExportJobError>

impl Client

pub fn get_read_set_import_job(&self) -> GetReadSetImportJobFluentBuilder

Constructs a fluent builder for the GetReadSetImportJob operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The job’s ID.

    
    
  • sequence_store_id(impl Into<String>) / set_sequence_store_id(Option<String>):
    required: true
    

    The job’s sequence store ID.

    
    
• On success, responds with GetReadSetImportJobOutput with field(s):
  • id(String):

    The job’s ID.

  • sequence_store_id(String):

    The job’s sequence store ID.

  • role_arn(String):

    The job’s service role ARN.

  • status(ReadSetImportJobStatus):

    The job’s status.

  • status_message(Option<String>):

    The job’s status message.

  • creation_time(DateTime):

    When the job was created.

  • completion_time(Option<DateTime>):

    When the job completed.

  • sources(Vec::<ImportReadSetSourceItem>):

    The job’s source files.

• On failure, responds with SdkError<GetReadSetImportJobError>

impl Client

pub fn get_read_set_metadata(&self) -> GetReadSetMetadataFluentBuilder

Constructs a fluent builder for the GetReadSetMetadata operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The read set’s ID.

    
    
  • sequence_store_id(impl Into<String>) / set_sequence_store_id(Option<String>):
    required: true
    

    The read set’s sequence store ID.

    
    
• On success, responds with GetReadSetMetadataOutput with field(s):
  • id(String):

    The read set’s ID.

  • arn(String):

    The read set’s ARN.

  • sequence_store_id(String):

    The read set’s sequence store ID.

  • subject_id(Option<String>):

    The read set’s subject ID.

  • sample_id(Option<String>):

    The read set’s sample ID.

  • status(ReadSetStatus):

    The read set’s status.

  • name(Option<String>):

    The read set’s name.

  • description(Option<String>):

    The read set’s description.

  • file_type(FileType):

    The read set’s file type.

  • creation_time(DateTime):

    When the read set was created.

  • sequence_information(Option<SequenceInformation>):

    The read set’s sequence information.

  • reference_arn(Option<String>):

    The read set’s genome reference ARN.

  • files(Option<ReadSetFiles>):

    The read set’s files.

  • status_message(Option<String>):

    The status message for a read set. It provides more detail as to why the read set has a status.

  • creation_type(Option<CreationType>):

    The creation type of the read set.

  • etag(Option<ETag>):

    The entity tag (ETag) is a hash of the object meant to represent its semantic content.

  • creation_job_id(Option<String>):

    The read set’s creation job ID.

• On failure, responds with SdkError<GetReadSetMetadataError>

impl Client

pub fn get_reference(&self) -> GetReferenceFluentBuilder

Constructs a fluent builder for the GetReference operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The reference’s ID.

    
    
  • reference_store_id(impl Into<String>) / set_reference_store_id(Option<String>):
    required: true
    

    The reference’s store ID.

    
    
  • range(impl Into<String>) / set_range(Option<String>):
    required: false
    

    The range to retrieve.

    
    
  • part_number(i32) / set_part_number(Option<i32>):
    required: true
    

    The part number to retrieve.

    
    
  • file(ReferenceFile) / set_file(Option<ReferenceFile>):
    required: false
    

    The file to retrieve.

    
    
• On success, responds with GetReferenceOutput with field(s):
  • payload(ByteStream):

    The reference file payload.

• On failure, responds with SdkError<GetReferenceError>

impl Client

pub fn get_reference_import_job(&self) -> GetReferenceImportJobFluentBuilder

Constructs a fluent builder for the GetReferenceImportJob operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The job’s ID.

    
    
  • reference_store_id(impl Into<String>) / set_reference_store_id(Option<String>):
    required: true
    

    The job’s reference store ID.

    
    
• On success, responds with GetReferenceImportJobOutput with field(s):
  • id(String):

    The job’s ID.

  • reference_store_id(String):

    The job’s reference store ID.

  • role_arn(String):

    The job’s service role ARN.

  • status(ReferenceImportJobStatus):

    The job’s status.

  • status_message(Option<String>):

    The job’s status message.

  • creation_time(DateTime):

    When the job was created.

  • completion_time(Option<DateTime>):

    When the job completed.

  • sources(Vec::<ImportReferenceSourceItem>):

    The job’s source files.

• On failure, responds with SdkError<GetReferenceImportJobError>

impl Client

pub fn get_reference_metadata(&self) -> GetReferenceMetadataFluentBuilder

Constructs a fluent builder for the GetReferenceMetadata operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The reference’s ID.

    
    
  • reference_store_id(impl Into<String>) / set_reference_store_id(Option<String>):
    required: true
    

    The reference’s reference store ID.

    
    
• On success, responds with GetReferenceMetadataOutput with field(s):
  • id(String):

    The reference’s ID.

  • arn(String):

    The reference’s ARN.

  • reference_store_id(String):

    The reference’s reference store ID.

  • md5(String):

    The reference’s MD5 checksum.

  • status(Option<ReferenceStatus>):

    The reference’s status.

  • name(Option<String>):

    The reference’s name.

  • description(Option<String>):

    The reference’s description.

  • creation_time(DateTime):

    When the reference was created.

  • update_time(DateTime):

    When the reference was updated.

  • files(Option<ReferenceFiles>):

    The reference’s files.

  • creation_type(Option<ReferenceCreationType>):

    The reference’s creation type.

  • creation_job_id(Option<String>):

    The reference’s creation job ID.

• On failure, responds with SdkError<GetReferenceMetadataError>

impl Client

pub fn get_reference_store(&self) -> GetReferenceStoreFluentBuilder

Constructs a fluent builder for the GetReferenceStore operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The store’s ID.

    
    
• On success, responds with GetReferenceStoreOutput with field(s):
  • id(String):

    The store’s ID.

  • arn(String):

    The store’s ARN.

  • name(Option<String>):

    The store’s name.

  • description(Option<String>):

    The store’s description.

  • sse_config(Option<SseConfig>):

    The store’s server-side encryption (SSE) settings.

  • creation_time(DateTime):

    When the store was created.

• On failure, responds with SdkError<GetReferenceStoreError>

impl Client

pub fn get_run(&self) -> GetRunFluentBuilder

Constructs a fluent builder for the GetRun operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The run’s ID.

    
    
  • export(RunExport) / set_export(Option<Vec::<RunExport>>):
    required: false
    

    The run’s export format.

    
    
• On success, responds with GetRunOutput with field(s):
  • arn(Option<String>):

    The run’s ARN.

  • id(Option<String>):

    The run’s ID.

  • cache_id(Option<String>):

    The run cache associated with the run.

  • cache_behavior(Option<CacheBehavior>):

    The run cache behavior for the run.

  • engine_version(Option<String>):

    The actual Nextflow engine version that Amazon Web Services HealthOmics used for the run. The other workflow definition languages don’t provide a value for this field.

  • status(Option<RunStatus>):

    The run’s status.

  • workflow_id(Option<String>):

    The run’s workflow ID.

  • workflow_type(Option<WorkflowType>):

    The run’s workflow type.

  • run_id(Option<String>):

    The run’s ID.

  • role_arn(Option<String>):

    The run’s service role ARN.

  • name(Option<String>):

    The run’s name.

  • run_group_id(Option<String>):

    The run’s group ID.

  • priority(Option<i32>):

    The run’s priority.

  • definition(Option<String>):

    The run’s definition.

  • digest(Option<String>):

    The run’s digest.

  • parameters(Option<Document>):

    The run’s parameters.

  • storage_capacity(Option<i32>):

    The run’s storage capacity in gibibytes. For dynamic storage, after the run has completed, this value is the maximum amount of storage used during the run.

  • output_uri(Option<String>):

    The run’s output URI.

  • log_level(Option<RunLogLevel>):

    The run’s log level.

  • resource_digests(Option<HashMap::<String, String>>):

    The run’s resource digests.

  • started_by(Option<String>):

    Who started the run.

  • creation_time(Option<DateTime>):

    When the run was created.

  • start_time(Option<DateTime>):

    When the run started.

  • stop_time(Option<DateTime>):

    The run’s stop time.

  • status_message(Option<String>):

    The run’s status message.

  • tags(Option<HashMap::<String, String>>):

    The run’s tags.

  • accelerators(Option<Accelerators>):

    The computational accelerator used to run the workflow.

  • retention_mode(Option<RunRetentionMode>):

    The run’s retention mode.

  • failure_reason(Option<String>):

    The reason a run has failed.

  • log_location(Option<RunLogLocation>):

    The location of the run log.

  • uuid(Option<String>):

    The universally unique identifier for a run.

  • run_output_uri(Option<String>):

    The destination for workflow outputs.

  • storage_type(Option<StorageType>):

    The run’s storage type.

  • workflow_owner_id(Option<String>):

    The ID of the workflow owner.

  • workflow_version_name(Option<String>):

    The workflow version name.

  • workflow_uuid(Option<String>):

    The universally unique identifier (UUID) value for the workflow.

• On failure, responds with SdkError<GetRunError>

impl Client

pub fn get_run_cache(&self) -> GetRunCacheFluentBuilder

Constructs a fluent builder for the GetRunCache operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The identifier of the run cache to retrieve.

    
    
• On success, responds with GetRunCacheOutput with field(s):
  • arn(Option<String>):

    Unique resource identifier for the run cache.

  • cache_behavior(Option<CacheBehavior>):

    The default cache behavior for runs using this cache.

  • cache_bucket_owner_id(Option<String>):

    The identifier of the bucket owner.

  • cache_s3_uri(Option<String>):

    The S3 URI where the cache data is stored.

  • creation_time(Option<DateTime>):

    Creation time of the run cache (an ISO 8601 formatted string).

  • description(Option<String>):

    The run cache description.

  • id(Option<String>):

    The run cache ID.

  • name(Option<String>):

    The run cache name.

  • status(Option<RunCacheStatus>):

    The run cache status.

  • tags(Option<HashMap::<String, String>>):

    The tags associated with the run cache.

• On failure, responds with SdkError<GetRunCacheError>

impl Client

pub fn get_run_group(&self) -> GetRunGroupFluentBuilder

Constructs a fluent builder for the GetRunGroup operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The group’s ID.

    
    
• On success, responds with GetRunGroupOutput with field(s):
  • arn(Option<String>):

    The group’s ARN.

  • id(Option<String>):

    The group’s ID.

  • name(Option<String>):

    The group’s name.

  • max_cpus(Option<i32>):

    The group’s maximum number of CPUs to use.

  • max_runs(Option<i32>):

    The maximum number of concurrent runs for the group.

  • max_duration(Option<i32>):

    The group’s maximum run time in minutes.

  • creation_time(Option<DateTime>):

    When the group was created.

  • tags(Option<HashMap::<String, String>>):

    The group’s tags.

  • max_gpus(Option<i32>):

    The maximum GPUs that can be used by a run group.

• On failure, responds with SdkError<GetRunGroupError>

impl Client

pub fn get_run_task(&self) -> GetRunTaskFluentBuilder

Constructs a fluent builder for the GetRunTask operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The workflow run ID.

    
    
  • task_id(impl Into<String>) / set_task_id(Option<String>):
    required: true
    

    The task’s ID.

    
    
• On success, responds with GetRunTaskOutput with field(s):
  • task_id(Option<String>):

    The task’s ID.

  • status(Option<TaskStatus>):

    The task’s status.

  • name(Option<String>):

    The task’s name.

  • cpus(Option<i32>):

    The task’s CPU usage.

  • cache_hit(Option<bool>):

    Set to true if Amazon Web Services HealthOmics found a matching entry in the run cache for this task.

  • cache_s3_uri(Option<String>):

    The S3 URI of the cache location.

  • memory(Option<i32>):

    The task’s memory use in gigabytes.

  • creation_time(Option<DateTime>):

    When the task was created.

  • start_time(Option<DateTime>):

    The task’s start time.

  • stop_time(Option<DateTime>):

    The task’s stop time.

  • status_message(Option<String>):

    The task’s status message.

  • log_stream(Option<String>):

    The task’s log stream.

  • gpus(Option<i32>):

    The number of Graphics Processing Units (GPU) specified in the task.

  • instance_type(Option<String>):

    The instance type for a task.

  • failure_reason(Option<String>):

    The reason a task has failed.

• On failure, responds with SdkError<GetRunTaskError>

impl Client

pub fn get_s3_access_policy(&self) -> GetS3AccessPolicyFluentBuilder

Constructs a fluent builder for the GetS3AccessPolicy operation.

• The fluent builder is configurable:
  • s3_access_point_arn(impl Into<String>) / set_s3_access_point_arn(Option<String>):
    required: true
    

    The S3 access point ARN that has the access policy.

    
    
• On success, responds with GetS3AccessPolicyOutput with field(s):
  • s3_access_point_arn(Option<String>):

    The S3 access point ARN that has the access policy.

  • store_id(Option<String>):

    The Amazon Web Services-generated Sequence Store or Reference Store ID.

  • store_type(Option<StoreType>):

    The type of store associated with the access point.

  • update_time(Option<DateTime>):

    The time when the policy was last updated.

  • s3_access_policy(String):

    The current resource policy that controls S3 access on the store.

• On failure, responds with SdkError<GetS3AccessPolicyError>

impl Client

pub fn get_sequence_store(&self) -> GetSequenceStoreFluentBuilder

Constructs a fluent builder for the GetSequenceStore operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The store’s ID.

    
    
• On success, responds with GetSequenceStoreOutput with field(s):
  • id(String):

    The store’s ID.

  • arn(String):

    The store’s ARN.

  • name(Option<String>):

    The store’s name.

  • description(Option<String>):

    The store’s description.

  • sse_config(Option<SseConfig>):

    The store’s server-side encryption (SSE) settings.

  • creation_time(DateTime):

    When the store was created.

  • fallback_location(Option<String>):

    An S3 location that is used to store files that have failed a direct upload.

  • s3_access(Option<SequenceStoreS3Access>):

    The S3 metadata of a sequence store, including the ARN and S3 URI of the S3 bucket.

  • e_tag_algorithm_family(Option<ETagAlgorithmFamily>):

    The algorithm family of the ETag.

  • status(Option<SequenceStoreStatus>):

    The status of the sequence store.

  • status_message(Option<String>):

    The status message of the sequence store.

  • propagated_set_level_tags(Option<Vec::<String>>):

    The tags keys to propagate to the S3 objects associated with read sets in the sequence store.

  • update_time(Option<DateTime>):

    The last-updated time of the sequence store.

• On failure, responds with SdkError<GetSequenceStoreError>

impl Client

pub fn get_share(&self) -> GetShareFluentBuilder

Constructs a fluent builder for the GetShare operation.

• The fluent builder is configurable:
  • share_id(impl Into<String>) / set_share_id(Option<String>):
    required: true
    

    The ID of the share.

    
    
• On success, responds with GetShareOutput with field(s):
  • share(Option<ShareDetails>):

    A resource share details object. The object includes the status, the resourceArn, and ownerId.

• On failure, responds with SdkError<GetShareError>

impl Client

pub fn get_variant_import_job(&self) -> GetVariantImportJobFluentBuilder

Constructs a fluent builder for the GetVariantImportJob operation.

• The fluent builder is configurable:
  • job_id(impl Into<String>) / set_job_id(Option<String>):
    required: true
    

    The job’s ID.

    
    
• On success, responds with GetVariantImportJobOutput with field(s):
  • id(String):

    The job’s ID.

  • destination_name(String):

    The job’s destination variant store.

  • role_arn(String):

    The job’s service role ARN.

  • status(JobStatus):

    The job’s status.

  • status_message(String):

    The job’s status message.

  • creation_time(DateTime):

    When the job was created.

  • update_time(DateTime):

    When the job was updated.

  • completion_time(Option<DateTime>):

    When the job completed.

  • items(Vec::<VariantImportItemDetail>):

    The job’s items.

  • run_left_normalization(bool):

    The job’s left normalization setting.

  • annotation_fields(Option<HashMap::<String, String>>):

    The annotation schema generated by the parsed annotation data.

• On failure, responds with SdkError<GetVariantImportJobError>

impl Client

pub fn get_variant_store(&self) -> GetVariantStoreFluentBuilder

Constructs a fluent builder for the GetVariantStore operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The store’s name.

    
    
• On success, responds with GetVariantStoreOutput with field(s):
  • id(String):

    The store’s ID.

  • reference(Option<ReferenceItem>):

    The store’s genome reference.

  • status(StoreStatus):

    The store’s status.

  • store_arn(String):

    The store’s ARN.

  • name(String):

    The store’s name.

  • description(String):

    The store’s description.

  • sse_config(Option<SseConfig>):

    The store’s server-side encryption (SSE) settings.

  • creation_time(DateTime):

    When the store was created.

  • update_time(DateTime):

    When the store was updated.

  • tags(HashMap::<String, String>):

    The store’s tags.

  • status_message(String):

    The store’s status message.

  • store_size_bytes(i64):

    The store’s size in bytes.

• On failure, responds with SdkError<GetVariantStoreError>

impl Client

pub fn get_workflow(&self) -> GetWorkflowFluentBuilder

Constructs a fluent builder for the GetWorkflow operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The workflow’s ID.

    
    
  • r#type(WorkflowType) / set_type(Option<WorkflowType>):
    required: false
    

    The workflow’s type.

    
    
  • export(WorkflowExport) / set_export(Option<Vec::<WorkflowExport>>):
    required: false
    

    The export format for the workflow.

    
    
  • workflow_owner_id(impl Into<String>) / set_workflow_owner_id(Option<String>):
    required: false
    

    The ID of the workflow owner.

    
    
• On success, responds with GetWorkflowOutput with field(s):
  • arn(Option<String>):

    The workflow’s ARN.

  • id(Option<String>):

    The workflow’s ID.

  • status(Option<WorkflowStatus>):

    The workflow’s status.

  • r#type(Option<WorkflowType>):

    The workflow’s type.

  • name(Option<String>):

    The workflow’s name.

  • description(Option<String>):

    The workflow’s description.

  • engine(Option<WorkflowEngine>):

    The workflow’s engine.

  • definition(Option<String>):

    The workflow’s definition.

  • main(Option<String>):

    The path of the main definition file for the workflow.

  • digest(Option<String>):

    The workflow’s digest.

  • parameter_template(Option<HashMap::<String, WorkflowParameter>>):

    The workflow’s parameter template.

  • storage_capacity(Option<i32>):

    The default static storage capacity (in gibibytes) for runs that use this workflow or workflow version.

  • creation_time(Option<DateTime>):

    When the workflow was created.

  • status_message(Option<String>):

    The workflow’s status message.

  • tags(Option<HashMap::<String, String>>):

    The workflow’s tags.

  • metadata(Option<HashMap::<String, String>>):

    Gets metadata for the workflow.

  • accelerators(Option<Accelerators>):

    The computational accelerator specified to run the workflow.

  • storage_type(Option<StorageType>):

    The default storage type for runs using this workflow.

  • uuid(Option<String>):

    The universally unique identifier (UUID) value for this workflow.

• On failure, responds with SdkError<GetWorkflowError>

impl Client

pub fn get_workflow_version(&self) -> GetWorkflowVersionFluentBuilder

Constructs a fluent builder for the GetWorkflowVersion operation.

• The fluent builder is configurable:
  • workflow_id(impl Into<String>) / set_workflow_id(Option<String>):
    required: true
    

    The workflow’s ID.

    
    
  • version_name(impl Into<String>) / set_version_name(Option<String>):
    required: true
    

    The workflow version name.

    
    
  • r#type(WorkflowType) / set_type(Option<WorkflowType>):
    required: false
    

    The workflow’s type.

    
    
  • export(WorkflowExport) / set_export(Option<Vec::<WorkflowExport>>):
    required: false
    

    The export format for the workflow.

    
    
  • workflow_owner_id(impl Into<String>) / set_workflow_owner_id(Option<String>):
    required: false
    

    Amazon Web Services Id of the owner of the workflow.

    
    
• On success, responds with GetWorkflowVersionOutput with field(s):
  • arn(Option<String>):

    ARN of the workflow version.

  • workflow_id(Option<String>):

    The workflow’s ID.

  • version_name(Option<String>):

    The workflow version name.

  • accelerators(Option<Accelerators>):

    The accelerator for this workflow version.

  • creation_time(Option<DateTime>):

    When the workflow version was created.

  • description(Option<String>):

    Description of the workflow version.

  • definition(Option<String>):

    Definition of the workflow version.

  • digest(Option<String>):

    The workflow version’s digest.

  • engine(Option<WorkflowEngine>):

    The workflow engine for this workflow version.

  • main(Option<String>):

    The path of the main definition file for the workflow.

  • metadata(Option<HashMap::<String, String>>):

    The metadata for the workflow version.

  • parameter_template(Option<HashMap::<String, WorkflowParameter>>):

    The parameter template for the workflow version.

  • status(Option<WorkflowStatus>):

    The workflow version status

  • status_message(Option<String>):

    The workflow version status message

  • storage_type(Option<StorageType>):

    The default storage type for the run.

  • storage_capacity(Option<i32>):

    The default run storage capacity for static storage.

  • r#type(Option<WorkflowType>):

    The workflow version type

  • tags(Option<HashMap::<String, String>>):

    The workflow version tags

  • uuid(Option<String>):

    The universally unique identifier (UUID) value for this workflow version

  • workflow_bucket_owner_id(Option<String>):

    Amazon Web Services Id of the owner of the bucket.

• On failure, responds with SdkError<GetWorkflowVersionError>

impl Client

pub fn list_annotation_import_jobs( &self, ) -> ListAnnotationImportJobsFluentBuilder

Constructs a fluent builder for the ListAnnotationImportJobs operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of jobs to return in one page of results.

    
    
  • ids(impl Into<String>) / set_ids(Option<Vec::<String>>):
    required: false
    

    IDs of annotation import jobs to retrieve.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    Specifies the pagination token from a previous request to retrieve the next page of results.

    
    
  • filter(ListAnnotationImportJobsFilter) / set_filter(Option<ListAnnotationImportJobsFilter>):
    required: false
    

    A filter to apply to the list.

    
    
• On success, responds with ListAnnotationImportJobsOutput with field(s):
  • annotation_import_jobs(Option<Vec::<AnnotationImportJobItem>>):

    A list of jobs.

  • next_token(Option<String>):

    Specifies the pagination token from a previous request to retrieve the next page of results.

• On failure, responds with SdkError<ListAnnotationImportJobsError>

impl Client

pub fn list_annotation_store_versions( &self, ) -> ListAnnotationStoreVersionsFluentBuilder

Constructs a fluent builder for the ListAnnotationStoreVersions operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of an annotation store.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of annotation store versions to return in one page of results.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    Specifies the pagination token from a previous request to retrieve the next page of results.

    
    
  • filter(ListAnnotationStoreVersionsFilter) / set_filter(Option<ListAnnotationStoreVersionsFilter>):
    required: false
    

    A filter to apply to the list of annotation store versions.

    
    
• On success, responds with ListAnnotationStoreVersionsOutput with field(s):
  • annotation_store_versions(Option<Vec::<AnnotationStoreVersionItem>>):

    Lists all versions of an annotation store.

  • next_token(Option<String>):

    Specifies the pagination token from a previous request to retrieve the next page of results.

• On failure, responds with SdkError<ListAnnotationStoreVersionsError>

impl Client

pub fn list_annotation_stores(&self) -> ListAnnotationStoresFluentBuilder

Constructs a fluent builder for the ListAnnotationStores operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • ids(impl Into<String>) / set_ids(Option<Vec::<String>>):
    required: false
    

    IDs of stores to list.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of stores to return in one page of results.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    Specify the pagination token from a previous request to retrieve the next page of results.

    
    
  • filter(ListAnnotationStoresFilter) / set_filter(Option<ListAnnotationStoresFilter>):
    required: false
    

    A filter to apply to the list.

    
    
• On success, responds with ListAnnotationStoresOutput with field(s):
  • annotation_stores(Option<Vec::<AnnotationStoreItem>>):

    A list of stores.

  • next_token(Option<String>):

    A pagination token that’s included if more results are available.

• On failure, responds with SdkError<ListAnnotationStoresError>

impl Client

pub fn list_multipart_read_set_uploads( &self, ) -> ListMultipartReadSetUploadsFluentBuilder

Constructs a fluent builder for the ListMultipartReadSetUploads operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • sequence_store_id(impl Into<String>) / set_sequence_store_id(Option<String>):
    required: true
    

    The Sequence Store ID used for the multipart uploads.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of multipart uploads returned in a page.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    Next token returned in the response of a previous ListMultipartReadSetUploads call. Used to get the next page of results.

    
    
• On success, responds with ListMultipartReadSetUploadsOutput with field(s):
  • next_token(Option<String>):

    Next token returned in the response of a previous ListMultipartReadSetUploads call. Used to get the next page of results.

  • uploads(Option<Vec::<MultipartReadSetUploadListItem>>):

    An array of multipart uploads.

• On failure, responds with SdkError<ListMultipartReadSetUploadsError>

impl Client

pub fn list_read_set_activation_jobs( &self, ) -> ListReadSetActivationJobsFluentBuilder

Constructs a fluent builder for the ListReadSetActivationJobs operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • sequence_store_id(impl Into<String>) / set_sequence_store_id(Option<String>):
    required: true
    

    The read set’s sequence store ID.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of read set activation jobs to return in one page of results.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    Specify the pagination token from a previous request to retrieve the next page of results.

    
    
  • filter(ActivateReadSetFilter) / set_filter(Option<ActivateReadSetFilter>):
    required: false
    

    A filter to apply to the list.

    
    
• On success, responds with ListReadSetActivationJobsOutput with field(s):
  • next_token(Option<String>):

    A pagination token that’s included if more results are available.

  • activation_jobs(Option<Vec::<ActivateReadSetJobItem>>):

    A list of jobs.

• On failure, responds with SdkError<ListReadSetActivationJobsError>

impl Client

pub fn list_read_set_export_jobs(&self) -> ListReadSetExportJobsFluentBuilder

Constructs a fluent builder for the ListReadSetExportJobs operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • sequence_store_id(impl Into<String>) / set_sequence_store_id(Option<String>):
    required: true
    

    The jobs’ sequence store ID.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of jobs to return in one page of results.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    Specify the pagination token from a previous request to retrieve the next page of results.

    
    
  • filter(ExportReadSetFilter) / set_filter(Option<ExportReadSetFilter>):
    required: false
    

    A filter to apply to the list.

    
    
• On success, responds with ListReadSetExportJobsOutput with field(s):
  • next_token(Option<String>):

    A pagination token that’s included if more results are available.

  • export_jobs(Option<Vec::<ExportReadSetJobDetail>>):

    A list of jobs.

• On failure, responds with SdkError<ListReadSetExportJobsError>

impl Client

pub fn list_read_set_import_jobs(&self) -> ListReadSetImportJobsFluentBuilder

Constructs a fluent builder for the ListReadSetImportJobs operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of jobs to return in one page of results.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    Specify the pagination token from a previous request to retrieve the next page of results.

    
    
  • sequence_store_id(impl Into<String>) / set_sequence_store_id(Option<String>):
    required: true
    

    The jobs’ sequence store ID.

    
    
  • filter(ImportReadSetFilter) / set_filter(Option<ImportReadSetFilter>):
    required: false
    

    A filter to apply to the list.

    
    
• On success, responds with ListReadSetImportJobsOutput with field(s):
  • next_token(Option<String>):

    A pagination token that’s included if more results are available.

  • import_jobs(Option<Vec::<ImportReadSetJobItem>>):

    A list of jobs.

• On failure, responds with SdkError<ListReadSetImportJobsError>

impl Client

pub fn list_read_set_upload_parts(&self) -> ListReadSetUploadPartsFluentBuilder

Constructs a fluent builder for the ListReadSetUploadParts operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • sequence_store_id(impl Into<String>) / set_sequence_store_id(Option<String>):
    required: true
    

    The Sequence Store ID used for the multipart uploads.

    
    
  • upload_id(impl Into<String>) / set_upload_id(Option<String>):
    required: true
    

    The ID for the initiated multipart upload.

    
    
  • part_source(ReadSetPartSource) / set_part_source(Option<ReadSetPartSource>):
    required: true
    

    The source file for the upload part.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of read set upload parts returned in a page.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    Next token returned in the response of a previous ListReadSetUploadPartsRequest call. Used to get the next page of results.

    
    
  • filter(ReadSetUploadPartListFilter) / set_filter(Option<ReadSetUploadPartListFilter>):
    required: false
    

    Attributes used to filter for a specific subset of read set part uploads.

    
    
• On success, responds with ListReadSetUploadPartsOutput with field(s):
  • next_token(Option<String>):

    Next token returned in the response of a previous ListReadSetUploadParts call. Used to get the next page of results.

  • parts(Option<Vec::<ReadSetUploadPartListItem>>):

    An array of upload parts.

• On failure, responds with SdkError<ListReadSetUploadPartsError>

impl Client

pub fn list_read_sets(&self) -> ListReadSetsFluentBuilder

Constructs a fluent builder for the ListReadSets operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • sequence_store_id(impl Into<String>) / set_sequence_store_id(Option<String>):
    required: true
    

    The jobs’ sequence store ID.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of read sets to return in one page of results.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    Specify the pagination token from a previous request to retrieve the next page of results.

    
    
  • filter(ReadSetFilter) / set_filter(Option<ReadSetFilter>):
    required: false
    

    A filter to apply to the list.

    
    
• On success, responds with ListReadSetsOutput with field(s):
  • next_token(Option<String>):

    A pagination token that’s included if more results are available.

  • read_sets(Vec::<ReadSetListItem>):

    A list of read sets.

• On failure, responds with SdkError<ListReadSetsError>

impl Client

pub fn list_reference_import_jobs(&self) -> ListReferenceImportJobsFluentBuilder

Constructs a fluent builder for the ListReferenceImportJobs operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of jobs to return in one page of results.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    Specify the pagination token from a previous request to retrieve the next page of results.

    
    
  • reference_store_id(impl Into<String>) / set_reference_store_id(Option<String>):
    required: true
    

    The job’s reference store ID.

    
    
  • filter(ImportReferenceFilter) / set_filter(Option<ImportReferenceFilter>):
    required: false
    

    A filter to apply to the list.

    
    
• On success, responds with ListReferenceImportJobsOutput with field(s):
  • next_token(Option<String>):

    A pagination token that’s included if more results are available.

  • import_jobs(Option<Vec::<ImportReferenceJobItem>>):

    A lis of jobs.

• On failure, responds with SdkError<ListReferenceImportJobsError>

impl Client

pub fn list_reference_stores(&self) -> ListReferenceStoresFluentBuilder

Constructs a fluent builder for the ListReferenceStores operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of stores to return in one page of results.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    Specify the pagination token from a previous request to retrieve the next page of results.

    
    
  • filter(ReferenceStoreFilter) / set_filter(Option<ReferenceStoreFilter>):
    required: false
    

    A filter to apply to the list.

    
    
• On success, responds with ListReferenceStoresOutput with field(s):
  • next_token(Option<String>):

    A pagination token that’s included if more results are available.

  • reference_stores(Vec::<ReferenceStoreDetail>):

    A list of reference stores.

• On failure, responds with SdkError<ListReferenceStoresError>

impl Client

pub fn list_references(&self) -> ListReferencesFluentBuilder

Constructs a fluent builder for the ListReferences operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • reference_store_id(impl Into<String>) / set_reference_store_id(Option<String>):
    required: true
    

    The references’ reference store ID.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of references to return in one page of results.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    Specify the pagination token from a previous request to retrieve the next page of results.

    
    
  • filter(ReferenceFilter) / set_filter(Option<ReferenceFilter>):
    required: false
    

    A filter to apply to the list.

    
    
• On success, responds with ListReferencesOutput with field(s):
  • next_token(Option<String>):

    A pagination token that’s included if more results are available.

  • references(Vec::<ReferenceListItem>):

    A list of references.

• On failure, responds with SdkError<ListReferencesError>

impl Client

pub fn list_run_caches(&self) -> ListRunCachesFluentBuilder

Constructs a fluent builder for the ListRunCaches operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return.

    
    
  • starting_token(impl Into<String>) / set_starting_token(Option<String>):
    required: false
    

    Optional pagination token returned from a prior call to the ListRunCaches API operation.

    
    
• On success, responds with ListRunCachesOutput with field(s):
  • items(Option<Vec::<RunCacheListItem>>):

    Details about each run cache in the response.

  • next_token(Option<String>):

    Pagination token to retrieve additional run caches. If the response does not have a nextTokenvalue, you have reached to the end of the list.

• On failure, responds with SdkError<ListRunCachesError>

impl Client

pub fn list_run_groups(&self) -> ListRunGroupsFluentBuilder

Constructs a fluent builder for the ListRunGroups operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    The run groups’ name.

    
    
  • starting_token(impl Into<String>) / set_starting_token(Option<String>):
    required: false
    

    Specify the pagination token from a previous request to retrieve the next page of results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of run groups to return in one page of results.

    
    
• On success, responds with ListRunGroupsOutput with field(s):
  • items(Option<Vec::<RunGroupListItem>>):

    A list of groups.

  • next_token(Option<String>):

    A pagination token that’s included if more results are available.

• On failure, responds with SdkError<ListRunGroupsError>

impl Client

pub fn list_run_tasks(&self) -> ListRunTasksFluentBuilder

Constructs a fluent builder for the ListRunTasks operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The run’s ID.

    
    
  • status(TaskStatus) / set_status(Option<TaskStatus>):
    required: false
    

    Filter the list by status.

    
    
  • starting_token(impl Into<String>) / set_starting_token(Option<String>):
    required: false
    

    Specify the pagination token from a previous request to retrieve the next page of results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of run tasks to return in one page of results.

    
    
• On success, responds with ListRunTasksOutput with field(s):
  • items(Option<Vec::<TaskListItem>>):

    A list of tasks.

  • next_token(Option<String>):

    A pagination token that’s included if more results are available.

• On failure, responds with SdkError<ListRunTasksError>

impl Client

pub fn list_runs(&self) -> ListRunsFluentBuilder

Constructs a fluent builder for the ListRuns operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    Filter the list by run name.

    
    
  • run_group_id(impl Into<String>) / set_run_group_id(Option<String>):
    required: false
    

    Filter the list by run group ID.

    
    
  • starting_token(impl Into<String>) / set_starting_token(Option<String>):
    required: false
    

    Specify the pagination token from a previous request to retrieve the next page of results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of runs to return in one page of results.

    
    
  • status(RunStatus) / set_status(Option<RunStatus>):
    required: false
    

    The status of a run.

    
    
• On success, responds with ListRunsOutput with field(s):
  • items(Option<Vec::<RunListItem>>):

    A list of runs.

  • next_token(Option<String>):

    A pagination token that’s included if more results are available.

• On failure, responds with SdkError<ListRunsError>

impl Client

pub fn list_sequence_stores(&self) -> ListSequenceStoresFluentBuilder

Constructs a fluent builder for the ListSequenceStores operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of stores to return in one page of results.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    Specify the pagination token from a previous request to retrieve the next page of results.

    
    
  • filter(SequenceStoreFilter) / set_filter(Option<SequenceStoreFilter>):
    required: false
    

    A filter to apply to the list.

    
    
• On success, responds with ListSequenceStoresOutput with field(s):
  • next_token(Option<String>):

    A pagination token that’s included if more results are available.

  • sequence_stores(Vec::<SequenceStoreDetail>):

    A list of sequence stores.

• On failure, responds with SdkError<ListSequenceStoresError>

impl Client

pub fn list_shares(&self) -> ListSharesFluentBuilder

Constructs a fluent builder for the ListShares operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • resource_owner(ResourceOwner) / set_resource_owner(Option<ResourceOwner>):
    required: true
    

    The account that owns the resource shares.

    
    
  • filter(Filter) / set_filter(Option<Filter>):
    required: false
    

    Attributes that you use to filter for a specific subset of resource shares.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    Next token returned in the response of a previous ListReadSetUploadPartsRequest call. Used to get the next page of results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of shares to return in one page of results.

    
    
• On success, responds with ListSharesOutput with field(s):
  • shares(Vec::<ShareDetails>):

    The shares available and their metadata details.

  • next_token(Option<String>):

    Next token returned in the response of a previous ListSharesResponse call. Used to get the next page of results.

• On failure, responds with SdkError<ListSharesError>

impl Client

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The resource’s ARN.

    
    
• On success, responds with ListTagsForResourceOutput with field(s):
  • tags(HashMap::<String, String>):

    A list of tags.

• On failure, responds with SdkError<ListTagsForResourceError>

impl Client

pub fn list_variant_import_jobs(&self) -> ListVariantImportJobsFluentBuilder

Constructs a fluent builder for the ListVariantImportJobs operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of import jobs to return in one page of results.

    
    
  • ids(impl Into<String>) / set_ids(Option<Vec::<String>>):
    required: false
    

    A list of job IDs.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    Specify the pagination token from a previous request to retrieve the next page of results.

    
    
  • filter(ListVariantImportJobsFilter) / set_filter(Option<ListVariantImportJobsFilter>):
    required: false
    

    A filter to apply to the list.

    
    
• On success, responds with ListVariantImportJobsOutput with field(s):
  • variant_import_jobs(Option<Vec::<VariantImportJobItem>>):

    A list of jobs.

  • next_token(Option<String>):

    A pagination token that’s included if more results are available.

• On failure, responds with SdkError<ListVariantImportJobsError>

impl Client

pub fn list_variant_stores(&self) -> ListVariantStoresFluentBuilder

Constructs a fluent builder for the ListVariantStores operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of stores to return in one page of results.

    
    
  • ids(impl Into<String>) / set_ids(Option<Vec::<String>>):
    required: false
    

    A list of store IDs.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    Specify the pagination token from a previous request to retrieve the next page of results.

    
    
  • filter(ListVariantStoresFilter) / set_filter(Option<ListVariantStoresFilter>):
    required: false
    

    A filter to apply to the list.

    
    
• On success, responds with ListVariantStoresOutput with field(s):
  • variant_stores(Option<Vec::<VariantStoreItem>>):

    A list of variant stores.

  • next_token(Option<String>):

    A pagination token that’s included if more results are available.

• On failure, responds with SdkError<ListVariantStoresError>

impl Client

pub fn list_workflow_versions(&self) -> ListWorkflowVersionsFluentBuilder

Constructs a fluent builder for the ListWorkflowVersions operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • workflow_id(impl Into<String>) / set_workflow_id(Option<String>):
    required: true
    

    The workflow’s ID.

    
    
  • r#type(WorkflowType) / set_type(Option<WorkflowType>):
    required: false
    

    The workflow type.

    
    
  • workflow_owner_id(impl Into<String>) / set_workflow_owner_id(Option<String>):
    required: false
    

    Amazon Web Services Id of the owner of the workflow.

    
    
  • starting_token(impl Into<String>) / set_starting_token(Option<String>):
    required: false
    

    Specify the pagination token from a previous request to retrieve the next page of results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of workflows to return in one page of results.

    
    
• On success, responds with ListWorkflowVersionsOutput with field(s):
  • items(Option<Vec::<WorkflowVersionListItem>>):

    A list of workflow version items.

  • next_token(Option<String>):

    A pagination token that’s included if more results are available.

• On failure, responds with SdkError<ListWorkflowVersionsError>

impl Client

pub fn list_workflows(&self) -> ListWorkflowsFluentBuilder

Constructs a fluent builder for the ListWorkflows operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • r#type(WorkflowType) / set_type(Option<WorkflowType>):
    required: false
    

    Filter the list by workflow type.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    Filter the list by workflow name.

    
    
  • starting_token(impl Into<String>) / set_starting_token(Option<String>):
    required: false
    

    Specify the pagination token from a previous request to retrieve the next page of results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of workflows to return in one page of results.

    
    
• On success, responds with ListWorkflowsOutput with field(s):
  • items(Option<Vec::<WorkflowListItem>>):

    A list of workflow items.

  • next_token(Option<String>):

    A pagination token that’s included if more results are available.

• On failure, responds with SdkError<ListWorkflowsError>

impl Client

pub fn put_s3_access_policy(&self) -> PutS3AccessPolicyFluentBuilder

Constructs a fluent builder for the PutS3AccessPolicy operation.

• The fluent builder is configurable:
  • s3_access_point_arn(impl Into<String>) / set_s3_access_point_arn(Option<String>):
    required: true
    

    The S3 access point ARN where you want to put the access policy.

    
    
  • s3_access_policy(impl Into<String>) / set_s3_access_policy(Option<String>):
    required: true
    

    The resource policy that controls S3 access to the store.

    
    
• On success, responds with PutS3AccessPolicyOutput with field(s):
  • s3_access_point_arn(Option<String>):

    The S3 access point ARN that now has the access policy.

  • store_id(Option<String>):

    The Amazon Web Services-generated Sequence Store or Reference Store ID.

  • store_type(Option<StoreType>):

    The type of store associated with the access point.

• On failure, responds with SdkError<PutS3AccessPolicyError>

impl Client

pub fn start_annotation_import_job( &self, ) -> StartAnnotationImportJobFluentBuilder

Constructs a fluent builder for the StartAnnotationImportJob operation.

• The fluent builder is configurable:
  • destination_name(impl Into<String>) / set_destination_name(Option<String>):
    required: true
    

    A destination annotation store for the job.

    
    
  • role_arn(impl Into<String>) / set_role_arn(Option<String>):
    required: true
    

    A service role for the job.

    
    
  • items(AnnotationImportItemSource) / set_items(Option<Vec::<AnnotationImportItemSource>>):
    required: true
    

    Items to import.

    
    
  • version_name(impl Into<String>) / set_version_name(Option<String>):
    required: false
    

    The name of the annotation store version.

    
    
  • format_options(FormatOptions) / set_format_options(Option<FormatOptions>):
    required: false
    

    Formatting options for the annotation file.

    
    
  • run_left_normalization(bool) / set_run_left_normalization(Option<bool>):
    required: false
    

    The job’s left normalization setting.

    
    
  • annotation_fields(impl Into<String>, impl Into<String>) / set_annotation_fields(Option<HashMap::<String, String>>):
    required: false
    

    The annotation schema generated by the parsed annotation data.

    
    
• On success, responds with StartAnnotationImportJobOutput with field(s):
  • job_id(String):

    The job’s ID.

• On failure, responds with SdkError<StartAnnotationImportJobError>

impl Client

pub fn start_read_set_activation_job( &self, ) -> StartReadSetActivationJobFluentBuilder

Constructs a fluent builder for the StartReadSetActivationJob operation.

• The fluent builder is configurable:
  • sequence_store_id(impl Into<String>) / set_sequence_store_id(Option<String>):
    required: true
    

    The read set’s sequence store ID.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    To ensure that jobs don’t run multiple times, specify a unique token for each job.

    
    
  • sources(StartReadSetActivationJobSourceItem) / set_sources(Option<Vec::<StartReadSetActivationJobSourceItem>>):
    required: true
    

    The job’s source files.

    
    
• On success, responds with StartReadSetActivationJobOutput with field(s):
  • id(String):

    The job’s ID.

  • sequence_store_id(String):

    The read set’s sequence store ID.

  • status(ReadSetActivationJobStatus):

    The job’s status.

  • creation_time(DateTime):

    When the job was created.

• On failure, responds with SdkError<StartReadSetActivationJobError>

impl Client

pub fn start_read_set_export_job(&self) -> StartReadSetExportJobFluentBuilder

Constructs a fluent builder for the StartReadSetExportJob operation.

• The fluent builder is configurable:
  • sequence_store_id(impl Into<String>) / set_sequence_store_id(Option<String>):
    required: true
    

    The read set’s sequence store ID.

    
    
  • destination(impl Into<String>) / set_destination(Option<String>):
    required: true
    

    A location for exported files in Amazon S3.

    
    
  • role_arn(impl Into<String>) / set_role_arn(Option<String>):
    required: true
    

    A service role for the job.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    To ensure that jobs don’t run multiple times, specify a unique token for each job.

    
    
  • sources(ExportReadSet) / set_sources(Option<Vec::<ExportReadSet>>):
    required: true
    

    The job’s source files.

    
    
• On success, responds with StartReadSetExportJobOutput with field(s):
  • id(String):

    The job’s ID.

  • sequence_store_id(String):

    The read set’s sequence store ID.

  • destination(String):

    The job’s output location.

  • status(ReadSetExportJobStatus):

    The job’s status.

  • creation_time(DateTime):

    When the job was created.

• On failure, responds with SdkError<StartReadSetExportJobError>

impl Client

pub fn start_read_set_import_job(&self) -> StartReadSetImportJobFluentBuilder

Constructs a fluent builder for the StartReadSetImportJob operation.

• The fluent builder is configurable:
  • sequence_store_id(impl Into<String>) / set_sequence_store_id(Option<String>):
    required: true
    

    The read set’s sequence store ID.

    
    
  • role_arn(impl Into<String>) / set_role_arn(Option<String>):
    required: true
    

    A service role for the job.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    To ensure that jobs don’t run multiple times, specify a unique token for each job.

    
    
  • sources(StartReadSetImportJobSourceItem) / set_sources(Option<Vec::<StartReadSetImportJobSourceItem>>):
    required: true
    

    The job’s source files.

    
    
• On success, responds with StartReadSetImportJobOutput with field(s):
  • id(String):

    The job’s ID.

  • sequence_store_id(String):

    The read set’s sequence store ID.

  • role_arn(String):

    The job’s service role ARN.

  • status(ReadSetImportJobStatus):

    The job’s status.

  • creation_time(DateTime):

    When the job was created.

• On failure, responds with SdkError<StartReadSetImportJobError>

impl Client

pub fn start_reference_import_job(&self) -> StartReferenceImportJobFluentBuilder

Constructs a fluent builder for the StartReferenceImportJob operation.

• The fluent builder is configurable:
  • reference_store_id(impl Into<String>) / set_reference_store_id(Option<String>):
    required: true
    

    The job’s reference store ID.

    
    
  • role_arn(impl Into<String>) / set_role_arn(Option<String>):
    required: true
    

    A service role for the job.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    To ensure that jobs don’t run multiple times, specify a unique token for each job.

    
    
  • sources(StartReferenceImportJobSourceItem) / set_sources(Option<Vec::<StartReferenceImportJobSourceItem>>):
    required: true
    

    The job’s source files.

    
    
• On success, responds with StartReferenceImportJobOutput with field(s):
  • id(String):

    The job’s ID.

  • reference_store_id(String):

    The job’s reference store ID.

  • role_arn(String):

    The job’s service role ARN.

  • status(ReferenceImportJobStatus):

    The job’s status.

  • creation_time(DateTime):

    When the job was created.

• On failure, responds with SdkError<StartReferenceImportJobError>

impl Client

pub fn start_run(&self) -> StartRunFluentBuilder

Constructs a fluent builder for the StartRun operation.

• The fluent builder is configurable:
  • workflow_id(impl Into<String>) / set_workflow_id(Option<String>):
    required: false
    

    The run’s workflow ID.

    
    
  • workflow_type(WorkflowType) / set_workflow_type(Option<WorkflowType>):
    required: false
    

    The run’s workflow type.

    
    
  • run_id(impl Into<String>) / set_run_id(Option<String>):
    required: false
    

    The ID of a run to duplicate.

    
    
  • role_arn(impl Into<String>) / set_role_arn(Option<String>):
    required: true
    

    A service role for the run.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    A name for the run.

    
    
  • cache_id(impl Into<String>) / set_cache_id(Option<String>):
    required: false
    

    Identifier of the cache associated with this run. If you don’t specify a cache ID, no task outputs are cached for this run.

    
    
  • cache_behavior(CacheBehavior) / set_cache_behavior(Option<CacheBehavior>):
    required: false
    

    The cache behavior for the run. You specify this value if you want to override the default behavior for the cache. You had set the default value when you created the cache. For more information, see Run cache behavior in the Amazon Web Services HealthOmics User Guide.

    
    
  • run_group_id(impl Into<String>) / set_run_group_id(Option<String>):
    required: false
    

    The run’s group ID.

    
    
  • priority(i32) / set_priority(Option<i32>):
    required: false
    

    A priority for the run.

    
    
  • parameters(Document) / set_parameters(Option<Document>):
    required: false
    

    Parameters for the run.

    
    
  • storage_capacity(i32) / set_storage_capacity(Option<i32>):
    required: false
    

    The static storage capacity (in gibibytes) for this run. This field is not required if the storage type is dynamic (the system ignores any value that you enter).

    
    
  • output_uri(impl Into<String>) / set_output_uri(Option<String>):
    required: false
    

    An output URI for the run.

    
    
  • log_level(RunLogLevel) / set_log_level(Option<RunLogLevel>):
    required: false
    

    A log level for the run.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    Tags for the run.

    
    
  • request_id(impl Into<String>) / set_request_id(Option<String>):
    required: true
    

    To ensure that requests don’t run multiple times, specify a unique ID for each request.

    
    
  • retention_mode(RunRetentionMode) / set_retention_mode(Option<RunRetentionMode>):
    required: false
    

    The retention mode for the run. The default value is RETAIN.

    Amazon Web Services HealthOmics stores a fixed number of runs that are available to the console and API. In the default mode (RETAIN), you need to remove runs manually when the number of run exceeds the maximum. If you set the retention mode to REMOVE, Amazon Web Services HealthOmics automatically removes runs (that have mode set to REMOVE) when the number of run exceeds the maximum. All run logs are available in CloudWatch logs, if you need information about a run that is no longer available to the API.

    For more information about retention mode, see Specifying run retention mode in the Amazon Web Services HealthOmics User Guide.

    
    
  • storage_type(StorageType) / set_storage_type(Option<StorageType>):
    required: false
    

    The storage type for the run. By default, the run uses STATIC storage type, which allocates a fixed amount of storage. If you set the storage type to DYNAMIC, Amazon Web Services HealthOmics dynamically scales the storage up or down, based on file system utilization. For more information about static and dynamic storage, see Running workflows in the Amazon Web Services HealthOmics User Guide.

    
    
  • workflow_owner_id(impl Into<String>) / set_workflow_owner_id(Option<String>):
    required: false
    

    The ID of the workflow owner.

    
    
  • workflow_version_name(impl Into<String>) / set_workflow_version_name(Option<String>):
    required: false
    

    The name of the workflow version.

    
    
• On success, responds with StartRunOutput with field(s):
  • arn(Option<String>):

    Unique resource identifier for the run.

  • id(Option<String>):

    The run’s ID.

  • status(Option<RunStatus>):

    The run’s status.

  • tags(Option<HashMap::<String, String>>):

    The run’s tags.

  • uuid(Option<String>):

    The universally unique identifier for a run.

  • run_output_uri(Option<String>):

    The destination for workflow outputs.

• On failure, responds with SdkError<StartRunError>

impl Client

pub fn start_variant_import_job(&self) -> StartVariantImportJobFluentBuilder

Constructs a fluent builder for the StartVariantImportJob operation.

• The fluent builder is configurable:
  • destination_name(impl Into<String>) / set_destination_name(Option<String>):
    required: true
    

    The destination variant store for the job.

    
    
  • role_arn(impl Into<String>) / set_role_arn(Option<String>):
    required: true
    

    A service role for the job.

    
    
  • items(VariantImportItemSource) / set_items(Option<Vec::<VariantImportItemSource>>):
    required: true
    

    Items to import.

    
    
  • run_left_normalization(bool) / set_run_left_normalization(Option<bool>):
    required: false
    

    The job’s left normalization setting.

    
    
  • annotation_fields(impl Into<String>, impl Into<String>) / set_annotation_fields(Option<HashMap::<String, String>>):
    required: false
    

    The annotation schema generated by the parsed annotation data.

    
    
• On success, responds with StartVariantImportJobOutput with field(s):
  • job_id(String):

    The job’s ID.

• On failure, responds with SdkError<StartVariantImportJobError>

impl Client

pub fn tag_resource(&self) -> TagResourceFluentBuilder

Constructs a fluent builder for the TagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The resource’s ARN.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: true
    

    Tags for the resource.

    
    
• On success, responds with TagResourceOutput
• On failure, responds with SdkError<TagResourceError>

impl Client

pub fn untag_resource(&self) -> UntagResourceFluentBuilder

Constructs a fluent builder for the UntagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The resource’s ARN.

    
    
  • tag_keys(impl Into<String>) / set_tag_keys(Option<Vec::<String>>):
    required: true
    

    Keys of tags to remove.

    
    
• On success, responds with UntagResourceOutput
• On failure, responds with SdkError<UntagResourceError>

impl Client

pub fn update_annotation_store(&self) -> UpdateAnnotationStoreFluentBuilder

Constructs a fluent builder for the UpdateAnnotationStore operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    A name for the store.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A description for the store.

    
    
• On success, responds with UpdateAnnotationStoreOutput with field(s):
  • id(String):

    The store’s ID.

  • reference(Option<ReferenceItem>):

    The store’s genome reference.

  • status(StoreStatus):

    The store’s status.

  • name(String):

    The store’s name.

  • description(String):

    The store’s description.

  • creation_time(DateTime):

    When the store was created.

  • update_time(DateTime):

    When the store was updated.

  • store_options(Option<StoreOptions>):

    Parsing options for the store.

  • store_format(Option<StoreFormat>):

    The annotation file format of the store.

• On failure, responds with SdkError<UpdateAnnotationStoreError>

impl Client

pub fn update_annotation_store_version( &self, ) -> UpdateAnnotationStoreVersionFluentBuilder

Constructs a fluent builder for the UpdateAnnotationStoreVersion operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of an annotation store.

    
    
  • version_name(impl Into<String>) / set_version_name(Option<String>):
    required: true
    

    The name of an annotation store version.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The description of an annotation store.

    
    
• On success, responds with UpdateAnnotationStoreVersionOutput with field(s):
  • store_id(String):

    The annotation store ID.

  • id(String):

    The annotation store version ID.

  • status(VersionStatus):

    The status of an annotation store version.

  • name(String):

    The name of an annotation store.

  • version_name(String):

    The name of an annotation store version.

  • description(String):

    The description of an annotation store version.

  • creation_time(DateTime):

    The time stamp for when an annotation store version was created.

  • update_time(DateTime):

    The time stamp for when an annotation store version was updated.

• On failure, responds with SdkError<UpdateAnnotationStoreVersionError>

impl Client

pub fn update_run_cache(&self) -> UpdateRunCacheFluentBuilder

Constructs a fluent builder for the UpdateRunCache operation.

• The fluent builder is configurable:
  • cache_behavior(CacheBehavior) / set_cache_behavior(Option<CacheBehavior>):
    required: false
    

    Update the default run cache behavior.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    Update the run cache description.

    
    
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The identifier of the run cache you want to update.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    Update the name of the run cache.

    
    
• On success, responds with UpdateRunCacheOutput
• On failure, responds with SdkError<UpdateRunCacheError>

impl Client

pub fn update_run_group(&self) -> UpdateRunGroupFluentBuilder

Constructs a fluent builder for the UpdateRunGroup operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The group’s ID.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    A name for the group.

    
    
  • max_cpus(i32) / set_max_cpus(Option<i32>):
    required: false
    

    The maximum number of CPUs to use.

    
    
  • max_runs(i32) / set_max_runs(Option<i32>):
    required: false
    

    The maximum number of concurrent runs for the group.

    
    
  • max_duration(i32) / set_max_duration(Option<i32>):
    required: false
    

    A maximum run time for the group in minutes.

    
    
  • max_gpus(i32) / set_max_gpus(Option<i32>):
    required: false
    

    The maximum GPUs that can be used by a run group.

    
    
• On success, responds with UpdateRunGroupOutput
• On failure, responds with SdkError<UpdateRunGroupError>

impl Client

pub fn update_sequence_store(&self) -> UpdateSequenceStoreFluentBuilder

Constructs a fluent builder for the UpdateSequenceStore operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The ID of the sequence store.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    A name for the sequence store.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A description for the sequence store.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    To ensure that requests don’t run multiple times, specify a unique token for each request.

    
    
  • fallback_location(impl Into<String>) / set_fallback_location(Option<String>):
    required: false
    

    The S3 URI of a bucket and folder to store Read Sets that fail to upload.

    
    
  • propagated_set_level_tags(impl Into<String>) / set_propagated_set_level_tags(Option<Vec::<String>>):
    required: false
    

    The tags keys to propagate to the S3 objects associated with read sets in the sequence store.

    
    
  • s3_access_config(S3AccessConfig) / set_s3_access_config(Option<S3AccessConfig>):
    required: false
    

    S3 access configuration parameters.

    
    
• On success, responds with UpdateSequenceStoreOutput with field(s):
  • id(String):

    The ID of the sequence store.

  • arn(String):

    The ARN of the sequence store.

  • name(Option<String>):

    The name of the sequence store.

  • description(Option<String>):

    Description of the sequence store.

  • sse_config(Option<SseConfig>):

    Server-side encryption (SSE) settings for a store.

  • creation_time(DateTime):

    The time when the store was created.

  • update_time(Option<DateTime>):

    The last-updated time of the Sequence Store.

  • propagated_set_level_tags(Option<Vec::<String>>):

    The tags keys to propagate to the S3 objects associated with read sets in the sequence store.

  • status(Option<SequenceStoreStatus>):

    The status of the sequence store.

  • status_message(Option<String>):

    The status message of the sequence store.

  • fallback_location(Option<String>):

    The S3 URI of a bucket and folder to store Read Sets that fail to upload.

  • s3_access(Option<SequenceStoreS3Access>):

    The S3 access metadata of the sequence store.

  • e_tag_algorithm_family(Option<ETagAlgorithmFamily>):

    The ETag algorithm family to use on ingested read sets.

• On failure, responds with SdkError<UpdateSequenceStoreError>

impl Client

pub fn update_variant_store(&self) -> UpdateVariantStoreFluentBuilder

Constructs a fluent builder for the UpdateVariantStore operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    A name for the store.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A description for the store.

    
    
• On success, responds with UpdateVariantStoreOutput with field(s):
  • id(String):

    The store’s ID.

  • reference(Option<ReferenceItem>):

    The store’s genome reference.

  • status(StoreStatus):

    The store’s status.

  • name(String):

    The store’s name.

  • description(String):

    The store’s description.

  • creation_time(DateTime):

    When the store was created.

  • update_time(DateTime):

    When the store was updated.

• On failure, responds with SdkError<UpdateVariantStoreError>

impl Client

pub fn update_workflow(&self) -> UpdateWorkflowFluentBuilder

Constructs a fluent builder for the UpdateWorkflow operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The workflow’s ID.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    A name for the workflow.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A description for the workflow.

    
    
  • storage_type(StorageType) / set_storage_type(Option<StorageType>):
    required: false
    

    The default storage type for runs that use this workflow. STATIC storage allocates a fixed amount of storage. DYNAMIC storage dynamically scales the storage up or down, based on file system utilization. For more information about static and dynamic storage, see Running workflows in the Amazon Web Services HealthOmics User Guide.

    
    
  • storage_capacity(i32) / set_storage_capacity(Option<i32>):
    required: false
    

    The default static storage capacity (in gibibytes) for runs that use this workflow or workflow version.

    
    
• On success, responds with UpdateWorkflowOutput
• On failure, responds with SdkError<UpdateWorkflowError>

impl Client

pub fn update_workflow_version(&self) -> UpdateWorkflowVersionFluentBuilder

Constructs a fluent builder for the UpdateWorkflowVersion operation.

• The fluent builder is configurable:
  • workflow_id(impl Into<String>) / set_workflow_id(Option<String>):
    required: true
    

    The workflow’s ID.

    
    
  • version_name(impl Into<String>) / set_version_name(Option<String>):
    required: true
    

    The name of the workflow version.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    Description of the workflow version.

    
    
  • storage_type(StorageType) / set_storage_type(Option<StorageType>):
    required: false
    

    The default storage type for runs that use this workflow. STATIC storage allocates a fixed amount of storage. DYNAMIC storage dynamically scales the storage up or down, based on file system utilization. For more information about static and dynamic storage, see Running workflows in the Amazon Web Services HealthOmics User Guide.

    
    
  • storage_capacity(i32) / set_storage_capacity(Option<i32>):
    required: false
    

    The default static storage capacity (in gibibytes) for runs that use this workflow or workflow version.

    
    
• On success, responds with UpdateWorkflowVersionOutput
• On failure, responds with SdkError<UpdateWorkflowVersionError>

impl Client

pub fn upload_read_set_part(&self) -> UploadReadSetPartFluentBuilder

Constructs a fluent builder for the UploadReadSetPart operation.

• The fluent builder is configurable:
  • sequence_store_id(impl Into<String>) / set_sequence_store_id(Option<String>):
    required: true
    

    The Sequence Store ID used for the multipart upload.

    
    
  • upload_id(impl Into<String>) / set_upload_id(Option<String>):
    required: true
    

    The ID for the initiated multipart upload.

    
    
  • part_source(ReadSetPartSource) / set_part_source(Option<ReadSetPartSource>):
    required: true
    

    The source file for an upload part.

    
    
  • part_number(i32) / set_part_number(Option<i32>):
    required: true
    

    The number of the part being uploaded.

    
    
  • payload(ByteStream) / set_payload(ByteStream):
    required: true
    

    The read set data to upload for a part.

    
    
• On success, responds with UploadReadSetPartOutput with field(s):
  • checksum(String):

    An identifier used to confirm that parts are being added to the intended upload.

• On failure, responds with SdkError<UploadReadSetPartError>

impl Client

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

This method will panic in the following cases:

• Retries or timeouts are enabled without a sleep_impl configured.
• Identity caching is enabled without a sleep_impl and time_source configured.
• No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

Panics

• This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.
• This method will panic if no BehaviorVersion is provided. If you experience this panic, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Waiters for Client

fn wait_until_annotation_import_job_created( &self, ) -> AnnotationImportJobCreatedFluentBuilder

Wait until an annotation import is completed

fn wait_until_annotation_store_created( &self, ) -> AnnotationStoreCreatedFluentBuilder

Wait until an annotation store is created

fn wait_until_annotation_store_deleted( &self, ) -> AnnotationStoreDeletedFluentBuilder

Wait until an annotation store is deleted.

fn wait_until_annotation_store_version_created( &self, ) -> AnnotationStoreVersionCreatedFluentBuilder

Wait until an annotation store version is created

fn wait_until_annotation_store_version_deleted( &self, ) -> AnnotationStoreVersionDeletedFluentBuilder

Wait until an annotation store version is deleted.

fn wait_until_read_set_activation_job_completed( &self, ) -> ReadSetActivationJobCompletedFluentBuilder

Wait until a job is completed.

fn wait_until_read_set_export_job_completed( &self, ) -> ReadSetExportJobCompletedFluentBuilder

Wait until a job is completed.

fn wait_until_read_set_import_job_completed( &self, ) -> ReadSetImportJobCompletedFluentBuilder

Wait until a job is completed.

fn wait_until_reference_import_job_completed( &self, ) -> ReferenceImportJobCompletedFluentBuilder

Wait until a job is completed.

fn wait_until_run_running(&self) -> RunRunningFluentBuilder

Wait until a run is running.

fn wait_until_run_completed(&self) -> RunCompletedFluentBuilder

Wait until a run is completed.

fn wait_until_task_running(&self) -> TaskRunningFluentBuilder

Wait until a task is running.

fn wait_until_task_completed(&self) -> TaskCompletedFluentBuilder

Wait until a task is completed.

fn wait_until_variant_import_job_created( &self, ) -> VariantImportJobCreatedFluentBuilder

Wait until variant import is completed

fn wait_until_variant_store_created(&self) -> VariantStoreCreatedFluentBuilder

Wait until a variant store is created

fn wait_until_variant_store_deleted(&self) -> VariantStoreDeletedFluentBuilder

Wait until a variant store is deleted.

fn wait_until_workflow_active(&self) -> WorkflowActiveFluentBuilder

Wait until a workflow is active.

fn wait_until_workflow_version_active( &self, ) -> WorkflowVersionActiveFluentBuilder

Wait until a workflow version is active.