Class: Aws::WorkspacesInstances::Client

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

Overview

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

client = Aws::WorkspacesInstances::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. Takes effect only when disable_clock_skew_correction is not set.

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

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

  • :disable_clock_skew_correction (Boolean) —

    Used only in standard and adaptive retry modes. When true, the SDK does not apply a clock skew correction, does not update its stored skew from responses, and does not retry clock skew errors. Clock skew correction is enabled by default.

  • :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 the 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 - A retry mode that includes all the functionality of standard mode along with automatic client side throttling.

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

    Disables request parameter conversion, validation, and formatting. Also disables response data type conversions. The request parameters hash must be formatted exactly as the API expects.This option is useful when you want to ensure the highest level of performance by avoiding overhead of walking request parameters and response data structures.

  • :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::WorkspacesInstances::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::WorkspacesInstances::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.



485
486
487
 
# File 'gems/aws-sdk-workspacesinstances/lib/aws-sdk-workspacesinstances/client.rb', line 485

def initialize(*args)
  super
end

Instance Method Details

#associate_volume(params = {}) ⇒ Struct

Attaches a volume to a WorkSpace Instance.

Examples:

Request syntax with placeholder values


resp = client.associate_volume({
  workspace_instance_id: "WorkspaceInstanceId", # required
  volume_id: "VolumeId", # required
  device: "DeviceName", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :workspace_instance_id (required, String) —

    WorkSpace Instance to attach volume to.

  • :volume_id (required, String) —

    Volume to be attached.

  • :device (required, String) —

    Device path for volume attachment.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



516
517
518
519
 
# File 'gems/aws-sdk-workspacesinstances/lib/aws-sdk-workspacesinstances/client.rb', line 516

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

#create_volume(params = {}) ⇒ Types::CreateVolumeResponse

Creates a new volume for WorkSpace Instances.

Examples:

Request syntax with placeholder values


resp = client.create_volume({
  availability_zone: "String64", # required
  client_token: "ClientToken",
  encrypted: false,
  iops: 1,
  kms_key_id: "KmsKeyId",
  size_in_gb: 1,
  snapshot_id: "SnapshotId",
  tag_specifications: [
    {
      resource_type: "instance", # accepts instance, volume, spot-instances-request, network-interface
      tags: [
        {
          key: "TagKey",
          value: "TagValue",
        },
      ],
    },
  ],
  throughput: 1,
  volume_type: "standard", # accepts standard, io1, io2, gp2, sc1, st1, gp3
})

Response structure


resp.volume_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :availability_zone (required, String) —

    Availability zone for the volume.

  • :client_token (String) —

    Unique token to prevent duplicate volume creation.

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

  • :encrypted (Boolean) —

    Indicates if the volume should be encrypted.

  • :iops (Integer) —

    Input/output operations per second for the volume.

  • :kms_key_id (String) —

    KMS key for volume encryption.

  • :size_in_gb (Integer) —

    Volume size in gigabytes.

  • :snapshot_id (String) —

    Source snapshot for volume creation.

  • :tag_specifications (Array<Types::TagSpecification>) —

    Metadata tags for the volume.

  • :throughput (Integer) —

    Volume throughput performance.

  • :volume_type (String) —

    Type of EBS volume.

Returns:

See Also:



593
594
595
596
 
# File 'gems/aws-sdk-workspacesinstances/lib/aws-sdk-workspacesinstances/client.rb', line 593

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

#create_workspace_instance(params = {}) ⇒ Types::CreateWorkspaceInstanceResponse

Launches a new WorkSpace Instance with specified configuration parameters, enabling programmatic workspace deployment.

Examples:

Request syntax with placeholder values


resp = client.create_workspace_instance({
  client_token: "ClientToken",
  tags: [
    {
      key: "TagKey",
      value: "TagValue",
    },
  ],
  managed_instance: { # required
    block_device_mappings: [
      {
        device_name: "DeviceName",
        ebs: {
          volume_type: "standard", # accepts standard, io1, io2, gp2, sc1, st1, gp3
          encrypted: false,
          kms_key_id: "KmsKeyId",
          iops: 1,
          throughput: 1,
          volume_size: 1,
        },
        no_device: "DeviceName",
        virtual_name: "VirtualName",
      },
    ],
    capacity_reservation_specification: {
      capacity_reservation_preference: "capacity-reservations-only", # accepts capacity-reservations-only, open, none
      capacity_reservation_target: {
        capacity_reservation_id: "String128",
        capacity_reservation_resource_group_arn: "ARN",
      },
    },
    cpu_options: {
      amd_sev_snp: "enabled", # accepts enabled, disabled
      core_count: 1,
      threads_per_core: 1,
      nested_virtualization: "enabled", # accepts enabled, disabled
    },
    credit_specification: {
      cpu_credits: "standard", # accepts standard, unlimited
    },
    disable_api_stop: false,
    ebs_optimized: false,
    enable_primary_ipv_6: false,
    enclave_options: {
      enabled: false,
    },
    hibernation_options: {
      configured: false,
    },
    iam_instance_profile: {
      arn: "ARN",
      name: "String64",
    },
    image_id: "ImageId",
    instance_market_options: {
      market_type: "spot", # accepts spot, capacity-block
      spot_options: {
        block_duration_minutes: 1,
        instance_interruption_behavior: "hibernate", # accepts hibernate, stop
        max_price: "String64",
        spot_instance_type: "one-time", # accepts one-time, persistent
        valid_until_utc: Time.now,
      },
    },
    instance_type: "InstanceType",
    ipv_6_addresses: [
      {
        ipv_6_address: "Ipv6Address",
        is_primary_ipv_6: false,
      },
    ],
    ipv_6_address_count: 1,
    kernel_id: "String128",
    key_name: "String64",
    license_specifications: [
      {
        license_configuration_arn: "ARN",
      },
    ],
    maintenance_options: {
      auto_recovery: "disabled", # accepts disabled, default
    },
    metadata_options: {
      http_endpoint: "enabled", # accepts enabled, disabled
      http_protocol_ipv_6: "enabled", # accepts enabled, disabled
      http_put_response_hop_limit: 1,
      http_tokens: "optional", # accepts optional, required
      instance_metadata_tags: "enabled", # accepts enabled, disabled
    },
    monitoring: {
      enabled: false,
    },
    network_interfaces: [
      {
        associate_carrier_ip_address: false,
        associate_public_ip_address: false,
        connection_tracking_specification: {
          tcp_established_timeout: 1,
          udp_stream_timeout: 1,
          udp_timeout: 1,
        },
        description: "Description",
        device_index: 1,
        ena_srd_specification: {
          ena_srd_enabled: false,
          ena_srd_udp_specification: {
            ena_srd_udp_enabled: false,
          },
        },
        interface_type: "interface", # accepts interface, efa, efa-only
        ipv_4_prefixes: [
          {
            ipv_4_prefix: "Ipv4Prefix",
          },
        ],
        ipv_4_prefix_count: 1,
        ipv_6_address_count: 1,
        ipv_6_addresses: [
          {
            ipv_6_address: "Ipv6Address",
            is_primary_ipv_6: false,
          },
        ],
        ipv_6_prefixes: [
          {
            ipv_6_prefix: "Ipv6Prefix",
          },
        ],
        ipv_6_prefix_count: 1,
        network_card_index: 1,
        network_interface_id: "NetworkInterfaceId",
        primary_ipv_6: false,
        private_ip_address: "Ipv4Address",
        private_ip_addresses: [
          {
            primary: false,
            private_ip_address: "Ipv4Address",
          },
        ],
        secondary_private_ip_address_count: 1,
        groups: ["SecurityGroupId"],
        subnet_id: "SubnetId",
      },
    ],
    network_performance_options: {
      bandwidth_weighting: "default", # accepts default, vpc-1, ebs-1
    },
    placement: {
      affinity: "String64",
      availability_zone: "AvailabilityZone",
      group_id: "PlacementGroupId",
      group_name: "String64",
      host_id: "HostId",
      host_resource_group_arn: "ARN",
      partition_number: 1,
      tenancy: "default", # accepts default, dedicated, host
    },
    private_dns_name_options: {
      hostname_type: "ip-name", # accepts ip-name, resource-name
      enable_resource_name_dns_a_record: false,
      enable_resource_name_dns_aaaa_record: false,
    },
    private_ip_address: "Ipv4Address",
    ramdisk_id: "String128",
    security_group_ids: ["SecurityGroupId"],
    security_groups: ["SecurityGroupName"],
    subnet_id: "SubnetId",
    tag_specifications: [
      {
        resource_type: "instance", # accepts instance, volume, spot-instances-request, network-interface
        tags: [
          {
            key: "TagKey",
            value: "TagValue",
          },
        ],
      },
    ],
    user_data: "UserData",
  },
  billing_configuration: {
    billing_mode: "MONTHLY", # required, accepts MONTHLY, HOURLY
  },
})

Response structure


resp.workspace_instance_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :client_token (String) —

    Unique token to ensure idempotent instance creation, preventing duplicate workspace launches.

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

  • :tags (Array<Types::Tag>) —

    Optional metadata tags for categorizing and managing WorkSpaces Instances.

  • :managed_instance (required, Types::ManagedInstanceRequest) —

    Comprehensive configuration settings for the WorkSpaces Instance, including network, compute, and storage parameters.

  • :billing_configuration (Types::BillingConfiguration) —

    Optional billing configuration for the WorkSpace Instance. Allows customers to specify their preferred billing mode when creating a new instance. Defaults to hourly billing if not specified.

Returns:

See Also:



820
821
822
823
 
# File 'gems/aws-sdk-workspacesinstances/lib/aws-sdk-workspacesinstances/client.rb', line 820

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

#delete_volume(params = {}) ⇒ Struct

Deletes a specified volume.

Examples:

Request syntax with placeholder values


resp = client.delete_volume({
  volume_id: "VolumeId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :volume_id (required, String) —

    Identifier of the volume to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



842
843
844
845
 
# File 'gems/aws-sdk-workspacesinstances/lib/aws-sdk-workspacesinstances/client.rb', line 842

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

#delete_workspace_instance(params = {}) ⇒ Struct

Deletes the specified WorkSpace

Usage of this API will result in deletion of the resource in question.

Examples:

Request syntax with placeholder values


resp = client.delete_workspace_instance({
  workspace_instance_id: "WorkspaceInstanceId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :workspace_instance_id (required, String) —

    Unique identifier of the WorkSpaces Instance targeted for deletion.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



866
867
868
869
 
# File 'gems/aws-sdk-workspacesinstances/lib/aws-sdk-workspacesinstances/client.rb', line 866

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

#disassociate_volume(params = {}) ⇒ Struct

Detaches a volume from a WorkSpace Instance.

Examples:

Request syntax with placeholder values


resp = client.disassociate_volume({
  workspace_instance_id: "WorkspaceInstanceId", # required
  volume_id: "VolumeId", # required
  device: "DeviceName",
  disassociate_mode: "FORCE", # accepts FORCE, NO_FORCE
})

Parameters:

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

    ({})

Options Hash (params):

  • :workspace_instance_id (required, String) —

    WorkSpace Instance to detach volume from.

  • :volume_id (required, String) —

    Volume to be detached.

  • :device (String) —

    Device path of volume to detach.

  • :disassociate_mode (String) —

    Mode for volume detachment.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



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

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

#get_workspace_instance(params = {}) ⇒ Types::GetWorkspaceInstanceResponse

Retrieves detailed information about a specific WorkSpace Instance.

Examples:

Request syntax with placeholder values


resp = client.get_workspace_instance({
  workspace_instance_id: "WorkspaceInstanceId", # required
})

Response structure


resp.workspace_instance_errors #=> Array
resp.workspace_instance_errors[0].error_code #=> String
resp.workspace_instance_errors[0].error_message #=> String
resp.ec2_instance_errors #=> Array
resp.ec2_instance_errors[0].ec2_error_code #=> String
resp.ec2_instance_errors[0].ec2_exception_type #=> String
resp.ec2_instance_errors[0].ec2_error_message #=> String
resp.provision_state #=> String, one of "ALLOCATING", "ALLOCATED", "DEALLOCATING", "DEALLOCATED", "ERROR_ALLOCATING", "ERROR_DEALLOCATING"
resp.workspace_instance_id #=> String
resp.ec2_managed_instance.instance_id #=> String
resp.billing_configuration.billing_mode #=> String, one of "MONTHLY", "HOURLY"

Parameters:

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

    ({})

Options Hash (params):

  • :workspace_instance_id (required, String) —

    Unique identifier of the WorkSpace Instance to retrieve.

Returns:

See Also:



943
944
945
946
 
# File 'gems/aws-sdk-workspacesinstances/lib/aws-sdk-workspacesinstances/client.rb', line 943

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

#list_instance_types(params = {}) ⇒ Types::ListInstanceTypesResponse

Retrieves a list of instance types supported by Amazon WorkSpaces Instances, enabling precise workspace infrastructure configuration.

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_instance_types({
  max_results: 1,
  next_token: "NextToken",
  instance_configuration_filter: {
    billing_mode: "MONTHLY", # required, accepts MONTHLY, HOURLY
    platform_type: "Windows", # required, accepts Windows, Windows BYOL, Linux/UNIX, Ubuntu Pro Linux, Red Hat Enterprise Linux, Red Hat BYOL Linux, SUSE Linux
    tenancy: "SHARED", # required, accepts SHARED, DEDICATED
  },
})

Response structure


resp.instance_types #=> Array
resp.instance_types[0].instance_type #=> String
resp.instance_types[0].supported_instance_configurations #=> Array
resp.instance_types[0].supported_instance_configurations[0].billing_mode #=> String, one of "MONTHLY", "HOURLY"
resp.instance_types[0].supported_instance_configurations[0].platform_type #=> String, one of "Windows", "Windows BYOL", "Linux/UNIX", "Ubuntu Pro Linux", "Red Hat Enterprise Linux", "Red Hat BYOL Linux", "SUSE Linux"
resp.instance_types[0].supported_instance_configurations[0].tenancy #=> String, one of "SHARED", "DEDICATED"
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (Integer) —

    Maximum number of instance types to return in a single API call. Enables pagination of instance type results.

  • :next_token (String) —

    Pagination token for retrieving subsequent pages of instance type results.

  • :instance_configuration_filter (Types::InstanceConfigurationFilter) —

    Optional filter to narrow instance type results based on configuration requirements. Only returns instance types that support the specified combination of tenancy, platform type, and billing mode.

Returns:

See Also:



997
998
999
1000
 
# File 'gems/aws-sdk-workspacesinstances/lib/aws-sdk-workspacesinstances/client.rb', line 997

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

#list_regions(params = {}) ⇒ Types::ListRegionsResponse

Retrieves a list of AWS regions supported by Amazon WorkSpaces Instances, enabling region discovery for workspace deployments.

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_regions({
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.regions #=> Array
resp.regions[0].region_name #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (Integer) —

    Maximum number of regions to return in a single API call. Enables pagination of region results.

  • :next_token (String) —

    Pagination token for retrieving subsequent pages of region results.

Returns:

See Also:



1036
1037
1038
1039
 
# File 'gems/aws-sdk-workspacesinstances/lib/aws-sdk-workspacesinstances/client.rb', line 1036

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

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

Retrieves tags for a WorkSpace Instance.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  workspace_instance_id: "WorkspaceInstanceId", # required
})

Response structure


resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :workspace_instance_id (required, String) —

    Unique identifier of the WorkSpace Instance.

Returns:

See Also:



1066
1067
1068
1069
 
# File 'gems/aws-sdk-workspacesinstances/lib/aws-sdk-workspacesinstances/client.rb', line 1066

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

#list_workspace_instances(params = {}) ⇒ Types::ListWorkspaceInstancesResponse

Retrieves a collection of WorkSpaces Instances based on specified filters.

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_workspace_instances({
  provision_states: ["ALLOCATING"], # accepts ALLOCATING, ALLOCATED, DEALLOCATING, DEALLOCATED, ERROR_ALLOCATING, ERROR_DEALLOCATING
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.workspace_instances #=> Array
resp.workspace_instances[0].provision_state #=> String, one of "ALLOCATING", "ALLOCATED", "DEALLOCATING", "DEALLOCATED", "ERROR_ALLOCATING", "ERROR_DEALLOCATING"
resp.workspace_instances[0].workspace_instance_id #=> String
resp.workspace_instances[0].ec2_managed_instance.instance_id #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :provision_states (Array<String>) —

    Filter WorkSpaces Instances by their current provisioning states.

  • :max_results (Integer) —

    Maximum number of WorkSpaces Instances to return in a single response.

  • :next_token (String) —

    Pagination token for retrieving subsequent pages of WorkSpaces Instances.

Returns:

See Also:



1111
1112
1113
1114
 
# File 'gems/aws-sdk-workspacesinstances/lib/aws-sdk-workspacesinstances/client.rb', line 1111

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

#modify_volume(params = {}) ⇒ Types::ModifyVolumeResponse

Modifies the size, volume type, IOPS (input/output operations per second), or throughput of a volume. When you modify a volume, you must specify at least one of these parameters. You can modify a volume only after any previous modification for that volume has finished.

To track the progress of a modification, use the Amazon EC2 DescribeVolumesModifications operation. For more information, see Monitor the progress of Amazon EBS volume modifications in the Amazon EBS User Guide.

After you increase the size of a volume, you must extend the partition and file system to use the new storage capacity. For more information, see Extend the file system after resizing an Amazon EBS volume in the Amazon EBS User Guide, which covers both Linux and Windows instances.

Examples:

Request syntax with placeholder values


resp = client.modify_volume({
  volume_id: "VolumeId", # required
  size_in_gb: 1,
  volume_type: "standard", # accepts standard, io1, io2, gp2, sc1, st1, gp3
  iops: 1,
  throughput: 1,
  client_token: "ClientToken",
})

Response structure


resp.volume_id #=> String
resp.target_size #=> Integer
resp.target_volume_type #=> String, one of "standard", "io1", "io2", "gp2", "sc1", "st1", "gp3"
resp.target_iops #=> Integer
resp.target_throughput #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :volume_id (required, String) —

    Specifies the identifier of the volume to modify.

  • :size_in_gb (Integer) —

    Specifies the target size of the volume, in GiB. The target size must be greater than or equal to the current size of the volume. If you don't specify a size, the current size is retained.

  • :volume_type (String) —

    Specifies the target Amazon Elastic Block Store (Amazon EBS) volume type. If you don't specify a volume type, the current volume type is retained.

  • :iops (Integer) —

    Specifies the target IOPS rate of the volume. This parameter is valid only for gp3, io1, and io2 volumes. If you don't specify IOPS and keep the same volume type, the current IOPS rate is retained.

  • :throughput (Integer) —

    Specifies the target throughput of the volume, in MiB/s. This parameter is valid only for gp3 volumes. If you don't specify throughput and the volume remains gp3, the current throughput is retained.

  • :client_token (String) —

    Unique token to ensure idempotent volume modification, preventing duplicate volume modifications.

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

Returns:

See Also:



1202
1203
1204
1205
 
# File 'gems/aws-sdk-workspacesinstances/lib/aws-sdk-workspacesinstances/client.rb', line 1202

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

#tag_resource(params = {}) ⇒ Struct

Adds tags to a WorkSpace Instance.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  workspace_instance_id: "WorkspaceInstanceId", # required
  tags: [ # required
    {
      key: "TagKey",
      value: "TagValue",
    },
  ],
})

Parameters:

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

    ({})

Options Hash (params):

  • :workspace_instance_id (required, String) —

    Unique identifier of the WorkSpace Instance to tag.

  • :tags (required, Array<Types::Tag>) —

    Tags to be added to the WorkSpace Instance.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1233
1234
1235
1236
 
# File 'gems/aws-sdk-workspacesinstances/lib/aws-sdk-workspacesinstances/client.rb', line 1233

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

#untag_resource(params = {}) ⇒ Struct

Removes tags from a WorkSpace Instance.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :workspace_instance_id (required, String) —

    Unique identifier of the WorkSpace Instance to untag.

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

    Keys of tags to be removed.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



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

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