Class: Aws::NimbleStudio::Client

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

Overview

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

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

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

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

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

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

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :credentials (required, Aws::CredentialProvider)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  • :adaptive_retry_wait_to_fill (Boolean) — default: true

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

  • :client_side_monitoring (Boolean) — default: false

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

  • :client_side_monitoring_client_id (String) — default: ""

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

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

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

  • :client_side_monitoring_port (Integer) — default: 31000

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

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

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

  • :convert_params (Boolean) — default: true

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

  • :correct_clock_skew (Boolean) — default: true

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

  • :disable_host_prefix_injection (Boolean) — default: false

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

  • :endpoint (String)

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

  • :endpoint_cache_max_entries (Integer) — default: 1000

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

  • :endpoint_cache_max_threads (Integer) — default: 10

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

  • :endpoint_cache_poll_interval (Integer) — default: 60

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

  • :endpoint_discovery (Boolean) — default: false

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

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

    The log formatter.

  • :log_level (Symbol) — default: :info

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

  • :logger (Logger)

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

  • :max_attempts (Integer) — default: 3

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

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

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

  • :retry_backoff (Proc)

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

  • :retry_base_delay (Float) — default: 0.3

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

  • :retry_jitter (Symbol) — default: :none

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

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

  • :retry_limit (Integer) — default: 3

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

  • :retry_max_delay (Integer) — default: 0

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

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

    Specifies which retry algorithm to use. Values are:

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

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

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

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

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

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

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

  • :http_proxy (URI::HTTP, String)

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

  • :http_open_timeout (Float) — default: 15

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

  • :http_read_timeout (Integer) — default: 60

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

  • :http_idle_timeout (Float) — default: 5

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

  • :http_continue_timeout (Float) — default: 1

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

  • :http_wire_trace (Boolean) — default: false

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

  • :ssl_verify_peer (Boolean) — default: true

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

  • :ssl_ca_bundle (String)

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

  • :ssl_ca_directory (String)

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



333
334
335
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 333

def initialize(*args)
  super
end

Instance Method Details

#accept_eulas(params = {}) ⇒ Types::AcceptEulasResponse

Accept EULAs.

Examples:

Request syntax with placeholder values


resp = client.accept_eulas({
  client_token: "ClientToken",
  eula_ids: ["String"],
  studio_id: "String", # required
})

Response structure


resp.eula_acceptances #=> Array
resp.eula_acceptances[0].accepted_at #=> Time
resp.eula_acceptances[0].accepted_by #=> String
resp.eula_acceptances[0].acceptee_id #=> String
resp.eula_acceptances[0].eula_acceptance_id #=> String
resp.eula_acceptances[0].eula_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :client_token (String)

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the AWS SDK automatically generates a client token and uses it for the request to ensure idempotency.

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

  • :eula_ids (Array<String>)

    The EULA ID.

  • :studio_id (required, String)

    A collection of EULA IDs.

Returns:

See Also:



381
382
383
384
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 381

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

#create_launch_profile(params = {}) ⇒ Types::CreateLaunchProfileResponse

Create a launch profile.

Examples:

Request syntax with placeholder values


resp = client.create_launch_profile({
  client_token: "ClientToken",
  description: "LaunchProfileDescription",
  ec2_subnet_ids: ["EC2SubnetId"], # required
  launch_profile_protocol_versions: ["LaunchProfileProtocolVersion"], # required
  name: "LaunchProfileName", # required
  stream_configuration: { # required
    clipboard_mode: "ENABLED", # required, accepts ENABLED, DISABLED
    ec2_instance_types: ["g4dn.xlarge"], # required, accepts g4dn.xlarge, g4dn.2xlarge, g4dn.4xlarge, g4dn.8xlarge, g4dn.12xlarge, g4dn.16xlarge
    max_session_length_in_minutes: 1,
    max_stopped_session_length_in_minutes: 1,
    streaming_image_ids: ["StreamingImageId"], # required
  },
  studio_component_ids: ["String"], # required
  studio_id: "String", # required
  tags: {
    "String" => "String",
  },
})

Response structure


resp.launch_profile.arn #=> String
resp.launch_profile.created_at #=> Time
resp.launch_profile.created_by #=> String
resp.launch_profile.description #=> String
resp.launch_profile.ec2_subnet_ids #=> Array
resp.launch_profile.ec2_subnet_ids[0] #=> String
resp.launch_profile.launch_profile_id #=> String
resp.launch_profile.launch_profile_protocol_versions #=> Array
resp.launch_profile.launch_profile_protocol_versions[0] #=> String
resp.launch_profile.name #=> String
resp.launch_profile.state #=> String, one of "CREATE_IN_PROGRESS", "READY", "UPDATE_IN_PROGRESS", "DELETE_IN_PROGRESS", "DELETED", "DELETE_FAILED", "CREATE_FAILED", "UPDATE_FAILED"
resp.launch_profile.status_code #=> String, one of "LAUNCH_PROFILE_CREATED", "LAUNCH_PROFILE_UPDATED", "LAUNCH_PROFILE_DELETED", "LAUNCH_PROFILE_CREATE_IN_PROGRESS", "LAUNCH_PROFILE_UPDATE_IN_PROGRESS", "LAUNCH_PROFILE_DELETE_IN_PROGRESS", "INTERNAL_ERROR", "STREAMING_IMAGE_NOT_FOUND", "STREAMING_IMAGE_NOT_READY", "LAUNCH_PROFILE_WITH_STREAM_SESSIONS_NOT_DELETED", "ENCRYPTION_KEY_ACCESS_DENIED", "ENCRYPTION_KEY_NOT_FOUND", "INVALID_SUBNETS_PROVIDED"
resp.launch_profile.status_message #=> String
resp.launch_profile.stream_configuration.clipboard_mode #=> String, one of "ENABLED", "DISABLED"
resp.launch_profile.stream_configuration.ec2_instance_types #=> Array
resp.launch_profile.stream_configuration.ec2_instance_types[0] #=> String, one of "g4dn.xlarge", "g4dn.2xlarge", "g4dn.4xlarge", "g4dn.8xlarge", "g4dn.12xlarge", "g4dn.16xlarge"
resp.launch_profile.stream_configuration.max_session_length_in_minutes #=> Integer
resp.launch_profile.stream_configuration.max_stopped_session_length_in_minutes #=> Integer
resp.launch_profile.stream_configuration.streaming_image_ids #=> Array
resp.launch_profile.stream_configuration.streaming_image_ids[0] #=> String
resp.launch_profile.studio_component_ids #=> Array
resp.launch_profile.studio_component_ids[0] #=> String
resp.launch_profile.tags #=> Hash
resp.launch_profile.tags["String"] #=> String
resp.launch_profile.updated_at #=> Time
resp.launch_profile.updated_by #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :client_token (String)

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the AWS SDK automatically generates a client token and uses it for the request to ensure idempotency.

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

  • :description (String)

    The description.

  • :ec2_subnet_ids (required, Array<String>)

    Specifies the IDs of the EC2 subnets where streaming sessions will be accessible from. These subnets must support the specified instance types.

  • :launch_profile_protocol_versions (required, Array<String>)

    The version number of the protocol that is used by the launch profile. The only valid version is "2021-03-31".

  • :name (required, String)

    The name for the launch profile.

  • :stream_configuration (required, Types::StreamConfigurationCreate)

    A configuration for a streaming session.

  • :studio_component_ids (required, Array<String>)

    Unique identifiers for a collection of studio components that can be used with this launch profile.

  • :studio_id (required, String)

    The studio ID.

  • :tags (Hash<String,String>)

    A collection of labels, in the form of key:value pairs, that apply to this resource.

Returns:

See Also:



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

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

#create_streaming_image(params = {}) ⇒ Types::CreateStreamingImageResponse

Creates a streaming image resource in a studio.

Examples:

Request syntax with placeholder values


resp = client.create_streaming_image({
  client_token: "ClientToken",
  description: "SyntheticCreateStreamingImageRequestStreamingImageDescription",
  ec2_image_id: "EC2ImageId", # required
  name: "SyntheticCreateStreamingImageRequestStreamingImageName", # required
  studio_id: "String", # required
  tags: {
    "String" => "String",
  },
})

Response structure


