Class: Aws::MedicalImaging::Client

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

Overview

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

client = Aws::MedicalImaging::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):

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

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

    Your AWS credentials used for authentication. This can be any class that includes and implements Aws::CredentialProvider, or 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, :session_token, and :account_id options.

    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'], ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID'].

    • ~/.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::InstanceProfileCredentials 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)
  • :account_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.

  • :auth_scheme_preference (Array<String>) —

    A list of preferred authentication schemes to use when making a request. Supported values are: sigv4, sigv4a, httpBearerAuth, and noAuth. When set using ENV['AWS_AUTH_SCHEME_PREFERENCE'] or in shared config as auth_scheme_preference, the value should be a comma-separated list.

  • :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 —

    When true, the SDK will not prepend the modeled host prefix to the endpoint.

  • :disable_request_compression (Boolean) — default: false —

    When set to 'true' the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the :endpoint option directly. This is normally constructed from the :region option. Configuring :endpoint is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :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.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :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.

  • :request_checksum_calculation (String) — default: "when_supported" —

    Determines when a checksum will be calculated for request payloads. Values are:

    • when_supported - (default) When set, a checksum will be calculated for all request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true and/or a requestAlgorithmMember is modeled.
    • when_required - When set, a checksum will only be calculated for request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true or where a requestAlgorithmMember is modeled and supplied.
  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :response_checksum_validation (String) — default: "when_supported" —

    Determines when checksum validation will be performed on response payloads. Values are:

    • when_supported - (default) When set, checksum validation is performed on all response payloads of operations modeled with the httpChecksum trait where responseAlgorithms is modeled, except when no modeled checksum algorithms are supported.
    • when_required - When set, checksum validation is not performed on response payloads of operations unless the checksum algorithm is supported and the requestValidationModeMember member is set to ENABLED.
  • :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.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default :sigv4a_signing_region_set is searched for in the following locations:

    • Aws.config[:sigv4a_signing_region_set]
    • ENV['AWS_SIGV4A_SIGNING_REGION_SET']
    • ~/.aws/config
  • :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.

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses NoOpTelemetryProvider which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the opentelemetry-sdk gem and then, pass in an instance of a Aws::Telemetry::OTelProvider for telemetry provider.
  • :token_provider (Aws::TokenProvider) —

    Your Bearer token used for authentication. This can be any class that includes and implements Aws::TokenProvider, or 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::MedicalImaging::EndpointProvider) —

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

  • :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.

  • :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_open_timeout (Float) — default: 15 —

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

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

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

  • :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_wire_trace (Boolean) — default: false —

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

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a content-length).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When true, response errors are raised.

  • :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.

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_cert (OpenSSL::X509::Certificate) —

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

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



473
474
475
 
# File 'gems/aws-sdk-medicalimaging/lib/aws-sdk-medicalimaging/client.rb', line 473

def initialize(*args)
  super
end

Instance Method Details

#copy_image_set(params = {}) ⇒ Types::CopyImageSetResponse

Copy an image set.

Examples:

Request syntax with placeholder values


resp = client.copy_image_set({
  datastore_id: "DatastoreId", # required
  source_image_set_id: "ImageSetId", # required
  copy_image_set_information: { # required
    source_image_set: { # required
      latest_version_id: "ImageSetExternalVersionId", # required
      dicom_copies: {
        copiable_attributes: "CopiableAttributes", # required
      },
    },
    destination_image_set: {
      image_set_id: "ImageSetId", # required
      latest_version_id: "ImageSetExternalVersionId", # required
    },
  },
  force: false,
  promote_to_primary: false,
})

Response structure


