Class: Aws::Omics::Client

Inherits:
Seahorse::Client::Base show all
Includes:
ClientStubs
Defined in:
gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb

Overview

An API client for Omics. To construct a client, you need to configure a :region and :credentials.

client = Aws::Omics::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the developer guide.

See #initialize for a full list of supported configuration options.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials. This can be an instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::SharedCredentials - Used for loading static credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    • Aws::AssumeRoleWebIdentityCredentials - Used when you need to assume a role after providing credentials via the web.

    • Aws::SSOCredentials - Used for loading credentials from AWS SSO using an access token generated from aws login.

    • Aws::ProcessCredentials - Used for loading credentials from a process that outputs to stdout.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::ECSCredentials - Used for loading credentials from instances running in ECS.

    • Aws::CognitoIdentityCredentials - Used for loading credentials from the Cognito Identity service.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]
    • The :access_key_id, :secret_access_key, and :session_token options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • ~/.aws/credentials
    • ~/.aws/config
    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentails or Aws::ECSCredentials to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.
  • :region (required, String) —

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is searched for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

  • :client_side_monitoring (Boolean) — default: false —

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When true, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy" —

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :endpoint (String) —

    The client endpoint is normally constructed from the :region option. You should only configure an :endpoint when connecting to test or custom endpoints. This should be a valid HTTP(S) URI.

  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false —

    When set to true, endpoint discovery will be enabled for operations when available.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the :logger at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the legacy retry mode.

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • adaptive - An experimental retry mode that includes all the functionality of standard mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :secret_access_key (String)
  • :session_token (String)
  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :token_provider (Aws::TokenProvider) —

    A Bearer Token Provider. This can be an instance of any one of the following classes:

    • Aws::StaticTokenProvider - Used for configuring static, non-refreshing tokens.

    • Aws::SSOTokenProvider - Used for loading tokens from AWS SSO using an access token generated from aws login.

    When :token_provider is not configured directly, the Aws::TokenProviderChain will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to true, dualstack enabled endpoints (with .aws TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to true, fips compatible endpoints will be used if available. When a fips region is used, the region is normalized and this config is set to true.

  • :validate_params (Boolean) — default: true —

    When true, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::Omics::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::Omics::EndpointParameters

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_open_timeout (Float) — default: 15 —

    The number of seconds to wait when opening a HTTP session before raising a Timeout::Error.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session.

  • :ssl_timeout (Float) — default: nil —

    Sets the SSL timeout in seconds.

  • :http_wire_trace (Boolean) — default: false —

    When true, HTTP debug output will be sent to the :logger.

  • :ssl_verify_peer (Boolean) — default: true —

    When true, SSL peer certificates are verified when establishing a connection.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.



365
366
367
 
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 365

def initialize(*args)
  super
end

Instance Method Details

#batch_delete_read_set(params = {}) ⇒ Types::BatchDeleteReadSetResponse

Deletes one or more read sets.

Examples:

Request syntax with placeholder values


resp = client.batch_delete_read_set({
  ids: ["ReadSetId"], # required
  sequence_store_id: "SequenceStoreId", # required
})

Response structure


resp.errors #=> Array
resp.errors[0].code #=> String
resp.errors[0].id #=> String
resp.errors[0].message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :ids (required, Array<String>) —

    The read sets' IDs.

  • :sequence_store_id (required, String) —

    The read sets' sequence store ID.

Returns:

See Also:



401
402
403
404
 
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 401

def batch_delete_read_set(params = {}, options = {})
  req = build_request(:batch_delete_read_set, params)
  req.send_request(options)
end

#cancel_annotation_import_job(params = {}) ⇒ Struct

Cancels an annotation import job.

Examples:

Request syntax with placeholder values


resp = client.cancel_annotation_import_job({
  job_id: "ResourceId", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :job_id (required, String) —

    The job's ID.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



423
424
425
426
 
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 423

def cancel_annotation_import_job(params = {}, options = {})
  req = build_request(:cancel_annotation_import_job, params)
  req.send_request(options)
end

#cancel_run(params = {}) ⇒ Struct

Cancels a run.

Examples:

Request syntax with placeholder values


resp = client.cancel_run({
  id: "RunId", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :id (required, String) —

    The run's ID.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



445
446
447
448
 
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 445

def cancel_run(params = {}, options = {})
  req = build_request(:cancel_run, params)
  req.send_request(options)
end

#cancel_variant_import_job(params = {}) ⇒ Struct

Cancels a variant import job.

Examples:

Request syntax with placeholder values


resp = client.cancel_variant_import_job({
  job_id: "ResourceId", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :job_id (required, String) —

    The job's ID.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



467
468
469
470
 
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 467

def cancel_variant_import_job(params = {}, options = {})
  req = build_request(:cancel_variant_import_job, params)
  req.send_request(options)
end

#create_annotation_store(params = {}) ⇒ Types::CreateAnnotationStoreResponse

Creates an annotation store.

Examples:

Request syntax with placeholder values


resp = client.create_annotation_store({
  description: "StoreDescription",
  name: "CreateAnnotationStoreRequestNameString",
  reference: {
    reference_arn: "ReferenceArn",
  },
  sse_config: {
    key_arn: "SseConfigKeyArnString",
    type: "KMS", # required, accepts KMS
  },
  store_format: "GFF", # required, accepts GFF, TSV, VCF
  store_options: {
    tsv_store_options: {
      annotation_type: "GENERIC", # accepts GENERIC, CHR_POS, CHR_POS_REF_ALT, CHR_START_END_ONE_BASE, CHR_START_END_REF_ALT_ONE_BASE, CHR_START_END_ZERO_BASE, CHR_START_END_REF_ALT_ZERO_BASE
      format_to_header: {
        "CHR" => "FormatToHeaderValueString",
      },
      schema: [
        {
          "SchemaItemKeyString" => "LONG", # accepts LONG, INT, STRING, FLOAT, DOUBLE, BOOLEAN
        },
      ],
    },
  },
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.creation_time #=> Time
resp.id #=> String
resp.name #=> String
resp.reference.reference_arn #=> String
resp.status #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "FAILED"
resp.store_format #=> String, one of "GFF", "TSV", "VCF"
resp.store_options.tsv_store_options.annotation_type #=> String, one of "GENERIC", "CHR_POS", "CHR_POS_REF_ALT", "CHR_START_END_ONE_BASE", "CHR_START_END_REF_ALT_ONE_BASE", "CHR_START_END_ZERO_BASE", "CHR_START_END_REF_ALT_ZERO_BASE"
resp.store_options.tsv_store_options.format_to_header #=> Hash
resp.store_options.tsv_store_options.format_to_header["FormatToHeaderKey"] #=> String
resp.store_options.tsv_store_options.schema #=> Array
resp.store_options.tsv_store_options.schema[0] #=> Hash
resp.store_options.tsv_store_options.schema[0]["SchemaItemKeyString"] #=> String, one of "LONG", "INT", "STRING", "FLOAT", "DOUBLE", "BOOLEAN"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :description (String) —

    A description for the store.

  • :name (String) —

    A name for the store.

  • :reference (Types::ReferenceItem) —

    The genome reference for the store's annotations.

  • :sse_config (Types::SseConfig) —

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

  • :store_format (required, String) —

    The annotation file format of the store.

  • :store_options (Types::StoreOptions) —

    File parsing options for the annotation store.

  • :tags (Hash<String,String>) —

    Tags for the store.

Returns:

See Also:



555
556
557
558
 
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 555

def create_annotation_store(params = {}, options = {})
  req = build_request(:create_annotation_store, params)
  req.send_request(options)
end

#create_reference_store(params = {}) ⇒ Types::CreateReferenceStoreResponse

Creates a reference store.

Examples:

Request syntax with placeholder values


resp = client.create_reference_store({
  client_token: "ClientToken",
  description: "ReferenceStoreDescription",
  name: "ReferenceStoreName", # required
  sse_config: {
    key_arn: "SseConfigKeyArnString",
    type: "KMS", # required, accepts KMS
  },
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.arn #=> String
resp.creation_time #=> Time
resp.description #=> String
resp.id #=> String
resp.name #=> String
resp.sse_config.key_arn #=> String
resp.sse_config.type #=> String, one of "KMS"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :client_token (String) —

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

  • :description (String) —

    A description for the store.

  • :name (required, String) —

    A name for the store.

  • :sse_config (Types::SseConfig) —

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

  • :tags (Hash<String,String>) —

    Tags for the store.

Returns:

See Also:



616
617
618
619
 
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 616

def create_reference_store(params = {}, options = {})
  req = build_request(:create_reference_store, params)
  req.send_request(options)
end

#create_run_group(params = {}) ⇒ Types::CreateRunGroupResponse

Creates a run group.

Examples:

Request syntax with placeholder values


resp = client.create_run_group({
  max_cpus: 1,
  max_duration: 1,
  max_runs: 1,
  name: "RunGroupName",
  request_id: "RunGroupRequestId", # required
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.arn #=> String
resp.id #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_cpus (Integer) —

    The maximum number of CPUs to use in the group.

  • :max_duration (Integer) —

    A maximum run time for the group in minutes.

  • :max_runs (Integer) —

    The maximum number of concurrent runs for the group.

  • :name (String) —

    A name for the group.

  • :request_id (required, String) —

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

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

  • :tags (Hash<String,String>) —

    Tags for the group.

Returns:

See Also:



675
676
677
678
 
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 675

def create_run_group(params = {}, options = {})
  req = build_request(:create_run_group, params)
  req.send_request(options)
end

#create_sequence_store(params = {}) ⇒ Types::CreateSequenceStoreResponse

Creates a sequence store.

Examples:

Request syntax with placeholder values


resp = client.create_sequence_store({
  client_token: "ClientToken",
  description: "SequenceStoreDescription",
  name: "SequenceStoreName", # required
  sse_config: {
    key_arn: "SseConfigKeyArnString",
    type: "KMS", # required, accepts KMS
  },
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.arn #=> String
resp.creation_time #=> Time
resp.description #=> String
resp.id #=> String
resp.name #=> String
resp.sse_config.key_arn #=> String
resp.sse_config.type #=> String, one of "KMS"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :client_token (String) —

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

  • :description (String) —

    A description for the store.

  • :name (required, String) —

    A name for the store.

  • :sse_config (Types::SseConfig) —

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

  • :tags (Hash<String,String>) —

    Tags for the store.

Returns:

See Also:



736
737
738
739
 
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 736

def create_sequence_store(params = {}, options = {})
  req = build_request(:create_sequence_store, params)
  req.send_request(options)
end

#create_variant_store(params = {}) ⇒ Types::CreateVariantStoreResponse

Creates a variant store.

Examples:

Request syntax with placeholder values


resp = client.create_variant_store({
  description: "StoreDescription",
  name: "CreateVariantStoreRequestNameString",
  reference: { # required
    reference_arn: "ReferenceArn",
  },
  sse_config: {
    key_arn: "SseConfigKeyArnString",
    type: "KMS", # required, accepts KMS
  },
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.creation_time #=> Time
resp.id #=> String
resp.name #=> String
resp.reference.reference_arn #=> String
resp.status #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "FAILED"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :description (String) —

    A description for the store.

  • :name (String) —

    A name for the store.

  • :reference (required, Types::ReferenceItem) —

    The genome reference for the store's variants.

  • :sse_config (Types::SseConfig) —

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

  • :tags (Hash<String,String>) —

    Tags for the store.

Returns:

See Also:



795
796
797
798
 
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 795

def create_variant_store(params = {}, options = {})
  req = build_request(:create_variant_store, params)
  req.send_request(options)
end

#create_workflow(params = {}) ⇒ Types::CreateWorkflowResponse

Creates a workflow.

Examples:

Request syntax with placeholder values


resp = client.create_workflow({
  definition_uri: "WorkflowDefinition",
  definition_zip: "data",
  description: "WorkflowDescription",
  engine: "WDL", # accepts WDL, NEXTFLOW
  main: "WorkflowMain",
  name: "WorkflowName",
  parameter_template: {
    "WorkflowParameterName" => {
      description: "WorkflowParameterDescription",
      optional: false,
    },
  },
  request_id: "WorkflowRequestId", # required
  storage_capacity: 1,
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.arn #=> String
resp.id #=> String
resp.status #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETED", "FAILED", "INACTIVE"
resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :definition_uri (String) —

    The URI of a definition for the workflow.

  • :definition_zip (String, StringIO, File) —

    A ZIP archive for the workflow.

  • :description (String) —

    A description for the workflow.

  • :engine (String) —

    An engine for the workflow.

  • :main (String) —

    The path of the main definition file for the workflow.

  • :name (String) —

    A name for the workflow.

  • :parameter_template (Hash<String,Types::WorkflowParameter>) —

    A parameter template for the workflow.

  • :request_id (required, String) —

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

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

  • :storage_capacity (Integer) —

    A storage capacity for the workflow in gigabytes.

  • :tags (Hash<String,String>) —

    Tags for the workflow.

Returns:

See Also:



877
878
879
880
 
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 877

def create_workflow(params = {}, options = {})
  req = build_request(:create_workflow, params)
  req.send_request(options)
end

#delete_annotation_store(params = {}) ⇒ Types::DeleteAnnotationStoreResponse

Deletes an annotation store.

Examples:

Request syntax with placeholder values


resp = client.delete_annotation_store({
  force: false,
  name: "String", # required
})

Response structure


resp.status #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "FAILED"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :force (Boolean) —

    Whether to force deletion.

  • :name (required, String) —

    The store's name.

Returns:

See Also:



909
910
911
912
 
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 909

def delete_annotation_store(params = {}, options = {})
  req = build_request(:delete_annotation_store, params)
  req.send_request(options)
end

#delete_reference(params = {}) ⇒ Struct

Deletes a genome reference.

Examples:

Request syntax with placeholder values


resp = client.delete_reference({
  id: "ReferenceId", # required
  reference_store_id: "ReferenceStoreId", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :id (required, String) —

    The reference's ID.

  • :reference_store_id (required, String) —

    The reference's store ID.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



935
936
937
938
 
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 935

def delete_reference(params = {}, options = {})
  req = build_request(:delete_reference, params)
  req.send_request(options)
end

#delete_reference_store(params = {}) ⇒ Struct

Deletes a genome reference store.

Examples:

Request syntax with placeholder values


resp = client.delete_reference_store({
  id: "ReferenceStoreId", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :id (required, String) —

    The store's ID.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



957
958
959
960
 
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 957

def delete_reference_store(params = {}, options = {})
  req = build_request(:delete_reference_store, params)
  req.send_request(options)
end

#delete_run(params = {}) ⇒ Struct

Deletes a workflow run.

Examples:

Request syntax with placeholder values


resp = client.delete_run({
  id: "RunId", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :id (required, String) —

    The run's ID.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



979
980
981
982
 
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 979

def delete_run(params = {}, options = {})
  req = build_request(:delete_run, params)
  req.send_request(options)
end

#delete_run_group(params = {}) ⇒ Struct

Deletes a workflow run group.

Examples:

Request syntax with placeholder values


resp = client.delete_run_group({
  id: "RunGroupId", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :id (required, String) —

    The run group's ID.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1001
1002
1003
1004
 
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1001

def delete_run_group(params = {}, options = {})
  req = build_request(:delete_run_group, params)
  req.send_request(options)
end

#delete_sequence_store(params = {}) ⇒ Struct

Deletes a sequence store.

Examples:

Request syntax with placeholder values


resp = client.delete_sequence_store({
  id: "SequenceStoreId", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :id (required, String) —

    The sequence store's ID.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1023
1024
1025
1026
 
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1023

def delete_sequence_store(params = {}, options = {})
  req = build_request(:delete_sequence_store, params)
  req.send_request(options)
end

#delete_variant_store(params = {}) ⇒ Types::DeleteVariantStoreResponse

Deletes a variant store.

Examples:

Request syntax with placeholder values


resp = client.delete_variant_store({
  force: false,
  name: "String", # required
})

Response structure


resp.status #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "FAILED"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :force (Boolean) —

    Whether to force deletion.

  • :name (required, String) —

    The store's name.

Returns:

See Also:



1055
1056
1057
1058
 
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1055

def delete_variant_store(params = {}, options = {})
  req = build_request(:delete_variant_store, params)
  req.send_request(options)
end

#delete_workflow(params = {}) ⇒ Struct

Deletes a workflow.

Examples:

Request syntax with placeholder values


resp = client.delete_workflow({
  id: "WorkflowId", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :id (required, String) —

    The workflow's ID.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1077
1078
1079
1080
 
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1077

def delete_workflow(params = {}, options = {})
  req = build_request(:delete_workflow, params)
  req.send_request(options)
end

#get_annotation_import_job(params = {}) ⇒ Types::GetAnnotationImportResponse

Gets information about an annotation import job.

The following waiters are defined for this operation (see #wait_until for detailed usage):

  • annotation_import_job_created

Examples:

Request syntax with placeholder values


resp = client.get_annotation_import_job({
  job_id: "ResourceId", # required
})

Response structure


resp.completion_time #=> Time
resp.creation_time #=> Time
resp.destination_name #=> String
resp.format_options.tsv_options.read_options.comment #=> String
resp.format_options.tsv_options.read_options.encoding #=> String
resp.format_options.tsv_options.read_options.escape #=> String
resp.format_options.tsv_options.read_options.escape_quotes #=> Boolean
resp.format_options.tsv_options.read_options.header #=> Boolean
resp.format_options.tsv_options.read_options.line_sep #=> String
resp.format_options.tsv_options.read_options.quote #=> String
resp.format_options.tsv_options.read_options.quote_all #=> Boolean
resp.format_options.tsv_options.read_options.sep #=> String
resp.format_options.vcf_options.ignore_filter_field #=> Boolean
resp.format_options.vcf_options.ignore_qual_field #=> Boolean
resp.id #=> String
resp.items #=> Array
resp.items[0].job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "CANCELLED", "COMPLETED", "FAILED", "COMPLETED_WITH_FAILURES"
resp.items[0].source #=> String
resp.role_arn #=> String
resp.run_left_normalization #=> Boolean
resp.status #=> String, one of "SUBMITTED", "IN_PROGRESS", "CANCELLED", "COMPLETED", "FAILED", "COMPLETED_WITH_FAILURES"
resp.status_message #=> String
resp.update_time #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :job_id (required, String) —

    The job's ID.

Returns:

See Also:



1142
1143
1144
1145
 
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1142

def get_annotation_import_job(params = {}, options = {})
  req = build_request(:get_annotation_import_job, params)
  req.send_request(options)
end

#get_annotation_store(params = {}) ⇒ Types::GetAnnotationStoreResponse

Gets information about an annotation store.

The following waiters are defined for this operation (see #wait_until for detailed usage):

  • annotation_store_created
  • annotation_store_deleted

Examples:

Request syntax with placeholder values


resp = client.get_annotation_store({
  name: "String", # required
})

Response structure


resp.creation_time #=> Time
resp.description #=> String
resp.id #=> String
resp.name #=> String
resp.reference.reference_arn #=> String
resp.sse_config.key_arn #=> String
resp.sse_config.type #=> String, one of "KMS"
resp.status #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "FAILED"
resp.status_message #=> String
resp.store_arn #=> String
resp.store_format #=> String, one of "GFF", "TSV", "VCF"
resp.store_options.tsv_store_options.annotation_type #=> String, one of "GENERIC", "CHR_POS", "CHR_POS_REF_ALT", "CHR_START_END_ONE_BASE", "CHR_START_END_REF_ALT_ONE_BASE", "CHR_START_END_ZERO_BASE", "CHR_START_END_REF_ALT_ZERO_BASE"
resp.store_options.tsv_store_options.format_to_header #=> Hash
resp.store_options.tsv_store_options.format_to_header["FormatToHeaderKey"] #=> String
resp.store_options.tsv_store_options.schema #=> Array
resp.store_options.tsv_store_options.schema[0] #=> Hash
resp.store_options.tsv_store_options.schema[0]["SchemaItemKeyString"] #=> String, one of "LONG", "INT", "STRING", "FLOAT", "DOUBLE", "BOOLEAN"
resp.store_size_bytes #=> Integer
resp.tags #=> Hash
resp.tags["TagKey"] #=> String
resp.update_time #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    The store's name.

Returns:

See Also:



1209
1210
1211
1212
 
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1209

def get_annotation_store(params = {}, options = {})
  req = build_request(:get_annotation_store, params)
  req.send_request(options)
end

#get_read_set(params = {}) ⇒ Types::GetReadSetResponse

Gets a file from a read set.

Examples:

Request syntax with placeholder values


resp = client.get_read_set({
  file: "SOURCE1", # accepts SOURCE1, SOURCE2, INDEX
  id: "ReadSetId", # required
  part_number: 1, # required
  sequence_store_id: "SequenceStoreId", # required
})

Response structure


resp.payload #=> IO

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :file (String) —

    The file to retrieve.

  • :id (required, String) —

    The read set's ID.

  • :part_number (required, Integer) —

    The part number to retrieve.

  • :sequence_store_id (required, String) —

    The read set's sequence store ID.

Returns:

See Also:



1249
1250
1251
1252
 
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1249

def get_read_set(params = {}, options = {}, &block)
  req = build_request(:get_read_set, params)
  req.send_request(options, &block)
end

#get_read_set_activation_job(params = {}) ⇒ Types::GetReadSetActivationJobResponse

Gets information about a read set activation job.

The following waiters are defined for this operation (see #wait_until for detailed usage):

  • read_set_activation_job_completed

Examples:

Request syntax with placeholder values


resp = client.get_read_set_activation_job({
  id: "ActivationJobId", # required
  sequence_store_id: "SequenceStoreId", # required
})

Response structure


resp.completion_time #=> Time
resp.creation_time #=> Time
resp.id #=> String
resp.sequence_store_id #=> String
resp.sources #=> Array
resp.sources[0].read_set_id #=> String
resp.sources[0].status #=> String, one of "NOT_STARTED", "IN_PROGRESS", "FINISHED", "FAILED"
resp.sources[0].status_message #=> String
resp.status #=> String, one of "SUBMITTED", "IN_PROGRESS", "CANCELLING", "CANCELLED", "FAILED", "COMPLETED", "COMPLETED_WITH_FAILURES"
resp.status_message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :id (required, String) —

    The job's ID.

  • :sequence_store_id (required, String) —

    The job's sequence store ID.

Returns:

See Also:



1301
1302
1303
1304
 
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1301

def get_read_set_activation_job(params = {}, options = {})
  req = build_request(:get_read_set_activation_job, params)
  req.send_request(options)
end

#get_read_set_export_job(params = {}) ⇒ Types::GetReadSetExportJobResponse

Gets information about a read set export job.

The following waiters are defined for this operation (see #wait_until for detailed usage):

  • read_set_export_job_completed

Examples:

Request syntax with placeholder values


resp = client.get_read_set_export_job({
  id: "ExportJobId", # required
  sequence_store_id: "SequenceStoreId", # required
})

Response structure


resp.completion_time #=> Time
resp.creation_time #=> Time
resp.destination #=> String
resp.id #=> String
resp.read_sets #=> Array
resp.read_sets[0].id #=> String
resp.read_sets[0].status #=> String, one of "NOT_STARTED", "IN_PROGRESS", "FINISHED", "FAILED"
resp.read_sets[0].status_message #=> String
resp.sequence_store_id #=> String
resp.status #=> String, one of "SUBMITTED", "IN_PROGRESS", "CANCELLING", "CANCELLED", "FAILED", "COMPLETED", "COMPLETED_WITH_FAILURES"
resp.status_message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :id (required, String) —

    The job's ID.

  • :sequence_store_id (required, String) —

    The job's sequence store ID.

Returns:

See Also:



1355
1356
1357
1358
 
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1355

def get_read_set_export_job(params = {}, options = {})
  req = build_request(:get_read_set_export_job, params)
  req.send_request(options)
end

#get_read_set_import_job(params = {}) ⇒ Types::GetReadSetImportJobResponse

Gets information about a read set import job.

The following waiters are defined for this operation (see #wait_until for detailed usage):

  • read_set_import_job_completed

Examples:

Request syntax with placeholder values


resp = client.get_read_set_import_job({
  id: "ImportJobId", # required
  sequence_store_id: "SequenceStoreId", # required
})

Response structure


resp.completion_time #=> Time
resp.creation_time #=> Time
resp.id #=> String
resp.role_arn #=> String
resp.sequence_store_id #=> String
resp.sources #=> Array
resp.sources[0].description #=> String
resp.sources[0].generated_from #=> String
resp.sources[0].name #=> String
resp.sources[0].reference_arn #=> String
resp.sources[0].sample_id #=> String
resp.sources[0].source_file_type #=> String, one of "FASTQ", "BAM", "CRAM"
resp.sources[0].source_files.source1 #=> String
resp.sources[0].source_files.source2 #=> String
resp.sources[0].status #=> String, one of "NOT_STARTED", "IN_PROGRESS", "FINISHED", "FAILED"
resp.sources[0].status_message #=> String
resp.sources[0].subject_id #=> String
resp.sources[0].tags #=> Hash
resp.sources[0].tags["TagKey"] #=> String
resp.status #=> String, one of "SUBMITTED", "IN_PROGRESS", "CANCELLING", "CANCELLED", "FAILED", "COMPLETED", "COMPLETED_WITH_FAILURES"
resp.status_message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :id (required, String) —

    The job's ID.

  • :sequence_store_id (required, String) —

    The job's sequence store ID.

Returns:

See Also:



1419
1420
1421
1422
 
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1419

def get_read_set_import_job(params = {}, options = {})
  req = build_request(:get_read_set_import_job, params)
  req.send_request(options)
end

#get_read_set_metadata(params = {}) ⇒ Types::GetReadSetMetadataResponse

Gets details about a read set.

Examples:

Request syntax with placeholder values


resp = client.get_read_set_metadata({
  id: "ReadSetId", # required
  sequence_store_id: "SequenceStoreId", # required
})

Response structure


resp.arn #=> String
resp.creation_time #=> Time
resp.description #=> String
resp.file_type #=> String, one of "FASTQ", "BAM", "CRAM"
resp.files.index.content_length #=> Integer
resp.files.index.part_size #=> Integer
resp.files.index.total_parts #=> Integer
resp.files.source1.content_length #=> Integer
resp.files.source1.part_size #=> Integer
resp.files.source1.total_parts #=> Integer
resp.files.source2.content_length #=> Integer
resp.files.source2.part_size #=> Integer
resp.files.source2.total_parts #=> Integer
resp.id #=> String
resp.name #=> String
resp.reference_arn #=> String
resp.sample_id #=> String
resp.sequence_information.alignment #=> String
resp.sequence_information.generated_from #=> String
resp.sequence_information.total_base_count #=> Integer
resp.sequence_information.total_read_count #=> Integer
resp.sequence_store_id #=> String
resp.status #=> String, one of "ARCHIVED", "ACTIVATING", "ACTIVE", "DELETING", "DELETED"
resp.subject_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :id (required, String) —

    The read set's ID.

  • :sequence_store_id (required, String) —

    The read set's sequence store ID.

Returns:

See Also:



1486
1487
1488
1489
 
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1486

def get_read_set_metadata(params = {}, options = {})
  req = build_request(:get_read_set_metadata, params)
  req.send_request(options)
end

#get_reference(params = {}) ⇒ Types::GetReferenceResponse

Gets a reference file.

Examples:

Request syntax with placeholder values


resp = client.get_reference({
  file: "SOURCE", # accepts SOURCE, INDEX
  id: "ReferenceId", # required
  part_number: 1, # required
  range: "Range",
  reference_store_id: "ReferenceStoreId", # required
})

Response structure


resp.payload #=> IO

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :file (String) —

    The file to retrieve.

  • :id (required, String) —

    The reference's ID.

  • :part_number (required, Integer) —

    The part number to retrieve.

  • :range (String) —

    The range to retrieve.

  • :reference_store_id (required, String) —

    The reference's store ID.

Returns:

See Also:



1530
1531
1532
1533
 
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1530

def get_reference(params = {}, options = {}, &block)
  req = build_request(:get_reference, params)
  req.send_request(options, &block)
end

#get_reference_import_job(params = {}) ⇒ Types::GetReferenceImportJobResponse

Gets information about a reference import job.

The following waiters are defined for this operation (see #wait_until for detailed usage):

  • reference_import_job_completed

Examples:

Request syntax with placeholder values


resp = client.get_reference_import_job({
  id: "ImportJobId", # required
  reference_store_id: "ReferenceStoreId", # required
})

Response structure


resp.completion_time #=> Time
resp.creation_time #=> Time
resp.id #=> String
resp.reference_store_id #=> String
resp.role_arn #=> String
resp.sources #=> Array
resp.sources[0].description #=> String
resp.sources[0].name #=> String
resp.sources[0].source_file #=> String
resp.sources[0].status #=> String, one of "NOT_STARTED", "IN_PROGRESS", "FINISHED", "FAILED"
resp.sources[0].status_message #=> String
resp.sources[0].tags #=> Hash
resp.sources[0].tags["TagKey"] #=> String
resp.status #=> String, one of "SUBMITTED", "IN_PROGRESS", "CANCELLING", "CANCELLED", "FAILED", "COMPLETED", "COMPLETED_WITH_FAILURES"
resp.status_message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :id (required, String) —

    The job's ID.

  • :reference_store_id (required, String) —

    The job's reference store ID.

Returns:

See Also:



1588
1589
1590
1591
 
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1588

def get_reference_import_job(params = {}, options = {})
  req = build_request(:get_reference_import_job, params)
  req.send_request(options)
end

#get_reference_metadata(params = {}) ⇒ Types::GetReferenceMetadataResponse

Gets information about a genome reference's metadata.

Examples:

Request syntax with placeholder values


resp = client.get_reference_metadata({
  id: "ReferenceId", # required
  reference_store_id: "ReferenceStoreId", # required
})

Response structure


resp.arn #=> String
resp.creation_time #=> Time
resp.description #=> String
resp.files.index.content_length #=> Integer
resp.files.index.part_size #=> Integer
resp.files.index.total_parts #=> Integer
resp.files.source.content_length #=> Integer
resp.files.source.part_size #=> Integer
resp.files.source.total_parts #=> Integer
resp.id #=> String
resp.md5 #=> String
resp.name #=> String
resp.reference_store_id #=> String
resp.status #=> String, one of "ACTIVE", "DELETING", "DELETED"
resp.update_time #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :id (required, String) —

    The reference's ID.

  • :reference_store_id (required, String) —

    The reference's reference store ID.

Returns:

See Also:



1643
1644
1645
1646
 
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1643

def get_reference_metadata(params = {}, options = {})
  req = build_request(:get_reference_metadata, params)
  req.send_request(options)
end

#get_reference_store(params = {}) ⇒ Types::GetReferenceStoreResponse

Gets information about a reference store.

Examples:

Request syntax with placeholder values


resp = client.get_reference_store({
  id: "ReferenceStoreId", # required
})

Response structure


resp.arn #=> String
resp.creation_time #=> Time
resp.description #=> String
resp.id #=> String
resp.name #=> String
resp.sse_config.key_arn #=> String
resp.sse_config.type #=> String, one of "KMS"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :id (required, String) —

    The store's ID.

Returns:

See Also:



1682
1683
1684
1685
 
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1682

def get_reference_store(params = {}, options = {})
  req = build_request(:get_reference_store, params)
  req.send_request(options)
end

#get_run(params = {}) ⇒ Types::GetRunResponse

Gets information about a workflow run.

The following waiters are defined for this operation (see #wait_until for detailed usage):

  • run_completed
  • run_running

Examples:

Request syntax with placeholder values


resp = client.get_run({
  export: ["DEFINITION"], # accepts DEFINITION
  id: "RunId", # required
})

Response structure


resp.arn #=> String
resp.creation_time #=> Time
resp.definition #=> String
resp.digest #=> String
resp.id #=> String
resp.log_level #=> String, one of "OFF", "FATAL", "ERROR", "ALL"
resp.name #=> String
resp.output_uri #=> String
resp.priority #=> Integer
resp.resource_digests #=> Hash
resp.resource_digests["RunResourceDigestKey"] #=> String
resp.role_arn #=> String
resp.run_group_id #=> String
resp.run_id #=> String
resp.start_time #=> Time
resp.started_by #=> String
resp.status #=> String, one of "PENDING", "STARTING", "RUNNING", "STOPPING", "COMPLETED", "DELETED", "CANCELLED", "FAILED"
resp.status_message #=> String
resp.stop_time #=> Time
resp.storage_capacity #=> Integer
resp.tags #=> Hash
resp.tags["TagKey"] #=> String
resp.workflow_id #=> String
resp.workflow_type #=> String, one of "PRIVATE", "SERVICE"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :export (Array<String>) —

    The run's export format.

  • :id (required, String) —

    The run's ID.

Returns:

See Also:



1765
1766
1767
1768
 
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1765

def get_run(params = {}, options = {})
  req = build_request(:get_run, params)
  req.send_request(options)
end

#get_run_group(params = {}) ⇒ Types::GetRunGroupResponse

Gets information about a workflow run group.

Examples:

Request syntax with placeholder values


resp = client.get_run_group({
  id: "RunGroupId", # required
})

Response structure


resp.arn #=> String
resp.creation_time #=> Time
resp.id #=> String
resp.max_cpus #=> Integer
resp.max_duration #=> Integer
resp.max_runs #=> Integer
resp.name #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :id (required, String) —

    The group's ID.

Returns:

See Also:



1808
1809
1810
1811
 
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1808

def get_run_group(params = {}, options = {})
  req = build_request(:get_run_group, params)
  req.send_request(options)
end

#get_run_task(params = {}) ⇒ Types::GetRunTaskResponse

Gets information about a workflow run task.

The following waiters are defined for this operation (see #wait_until for detailed usage):

  • task_completed
  • task_running

Examples:

Request syntax with placeholder values


resp = client.get_run_task({
  id: "RunId", # required
  task_id: "TaskId", # required
})

Response structure


resp.cpus #=> Integer
resp.creation_time #=> Time
resp.log_stream #=> String
resp.memory #=> Integer
resp.name #=> String
resp.start_time #=> Time
resp.status #=> String, one of "PENDING", "STARTING", "RUNNING", "STOPPING", "COMPLETED", "CANCELLED", "FAILED"
resp.status_message #=> String
resp.stop_time #=> Time
resp.task_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :id (required, String) —

    The task's ID.

  • :task_id (required, String) —

    The task's ID.

Returns:

See Also:



1864
1865
1866
1867
 
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1864

def get_run_task(params = {}, options = {})
  req = build_request(:get_run_task, params)
  req.send_request(options)
end

#get_sequence_store(params = {}) ⇒ Types::GetSequenceStoreResponse

Gets information about a sequence store.

Examples:

Request syntax with placeholder values


resp = client.get_sequence_store({
  id: "SequenceStoreId", # required
})

Response structure


resp.arn #=> String
resp.creation_time #=> Time
resp.description #=> String
resp.id #=> String
resp.name #=> String
resp.sse_config.key_arn #=> String
resp.sse_config.type #=> String, one of "KMS"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :id (required, String) —

    The store's ID.

Returns:

See Also:



1903
1904
1905
1906
 
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1903

def get_sequence_store(params = {}, options = {})
  req = build_request(:get_sequence_store, params)
  req.send_request(options)
end

#get_variant_import_job(params = {}) ⇒ Types::GetVariantImportResponse

Gets information about a variant import job.

The following waiters are defined for this operation (see #wait_until for detailed usage):

  • variant_import_job_created

Examples:

Request syntax with placeholder values


resp = client.get_variant_import_job({
  job_id: "ResourceId", # required
})

Response structure


resp.completion_time #=> Time
resp.creation_time #=> Time
resp.destination_name #=> String
resp.id #=> String
resp.items #=> Array
resp.items[0].job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "CANCELLED", "COMPLETED", "FAILED", "COMPLETED_WITH_FAILURES"
resp.items[0].source #=> String
resp.items[0].status_message #=> String
resp.role_arn #=> String
resp.run_left_normalization #=> Boolean
resp.status #=> String, one of "SUBMITTED", "IN_PROGRESS", "CANCELLED", "COMPLETED", "FAILED", "COMPLETED_WITH_FAILURES"
resp.status_message #=> String
resp.update_time #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :job_id (required, String) —

    The job's ID.

Returns:

See Also:



1957
1958
1959
1960
 
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1957

def get_variant_import_job(params = {}, options = {})
  req = build_request(:get_variant_import_job, params)
  req.send_request(options)
end

#get_variant_store(params = {}) ⇒ Types::GetVariantStoreResponse

Gets information about a variant store.

The following waiters are defined for this operation (see #wait_until for detailed usage):

  • variant_store_created
  • variant_store_deleted

Examples:

Request syntax with placeholder values


resp = client.get_variant_store({
  name: "String", # required
})

Response structure


resp.creation_time #=> Time
resp.description #=> String
resp.id #=> String
resp.name #=> String
resp.reference.reference_arn #=> String
resp.sse_config.key_arn #=> String
resp.sse_config.type #=> String, one of "KMS"
resp.status #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "FAILED"
resp.status_message #=> String
resp.store_arn #=> String
resp.store_size_bytes #=> Integer
resp.tags #=> Hash
resp.tags["TagKey"] #=> String
resp.update_time #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    The store's name.

Returns:

See Also:



2015
2016
2017
2018
 
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2015

def get_variant_store(params = {}, options = {})
  req = build_request(:get_variant_store, params)
  req.send_request(options)
end

#get_workflow(params = {}) ⇒ Types::GetWorkflowResponse

Gets information about a workflow.

The following waiters are defined for this operation (see #wait_until for detailed usage):

  • workflow_active

Examples:

Request syntax with placeholder values


resp = client.get_workflow({
  export: ["DEFINITION"], # accepts DEFINITION
  id: "WorkflowId", # required
  type: "PRIVATE", # accepts PRIVATE, SERVICE
})

Response structure


resp.arn #=> String
resp.creation_time #=> Time
resp.definition #=> String
resp.description #=> String
resp.digest #=> String
resp.engine #=> String, one of "WDL", "NEXTFLOW"
resp.id #=> String
resp.main #=> String
resp.name #=> String
resp.parameter_template #=> Hash
resp.parameter_template["WorkflowParameterName"].description #=> String
resp.parameter_template["WorkflowParameterName"].optional #=> Boolean
resp.status #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETED", "FAILED", "INACTIVE"
resp.status_message #=> String
resp.storage_capacity #=> Integer
resp.tags #=> Hash
resp.tags["TagKey"] #=> String
resp.type #=> String, one of "PRIVATE", "SERVICE"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :export (Array<String>) —

    The export format for the workflow.

  • :id (required, String) —

    The workflow's ID.

  • :type (String) —

    The workflow's type.

Returns:

See Also:



2087
2088
2089
2090
 
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2087

def get_workflow(params = {}, options = {})
  req = build_request(:get_workflow, params)
  req.send_request(options)
end

#list_annotation_import_jobs(params = {}) ⇒ Types::ListAnnotationImportJobsResponse

Retrieves a list of annotation import jobs.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_annotation_import_jobs({
  filter: {
    status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, CANCELLED, COMPLETED, FAILED, COMPLETED_WITH_FAILURES
    store_name: "String",
  },
  ids: ["ResourceIdentifier"],
  max_results: 1,
  next_token: "ListAnnotationImportJobsRequestNextTokenString",
})

Response structure


resp.annotation_import_jobs #=> Array
resp.annotation_import_jobs[0].completion_time #=> Time
resp.annotation_import_jobs[0].creation_time #=> Time
resp.annotation_import_jobs[0].destination_name #=> String
resp.annotation_import_jobs[0].id #=> String
resp.annotation_import_jobs[0].role_arn #=> String
resp.annotation_import_jobs[0].run_left_normalization #=> Boolean
resp.annotation_import_jobs[0].status #=> String, one of "SUBMITTED", "IN_PROGRESS", "CANCELLED", "COMPLETED", "FAILED", "COMPLETED_WITH_FAILURES"
resp.annotation_import_jobs[0].update_time #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :filter (Types::ListAnnotationImportJobsFilter) —

    A filter to apply to the list.

  • :ids (Array<String>) —

    IDs of annotation import jobs to retrieve.

  • :max_results (Integer) —

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

  • :next_token (String) —

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

Returns:

See Also:



2143
2144
2145
2146
 
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2143

def list_annotation_import_jobs(params = {}, options = {})
  req = build_request(:list_annotation_import_jobs, params)
  req.send_request(options)
end

#list_annotation_stores(params = {}) ⇒ Types::ListAnnotationStoresResponse

Retrieves a list of annotation stores.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_annotation_stores({
  filter: {
    status: "CREATING", # accepts CREATING, UPDATING, DELETING, ACTIVE, FAILED
  },
  ids: ["ResourceIdentifier"],
  max_results: 1,
  next_token: "ListAnnotationStoresRequestNextTokenString",
})

Response structure


resp.annotation_stores #=> Array
resp.annotation_stores[0].creation_time #=> Time
resp.annotation_stores[0].description #=> String
resp.annotation_stores[0].id #=> String
resp.annotation_stores[0].name #=> String
resp.annotation_stores[0].reference.reference_arn #=> String
resp.annotation_stores[0].sse_config.key_arn #=> String
resp.annotation_stores[0].sse_config.type #=> String, one of "KMS"
resp.annotation_stores[0].status #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "FAILED"
resp.annotation_stores[0].status_message #=> String
resp.annotation_stores[0].store_arn #=> String
resp.annotation_stores[0].store_format #=> String, one of "GFF", "TSV", "VCF"
resp.annotation_stores[0].store_size_bytes #=> Integer
resp.annotation_stores[0].update_time #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :filter (Types::ListAnnotationStoresFilter) —

    A filter to apply to the list.

  • :ids (Array<String>) —

    IDs of stores to list.

  • :max_results (Integer) —

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

  • :next_token (String) —

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

Returns:

See Also:



2203
2204
2205
2206
 
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2203

def list_annotation_stores(params = {}, options = {})
  req = build_request(:list_annotation_stores, params)
  req.send_request(options)
end

#list_read_set_activation_jobs(params = {}) ⇒ Types::ListReadSetActivationJobsResponse

Retrieves a list of read set activation jobs.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_read_set_activation_jobs({
  filter: {
    created_after: Time.now,
    created_before: Time.now,
    status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, CANCELLING, CANCELLED, FAILED, COMPLETED, COMPLETED_WITH_FAILURES
  },
  max_results: 1,
  next_token: "NextToken",
  sequence_store_id: "SequenceStoreId", # required
})

Response structure


resp.activation_jobs #=> Array
resp.activation_jobs[0].completion_time #=> Time
resp.activation_jobs[0].creation_time #=> Time
resp.activation_jobs[0].id #=> String
resp.activation_jobs[0].sequence_store_id #=> String
resp.activation_jobs[0].status #=> String, one of "SUBMITTED", "IN_PROGRESS", "CANCELLING", "CANCELLED", "FAILED", "COMPLETED", "COMPLETED_WITH_FAILURES"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :filter (Types::ActivateReadSetFilter) —

    A filter to apply to the list.

  • :max_results (Integer) —

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

  • :next_token (String) —

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

  • :sequence_store_id (required, String) —

    The read set's sequence store ID.

Returns:

See Also:



2258
2259
2260
2261
 
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2258

def list_read_set_activation_jobs(params = {}, options = {})
  req = build_request(:list_read_set_activation_jobs, params)
  req.send_request(options)
end

#list_read_set_export_jobs(params = {}) ⇒ Types::ListReadSetExportJobsResponse

Retrieves a list of read set export jobs.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_read_set_export_jobs({
  filter: {
    created_after: Time.now,
    created_before: Time.now,
    status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, CANCELLING, CANCELLED, FAILED, COMPLETED, COMPLETED_WITH_FAILURES
  },
  max_results: 1,
  next_token: "NextToken",
  sequence_store_id: "SequenceStoreId", # required
})

Response structure


resp.export_jobs #=> Array
resp.export_jobs[0].completion_time #=> Time
resp.export_jobs[0].creation_time #=> Time
resp.export_jobs[0].destination #=> String
resp.export_jobs[0].id #=> String
resp.export_jobs[0].sequence_store_id #=> String
resp.export_jobs[0].status #=> String, one of "SUBMITTED", "IN_PROGRESS", "CANCELLING", "CANCELLED", "FAILED", "COMPLETED", "COMPLETED_WITH_FAILURES"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :filter (Types::ExportReadSetFilter) —

    A filter to apply to the list.

  • :max_results (Integer) —

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

  • :next_token (String) —

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

  • :sequence_store_id (required, String) —

    The jobs' sequence store ID.

Returns:

See Also:



2313
2314
2315
2316
 
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2313

def list_read_set_export_jobs(params = {}, options = {})
  req = build_request(:list_read_set_export_jobs, params)
  req.send_request(options)
end

#list_read_set_import_jobs(params = {}) ⇒ Types::ListReadSetImportJobsResponse

Retrieves a list of read set import jobs.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_read_set_import_jobs({
  filter: {
    created_after: Time.now,
    created_before: Time.now,
    status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, CANCELLING, CANCELLED, FAILED, COMPLETED, COMPLETED_WITH_FAILURES
  },
  max_results: 1,
  next_token: "NextToken",
  sequence_store_id: "SequenceStoreId", # required
})

Response structure


resp.import_jobs #=> Array
resp.import_jobs[0].completion_time #=> Time
resp.import_jobs[0].creation_time #=> Time
resp.import_jobs[0].id #=> String
resp.import_jobs[0].role_arn #=> String
resp.import_jobs[0].sequence_store_id #=> String
resp.import_jobs[0].status #=> String, one of "SUBMITTED", "IN_PROGRESS", "CANCELLING", "CANCELLED", "FAILED", "COMPLETED", "COMPLETED_WITH_FAILURES"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :filter (Types::ImportReadSetFilter) —

    A filter to apply to the list.

  • :max_results (Integer) —

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

  • :next_token (String) —

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

  • :sequence_store_id (required, String) —

    The jobs' sequence store ID.

Returns:

See Also:



2368
2369
2370
2371
 
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2368

def list_read_set_import_jobs(params = {}, options = {})
  req = build_request(:list_read_set_import_jobs, params)
  req.send_request(options)
end

#list_read_sets(params = {}) ⇒ Types::ListReadSetsResponse

Retrieves a list of read sets.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_read_sets({
  filter: {
    created_after: Time.now,
    created_before: Time.now,
    name: "ReadSetName",
    reference_arn: "ReferenceArn",
    status: "ARCHIVED", # accepts ARCHIVED, ACTIVATING, ACTIVE, DELETING, DELETED
  },
  max_results: 1,
  next_token: "NextToken",
  sequence_store_id: "SequenceStoreId", # required
})

Response structure


resp.next_token #=> String
resp.read_sets #=> Array
resp.read_sets[0].arn #=> String
resp.read_sets[0].creation_time #=> Time
resp.read_sets[0].description #=> String
resp.read_sets[0].file_type #=> String, one of "FASTQ", "BAM", "CRAM"
resp.read_sets[0].id #=> String
resp.read_sets[0].name #=> String
resp.read_sets[0].reference_arn #=> String
resp.read_sets[0].sample_id #=> String
resp.read_sets[0].sequence_information.alignment #=> String
resp.read_sets[0].sequence_information.generated_from #=> String
resp.read_sets[0].sequence_information.total_base_count #=> Integer
resp.read_sets[0].sequence_information.total_read_count #=> Integer
resp.read_sets[0].sequence_store_id #=> String
resp.read_sets[0].status #=> String, one of "ARCHIVED", "ACTIVATING", "ACTIVE", "DELETING", "DELETED"
resp.read_sets[0].subject_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :filter (Types::ReadSetFilter) —

    A filter to apply to the list.

  • :max_results (Integer) —

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

  • :next_token (String) —

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

  • :sequence_store_id (required, String) —

    The jobs' sequence store ID.

Returns:

See Also:



2434
2435
2436
2437
 
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2434

def list_read_sets(params = {}, options = {})
  req = build_request(:list_read_sets, params)
  req.send_request(options)
end

#list_reference_import_jobs(params = {}) ⇒ Types::ListReferenceImportJobsResponse

Retrieves a list of reference import jobs.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_reference_import_jobs({
  filter: {
    created_after: Time.now,
    created_before: Time.now,
    status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, CANCELLING, CANCELLED, FAILED, COMPLETED, COMPLETED_WITH_FAILURES
  },
  max_results: 1,
  next_token: "NextToken",
  reference_store_id: "ReferenceStoreId", # required
})

Response structure


resp.import_jobs #=> Array
resp.import_jobs[0].completion_time #=> Time
resp.import_jobs[0].creation_time #=> Time
resp.import_jobs[0].id #=> String
resp.import_jobs[0].reference_store_id #=> String
resp.import_jobs[0].role_arn #=> String
resp.import_jobs[0].status #=> String, one of "SUBMITTED", "IN_PROGRESS", "CANCELLING", "CANCELLED", "FAILED", "COMPLETED", "COMPLETED_WITH_FAILURES"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :filter (Types::ImportReferenceFilter) —

    A filter to apply to the list.

  • :max_results (Integer) —

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

  • :next_token (String) —

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

  • :reference_store_id (required, String) —

    The job's reference store ID.

Returns:

See Also:



2489
2490
2491
2492
 
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2489

def list_reference_import_jobs(params = {}, options = {})
  req = build_request(:list_reference_import_jobs, params)
  req.send_request(options)
end

#list_reference_stores(params = {}) ⇒ Types::ListReferenceStoresResponse

Retrieves a list of reference stores.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_reference_stores({
  filter: {
    created_after: Time.now,
    created_before: Time.now,
    name: "ReferenceStoreName",
  },
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.next_token #=> String
resp.reference_stores #=> Array
resp.reference_stores[0].arn #=> String
resp.reference_stores[0].creation_time #=> Time
resp.reference_stores[0].description #=> String
resp.reference_stores[0].id #=> String
resp.reference_stores[0].name #=> String
resp.reference_stores[0].sse_config.key_arn #=> String
resp.reference_stores[0].sse_config.type #=> String, one of "KMS"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :filter (Types::ReferenceStoreFilter) —

    A filter to apply to the list.

  • :max_results (Integer) —

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

  • :next_token (String) —

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

Returns:

See Also:



2541
2542
2543
2544
 
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2541

def list_reference_stores(params = {}, options = {})
  req = build_request(:list_reference_stores, params)
  req.send_request(options)
end

#list_references(params = {}) ⇒ Types::ListReferencesResponse

Retrieves a list of references.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_references({
  filter: {
    created_after: Time.now,
    created_before: Time.now,
    md5: "Md5",
    name: "ReferenceName",
  },
  max_results: 1,
  next_token: "NextToken",
  reference_store_id: "ReferenceStoreId", # required
})

Response structure


resp.next_token #=> String
resp.references #=> Array
resp.references[0].arn #=> String
resp.references[0].creation_time #=> Time
resp.references[0].description #=> String
resp.references[0].id #=> String
resp.references[0].md5 #=> String
resp.references[0].name #=> String
resp.references[0].reference_store_id #=> String
resp.references[0].status #=> String, one of "ACTIVE", "DELETING", "DELETED"
resp.references[0].update_time #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :filter (Types::ReferenceFilter) —

    A filter to apply to the list.

  • :max_results (Integer) —

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

  • :next_token (String) —

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

  • :reference_store_id (required, String) —

    The references' reference store ID.

Returns:

See Also:



2600
2601
2602
2603
 
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2600

def list_references(params = {}, options = {})
  req = build_request(:list_references, params)
  req.send_request(options)
end

#list_run_groups(params = {}) ⇒ Types::ListRunGroupsResponse

Retrieves a list of run groups.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_run_groups({
  max_results: 1,
  name: "RunGroupName",
  starting_token: "RunGroupListToken",
})

Response structure


resp.items #=> Array
resp.items[0].arn #=> String
resp.items[0].creation_time #=> Time
resp.items[0].id #=> String
resp.items[0].max_cpus #=> Integer
resp.items[0].max_duration #=> Integer
resp.items[0].max_runs #=> Integer
resp.items[0].name #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer) —

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

  • :name (String) —

    The run groups' name.

  • :starting_token (String) —

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

Returns:

See Also:



2648
2649
2650
2651
 
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2648

def list_run_groups(params = {}, options = {})
  req = build_request(:list_run_groups, params)
  req.send_request(options)
end

#list_run_tasks(params = {}) ⇒ Types::ListRunTasksResponse

Retrieves a list of tasks for a run.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_run_tasks({
  id: "RunId", # required
  max_results: 1,
  starting_token: "TaskListToken",
  status: "PENDING", # accepts PENDING, STARTING, RUNNING, STOPPING, COMPLETED, CANCELLED, FAILED
})

Response structure


resp.items #=> Array
resp.items[0].cpus #=> Integer
resp.items[0].creation_time #=> Time
resp.items[0].memory #=> Integer
resp.items[0].name #=> String
resp.items[0].start_time #=> Time
resp.items[0].status #=> String, one of "PENDING", "STARTING", "RUNNING", "STOPPING", "COMPLETED", "CANCELLED", "FAILED"
resp.items[0].stop_time #=> Time
resp.items[0].task_id #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :id (required, String) —

    The run's ID.

  • :max_results (Integer) —

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

  • :starting_token (String) —

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

  • :status (String) —

    Filter the list by status.

Returns:

See Also:



2701
2702
2703
2704
 
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2701

def list_run_tasks(params = {}, options = {})
  req = build_request(:list_run_tasks, params)
  req.send_request(options)
end

#list_runs(params = {}) ⇒ Types::ListRunsResponse

Retrieves a list of runs.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_runs({
  max_results: 1,
  name: "RunName",
  run_group_id: "RunGroupId",
  starting_token: "RunListToken",
})

Response structure


resp.items #=> Array
resp.items[0].arn #=> String
resp.items[0].creation_time #=> Time
resp.items[0].id #=> String
resp.items[0].name #=> String
resp.items[0].priority #=> Integer
resp.items[0].start_time #=> Time
resp.items[0].status #=> String, one of "PENDING", "STARTING", "RUNNING", "STOPPING", "COMPLETED", "DELETED", "CANCELLED", "FAILED"
resp.items[0].stop_time #=> Time
resp.items[0].storage_capacity #=> Integer
resp.items[0].workflow_id #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer) —

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

  • :name (String) —

    Filter the list by run name.

  • :run_group_id (String) —

    Filter the list by run group ID.

  • :starting_token (String) —

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

Returns:

See Also:



2756
2757
2758
2759
 
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2756

def list_runs(params = {}, options = {})
  req = build_request(:list_runs, params)
  req.send_request(options)
end

#list_sequence_stores(params = {}) ⇒ Types::ListSequenceStoresResponse

Retrieves a list of sequence stores.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_sequence_stores({
  filter: {
    created_after: Time.now,
    created_before: Time.now,
    name: "SequenceStoreName",
  },
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.next_token #=> String
resp.sequence_stores #=> Array
resp.sequence_stores[0].arn #=> String
resp.sequence_stores[0].creation_time #=> Time
resp.sequence_stores[0].description #=> String
resp.sequence_stores[0].id #=> String
resp.sequence_stores[0].name #=> String
resp.sequence_stores[0].sse_config.key_arn #=> String
resp.sequence_stores[0].sse_config.type #=> String, one of "KMS"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :filter (Types::SequenceStoreFilter) —

    A filter to apply to the list.

  • :max_results (Integer) —

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

  • :next_token (String) —

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

Returns:

See Also:



2808
2809
2810
2811
 
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2808

def list_sequence_stores(params = {}, options = {})
  req = build_request(:list_sequence_stores, params)
  req.send_request(options)
end

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse

Retrieves a list of tags for a resource.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "TagArn", # required
})

Response structure


resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The resource's ARN.

Returns:

See Also:



2837
2838
2839
2840
 
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2837

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
end

#list_variant_import_jobs(params = {}) ⇒ Types::ListVariantImportJobsResponse

Retrieves a list of variant import jobs.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_variant_import_jobs({
  filter: {
    status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, CANCELLED, COMPLETED, FAILED, COMPLETED_WITH_FAILURES
    store_name: "String",
  },
  ids: ["ResourceIdentifier"],
  max_results: 1,
  next_token: "ListVariantImportJobsRequestNextTokenString",
})

Response structure


resp.next_token #=> String
resp.variant_import_jobs #=> Array
resp.variant_import_jobs[0].completion_time #=> Time
resp.variant_import_jobs[0].creation_time #=> Time
resp.variant_import_jobs[0].destination_name #=> String
resp.variant_import_jobs[0].id #=> String
resp.variant_import_jobs[0].role_arn #=> String
resp.variant_import_jobs[0].run_left_normalization #=> Boolean
resp.variant_import_jobs[0].status #=> String, one of "SUBMITTED", "IN_PROGRESS", "CANCELLED", "COMPLETED", "FAILED", "COMPLETED_WITH_FAILURES"
resp.variant_import_jobs[0].update_time #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :filter (Types::ListVariantImportJobsFilter) —

    A filter to apply to the list.

  • :ids (Array<String>) —

    A list of job IDs.

  • :max_results (Integer) —

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

  • :next_token (String) —

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

Returns:

See Also:



2893
2894
2895
2896
 
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2893

def list_variant_import_jobs(params = {}, options = {})
  req = build_request(:list_variant_import_jobs, params)
  req.send_request(options)
end

#list_variant_stores(params = {}) ⇒ Types::ListVariantStoresResponse

Retrieves a list of variant stores.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_variant_stores({
  filter: {
    status: "CREATING", # accepts CREATING, UPDATING, DELETING, ACTIVE, FAILED
  },
  ids: ["ResourceIdentifier"],
  max_results: 1,
  next_token: "ListVariantStoresRequestNextTokenString",
})

Response structure


resp.next_token #=> String
resp.variant_stores #=> Array
resp.variant_stores[0].creation_time #=> Time
resp.variant_stores[0].description #=> String
resp.variant_stores[0].id #=> String
resp.variant_stores[0].name #=> String
resp.variant_stores[0].reference.reference_arn #=> String
resp.variant_stores[0].sse_config.key_arn #=> String
resp.variant_stores[0].sse_config.type #=> String, one of "KMS"
resp.variant_stores[0].status #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "FAILED"
resp.variant_stores[0].status_message #=> String
resp.variant_stores[0].store_arn #=> String
resp.variant_stores[0].store_size_bytes #=> Integer
resp.variant_stores[0].update_time #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :filter (Types::ListVariantStoresFilter) —

    A filter to apply to the list.

  • :ids (Array<String>) —

    A list of store IDs.

  • :max_results (Integer) —

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

  • :next_token (String) —

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

Returns:

See Also:



2952
2953
2954
2955
 
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2952

def list_variant_stores(params = {}, options = {})
  req = build_request(:list_variant_stores, params)
  req.send_request(options)
end

#list_workflows(params = {}) ⇒ Types::ListWorkflowsResponse

Retrieves a list of workflows.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_workflows({
  max_results: 1,
  name: "WorkflowName",
  starting_token: "WorkflowListToken",
  type: "PRIVATE", # accepts PRIVATE, SERVICE
})

Response structure


resp.items #=> Array
resp.items[0].arn #=> String
resp.items[0].creation_time #=> Time
resp.items[0].digest #=> String
resp.items[0].id #=> String
resp.items[0].name #=> String
resp.items[0].status #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETED", "FAILED", "INACTIVE"
resp.items[0].type #=> String, one of "PRIVATE", "SERVICE"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer) —

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

  • :name (String) —

    The workflows' name.

  • :starting_token (String) —

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

  • :type (String) —

    The workflows' type.

Returns:

See Also:



3004
3005
3006
3007
 
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3004

def list_workflows(params = {}, options = {})
  req = build_request(:list_workflows, params)
  req.send_request(options)
end

#start_annotation_import_job(params = {}) ⇒ Types::StartAnnotationImportResponse

Starts an annotation import job.

Examples:

Request syntax with placeholder values


resp = client.start_annotation_import_job({
  destination_name: "StoreName", # required
  format_options: {
    tsv_options: {
      read_options: {
        comment: "CommentChar",
        encoding: "Encoding",
        escape: "EscapeChar",
        escape_quotes: false,
        header: false,
        line_sep: "LineSep",
        quote: "Quote",
        quote_all: false,
        sep: "Separator",
      },
    },
    vcf_options: {
      ignore_filter_field: false,
      ignore_qual_field: false,
    },
  },
  items: [ # required
    {
      source: "S3Uri", # required
    },
  ],
  role_arn: "Arn", # required
  run_left_normalization: false,
})

Response structure


resp.job_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :destination_name (required, String) —

    A destination annotation store for the job.

  • :format_options (Types::FormatOptions) —

    Formatting options for the annotation file.

  • :items (required, Array<Types::AnnotationImportItemSource>) —

    Items to import.

  • :role_arn (required, String) —

    A service role for the job.

  • :run_left_normalization (Boolean) —

    The job's left normalization setting.

Returns:

See Also:



3070
3071
3072
3073
 
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3070

def start_annotation_import_job(params = {}, options = {})
  req = build_request(:start_annotation_import_job, params)
  req.send_request(options)
end

#start_read_set_activation_job(params = {}) ⇒ Types::StartReadSetActivationJobResponse

Activates an archived read set. To reduce storage charges, Amazon Omics archives unused read sets after 30 days.

Examples:

Request syntax with placeholder values


resp = client.start_read_set_activation_job({
  client_token: "ClientToken",
  sequence_store_id: "SequenceStoreId", # required
  sources: [ # required
    {
      read_set_id: "ReadSetId", # required
    },
  ],
})

Response structure


resp.creation_time #=> Time
resp.id #=> String
resp.sequence_store_id #=> String
resp.status #=> String, one of "SUBMITTED", "IN_PROGRESS", "CANCELLING", "CANCELLED", "FAILED", "COMPLETED", "COMPLETED_WITH_FAILURES"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :client_token (String) —

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

  • :sequence_store_id (required, String) —

    The read set's sequence store ID.

  • :sources (required, Array<Types::StartReadSetActivationJobSourceItem>) —

    The job's source files.

Returns:

See Also:



3118
3119
3120
3121
 
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3118

def start_read_set_activation_job(params = {}, options = {})
  req = build_request(:start_read_set_activation_job, params)
  req.send_request(options)
end

#start_read_set_export_job(params = {}) ⇒ Types::StartReadSetExportJobResponse

Exports a read set to Amazon S3.

Examples:

Request syntax with placeholder values


resp = client.start_read_set_export_job({
  client_token: "ClientToken",
  destination: "S3Destination", # required
  role_arn: "RoleArn", # required
  sequence_store_id: "SequenceStoreId", # required
  sources: [ # required
    {
      read_set_id: "ReadSetId", # required
    },
  ],
})

Response structure


resp.creation_time #=> Time
resp.destination #=> String
resp.id #=> String
resp.sequence_store_id #=> String
resp.status #=> String, one of "SUBMITTED", "IN_PROGRESS", "CANCELLING", "CANCELLED", "FAILED", "COMPLETED", "COMPLETED_WITH_FAILURES"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :client_token (String) —

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

  • :destination (required, String) —

    A location for exported files in Amazon S3.

  • :role_arn (required, String) —

    A service role for the job.

  • :sequence_store_id (required, String) —

    The read set's sequence store ID.

  • :sources (required, Array<Types::ExportReadSet>) —

    The job's source files.

Returns:

See Also:



3175
3176
3177
3178
 
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3175

def start_read_set_export_job(params = {}, options = {})
  req = build_request(:start_read_set_export_job, params)
  req.send_request(options)
end

#start_read_set_import_job(params = {}) ⇒ Types::StartReadSetImportJobResponse

Starts a read set import job.

Examples:

Request syntax with placeholder values


resp = client.start_read_set_import_job({
  client_token: "ClientToken",
  role_arn: "RoleArn", # required
  sequence_store_id: "SequenceStoreId", # required
  sources: [ # required
    {
      description: "ReadSetDescription",
      generated_from: "GeneratedFrom",
      name: "ReadSetName",
      reference_arn: "ReferenceArn", # required
      sample_id: "SampleId", # required
      source_file_type: "FASTQ", # required, accepts FASTQ, BAM, CRAM
      source_files: { # required
        source1: "S3Uri", # required
        source2: "S3Uri",
      },
      subject_id: "SubjectId", # required
      tags: {
        "TagKey" => "TagValue",
      },
    },
  ],
})

Response structure


resp.creation_time #=> Time
resp.id #=> String
resp.role_arn #=> String
resp.sequence_store_id #=> String
resp.status #=> String, one of "SUBMITTED", "IN_PROGRESS", "CANCELLING", "CANCELLED", "FAILED", "COMPLETED", "COMPLETED_WITH_FAILURES"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :client_token (String) —

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

  • :role_arn (required, String) —

    A service role for the job.

  • :sequence_store_id (required, String) —

    The read set's sequence store ID.

  • :sources (required, Array<Types::StartReadSetImportJobSourceItem>) —

    The job's source files.

Returns:

See Also:



3241
3242
3243
3244
 
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3241

def start_read_set_import_job(params = {}, options = {})
  req = build_request(:start_read_set_import_job, params)
  req.send_request(options)
end

#start_reference_import_job(params = {}) ⇒ Types::StartReferenceImportJobResponse

Starts a reference import job.

Examples:

Request syntax with placeholder values


resp = client.start_reference_import_job({
  client_token: "ClientToken",
  reference_store_id: "ReferenceStoreId", # required
  role_arn: "RoleArn", # required
  sources: [ # required
    {
      description: "ReferenceDescription",
      name: "ReferenceName", # required
      source_file: "S3Uri", # required
      tags: {
        "TagKey" => "TagValue",
      },
    },
  ],
})

Response structure


resp.creation_time #=> Time
resp.id #=> String
resp.reference_store_id #=> String
resp.role_arn #=> String
resp.status #=> String, one of "SUBMITTED", "IN_PROGRESS", "CANCELLING", "CANCELLED", "FAILED", "COMPLETED", "COMPLETED_WITH_FAILURES"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :client_token (String) —

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

  • :reference_store_id (required, String) —

    The job's reference store ID.

  • :role_arn (required, String) —

    A service role for the job.

  • :sources (required, Array<Types::StartReferenceImportJobSourceItem>) —

    The job's source files.

Returns:

See Also:



3299
3300
3301
3302
 
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3299

def start_reference_import_job(params = {}, options = {})
  req = build_request(:start_reference_import_job, params)
  req.send_request(options)
end

#start_run(params = {}) ⇒ Types::StartRunResponse

Starts a run.

Examples:

Request syntax with placeholder values


resp = client.start_run({
  log_level: "OFF", # accepts OFF, FATAL, ERROR, ALL
  name: "RunName",
  output_uri: "RunOutputUri",
  parameters: {
  },
  priority: 1,
  request_id: "RunRequestId", # required
  role_arn: "RunRoleArn", # required
  run_group_id: "RunGroupId",
  run_id: "RunId",
  storage_capacity: 1,
  tags: {
    "TagKey" => "TagValue",
  },
  workflow_id: "WorkflowId",
  workflow_type: "PRIVATE", # accepts PRIVATE, SERVICE
})

Response structure


resp.arn #=> String
resp.id #=> String
resp.status #=> String, one of "PENDING", "STARTING", "RUNNING", "STOPPING", "COMPLETED", "DELETED", "CANCELLED", "FAILED"
resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :log_level (String) —

    A log level for the run.

  • :name (String) —

    A name for the run.

  • :output_uri (String) —

    An output URI for the run.

  • :parameters (Hash, Array, String, Numeric, Boolean) —

    Parameters for the run.

    Document type used to carry open content (Hash,Array,String,Numeric,Boolean). A document type value is serialized using the same format as its surroundings and requires no additional encoding or escaping.

  • :priority (Integer) —

    A priority for the run.

  • :request_id (required, String) —

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

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

  • :role_arn (required, String) —

    A service role for the run.

  • :run_group_id (String) —

    The run's group ID.

  • :run_id (String) —

    The run's ID.

  • :storage_capacity (Integer) —

    A storage capacity for the run in gigabytes.

  • :tags (Hash<String,String>) —

    Tags for the run.

  • :workflow_id (String) —

    The run's workflow ID.

  • :workflow_type (String) —

    The run's workflows type.

Returns:

See Also:



3394
3395
3396
3397
 
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3394

def start_run(params = {}, options = {})
  req = build_request(:start_run, params)
  req.send_request(options)
end

#start_variant_import_job(params = {}) ⇒ Types::StartVariantImportResponse

Starts a variant import job.

Examples:

Request syntax with placeholder values


resp = client.start_variant_import_job({
  destination_name: "StoreName", # required
  items: [ # required
    {
      source: "S3Uri", # required
    },
  ],
  role_arn: "Arn", # required
  run_left_normalization: false,
})

Response structure


resp.job_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :destination_name (required, String) —

    The destination variant store for the job.

  • :items (required, Array<Types::VariantImportItemSource>) —

    Items to import.

  • :role_arn (required, String) —

    A service role for the job.

  • :run_left_normalization (Boolean) —

    The job's left normalization setting.

Returns:

See Also:



3438
3439
3440
3441
 
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3438

def start_variant_import_job(params = {}, options = {})
  req = build_request(:start_variant_import_job, params)
  req.send_request(options)
end

#tag_resource(params = {}) ⇒ Struct

Tags a resource.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "TagArn", # required
  tags: { # required
    "TagKey" => "TagValue",
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The resource's ARN.

  • :tags (required, Hash<String,String>) —

    Tags for the resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3466
3467
3468
3469
 
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3466

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ Struct

Removes tags from a resource.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "TagArn", # required
  tag_keys: ["TagKey"], # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The resource's ARN.

  • :tag_keys (required, Array<String>) —

    Keys of tags to remove.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3492
3493
3494
3495
 
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3492

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end

#update_annotation_store(params = {}) ⇒ Types::UpdateAnnotationStoreResponse

Updates an annotation store.

Examples:

Request syntax with placeholder values


resp = client.update_annotation_store({
  description: "StoreDescription",
  name: "String", # required
})

Response structure


resp.creation_time #=> Time
resp.description #=> String
resp.id #=> String
resp.name #=> String
resp.reference.reference_arn #=> String
resp.status #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "FAILED"
resp.store_format #=> String, one of "GFF", "TSV", "VCF"
resp.store_options.tsv_store_options.annotation_type #=> String, one of "GENERIC", "CHR_POS", "CHR_POS_REF_ALT", "CHR_START_END_ONE_BASE", "CHR_START_END_REF_ALT_ONE_BASE", "CHR_START_END_ZERO_BASE", "CHR_START_END_REF_ALT_ZERO_BASE"
resp.store_options.tsv_store_options.format_to_header #=> Hash
resp.store_options.tsv_store_options.format_to_header["FormatToHeaderKey"] #=> String
resp.store_options.tsv_store_options.schema #=> Array
resp.store_options.tsv_store_options.schema[0] #=> Hash
resp.store_options.tsv_store_options.schema[0]["SchemaItemKeyString"] #=> String, one of "LONG", "INT", "STRING", "FLOAT", "DOUBLE", "BOOLEAN"
resp.update_time #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :description (String) —

    A description for the store.

  • :name (required, String) —

    A name for the store.

Returns:

See Also:



3545
3546
3547
3548
 
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3545

def update_annotation_store(params = {}, options = {})
  req = build_request(:update_annotation_store, params)
  req.send_request(options)
end

#update_run_group(params = {}) ⇒ Struct

Updates a run group.

Examples:

Request syntax with placeholder values


resp = client.update_run_group({
  id: "RunGroupId", # required
  max_cpus: 1,
  max_duration: 1,
  max_runs: 1,
  name: "RunGroupName",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :id (required, String) —

    The group's ID.

  • :max_cpus (Integer) —

    The maximum number of CPUs to use.

  • :max_duration (Integer) —

    A maximum run time for the group in minutes.

  • :max_runs (Integer) —

    The maximum number of concurrent runs for the group.

  • :name (String) —

    A name for the group.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3583
3584
3585
3586
 
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3583

def update_run_group(params = {}, options = {})
  req = build_request(:update_run_group, params)
  req.send_request(options)
end

#update_variant_store(params = {}) ⇒ Types::UpdateVariantStoreResponse

Updates a variant store.

Examples:

Request syntax with placeholder values


resp = client.update_variant_store({
  description: "StoreDescription",
  name: "String", # required
})

Response structure


resp.creation_time #=> Time
resp.description #=> String
resp.id #=> String
resp.name #=> String
resp.reference.reference_arn #=> String
resp.status #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "FAILED"
resp.update_time #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :description (String) —

    A description for the store.

  • :name (required, String) —

    A name for the store.

Returns:

See Also:



3627
3628
3629
3630
 
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3627

def update_variant_store(params = {}, options = {})
  req = build_request(:update_variant_store, params)
  req.send_request(options)
end

#update_workflow(params = {}) ⇒ Struct

Updates a workflow.

Examples:

Request syntax with placeholder values


resp = client.update_workflow({
  description: "WorkflowDescription",
  id: "WorkflowId", # required
  name: "WorkflowName",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :description (String) —

    A description for the workflow.

  • :id (required, String) —

    The workflow's ID.

  • :name (String) —

    A name for the workflow.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3657
3658
3659
3660
 
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3657

def update_workflow(params = {}, options = {})
  req = build_request(:update_workflow, params)
  req.send_request(options)
end

#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean

Polls an API operation until a resource enters a desired state.

Basic Usage

A waiter will call an API operation until:

  • It is successful
  • It enters a terminal state
  • It makes the maximum number of attempts

In between attempts, the waiter will sleep.

# polls in a loop, sleeping between attempts
client.wait_until(waiter_name, params)

Configuration

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You can pass configuration as the final arguments hash.

# poll for ~25 seconds
client.wait_until(waiter_name, params, {
  max_attempts: 5,
  delay: 5,
})

Callbacks

You can be notified before each polling attempt and before each delay. If you throw :success or :failure from these callbacks, it will terminate the waiter.

started_at = Time.now
client.wait_until(waiter_name, params, {

  # disable max attempts
  max_attempts: nil,

  # poll for 1 hour, instead of a number of attempts
  before_wait: -> (attempts, response) do
    throw :failure if Time.now - started_at > 3600
  end
})

Handling Errors

When a waiter is unsuccessful, it will raise an error. All of the failure errors extend from Waiters::Errors::WaiterFailed.

begin
  client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end

Valid Waiters

The following table lists the valid waiter names, the operations they call, and the default :delay and :max_attempts values.

waiter_name params :delay :max_attempts
annotation_import_job_created #get_annotation_import_job 30 20
annotation_store_created #get_annotation_store 30 20
annotation_store_deleted #get_annotation_store 30 20
read_set_activation_job_completed #get_read_set_activation_job 30 20
read_set_export_job_completed #get_read_set_export_job 30 20
read_set_import_job_completed #get_read_set_import_job 30 20
reference_import_job_completed #get_reference_import_job 30 20
run_completed #get_run 30 20
run_running #get_run 30 20
task_completed #get_run_task 30 20
task_running #get_run_task 30 20
variant_import_job_created #get_variant_import_job 30 20
variant_store_created #get_variant_store 30 20
variant_store_deleted #get_variant_store 30 20
workflow_active #get_workflow 3 10

Parameters:

  • waiter_name (Symbol)
  • params (Hash) (defaults to: {}) —

    ({})

  • options (Hash) (defaults to: {}) —

    ({})

Options Hash (options):

  • :max_attempts (Integer)
  • :delay (Integer)
  • :before_attempt (Proc)
  • :before_wait (Proc)

Yields:

  • (w.waiter)

Returns:

  • (Boolean) —

    Returns true if the waiter was successful.

Raises:

  • (Errors::FailureStateError) —

    Raised when the waiter terminates because the waiter has entered a state that it will not transition out of, preventing success.

  • (Errors::TooManyAttemptsError) —

    Raised when the configured maximum number of attempts have been made, and the waiter is not yet successful.

  • (Errors::UnexpectedError) —

    Raised when an error is encounted while polling for a resource that is not expected.

  • (Errors::NoSuchWaiterError) —

    Raised when you request to wait for an unknown state.



3781
3782
3783
3784
3785
 
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3781

def wait_until(waiter_name, params = {}, options = {})
  w = waiter(waiter_name, options)
  yield(w.waiter) if block_given? # deprecated
  w.wait(params)
end