resp.streaming_image.arn #=> String
resp.streaming_image.description #=> String
resp.streaming_image.ec2_image_id #=> String
resp.streaming_image.encryption_configuration.key_arn #=> String
resp.streaming_image.encryption_configuration.key_type #=> String, one of "CUSTOMER_MANAGED_KEY"
resp.streaming_image.eula_ids #=> Array
resp.streaming_image.eula_ids[0] #=> String
resp.streaming_image.name #=> String
resp.streaming_image.owner #=> String
resp.streaming_image.platform #=> String
resp.streaming_image.state #=> String, one of "CREATE_IN_PROGRESS", "READY", "DELETE_IN_PROGRESS", "DELETED", "UPDATE_IN_PROGRESS", "UPDATE_FAILED", "CREATE_FAILED", "DELETE_FAILED"
resp.streaming_image.status_code #=> String, one of "STREAMING_IMAGE_CREATE_IN_PROGRESS", "STREAMING_IMAGE_READY", "STREAMING_IMAGE_DELETE_IN_PROGRESS", "STREAMING_IMAGE_DELETED", "STREAMING_IMAGE_UPDATE_IN_PROGRESS", "INTERNAL_ERROR"
resp.streaming_image.status_message #=> String
resp.streaming_image.streaming_image_id #=> String
resp.streaming_image.tags #=> Hash
resp.streaming_image.tags["String"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :client_token (String)

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the AWS SDK automatically generates a client token and uses it for the request to ensure idempotency.

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

  • :description (String)

    A human-readable description of the streaming image.

  • :ec2_image_id (required, String)

    The ID of an EC2 machine image with which to create this streaming image.

  • :name (required, String)

    A friendly name for a streaming image resource.

  • :studio_id (required, String)

    The studio ID.

  • :tags (Hash<String,String>)

    A collection of labels, in the form of key:value pairs, that apply to this resource.

Returns:

See Also:



558
559
560
561
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 558

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

#create_streaming_session(params = {}) ⇒ Types::CreateStreamingSessionResponse

Creates a streaming session in a studio.

After invoking this operation, you must poll GetStreamingSession until the streaming session is in state READY.

Examples:

Request syntax with placeholder values


resp = client.create_streaming_session({
  client_token: "ClientToken",
  ec2_instance_type: "g4dn.xlarge", # accepts g4dn.xlarge, g4dn.2xlarge, g4dn.4xlarge, g4dn.8xlarge, g4dn.12xlarge, g4dn.16xlarge
  launch_profile_id: "String",
  owned_by: "String",
  streaming_image_id: "StreamingImageId",
  studio_id: "String", # required
  tags: {
    "String" => "String",
  },
})

Response structure


resp.session.arn #=> String
resp.session.created_at #=> Time
resp.session.created_by #=> String
resp.session.ec2_instance_type #=> String
resp.session.launch_profile_id #=> String
resp.session.owned_by #=> String
resp.session.session_id #=> String
resp.session.started_at #=> Time
resp.session.started_by #=> String
resp.session.state #=> String, one of "CREATE_IN_PROGRESS", "DELETE_IN_PROGRESS", "READY", "DELETED", "CREATE_FAILED", "DELETE_FAILED", "STOP_IN_PROGRESS", "START_IN_PROGRESS", "STOPPED", "STOP_FAILED", "START_FAILED"
resp.session.status_code #=> String, one of "STREAMING_SESSION_READY", "STREAMING_SESSION_DELETED", "STREAMING_SESSION_CREATE_IN_PROGRESS", "STREAMING_SESSION_DELETE_IN_PROGRESS", "INTERNAL_ERROR", "INSUFFICIENT_CAPACITY", "ACTIVE_DIRECTORY_DOMAIN_JOIN_ERROR", "NETWORK_CONNECTION_ERROR", "INITIALIZATION_SCRIPT_ERROR", "DECRYPT_STREAMING_IMAGE_ERROR", "NETWORK_INTERFACE_ERROR", "STREAMING_SESSION_STOPPED", "STREAMING_SESSION_STARTED", "STREAMING_SESSION_STOP_IN_PROGRESS", "STREAMING_SESSION_START_IN_PROGRESS"
resp.session.status_message #=> String
resp.session.stop_at #=> Time
resp.session.stopped_at #=> Time
resp.session.stopped_by #=> String
resp.session.streaming_image_id #=> String
resp.session.tags #=> Hash
resp.session.tags["String"] #=> String
resp.session.terminate_at #=> Time
resp.session.updated_at #=> Time
resp.session.updated_by #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :client_token (String)

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the AWS SDK automatically generates a client token and uses it for the request to ensure idempotency.

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

  • :ec2_instance_type (String)

    The EC2 Instance type used for the streaming session.

  • :launch_profile_id (String)

    The launch profile ID.

  • :owned_by (String)

    The user ID of the user that owns the streaming session.

  • :streaming_image_id (String)

    The ID of the streaming image.

  • :studio_id (required, String)

    The studio ID.

  • :tags (Hash<String,String>)

    A collection of labels, in the form of key:value pairs, that apply to this resource.

Returns:

See Also:



642
643
644
645
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 642

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

#create_streaming_session_stream(params = {}) ⇒ Types::CreateStreamingSessionStreamResponse

Creates a streaming session stream for a streaming session.

After invoking this API, invoke GetStreamingSessionStream with the returned streamId to poll the resource until it is in state READY.

Examples:

Request syntax with placeholder values


resp = client.create_streaming_session_stream({
  client_token: "ClientToken",
  expiration_in_seconds: 1,
  session_id: "String", # required
  studio_id: "String", # required
})

Response structure


resp.stream.created_at #=> Time
resp.stream.created_by #=> String
resp.stream.expires_at #=> Time
resp.stream.owned_by #=> String
resp.stream.state #=> String, one of "READY", "CREATE_IN_PROGRESS", "DELETE_IN_PROGRESS", "DELETED", "CREATE_FAILED", "DELETE_FAILED"
resp.stream.status_code #=> String, one of "STREAM_CREATE_IN_PROGRESS", "STREAM_READY", "STREAM_DELETE_IN_PROGRESS", "STREAM_DELETED", "INTERNAL_ERROR", "NETWORK_CONNECTION_ERROR"
resp.stream.stream_id #=> String
resp.stream.url #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :client_token (String)

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the AWS SDK automatically generates a client token and uses it for the request to ensure idempotency.

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

  • :expiration_in_seconds (Integer)

    The expiration time in seconds.

  • :session_id (required, String)

    The streaming session ID.

  • :studio_id (required, String)

    The studio ID.

Returns:

See Also:



698
699
700
701
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 698

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

#create_studio(params = {}) ⇒ Types::CreateStudioResponse

Create a new Studio.

When creating a Studio, two IAM roles must be provided: the admin role and the user Role. These roles are assumed by your users when they log in to the Nimble Studio portal.

The user role must have the AmazonNimbleStudio-StudioUser managed policy attached for the portal to function properly.

The Admin Role must have the AmazonNimbleStudio-StudioAdmin managed policy attached for the portal to function properly.

You may optionally specify a KMS key in the StudioEncryptionConfiguration.

In Nimble Studio, resource names, descriptions, initialization scripts, and other data you provide are always encrypted at rest using an KMS key. By default, this key is owned by Amazon Web Services and managed on your behalf. You may provide your own KMS key when calling CreateStudio to encrypt this data using a key you own and manage.

When providing an KMS key during studio creation, Nimble Studio creates KMS grants in your account to provide your studio user and admin roles access to these KMS keys.

If you delete this grant, the studio will no longer be accessible to your portal users.

If you delete the studio KMS key, your studio will no longer be accessible.

Examples:

Request syntax with placeholder values


resp = client.create_studio({
  admin_role_arn: "String", # required
  client_token: "ClientToken",
  display_name: "SyntheticCreateStudioRequestStudioDisplayName", # required
  studio_encryption_configuration: {
    key_arn: "StudioEncryptionConfigurationKeyArn",
    key_type: "AWS_OWNED_KEY", # required, accepts AWS_OWNED_KEY, CUSTOMER_MANAGED_KEY
  },
  studio_name: "StudioName", # required
  tags: {
    "String" => "String",
  },
  user_role_arn: "String", # required
})

Response structure


resp.studio.admin_role_arn #=> String
resp.studio.arn #=> String
resp.studio.created_at #=> Time
resp.studio.display_name #=> String
resp.studio.home_region #=> String
resp.studio.sso_client_id #=> String
resp.studio.state #=> String, one of "CREATE_IN_PROGRESS", "READY", "UPDATE_IN_PROGRESS", "DELETE_IN_PROGRESS", "DELETED", "DELETE_FAILED", "CREATE_FAILED", "UPDATE_FAILED"
resp.studio.status_code #=> String, one of "STUDIO_CREATED", "STUDIO_DELETED", "STUDIO_UPDATED", "STUDIO_CREATE_IN_PROGRESS", "STUDIO_UPDATE_IN_PROGRESS", "STUDIO_DELETE_IN_PROGRESS", "STUDIO_WITH_LAUNCH_PROFILES_NOT_DELETED", "STUDIO_WITH_STUDIO_COMPONENTS_NOT_DELETED", "STUDIO_WITH_STREAMING_IMAGES_NOT_DELETED", "AWS_SSO_NOT_ENABLED", "AWS_SSO_ACCESS_DENIED", "ROLE_NOT_OWNED_BY_STUDIO_OWNER", "ROLE_COULD_NOT_BE_ASSUMED", "INTERNAL_ERROR", "ENCRYPTION_KEY_NOT_FOUND", "ENCRYPTION_KEY_ACCESS_DENIED", "AWS_SSO_CONFIGURATION_REPAIRED", "AWS_SSO_CONFIGURATION_REPAIR_IN_PROGRESS"
resp.studio.status_message #=> String
resp.studio.studio_encryption_configuration.key_arn #=> String
resp.studio.studio_encryption_configuration.key_type #=> String, one of "AWS_OWNED_KEY", "CUSTOMER_MANAGED_KEY"
resp.studio.studio_id #=> String
resp.studio.studio_name #=> String
resp.studio.studio_url #=> String
resp.studio.tags #=> Hash
resp.studio.tags["String"] #=> String
resp.studio.updated_at #=> Time
resp.studio.user_role_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :admin_role_arn (required, String)

    The IAM role that Studio Admins will assume when logging in to the Nimble Studio portal.

  • :client_token (String)

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the AWS SDK automatically generates a client token and uses it for the request to ensure idempotency.

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

  • :display_name (required, String)

    A friendly name for the studio.

  • :studio_encryption_configuration (Types::StudioEncryptionConfiguration)

    The studio encryption configuration.

  • :studio_name (required, String)

    The studio name that is used in the URL of the Nimble Studio portal when accessed by Nimble Studio users.

  • :tags (Hash<String,String>)

    A collection of labels, in the form of key:value pairs, that apply to this resource.

  • :user_role_arn (required, String)

    The IAM role that Studio Users will assume when logging in to the Nimble Studio portal.

Returns:

See Also:



811
812
813
814
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 811

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

#create_studio_component(params = {}) ⇒ Types::CreateStudioComponentResponse

Creates a studio component resource.

Examples:

Request syntax with placeholder values


resp = client.create_studio_component({
  client_token: "ClientToken",
  configuration: {
    active_directory_configuration: {
      computer_attributes: [
        {
          name: "ActiveDirectoryComputerAttributeName",
          value: "ActiveDirectoryComputerAttributeValue",
        },
      ],
      directory_id: "DirectoryId",
      organizational_unit_distinguished_name: "ActiveDirectoryOrganizationalUnitDistinguishedName",
    },
    compute_farm_configuration: {
      active_directory_user: "String",
      endpoint: "SyntheticComputeFarmConfigurationString",
    },
    license_service_configuration: {
      endpoint: "SyntheticLicenseServiceConfigurationString",
    },
    shared_file_system_configuration: {
      endpoint: "SyntheticSharedFileSystemConfigurationString",
      file_system_id: "String",
      linux_mount_point: "LinuxMountPoint",
      share_name: "SyntheticSharedFileSystemConfigurationString",
      windows_mount_drive: "WindowsMountDrive",
    },
  },
  description: "StudioComponentDescription",
  ec2_security_group_ids: ["SecurityGroupId"],
  initialization_scripts: [
    {
      launch_profile_protocol_version: "LaunchProfileProtocolVersion",
      platform: "LINUX", # accepts LINUX, WINDOWS
      run_context: "SYSTEM_INITIALIZATION", # accepts SYSTEM_INITIALIZATION, USER_INITIALIZATION
      script: "StudioComponentInitializationScriptContent",
    },
  ],
  name: "StudioComponentName", # required
  script_parameters: [
    {
      key: "ScriptParameterKey",
      value: "ScriptParameterValue",
    },
  ],
  studio_id: "String", # required
  subtype: "AWS_MANAGED_MICROSOFT_AD", # accepts AWS_MANAGED_MICROSOFT_AD, AMAZON_FSX_FOR_WINDOWS, AMAZON_FSX_FOR_LUSTRE, CUSTOM
  tags: {
    "String" => "String",
  },
  type: "ACTIVE_DIRECTORY", # required, accepts ACTIVE_DIRECTORY, SHARED_FILE_SYSTEM, COMPUTE_FARM, LICENSE_SERVICE, CUSTOM
})

Response structure


resp.studio_component.arn #=> String
resp.studio_component.configuration.active_directory_configuration.computer_attributes #=> Array
resp.studio_component.configuration.active_directory_configuration.computer_attributes[0].name #=> String
resp.studio_component.configuration.active_directory_configuration.computer_attributes[0].value #=> String
resp.studio_component.configuration.active_directory_configuration.directory_id #=> String
resp.studio_component.configuration.active_directory_configuration.organizational_unit_distinguished_name #=> String
resp.studio_component.configuration.compute_farm_configuration.active_directory_user #=> String
resp.studio_component.configuration.compute_farm_configuration.endpoint #=> String
resp.studio_component.configuration.license_service_configuration.endpoint #=> String
resp.studio_component.configuration.shared_file_system_configuration.endpoint #=> String
resp.studio_component.configuration.shared_file_system_configuration.file_system_id #=> String
resp.studio_component.configuration.shared_file_system_configuration.linux_mount_point #=> String
resp.studio_component.configuration.shared_file_system_configuration.share_name #=> String
resp.studio_component.configuration.shared_file_system_configuration.windows_mount_drive #=> String
resp.studio_component.created_at #=> Time
resp.studio_component.created_by #=> String
resp.studio_component.description #=> String
resp.studio_component.ec2_security_group_ids #=> Array
resp.studio_component.ec2_security_group_ids[0] #=> String
resp.studio_component.initialization_scripts #=> Array
resp.studio_component.initialization_scripts[0].launch_profile_protocol_version #=> String
resp.studio_component.initialization_scripts[0].platform #=> String, one of "LINUX", "WINDOWS"
resp.studio_component.initialization_scripts[0].run_context #=> String, one of "SYSTEM_INITIALIZATION", "USER_INITIALIZATION"
resp.studio_component.initialization_scripts[0].script #=> String
resp.studio_component.name #=> String
resp.studio_component.script_parameters #=> Array
resp.studio_component.script_parameters[0].key #=> String
resp.studio_component.script_parameters[0].value #=> String
resp.studio_component.state #=> String, one of "CREATE_IN_PROGRESS", "READY", "UPDATE_IN_PROGRESS", "DELETE_IN_PROGRESS", "DELETED", "DELETE_FAILED", "CREATE_FAILED", "UPDATE_FAILED"
resp.studio_component.status_code #=> String, one of "ACTIVE_DIRECTORY_ALREADY_EXISTS", "STUDIO_COMPONENT_CREATED", "STUDIO_COMPONENT_UPDATED", "STUDIO_COMPONENT_DELETED", "ENCRYPTION_KEY_ACCESS_DENIED", "ENCRYPTION_KEY_NOT_FOUND", "STUDIO_COMPONENT_CREATE_IN_PROGRESS", "STUDIO_COMPONENT_UPDATE_IN_PROGRESS", "STUDIO_COMPONENT_DELETE_IN_PROGRESS", "INTERNAL_ERROR"
resp.studio_component.status_message #=> String
resp.studio_component.studio_component_id #=> String
resp.studio_component.subtype #=> String, one of "AWS_MANAGED_MICROSOFT_AD", "AMAZON_FSX_FOR_WINDOWS", "AMAZON_FSX_FOR_LUSTRE", "CUSTOM"
resp.studio_component.tags #=> Hash
resp.studio_component.tags["String"] #=> String
resp.studio_component.type #=> String, one of "ACTIVE_DIRECTORY", "SHARED_FILE_SYSTEM", "COMPUTE_FARM", "LICENSE_SERVICE", "CUSTOM"
resp.studio_component.updated_at #=> Time
resp.studio_component.updated_by #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :client_token (String)

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the AWS SDK automatically generates a client token and uses it for the request to ensure idempotency.

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

  • :configuration (Types::StudioComponentConfiguration)

    The configuration of the studio component, based on component type.

  • :description (String)

    The description.

  • :ec2_security_group_ids (Array<String>)

    The EC2 security groups that control access to the studio component.

  • :initialization_scripts (Array<Types::StudioComponentInitializationScript>)

    Initialization scripts for studio components.

  • :name (required, String)

    The name for the studio component.

  • :script_parameters (Array<Types::ScriptParameterKeyValue>)

    Parameters for the studio component scripts.

  • :studio_id (required, String)

    The studio ID.

  • :subtype (String)

    The specific subtype of a studio component.

  • :tags (Hash<String,String>)

    A collection of labels, in the form of key:value pairs, that apply to this resource.

  • :type (required, String)

    The type of the studio component.

Returns:

See Also:



962
963
964
965
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 962

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

#delete_launch_profile(params = {}) ⇒ Types::DeleteLaunchProfileResponse

Permanently delete a launch profile.

Examples:

Request syntax with placeholder values


resp = client.delete_launch_profile({
  client_token: "ClientToken",
  launch_profile_id: "String", # required
  studio_id: "String", # required
})

Response structure


resp.launch_profile.arn #=> String
resp.launch_profile.created_at #=> Time
resp.launch_profile.created_by #=> String
resp.launch_profile.description #=> String
resp.launch_profile.ec2_subnet_ids #=> Array
resp.launch_profile.ec2_subnet_ids[0] #=> String
resp.launch_profile.launch_profile_id #=> String
resp.launch_profile.launch_profile_protocol_versions #=> Array
resp.launch_profile.launch_profile_protocol_versions[0] #=> String
resp.launch_profile.name #=> String
resp.launch_profile.state #=> String, one of "CREATE_IN_PROGRESS", "READY", "UPDATE_IN_PROGRESS", "DELETE_IN_PROGRESS", "DELETED", "DELETE_FAILED", "CREATE_FAILED", "UPDATE_FAILED"
resp.launch_profile.status_code #=> String, one of "LAUNCH_PROFILE_CREATED", "LAUNCH_PROFILE_UPDATED", "LAUNCH_PROFILE_DELETED", "LAUNCH_PROFILE_CREATE_IN_PROGRESS", "LAUNCH_PROFILE_UPDATE_IN_PROGRESS", "LAUNCH_PROFILE_DELETE_IN_PROGRESS", "INTERNAL_ERROR", "STREAMING_IMAGE_NOT_FOUND", "STREAMING_IMAGE_NOT_READY", "LAUNCH_PROFILE_WITH_STREAM_SESSIONS_NOT_DELETED", "ENCRYPTION_KEY_ACCESS_DENIED", "ENCRYPTION_KEY_NOT_FOUND", "INVALID_SUBNETS_PROVIDED"
resp.launch_profile.status_message #=> String
resp.launch_profile.stream_configuration.clipboard_mode #=> String, one of "ENABLED", "DISABLED"
resp.launch_profile.stream_configuration.ec2_instance_types #=> Array
resp.launch_profile.stream_configuration.ec2_instance_types[0] #=> String, one of "g4dn.xlarge", "g4dn.2xlarge", "g4dn.4xlarge", "g4dn.8xlarge", "g4dn.12xlarge", "g4dn.16xlarge"
resp.launch_profile.stream_configuration.max_session_length_in_minutes #=> Integer
resp.launch_profile.stream_configuration.max_stopped_session_length_in_minutes #=> Integer
resp.launch_profile.stream_configuration.streaming_image_ids #=> Array
resp.launch_profile.stream_configuration.streaming_image_ids[0] #=> String
resp.launch_profile.studio_component_ids #=> Array
resp.launch_profile.studio_component_ids[0] #=> String
resp.launch_profile.tags #=> Hash
resp.launch_profile.tags["String"] #=> String
resp.launch_profile.updated_at #=> Time
resp.launch_profile.updated_by #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :client_token (String)

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the AWS SDK automatically generates a client token and uses it for the request to ensure idempotency.

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

  • :launch_profile_id (required, String)

    The Launch Profile ID.

  • :studio_id (required, String)

    The studio ID.

Returns:

See Also:



1029
1030
1031
1032
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 1029

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

#delete_launch_profile_member(params = {}) ⇒ Struct

Delete a user from launch profile membership.

Examples:

Request syntax with placeholder values


resp = client.delete_launch_profile_member({
  client_token: "ClientToken",
  launch_profile_id: "String", # required
  principal_id: "String", # required
  studio_id: "String", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :client_token (String)

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the AWS SDK automatically generates a client token and uses it for the request to ensure idempotency.

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

  • :launch_profile_id (required, String)

    The Launch Profile ID.

  • :principal_id (required, String)

    The principal ID. This currently supports a Amazon Web Services SSO UserId.

  • :studio_id (required, String)

    The studio ID.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1070
1071
1072
1073
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 1070

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

#delete_streaming_image(params = {}) ⇒ Types::DeleteStreamingImageResponse

Delete streaming image.

Examples:

Request syntax with placeholder values


resp = client.delete_streaming_image({
  client_token: "ClientToken",
  streaming_image_id: "String", # required
  studio_id: "String", # required
})

Response structure


resp.streaming_image.arn #=> String
resp.streaming_image.description #=> String
resp.streaming_image.ec2_image_id #=> String
resp.streaming_image.encryption_configuration.key_arn #=> String
resp.streaming_image.encryption_configuration.key_type #=> String, one of "CUSTOMER_MANAGED_KEY"
resp.streaming_image.eula_ids #=> Array
resp.streaming_image.eula_ids[0] #=> String
resp.streaming_image.name #=> String
resp.streaming_image.owner #=> String
resp.streaming_image.platform #=> String
resp.streaming_image.state #=> String, one of "CREATE_IN_PROGRESS", "READY", "DELETE_IN_PROGRESS", "DELETED", "UPDATE_IN_PROGRESS", "UPDATE_FAILED", "CREATE_FAILED", "DELETE_FAILED"
resp.streaming_image.status_code #=> String, one of "STREAMING_IMAGE_CREATE_IN_PROGRESS", "STREAMING_IMAGE_READY", "STREAMING_IMAGE_DELETE_IN_PROGRESS", "STREAMING_IMAGE_DELETED", "STREAMING_IMAGE_UPDATE_IN_PROGRESS", "INTERNAL_ERROR"
resp.streaming_image.status_message #=> String
resp.streaming_image.streaming_image_id #=> String
resp.streaming_image.tags #=> Hash
resp.streaming_image.tags["String"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :client_token (String)

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the AWS SDK automatically generates a client token and uses it for the request to ensure idempotency.

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

  • :streaming_image_id (required, String)

    The streaming image ID.

  • :studio_id (required, String)

    The studio ID.

Returns:

See Also:



1127
1128
1129
1130
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 1127

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

#delete_streaming_session(params = {}) ⇒ Types::DeleteStreamingSessionResponse

Deletes streaming session resource.

After invoking this operation, use GetStreamingSession to poll the resource until it transitions to a DELETED state.

A streaming session will count against your streaming session quota until it is marked DELETED.

Examples:

Request syntax with placeholder values


resp = client.delete_streaming_session({
  client_token: "ClientToken",
  session_id: "String", # required
  studio_id: "String", # required
})

Response structure


resp.session.arn #=> String
resp.session.created_at #=> Time
resp.session.created_by #=> String
resp.session.ec2_instance_type #=> String
resp.session.launch_profile_id #=> String
resp.session.owned_by #=> String
resp.session.session_id #=> String
resp.session.started_at #=> Time
resp.session.started_by #=> String
resp.session.state #=> String, one of "CREATE_IN_PROGRESS", "DELETE_IN_PROGRESS", "READY", "DELETED", "CREATE_FAILED", "DELETE_FAILED", "STOP_IN_PROGRESS", "START_IN_PROGRESS", "STOPPED", "STOP_FAILED", "START_FAILED"
resp.session.status_code #=> String, one of "STREAMING_SESSION_READY", "STREAMING_SESSION_DELETED", "STREAMING_SESSION_CREATE_IN_PROGRESS", "STREAMING_SESSION_DELETE_IN_PROGRESS", "INTERNAL_ERROR", "INSUFFICIENT_CAPACITY", "ACTIVE_DIRECTORY_DOMAIN_JOIN_ERROR", "NETWORK_CONNECTION_ERROR", "INITIALIZATION_SCRIPT_ERROR", "DECRYPT_STREAMING_IMAGE_ERROR", "NETWORK_INTERFACE_ERROR", "STREAMING_SESSION_STOPPED", "STREAMING_SESSION_STARTED", "STREAMING_SESSION_STOP_IN_PROGRESS", "STREAMING_SESSION_START_IN_PROGRESS"
resp.session.status_message #=> String
resp.session.stop_at #=> Time
resp.session.stopped_at #=> Time
resp.session.stopped_by #=> String
resp.session.streaming_image_id #=> String
resp.session.tags #=> Hash
resp.session.tags["String"] #=> String
resp.session.terminate_at #=> Time
resp.session.updated_at #=> Time
resp.session.updated_by #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :client_token (String)

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the AWS SDK automatically generates a client token and uses it for the request to ensure idempotency.

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

  • :session_id (required, String)

    The streaming session ID.

  • :studio_id (required, String)

    The studio ID.

Returns:

See Also:



1195
1196
1197
1198
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 1195

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

#delete_studio(params = {}) ⇒ Types::DeleteStudioResponse

Delete a studio resource.

Examples:

Request syntax with placeholder values


resp = client.delete_studio({
  client_token: "ClientToken",
  studio_id: "String", # required
})

Response structure


resp.studio.admin_role_arn #=> String
resp.studio.arn #=> String
resp.studio.created_at #=> Time
resp.studio.display_name #=> String
resp.studio.home_region #=> String
resp.studio.sso_client_id #=> String
resp.studio.state #=> String, one of "CREATE_IN_PROGRESS", "READY", "UPDATE_IN_PROGRESS", "DELETE_IN_PROGRESS", "DELETED", "DELETE_FAILED", "CREATE_FAILED", "UPDATE_FAILED"
resp.studio.status_code #=> String, one of "STUDIO_CREATED", "STUDIO_DELETED", "STUDIO_UPDATED", "STUDIO_CREATE_IN_PROGRESS", "STUDIO_UPDATE_IN_PROGRESS", "STUDIO_DELETE_IN_PROGRESS", "STUDIO_WITH_LAUNCH_PROFILES_NOT_DELETED", "STUDIO_WITH_STUDIO_COMPONENTS_NOT_DELETED", "STUDIO_WITH_STREAMING_IMAGES_NOT_DELETED", "AWS_SSO_NOT_ENABLED", "AWS_SSO_ACCESS_DENIED", "ROLE_NOT_OWNED_BY_STUDIO_OWNER", "ROLE_COULD_NOT_BE_ASSUMED", "INTERNAL_ERROR", "ENCRYPTION_KEY_NOT_FOUND", "ENCRYPTION_KEY_ACCESS_DENIED", "AWS_SSO_CONFIGURATION_REPAIRED", "AWS_SSO_CONFIGURATION_REPAIR_IN_PROGRESS"
resp.studio.status_message #=> String
resp.studio.studio_encryption_configuration.key_arn #=> String
resp.studio.studio_encryption_configuration.key_type #=> String, one of "AWS_OWNED_KEY", "CUSTOMER_MANAGED_KEY"
resp.studio.studio_id #=> String
resp.studio.studio_name #=> String
resp.studio.studio_url #=> String
resp.studio.tags #=> Hash
resp.studio.tags["String"] #=> String
resp.studio.updated_at #=> Time
resp.studio.user_role_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :client_token (String)

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the AWS SDK automatically generates a client token and uses it for the request to ensure idempotency.

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

  • :studio_id (required, String)

    The studio ID.

Returns:

See Also:



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

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

#delete_studio_component(params = {}) ⇒ Types::DeleteStudioComponentResponse

Deletes a studio component resource.

Examples:

Request syntax with placeholder values


resp = client.delete_studio_component({
  client_token: "ClientToken",
  studio_component_id: "String", # required
  studio_id: "String", # required
})

Response structure


resp.studio_component.arn #=> String
resp.studio_component.configuration.active_directory_configuration.computer_attributes #=> Array
resp.studio_component.configuration.active_directory_configuration.computer_attributes[0].name #=> String
resp.studio_component.configuration.active_directory_configuration.computer_attributes[0].value #=> String
resp.studio_component.configuration.active_directory_configuration.directory_id #=> String
resp.studio_component.configuration.active_directory_configuration.organizational_unit_distinguished_name #=> String
resp.studio_component.configuration.compute_farm_configuration.active_directory_user #=> String
resp.studio_component.configuration.compute_farm_configuration.endpoint #=> String
resp.studio_component.configuration.license_service_configuration.endpoint #=> String
resp.studio_component.configuration.shared_file_system_configuration.endpoint #=> String
resp.studio_component.configuration.shared_file_system_configuration.file_system_id #=> String
resp.studio_component.configuration.shared_file_system_configuration.linux_mount_point #=> String
resp.studio_component.configuration.shared_file_system_configuration.share_name #=> String
resp.studio_component.configuration.shared_file_system_configuration.windows_mount_drive #=> String
resp.studio_component.created_at #=> Time
resp.studio_component.created_by #=> String
resp.studio_component.description #=> String
resp.studio_component.ec2_security_group_ids #=> Array
resp.studio_component.ec2_security_group_ids[0] #=> String
resp.studio_component.initialization_scripts #=> Array
resp.studio_component.initialization_scripts[0].launch_profile_protocol_version #=> String
resp.studio_component.initialization_scripts[0].platform #=> String, one of "LINUX", "WINDOWS"
resp.studio_component.initialization_scripts[0].run_context #=> String, one of "SYSTEM_INITIALIZATION", "USER_INITIALIZATION"
resp.studio_component.initialization_scripts[0].script #=> String
resp.studio_component.name #=> String
resp.studio_component.script_parameters #=> Array
resp.studio_component.script_parameters[0].key #=> String
resp.studio_component.script_parameters[0].value #=> String
resp.studio_component.state #=> String, one of "CREATE_IN_PROGRESS", "READY", "UPDATE_IN_PROGRESS", "DELETE_IN_PROGRESS", "DELETED", "DELETE_FAILED", "CREATE_FAILED", "UPDATE_FAILED"
resp.studio_component.status_code #=> String, one of "ACTIVE_DIRECTORY_ALREADY_EXISTS", "STUDIO_COMPONENT_CREATED", "STUDIO_COMPONENT_UPDATED", "STUDIO_COMPONENT_DELETED", "ENCRYPTION_KEY_ACCESS_DENIED", "ENCRYPTION_KEY_NOT_FOUND", "STUDIO_COMPONENT_CREATE_IN_PROGRESS", "STUDIO_COMPONENT_UPDATE_IN_PROGRESS", "STUDIO_COMPONENT_DELETE_IN_PROGRESS", "INTERNAL_ERROR"
resp.studio_component.status_message #=> String
resp.studio_component.studio_component_id #=> String
resp.studio_component.subtype #=> String, one of "AWS_MANAGED_MICROSOFT_AD", "AMAZON_FSX_FOR_WINDOWS", "AMAZON_FSX_FOR_LUSTRE", "CUSTOM"
resp.studio_component.tags #=> Hash
resp.studio_component.tags["String"] #=> String
resp.studio_component.type #=> String, one of "ACTIVE_DIRECTORY", "SHARED_FILE_SYSTEM", "COMPUTE_FARM", "LICENSE_SERVICE", "CUSTOM"
resp.studio_component.updated_at #=> Time
resp.studio_component.updated_by #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :client_token (String)

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the AWS SDK automatically generates a client token and uses it for the request to ensure idempotency.

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

  • :studio_component_id (required, String)

    The studio component ID.

  • :studio_id (required, String)

    The studio ID.

Returns:

See Also:



1329
1330
1331
1332
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 1329

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

#delete_studio_member(params = {}) ⇒ Struct

Delete a user from studio membership.

Examples:

Request syntax with placeholder values


resp = client.delete_studio_member({
  client_token: "ClientToken",
  principal_id: "String", # required
  studio_id: "String", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :client_token (String)

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the AWS SDK automatically generates a client token and uses it for the request to ensure idempotency.

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

  • :principal_id (required, String)

    The principal ID. This currently supports a Amazon Web Services SSO UserId.

  • :studio_id (required, String)

    The studio ID.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1366
1367
1368
1369
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 1366

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

#get_eula(params = {}) ⇒ Types::GetEulaResponse

Get Eula.

Examples:

Request syntax with placeholder values


resp = client.get_eula({
  eula_id: "String", # required
})

Response structure


resp.eula.content #=> String
resp.eula.created_at #=> Time
resp.eula.eula_id #=> String
resp.eula.name #=> String
resp.eula.updated_at #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :eula_id (required, String)

    The EULA ID.

Returns:

See Also:



1398
1399
1400
1401
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 1398

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

#get_launch_profile(params = {}) ⇒ Types::GetLaunchProfileResponse

Get a launch profile.

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

  • launch_profile_deleted
  • launch_profile_ready

Examples:

Request syntax with placeholder values


resp = client.get_launch_profile({
  launch_profile_id: "String", # required
  studio_id: "String", # required
})

Response structure


resp.launch_profile.arn #=> String
resp.launch_profile.created_at #=> Time
resp.launch_profile.created_by #=> String
resp.launch_profile.description #=> String
resp.launch_profile.ec2_subnet_ids #=> Array
resp.launch_profile.ec2_subnet_ids[0] #=> String
resp.launch_profile.launch_profile_id #=> String
resp.launch_profile.launch_profile_protocol_versions #=> Array
resp.launch_profile.launch_profile_protocol_versions[0] #=> String
resp.launch_profile.name #=> String
resp.launch_profile.state #=> String, one of "CREATE_IN_PROGRESS", "READY", "UPDATE_IN_PROGRESS", "DELETE_IN_PROGRESS", "DELETED", "DELETE_FAILED", "CREATE_FAILED", "UPDATE_FAILED"
resp.launch_profile.status_code #=> String, one of "LAUNCH_PROFILE_CREATED", "LAUNCH_PROFILE_UPDATED", "LAUNCH_PROFILE_DELETED", "LAUNCH_PROFILE_CREATE_IN_PROGRESS", "LAUNCH_PROFILE_UPDATE_IN_PROGRESS", "LAUNCH_PROFILE_DELETE_IN_PROGRESS", "INTERNAL_ERROR", "STREAMING_IMAGE_NOT_FOUND", "STREAMING_IMAGE_NOT_READY", "LAUNCH_PROFILE_WITH_STREAM_SESSIONS_NOT_DELETED", "ENCRYPTION_KEY_ACCESS_DENIED", "ENCRYPTION_KEY_NOT_FOUND", "INVALID_SUBNETS_PROVIDED"
resp.launch_profile.status_message #=> String
resp.launch_profile.stream_configuration.clipboard_mode #=> String, one of "ENABLED", "DISABLED"
resp.launch_profile.stream_configuration.ec2_instance_types #=> Array
resp.launch_profile.stream_configuration.ec2_instance_types[0] #=> String, one of "g4dn.xlarge", "g4dn.2xlarge", "g4dn.4xlarge", "g4dn.8xlarge", "g4dn.12xlarge", "g4dn.16xlarge"
resp.launch_profile.stream_configuration.max_session_length_in_minutes #=> Integer
resp.launch_profile.stream_configuration.max_stopped_session_length_in_minutes #=> Integer
resp.launch_profile.stream_configuration.streaming_image_ids #=> Array
resp.launch_profile.stream_configuration.streaming_image_ids[0] #=> String
resp.launch_profile.studio_component_ids #=> Array
resp.launch_profile.studio_component_ids[0] #=> String
resp.launch_profile.tags #=> Hash
resp.launch_profile.tags["String"] #=> String
resp.launch_profile.updated_at #=> Time
resp.launch_profile.updated_by #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :launch_profile_id (required, String)

    The Launch Profile ID.

  • :studio_id (required, String)

    The studio ID.

Returns:

See Also:



1461
1462
1463
1464
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 1461

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

#get_launch_profile_details(params = {}) ⇒ Types::GetLaunchProfileDetailsResponse

Launch profile details include the launch profile resource and summary information of resources that are used by, or available to, the launch profile. This includes the name and description of all studio components used by the launch profiles, and the name and description of streaming images that can be used with this launch profile.

Examples:

Request syntax with placeholder values


resp = client.get_launch_profile_details({
  launch_profile_id: "String", # required
  studio_id: "String", # required
})

Response structure


resp.launch_profile.arn #=> String
resp.launch_profile.created_at #=> Time
resp.launch_profile.created_by #=> String
resp.launch_profile.description #=> String
resp.launch_profile.ec2_subnet_ids #=> Array
resp.launch_profile.ec2_subnet_ids[0] #=> String
resp.launch_profile.launch_profile_id #=> String
resp.launch_profile.launch_profile_protocol_versions #=> Array
resp.launch_profile.launch_profile_protocol_versions[0] #=> String
resp.launch_profile.name #=> String
resp.launch_profile.state #=> String, one of "CREATE_IN_PROGRESS", "READY", "UPDATE_IN_PROGRESS", "DELETE_IN_PROGRESS", "DELETED", "DELETE_FAILED", "CREATE_FAILED", "UPDATE_FAILED"
resp.launch_profile.status_code #=> String, one of "LAUNCH_PROFILE_CREATED", "LAUNCH_PROFILE_UPDATED", "LAUNCH_PROFILE_DELETED", "LAUNCH_PROFILE_CREATE_IN_PROGRESS", "LAUNCH_PROFILE_UPDATE_IN_PROGRESS", "LAUNCH_PROFILE_DELETE_IN_PROGRESS", "INTERNAL_ERROR", "STREAMING_IMAGE_NOT_FOUND", "STREAMING_IMAGE_NOT_READY", "LAUNCH_PROFILE_WITH_STREAM_SESSIONS_NOT_DELETED", "ENCRYPTION_KEY_ACCESS_DENIED", "ENCRYPTION_KEY_NOT_FOUND", "INVALID_SUBNETS_PROVIDED"
resp.launch_profile.status_message #=> String
resp.launch_profile.stream_configuration.clipboard_mode #=> String, one of "ENABLED", "DISABLED"
resp.launch_profile.stream_configuration.ec2_instance_types #=> Array
resp.launch_profile.stream_configuration.ec2_instance_types[0] #=> String, one of "g4dn.xlarge", "g4dn.2xlarge", "g4dn.4xlarge", "g4dn.8xlarge", "g4dn.12xlarge", "g4dn.16xlarge"
resp.launch_profile.stream_configuration.max_session_length_in_minutes #=> Integer
resp.launch_profile.stream_configuration.max_stopped_session_length_in_minutes #=> Integer
resp.launch_profile.stream_configuration.streaming_image_ids #=> Array
resp.launch_profile.stream_configuration.streaming_image_ids[0] #=> String
resp.launch_profile.studio_component_ids #=> Array
resp.launch_profile.studio_component_ids[0] #=> String
resp.launch_profile.tags #=> Hash
resp.launch_profile.tags["String"] #=> String
resp.launch_profile.updated_at #=> Time
resp.launch_profile.updated_by #=> String
resp.streaming_images #=> Array
resp.streaming_images[0].arn #=> String
resp.streaming_images[0].description #=> String
resp.streaming_images[0].ec2_image_id #=> String
resp.streaming_images[0].encryption_configuration.key_arn #=> String
resp.streaming_images[0].encryption_configuration.key_type #=> String, one of "CUSTOMER_MANAGED_KEY"
resp.streaming_images[0].eula_ids #=> Array
resp.streaming_images[0].eula_ids[0] #=> String
resp.streaming_images[0].name #=> String
resp.streaming_images[0].owner #=> String
resp.streaming_images[0].platform #=> String
resp.streaming_images[0].state #=> String, one of "CREATE_IN_PROGRESS", "READY", "DELETE_IN_PROGRESS", "DELETED", "UPDATE_IN_PROGRESS", "UPDATE_FAILED", "CREATE_FAILED", "DELETE_FAILED"
resp.streaming_images[0].status_code #=> String, one of "STREAMING_IMAGE_CREATE_IN_PROGRESS", "STREAMING_IMAGE_READY", "STREAMING_IMAGE_DELETE_IN_PROGRESS", "STREAMING_IMAGE_DELETED", "STREAMING_IMAGE_UPDATE_IN_PROGRESS", "INTERNAL_ERROR"
resp.streaming_images[0].status_message #=> String
resp.streaming_images[0].streaming_image_id #=> String
resp.streaming_images[0].tags #=> Hash
resp.streaming_images[0].tags["String"] #=> String
resp.studio_component_summaries #=> Array
resp.studio_component_summaries[0].created_at #=> Time
resp.studio_component_summaries[0].created_by #=> String
resp.studio_component_summaries[0].description #=> String
resp.studio_component_summaries[0].name #=> String
resp.studio_component_summaries[0].studio_component_id #=> String
resp.studio_component_summaries[0].subtype #=> String, one of "AWS_MANAGED_MICROSOFT_AD", "AMAZON_FSX_FOR_WINDOWS", "AMAZON_FSX_FOR_LUSTRE", "CUSTOM"
resp.studio_component_summaries[0].type #=> String, one of "ACTIVE_DIRECTORY", "SHARED_FILE_SYSTEM", "COMPUTE_FARM", "LICENSE_SERVICE", "CUSTOM"
resp.studio_component_summaries[0].updated_at #=> Time
resp.studio_component_summaries[0].updated_by #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :launch_profile_id (required, String)

    The Launch Profile ID.

  • :studio_id (required, String)

    The studio ID.

Returns:

See Also:



1551
1552
1553
1554
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 1551

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

#get_launch_profile_initialization(params = {}) ⇒ Types::GetLaunchProfileInitializationResponse

Get a launch profile initialization.

Examples:

Request syntax with placeholder values


resp = client.get_launch_profile_initialization({
  launch_profile_id: "String", # required
  launch_profile_protocol_versions: ["String"], # required
  launch_purpose: "String", # required
  platform: "String", # required
  studio_id: "String", # required
})

Response structure


resp.launch_profile_initialization.active_directory.computer_attributes #=> Array
resp.launch_profile_initialization.active_directory.computer_attributes[0].name #=> String
resp.launch_profile_initialization.active_directory.computer_attributes[0].value #=> String
resp.launch_profile_initialization.active_directory.directory_id #=> String
resp.launch_profile_initialization.active_directory.directory_name #=> String
resp.launch_profile_initialization.active_directory.dns_ip_addresses #=> Array
resp.launch_profile_initialization.active_directory.dns_ip_addresses[0] #=> String
resp.launch_profile_initialization.active_directory.organizational_unit_distinguished_name #=> String
resp.launch_profile_initialization.active_directory.studio_component_id #=> String
resp.launch_profile_initialization.active_directory.studio_component_name #=> String
resp.launch_profile_initialization.ec2_security_group_ids #=> Array
resp.launch_profile_initialization.ec2_security_group_ids[0] #=> String
resp.launch_profile_initialization.launch_profile_id #=> String
resp.launch_profile_initialization.launch_profile_protocol_version #=> String
resp.launch_profile_initialization.launch_purpose #=> String
resp.launch_profile_initialization.name #=> String
resp.launch_profile_initialization.platform #=> String, one of "LINUX", "WINDOWS"
resp.launch_profile_initialization.system_initialization_scripts #=> Array
resp.launch_profile_initialization.system_initialization_scripts[0].script #=> String
resp.launch_profile_initialization.system_initialization_scripts[0].studio_component_id #=> String
resp.launch_profile_initialization.system_initialization_scripts[0].studio_component_name #=> String
resp.launch_profile_initialization.user_initialization_scripts #=> Array
resp.launch_profile_initialization.user_initialization_scripts[0].script #=> String
resp.launch_profile_initialization.user_initialization_scripts[0].studio_component_id #=> String
resp.launch_profile_initialization.user_initialization_scripts[0].studio_component_name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :launch_profile_id (required, String)

    The Launch Profile ID.

  • :launch_profile_protocol_versions (required, Array<String>)

    The launch profile protocol versions supported by the client.

  • :launch_purpose (required, String)

    The launch purpose.

  • :platform (required, String)

    The platform where this Launch Profile will be used, either WINDOWS or LINUX.

  • :studio_id (required, String)

    The studio ID.

Returns:

See Also:



1620
1621
1622
1623
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 1620

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

#get_launch_profile_member(params = {}) ⇒ Types::GetLaunchProfileMemberResponse

Get a user persona in launch profile membership.

Examples:

Request syntax with placeholder values


resp = client.get_launch_profile_member({
  launch_profile_id: "String", # required
  principal_id: "String", # required
  studio_id: "String", # required
})

Response structure


resp.member.identity_store_id #=> String
resp.member.persona #=> String, one of "USER"
resp.member.principal_id #=> String
resp.member.sid #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :launch_profile_id (required, String)

    The Launch Profile ID.

  • :principal_id (required, String)

    The principal ID. This currently supports a Amazon Web Services SSO UserId.

  • :studio_id (required, String)

    The studio ID.

Returns:

See Also:



1660
1661
1662
1663
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 1660

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

#get_streaming_image(params = {}) ⇒ Types::GetStreamingImageResponse

Get streaming image.

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

  • streaming_image_deleted
  • streaming_image_ready

Examples:

Request syntax with placeholder values


resp = client.get_streaming_image({
  streaming_image_id: "String", # required
  studio_id: "String", # required
})

Response structure


resp.streaming_image.arn #=> String
resp.streaming_image.description #=> String
resp.streaming_image.ec2_image_id #=> String
resp.streaming_image.encryption_configuration.key_arn #=> String
resp.streaming_image.encryption_configuration.key_type #=> String, one of "CUSTOMER_MANAGED_KEY"
resp.streaming_image.eula_ids #=> Array
resp.streaming_image.eula_ids[0] #=> String
resp.streaming_image.name #=> String
resp.streaming_image.owner #=> String
resp.streaming_image.platform #=> String
resp.streaming_image.state #=> String, one of "CREATE_IN_PROGRESS", "READY", "DELETE_IN_PROGRESS", "DELETED", "UPDATE_IN_PROGRESS", "UPDATE_FAILED", "CREATE_FAILED", "DELETE_FAILED"
resp.streaming_image.status_code #=> String, one of "STREAMING_IMAGE_CREATE_IN_PROGRESS", "STREAMING_IMAGE_READY", "STREAMING_IMAGE_DELETE_IN_PROGRESS", "STREAMING_IMAGE_DELETED", "STREAMING_IMAGE_UPDATE_IN_PROGRESS", "INTERNAL_ERROR"
resp.streaming_image.status_message #=> String
resp.streaming_image.streaming_image_id #=> String
resp.streaming_image.tags #=> Hash
resp.streaming_image.tags["String"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :streaming_image_id (required, String)

    The streaming image ID.

  • :studio_id (required, String)

    The studio ID.

Returns:

See Also:



1713
1714
1715
1716
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 1713

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

#get_streaming_session(params = {}) ⇒ Types::GetStreamingSessionResponse

Gets StreamingSession resource.

anvoke this operation to poll for a streaming session state while creating or deleting a session.

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

  • streaming_session_deleted
  • streaming_session_ready
  • streaming_session_stopped

Examples:

Request syntax with placeholder values


resp = client.get_streaming_session({
  session_id: "String", # required
  studio_id: "String", # required
})

Response structure


resp.session.arn #=> String
resp.session.created_at #=> Time
resp.session.created_by #=> String
resp.session.ec2_instance_type #=> String
resp.session.launch_profile_id #=> String
resp.session.owned_by #=> String
resp.session.session_id #=> String
resp.session.started_at #=> Time
resp.session.started_by #=> String
resp.session.state #=> String, one of "CREATE_IN_PROGRESS", "DELETE_IN_PROGRESS", "READY", "DELETED", "CREATE_FAILED", "DELETE_FAILED", "STOP_IN_PROGRESS", "START_IN_PROGRESS", "STOPPED", "STOP_FAILED", "START_FAILED"
resp.session.status_code #=> String, one of "STREAMING_SESSION_READY", "STREAMING_SESSION_DELETED", "STREAMING_SESSION_CREATE_IN_PROGRESS", "STREAMING_SESSION_DELETE_IN_PROGRESS", "INTERNAL_ERROR", "INSUFFICIENT_CAPACITY", "ACTIVE_DIRECTORY_DOMAIN_JOIN_ERROR", "NETWORK_CONNECTION_ERROR", "INITIALIZATION_SCRIPT_ERROR", "DECRYPT_STREAMING_IMAGE_ERROR", "NETWORK_INTERFACE_ERROR", "STREAMING_SESSION_STOPPED", "STREAMING_SESSION_STARTED", "STREAMING_SESSION_STOP_IN_PROGRESS", "STREAMING_SESSION_START_IN_PROGRESS"
resp.session.status_message #=> String
resp.session.stop_at #=> Time
resp.session.stopped_at #=> Time
resp.session.stopped_by #=> String
resp.session.streaming_image_id #=> String
resp.session.tags #=> Hash
resp.session.tags["String"] #=> String
resp.session.terminate_at #=> Time
resp.session.updated_at #=> Time
resp.session.updated_by #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :session_id (required, String)

    The streaming session ID.

  • :studio_id (required, String)

    The studio ID.

Returns:

See Also:



1775
1776
1777
1778
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 1775

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

#get_streaming_session_stream(params = {}) ⇒ Types::GetStreamingSessionStreamResponse

Gets a StreamingSessionStream for a streaming session.

Invoke this operation to poll the resource after invoking CreateStreamingSessionStream.

After the StreamingSessionStream changes to the state READY, the url property will contain a stream to be used with the DCV streaming client.

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

  • streaming_session_stream_ready

Examples:

Request syntax with placeholder values


resp = client.get_streaming_session_stream({
  session_id: "String", # required
  stream_id: "String", # required
  studio_id: "String", # required
})

Response structure


resp.stream.created_at #=> Time
resp.stream.created_by #=> String
resp.stream.expires_at #=> Time
resp.stream.owned_by #=> String
resp.stream.state #=> String, one of "READY", "CREATE_IN_PROGRESS", "DELETE_IN_PROGRESS", "DELETED", "CREATE_FAILED", "DELETE_FAILED"
resp.stream.status_code #=> String, one of "STREAM_CREATE_IN_PROGRESS", "STREAM_READY", "STREAM_DELETE_IN_PROGRESS", "STREAM_DELETED", "INTERNAL_ERROR", "NETWORK_CONNECTION_ERROR"
resp.stream.stream_id #=> String
resp.stream.url #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :session_id (required, String)

    The streaming session ID.

  • :stream_id (required, String)

    The streaming session stream ID.

  • :studio_id (required, String)

    The studio ID.

Returns:

See Also:



1830
1831
1832
1833
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 1830

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

#get_studio(params = {}) ⇒ Types::GetStudioResponse

Get a Studio resource.

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

  • studio_deleted
  • studio_ready

Examples:

Request syntax with placeholder values


resp = client.get_studio({
  studio_id: "String", # required
})

Response structure


resp.studio.admin_role_arn #=> String
resp.studio.arn #=> String
resp.studio.created_at #=> Time
resp.studio.display_name #=> String
resp.studio.home_region #=> String
resp.studio.sso_client_id #=> String
resp.studio.state #=> String, one of "CREATE_IN_PROGRESS", "READY", "UPDATE_IN_PROGRESS", "DELETE_IN_PROGRESS", "DELETED", "DELETE_FAILED", "CREATE_FAILED", "UPDATE_FAILED"
resp.studio.status_code #=> String, one of "STUDIO_CREATED", "STUDIO_DELETED", "STUDIO_UPDATED", "STUDIO_CREATE_IN_PROGRESS", "STUDIO_UPDATE_IN_PROGRESS", "STUDIO_DELETE_IN_PROGRESS", "STUDIO_WITH_LAUNCH_PROFILES_NOT_DELETED", "STUDIO_WITH_STUDIO_COMPONENTS_NOT_DELETED", "STUDIO_WITH_STREAMING_IMAGES_NOT_DELETED", "AWS_SSO_NOT_ENABLED", "AWS_SSO_ACCESS_DENIED", "ROLE_NOT_OWNED_BY_STUDIO_OWNER", "ROLE_COULD_NOT_BE_ASSUMED", "INTERNAL_ERROR", "ENCRYPTION_KEY_NOT_FOUND", "ENCRYPTION_KEY_ACCESS_DENIED", "AWS_SSO_CONFIGURATION_REPAIRED", "AWS_SSO_CONFIGURATION_REPAIR_IN_PROGRESS"
resp.studio.status_message #=> String
resp.studio.studio_encryption_configuration.key_arn #=> String
resp.studio.studio_encryption_configuration.key_type #=> String, one of "AWS_OWNED_KEY", "CUSTOMER_MANAGED_KEY"
resp.studio.studio_id #=> String
resp.studio.studio_name #=> String
resp.studio.studio_url #=> String
resp.studio.tags #=> Hash
resp.studio.tags["String"] #=> String
resp.studio.updated_at #=> Time
resp.studio.user_role_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :studio_id (required, String)

    The studio ID.

Returns:

See Also:



1881
1882
1883
1884
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 1881

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

#get_studio_component(params = {}) ⇒ Types::GetStudioComponentResponse

Gets a studio component resource.

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

  • studio_component_deleted
  • studio_component_ready

Examples:

Request syntax with placeholder values


resp = client.get_studio_component({
  studio_component_id: "String", # required
  studio_id: "String", # required
})

Response structure


resp.studio_component.arn #=> String
resp.studio_component.configuration.active_directory_configuration.computer_attributes #=> Array
resp.studio_component.configuration.active_directory_configuration.computer_attributes[0].name #=> String
resp.studio_component.configuration.active_directory_configuration.computer_attributes[0].value #=> String
resp.studio_component.configuration.active_directory_configuration.directory_id #=> String
resp.studio_component.configuration.active_directory_configuration.organizational_unit_distinguished_name #=> String
resp.studio_component.configuration.compute_farm_configuration.active_directory_user #=> String
resp.studio_component.configuration.compute_farm_configuration.endpoint #=> String
resp.studio_component.configuration.license_service_configuration.endpoint #=> String
resp.studio_component.configuration.shared_file_system_configuration.endpoint #=> String
resp.studio_component.configuration.shared_file_system_configuration.file_system_id #=> String
resp.studio_component.configuration.shared_file_system_configuration.linux_mount_point #=> String
resp.studio_component.configuration.shared_file_system_configuration.share_name #=> String
resp.studio_component.configuration.shared_file_system_configuration.windows_mount_drive #=> String
resp.studio_component.created_at #=> Time
resp.studio_component.created_by #=> String
resp.studio_component.description #=> String
resp.studio_component.ec2_security_group_ids #=> Array
resp.studio_component.ec2_security_group_ids[0] #=> String
resp.studio_component.initialization_scripts #=> Array
resp.studio_component.initialization_scripts[0].launch_profile_protocol_version #=> String
resp.studio_component.initialization_scripts[0].platform #=> String, one of "LINUX", "WINDOWS"
resp.studio_component.initialization_scripts[0].run_context #=> String, one of "SYSTEM_INITIALIZATION", "USER_INITIALIZATION"
resp.studio_component.initialization_scripts[0].script #=> String
resp.studio_component.name #=> String
resp.studio_component.script_parameters #=> Array
resp.studio_component.script_parameters[0].key #=> String
resp.studio_component.script_parameters[0].value #=> String
resp.studio_component.state #=> String, one of "CREATE_IN_PROGRESS", "READY", "UPDATE_IN_PROGRESS", "DELETE_IN_PROGRESS", "DELETED", "DELETE_FAILED", "CREATE_FAILED", "UPDATE_FAILED"
resp.studio_component.status_code #=> String, one of "ACTIVE_DIRECTORY_ALREADY_EXISTS", "STUDIO_COMPONENT_CREATED", "STUDIO_COMPONENT_UPDATED", "STUDIO_COMPONENT_DELETED", "ENCRYPTION_KEY_ACCESS_DENIED", "ENCRYPTION_KEY_NOT_FOUND", "STUDIO_COMPONENT_CREATE_IN_PROGRESS", "STUDIO_COMPONENT_UPDATE_IN_PROGRESS", "STUDIO_COMPONENT_DELETE_IN_PROGRESS", "INTERNAL_ERROR"
resp.studio_component.status_message #=> String
resp.studio_component.studio_component_id #=> String
resp.studio_component.subtype #=> String, one of "AWS_MANAGED_MICROSOFT_AD", "AMAZON_FSX_FOR_WINDOWS", "AMAZON_FSX_FOR_LUSTRE", "CUSTOM"
resp.studio_component.tags #=> Hash
resp.studio_component.tags["String"] #=> String
resp.studio_component.type #=> String, one of "ACTIVE_DIRECTORY", "SHARED_FILE_SYSTEM", "COMPUTE_FARM", "LICENSE_SERVICE", "CUSTOM"
resp.studio_component.updated_at #=> Time
resp.studio_component.updated_by #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :studio_component_id (required, String)

    The studio component ID.

  • :studio_id (required, String)

    The studio ID.

Returns:

See Also:



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

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

#get_studio_member(params = {}) ⇒ Types::GetStudioMemberResponse

Get a user's membership in a studio.

Examples:

Request syntax with placeholder values


resp = client.get_studio_member({
  principal_id: "String", # required
  studio_id: "String", # required
})

Response structure


resp.member.identity_store_id #=> String
resp.member.persona #=> String, one of "ADMINISTRATOR"
resp.member.principal_id #=> String
resp.member.sid #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :principal_id (required, String)

    The principal ID. This currently supports a Amazon Web Services SSO UserId.

  • :studio_id (required, String)

    The studio ID.

Returns:

See Also:



1992
1993
1994
1995
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 1992

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

#list_eula_acceptances(params = {}) ⇒ Types::ListEulaAcceptancesResponse

List Eula Acceptances.

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_eula_acceptances({
  eula_ids: ["String"],
  next_token: "String",
  studio_id: "String", # required
})

Response structure


resp.eula_acceptances #=> Array
resp.eula_acceptances[0].accepted_at #=> Time
resp.eula_acceptances[0].accepted_by #=> String
resp.eula_acceptances[0].acceptee_id #=> String
resp.eula_acceptances[0].eula_acceptance_id #=> String
resp.eula_acceptances[0].eula_id #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :eula_ids (Array<String>)

    The list of EULA IDs that have been previously accepted.

  • :next_token (String)

    The token to request the next page of results.

  • :studio_id (required, String)

    The studio ID.

Returns:

See Also:



2037
2038
2039
2040
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 2037

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

#list_eulas(params = {}) ⇒ Types::ListEulasResponse

List Eulas.

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_eulas({
  eula_ids: ["String"],
  next_token: "String",
})

Response structure


resp.eulas #=> Array
resp.eulas[0].content #=> String
resp.eulas[0].created_at #=> Time
resp.eulas[0].eula_id #=> String
resp.eulas[0].name #=> String
resp.eulas[0].updated_at #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :eula_ids (Array<String>)

    The list of EULA IDs that should be returned

  • :next_token (String)

    The token to request the next page of results.

Returns:

See Also:



2078
2079
2080
2081
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 2078

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

#list_launch_profile_members(params = {}) ⇒ Types::ListLaunchProfileMembersResponse

Get all users in a given launch profile membership.

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_launch_profile_members({
  launch_profile_id: "String", # required
  max_results: 1,
  next_token: "String",
  studio_id: "String", # required
})

Response structure


resp.members #=> Array
resp.members[0].identity_store_id #=> String
resp.members[0].persona #=> String, one of "USER"
resp.members[0].principal_id #=> String
resp.members[0].sid #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :launch_profile_id (required, String)

    The Launch Profile ID.

  • :max_results (Integer)

    The max number of results to return in the response.

  • :next_token (String)

    The token to request the next page of results.

  • :studio_id (required, String)

    The studio ID.

Returns:

See Also:



2126
2127
2128
2129
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 2126

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

#list_launch_profiles(params = {}) ⇒ Types::ListLaunchProfilesResponse

List all the launch profiles a studio.

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_launch_profiles({
  max_results: 1,
  next_token: "String",
  principal_id: "String",
  states: ["String"],
  studio_id: "String", # required
})

Response structure


resp.launch_profiles #=> Array
resp.launch_profiles[0].arn #=> String
resp.launch_profiles[0].created_at #=> Time
resp.launch_profiles[0].created_by #=> String
resp.launch_profiles[0].description #=> String
resp.launch_profiles[0].ec2_subnet_ids #=> Array
resp.launch_profiles[0].ec2_subnet_ids[0] #=> String
resp.launch_profiles[0].launch_profile_id #=> String
resp.launch_profiles[0].launch_profile_protocol_versions #=> Array
resp.launch_profiles[0].launch_profile_protocol_versions[0] #=> String
resp.launch_profiles[0].name #=> String
resp.launch_profiles[0].state #=> String, one of "CREATE_IN_PROGRESS", "READY", "UPDATE_IN_PROGRESS", "DELETE_IN_PROGRESS", "DELETED", "DELETE_FAILED", "CREATE_FAILED", "UPDATE_FAILED"
resp.launch_profiles[0].status_code #=> String, one of "LAUNCH_PROFILE_CREATED", "LAUNCH_PROFILE_UPDATED", "LAUNCH_PROFILE_DELETED", "LAUNCH_PROFILE_CREATE_IN_PROGRESS", "LAUNCH_PROFILE_UPDATE_IN_PROGRESS", "LAUNCH_PROFILE_DELETE_IN_PROGRESS", "INTERNAL_ERROR", "STREAMING_IMAGE_NOT_FOUND", "STREAMING_IMAGE_NOT_READY", "LAUNCH_PROFILE_WITH_STREAM_SESSIONS_NOT_DELETED", "ENCRYPTION_KEY_ACCESS_DENIED", "ENCRYPTION_KEY_NOT_FOUND", "INVALID_SUBNETS_PROVIDED"
resp.launch_profiles[0].status_message #=> String
resp.launch_profiles[0].stream_configuration.clipboard_mode #=> String, one of "ENABLED", "DISABLED"
resp.launch_profiles[0].stream_configuration.ec2_instance_types #=> Array
resp.launch_profiles[0].stream_configuration.ec2_instance_types[0] #=> String, one of "g4dn.xlarge", "g4dn.2xlarge", "g4dn.4xlarge", "g4dn.8xlarge", "g4dn.12xlarge", "g4dn.16xlarge"
resp.launch_profiles[0].stream_configuration.max_session_length_in_minutes #=> Integer
resp.launch_profiles[0].stream_configuration.max_stopped_session_length_in_minutes #=> Integer
resp.launch_profiles[0].stream_configuration.streaming_image_ids #=> Array
resp.launch_profiles[0].stream_configuration.streaming_image_ids[0] #=> String
resp.launch_profiles[0].studio_component_ids #=> Array
resp.launch_profiles[0].studio_component_ids[0] #=> String
resp.launch_profiles[0].tags #=> Hash
resp.launch_profiles[0].tags["String"] #=> String
resp.launch_profiles[0].updated_at #=> Time
resp.launch_profiles[0].updated_by #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (Integer)

    The max number of results to return in the response.

  • :next_token (String)

    The token to request the next page of results.

  • :principal_id (String)

    The principal ID. This currently supports a Amazon Web Services SSO UserId.

  • :states (Array<String>)

    Filter this request to launch profiles in any of the given states.

  • :studio_id (required, String)

    The studio ID.

Returns:

See Also:



2201
2202
2203
2204
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 2201

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

#list_streaming_images(params = {}) ⇒ Types::ListStreamingImagesResponse

List the streaming image resources available to this studio.

This list will contain both images provided by Amazon Web Services, as well as streaming images that you have created in your studio.

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_streaming_images({
  next_token: "String",
  owner: "String",
  studio_id: "String", # required
})

Response structure


resp.next_token #=> String
resp.streaming_images #=> Array
resp.streaming_images[0].arn #=> String
resp.streaming_images[0].description #=> String
resp.streaming_images[0].ec2_image_id #=> String
resp.streaming_images[0].encryption_configuration.key_arn #=> String
resp.streaming_images[0].encryption_configuration.key_type #=> String, one of "CUSTOMER_MANAGED_KEY"
resp.streaming_images[0].eula_ids #=> Array
resp.streaming_images[0].eula_ids[0] #=> String
resp.streaming_images[0].name #=> String
resp.streaming_images[0].owner #=> String
resp.streaming_images[0].platform #=> String
resp.streaming_images[0].state #=> String, one of "CREATE_IN_PROGRESS", "READY", "DELETE_IN_PROGRESS", "DELETED", "UPDATE_IN_PROGRESS", "UPDATE_FAILED", "CREATE_FAILED", "DELETE_FAILED"
resp.streaming_images[0].status_code #=> String, one of "STREAMING_IMAGE_CREATE_IN_PROGRESS", "STREAMING_IMAGE_READY", "STREAMING_IMAGE_DELETE_IN_PROGRESS", "STREAMING_IMAGE_DELETED", "STREAMING_IMAGE_UPDATE_IN_PROGRESS", "INTERNAL_ERROR"
resp.streaming_images[0].status_message #=> String
resp.streaming_images[0].streaming_image_id #=> String
resp.streaming_images[0].tags #=> Hash
resp.streaming_images[0].tags["String"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String)

    The token to request the next page of results.

  • :owner (String)

    Filter this request to streaming images with the given owner

  • :studio_id (required, String)

    The studio ID.

Returns:

See Also:



2260
2261
2262
2263
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 2260

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

#list_streaming_sessions(params = {}) ⇒ Types::ListStreamingSessionsResponse

Lists the streaming image resources in a studio.

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_streaming_sessions({
  created_by: "String",
  next_token: "String",
  owned_by: "String",
  session_ids: "String",
  studio_id: "String", # required
})

Response structure


resp.next_token #=> String
resp.sessions #=> Array
resp.sessions[0].arn #=> String
resp.sessions[0].created_at #=> Time
resp.sessions[0].created_by #=> String
resp.sessions[0].ec2_instance_type #=> String
resp.sessions[0].launch_profile_id #=> String
resp.sessions[0].owned_by #=> String
resp.sessions[0].session_id #=> String
resp.sessions[0].started_at #=> Time
resp.sessions[0].started_by #=> String
resp.sessions[0].state #=> String, one of "CREATE_IN_PROGRESS", "DELETE_IN_PROGRESS", "READY", "DELETED", "CREATE_FAILED", "DELETE_FAILED", "STOP_IN_PROGRESS", "START_IN_PROGRESS", "STOPPED", "STOP_FAILED", "START_FAILED"
resp.sessions[0].status_code #=> String, one of "STREAMING_SESSION_READY", "STREAMING_SESSION_DELETED", "STREAMING_SESSION_CREATE_IN_PROGRESS", "STREAMING_SESSION_DELETE_IN_PROGRESS", "INTERNAL_ERROR", "INSUFFICIENT_CAPACITY", "ACTIVE_DIRECTORY_DOMAIN_JOIN_ERROR", "NETWORK_CONNECTION_ERROR", "INITIALIZATION_SCRIPT_ERROR", "DECRYPT_STREAMING_IMAGE_ERROR", "NETWORK_INTERFACE_ERROR", "STREAMING_SESSION_STOPPED", "STREAMING_SESSION_STARTED", "STREAMING_SESSION_STOP_IN_PROGRESS", "STREAMING_SESSION_START_IN_PROGRESS"
resp.sessions[0].status_message #=> String
resp.sessions[0].stop_at #=> Time
resp.sessions[0].stopped_at #=> Time
resp.sessions[0].stopped_by #=> String
resp.sessions[0].streaming_image_id #=> String
resp.sessions[0].tags #=> Hash
resp.sessions[0].tags["String"] #=> String
resp.sessions[0].terminate_at #=> Time
resp.sessions[0].updated_at #=> Time
resp.sessions[0].updated_by #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :created_by (String)

    Filters the request to streaming sessions created by the given user.

  • :next_token (String)

    The token to request the next page of results.

  • :owned_by (String)

    Filters the request to streaming session owned by the given user

  • :session_ids (String)

    Filters the request to only the provided session IDs.

  • :studio_id (required, String)

    The studio ID.

Returns:

See Also:



2329
2330
2331
2332
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 2329

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

#list_studio_components(params = {}) ⇒ Types::ListStudioComponentsResponse

Lists the StudioComponents in a studio.

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_studio_components({
  max_results: 1,
  next_token: "String",
  states: ["String"],
  studio_id: "String", # required
  types: ["String"],
})

Response structure


resp.next_token #=> String
resp.studio_components #=> Array
resp.studio_components[0].arn #=> String
resp.studio_components[0].configuration.active_directory_configuration.computer_attributes #=> Array
resp.studio_components[0].configuration.active_directory_configuration.computer_attributes[0].name #=> String
resp.studio_components[0].configuration.active_directory_configuration.computer_attributes[0].value #=> String
resp.studio_components[0].configuration.active_directory_configuration.directory_id #=> String
resp.studio_components[0].configuration.active_directory_configuration.organizational_unit_distinguished_name #=> String
resp.studio_components[0].configuration.compute_farm_configuration.active_directory_user #=> String
resp.studio_components[0].configuration.compute_farm_configuration.endpoint #=> String
resp.studio_components[0].configuration.license_service_configuration.endpoint #=> String
resp.studio_components[0].configuration.shared_file_system_configuration.endpoint #=> String
resp.studio_components[0].configuration.shared_file_system_configuration.file_system_id #=> String
resp.studio_components[0].configuration.shared_file_system_configuration.linux_mount_point #=> String
resp.studio_components[0].configuration.shared_file_system_configuration.share_name #=> String
resp.studio_components[0].configuration.shared_file_system_configuration.windows_mount_drive #=> String
resp.studio_components[0].created_at #=> Time
resp.studio_components[0].created_by #=> String
resp.studio_components[0].description #=> String
resp.studio_components[0].ec2_security_group_ids #=> Array
resp.studio_components[0].ec2_security_group_ids[0] #=> String
resp.studio_components[0].initialization_scripts #=> Array
resp.studio_components[0].initialization_scripts[0].launch_profile_protocol_version #=> String
resp.studio_components[0].initialization_scripts[0].platform #=> String, one of "LINUX", "WINDOWS"
resp.studio_components[0].initialization_scripts[0].run_context #=> String, one of "SYSTEM_INITIALIZATION", "USER_INITIALIZATION"
resp.studio_components[0].initialization_scripts[0].script #=> String
resp.studio_components[0].name #=> String
resp.studio_components[0].script_parameters #=> Array
resp.studio_components[0].script_parameters[0].key #=> String
resp.studio_components[0].script_parameters[0].value #=> String
resp.studio_components[0].state #=> String, one of "CREATE_IN_PROGRESS", "READY", "UPDATE_IN_PROGRESS", "DELETE_IN_PROGRESS", "DELETED", "DELETE_FAILED", "CREATE_FAILED", "UPDATE_FAILED"
resp.studio_components[0].status_code #=> String, one of "ACTIVE_DIRECTORY_ALREADY_EXISTS", "STUDIO_COMPONENT_CREATED", "STUDIO_COMPONENT_UPDATED", "STUDIO_COMPONENT_DELETED", "ENCRYPTION_KEY_ACCESS_DENIED", "ENCRYPTION_KEY_NOT_FOUND", "STUDIO_COMPONENT_CREATE_IN_PROGRESS", "STUDIO_COMPONENT_UPDATE_IN_PROGRESS", "STUDIO_COMPONENT_DELETE_IN_PROGRESS", "INTERNAL_ERROR"
resp.studio_components[0].status_message #=> String
resp.studio_components[0].studio_component_id #=> String
resp.studio_components[0].subtype #=> String, one of "AWS_MANAGED_MICROSOFT_AD", "AMAZON_FSX_FOR_WINDOWS", "AMAZON_FSX_FOR_LUSTRE", "CUSTOM"
resp.studio_components[0].tags #=> Hash
resp.studio_components[0].tags["String"] #=> String
resp.studio_components[0].type #=> String, one of "ACTIVE_DIRECTORY", "SHARED_FILE_SYSTEM", "COMPUTE_FARM", "LICENSE_SERVICE", "CUSTOM"
resp.studio_components[0].updated_at #=> Time
resp.studio_components[0].updated_by #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (Integer)

    The max number of results to return in the response.

  • :next_token (String)

    The token to request the next page of results.

  • :states (Array<String>)

    Filters the request to studio components that are in one of the given states.

  • :studio_id (required, String)

    The studio ID.

  • :types (Array<String>)

    Filters the request to studio components that are of one of the given types.

Returns:

See Also:



2417
2418
2419
2420
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 2417

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

#list_studio_members(params = {}) ⇒ Types::ListStudioMembersResponse

Get all users in a given studio membership.

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_studio_members({
  max_results: 1,
  next_token: "String",
  studio_id: "String", # required
})

Response structure


resp.members #=> Array
resp.members[0].identity_store_id #=> String
resp.members[0].persona #=> String, one of "ADMINISTRATOR"
resp.members[0].principal_id #=> String
resp.members[0].sid #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (Integer)

    The max number of results to return in the response.

  • :next_token (String)

    The token to request the next page of results.

  • :studio_id (required, String)

    The studio ID.

Returns:

See Also:



2461
2462
2463
2464
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 2461

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

#list_studios(params = {}) ⇒ Types::ListStudiosResponse

List studios in your Amazon Web Services account in the requested Amazon Web Services Region.

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_studios({
  next_token: "String",
})

Response structure


resp.next_token #=> String
resp.studios #=> Array
resp.studios[0].admin_role_arn #=> String
resp.studios[0].arn #=> String
resp.studios[0].created_at #=> Time
resp.studios[0].display_name #=> String
resp.studios[0].home_region #=> String
resp.studios[0].sso_client_id #=> String
resp.studios[0].state #=> String, one of "CREATE_IN_PROGRESS", "READY", "UPDATE_IN_PROGRESS", "DELETE_IN_PROGRESS", "DELETED", "DELETE_FAILED", "CREATE_FAILED", "UPDATE_FAILED"
resp.studios[0].status_code #=> String, one of "STUDIO_CREATED", "STUDIO_DELETED", "STUDIO_UPDATED", "STUDIO_CREATE_IN_PROGRESS", "STUDIO_UPDATE_IN_PROGRESS", "STUDIO_DELETE_IN_PROGRESS", "STUDIO_WITH_LAUNCH_PROFILES_NOT_DELETED", "STUDIO_WITH_STUDIO_COMPONENTS_NOT_DELETED", "STUDIO_WITH_STREAMING_IMAGES_NOT_DELETED", "AWS_SSO_NOT_ENABLED", "AWS_SSO_ACCESS_DENIED", "ROLE_NOT_OWNED_BY_STUDIO_OWNER", "ROLE_COULD_NOT_BE_ASSUMED", "INTERNAL_ERROR", "ENCRYPTION_KEY_NOT_FOUND", "ENCRYPTION_KEY_ACCESS_DENIED", "AWS_SSO_CONFIGURATION_REPAIRED", "AWS_SSO_CONFIGURATION_REPAIR_IN_PROGRESS"
resp.studios[0].status_message #=> String
resp.studios[0].studio_encryption_configuration.key_arn #=> String
resp.studios[0].studio_encryption_configuration.key_type #=> String, one of "AWS_OWNED_KEY", "CUSTOMER_MANAGED_KEY"
resp.studios[0].studio_id #=> String
resp.studios[0].studio_name #=> String
resp.studios[0].studio_url #=> String
resp.studios[0].tags #=> Hash
resp.studios[0].tags["String"] #=> String
resp.studios[0].updated_at #=> Time
resp.studios[0].user_role_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String)

    The token to request the next page of results.

Returns:

See Also:



2512
2513
2514
2515
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 2512

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

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

Gets the tags for a resource, given its Amazon Resource Names (ARN).

This operation supports ARNs for all resource types in Nimble Studio that support tags, including studio, studio component, launch profile, streaming image, and streaming session. All resources that can be tagged will contain an ARN property, so you do not have to create this ARN yourself.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String)

    The Amazon Resource Name (ARN) of the resource for which you want to list tags.

Returns:

See Also:



2548
2549
2550
2551
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 2548

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

#put_launch_profile_members(params = {}) ⇒ Struct

Add/update users with given persona to launch profile membership.

Examples:

Request syntax with placeholder values


resp = client.put_launch_profile_members({
  client_token: "ClientToken",
  identity_store_id: "String", # required
  launch_profile_id: "String", # required
  members: [ # required
    {
      persona: "USER", # required, accepts USER
      principal_id: "String", # required
    },
  ],
  studio_id: "String", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :client_token (String)

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the AWS SDK automatically generates a client token and uses it for the request to ensure idempotency.

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

  • :identity_store_id (required, String)

    The ID of the identity store.

  • :launch_profile_id (required, String)

    The Launch Profile ID.

  • :members (required, Array<Types::NewLaunchProfileMember>)

    A list of members.

  • :studio_id (required, String)

    The studio ID.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



2597
2598
2599
2600
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 2597

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

#put_studio_members(params = {}) ⇒ Struct

Add/update users with given persona to studio membership.

Examples:

Request syntax with placeholder values


resp = client.put_studio_members({
  client_token: "ClientToken",
  identity_store_id: "String", # required
  members: [ # required
    {
      persona: "ADMINISTRATOR", # required, accepts ADMINISTRATOR
      principal_id: "String", # required
    },
  ],
  studio_id: "String", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :client_token (String)

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the AWS SDK automatically generates a client token and uses it for the request to ensure idempotency.

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

  • :identity_store_id (required, String)

    The ID of the identity store.

  • :members (required, Array<Types::NewStudioMember>)

    A list of members.

  • :studio_id (required, String)

    The studio ID.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



2642
2643
2644
2645
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 2642

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

#start_streaming_session(params = {}) ⇒ Types::StartStreamingSessionResponse

Transitions sessions from the STOPPED state into the READY state. The START_IN_PROGRESS state is the intermediate state between the STOPPED and READY states.

Examples:

Request syntax with placeholder values


resp = client.start_streaming_session({
  client_token: "ClientToken",
  session_id: "String", # required
  studio_id: "String", # required
})

Response structure


resp.session.arn #=> String
resp.session.created_at #=> Time
resp.session.created_by #=> String
resp.session.ec2_instance_type #=> String
resp.session.launch_profile_id #=> String
resp.session.owned_by #=> String
resp.session.session_id #=> String
resp.session.started_at #=> Time
resp.session.started_by #=> String
resp.session.state #=> String, one of "CREATE_IN_PROGRESS", "DELETE_IN_PROGRESS", "READY", "DELETED", "CREATE_FAILED", "DELETE_FAILED", "STOP_IN_PROGRESS", "START_IN_PROGRESS", "STOPPED", "STOP_FAILED", "START_FAILED"
resp.session.status_code #=> String, one of "STREAMING_SESSION_READY", "STREAMING_SESSION_DELETED", "STREAMING_SESSION_CREATE_IN_PROGRESS", "STREAMING_SESSION_DELETE_IN_PROGRESS", "INTERNAL_ERROR", "INSUFFICIENT_CAPACITY", "ACTIVE_DIRECTORY_DOMAIN_JOIN_ERROR", "NETWORK_CONNECTION_ERROR", "INITIALIZATION_SCRIPT_ERROR", "DECRYPT_STREAMING_IMAGE_ERROR", "NETWORK_INTERFACE_ERROR", "STREAMING_SESSION_STOPPED", "STREAMING_SESSION_STARTED", "STREAMING_SESSION_STOP_IN_PROGRESS", "STREAMING_SESSION_START_IN_PROGRESS"
resp.session.status_message #=> String
resp.session.stop_at #=> Time
resp.session.stopped_at #=> Time
resp.session.stopped_by #=> String
resp.session.streaming_image_id #=> String
resp.session.tags #=> Hash
resp.session.tags["String"] #=> String
resp.session.terminate_at #=> Time
resp.session.updated_at #=> Time
resp.session.updated_by #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :client_token (String)

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the AWS SDK automatically generates a client token and uses it for the request to ensure idempotency.

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

  • :session_id (required, String)

    The streaming session ID for the StartStreamingSessionRequest.

  • :studio_id (required, String)

    The studio ID for the StartStreamingSessionRequest.

Returns:

See Also:



2706
2707
2708
2709
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 2706

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

#start_studio_sso_configuration_repair(params = {}) ⇒ Types::StartStudioSSOConfigurationRepairResponse

Repairs the Amazon Web Services SSO configuration for a given studio.

If the studio has a valid Amazon Web Services SSO configuration currently associated with it, this operation will fail with a validation error.

If the studio does not have a valid Amazon Web Services SSO configuration currently associated with it, then a new Amazon Web Services SSO application is created for the studio and the studio is changed to the READY state.

After the Amazon Web Services SSO application is repaired, you must use the Amazon Nimble Studio console to add administrators and users to your studio.

Examples:

Request syntax with placeholder values


resp = client.start_studio_sso_configuration_repair({
  client_token: "ClientToken",
  studio_id: "String", # required
})

Response structure


resp.studio.admin_role_arn #=> String
resp.studio.arn #=> String
resp.studio.created_at #=> Time
resp.studio.display_name #=> String
resp.studio.home_region #=> String
resp.studio.sso_client_id #=> String
resp.studio.state #=> String, one of "CREATE_IN_PROGRESS", "READY", "UPDATE_IN_PROGRESS", "DELETE_IN_PROGRESS", "DELETED", "DELETE_FAILED", "CREATE_FAILED", "UPDATE_FAILED"
resp.studio.status_code #=> String, one of "STUDIO_CREATED", "STUDIO_DELETED", "STUDIO_UPDATED", "STUDIO_CREATE_IN_PROGRESS", "STUDIO_UPDATE_IN_PROGRESS", "STUDIO_DELETE_IN_PROGRESS", "STUDIO_WITH_LAUNCH_PROFILES_NOT_DELETED", "STUDIO_WITH_STUDIO_COMPONENTS_NOT_DELETED", "STUDIO_WITH_STREAMING_IMAGES_NOT_DELETED", "AWS_SSO_NOT_ENABLED", "AWS_SSO_ACCESS_DENIED", "ROLE_NOT_OWNED_BY_STUDIO_OWNER", "ROLE_COULD_NOT_BE_ASSUMED", "INTERNAL_ERROR", "ENCRYPTION_KEY_NOT_FOUND", "ENCRYPTION_KEY_ACCESS_DENIED", "AWS_SSO_CONFIGURATION_REPAIRED", "AWS_SSO_CONFIGURATION_REPAIR_IN_PROGRESS"
resp.studio.status_message #=> String
resp.studio.studio_encryption_configuration.key_arn #=> String
resp.studio.studio_encryption_configuration.key_type #=> String, one of "AWS_OWNED_KEY", "CUSTOMER_MANAGED_KEY"
resp.studio.studio_id #=> String
resp.studio.studio_name #=> String
resp.studio.studio_url #=> String
resp.studio.tags #=> Hash
resp.studio.tags["String"] #=> String
resp.studio.updated_at #=> Time
resp.studio.user_role_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :client_token (String)

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the AWS SDK automatically generates a client token and uses it for the request to ensure idempotency.

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

  • :studio_id (required, String)

    The studio ID.

Returns:

See Also:



2774
2775
2776
2777
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 2774

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

#stop_streaming_session(params = {}) ⇒ Types::StopStreamingSessionResponse

Transitions sessions from the READY state into the STOPPED state. The STOP_IN_PROGRESS state is the intermediate state between the READY and STOPPED states.

Examples:

Request syntax with placeholder values


resp = client.stop_streaming_session({
  client_token: "ClientToken",
  session_id: "String", # required
  studio_id: "String", # required
})

Response structure


resp.session.arn #=> String
resp.session.created_at #=> Time
resp.session.created_by #=> String
resp.session.ec2_instance_type #=> String
resp.session.launch_profile_id #=> String
resp.session.owned_by #=> String
resp.session.session_id #=> String
resp.session.started_at #=> Time
resp.session.started_by #=> String
resp.session.state #=> String, one of "CREATE_IN_PROGRESS", "DELETE_IN_PROGRESS", "READY", "DELETED", "CREATE_FAILED", "DELETE_FAILED", "STOP_IN_PROGRESS", "START_IN_PROGRESS", "STOPPED", "STOP_FAILED", "START_FAILED"
resp.session.status_code #=> String, one of "STREAMING_SESSION_READY", "STREAMING_SESSION_DELETED", "STREAMING_SESSION_CREATE_IN_PROGRESS", "STREAMING_SESSION_DELETE_IN_PROGRESS", "INTERNAL_ERROR", "INSUFFICIENT_CAPACITY", "ACTIVE_DIRECTORY_DOMAIN_JOIN_ERROR", "NETWORK_CONNECTION_ERROR", "INITIALIZATION_SCRIPT_ERROR", "DECRYPT_STREAMING_IMAGE_ERROR", "NETWORK_INTERFACE_ERROR", "STREAMING_SESSION_STOPPED", "STREAMING_SESSION_STARTED", "STREAMING_SESSION_STOP_IN_PROGRESS", "STREAMING_SESSION_START_IN_PROGRESS"
resp.session.status_message #=> String
resp.session.stop_at #=> Time
resp.session.stopped_at #=> Time
resp.session.stopped_by #=> String
resp.session.streaming_image_id #=> String
resp.session.tags #=> Hash
resp.session.tags["String"] #=> String
resp.session.terminate_at #=> Time
resp.session.updated_at #=> Time
resp.session.updated_by #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :client_token (String)

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the AWS SDK automatically generates a client token and uses it for the request to ensure idempotency.

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

  • :session_id (required, String)

    The streaming session ID for the StopStreamingSessionRequest.

  • :studio_id (required, String)

    The studioId for the StopStreamingSessionRequest.

Returns:

See Also:



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

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

#tag_resource(params = {}) ⇒ Struct

Creates tags for a resource, given its ARN.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String)

    The Amazon Resource Name (ARN) of the resource you want to add tags to.

  • :tags (Hash<String,String>)

    A collection of labels, in the form of key:value pairs, that apply to this resource.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



2868
2869
2870
2871
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 2868

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

#untag_resource(params = {}) ⇒ Struct

Deletes the tags for a resource.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String)

    Identifies the Amazon Resource Name(ARN) key from which you are removing tags.

  • :tag_keys (required, Array<String>)

    One or more tag keys. Specify only the tag keys, not the tag values.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



2895
2896
2897
2898
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 2895

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

#update_launch_profile(params = {}) ⇒ Types::UpdateLaunchProfileResponse

Update a launch profile.

Examples:

Request syntax with placeholder values


resp = client.update_launch_profile({
  client_token: "ClientToken",
  description: "LaunchProfileDescription",
  launch_profile_id: "String", # required
  launch_profile_protocol_versions: ["LaunchProfileProtocolVersion"],
  name: "LaunchProfileName",
  stream_configuration: {
    clipboard_mode: "ENABLED", # required, accepts ENABLED, DISABLED
    ec2_instance_types: ["g4dn.xlarge"], # required, accepts g4dn.xlarge, g4dn.2xlarge, g4dn.4xlarge, g4dn.8xlarge, g4dn.12xlarge, g4dn.16xlarge
    max_session_length_in_minutes: 1,
    max_stopped_session_length_in_minutes: 1,
    streaming_image_ids: ["StreamingImageId"], # required
  },
  studio_component_ids: ["String"],
  studio_id: "String", # required
})

Response structure


resp.launch_profile.arn #=> String
resp.launch_profile.created_at #=> Time
resp.launch_profile.created_by #=> String
resp.launch_profile.description #=> String
resp.launch_profile.ec2_subnet_ids #=> Array
resp.launch_profile.ec2_subnet_ids[0] #=> String
resp.launch_profile.launch_profile_id #=> String
resp.launch_profile.launch_profile_protocol_versions #=> Array
resp.launch_profile.launch_profile_protocol_versions[0] #=> String
resp.launch_profile.name #=> String
resp.launch_profile.state #=> String, one of "CREATE_IN_PROGRESS", "READY", "UPDATE_IN_PROGRESS", "DELETE_IN_PROGRESS", "DELETED", "DELETE_FAILED", "CREATE_FAILED", "UPDATE_FAILED"
resp.launch_profile.status_code #=> String, one of "LAUNCH_PROFILE_CREATED", "LAUNCH_PROFILE_UPDATED", "LAUNCH_PROFILE_DELETED", "LAUNCH_PROFILE_CREATE_IN_PROGRESS", "LAUNCH_PROFILE_UPDATE_IN_PROGRESS", "LAUNCH_PROFILE_DELETE_IN_PROGRESS", "INTERNAL_ERROR", "STREAMING_IMAGE_NOT_FOUND", "STREAMING_IMAGE_NOT_READY", "LAUNCH_PROFILE_WITH_STREAM_SESSIONS_NOT_DELETED", "ENCRYPTION_KEY_ACCESS_DENIED", "ENCRYPTION_KEY_NOT_FOUND", "INVALID_SUBNETS_PROVIDED"
resp.launch_profile.status_message #=> String
resp.launch_profile.stream_configuration.clipboard_mode #=> String, one of "ENABLED", "DISABLED"
resp.launch_profile.stream_configuration.ec2_instance_types #=> Array
resp.launch_profile.stream_configuration.ec2_instance_types[0] #=> String, one of "g4dn.xlarge", "g4dn.2xlarge", "g4dn.4xlarge", "g4dn.8xlarge", "g4dn.12xlarge", "g4dn.16xlarge"
resp.launch_profile.stream_configuration.max_session_length_in_minutes #=> Integer
resp.launch_profile.stream_configuration.max_stopped_session_length_in_minutes #=> Integer
resp.launch_profile.stream_configuration.streaming_image_ids #=> Array
resp.launch_profile.stream_configuration.streaming_image_ids[0] #=> String
resp.launch_profile.studio_component_ids #=> Array
resp.launch_profile.studio_component_ids[0] #=> String
resp.launch_profile.tags #=> Hash
resp.launch_profile.tags["String"] #=> String
resp.launch_profile.updated_at #=> Time
resp.launch_profile.updated_by #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :client_token (String)

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the AWS SDK automatically generates a client token and uses it for the request to ensure idempotency.

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

  • :description (String)

    The description.

  • :launch_profile_id (required, String)

    The Launch Profile ID.

  • :launch_profile_protocol_versions (Array<String>)

    The version number of the protocol that is used by the launch profile. The only valid version is "2021-03-31".

  • :name (String)

    The name for the launch profile.

  • :stream_configuration (Types::StreamConfigurationCreate)

    A configuration for a streaming session.

  • :studio_component_ids (Array<String>)

    Unique identifiers for a collection of studio components that can be used with this launch profile.

  • :studio_id (required, String)

    The studio ID.

Returns:

See Also:



2990
2991
2992
2993
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 2990

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

#update_launch_profile_member(params = {}) ⇒ Types::UpdateLaunchProfileMemberResponse

Update a user persona in launch profile membership.

Examples:

Request syntax with placeholder values


resp = client.update_launch_profile_member({
  client_token: "ClientToken",
  launch_profile_id: "String", # required
  persona: "USER", # required, accepts USER
  principal_id: "String", # required
  studio_id: "String", # required
})

Response structure


resp.member.identity_store_id #=> String
resp.member.persona #=> String, one of "USER"
resp.member.principal_id #=> String
resp.member.sid #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :client_token (String)

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the AWS SDK automatically generates a client token and uses it for the request to ensure idempotency.

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

  • :launch_profile_id (required, String)

    The Launch Profile ID.

  • :persona (required, String)

    The persona.

  • :principal_id (required, String)

    The principal ID. This currently supports a Amazon Web Services SSO UserId.

  • :studio_id (required, String)

    The studio ID.

Returns:

See Also:



3044
3045
3046
3047
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 3044

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

#update_streaming_image(params = {}) ⇒ Types::UpdateStreamingImageResponse

Update streaming image.

Examples:

Request syntax with placeholder values


resp = client.update_streaming_image({
  client_token: "ClientToken",
  description: "SyntheticUpdateStreamingImageRequestStreamingImageDescription",
  name: "SyntheticUpdateStreamingImageRequestStreamingImageName",
  streaming_image_id: "String", # required
  studio_id: "String", # required
})

Response structure


resp.streaming_image.arn #=> String
resp.streaming_image.description #=> String
resp.streaming_image.ec2_image_id #=> String
resp.streaming_image.encryption_configuration.key_arn #=> String
resp.streaming_image.encryption_configuration.key_type #=> String, one of "CUSTOMER_MANAGED_KEY"
resp.streaming_image.eula_ids #=> Array
resp.streaming_image.eula_ids[0] #=> String
resp.streaming_image.name #=> String
resp.streaming_image.owner #=> String
resp.streaming_image.platform #=> String
resp.streaming_image.state #=> String, one of "CREATE_IN_PROGRESS", "READY", "DELETE_IN_PROGRESS", "DELETED", "UPDATE_IN_PROGRESS", "UPDATE_FAILED", "CREATE_FAILED", "DELETE_FAILED"
resp.streaming_image.status_code #=> String, one of "STREAMING_IMAGE_CREATE_IN_PROGRESS", "STREAMING_IMAGE_READY", "STREAMING_IMAGE_DELETE_IN_PROGRESS", "STREAMING_IMAGE_DELETED", "STREAMING_IMAGE_UPDATE_IN_PROGRESS", "INTERNAL_ERROR"
resp.streaming_image.status_message #=> String
resp.streaming_image.streaming_image_id #=> String
resp.streaming_image.tags #=> Hash
resp.streaming_image.tags["String"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :client_token (String)

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the AWS SDK automatically generates a client token and uses it for the request to ensure idempotency.

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

  • :description (String)

    The description.

  • :name (String)

    The name for the streaming image.

  • :streaming_image_id (required, String)

    The streaming image ID.

  • :studio_id (required, String)

    The studio ID.

Returns:

See Also:



3109
3110
3111
3112
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 3109

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

#update_studio(params = {}) ⇒ Types::UpdateStudioResponse

Update a Studio resource.

Currently, this operation only supports updating the displayName of your studio.

Examples:

Request syntax with placeholder values


resp = client.update_studio({
  admin_role_arn: "String",
  client_token: "ClientToken",
  display_name: "SyntheticUpdateStudioRequestStudioDisplayName",
  studio_id: "String", # required
  user_role_arn: "String",
})

Response structure


resp.studio.admin_role_arn #=> String
resp.studio.arn #=> String
resp.studio.created_at #=> Time
resp.studio.display_name #=> String
resp.studio.home_region #=> String
resp.studio.sso_client_id #=> String
resp.studio.state #=> String, one of "CREATE_IN_PROGRESS", "READY", "UPDATE_IN_PROGRESS", "DELETE_IN_PROGRESS", "DELETED", "DELETE_FAILED", "CREATE_FAILED", "UPDATE_FAILED"
resp.studio.status_code #=> String, one of "STUDIO_CREATED", "STUDIO_DELETED", "STUDIO_UPDATED", "STUDIO_CREATE_IN_PROGRESS", "STUDIO_UPDATE_IN_PROGRESS", "STUDIO_DELETE_IN_PROGRESS", "STUDIO_WITH_LAUNCH_PROFILES_NOT_DELETED", "STUDIO_WITH_STUDIO_COMPONENTS_NOT_DELETED", "STUDIO_WITH_STREAMING_IMAGES_NOT_DELETED", "AWS_SSO_NOT_ENABLED", "AWS_SSO_ACCESS_DENIED", "ROLE_NOT_OWNED_BY_STUDIO_OWNER", "ROLE_COULD_NOT_BE_ASSUMED", "INTERNAL_ERROR", "ENCRYPTION_KEY_NOT_FOUND", "ENCRYPTION_KEY_ACCESS_DENIED", "AWS_SSO_CONFIGURATION_REPAIRED", "AWS_SSO_CONFIGURATION_REPAIR_IN_PROGRESS"
resp.studio.status_message #=> String
resp.studio.studio_encryption_configuration.key_arn #=> String
resp.studio.studio_encryption_configuration.key_type #=> String, one of "AWS_OWNED_KEY", "CUSTOMER_MANAGED_KEY"
resp.studio.studio_id #=> String
resp.studio.studio_name #=> String
resp.studio.studio_url #=> String
resp.studio.tags #=> Hash
resp.studio.tags["String"] #=> String
resp.studio.updated_at #=> Time
resp.studio.user_role_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :admin_role_arn (String)

    The IAM role that Studio Admins will assume when logging in to the Nimble Studio portal.

  • :client_token (String)

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the AWS SDK automatically generates a client token and uses it for the request to ensure idempotency.

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

  • :display_name (String)

    A friendly name for the studio.

  • :studio_id (required, String)

    The studio ID.

  • :user_role_arn (String)

    The IAM role that Studio Users will assume when logging in to the Nimble Studio portal.

Returns:

See Also:



3181
3182
3183
3184
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 3181

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

#update_studio_component(params = {}) ⇒ Types::UpdateStudioComponentResponse

Updates a studio component resource.

Examples:

Request syntax with placeholder values


resp = client.update_studio_component({
  client_token: "ClientToken",
  configuration: {
    active_directory_configuration: {
      computer_attributes: [
        {
          name: "ActiveDirectoryComputerAttributeName",
          value: "ActiveDirectoryComputerAttributeValue",
        },
      ],
      directory_id: "DirectoryId",
      organizational_unit_distinguished_name: "ActiveDirectoryOrganizationalUnitDistinguishedName",
    },
    compute_farm_configuration: {
      active_directory_user: "String",
      endpoint: "SyntheticComputeFarmConfigurationString",
    },
    license_service_configuration: {
      endpoint: "SyntheticLicenseServiceConfigurationString",
    },
    shared_file_system_configuration: {
      endpoint: "SyntheticSharedFileSystemConfigurationString",
      file_system_id: "String",
      linux_mount_point: "LinuxMountPoint",
      share_name: "SyntheticSharedFileSystemConfigurationString",
      windows_mount_drive: "WindowsMountDrive",
    },
  },
  description: "StudioComponentDescription",
  ec2_security_group_ids: ["SecurityGroupId"],
  initialization_scripts: [
    {
      launch_profile_protocol_version: "LaunchProfileProtocolVersion",
      platform: "LINUX", # accepts LINUX, WINDOWS
      run_context: "SYSTEM_INITIALIZATION", # accepts SYSTEM_INITIALIZATION, USER_INITIALIZATION
      script: "StudioComponentInitializationScriptContent",
    },
  ],
  name: "StudioComponentName",
  script_parameters: [
    {
      key: "ScriptParameterKey",
      value: "ScriptParameterValue",
    },
  ],
  studio_component_id: "String", # required
  studio_id: "String", # required
  subtype: "AWS_MANAGED_MICROSOFT_AD", # accepts AWS_MANAGED_MICROSOFT_AD, AMAZON_FSX_FOR_WINDOWS, AMAZON_FSX_FOR_LUSTRE, CUSTOM
  type: "ACTIVE_DIRECTORY", # accepts ACTIVE_DIRECTORY, SHARED_FILE_SYSTEM, COMPUTE_FARM, LICENSE_SERVICE, CUSTOM
})

Response structure


resp.studio_component.arn #=> String
resp.studio_component.configuration.active_directory_configuration.computer_attributes #=> Array
resp.studio_component.configuration.active_directory_configuration.computer_attributes[0].name #=> String
resp.studio_component.configuration.active_directory_configuration.computer_attributes[0].value #=> String
resp.studio_component.configuration.active_directory_configuration.directory_id #=> String
resp.studio_component.configuration.active_directory_configuration.organizational_unit_distinguished_name #=> String
resp.studio_component.configuration.compute_farm_configuration.active_directory_user #=> String
resp.studio_component.configuration.compute_farm_configuration.endpoint #=> String
resp.studio_component.configuration.license_service_configuration.endpoint #=> String
resp.studio_component.configuration.shared_file_system_configuration.endpoint #=> String
resp.studio_component.configuration.shared_file_system_configuration.file_system_id #=> String
resp.studio_component.configuration.shared_file_system_configuration.linux_mount_point #=> String
resp.studio_component.configuration.shared_file_system_configuration.share_name #=> String
resp.studio_component.configuration.shared_file_system_configuration.windows_mount_drive #=> String
resp.studio_component.created_at #=> Time
resp.studio_component.created_by #=> String
resp.studio_component.description #=> String
resp.studio_component.ec2_security_group_ids #=> Array
resp.studio_component.ec2_security_group_ids[0] #=> String
resp.studio_component.initialization_scripts #=> Array
resp.studio_component.initialization_scripts[0].launch_profile_protocol_version #=> String
resp.studio_component.initialization_scripts[0].platform #=> String, one of "LINUX", "WINDOWS"
resp.studio_component.initialization_scripts[0].run_context #=> String, one of "SYSTEM_INITIALIZATION", "USER_INITIALIZATION"
resp.studio_component.initialization_scripts[0].script #=> String
resp.studio_component.name #=> String
resp.studio_component.script_parameters #=> Array
resp.studio_component.script_parameters[0].key #=> String
resp.studio_component.script_parameters[0].value #=> String
resp.studio_component.state #=> String, one of "CREATE_IN_PROGRESS", "READY", "UPDATE_IN_PROGRESS", "DELETE_IN_PROGRESS", "DELETED", "DELETE_FAILED", "CREATE_FAILED", "UPDATE_FAILED"
resp.studio_component.status_code #=> String, one of "ACTIVE_DIRECTORY_ALREADY_EXISTS", "STUDIO_COMPONENT_CREATED", "STUDIO_COMPONENT_UPDATED", "STUDIO_COMPONENT_DELETED", "ENCRYPTION_KEY_ACCESS_DENIED", "ENCRYPTION_KEY_NOT_FOUND", "STUDIO_COMPONENT_CREATE_IN_PROGRESS", "STUDIO_COMPONENT_UPDATE_IN_PROGRESS", "STUDIO_COMPONENT_DELETE_IN_PROGRESS", "INTERNAL_ERROR"
resp.studio_component.status_message #=> String
resp.studio_component.studio_component_id #=> String
resp.studio_component.subtype #=> String, one of "AWS_MANAGED_MICROSOFT_AD", "AMAZON_FSX_FOR_WINDOWS", "AMAZON_FSX_FOR_LUSTRE", "CUSTOM"
resp.studio_component.tags #=> Hash
resp.studio_component.tags["String"] #=> String
resp.studio_component.type #=> String, one of "ACTIVE_DIRECTORY", "SHARED_FILE_SYSTEM", "COMPUTE_FARM", "LICENSE_SERVICE", "CUSTOM"
resp.studio_component.updated_at #=> Time
resp.studio_component.updated_by #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :client_token (String)

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the AWS SDK automatically generates a client token and uses it for the request to ensure idempotency.

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

  • :configuration (Types::StudioComponentConfiguration)

    The configuration of the studio component, based on component type.

  • :description (String)

    The description.

  • :ec2_security_group_ids (Array<String>)

    The EC2 security groups that control access to the studio component.

  • :initialization_scripts (Array<Types::StudioComponentInitializationScript>)

    Initialization scripts for studio components.

  • :name (String)

    The name for the studio component.

  • :script_parameters (Array<Types::ScriptParameterKeyValue>)

    Parameters for the studio component scripts.

  • :studio_component_id (required, String)

    The studio component ID.

  • :studio_id (required, String)

    The studio ID.

  • :subtype (String)

    The specific subtype of a studio component.

  • :type (String)

    The type of the studio component.

Returns:

See Also:



3329
3330
3331
3332
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 3329

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

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

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

Basic Usage

A waiter will call an API operation until:

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

In between attempts, the waiter will sleep.

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

Configuration

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

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

Callbacks

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

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

  # disable max attempts
  max_attempts: nil,

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

Handling Errors

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

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

Valid Waiters

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

waiter_name params :delay :max_attempts
launch_profile_deleted #get_launch_profile 5 150
launch_profile_ready #get_launch_profile 5 150
streaming_image_deleted #get_streaming_image 2 60
streaming_image_ready #get_streaming_image 2 60
streaming_session_deleted #get_streaming_session 5 180
streaming_session_ready #get_streaming_session 10 180
streaming_session_stopped #get_streaming_session 5 180
streaming_session_stream_ready #get_streaming_session_stream 5 30
studio_component_deleted #get_studio_component 1 120
studio_component_ready #get_studio_component 2 60
studio_deleted #get_studio 2 60
studio_ready #get_studio 2 60

Parameters:

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

    ({})

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

    ({})

Options Hash (options):

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

Yields:

  • (w.waiter)

Returns:

  • (Boolean)

    Returns true if the waiter was successful.

Raises:

  • (Errors::FailureStateError)

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

  • (Errors::TooManyAttemptsError)

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

  • (Errors::UnexpectedError)

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

  • (Errors::NoSuchWaiterError)

    Raised when you request to wait for an unknown state.



3450
3451
3452
3453
3454
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 3450

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