resp.datastore_id #=> String
resp.source_image_set_properties.image_set_id #=> String
resp.source_image_set_properties.latest_version_id #=> String
resp.source_image_set_properties.image_set_state #=> String, one of "ACTIVE", "LOCKED", "DELETED"
resp.source_image_set_properties.image_set_workflow_status #=> String, one of "CREATED", "COPIED", "COPYING", "COPYING_WITH_READ_ONLY_ACCESS", "COPY_FAILED", "UPDATING", "UPDATED", "UPDATE_FAILED", "DELETING", "DELETED", "IMPORTING", "IMPORTED", "IMPORT_FAILED"
resp.source_image_set_properties.created_at #=> Time
resp.source_image_set_properties.updated_at #=> Time
resp.source_image_set_properties.image_set_arn #=> String
resp.destination_image_set_properties.image_set_id #=> String
resp.destination_image_set_properties.latest_version_id #=> String
resp.destination_image_set_properties.image_set_state #=> String, one of "ACTIVE", "LOCKED", "DELETED"
resp.destination_image_set_properties.image_set_workflow_status #=> String, one of "CREATED", "COPIED", "COPYING", "COPYING_WITH_READ_ONLY_ACCESS", "COPY_FAILED", "UPDATING", "UPDATED", "UPDATE_FAILED", "DELETING", "DELETED", "IMPORTING", "IMPORTED", "IMPORT_FAILED"
resp.destination_image_set_properties.created_at #=> Time
resp.destination_image_set_properties.updated_at #=> Time
resp.destination_image_set_properties.image_set_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :datastore_id (required, String) —

    The data store identifier.

  • :source_image_set_id (required, String) —

    The source image set identifier.

  • :copy_image_set_information (required, Types::CopyImageSetInformation) —

    Copy image set information.

  • :force (Boolean) —

    Providing this parameter will force completion of the CopyImageSet operation, even if there are inconsistent Patient, Study, and/or Series level metadata elements between the sourceImageSet and destinationImageSet.

  • :promote_to_primary (Boolean) —

    Providing this parameter will configure the CopyImageSet operation to promote the given image set to the primary DICOM hierarchy. If successful, a new primary image set ID will be returned as the destination image set.

Returns:

See Also:



551
552
553
554
 
# File 'gems/aws-sdk-medicalimaging/lib/aws-sdk-medicalimaging/client.rb', line 551

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

#create_datastore(params = {}) ⇒ Types::CreateDatastoreResponse

Create a data store.

Examples:

Request syntax with placeholder values


resp = client.create_datastore({
  datastore_name: "DatastoreName",
  client_token: "ClientToken", # required
  tags: {
    "TagKey" => "TagValue",
  },
  kms_key_arn: "KmsKeyArn",
  lambda_authorizer_arn: "LambdaArn",
})

Response structure


resp.datastore_id #=> String
resp.datastore_status #=> String, one of "CREATING", "CREATE_FAILED", "ACTIVE", "DELETING", "DELETED"

Parameters:

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

    ({})

Options Hash (params):

  • :datastore_name (String) —

    The data store name.

  • :client_token (required, String) —

    A unique identifier for API idempotency.

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

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

    The tags provided when creating a data store.

  • :kms_key_arn (String) —

    The Amazon Resource Name (ARN) assigned to the Key Management Service (KMS) key for accessing encrypted data.

  • :lambda_authorizer_arn (String) —

    The ARN of the authorizer's Lambda function.

Returns:

See Also:



603
604
605
606
 
# File 'gems/aws-sdk-medicalimaging/lib/aws-sdk-medicalimaging/client.rb', line 603

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

#delete_datastore(params = {}) ⇒ Types::DeleteDatastoreResponse

Delete a data store.

Before a data store can be deleted, you must first delete all image sets within it.

Examples:

Request syntax with placeholder values


resp = client.delete_datastore({
  datastore_id: "DatastoreId", # required
})

Response structure


resp.datastore_id #=> String
resp.datastore_status #=> String, one of "CREATING", "CREATE_FAILED", "ACTIVE", "DELETING", "DELETED"

Parameters:

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

    ({})

Options Hash (params):

  • :datastore_id (required, String) —

    The data store identifier.

Returns:

See Also:



638
639
640
641
 
# File 'gems/aws-sdk-medicalimaging/lib/aws-sdk-medicalimaging/client.rb', line 638

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

#delete_image_set(params = {}) ⇒ Types::DeleteImageSetResponse

Delete an image set.

Examples:

Request syntax with placeholder values


resp = client.delete_image_set({
  datastore_id: "DatastoreId", # required
  image_set_id: "ImageSetId", # required
})

Response structure


resp.datastore_id #=> String
resp.image_set_id #=> String
resp.image_set_state #=> String, one of "ACTIVE", "LOCKED", "DELETED"
resp.image_set_workflow_status #=> String, one of "CREATED", "COPIED", "COPYING", "COPYING_WITH_READ_ONLY_ACCESS", "COPY_FAILED", "UPDATING", "UPDATED", "UPDATE_FAILED", "DELETING", "DELETED", "IMPORTING", "IMPORTED", "IMPORT_FAILED"

Parameters:

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

    ({})

Options Hash (params):

  • :datastore_id (required, String) —

    The data store identifier.

  • :image_set_id (required, String) —

    The image set identifier.

Returns:

See Also:



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

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

