lib/aws-sdk-omics/client.rb in aws-sdk-omics-1.25.0 vs lib/aws-sdk-omics/client.rb in aws-sdk-omics-1.26.0
- old
+ new
@@ -436,14 +436,14 @@
def abort_multipart_read_set_upload(params = {}, options = {})
req = build_request(:abort_multipart_read_set_upload, params)
req.send_request(options)
end
- # Accepts a share for an analytics store.
+ # Accept a resource share request.
#
# @option params [required, String] :share_id
- # The ID for a share offer for analytics store data.
+ # The ID of the resource share.
#
# @return [Types::AcceptShareResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::AcceptShareResponse#status #status} => String
#
@@ -1067,23 +1067,31 @@
def create_sequence_store(params = {}, options = {})
req = build_request(:create_sequence_store, params)
req.send_request(options)
end
- # Creates a share offer that can be accepted outside the account by a
- # subscriber. The share is created by the owner and accepted by the
- # principal subscriber.
+ # Creates a cross-account shared resource. The resource owner makes an
+ # offer to share the resource with the principal subscriber (an AWS user
+ # with a different account than the resource owner).
#
+ # The following resources support cross-account sharing:
+ #
+ # * Healthomics variant stores
+ #
+ # * Healthomics annotation stores
+ #
+ # * Private workflows
+ #
# @option params [required, String] :resource_arn
- # The resource ARN for the analytics store to be shared.
+ # The ARN of the resource to be shared.
#
# @option params [required, String] :principal_subscriber
- # The principal subscriber is the account being given access to the
- # analytics store data through the share offer.
+ # The principal subscriber is the account being offered shared access to
+ # the resource.
#
# @option params [String] :share_name
- # A name given to the share.
+ # A name that the owner defines for the share.
#
# @return [Types::CreateShareResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::CreateShareResponse#share_id #share_id} => String
# * {Types::CreateShareResponse#status #status} => String
@@ -1193,11 +1201,11 @@
#
# @option params [Hash<String,Types::WorkflowParameter>] :parameter_template
# A parameter template for the workflow.
#
# @option params [Integer] :storage_capacity
- # A storage capacity for the workflow in gibibytes.
+ # The storage capacity for the workflow in gibibytes.
#
# @option params [Hash<String,String>] :tags
# Tags for the workflow.
#
# @option params [required, String] :request_id
@@ -1441,14 +1449,16 @@
def delete_sequence_store(params = {}, options = {})
req = build_request(:delete_sequence_store, params)
req.send_request(options)
end
- # Deletes a share of an analytics store.
+ # Deletes a resource share. If you are the resource owner, the
+ # subscriber will no longer have access to the shared resource. If you
+ # are the subscriber, this operation deletes your access to the share.
#
# @option params [required, String] :share_id
- # The ID for the share request to be deleted.
+ # The ID for the resource share to be deleted.
#
# @return [Types::DeleteShareResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::DeleteShareResponse#status #status} => String
#
@@ -2220,10 +2230,13 @@
req.send_request(options)
end
# Gets information about a workflow run.
#
+ # If a workflow is shared with you, you cannot export information about
+ # the run.
+ #
# @option params [required, String] :id
# The run's ID.
#
# @option params [Array<String>] :export
# The run's export format.
@@ -2257,10 +2270,12 @@
# * {Types::GetRunResponse#retention_mode #retention_mode} => String
# * {Types::GetRunResponse#failure_reason #failure_reason} => String
# * {Types::GetRunResponse#log_location #log_location} => Types::RunLogLocation
# * {Types::GetRunResponse#uuid #uuid} => String
# * {Types::GetRunResponse#run_output_uri #run_output_uri} => String
+ # * {Types::GetRunResponse#storage_type #storage_type} => String
+ # * {Types::GetRunResponse#workflow_owner_id #workflow_owner_id} => String
#
# @example Request syntax with placeholder values
#
# resp = client.get_run({
# id: "RunId", # required
@@ -2298,10 +2313,12 @@
# resp.failure_reason #=> String
# resp.log_location.engine_log_stream #=> String
# resp.log_location.run_log_stream #=> String
# resp.uuid #=> String
# resp.run_output_uri #=> String
+ # resp.storage_type #=> String, one of "STATIC", "DYNAMIC"
+ # resp.workflow_owner_id #=> String
#
#
# The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
#
# * run_completed
@@ -2467,14 +2484,14 @@
def get_sequence_store(params = {}, options = {})
req = build_request(:get_sequence_store, params)
req.send_request(options)
end
- # Retrieves the metadata for a share.
+ # Retrieves the metadata for the specified resource share.
#
# @option params [required, String] :share_id
- # The generated ID for a share.
+ # The ID of the share.
#
# @return [Types::GetShareResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::GetShareResponse#share #share} => Types::ShareDetails
#
@@ -2486,10 +2503,11 @@
#
# @example Response structure
#
# resp.share.share_id #=> String
# resp.share.resource_arn #=> String
+ # resp.share.resource_id #=> String
# resp.share.principal_subscriber #=> String
# resp.share.owner_id #=> String
# resp.share.status #=> String, one of "PENDING", "ACTIVATING", "ACTIVE", "DELETING", "DELETED", "FAILED"
# resp.share.status_message #=> String
# resp.share.share_name #=> String
@@ -2620,19 +2638,24 @@
req.send_request(options)
end
# Gets information about a workflow.
#
+ # If a workflow is shared with you, you cannot export the workflow.
+ #
# @option params [required, String] :id
# The workflow's ID.
#
# @option params [String] :type
# The workflow's type.
#
# @option params [Array<String>] :export
# The export format for the workflow.
#
+ # @option params [String] :workflow_owner_id
+ # The ID of the workflow owner.
+ #
# @return [Types::GetWorkflowResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::GetWorkflowResponse#arn #arn} => String
# * {Types::GetWorkflowResponse#id #id} => String
# * {Types::GetWorkflowResponse#status #status} => String
@@ -2655,10 +2678,11 @@
#
# resp = client.get_workflow({
# id: "WorkflowId", # required
# type: "PRIVATE", # accepts PRIVATE, READY2RUN
# export: ["DEFINITION"], # accepts DEFINITION
+ # workflow_owner_id: "WorkflowOwnerId",
# })
#
# @example Response structure
#
# resp.arn #=> String
@@ -3552,10 +3576,11 @@
# resp.items[0].priority #=> Integer
# resp.items[0].storage_capacity #=> Integer
# resp.items[0].creation_time #=> Time
# resp.items[0].start_time #=> Time
# resp.items[0].stop_time #=> Time
+ # resp.items[0].storage_type #=> String, one of "STATIC", "DYNAMIC"
# resp.next_token #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/ListRuns AWS API Documentation
#
# @overload list_runs(params = {})
@@ -3617,17 +3642,19 @@
def list_sequence_stores(params = {}, options = {})
req = build_request(:list_sequence_stores, params)
req.send_request(options)
end
- # Lists all shares associated with an account.
+ # Retrieves the resource shares associated with an account. Use the
+ # filter parameter to retrieve a specific subset of the shares.
#
# @option params [required, String] :resource_owner
- # The account that owns the analytics store shared.
+ # The account that owns the resource shares.
#
# @option params [Types::Filter] :filter
- # Attributes used to filter for a specific subset of shares.
+ # Attributes that you use to filter for a specific subset of resource
+ # shares.
#
# @option params [String] :next_token
# Next token returned in the response of a previous
# ListReadSetUploadPartsRequest call. Used to get the next page of
# results.
@@ -3647,20 +3674,22 @@
# resp = client.list_shares({
# resource_owner: "SELF", # required, accepts SELF, OTHER
# filter: {
# resource_arns: ["String"],
# status: ["PENDING"], # accepts PENDING, ACTIVATING, ACTIVE, DELETING, DELETED, FAILED
+ # type: ["VARIANT_STORE"], # accepts VARIANT_STORE, ANNOTATION_STORE, WORKFLOW
# },
# next_token: "String",
# max_results: 1,
# })
#
# @example Response structure
#
# resp.shares #=> Array
# resp.shares[0].share_id #=> String
# resp.shares[0].resource_arn #=> String
+ # resp.shares[0].resource_id #=> String
# resp.shares[0].principal_subscriber #=> String
# resp.shares[0].owner_id #=> String
# resp.shares[0].status #=> String, one of "PENDING", "ACTIVATING", "ACTIVE", "DELETING", "DELETED", "FAILED"
# resp.shares[0].status_message #=> String
# resp.shares[0].share_name #=> String
@@ -3824,14 +3853,14 @@
end
# Retrieves a list of workflows.
#
# @option params [String] :type
- # The workflows' type.
+ # Filter the list by workflow type.
#
# @option params [String] :name
- # The workflows' name.
+ # Filter the list by workflow name.
#
# @option params [String] :starting_token
# Specify the pagination token from a previous request to retrieve the
# next page of results.
#
@@ -4183,15 +4212,29 @@
end
# Starts a workflow run. To duplicate a run, specify the run's ID and a
# role ARN. The remaining parameters are copied from the previous run.
#
+ # StartRun will not support re-run for a workflow that is shared with
+ # you.
+ #
# The total number of runs in your account is subject to a quota per
# Region. To avoid needing to delete runs manually, you can set the
# retention mode to `REMOVE`. Runs with this setting are deleted
# automatically when the run quoata is exceeded.
#
+ # By default, the run uses STATIC storage. For STATIC storage, set the
+ # `storageCapacity` field. You can set the storage type to DYNAMIC. You
+ # do not set `storageCapacity`, because HealthOmics dynamically scales
+ # the storage up or down as required. For more information about static
+ # and dynamic storage, see [Running workflows][1] in the *AWS
+ # HealthOmics User Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/omics/latest/dev/Using-workflows.html
+ #
# @option params [String] :workflow_id
# The run's workflow ID.
#
# @option params [String] :workflow_type
# The run's workflow type.
@@ -4218,11 +4261,13 @@
# (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.
#
# @option params [Integer] :storage_capacity
- # A storage capacity for the run in gibibytes.
+ # A storage capacity for the run in gibibytes. This field is not
+ # required if the storage type is dynamic (the system ignores any value
+ # that you enter).
#
# @option params [String] :output_uri
# An output URI for the run.
#
# @option params [String] :log_level
@@ -4239,10 +4284,19 @@
# not need to pass this option.**
#
# @option params [String] :retention_mode
# The retention mode for the run.
#
+ # @option params [String] :storage_type
+ # The run's storage type. By default, the run uses STATIC storage type,
+ # which allocates a fixed amount of storage. If you set the storage type
+ # to DYNAMIC, HealthOmics dynamically scales the storage up or down,
+ # based on file system utilization.
+ #
+ # @option params [String] :workflow_owner_id
+ # The ID of the workflow owner.
+ #
# @return [Types::StartRunResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::StartRunResponse#arn #arn} => String
# * {Types::StartRunResponse#id #id} => String
# * {Types::StartRunResponse#status #status} => String
@@ -4268,10 +4322,12 @@
# tags: {
# "TagKey" => "TagValue",
# },
# request_id: "RunRequestId", # required
# retention_mode: "RETAIN", # accepts RETAIN, REMOVE
+ # storage_type: "STATIC", # accepts STATIC, DYNAMIC
+ # workflow_owner_id: "WorkflowOwnerId",
# })
#
# @example Response structure
#
# resp.arn #=> String
@@ -4671,10 +4727,10 @@
operation: config.api.operation(operation_name),
client: self,
params: params,
config: config)
context[:gem_name] = 'aws-sdk-omics'
- context[:gem_version] = '1.25.0'
+ context[:gem_version] = '1.26.0'
Seahorse::Client::Request.new(handlers, context)
end
# Polls an API operation until a resource enters a desired state.
#