#get_datastore(params = {}) ⇒ Types::GetDatastoreResponse

Get data store properties.

Examples:

Request syntax with placeholder values


resp = client.get_datastore({
  datastore_id: "DatastoreId", # required
})

Response structure


resp.datastore_properties.datastore_id #=> String
resp.datastore_properties.datastore_name #=> String
resp.datastore_properties.datastore_status #=> String, one of "CREATING", "CREATE_FAILED", "ACTIVE", "DELETING", "DELETED"
resp.datastore_properties.kms_key_arn #=> String
resp.datastore_properties.lambda_authorizer_arn #=> String
resp.datastore_properties.datastore_arn #=> String
resp.datastore_properties.created_at #=> Time
resp.datastore_properties.updated_at #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :datastore_id (required, String) —

    The data store identifier.

Returns:

See Also:



762
763
764
765
 
# File 'gems/aws-sdk-medicalimaging/lib/aws-sdk-medicalimaging/client.rb', line 762

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

#get_dicom_import_job(params = {}) ⇒ Types::GetDICOMImportJobResponse

Get the import job properties to learn more about the job or job progress.

The jobStatus refers to the execution of the import job. Therefore, an import job can return a jobStatus as COMPLETED even if validation issues are discovered during the import process. If a jobStatus returns as COMPLETED, we still recommend you review the output manifests written to S3, as they provide details on the success or failure of individual P10 object imports.

Examples:

Request syntax with placeholder values


resp = client.get_dicom_import_job({
  datastore_id: "DatastoreId", # required
  job_id: "JobId", # required
})

Response structure


resp.job_properties.job_id #=> String
resp.job_properties.job_name #=> String
resp.job_properties.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED"
resp.job_properties.datastore_id #=> String
resp.job_properties.data_access_role_arn #=> String
resp.job_properties.ended_at #=> Time
resp.job_properties.submitted_at #=> Time
resp.job_properties.input_s3_uri #=> String
resp.job_properties.output_s3_uri #=> String
resp.job_properties.message #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :datastore_id (required, String) —

    The data store identifier.

  • :job_id (required, String) —

    The import job identifier.

Returns:

See Also:



727
728
729
730
 
# File 'gems/aws-sdk-medicalimaging/lib/aws-sdk-medicalimaging/client.rb', line 727

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

#get_image_frame(params = {}) ⇒ Types::GetImageFrameResponse

Get an image frame (pixel data) for an image set.

Examples:

Request syntax with placeholder values


resp = client.get_image_frame({
  datastore_id: "DatastoreId", # required
  image_set_id: "ImageSetId", # required
  image_frame_information: { # required
    image_frame_id: "ImageFrameId", # required
  },
})

Response structure


resp.image_frame_blob #=> IO
resp.content_type #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :datastore_id (required, String) —

    The data store identifier.

  • :image_set_id (required, String) —

    The image set identifier.

  • :image_frame_information (required, Types::ImageFrameInformation) —

    Information about the image frame (pixel data) identifier.

Returns:

See Also:



802
803
804
805
 
# File 'gems/aws-sdk-medicalimaging/lib/aws-sdk-medicalimaging/client.rb', line 802

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

#get_image_set(params = {}) ⇒ Types::GetImageSetResponse

Get image set properties.

Examples:

Request syntax with placeholder values


resp = client.get_image_set({
  datastore_id: "DatastoreId", # required
  image_set_id: "ImageSetId", # required
  version_id: "ImageSetExternalVersionId",
})

Response structure


resp.datastore_id #=> String
resp.image_set_id #=> String
resp.version_id #=> String
resp.image_set_state #=> String, one of "ACTIVE", "LOCKED", "DELETED"
resp.image_set_workflow_status #=> String, one of "CREATED", "COPIED", "COPYING", "COPYING_WITH_READ_ONLY_ACCESS", "COPY_FAILED", "UPDATING", "UPDATED", "UPDATE_FAILED", "DELETING", "DELETED", "IMPORTING", "IMPORTED", "IMPORT_FAILED"
resp.created_at #=> Time
resp.updated_at #=> Time
resp.deleted_at #=> Time
resp.message #=> String
resp.image_set_arn #=> String
resp.overrides.forced #=> Boolean
resp.is_primary #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :datastore_id (required, String) —

    The data store identifier.

  • :image_set_id (required, String) —

    The image set identifier.

  • :version_id (String) —

    The image set version identifier.

Returns:

See Also:



860
861
862
863
 
# File 'gems/aws-sdk-medicalimaging/lib/aws-sdk-medicalimaging/client.rb', line 860

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

#get_image_set_metadata(params = {}) ⇒ Types::GetImageSetMetadataResponse

Get metadata attributes for an image set.

Examples:

Request syntax with placeholder values


resp = client.get_image_set_metadata({
  datastore_id: "DatastoreId", # required
  image_set_id: "ImageSetId", # required
  version_id: "ImageSetExternalVersionId",
})

Response structure


resp.image_set_metadata_blob #=> IO
resp.content_type #=> String
resp.content_encoding #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :datastore_id (required, String) —

    The data store identifier.

  • :image_set_id (required, String) —

    The image set identifier.

  • :version_id (String) —

    The image set version identifier.

Returns:

See Also:



900
901
902
903
 
# File 'gems/aws-sdk-medicalimaging/lib/aws-sdk-medicalimaging/client.rb', line 900

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

#list_datastores(params = {}) ⇒ Types::ListDatastoresResponse

List data 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_datastores({
  datastore_status: "CREATING", # accepts CREATING, CREATE_FAILED, ACTIVE, DELETING, DELETED
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.datastore_summaries #=> Array
resp.datastore_summaries[0].datastore_id #=> String
resp.datastore_summaries[0].datastore_name #=> String
resp.datastore_summaries[0].datastore_status #=> String, one of "CREATING", "CREATE_FAILED", "ACTIVE", "DELETING", "DELETED"
resp.datastore_summaries[0].datastore_arn #=> String
resp.datastore_summaries[0].created_at #=> Time
resp.datastore_summaries[0].updated_at #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :datastore_status (String) —

    The data store status.

  • :next_token (String) —

    The pagination token used to request the list of data stores on the next page.

  • :max_results (Integer) —

    Valid Range: Minimum value of 1. Maximum value of 50.

Returns:

See Also:



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

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

#list_dicom_import_jobs(params = {}) ⇒ Types::ListDICOMImportJobsResponse

List import jobs created for a specific data store.

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_dicom_import_jobs({
  datastore_id: "DatastoreId", # required
  job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, FAILED
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.job_summaries #=> Array
resp.job_summaries[0].job_id #=> String
resp.job_summaries[0].job_name #=> String
resp.job_summaries[0].job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED"
resp.job_summaries[0].datastore_id #=> String
resp.job_summaries[0].data_access_role_arn #=> String
resp.job_summaries[0].ended_at #=> Time
resp.job_summaries[0].submitted_at #=> Time
resp.job_summaries[0].message #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :datastore_id (required, String) —

    The data store identifier.

  • :job_status (String) —

    The filters for listing import jobs based on status.

  • :next_token (String) —

    The pagination token used to request the list of import jobs on the next page.

  • :max_results (Integer) —

    The max results count. The upper bound is determined by load testing.

Returns:

See Also:



953
954
955
956
 
# File 'gems/aws-sdk-medicalimaging/lib/aws-sdk-medicalimaging/client.rb', line 953

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

#list_image_set_versions(params = {}) ⇒ Types::ListImageSetVersionsResponse

List image set versions.

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_image_set_versions({
  datastore_id: "DatastoreId", # required
  image_set_id: "ImageSetId", # required
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.image_set_properties_list #=> Array
resp.image_set_properties_list[0].image_set_id #=> String
resp.image_set_properties_list[0].version_id #=> String
resp.image_set_properties_list[0].image_set_state #=> String, one of "ACTIVE", "LOCKED", "DELETED"
resp.image_set_properties_list[0].image_set_workflow_status #=> String, one of "CREATED", "COPIED", "COPYING", "COPYING_WITH_READ_ONLY_ACCESS", "COPY_FAILED", "UPDATING", "UPDATED", "UPDATE_FAILED", "DELETING", "DELETED", "IMPORTING", "IMPORTED", "IMPORT_FAILED"
resp.image_set_properties_list[0].created_at #=> Time
resp.image_set_properties_list[0].updated_at #=> Time
resp.image_set_properties_list[0].deleted_at #=> Time
resp.image_set_properties_list[0].message #=> String
resp.image_set_properties_list[0].overrides.forced #=> Boolean
resp.image_set_properties_list[0].is_primary #=> Boolean
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :datastore_id (required, String) —

    The data store identifier.

  • :image_set_id (required, String) —

    The image set identifier.

  • :next_token (String) —

    The pagination token used to request the list of image set versions on the next page.

  • :max_results (Integer) —

    The max results count.

Returns:

See Also:



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

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

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

Lists all tags associated with a medical imaging resource.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the medical imaging resource to list tags for.

Returns:

See Also:



1085
1086
1087
1088
 
# File 'gems/aws-sdk-medicalimaging/lib/aws-sdk-medicalimaging/client.rb', line 1085

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

#search_image_sets(params = {}) ⇒ Types::SearchImageSetsResponse

Search image sets based on defined input attributes.

SearchImageSets accepts a single search query parameter and returns a paginated response of all image sets that have the matching criteria. All date range queries must be input as (lowerBound, upperBound).

By default, SearchImageSets uses the updatedAt field for sorting in descending order from newest to oldest.

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

Examples:

Request syntax with placeholder values


resp = client.search_image_sets({
  datastore_id: "DatastoreId", # required
  search_criteria: {
    filters: [
      {
        values: [ # required
          {
            dicom_patient_id: "DICOMPatientId",
            dicom_accession_number: "DICOMAccessionNumber",
            dicom_study_id: "DICOMStudyId",
            dicom_study_instance_uid: "DICOMStudyInstanceUID",
            dicom_series_instance_uid: "DICOMSeriesInstanceUID",
            created_at: Time.now,
            updated_at: Time.now,
            dicom_study_date_and_time: {
              dicom_study_date: "DICOMStudyDate", # required
              dicom_study_time: "DICOMStudyTime",
            },
            is_primary: false,
          },
        ],
        operator: "EQUAL", # required, accepts EQUAL, BETWEEN
      },
    ],
    sort: {
      sort_order: "ASC", # required, accepts ASC, DESC
      sort_field: "updatedAt", # required, accepts updatedAt, createdAt, DICOMStudyDateAndTime
    },
  },
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.image_sets_metadata_summaries #=> Array
resp.image_sets_metadata_summaries[0].image_set_id #=> String
resp.image_sets_metadata_summaries[0].version #=> Integer
resp.image_sets_metadata_summaries[0].created_at #=> Time
resp.image_sets_metadata_summaries[0].updated_at #=> Time
resp.image_sets_metadata_summaries[0].dicom_tags.dicom_patient_id #=> String
resp.image_sets_metadata_summaries[0].dicom_tags.dicom_patient_name #=> String
resp.image_sets_metadata_summaries[0].dicom_tags.dicom_patient_birth_date #=> String
resp.image_sets_metadata_summaries[0].dicom_tags.dicom_patient_sex #=> String
resp.image_sets_metadata_summaries[0].dicom_tags.dicom_study_instance_uid #=> String
resp.image_sets_metadata_summaries[0].dicom_tags.dicom_study_id #=> String
resp.image_sets_metadata_summaries[0].dicom_tags.dicom_study_description #=> String
resp.image_sets_metadata_summaries[0].dicom_tags.dicom_number_of_study_related_series #=> Integer
resp.image_sets_metadata_summaries[0].dicom_tags.dicom_number_of_study_related_instances #=> Integer
resp.image_sets_metadata_summaries[0].dicom_tags.dicom_accession_number #=> String
resp.image_sets_metadata_summaries[0].dicom_tags.dicom_series_instance_uid #=> String
resp.image_sets_metadata_summaries[0].dicom_tags.dicom_series_modality #=> String
resp.image_sets_metadata_summaries[0].dicom_tags.dicom_series_body_part #=> String
resp.image_sets_metadata_summaries[0].dicom_tags.dicom_series_number #=> Integer
resp.image_sets_metadata_summaries[0].dicom_tags.dicom_study_date #=> String
resp.image_sets_metadata_summaries[0].dicom_tags.dicom_study_time #=> String
resp.image_sets_metadata_summaries[0].is_primary #=> Boolean
resp.data.sort.sort_order #=> String, one of "ASC", "DESC"
resp.data.sort.sort_field #=> String, one of "updatedAt", "createdAt", "DICOMStudyDateAndTime"
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :datastore_id (required, String) —

    The identifier of the data store where the image sets reside.

  • :search_criteria (Types::SearchCriteria) —

    The search criteria that filters by applying a maximum of 1 item to SearchByAttribute.

  • :max_results (Integer) —

    The maximum number of results that can be returned in a search.

  • :next_token (String) —

    The token used for pagination of results returned in the response. Use the token returned from the previous request to continue results where the previous request ended.

Returns:

See Also:



1192
1193
1194
1195
 
# File 'gems/aws-sdk-medicalimaging/lib/aws-sdk-medicalimaging/client.rb', line 1192

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

#start_dicom_import_job(params = {}) ⇒ Types::StartDICOMImportJobResponse

Start importing bulk data into an ACTIVE data store. The import job imports DICOM P10 files found in the S3 prefix specified by the inputS3Uri parameter. The import job stores processing results in the file specified by the outputS3Uri parameter.

Examples:

Request syntax with placeholder values


resp = client.start_dicom_import_job({
  job_name: "JobName",
  data_access_role_arn: "RoleArn", # required
  client_token: "ClientToken", # required
  datastore_id: "DatastoreId", # required
  input_s3_uri: "S3Uri", # required
  output_s3_uri: "S3Uri", # required
  input_owner_account_id: "AwsAccountId",
})

Response structure


resp.datastore_id #=> String
resp.job_id #=> String
resp.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED"
resp.submitted_at #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :job_name (String) —

    The import job name.

  • :data_access_role_arn (required, String) —

    The Amazon Resource Name (ARN) of the IAM role that grants permission to access medical imaging resources.

  • :client_token (required, String) —

    A unique identifier for API idempotency.

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

  • :datastore_id (required, String) —

    The data store identifier.

  • :input_s3_uri (required, String) —

    The input prefix path for the S3 bucket that contains the DICOM files to be imported.

  • :output_s3_uri (required, String) —

    The output prefix of the S3 bucket to upload the results of the DICOM import job.

  • :input_owner_account_id (String) —

    The account ID of the source S3 bucket owner.

Returns:

See Also:



1259
1260
1261
1262
 
# File 'gems/aws-sdk-medicalimaging/lib/aws-sdk-medicalimaging/client.rb', line 1259

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

#tag_resource(params = {}) ⇒ Struct

Adds a user-specifed key and value tag to a medical imaging resource.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the medical imaging resource that tags are being added to.

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

    The user-specified key and value tag pairs added to a medical imaging resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1289
1290
1291
1292
 
# File 'gems/aws-sdk-medicalimaging/lib/aws-sdk-medicalimaging/client.rb', line 1289

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

#untag_resource(params = {}) ⇒ Struct

Removes tags from a medical imaging resource.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the medical imaging resource that tags are being removed from.

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

    The keys for the tags to be removed from the medical imaging resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1316
1317
1318
1319
 
# File 'gems/aws-sdk-medicalimaging/lib/aws-sdk-medicalimaging/client.rb', line 1316

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

#update_image_set_metadata(params = {}) ⇒ Types::UpdateImageSetMetadataResponse

Update image set metadata attributes.

Examples:

Request syntax with placeholder values


resp = client.update_image_set_metadata({
  datastore_id: "DatastoreId", # required
  image_set_id: "ImageSetId", # required
  latest_version_id: "ImageSetExternalVersionId", # required
  force: false,
  update_image_set_metadata_updates: { # required
    dicom_updates: {
      removable_attributes: "data",
      updatable_attributes: "data",
    },
    revert_to_version_id: "ImageSetExternalVersionId",
  },
})

Response structure


resp.datastore_id #=> String
resp.image_set_id #=> String
resp.latest_version_id #=> String
resp.image_set_state #=> String, one of "ACTIVE", "LOCKED", "DELETED"
resp.image_set_workflow_status #=> String, one of "CREATED", "COPIED", "COPYING", "COPYING_WITH_READ_ONLY_ACCESS", "COPY_FAILED", "UPDATING", "UPDATED", "UPDATE_FAILED", "DELETING", "DELETED", "IMPORTING", "IMPORTED", "IMPORT_FAILED"
resp.created_at #=> Time
resp.updated_at #=> Time
resp.message #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :datastore_id (required, String) —

    The data store identifier.

  • :image_set_id (required, String) —

    The image set identifier.

  • :latest_version_id (required, String) —

    The latest image set version identifier.

  • :force (Boolean) —

    Setting this flag will force the UpdateImageSetMetadata operation for the following attributes:

    • Tag.StudyInstanceUID, Tag.SeriesInstanceUID, Tag.SOPInstanceUID, and Tag.StudyID

    • Adding, removing, or updating private tags for an individual SOP Instance

  • :update_image_set_metadata_updates (required, Types::MetadataUpdates) —

    Update image set metadata updates.

Returns:

See Also:



1387
1388
1389
1390
 
# File 'gems/aws-sdk-medicalimaging/lib/aws-sdk-medicalimaging/client.rb', line 1387

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