You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::AppStream::Client

Inherits:

Seahorse::Client::Base

Object
Seahorse::Client::Base
Aws::AppStream::Client

show all

Defined in:: (unknown)

Overview

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

appstream = Aws::AppStream::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

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

Region

You can configure a default region in the following locations:

ENV['AWS_REGION']
Aws.config[:region]

Go here for a list of supported regions.

Credentials

Default credentials are loaded automatically from the following locations:

ENV['AWS_ACCESS_KEY_ID'] and ENV['AWS_SECRET_ACCESS_KEY']
Aws.config[:credentials]
The shared credentials ini file at ~/.aws/credentials (more information)
From an instance profile when running on EC2

You can also construct a credentials object from one of the following classes:

Alternatively, you configure credentials with :access_key_id and :secret_access_key:

# load credentials from disk
creds = YAML.load(File.read('/path/to/secrets'))

Aws::AppStream::Client.new(
  access_key_id: creds['access_key_id'],
  secret_access_key: creds['secret_access_key']
)

Always load your credentials from outside your application. Avoid configuring credentials statically and never commit them to source control.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

Constructor collapse

#initialize(options = {}) ⇒ Aws::AppStream::Client constructor
Constructs an API client.

API Operations collapse

#associate_fleet(options = {}) ⇒ Struct
Associates the specified fleet with the specified stack.

.
#batch_associate_user_stack(options = {}) ⇒ Types::BatchAssociateUserStackResult
Associates the specified users with the specified stacks.
#batch_disassociate_user_stack(options = {}) ⇒ Types::BatchDisassociateUserStackResult
Disassociates the specified users from the specified stacks.

.
#copy_image(options = {}) ⇒ Types::CopyImageResponse
Copies the image within the same region or to a new region within the same AWS account.
#create_directory_config(options = {}) ⇒ Types::CreateDirectoryConfigResult
Creates a Directory Config object in AppStream 2.0.
#create_fleet(options = {}) ⇒ Types::CreateFleetResult
Creates a fleet.
#create_image_builder(options = {}) ⇒ Types::CreateImageBuilderResult
Creates an image builder.
#create_image_builder_streaming_url(options = {}) ⇒ Types::CreateImageBuilderStreamingURLResult
Creates a URL to start an image builder streaming session.

.
#create_stack(options = {}) ⇒ Types::CreateStackResult
Creates a stack to start streaming applications to users.
#create_streaming_url(options = {}) ⇒ Types::CreateStreamingURLResult
Creates a temporary URL to start an AppStream 2.0 streaming session for the specified user.
#create_usage_report_subscription(options = {}) ⇒ Types::CreateUsageReportSubscriptionResult
Creates a usage report subscription.
#create_user(options = {}) ⇒ Struct
Creates a new user in the user pool.

.
#delete_directory_config(options = {}) ⇒ Struct
Deletes the specified Directory Config object from AppStream 2.0.
#delete_fleet(options = {}) ⇒ Struct
Deletes the specified fleet.

.
#delete_image(options = {}) ⇒ Types::DeleteImageResult
Deletes the specified image.
#delete_image_builder(options = {}) ⇒ Types::DeleteImageBuilderResult
Deletes the specified image builder and releases the capacity.

.
#delete_image_permissions(options = {}) ⇒ Struct
Deletes permissions for the specified private image.
#delete_stack(options = {}) ⇒ Struct
Deletes the specified stack.
#delete_usage_report_subscription(options = {}) ⇒ Struct
Disables usage report generation.

.
#delete_user(options = {}) ⇒ Struct
Deletes a user from the user pool.

.
#describe_directory_configs(options = {}) ⇒ Types::DescribeDirectoryConfigsResult
Retrieves a list that describes one or more specified Directory Config objects for AppStream 2.0, if the names for these objects are provided.
#describe_fleets(options = {}) ⇒ Types::DescribeFleetsResult
Retrieves a list that describes one or more specified fleets, if the fleet names are provided.
#describe_image_builders(options = {}) ⇒ Types::DescribeImageBuildersResult
Retrieves a list that describes one or more specified image builders, if the image builder names are provided.
#describe_image_permissions(options = {}) ⇒ Types::DescribeImagePermissionsResult
Retrieves a list that describes the permissions for shared AWS account IDs on a private image that you own.
#describe_images(options = {}) ⇒ Types::DescribeImagesResult
Retrieves a list that describes one or more specified images, if the image names or image ARNs are provided.
#describe_sessions(options = {}) ⇒ Types::DescribeSessionsResult
Retrieves a list that describes the streaming sessions for a specified stack and fleet.
#describe_stacks(options = {}) ⇒ Types::DescribeStacksResult
Retrieves a list that describes one or more specified stacks, if the stack names are provided.
#describe_usage_report_subscriptions(options = {}) ⇒ Types::DescribeUsageReportSubscriptionsResult
Retrieves a list that describes one or more usage report subscriptions.

.
#describe_user_stack_associations(options = {}) ⇒ Types::DescribeUserStackAssociationsResult
Retrieves a list that describes the UserStackAssociation objects.
#describe_users(options = {}) ⇒ Types::DescribeUsersResult
Retrieves a list that describes one or more specified users in the user pool.

.
#disable_user(options = {}) ⇒ Struct
Disables the specified user in the user pool.
#disassociate_fleet(options = {}) ⇒ Struct
Disassociates the specified fleet from the specified stack.

.
#enable_user(options = {}) ⇒ Struct
Enables a user in the user pool.
#expire_session(options = {}) ⇒ Struct
Immediately stops the specified streaming session.

.
#list_associated_fleets(options = {}) ⇒ Types::ListAssociatedFleetsResult
Retrieves the name of the fleet that is associated with the specified stack.

.
#list_associated_stacks(options = {}) ⇒ Types::ListAssociatedStacksResult
Retrieves the name of the stack with which the specified fleet is associated.

.
#list_tags_for_resource(options = {}) ⇒ Types::ListTagsForResourceResponse
Retrieves a list of all tags for the specified AppStream 2.0 resource.
#start_fleet(options = {}) ⇒ Struct
Starts the specified fleet.

.
#start_image_builder(options = {}) ⇒ Types::StartImageBuilderResult
Starts the specified image builder.

.
#stop_fleet(options = {}) ⇒ Struct
Stops the specified fleet.

.
#stop_image_builder(options = {}) ⇒ Types::StopImageBuilderResult
Stops the specified image builder.

.
#tag_resource(options = {}) ⇒ Struct
Adds or overwrites one or more tags for the specified AppStream 2.0 resource.
#untag_resource(options = {}) ⇒ Struct
Disassociates one or more specified tags from the specified AppStream 2.0 resource.

To list the current tags for your resources, use ListTagsForResource.

For more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide.
.
#update_directory_config(options = {}) ⇒ Types::UpdateDirectoryConfigResult
Updates the specified Directory Config object in AppStream 2.0.
#update_fleet(options = {}) ⇒ Types::UpdateFleetResult
Updates the specified fleet.

If the fleet is in the STOPPED state, you can update any attribute except the fleet name.
#update_image_permissions(options = {}) ⇒ Struct
Adds or updates permissions for the specified private image.
#update_stack(options = {}) ⇒ Types::UpdateStackResult
Updates the specified fields for the specified stack.

.

Instance Method Summary collapse

#wait_until(waiter_name, params = {}) {|waiter| ... } ⇒ Boolean
Waiters polls an API operation until a resource enters a desired state.
#waiter_names ⇒ Array<Symbol>
Returns the list of supported waiters.

Methods inherited from Seahorse::Client::Base

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

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options = {}) ⇒ `Aws::AppStream::Client`

Constructs an API client.

Options Hash (options):

:access_key_id (String) —
Used to set credentials statically. See Plugins::RequestSigner for more details.
:active_endpoint_cache (Boolean) —
When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false. See Plugins::EndpointDiscovery for more details.
:convert_params (Boolean) — default: true —
When true, an attempt is made to coerce request parameters into the required types. See Plugins::ParamConverter for more details.
:credentials (required, Credentials) —
Your AWS credentials. The following locations will be searched in order for credentials:
- :access_key_id, :secret_access_key, and :session_token options
- ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
- HOME/.aws/credentials shared credentials file
- EC2 instance profile credentials See Plugins::RequestSigner for more details.
:disable_host_prefix_injection (Boolean) —
Set to true to disable SDK automatically adding host prefix to default service endpoint when available. See Plugins::EndpointPattern for more details.
:endpoint (String) —
A default endpoint is constructed from the :region. See Plugins::RegionalEndpoint for more details.
:endpoint_cache_max_entries (Integer) —
Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000. See Plugins::EndpointDiscovery for more details.
:endpoint_cache_max_threads (Integer) —
Used for the maximum threads in use for polling endpoints to be cached, defaults to 10. See Plugins::EndpointDiscovery for more details.
:endpoint_cache_poll_interval (Integer) —
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. See Plugins::EndpointDiscovery for more details.
:endpoint_discovery (Boolean) —
When set to true, endpoint discovery will be enabled for operations when available. Defaults to false. See Plugins::EndpointDiscovery for more details.
:http_continue_timeout (Float) — default: 1 —
See Seahorse::Client::Plugins::NetHttp for more details.
:http_idle_timeout (Integer) — default: 5 —
See Seahorse::Client::Plugins::NetHttp for more details.
:http_open_timeout (Integer) — default: 15 —
See Seahorse::Client::Plugins::NetHttp for more details.
:http_proxy (String) —
See Seahorse::Client::Plugins::NetHttp for more details.
:http_read_timeout (Integer) — default: 60 —
See Seahorse::Client::Plugins::NetHttp for more details.
:http_wire_trace (Boolean) — default: false —
See Seahorse::Client::Plugins::NetHttp for more details.
:log_level (Symbol) — default: :info —
The log level to send messages to the logger at. See Plugins::Logging for more details.
:log_formatter (Logging::LogFormatter) —
The log formatter. Defaults to Seahorse::Client::Logging::Formatter.default. See Plugins::Logging for more details.
:logger (Logger) — default: nil —
The Logger instance to send log messages to. If this option is not set, logging will be disabled. See Plugins::Logging for more details.
:profile (String) —
Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used. See Plugins::RequestSigner for more details.
:raise_response_errors (Boolean) — default: true —
When true, response errors are raised. See Seahorse::Client::Plugins::RaiseResponseErrors for more details.
:region (required, String) —
The AWS region to connect to. The region is used to construct the client endpoint. Defaults to ENV['AWS_REGION']. Also checks AMAZON_REGION and AWS_DEFAULT_REGION. See Plugins::RegionalEndpoint for more details.
: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 and auth errors from expired credentials. See Plugins::RetryErrors for more details.
:secret_access_key (String) —
Used to set credentials statically. See Plugins::RequestSigner for more details.
:session_token (String) —
Used to set credentials statically. See Plugins::RequestSigner for more details.
:simple_json (Boolean) — default: false —
Disables request parameter conversion, validation, and formatting. Also disable response data type conversions. This option is useful when you want to ensure the highest level of performance by avoiding overhead of walking request parameters and response data structures.

When :simple_json is enabled, the request parameters hash must be formatted exactly as the DynamoDB API expects. See Plugins::Protocols::JsonRpc for more details.
:ssl_ca_bundle (String) —
See Seahorse::Client::Plugins::NetHttp for more details.
:ssl_ca_directory (String) —
See Seahorse::Client::Plugins::NetHttp for more details.
:ssl_ca_store (String) —
See Seahorse::Client::Plugins::NetHttp for more details.
:ssl_verify_peer (Boolean) — default: true —
See Seahorse::Client::Plugins::NetHttp for more details.
: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. See Plugins::StubResponses for more details.
:validate_params (Boolean) — default: true —
When true, request parameters are validated before sending the request. See Plugins::ParamValidator for more details.

Instance Method Details

#associate_fleet(options = {}) ⇒ `Struct`

Associates the specified fleet with the specified stack.

Examples:

Request syntax with placeholder values


resp = client.associate_fleet({
  fleet_name: "String", # required
  stack_name: "String", # required
})

Options Hash (options):

:fleet_name (required, String) —
The name of the fleet.
:stack_name (required, String) —
The name of the stack.

Returns:

(Struct) —
Returns an empty response.

See Also:

AWS API Documentation

#batch_associate_user_stack(options = {}) ⇒ `Types::BatchAssociateUserStackResult`

Associates the specified users with the specified stacks. Users in a user pool cannot be assigned to stacks with fleets that are joined to an Active Directory domain.

Examples:

Request syntax with placeholder values


resp = client.batch_associate_user_stack({
  user_stack_associations: [ # required
    {
      stack_name: "String", # required
      user_name: "Username", # required
      authentication_type: "API", # required, accepts API, SAML, USERPOOL
      send_email_notification: false,
    },
  ],
})

Response structure


resp.errors #=> Array
resp.errors[0].user_stack_association.stack_name #=> String
resp.errors[0].user_stack_association.user_name #=> String
resp.errors[0].user_stack_association.authentication_type #=> String, one of "API", "SAML", "USERPOOL"
resp.errors[0].user_stack_association.send_email_notification #=> true/false
resp.errors[0].error_code #=> String, one of "STACK_NOT_FOUND", "USER_NAME_NOT_FOUND", "DIRECTORY_NOT_FOUND", "INTERNAL_ERROR"
resp.errors[0].error_message #=> String

Options Hash (options):

:user_stack_associations (required, Array<Types::UserStackAssociation>) —
The list of UserStackAssociation objects.

Returns:

(Types::BatchAssociateUserStackResult) —
Returns a response object which responds to the following methods:
- #errors => Array<Types::UserStackAssociationError>

See Also:

AWS API Documentation

#batch_disassociate_user_stack(options = {}) ⇒ `Types::BatchDisassociateUserStackResult`

Disassociates the specified users from the specified stacks.

Examples:

Request syntax with placeholder values


resp = client.batch_disassociate_user_stack({
  user_stack_associations: [ # required
    {
      stack_name: "String", # required
      user_name: "Username", # required
      authentication_type: "API", # required, accepts API, SAML, USERPOOL
      send_email_notification: false,
    },
  ],
})

Response structure


resp.errors #=> Array
resp.errors[0].user_stack_association.stack_name #=> String
resp.errors[0].user_stack_association.user_name #=> String
resp.errors[0].user_stack_association.authentication_type #=> String, one of "API", "SAML", "USERPOOL"
resp.errors[0].user_stack_association.send_email_notification #=> true/false
resp.errors[0].error_code #=> String, one of "STACK_NOT_FOUND", "USER_NAME_NOT_FOUND", "DIRECTORY_NOT_FOUND", "INTERNAL_ERROR"
resp.errors[0].error_message #=> String

Options Hash (options):

:user_stack_associations (required, Array<Types::UserStackAssociation>) —
The list of UserStackAssociation objects.

Returns:

(Types::BatchDisassociateUserStackResult) —
Returns a response object which responds to the following methods:
- #errors => Array<Types::UserStackAssociationError>

See Also:

AWS API Documentation

#copy_image(options = {}) ⇒ `Types::CopyImageResponse`

Copies the image within the same region or to a new region within the same AWS account. Note that any tags you added to the image will not be copied.

Examples:

Request syntax with placeholder values


resp = client.copy_image({
  source_image_name: "Name", # required
  destination_image_name: "Name", # required
  destination_region: "RegionName", # required
  destination_image_description: "Description",
})

Response structure


resp.destination_image_name #=> String

Options Hash (options):

:source_image_name (required, String) —
The name of the image to copy.
:destination_image_name (required, String) —
The name that the image will have when it is copied to the destination.
:destination_region (required, String) —
The destination region to which the image will be copied. This parameter is required, even if you are copying an image within the same region.
:destination_image_description (String) —
The description that the image will have when it is copied to the destination.

Returns:

(Types::CopyImageResponse) —
Returns a response object which responds to the following methods:
- #destination_image_name => String

See Also:

AWS API Documentation

#create_directory_config(options = {}) ⇒ `Types::CreateDirectoryConfigResult`

Creates a Directory Config object in AppStream 2.0. This object includes the configuration information required to join fleets and image builders to Microsoft Active Directory domains.

Examples:

Request syntax with placeholder values


resp = client.create_directory_config({
  directory_name: "DirectoryName", # required
  organizational_unit_distinguished_names: ["OrganizationalUnitDistinguishedName"], # required
  service_account_credentials: {
    account_name: "AccountName", # required
    account_password: "AccountPassword", # required
  },
})

Response structure


resp.directory_config.directory_name #=> String
resp.directory_config.organizational_unit_distinguished_names #=> Array
resp.directory_config.organizational_unit_distinguished_names[0] #=> String
resp.directory_config.service_account_credentials.account_name #=> String
resp.directory_config.service_account_credentials.account_password #=> String
resp.directory_config.created_time #=> Time

Options Hash (options):

:directory_name (required, String) —
The fully qualified name of the directory (for example, corp.example.com).
:organizational_unit_distinguished_names (required, Array<String>) —
The distinguished names of the organizational units for computer accounts.
:service_account_credentials (Types::ServiceAccountCredentials) —
The credentials for the service account used by the fleet or image builder to connect to the directory.

Returns:

(Types::CreateDirectoryConfigResult) —
Returns a response object which responds to the following methods:
- #directory_config => Types::DirectoryConfig

See Also:

AWS API Documentation

#create_fleet(options = {}) ⇒ `Types::CreateFleetResult`

Creates a fleet. A fleet consists of streaming instances that run a specified image.

Examples:

Request syntax with placeholder values


resp = client.create_fleet({
  name: "Name", # required
  image_name: "String",
  image_arn: "Arn",
  instance_type: "String", # required
  fleet_type: "ALWAYS_ON", # accepts ALWAYS_ON, ON_DEMAND
  compute_capacity: { # required
    desired_instances: 1, # required
  },
  vpc_config: {
    subnet_ids: ["String"],
    security_group_ids: ["String"],
  },
  max_user_duration_in_seconds: 1,
  disconnect_timeout_in_seconds: 1,
  description: "Description",
  display_name: "DisplayName",
  enable_default_internet_access: false,
  domain_join_info: {
    directory_name: "DirectoryName",
    organizational_unit_distinguished_name: "OrganizationalUnitDistinguishedName",
  },
  tags: {
    "TagKey" => "TagValue",
  },
  idle_disconnect_timeout_in_seconds: 1,
  iam_role_arn: "Arn",
  stream_view: "APP", # accepts APP, DESKTOP
})

Response structure


resp.fleet.arn #=> String
resp.fleet.name #=> String
resp.fleet.display_name #=> String
resp.fleet.description #=> String
resp.fleet.image_name #=> String
resp.fleet.image_arn #=> String
resp.fleet.instance_type #=> String
resp.fleet.fleet_type #=> String, one of "ALWAYS_ON", "ON_DEMAND"
resp.fleet.compute_capacity_status.desired #=> Integer
resp.fleet.compute_capacity_status.running #=> Integer
resp.fleet.compute_capacity_status.in_use #=> Integer
resp.fleet.compute_capacity_status.available #=> Integer
resp.fleet.max_user_duration_in_seconds #=> Integer
resp.fleet.disconnect_timeout_in_seconds #=> Integer
resp.fleet.state #=> String, one of "STARTING", "RUNNING", "STOPPING", "STOPPED"
resp.fleet.vpc_config.subnet_ids #=> Array
resp.fleet.vpc_config.subnet_ids[0] #=> String
resp.fleet.vpc_config.security_group_ids #=> Array
resp.fleet.vpc_config.security_group_ids[0] #=> String
resp.fleet.created_time #=> Time
resp.fleet.fleet_errors #=> Array
resp.fleet.fleet_errors[0].error_code #=> String, one of "IAM_SERVICE_ROLE_MISSING_ENI_DESCRIBE_ACTION", "IAM_SERVICE_ROLE_MISSING_ENI_CREATE_ACTION", "IAM_SERVICE_ROLE_MISSING_ENI_DELETE_ACTION", "NETWORK_INTERFACE_LIMIT_EXCEEDED", "INTERNAL_SERVICE_ERROR", "IAM_SERVICE_ROLE_IS_MISSING", "MACHINE_ROLE_IS_MISSING", "STS_DISABLED_IN_REGION", "SUBNET_HAS_INSUFFICIENT_IP_ADDRESSES", "IAM_SERVICE_ROLE_MISSING_DESCRIBE_SUBNET_ACTION", "SUBNET_NOT_FOUND", "IMAGE_NOT_FOUND", "INVALID_SUBNET_CONFIGURATION", "SECURITY_GROUPS_NOT_FOUND", "IGW_NOT_ATTACHED", "IAM_SERVICE_ROLE_MISSING_DESCRIBE_SECURITY_GROUPS_ACTION", "DOMAIN_JOIN_ERROR_FILE_NOT_FOUND", "DOMAIN_JOIN_ERROR_ACCESS_DENIED", "DOMAIN_JOIN_ERROR_LOGON_FAILURE", "DOMAIN_JOIN_ERROR_INVALID_PARAMETER", "DOMAIN_JOIN_ERROR_MORE_DATA", "DOMAIN_JOIN_ERROR_NO_SUCH_DOMAIN", "DOMAIN_JOIN_ERROR_NOT_SUPPORTED", "DOMAIN_JOIN_NERR_INVALID_WORKGROUP_NAME", "DOMAIN_JOIN_NERR_WORKSTATION_NOT_STARTED", "DOMAIN_JOIN_ERROR_DS_MACHINE_ACCOUNT_QUOTA_EXCEEDED", "DOMAIN_JOIN_NERR_PASSWORD_EXPIRED", "DOMAIN_JOIN_INTERNAL_SERVICE_ERROR"
resp.fleet.fleet_errors[0].error_message #=> String
resp.fleet.enable_default_internet_access #=> true/false
resp.fleet.domain_join_info.directory_name #=> String
resp.fleet.domain_join_info.organizational_unit_distinguished_name #=> String
resp.fleet.idle_disconnect_timeout_in_seconds #=> Integer
resp.fleet.iam_role_arn #=> String
resp.fleet.stream_view #=> String, one of "APP", "DESKTOP"

Options Hash (options):

:name (required, String) —
A unique name for the fleet.
:image_name (String) —
The name of the image used to create the fleet.
:image_arn (String) —
The ARN of the public, private, or shared image to use.
:instance_type (required, String) —
The instance type to use when launching fleet instances. The following instance types are available:
- stream.standard.medium
- stream.standard.large
- stream.compute.large
- stream.compute.xlarge
- stream.compute.2xlarge
- stream.compute.4xlarge
- stream.compute.8xlarge
- stream.memory.large
- stream.memory.xlarge
- stream.memory.2xlarge
- stream.memory.4xlarge
- stream.memory.8xlarge
- stream.memory.z1d.large
- stream.memory.z1d.xlarge
- stream.memory.z1d.2xlarge
- stream.memory.z1d.3xlarge
- stream.memory.z1d.6xlarge
- stream.memory.z1d.12xlarge
- stream.graphics-design.large
- stream.graphics-design.xlarge
- stream.graphics-design.2xlarge
- stream.graphics-design.4xlarge
- stream.graphics-desktop.2xlarge
- stream.graphics.g4dn.xlarge
- stream.graphics.g4dn.2xlarge
- stream.graphics.g4dn.4xlarge
- stream.graphics.g4dn.8xlarge
- stream.graphics.g4dn.12xlarge
- stream.graphics.g4dn.16xlarge
- stream.graphics-pro.4xlarge
- stream.graphics-pro.8xlarge
- stream.graphics-pro.16xlarge
:fleet_type (String) —
The fleet type.

ALWAYS_ON

Provides users with instant-on access to their apps. You are charged for all running instances in your fleet, even if no users are streaming apps.

ON_DEMAND

Provide users with access to applications after they connect, which takes one to two minutes. You are charged for instance streaming when users are connected and a small hourly fee for instances that are not streaming apps.
:compute_capacity (required, Types::ComputeCapacity) —
The desired capacity for the fleet.
:vpc_config (Types::VpcConfig) —
The VPC configuration for the fleet.
:max_user_duration_in_seconds (Integer) —
The maximum amount of time that a streaming session can remain active, in seconds. If users are still connected to a streaming instance five minutes before this limit is reached, they are prompted to save any open documents before being disconnected. After this time elapses, the instance is terminated and replaced by a new instance.

Specify a value between 600 and 360000.
:disconnect_timeout_in_seconds (Integer) —
The amount of time that a streaming session remains active after users disconnect. If users try to reconnect to the streaming session after a disconnection or network interruption within this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance.

Specify a value between 60 and 360000.
:description (String) —
The description to display.
:display_name (String) —
The fleet name to display.
:enable_default_internet_access (Boolean) —
Enables or disables default internet access for the fleet.
:domain_join_info (Types::DomainJoinInfo) —
The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain.
:tags (Hash<String,String>) —
The tags to associate with the fleet. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=.

If you do not specify a value, the value is set to an empty string.

Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters:

_ . : / = + \ - @

For more information, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide.
:idle_disconnect_timeout_in_seconds (Integer) —
The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the DisconnectTimeoutInSeconds time interval begins. Users are notified before they are disconnected due to inactivity. If they try to reconnect to the streaming session before the time interval specified in DisconnectTimeoutInSeconds elapses, they are connected to their previous session. Users are considered idle when they stop providing keyboard or mouse input during their streaming session. File uploads and downloads, audio in, audio out, and pixels changing do not qualify as user activity. If users continue to be idle after the time interval in IdleDisconnectTimeoutInSeconds elapses, they are disconnected.

To prevent users from being disconnected due to inactivity, specify a value of 0. Otherwise, specify a value between 60 and 3600. The default value is 0.

If you enable this feature, we recommend that you specify a value that corresponds exactly to a whole number of minutes (for example, 60, 120, and 180). If you don\'t do this, the value is rounded to the nearest minute. For example, if you specify a value of 70, users are disconnected after 1 minute of inactivity. If you specify a value that is at the midpoint between two different minutes, the value is rounded up. For example, if you specify a value of 90, users are disconnected after 2 minutes of inactivity.
:iam_role_arn (String) —
The Amazon Resource Name (ARN) of the IAM role to apply to the fleet. To assume a role, a fleet instance calls the AWS Security Token Service (STS) AssumeRole API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the appstream_machine_role credential profile on the instance.

For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide.
:stream_view (String) —
The AppStream 2.0 view that is displayed to your users when they stream from the fleet. When APP is specified, only the windows of applications opened by users display. When DESKTOP is specified, the standard desktop that is provided by the operating system displays.

The default value is APP.

Returns:

(Types::CreateFleetResult) —
Returns a response object which responds to the following methods:
- #fleet => Types::Fleet

See Also:

AWS API Documentation

#create_image_builder(options = {}) ⇒ `Types::CreateImageBuilderResult`

Creates an image builder. An image builder is a virtual machine that is used to create an image.

The initial state of the builder is PENDING. When it is ready, the state is RUNNING.

Examples:

Request syntax with placeholder values


resp = client.create_image_builder({
  name: "Name", # required
  image_name: "String",
  image_arn: "Arn",
  instance_type: "String", # required
  description: "Description",
  display_name: "DisplayName",
  vpc_config: {
    subnet_ids: ["String"],
    security_group_ids: ["String"],
  },
  iam_role_arn: "Arn",
  enable_default_internet_access: false,
  domain_join_info: {
    directory_name: "DirectoryName",
    organizational_unit_distinguished_name: "OrganizationalUnitDistinguishedName",
  },
  appstream_agent_version: "AppstreamAgentVersion",
  tags: {
    "TagKey" => "TagValue",
  },
  access_endpoints: [
    {
      endpoint_type: "STREAMING", # required, accepts STREAMING
      vpce_id: "String",
    },
  ],
})

Response structure


resp.image_builder.name #=> String
resp.image_builder.arn #=> String
resp.image_builder.image_arn #=> String
resp.image_builder.description #=> String
resp.image_builder.display_name #=> String
resp.image_builder.vpc_config.subnet_ids #=> Array
resp.image_builder.vpc_config.subnet_ids[0] #=> String
resp.image_builder.vpc_config.security_group_ids #=> Array
resp.image_builder.vpc_config.security_group_ids[0] #=> String
resp.image_builder.instance_type #=> String
resp.image_builder.platform #=> String, one of "WINDOWS", "WINDOWS_SERVER_2016", "WINDOWS_SERVER_2019"
resp.image_builder.iam_role_arn #=> String
resp.image_builder.state #=> String, one of "PENDING", "UPDATING_AGENT", "RUNNING", "STOPPING", "STOPPED", "REBOOTING", "SNAPSHOTTING", "DELETING", "FAILED"
resp.image_builder.state_change_reason.code #=> String, one of "INTERNAL_ERROR", "IMAGE_UNAVAILABLE"
resp.image_builder.state_change_reason.message #=> String
resp.image_builder.created_time #=> Time
resp.image_builder.enable_default_internet_access #=> true/false
resp.image_builder.domain_join_info.directory_name #=> String
resp.image_builder.domain_join_info.organizational_unit_distinguished_name #=> String
resp.image_builder.network_access_configuration.eni_private_ip_address #=> String
resp.image_builder.network_access_configuration.eni_id #=> String
resp.image_builder.image_builder_errors #=> Array
resp.image_builder.image_builder_errors[0].error_code #=> String, one of "IAM_SERVICE_ROLE_MISSING_ENI_DESCRIBE_ACTION", "IAM_SERVICE_ROLE_MISSING_ENI_CREATE_ACTION", "IAM_SERVICE_ROLE_MISSING_ENI_DELETE_ACTION", "NETWORK_INTERFACE_LIMIT_EXCEEDED", "INTERNAL_SERVICE_ERROR", "IAM_SERVICE_ROLE_IS_MISSING", "MACHINE_ROLE_IS_MISSING", "STS_DISABLED_IN_REGION", "SUBNET_HAS_INSUFFICIENT_IP_ADDRESSES", "IAM_SERVICE_ROLE_MISSING_DESCRIBE_SUBNET_ACTION", "SUBNET_NOT_FOUND", "IMAGE_NOT_FOUND", "INVALID_SUBNET_CONFIGURATION", "SECURITY_GROUPS_NOT_FOUND", "IGW_NOT_ATTACHED", "IAM_SERVICE_ROLE_MISSING_DESCRIBE_SECURITY_GROUPS_ACTION", "DOMAIN_JOIN_ERROR_FILE_NOT_FOUND", "DOMAIN_JOIN_ERROR_ACCESS_DENIED", "DOMAIN_JOIN_ERROR_LOGON_FAILURE", "DOMAIN_JOIN_ERROR_INVALID_PARAMETER", "DOMAIN_JOIN_ERROR_MORE_DATA", "DOMAIN_JOIN_ERROR_NO_SUCH_DOMAIN", "DOMAIN_JOIN_ERROR_NOT_SUPPORTED", "DOMAIN_JOIN_NERR_INVALID_WORKGROUP_NAME", "DOMAIN_JOIN_NERR_WORKSTATION_NOT_STARTED", "DOMAIN_JOIN_ERROR_DS_MACHINE_ACCOUNT_QUOTA_EXCEEDED", "DOMAIN_JOIN_NERR_PASSWORD_EXPIRED", "DOMAIN_JOIN_INTERNAL_SERVICE_ERROR"
resp.image_builder.image_builder_errors[0].error_message #=> String
resp.image_builder.image_builder_errors[0].error_timestamp #=> Time
resp.image_builder.appstream_agent_version #=> String
resp.image_builder.access_endpoints #=> Array
resp.image_builder.access_endpoints[0].endpoint_type #=> String, one of "STREAMING"
resp.image_builder.access_endpoints[0].vpce_id #=> String

Options Hash (options):

:name (required, String) —
A unique name for the image builder.
:image_name (String) —
The name of the image used to create the image builder.
:image_arn (String) —
The ARN of the public, private, or shared image to use.
:instance_type (required, String) —
The instance type to use when launching the image builder. The following instance types are available:
- stream.standard.medium
- stream.standard.large
- stream.compute.large
- stream.compute.xlarge
- stream.compute.2xlarge
- stream.compute.4xlarge
- stream.compute.8xlarge
- stream.memory.large
- stream.memory.xlarge
- stream.memory.2xlarge
- stream.memory.4xlarge
- stream.memory.8xlarge
- stream.memory.z1d.large
- stream.memory.z1d.xlarge
- stream.memory.z1d.2xlarge
- stream.memory.z1d.3xlarge
- stream.memory.z1d.6xlarge
- stream.memory.z1d.12xlarge
- stream.graphics-design.large
- stream.graphics-design.xlarge
- stream.graphics-design.2xlarge
- stream.graphics-design.4xlarge
- stream.graphics-desktop.2xlarge
- stream.graphics.g4dn.xlarge
- stream.graphics.g4dn.2xlarge
- stream.graphics.g4dn.4xlarge
- stream.graphics.g4dn.8xlarge
- stream.graphics.g4dn.12xlarge
- stream.graphics.g4dn.16xlarge
- stream.graphics-pro.4xlarge
- stream.graphics-pro.8xlarge
- stream.graphics-pro.16xlarge
:description (String) —
The description to display.
:display_name (String) —
The image builder name to display.
:vpc_config (Types::VpcConfig) —
The VPC configuration for the image builder. You can specify only one subnet.
:iam_role_arn (String) —
The Amazon Resource Name (ARN) of the IAM role to apply to the image builder. To assume a role, the image builder calls the AWS Security Token Service (STS) AssumeRole API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the appstream_machine_role credential profile on the instance.

For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide.
:enable_default_internet_access (Boolean) —
Enables or disables default internet access for the image builder.
:domain_join_info (Types::DomainJoinInfo) —
The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain.
:appstream_agent_version (String) —
The version of the AppStream 2.0 agent to use for this image builder. To use the latest version of the AppStream 2.0 agent, specify [LATEST].
:tags (Hash<String,String>) —
The tags to associate with the image builder. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=.

Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters:

_ . : / = + \ - @

If you do not specify a value, the value is set to an empty string.

For more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide.
:access_endpoints (Array<Types::AccessEndpoint>) —
The list of interface VPC endpoint (interface endpoint) objects. Administrators can connect to the image builder only through the specified endpoints.

Returns:

(Types::CreateImageBuilderResult) —
Returns a response object which responds to the following methods:
- #image_builder => Types::ImageBuilder

See Also:

AWS API Documentation

#create_image_builder_streaming_url(options = {}) ⇒ `Types::CreateImageBuilderStreamingURLResult`

Creates a URL to start an image builder streaming session.

Examples:

Request syntax with placeholder values


resp = client.create_image_builder_streaming_url({
  name: "String", # required
  validity: 1,
})

Response structure


resp.streaming_url #=> String
resp.expires #=> Time

Options Hash (options):

:name (required, String) —
The name of the image builder.
:validity (Integer) —
The time that the streaming URL will be valid, in seconds. Specify a value between 1 and 604800 seconds. The default is 3600 seconds.

Returns:

(Types::CreateImageBuilderStreamingURLResult) —
Returns a response object which responds to the following methods:
- #streaming_url => String
- #expires => Time

See Also:

AWS API Documentation

#create_stack(options = {}) ⇒ `Types::CreateStackResult`

Creates a stack to start streaming applications to users. A stack consists of an associated fleet, user access policies, and storage configurations.

Examples:

Request syntax with placeholder values


resp = client.create_stack({
  name: "Name", # required
  description: "Description",
  display_name: "DisplayName",
  storage_connectors: [
    {
      connector_type: "HOMEFOLDERS", # required, accepts HOMEFOLDERS, GOOGLE_DRIVE, ONE_DRIVE
      resource_identifier: "ResourceIdentifier",
      domains: ["Domain"],
    },
  ],
  redirect_url: "RedirectURL",
  feedback_url: "FeedbackURL",
  user_settings: [
    {
      action: "CLIPBOARD_COPY_FROM_LOCAL_DEVICE", # required, accepts CLIPBOARD_COPY_FROM_LOCAL_DEVICE, CLIPBOARD_COPY_TO_LOCAL_DEVICE, FILE_UPLOAD, FILE_DOWNLOAD, PRINTING_TO_LOCAL_DEVICE
      permission: "ENABLED", # required, accepts ENABLED, DISABLED
    },
  ],
  application_settings: {
    enabled: false, # required
    settings_group: "SettingsGroup",
  },
  tags: {
    "TagKey" => "TagValue",
  },
  access_endpoints: [
    {
      endpoint_type: "STREAMING", # required, accepts STREAMING
      vpce_id: "String",
    },
  ],
  embed_host_domains: ["EmbedHostDomain"],
})

Response structure


resp.stack.arn #=> String
resp.stack.name #=> String
resp.stack.description #=> String
resp.stack.display_name #=> String
resp.stack.created_time #=> Time
resp.stack.storage_connectors #=> Array
resp.stack.storage_connectors[0].connector_type #=> String, one of "HOMEFOLDERS", "GOOGLE_DRIVE", "ONE_DRIVE"
resp.stack.storage_connectors[0].resource_identifier #=> String
resp.stack.storage_connectors[0].domains #=> Array
resp.stack.storage_connectors[0].domains[0] #=> String
resp.stack.redirect_url #=> String
resp.stack.feedback_url #=> String
resp.stack.stack_errors #=> Array
resp.stack.stack_errors[0].error_code #=> String, one of "STORAGE_CONNECTOR_ERROR", "INTERNAL_SERVICE_ERROR"
resp.stack.stack_errors[0].error_message #=> String
resp.stack.user_settings #=> Array
resp.stack.user_settings[0].action #=> String, one of "CLIPBOARD_COPY_FROM_LOCAL_DEVICE", "CLIPBOARD_COPY_TO_LOCAL_DEVICE", "FILE_UPLOAD", "FILE_DOWNLOAD", "PRINTING_TO_LOCAL_DEVICE"
resp.stack.user_settings[0].permission #=> String, one of "ENABLED", "DISABLED"
resp.stack.application_settings.enabled #=> true/false
resp.stack.application_settings.settings_group #=> String
resp.stack.application_settings.s3_bucket_name #=> String
resp.stack.access_endpoints #=> Array
resp.stack.access_endpoints[0].endpoint_type #=> String, one of "STREAMING"
resp.stack.access_endpoints[0].vpce_id #=> String
resp.stack.embed_host_domains #=> Array
resp.stack.embed_host_domains[0] #=> String

Options Hash (options):

:name (required, String) —
The name of the stack.
:description (String) —
The description to display.
:display_name (String) —
The stack name to display.
:storage_connectors (Array<Types::StorageConnector>) —
The storage connectors to enable.
:redirect_url (String) —
The URL that users are redirected to after their streaming session ends.
:feedback_url (String) —
The URL that users are redirected to after they click the Send Feedback link. If no URL is specified, no Send Feedback link is displayed.
:user_settings (Array<Types::UserSetting>) —
The actions that are enabled or disabled for users during their streaming sessions. By default, these actions are enabled.
:application_settings (Types::ApplicationSettings) —
The persistent application settings for users of a stack. When these settings are enabled, changes that users make to applications and Windows settings are automatically saved after each session and applied to the next session.
:tags (Hash<String,String>) —
The tags to associate with the stack. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=.

If you do not specify a value, the value is set to an empty string.

Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters:

_ . : / = + \ - @

For more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide.
:access_endpoints (Array<Types::AccessEndpoint>) —
The list of interface VPC endpoint (interface endpoint) objects. Users of the stack can connect to AppStream 2.0 only through the specified endpoints.
:embed_host_domains (Array<String>) —
The domains where AppStream 2.0 streaming sessions can be embedded in an iframe. You must approve the domains that you want to host embedded AppStream 2.0 streaming sessions.

Returns:

(Types::CreateStackResult) —
Returns a response object which responds to the following methods:
- #stack => Types::Stack

See Also:

AWS API Documentation

#create_streaming_url(options = {}) ⇒ `Types::CreateStreamingURLResult`

Creates a temporary URL to start an AppStream 2.0 streaming session for the specified user. A streaming URL enables application streaming to be tested without user setup.

Examples:

Request syntax with placeholder values


resp = client.create_streaming_url({
  stack_name: "String", # required
  fleet_name: "String", # required
  user_id: "StreamingUrlUserId", # required
  application_id: "String",
  validity: 1,
  session_context: "String",
})

Response structure


resp.streaming_url #=> String
resp.expires #=> Time

Options Hash (options):

:stack_name (required, String) —
The name of the stack.
:fleet_name (required, String) —
The name of the fleet.
:user_id (required, String) —
The identifier of the user.
:application_id (String) —
The name of the application to launch after the session starts. This is the name that you specified as Name in the Image Assistant.
:validity (Integer) —
The time that the streaming URL will be valid, in seconds. Specify a value between 1 and 604800 seconds. The default is 60 seconds.
:session_context (String) —
The session context. For more information, see Session Context in the Amazon AppStream 2.0 Administration Guide.

Returns:

(Types::CreateStreamingURLResult) —
Returns a response object which responds to the following methods:
- #streaming_url => String
- #expires => Time

See Also:

AWS API Documentation

#create_usage_report_subscription(options = {}) ⇒ `Types::CreateUsageReportSubscriptionResult`

Creates a usage report subscription. Usage reports are generated daily.

Examples:

Request syntax with placeholder values


resp = client.create_usage_report_subscription()

Response structure


resp.s3_bucket_name #=> String
resp.schedule #=> String, one of "DAILY"

Returns:

(Types::CreateUsageReportSubscriptionResult) —
Returns a response object which responds to the following methods:
- #s3_bucket_name => String
- #schedule => String

See Also:

AWS API Documentation

#create_user(options = {}) ⇒ `Struct`

Creates a new user in the user pool.

Examples:

Request syntax with placeholder values


resp = client.create_user({
  user_name: "Username", # required
  message_action: "SUPPRESS", # accepts SUPPRESS, RESEND
  first_name: "UserAttributeValue",
  last_name: "UserAttributeValue",
  authentication_type: "API", # required, accepts API, SAML, USERPOOL
})

Options Hash (options):

:user_name (required, String) —
The email address of the user.

Users\' email addresses are case-sensitive. During login, if they specify an email address that doesn\'t use the same capitalization as the email address specified when their user pool account was created, a \"user does not exist\" error message displays.
:message_action (String) —
The action to take for the welcome email that is sent to a user after the user is created in the user pool. If you specify SUPPRESS, no email is sent. If you specify RESEND, do not specify the first name or last name of the user. If the value is null, the email is sent.

The temporary password in the welcome email is valid for only 7 days. If users don’t set their passwords within 7 days, you must send them a new welcome email.
:first_name (String) —
The first name, or given name, of the user.
:last_name (String) —
The last name, or surname, of the user.
:authentication_type (required, String) —
The authentication type for the user. You must specify USERPOOL.

Returns:

(Struct) —
Returns an empty response.

See Also:

AWS API Documentation

#delete_directory_config(options = {}) ⇒ `Struct`

Deletes the specified Directory Config object from AppStream 2.0. This object includes the information required to join streaming instances to an Active Directory domain.

Examples:

Request syntax with placeholder values


resp = client.delete_directory_config({
  directory_name: "DirectoryName", # required
})

Options Hash (options):

:directory_name (required, String) —
The name of the directory configuration.

Returns:

(Struct) —
Returns an empty response.

See Also:

AWS API Documentation

#delete_fleet(options = {}) ⇒ `Struct`

Deletes the specified fleet.

Examples:

Request syntax with placeholder values


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

Options Hash (options):

:name (required, String) —
The name of the fleet.

Returns:

(Struct) —
Returns an empty response.

See Also:

AWS API Documentation

#delete_image(options = {}) ⇒ `Types::DeleteImageResult`

Deletes the specified image. You cannot delete an image when it is in use. After you delete an image, you cannot provision new capacity using the image.

Examples:

Request syntax with placeholder values


resp = client.delete_image({
  name: "Name", # required
})

Response structure


resp.image.name #=> String
resp.image.arn #=> String
resp.image.base_image_arn #=> String
resp.image.display_name #=> String
resp.image.state #=> String, one of "PENDING", "AVAILABLE", "FAILED", "COPYING", "DELETING"
resp.image.visibility #=> String, one of "PUBLIC", "PRIVATE", "SHARED"
resp.image.image_builder_supported #=> true/false
resp.image.image_builder_name #=> String
resp.image.platform #=> String, one of "WINDOWS", "WINDOWS_SERVER_2016", "WINDOWS_SERVER_2019"
resp.image.description #=> String
resp.image.state_change_reason.code #=> String, one of "INTERNAL_ERROR", "IMAGE_BUILDER_NOT_AVAILABLE", "IMAGE_COPY_FAILURE"
resp.image.state_change_reason.message #=> String
resp.image.applications #=> Array
resp.image.applications[0].name #=> String
resp.image.applications[0].display_name #=> String
resp.image.applications[0].icon_url #=> String
resp.image.applications[0].launch_path #=> String
resp.image.applications[0].launch_parameters #=> String
resp.image.applications[0].enabled #=> true/false
resp.image.applications[0].metadata #=> Hash
resp.image.applications[0].metadata["String"] #=> String
resp.image.created_time #=> Time
resp.image.public_base_image_released_date #=> Time
resp.image.appstream_agent_version #=> String
resp.image.image_permissions.allow_fleet #=> true/false
resp.image.image_permissions.allow_image_builder #=> true/false

Options Hash (options):

:name (required, String) —
The name of the image.

Returns:

(Types::DeleteImageResult) —
Returns a response object which responds to the following methods:
- #image => Types::Image

See Also:

AWS API Documentation

#delete_image_builder(options = {}) ⇒ `Types::DeleteImageBuilderResult`

Deletes the specified image builder and releases the capacity.

Examples:

Request syntax with placeholder values


resp = client.delete_image_builder({
  name: "Name", # required
})

Response structure


resp.image_builder.name #=> String
resp.image_builder.arn #=> String
resp.image_builder.image_arn #=> String
resp.image_builder.description #=> String
resp.image_builder.display_name #=> String
resp.image_builder.vpc_config.subnet_ids #=> Array
resp.image_builder.vpc_config.subnet_ids[0] #=> String
resp.image_builder.vpc_config.security_group_ids #=> Array
resp.image_builder.vpc_config.security_group_ids[0] #=> String
resp.image_builder.instance_type #=> String
resp.image_builder.platform #=> String, one of "WINDOWS", "WINDOWS_SERVER_2016", "WINDOWS_SERVER_2019"
resp.image_builder.iam_role_arn #=> String
resp.image_builder.state #=> String, one of "PENDING", "UPDATING_AGENT", "RUNNING", "STOPPING", "STOPPED", "REBOOTING", "SNAPSHOTTING", "DELETING", "FAILED"
resp.image_builder.state_change_reason.code #=> String, one of "INTERNAL_ERROR", "IMAGE_UNAVAILABLE"
resp.image_builder.state_change_reason.message #=> String
resp.image_builder.created_time #=> Time
resp.image_builder.enable_default_internet_access #=> true/false
resp.image_builder.domain_join_info.directory_name #=> String
resp.image_builder.domain_join_info.organizational_unit_distinguished_name #=> String
resp.image_builder.network_access_configuration.eni_private_ip_address #=> String
resp.image_builder.network_access_configuration.eni_id #=> String
resp.image_builder.image_builder_errors #=> Array
resp.image_builder.image_builder_errors[0].error_code #=> String, one of "IAM_SERVICE_ROLE_MISSING_ENI_DESCRIBE_ACTION", "IAM_SERVICE_ROLE_MISSING_ENI_CREATE_ACTION", "IAM_SERVICE_ROLE_MISSING_ENI_DELETE_ACTION", "NETWORK_INTERFACE_LIMIT_EXCEEDED", "INTERNAL_SERVICE_ERROR", "IAM_SERVICE_ROLE_IS_MISSING", "MACHINE_ROLE_IS_MISSING", "STS_DISABLED_IN_REGION", "SUBNET_HAS_INSUFFICIENT_IP_ADDRESSES", "IAM_SERVICE_ROLE_MISSING_DESCRIBE_SUBNET_ACTION", "SUBNET_NOT_FOUND", "IMAGE_NOT_FOUND", "INVALID_SUBNET_CONFIGURATION", "SECURITY_GROUPS_NOT_FOUND", "IGW_NOT_ATTACHED", "IAM_SERVICE_ROLE_MISSING_DESCRIBE_SECURITY_GROUPS_ACTION", "DOMAIN_JOIN_ERROR_FILE_NOT_FOUND", "DOMAIN_JOIN_ERROR_ACCESS_DENIED", "DOMAIN_JOIN_ERROR_LOGON_FAILURE", "DOMAIN_JOIN_ERROR_INVALID_PARAMETER", "DOMAIN_JOIN_ERROR_MORE_DATA", "DOMAIN_JOIN_ERROR_NO_SUCH_DOMAIN", "DOMAIN_JOIN_ERROR_NOT_SUPPORTED", "DOMAIN_JOIN_NERR_INVALID_WORKGROUP_NAME", "DOMAIN_JOIN_NERR_WORKSTATION_NOT_STARTED", "DOMAIN_JOIN_ERROR_DS_MACHINE_ACCOUNT_QUOTA_EXCEEDED", "DOMAIN_JOIN_NERR_PASSWORD_EXPIRED", "DOMAIN_JOIN_INTERNAL_SERVICE_ERROR"
resp.image_builder.image_builder_errors[0].error_message #=> String
resp.image_builder.image_builder_errors[0].error_timestamp #=> Time
resp.image_builder.appstream_agent_version #=> String
resp.image_builder.access_endpoints #=> Array
resp.image_builder.access_endpoints[0].endpoint_type #=> String, one of "STREAMING"
resp.image_builder.access_endpoints[0].vpce_id #=> String

Options Hash (options):

:name (required, String) —
The name of the image builder.

Returns:

(Types::DeleteImageBuilderResult) —
Returns a response object which responds to the following methods:
- #image_builder => Types::ImageBuilder

See Also:

AWS API Documentation

#delete_image_permissions(options = {}) ⇒ `Struct`

Deletes permissions for the specified private image. After you delete permissions for an image, AWS accounts to which you previously granted these permissions can no longer use the image.

Examples:

Request syntax with placeholder values


resp = client.delete_image_permissions({
  name: "Name", # required
  shared_account_id: "AwsAccountId", # required
})

Options Hash (options):

:name (required, String) —
The name of the private image.
:shared_account_id (required, String) —
The 12-digit identifier of the AWS account for which to delete image permissions.

Returns:

(Struct) —
Returns an empty response.

See Also:

AWS API Documentation

#delete_stack(options = {}) ⇒ `Struct`

Deletes the specified stack. After the stack is deleted, the application streaming environment provided by the stack is no longer available to users. Also, any reservations made for application streaming sessions for the stack are released.

Examples:

Request syntax with placeholder values


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

Options Hash (options):

:name (required, String) —
The name of the stack.

Returns:

(Struct) —
Returns an empty response.

See Also:

AWS API Documentation

#delete_usage_report_subscription(options = {}) ⇒ `Struct`

Disables usage report generation.

Examples:

Request syntax with placeholder values


resp = client.delete_usage_report_subscription()

Returns:

(Struct) —
Returns an empty response.

See Also:

AWS API Documentation

#delete_user(options = {}) ⇒ `Struct`

Deletes a user from the user pool.

Examples:

Request syntax with placeholder values


resp = client.delete_user({
  user_name: "Username", # required
  authentication_type: "API", # required, accepts API, SAML, USERPOOL
})

Options Hash (options):

:user_name (required, String) —
The email address of the user.

Users\' email addresses are case-sensitive.
:authentication_type (required, String) —
The authentication type for the user. You must specify USERPOOL.

Returns:

(Struct) —
Returns an empty response.

See Also:

AWS API Documentation

#describe_directory_configs(options = {}) ⇒ `Types::DescribeDirectoryConfigsResult`

Retrieves a list that describes one or more specified Directory Config objects for AppStream 2.0, if the names for these objects are provided. Otherwise, all Directory Config objects in the account are described. These objects include the configuration information required to join fleets and image builders to Microsoft Active Directory domains.

Although the response syntax in this topic includes the account password, this password is not returned in the actual response.

Examples:

Request syntax with placeholder values


resp = client.describe_directory_configs({
  directory_names: ["DirectoryName"],
  max_results: 1,
  next_token: "String",
})

Response structure


resp.directory_configs #=> Array
resp.directory_configs[0].directory_name #=> String
resp.directory_configs[0].organizational_unit_distinguished_names #=> Array
resp.directory_configs[0].organizational_unit_distinguished_names[0] #=> String
resp.directory_configs[0].service_account_credentials.account_name #=> String
resp.directory_configs[0].service_account_credentials.account_password #=> String
resp.directory_configs[0].created_time #=> Time
resp.next_token #=> String

Options Hash (options):

:directory_names (Array<String>) —
The directory names.
:max_results (Integer) —
The maximum size of each page of results.
:next_token (String) —
The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

Returns:

(Types::DescribeDirectoryConfigsResult) —
Returns a response object which responds to the following methods:
- #directory_configs => Array<Types::DirectoryConfig>
- #next_token => String

See Also:

AWS API Documentation

#describe_fleets(options = {}) ⇒ `Types::DescribeFleetsResult`

Retrieves a list that describes one or more specified fleets, if the fleet names are provided. Otherwise, all fleets in the account are described.

Examples:

Request syntax with placeholder values


resp = client.describe_fleets({
  names: ["String"],
  next_token: "String",
})

Response structure


resp.fleets #=> Array
resp.fleets[0].arn #=> String
resp.fleets[0].name #=> String
resp.fleets[0].display_name #=> String
resp.fleets[0].description #=> String
resp.fleets[0].image_name #=> String
resp.fleets[0].image_arn #=> String
resp.fleets[0].instance_type #=> String
resp.fleets[0].fleet_type #=> String, one of "ALWAYS_ON", "ON_DEMAND"
resp.fleets[0].compute_capacity_status.desired #=> Integer
resp.fleets[0].compute_capacity_status.running #=> Integer
resp.fleets[0].compute_capacity_status.in_use #=> Integer
resp.fleets[0].compute_capacity_status.available #=> Integer
resp.fleets[0].max_user_duration_in_seconds #=> Integer
resp.fleets[0].disconnect_timeout_in_seconds #=> Integer
resp.fleets[0].state #=> String, one of "STARTING", "RUNNING", "STOPPING", "STOPPED"
resp.fleets[0].vpc_config.subnet_ids #=> Array
resp.fleets[0].vpc_config.subnet_ids[0] #=> String
resp.fleets[0].vpc_config.security_group_ids #=> Array
resp.fleets[0].vpc_config.security_group_ids[0] #=> String
resp.fleets[0].created_time #=> Time
resp.fleets[0].fleet_errors #=> Array
resp.fleets[0].fleet_errors[0].error_code #=> String, one of "IAM_SERVICE_ROLE_MISSING_ENI_DESCRIBE_ACTION", "IAM_SERVICE_ROLE_MISSING_ENI_CREATE_ACTION", "IAM_SERVICE_ROLE_MISSING_ENI_DELETE_ACTION", "NETWORK_INTERFACE_LIMIT_EXCEEDED", "INTERNAL_SERVICE_ERROR", "IAM_SERVICE_ROLE_IS_MISSING", "MACHINE_ROLE_IS_MISSING", "STS_DISABLED_IN_REGION", "SUBNET_HAS_INSUFFICIENT_IP_ADDRESSES", "IAM_SERVICE_ROLE_MISSING_DESCRIBE_SUBNET_ACTION", "SUBNET_NOT_FOUND", "IMAGE_NOT_FOUND", "INVALID_SUBNET_CONFIGURATION", "SECURITY_GROUPS_NOT_FOUND", "IGW_NOT_ATTACHED", "IAM_SERVICE_ROLE_MISSING_DESCRIBE_SECURITY_GROUPS_ACTION", "DOMAIN_JOIN_ERROR_FILE_NOT_FOUND", "DOMAIN_JOIN_ERROR_ACCESS_DENIED", "DOMAIN_JOIN_ERROR_LOGON_FAILURE", "DOMAIN_JOIN_ERROR_INVALID_PARAMETER", "DOMAIN_JOIN_ERROR_MORE_DATA", "DOMAIN_JOIN_ERROR_NO_SUCH_DOMAIN", "DOMAIN_JOIN_ERROR_NOT_SUPPORTED", "DOMAIN_JOIN_NERR_INVALID_WORKGROUP_NAME", "DOMAIN_JOIN_NERR_WORKSTATION_NOT_STARTED", "DOMAIN_JOIN_ERROR_DS_MACHINE_ACCOUNT_QUOTA_EXCEEDED", "DOMAIN_JOIN_NERR_PASSWORD_EXPIRED", "DOMAIN_JOIN_INTERNAL_SERVICE_ERROR"
resp.fleets[0].fleet_errors[0].error_message #=> String
resp.fleets[0].enable_default_internet_access #=> true/false
resp.fleets[0].domain_join_info.directory_name #=> String
resp.fleets[0].domain_join_info.organizational_unit_distinguished_name #=> String
resp.fleets[0].idle_disconnect_timeout_in_seconds #=> Integer
resp.fleets[0].iam_role_arn #=> String
resp.fleets[0].stream_view #=> String, one of "APP", "DESKTOP"
resp.next_token #=> String

Options Hash (options):

:names (Array<String>) —
The names of the fleets to describe.
:next_token (String) —
The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

Returns:

(Types::DescribeFleetsResult) —
Returns a response object which responds to the following methods:
- #fleets => Array<Types::Fleet>
- #next_token => String

See Also:

AWS API Documentation

#describe_image_builders(options = {}) ⇒ `Types::DescribeImageBuildersResult`

Retrieves a list that describes one or more specified image builders, if the image builder names are provided. Otherwise, all image builders in the account are described.

Examples:

Request syntax with placeholder values


resp = client.describe_image_builders({
  names: ["String"],
  max_results: 1,
  next_token: "String",
})

Response structure


resp.image_builders #=> Array
resp.image_builders[0].name #=> String
resp.image_builders[0].arn #=> String
resp.image_builders[0].image_arn #=> String
resp.image_builders[0].description #=> String
resp.image_builders[0].display_name #=> String
resp.image_builders[0].vpc_config.subnet_ids #=> Array
resp.image_builders[0].vpc_config.subnet_ids[0] #=> String
resp.image_builders[0].vpc_config.security_group_ids #=> Array
resp.image_builders[0].vpc_config.security_group_ids[0] #=> String
resp.image_builders[0].instance_type #=> String
resp.image_builders[0].platform #=> String, one of "WINDOWS", "WINDOWS_SERVER_2016", "WINDOWS_SERVER_2019"
resp.image_builders[0].iam_role_arn #=> String
resp.image_builders[0].state #=> String, one of "PENDING", "UPDATING_AGENT", "RUNNING", "STOPPING", "STOPPED", "REBOOTING", "SNAPSHOTTING", "DELETING", "FAILED"
resp.image_builders[0].state_change_reason.code #=> String, one of "INTERNAL_ERROR", "IMAGE_UNAVAILABLE"
resp.image_builders[0].state_change_reason.message #=> String
resp.image_builders[0].created_time #=> Time
resp.image_builders[0].enable_default_internet_access #=> true/false
resp.image_builders[0].domain_join_info.directory_name #=> String
resp.image_builders[0].domain_join_info.organizational_unit_distinguished_name #=> String
resp.image_builders[0].network_access_configuration.eni_private_ip_address #=> String
resp.image_builders[0].network_access_configuration.eni_id #=> String
resp.image_builders[0].image_builder_errors #=> Array
resp.image_builders[0].image_builder_errors[0].error_code #=> String, one of "IAM_SERVICE_ROLE_MISSING_ENI_DESCRIBE_ACTION", "IAM_SERVICE_ROLE_MISSING_ENI_CREATE_ACTION", "IAM_SERVICE_ROLE_MISSING_ENI_DELETE_ACTION", "NETWORK_INTERFACE_LIMIT_EXCEEDED", "INTERNAL_SERVICE_ERROR", "IAM_SERVICE_ROLE_IS_MISSING", "MACHINE_ROLE_IS_MISSING", "STS_DISABLED_IN_REGION", "SUBNET_HAS_INSUFFICIENT_IP_ADDRESSES", "IAM_SERVICE_ROLE_MISSING_DESCRIBE_SUBNET_ACTION", "SUBNET_NOT_FOUND", "IMAGE_NOT_FOUND", "INVALID_SUBNET_CONFIGURATION", "SECURITY_GROUPS_NOT_FOUND", "IGW_NOT_ATTACHED", "IAM_SERVICE_ROLE_MISSING_DESCRIBE_SECURITY_GROUPS_ACTION", "DOMAIN_JOIN_ERROR_FILE_NOT_FOUND", "DOMAIN_JOIN_ERROR_ACCESS_DENIED", "DOMAIN_JOIN_ERROR_LOGON_FAILURE", "DOMAIN_JOIN_ERROR_INVALID_PARAMETER", "DOMAIN_JOIN_ERROR_MORE_DATA", "DOMAIN_JOIN_ERROR_NO_SUCH_DOMAIN", "DOMAIN_JOIN_ERROR_NOT_SUPPORTED", "DOMAIN_JOIN_NERR_INVALID_WORKGROUP_NAME", "DOMAIN_JOIN_NERR_WORKSTATION_NOT_STARTED", "DOMAIN_JOIN_ERROR_DS_MACHINE_ACCOUNT_QUOTA_EXCEEDED", "DOMAIN_JOIN_NERR_PASSWORD_EXPIRED", "DOMAIN_JOIN_INTERNAL_SERVICE_ERROR"
resp.image_builders[0].image_builder_errors[0].error_message #=> String
resp.image_builders[0].image_builder_errors[0].error_timestamp #=> Time
resp.image_builders[0].appstream_agent_version #=> String
resp.image_builders[0].access_endpoints #=> Array
resp.image_builders[0].access_endpoints[0].endpoint_type #=> String, one of "STREAMING"
resp.image_builders[0].access_endpoints[0].vpce_id #=> String
resp.next_token #=> String

Options Hash (options):

:names (Array<String>) —
The names of the image builders to describe.
:max_results (Integer) —
The maximum size of each page of results.
:next_token (String) —
The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

Returns:

(Types::DescribeImageBuildersResult) —
Returns a response object which responds to the following methods:
- #image_builders => Array<Types::ImageBuilder>
- #next_token => String

See Also:

AWS API Documentation

#describe_image_permissions(options = {}) ⇒ `Types::DescribeImagePermissionsResult`

Retrieves a list that describes the permissions for shared AWS account IDs on a private image that you own.

Examples:

Request syntax with placeholder values


resp = client.describe_image_permissions({
  name: "Name", # required
  max_results: 1,
  shared_aws_account_ids: ["AwsAccountId"],
  next_token: "String",
})

Response structure


resp.name #=> String
resp.shared_image_permissions_list #=> Array
resp.shared_image_permissions_list[0].shared_account_id #=> String
resp.shared_image_permissions_list[0].image_permissions.allow_fleet #=> true/false
resp.shared_image_permissions_list[0].image_permissions.allow_image_builder #=> true/false
resp.next_token #=> String

Options Hash (options):

:name (required, String) —
The name of the private image for which to describe permissions. The image must be one that you own.
:max_results (Integer) —
The maximum size of each page of results.
:shared_aws_account_ids (Array<String>) —
The 12-digit identifier of one or more AWS accounts with which the image is shared.
:next_token (String) —
The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

Returns:

(Types::DescribeImagePermissionsResult) —
Returns a response object which responds to the following methods:
- #name => String
- #shared_image_permissions_list => Array<Types::SharedImagePermissions>
- #next_token => String

See Also:

AWS API Documentation

#describe_images(options = {}) ⇒ `Types::DescribeImagesResult`

Retrieves a list that describes one or more specified images, if the image names or image ARNs are provided. Otherwise, all images in the account are described.

Examples:

Request syntax with placeholder values


resp = client.describe_images({
  names: ["String"],
  arns: ["Arn"],
  type: "PUBLIC", # accepts PUBLIC, PRIVATE, SHARED
  next_token: "String",
  max_results: 1,
})

Response structure


resp.images #=> Array
resp.images[0].name #=> String
resp.images[0].arn #=> String
resp.images[0].base_image_arn #=> String
resp.images[0].display_name #=> String
resp.images[0].state #=> String, one of "PENDING", "AVAILABLE", "FAILED", "COPYING", "DELETING"
resp.images[0].visibility #=> String, one of "PUBLIC", "PRIVATE", "SHARED"
resp.images[0].image_builder_supported #=> true/false
resp.images[0].image_builder_name #=> String
resp.images[0].platform #=> String, one of "WINDOWS", "WINDOWS_SERVER_2016", "WINDOWS_SERVER_2019"
resp.images[0].description #=> String
resp.images[0].state_change_reason.code #=> String, one of "INTERNAL_ERROR", "IMAGE_BUILDER_NOT_AVAILABLE", "IMAGE_COPY_FAILURE"
resp.images[0].state_change_reason.message #=> String
resp.images[0].applications #=> Array
resp.images[0].applications[0].name #=> String
resp.images[0].applications[0].display_name #=> String
resp.images[0].applications[0].icon_url #=> String
resp.images[0].applications[0].launch_path #=> String
resp.images[0].applications[0].launch_parameters #=> String
resp.images[0].applications[0].enabled #=> true/false
resp.images[0].applications[0].metadata #=> Hash
resp.images[0].applications[0].metadata["String"] #=> String
resp.images[0].created_time #=> Time
resp.images[0].public_base_image_released_date #=> Time
resp.images[0].appstream_agent_version #=> String
resp.images[0].image_permissions.allow_fleet #=> true/false
resp.images[0].image_permissions.allow_image_builder #=> true/false
resp.next_token #=> String

Options Hash (options):

:names (Array<String>) —
The names of the public or private images to describe.
:arns (Array<String>) —
The ARNs of the public, private, and shared images to describe.
:type (String) —
The type of image (public, private, or shared) to describe.
:next_token (String) —
The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
:max_results (Integer) —
The maximum size of each page of results.

Returns:

(Types::DescribeImagesResult) —
Returns a response object which responds to the following methods:
- #images => Array<Types::Image>
- #next_token => String

See Also:

AWS API Documentation

#describe_sessions(options = {}) ⇒ `Types::DescribeSessionsResult`

Retrieves a list that describes the streaming sessions for a specified stack and fleet. If a UserId is provided for the stack and fleet, only streaming sessions for that user are described. If an authentication type is not provided, the default is to authenticate users using a streaming URL.

Examples:

Request syntax with placeholder values


resp = client.describe_sessions({
  stack_name: "String", # required
  fleet_name: "String", # required
  user_id: "UserId",
  next_token: "String",
  limit: 1,
  authentication_type: "API", # accepts API, SAML, USERPOOL
})

Response structure


resp.sessions #=> Array
resp.sessions[0].id #=> String
resp.sessions[0].user_id #=> String
resp.sessions[0].stack_name #=> String
resp.sessions[0].fleet_name #=> String
resp.sessions[0].state #=> String, one of "ACTIVE", "PENDING", "EXPIRED"
resp.sessions[0].connection_state #=> String, one of "CONNECTED", "NOT_CONNECTED"
resp.sessions[0].start_time #=> Time
resp.sessions[0].max_expiration_time #=> Time
resp.sessions[0].authentication_type #=> String, one of "API", "SAML", "USERPOOL"
resp.sessions[0].network_access_configuration.eni_private_ip_address #=> String
resp.sessions[0].network_access_configuration.eni_id #=> String
resp.next_token #=> String

Options Hash (options):

:stack_name (required, String) —
The name of the stack. This value is case-sensitive.
:fleet_name (required, String) —
The name of the fleet. This value is case-sensitive.
:user_id (String) —
The user identifier (ID). If you specify a user ID, you must also specify the authentication type.
:next_token (String) —
The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
:limit (Integer) —
The size of each page of results. The default value is 20 and the maximum value is 50.
:authentication_type (String) —
The authentication method. Specify API for a user authenticated using a streaming URL or SAML for a SAML federated user. The default is to authenticate users using a streaming URL.

Returns:

(Types::DescribeSessionsResult) —
Returns a response object which responds to the following methods:
- #sessions => Array<Types::Session>
- #next_token => String

See Also:

AWS API Documentation

#describe_stacks(options = {}) ⇒ `Types::DescribeStacksResult`

Retrieves a list that describes one or more specified stacks, if the stack names are provided. Otherwise, all stacks in the account are described.

Examples:

Request syntax with placeholder values


resp = client.describe_stacks({
  names: ["String"],
  next_token: "String",
})

Response structure


resp.stacks #=> Array
resp.stacks[0].arn #=> String
resp.stacks[0].name #=> String
resp.stacks[0].description #=> String
resp.stacks[0].display_name #=> String
resp.stacks[0].created_time #=> Time
resp.stacks[0].storage_connectors #=> Array
resp.stacks[0].storage_connectors[0].connector_type #=> String, one of "HOMEFOLDERS", "GOOGLE_DRIVE", "ONE_DRIVE"
resp.stacks[0].storage_connectors[0].resource_identifier #=> String
resp.stacks[0].storage_connectors[0].domains #=> Array
resp.stacks[0].storage_connectors[0].domains[0] #=> String
resp.stacks[0].redirect_url #=> String
resp.stacks[0].feedback_url #=> String
resp.stacks[0].stack_errors #=> Array
resp.stacks[0].stack_errors[0].error_code #=> String, one of "STORAGE_CONNECTOR_ERROR", "INTERNAL_SERVICE_ERROR"
resp.stacks[0].stack_errors[0].error_message #=> String
resp.stacks[0].user_settings #=> Array
resp.stacks[0].user_settings[0].action #=> String, one of "CLIPBOARD_COPY_FROM_LOCAL_DEVICE", "CLIPBOARD_COPY_TO_LOCAL_DEVICE", "FILE_UPLOAD", "FILE_DOWNLOAD", "PRINTING_TO_LOCAL_DEVICE"
resp.stacks[0].user_settings[0].permission #=> String, one of "ENABLED", "DISABLED"
resp.stacks[0].application_settings.enabled #=> true/false
resp.stacks[0].application_settings.settings_group #=> String
resp.stacks[0].application_settings.s3_bucket_name #=> String
resp.stacks[0].access_endpoints #=> Array
resp.stacks[0].access_endpoints[0].endpoint_type #=> String, one of "STREAMING"
resp.stacks[0].access_endpoints[0].vpce_id #=> String
resp.stacks[0].embed_host_domains #=> Array
resp.stacks[0].embed_host_domains[0] #=> String
resp.next_token #=> String

Options Hash (options):

:names (Array<String>) —
The names of the stacks to describe.
:next_token (String) —
The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

Returns:

(Types::DescribeStacksResult) —
Returns a response object which responds to the following methods:
- #stacks => Array<Types::Stack>
- #next_token => String

See Also:

AWS API Documentation

#describe_usage_report_subscriptions(options = {}) ⇒ `Types::DescribeUsageReportSubscriptionsResult`

Retrieves a list that describes one or more usage report subscriptions.

Examples:

Request syntax with placeholder values


resp = client.describe_usage_report_subscriptions({
  max_results: 1,
  next_token: "String",
})

Response structure


resp.usage_report_subscriptions #=> Array
resp.usage_report_subscriptions[0].s3_bucket_name #=> String
resp.usage_report_subscriptions[0].schedule #=> String, one of "DAILY"
resp.usage_report_subscriptions[0].last_generated_report_date #=> Time
resp.usage_report_subscriptions[0].subscription_errors #=> Array
resp.usage_report_subscriptions[0].subscription_errors[0].error_code #=> String, one of "RESOURCE_NOT_FOUND", "ACCESS_DENIED", "INTERNAL_SERVICE_ERROR"
resp.usage_report_subscriptions[0].subscription_errors[0].error_message #=> String
resp.next_token #=> String

Options Hash (options):

:max_results (Integer) —
The maximum size of each page of results.
:next_token (String) —
The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

Returns:

(Types::DescribeUsageReportSubscriptionsResult) —
Returns a response object which responds to the following methods:
- #usage_report_subscriptions => Array<Types::UsageReportSubscription>
- #next_token => String

See Also:

AWS API Documentation

#describe_user_stack_associations(options = {}) ⇒ `Types::DescribeUserStackAssociationsResult`

Retrieves a list that describes the UserStackAssociation objects. You must specify either or both of the following:

The stack name
The user name (email address of the user associated with the stack) and the authentication type for the user

Examples:

Request syntax with placeholder values


resp = client.describe_user_stack_associations({
  stack_name: "String",
  user_name: "Username",
  authentication_type: "API", # accepts API, SAML, USERPOOL
  max_results: 1,
  next_token: "String",
})

Response structure


resp.user_stack_associations #=> Array
resp.user_stack_associations[0].stack_name #=> String
resp.user_stack_associations[0].user_name #=> String
resp.user_stack_associations[0].authentication_type #=> String, one of "API", "SAML", "USERPOOL"
resp.user_stack_associations[0].send_email_notification #=> true/false
resp.next_token #=> String

Options Hash (options):

:stack_name (String) —
The name of the stack that is associated with the user.
:user_name (String) —
The email address of the user who is associated with the stack.

Users\' email addresses are case-sensitive.
:authentication_type (String) —
The authentication type for the user who is associated with the stack. You must specify USERPOOL.
:max_results (Integer) —
The maximum size of each page of results.
:next_token (String) —
The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

Returns:

(Types::DescribeUserStackAssociationsResult) —
Returns a response object which responds to the following methods:
- #user_stack_associations => Array<Types::UserStackAssociation>
- #next_token => String

See Also:

AWS API Documentation

#describe_users(options = {}) ⇒ `Types::DescribeUsersResult`

Retrieves a list that describes one or more specified users in the user pool.

Examples:

Request syntax with placeholder values


resp = client.describe_users({
  authentication_type: "API", # required, accepts API, SAML, USERPOOL
  max_results: 1,
  next_token: "String",
})

Response structure


resp.users #=> Array
resp.users[0].arn #=> String
resp.users[0].user_name #=> String
resp.users[0].enabled #=> true/false
resp.users[0].status #=> String
resp.users[0].first_name #=> String
resp.users[0].last_name #=> String
resp.users[0].created_time #=> Time
resp.users[0].authentication_type #=> String, one of "API", "SAML", "USERPOOL"
resp.next_token #=> String

Options Hash (options):

:authentication_type (required, String) —
The authentication type for the users in the user pool to describe. You must specify USERPOOL.
:max_results (Integer) —
The maximum size of each page of results.
:next_token (String) —
The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

Returns:

(Types::DescribeUsersResult) —
Returns a response object which responds to the following methods:
- #users => Array<Types::User>
- #next_token => String

See Also:

AWS API Documentation

#disable_user(options = {}) ⇒ `Struct`

Disables the specified user in the user pool. Users can't sign in to AppStream 2.0 until they are re-enabled. This action does not delete the user.

Examples:

Request syntax with placeholder values


resp = client.disable_user({
  user_name: "Username", # required
  authentication_type: "API", # required, accepts API, SAML, USERPOOL
})

Options Hash (options):

:user_name (required, String) —
The email address of the user.

Users\' email addresses are case-sensitive.
:authentication_type (required, String) —
The authentication type for the user. You must specify USERPOOL.

Returns:

(Struct) —
Returns an empty response.

See Also:

AWS API Documentation

#disassociate_fleet(options = {}) ⇒ `Struct`

Disassociates the specified fleet from the specified stack.

Examples:

Request syntax with placeholder values


resp = client.disassociate_fleet({
  fleet_name: "String", # required
  stack_name: "String", # required
})

Options Hash (options):

:fleet_name (required, String) —
The name of the fleet.
:stack_name (required, String) —
The name of the stack.

Returns:

(Struct) —
Returns an empty response.

See Also:

AWS API Documentation

#enable_user(options = {}) ⇒ `Struct`

Enables a user in the user pool. After being enabled, users can sign in to AppStream 2.0 and open applications from the stacks to which they are assigned.

Examples:

Request syntax with placeholder values


resp = client.enable_user({
  user_name: "Username", # required
  authentication_type: "API", # required, accepts API, SAML, USERPOOL
})

Options Hash (options):

:user_name (required, String) —
The email address of the user.

Users\' email addresses are case-sensitive. During login, if they specify an email address that doesn\'t use the same capitalization as the email address specified when their user pool account was created, a \"user does not exist\" error message displays.
:authentication_type (required, String) —
The authentication type for the user. You must specify USERPOOL.

Returns:

(Struct) —
Returns an empty response.

See Also:

AWS API Documentation

#expire_session(options = {}) ⇒ `Struct`

Immediately stops the specified streaming session.

Examples:

Request syntax with placeholder values


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

Options Hash (options):

:session_id (required, String) —
The identifier of the streaming session.

Returns:

(Struct) —
Returns an empty response.

See Also:

AWS API Documentation

#list_associated_fleets(options = {}) ⇒ `Types::ListAssociatedFleetsResult`

Retrieves the name of the fleet that is associated with the specified stack.

Examples:

Request syntax with placeholder values


resp = client.list_associated_fleets({
  stack_name: "String", # required
  next_token: "String",
})

Response structure


resp.names #=> Array
resp.names[0] #=> String
resp.next_token #=> String

Options Hash (options):

:stack_name (required, String) —
The name of the stack.
:next_token (String) —
The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

Returns:

(Types::ListAssociatedFleetsResult) —
Returns a response object which responds to the following methods:
- #names => Array<String>
- #next_token => String

See Also:

AWS API Documentation

#list_associated_stacks(options = {}) ⇒ `Types::ListAssociatedStacksResult`

Retrieves the name of the stack with which the specified fleet is associated.

Examples:

Request syntax with placeholder values


resp = client.list_associated_stacks({
  fleet_name: "String", # required
  next_token: "String",
})

Response structure


resp.names #=> Array
resp.names[0] #=> String
resp.next_token #=> String

Options Hash (options):

:fleet_name (required, String) —
The name of the fleet.
:next_token (String) —
The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

Returns:

(Types::ListAssociatedStacksResult) —
Returns a response object which responds to the following methods:
- #names => Array<String>
- #next_token => String

See Also:

AWS API Documentation

#list_tags_for_resource(options = {}) ⇒ `Types::ListTagsForResourceResponse`

Retrieves a list of all tags for the specified AppStream 2.0 resource. You can tag AppStream 2.0 image builders, images, fleets, and stacks.

For more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide.

Examples:

Request syntax with placeholder values


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

Response structure


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

Options Hash (options):

:resource_arn (required, String) —
The Amazon Resource Name (ARN) of the resource.

Returns:

(Types::ListTagsForResourceResponse) —
Returns a response object which responds to the following methods:
- #tags => Hash<String,String>

See Also:

AWS API Documentation

#start_fleet(options = {}) ⇒ `Struct`

Starts the specified fleet.

Examples:

Request syntax with placeholder values


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

Options Hash (options):

:name (required, String) —
The name of the fleet.

Returns:

(Struct) —
Returns an empty response.

See Also:

AWS API Documentation

#start_image_builder(options = {}) ⇒ `Types::StartImageBuilderResult`

Starts the specified image builder.

Examples:

Request syntax with placeholder values


resp = client.start_image_builder({
  name: "String", # required
  appstream_agent_version: "AppstreamAgentVersion",
})

Response structure


resp.image_builder.name #=> String
resp.image_builder.arn #=> String
resp.image_builder.image_arn #=> String
resp.image_builder.description #=> String
resp.image_builder.display_name #=> String
resp.image_builder.vpc_config.subnet_ids #=> Array
resp.image_builder.vpc_config.subnet_ids[0] #=> String
resp.image_builder.vpc_config.security_group_ids #=> Array
resp.image_builder.vpc_config.security_group_ids[0] #=> String
resp.image_builder.instance_type #=> String
resp.image_builder.platform #=> String, one of "WINDOWS", "WINDOWS_SERVER_2016", "WINDOWS_SERVER_2019"
resp.image_builder.iam_role_arn #=> String
resp.image_builder.state #=> String, one of "PENDING", "UPDATING_AGENT", "RUNNING", "STOPPING", "STOPPED", "REBOOTING", "SNAPSHOTTING", "DELETING", "FAILED"
resp.image_builder.state_change_reason.code #=> String, one of "INTERNAL_ERROR", "IMAGE_UNAVAILABLE"
resp.image_builder.state_change_reason.message #=> String
resp.image_builder.created_time #=> Time
resp.image_builder.enable_default_internet_access #=> true/false
resp.image_builder.domain_join_info.directory_name #=> String
resp.image_builder.domain_join_info.organizational_unit_distinguished_name #=> String
resp.image_builder.network_access_configuration.eni_private_ip_address #=> String
resp.image_builder.network_access_configuration.eni_id #=> String
resp.image_builder.image_builder_errors #=> Array
resp.image_builder.image_builder_errors[0].error_code #=> String, one of "IAM_SERVICE_ROLE_MISSING_ENI_DESCRIBE_ACTION", "IAM_SERVICE_ROLE_MISSING_ENI_CREATE_ACTION", "IAM_SERVICE_ROLE_MISSING_ENI_DELETE_ACTION", "NETWORK_INTERFACE_LIMIT_EXCEEDED", "INTERNAL_SERVICE_ERROR", "IAM_SERVICE_ROLE_IS_MISSING", "MACHINE_ROLE_IS_MISSING", "STS_DISABLED_IN_REGION", "SUBNET_HAS_INSUFFICIENT_IP_ADDRESSES", "IAM_SERVICE_ROLE_MISSING_DESCRIBE_SUBNET_ACTION", "SUBNET_NOT_FOUND", "IMAGE_NOT_FOUND", "INVALID_SUBNET_CONFIGURATION", "SECURITY_GROUPS_NOT_FOUND", "IGW_NOT_ATTACHED", "IAM_SERVICE_ROLE_MISSING_DESCRIBE_SECURITY_GROUPS_ACTION", "DOMAIN_JOIN_ERROR_FILE_NOT_FOUND", "DOMAIN_JOIN_ERROR_ACCESS_DENIED", "DOMAIN_JOIN_ERROR_LOGON_FAILURE", "DOMAIN_JOIN_ERROR_INVALID_PARAMETER", "DOMAIN_JOIN_ERROR_MORE_DATA", "DOMAIN_JOIN_ERROR_NO_SUCH_DOMAIN", "DOMAIN_JOIN_ERROR_NOT_SUPPORTED", "DOMAIN_JOIN_NERR_INVALID_WORKGROUP_NAME", "DOMAIN_JOIN_NERR_WORKSTATION_NOT_STARTED", "DOMAIN_JOIN_ERROR_DS_MACHINE_ACCOUNT_QUOTA_EXCEEDED", "DOMAIN_JOIN_NERR_PASSWORD_EXPIRED", "DOMAIN_JOIN_INTERNAL_SERVICE_ERROR"
resp.image_builder.image_builder_errors[0].error_message #=> String
resp.image_builder.image_builder_errors[0].error_timestamp #=> Time
resp.image_builder.appstream_agent_version #=> String
resp.image_builder.access_endpoints #=> Array
resp.image_builder.access_endpoints[0].endpoint_type #=> String, one of "STREAMING"
resp.image_builder.access_endpoints[0].vpce_id #=> String

Options Hash (options):

:name (required, String) —
The name of the image builder.
:appstream_agent_version (String) —
The version of the AppStream 2.0 agent to use for this image builder. To use the latest version of the AppStream 2.0 agent, specify [LATEST].

Returns:

(Types::StartImageBuilderResult) —
Returns a response object which responds to the following methods:
- #image_builder => Types::ImageBuilder

See Also:

AWS API Documentation

#stop_fleet(options = {}) ⇒ `Struct`

Stops the specified fleet.

Examples:

Request syntax with placeholder values


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

Options Hash (options):

:name (required, String) —
The name of the fleet.

Returns:

(Struct) —
Returns an empty response.

See Also:

AWS API Documentation

#stop_image_builder(options = {}) ⇒ `Types::StopImageBuilderResult`

Stops the specified image builder.

Examples:

Request syntax with placeholder values


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

Response structure


resp.image_builder.name #=> String
resp.image_builder.arn #=> String
resp.image_builder.image_arn #=> String
resp.image_builder.description #=> String
resp.image_builder.display_name #=> String
resp.image_builder.vpc_config.subnet_ids #=> Array
resp.image_builder.vpc_config.subnet_ids[0] #=> String
resp.image_builder.vpc_config.security_group_ids #=> Array
resp.image_builder.vpc_config.security_group_ids[0] #=> String
resp.image_builder.instance_type #=> String
resp.image_builder.platform #=> String, one of "WINDOWS", "WINDOWS_SERVER_2016", "WINDOWS_SERVER_2019"
resp.image_builder.iam_role_arn #=> String
resp.image_builder.state #=> String, one of "PENDING", "UPDATING_AGENT", "RUNNING", "STOPPING", "STOPPED", "REBOOTING", "SNAPSHOTTING", "DELETING", "FAILED"
resp.image_builder.state_change_reason.code #=> String, one of "INTERNAL_ERROR", "IMAGE_UNAVAILABLE"
resp.image_builder.state_change_reason.message #=> String
resp.image_builder.created_time #=> Time
resp.image_builder.enable_default_internet_access #=> true/false
resp.image_builder.domain_join_info.directory_name #=> String
resp.image_builder.domain_join_info.organizational_unit_distinguished_name #=> String
resp.image_builder.network_access_configuration.eni_private_ip_address #=> String
resp.image_builder.network_access_configuration.eni_id #=> String
resp.image_builder.image_builder_errors #=> Array
resp.image_builder.image_builder_errors[0].error_code #=> String, one of "IAM_SERVICE_ROLE_MISSING_ENI_DESCRIBE_ACTION", "IAM_SERVICE_ROLE_MISSING_ENI_CREATE_ACTION", "IAM_SERVICE_ROLE_MISSING_ENI_DELETE_ACTION", "NETWORK_INTERFACE_LIMIT_EXCEEDED", "INTERNAL_SERVICE_ERROR", "IAM_SERVICE_ROLE_IS_MISSING", "MACHINE_ROLE_IS_MISSING", "STS_DISABLED_IN_REGION", "SUBNET_HAS_INSUFFICIENT_IP_ADDRESSES", "IAM_SERVICE_ROLE_MISSING_DESCRIBE_SUBNET_ACTION", "SUBNET_NOT_FOUND", "IMAGE_NOT_FOUND", "INVALID_SUBNET_CONFIGURATION", "SECURITY_GROUPS_NOT_FOUND", "IGW_NOT_ATTACHED", "IAM_SERVICE_ROLE_MISSING_DESCRIBE_SECURITY_GROUPS_ACTION", "DOMAIN_JOIN_ERROR_FILE_NOT_FOUND", "DOMAIN_JOIN_ERROR_ACCESS_DENIED", "DOMAIN_JOIN_ERROR_LOGON_FAILURE", "DOMAIN_JOIN_ERROR_INVALID_PARAMETER", "DOMAIN_JOIN_ERROR_MORE_DATA", "DOMAIN_JOIN_ERROR_NO_SUCH_DOMAIN", "DOMAIN_JOIN_ERROR_NOT_SUPPORTED", "DOMAIN_JOIN_NERR_INVALID_WORKGROUP_NAME", "DOMAIN_JOIN_NERR_WORKSTATION_NOT_STARTED", "DOMAIN_JOIN_ERROR_DS_MACHINE_ACCOUNT_QUOTA_EXCEEDED", "DOMAIN_JOIN_NERR_PASSWORD_EXPIRED", "DOMAIN_JOIN_INTERNAL_SERVICE_ERROR"
resp.image_builder.image_builder_errors[0].error_message #=> String
resp.image_builder.image_builder_errors[0].error_timestamp #=> Time
resp.image_builder.appstream_agent_version #=> String
resp.image_builder.access_endpoints #=> Array
resp.image_builder.access_endpoints[0].endpoint_type #=> String, one of "STREAMING"
resp.image_builder.access_endpoints[0].vpce_id #=> String

Options Hash (options):

:name (required, String) —
The name of the image builder.

Returns:

(Types::StopImageBuilderResult) —
Returns a response object which responds to the following methods:
- #image_builder => Types::ImageBuilder

See Also:

AWS API Documentation

#tag_resource(options = {}) ⇒ `Struct`

Adds or overwrites one or more tags for the specified AppStream 2.0 resource. You can tag AppStream 2.0 image builders, images, fleets, and stacks.

Each tag consists of a key and an optional value. If a resource already has a tag with the same key, this operation updates its value.

To list the current tags for your resources, use ListTagsForResource. To disassociate tags from your resources, use UntagResource.

For more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide.

Examples:

Request syntax with placeholder values


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

Options Hash (options):

:resource_arn (required, String) —
The Amazon Resource Name (ARN) of the resource.
:tags (required, Hash<String,String>) —
The tags to associate. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=.

If you do not specify a value, the value is set to an empty string.

Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters:

_ . : / = + \ - @

Returns:

(Struct) —
Returns an empty response.

See Also:

AWS API Documentation

#untag_resource(options = {}) ⇒ `Struct`

Disassociates one or more specified tags from the specified AppStream 2.0 resource.

To list the current tags for your resources, use ListTagsForResource.

For more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide.

Examples:

Request syntax with placeholder values


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

Options Hash (options):

:resource_arn (required, String) —
The Amazon Resource Name (ARN) of the resource.
:tag_keys (required, Array<String>) —
The tag keys for the tags to disassociate.

Returns:

(Struct) —
Returns an empty response.

See Also:

AWS API Documentation

#update_directory_config(options = {}) ⇒ `Types::UpdateDirectoryConfigResult`

Updates the specified Directory Config object in AppStream 2.0. This object includes the configuration information required to join fleets and image builders to Microsoft Active Directory domains.

Examples:

Request syntax with placeholder values


resp = client.update_directory_config({
  directory_name: "DirectoryName", # required
  organizational_unit_distinguished_names: ["OrganizationalUnitDistinguishedName"],
  service_account_credentials: {
    account_name: "AccountName", # required
    account_password: "AccountPassword", # required
  },
})

Response structure


resp.directory_config.directory_name #=> String
resp.directory_config.organizational_unit_distinguished_names #=> Array
resp.directory_config.organizational_unit_distinguished_names[0] #=> String
resp.directory_config.service_account_credentials.account_name #=> String
resp.directory_config.service_account_credentials.account_password #=> String
resp.directory_config.created_time #=> Time

Options Hash (options):

:directory_name (required, String) —
The name of the Directory Config object.
:organizational_unit_distinguished_names (Array<String>) —
The distinguished names of the organizational units for computer accounts.
:service_account_credentials (Types::ServiceAccountCredentials) —
The credentials for the service account used by the fleet or image builder to connect to the directory.

Returns:

(Types::UpdateDirectoryConfigResult) —
Returns a response object which responds to the following methods:
- #directory_config => Types::DirectoryConfig

See Also:

AWS API Documentation

#update_fleet(options = {}) ⇒ `Types::UpdateFleetResult`

Updates the specified fleet.

If the fleet is in the STOPPED state, you can update any attribute except the fleet name. If the fleet is in the RUNNING state, you can update the DisplayName, ComputeCapacity, ImageARN, ImageName, IdleDisconnectTimeoutInSeconds, and DisconnectTimeoutInSeconds attributes. If the fleet is in the STARTING or STOPPING state, you can't update it.

Examples:

Request syntax with placeholder values


resp = client.update_fleet({
  image_name: "String",
  image_arn: "Arn",
  name: "String",
  instance_type: "String",
  compute_capacity: {
    desired_instances: 1, # required
  },
  vpc_config: {
    subnet_ids: ["String"],
    security_group_ids: ["String"],
  },
  max_user_duration_in_seconds: 1,
  disconnect_timeout_in_seconds: 1,
  delete_vpc_config: false,
  description: "Description",
  display_name: "DisplayName",
  enable_default_internet_access: false,
  domain_join_info: {
    directory_name: "DirectoryName",
    organizational_unit_distinguished_name: "OrganizationalUnitDistinguishedName",
  },
  idle_disconnect_timeout_in_seconds: 1,
  attributes_to_delete: ["VPC_CONFIGURATION"], # accepts VPC_CONFIGURATION, VPC_CONFIGURATION_SECURITY_GROUP_IDS, DOMAIN_JOIN_INFO, IAM_ROLE_ARN
  iam_role_arn: "Arn",
  stream_view: "APP", # accepts APP, DESKTOP
})

Response structure


resp.fleet.arn #=> String
resp.fleet.name #=> String
resp.fleet.display_name #=> String
resp.fleet.description #=> String
resp.fleet.image_name #=> String
resp.fleet.image_arn #=> String
resp.fleet.instance_type #=> String
resp.fleet.fleet_type #=> String, one of "ALWAYS_ON", "ON_DEMAND"
resp.fleet.compute_capacity_status.desired #=> Integer
resp.fleet.compute_capacity_status.running #=> Integer
resp.fleet.compute_capacity_status.in_use #=> Integer
resp.fleet.compute_capacity_status.available #=> Integer
resp.fleet.max_user_duration_in_seconds #=> Integer
resp.fleet.disconnect_timeout_in_seconds #=> Integer
resp.fleet.state #=> String, one of "STARTING", "RUNNING", "STOPPING", "STOPPED"
resp.fleet.vpc_config.subnet_ids #=> Array
resp.fleet.vpc_config.subnet_ids[0] #=> String
resp.fleet.vpc_config.security_group_ids #=> Array
resp.fleet.vpc_config.security_group_ids[0] #=> String
resp.fleet.created_time #=> Time
resp.fleet.fleet_errors #=> Array
resp.fleet.fleet_errors[0].error_code #=> String, one of "IAM_SERVICE_ROLE_MISSING_ENI_DESCRIBE_ACTION", "IAM_SERVICE_ROLE_MISSING_ENI_CREATE_ACTION", "IAM_SERVICE_ROLE_MISSING_ENI_DELETE_ACTION", "NETWORK_INTERFACE_LIMIT_EXCEEDED", "INTERNAL_SERVICE_ERROR", "IAM_SERVICE_ROLE_IS_MISSING", "MACHINE_ROLE_IS_MISSING", "STS_DISABLED_IN_REGION", "SUBNET_HAS_INSUFFICIENT_IP_ADDRESSES", "IAM_SERVICE_ROLE_MISSING_DESCRIBE_SUBNET_ACTION", "SUBNET_NOT_FOUND", "IMAGE_NOT_FOUND", "INVALID_SUBNET_CONFIGURATION", "SECURITY_GROUPS_NOT_FOUND", "IGW_NOT_ATTACHED", "IAM_SERVICE_ROLE_MISSING_DESCRIBE_SECURITY_GROUPS_ACTION", "DOMAIN_JOIN_ERROR_FILE_NOT_FOUND", "DOMAIN_JOIN_ERROR_ACCESS_DENIED", "DOMAIN_JOIN_ERROR_LOGON_FAILURE", "DOMAIN_JOIN_ERROR_INVALID_PARAMETER", "DOMAIN_JOIN_ERROR_MORE_DATA", "DOMAIN_JOIN_ERROR_NO_SUCH_DOMAIN", "DOMAIN_JOIN_ERROR_NOT_SUPPORTED", "DOMAIN_JOIN_NERR_INVALID_WORKGROUP_NAME", "DOMAIN_JOIN_NERR_WORKSTATION_NOT_STARTED", "DOMAIN_JOIN_ERROR_DS_MACHINE_ACCOUNT_QUOTA_EXCEEDED", "DOMAIN_JOIN_NERR_PASSWORD_EXPIRED", "DOMAIN_JOIN_INTERNAL_SERVICE_ERROR"
resp.fleet.fleet_errors[0].error_message #=> String
resp.fleet.enable_default_internet_access #=> true/false
resp.fleet.domain_join_info.directory_name #=> String
resp.fleet.domain_join_info.organizational_unit_distinguished_name #=> String
resp.fleet.idle_disconnect_timeout_in_seconds #=> Integer
resp.fleet.iam_role_arn #=> String
resp.fleet.stream_view #=> String, one of "APP", "DESKTOP"

Options Hash (options):

:image_name (String) —
The name of the image used to create the fleet.
:image_arn (String) —
The ARN of the public, private, or shared image to use.
:name (String) —
A unique name for the fleet.
:instance_type (String) —
The instance type to use when launching fleet instances. The following instance types are available:
- stream.standard.medium
- stream.standard.large
- stream.compute.large
- stream.compute.xlarge
- stream.compute.2xlarge
- stream.compute.4xlarge
- stream.compute.8xlarge
- stream.memory.large
- stream.memory.xlarge
- stream.memory.2xlarge
- stream.memory.4xlarge
- stream.memory.8xlarge
- stream.memory.z1d.large
- stream.memory.z1d.xlarge
- stream.memory.z1d.2xlarge
- stream.memory.z1d.3xlarge
- stream.memory.z1d.6xlarge
- stream.memory.z1d.12xlarge
- stream.graphics-design.large
- stream.graphics-design.xlarge
- stream.graphics-design.2xlarge
- stream.graphics-design.4xlarge
- stream.graphics-desktop.2xlarge
- stream.graphics.g4dn.xlarge
- stream.graphics.g4dn.2xlarge
- stream.graphics.g4dn.4xlarge
- stream.graphics.g4dn.8xlarge
- stream.graphics.g4dn.12xlarge
- stream.graphics.g4dn.16xlarge
- stream.graphics-pro.4xlarge
- stream.graphics-pro.8xlarge
- stream.graphics-pro.16xlarge
:compute_capacity (Types::ComputeCapacity) —
The desired capacity for the fleet.
:vpc_config (Types::VpcConfig) —
The VPC configuration for the fleet.
:max_user_duration_in_seconds (Integer) —
The maximum amount of time that a streaming session can remain active, in seconds. If users are still connected to a streaming instance five minutes before this limit is reached, they are prompted to save any open documents before being disconnected. After this time elapses, the instance is terminated and replaced by a new instance.

Specify a value between 600 and 360000.
:disconnect_timeout_in_seconds (Integer) —
The amount of time that a streaming session remains active after users disconnect. If users try to reconnect to the streaming session after a disconnection or network interruption within this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance.

Specify a value between 60 and 360000.
:delete_vpc_config (Boolean) —
Deletes the VPC association for the specified fleet.
:description (String) —
The description to display.
:display_name (String) —
The fleet name to display.
:enable_default_internet_access (Boolean) —
Enables or disables default internet access for the fleet.
:domain_join_info (Types::DomainJoinInfo) —
The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain.
:idle_disconnect_timeout_in_seconds (Integer) —
The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the DisconnectTimeoutInSeconds time interval begins. Users are notified before they are disconnected due to inactivity. If users try to reconnect to the streaming session before the time interval specified in DisconnectTimeoutInSeconds elapses, they are connected to their previous session. Users are considered idle when they stop providing keyboard or mouse input during their streaming session. File uploads and downloads, audio in, audio out, and pixels changing do not qualify as user activity. If users continue to be idle after the time interval in IdleDisconnectTimeoutInSeconds elapses, they are disconnected.

To prevent users from being disconnected due to inactivity, specify a value of 0. Otherwise, specify a value between 60 and 3600. The default value is 0.

If you enable this feature, we recommend that you specify a value that corresponds exactly to a whole number of minutes (for example, 60, 120, and 180). If you don\'t do this, the value is rounded to the nearest minute. For example, if you specify a value of 70, users are disconnected after 1 minute of inactivity. If you specify a value that is at the midpoint between two different minutes, the value is rounded up. For example, if you specify a value of 90, users are disconnected after 2 minutes of inactivity.
:attributes_to_delete (Array<String>) —
The fleet attributes to delete.
:iam_role_arn (String) —
The Amazon Resource Name (ARN) of the IAM role to apply to the fleet. To assume a role, a fleet instance calls the AWS Security Token Service (STS) AssumeRole API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the appstream_machine_role credential profile on the instance.

For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide.
:stream_view (String) —
The AppStream 2.0 view that is displayed to your users when they stream from the fleet. When APP is specified, only the windows of applications opened by users display. When DESKTOP is specified, the standard desktop that is provided by the operating system displays.

The default value is APP.

Returns:

(Types::UpdateFleetResult) —
Returns a response object which responds to the following methods:
- #fleet => Types::Fleet

See Also:

AWS API Documentation

#update_image_permissions(options = {}) ⇒ `Struct`

Adds or updates permissions for the specified private image.

Examples:

Request syntax with placeholder values


resp = client.update_image_permissions({
  name: "Name", # required
  shared_account_id: "AwsAccountId", # required
  image_permissions: { # required
    allow_fleet: false,
    allow_image_builder: false,
  },
})

Options Hash (options):

:name (required, String) —
The name of the private image.
:shared_account_id (required, String) —
The 12-digit identifier of the AWS account for which you want add or update image permissions.
:image_permissions (required, Types::ImagePermissions) —
The permissions for the image.

Returns:

(Struct) —
Returns an empty response.

See Also:

AWS API Documentation

#update_stack(options = {}) ⇒ `Types::UpdateStackResult`

Updates the specified fields for the specified stack.

Examples:

Request syntax with placeholder values


resp = client.update_stack({
  display_name: "DisplayName",
  description: "Description",
  name: "String", # required
  storage_connectors: [
    {
      connector_type: "HOMEFOLDERS", # required, accepts HOMEFOLDERS, GOOGLE_DRIVE, ONE_DRIVE
      resource_identifier: "ResourceIdentifier",
      domains: ["Domain"],
    },
  ],
  delete_storage_connectors: false,
  redirect_url: "RedirectURL",
  feedback_url: "FeedbackURL",
  attributes_to_delete: ["STORAGE_CONNECTORS"], # accepts STORAGE_CONNECTORS, STORAGE_CONNECTOR_HOMEFOLDERS, STORAGE_CONNECTOR_GOOGLE_DRIVE, STORAGE_CONNECTOR_ONE_DRIVE, REDIRECT_URL, FEEDBACK_URL, THEME_NAME, USER_SETTINGS, EMBED_HOST_DOMAINS, IAM_ROLE_ARN, ACCESS_ENDPOINTS
  user_settings: [
    {
      action: "CLIPBOARD_COPY_FROM_LOCAL_DEVICE", # required, accepts CLIPBOARD_COPY_FROM_LOCAL_DEVICE, CLIPBOARD_COPY_TO_LOCAL_DEVICE, FILE_UPLOAD, FILE_DOWNLOAD, PRINTING_TO_LOCAL_DEVICE
      permission: "ENABLED", # required, accepts ENABLED, DISABLED
    },
  ],
  application_settings: {
    enabled: false, # required
    settings_group: "SettingsGroup",
  },
  access_endpoints: [
    {
      endpoint_type: "STREAMING", # required, accepts STREAMING
      vpce_id: "String",
    },
  ],
  embed_host_domains: ["EmbedHostDomain"],
})

Response structure


resp.stack.arn #=> String
resp.stack.name #=> String
resp.stack.description #=> String
resp.stack.display_name #=> String
resp.stack.created_time #=> Time
resp.stack.storage_connectors #=> Array
resp.stack.storage_connectors[0].connector_type #=> String, one of "HOMEFOLDERS", "GOOGLE_DRIVE", "ONE_DRIVE"
resp.stack.storage_connectors[0].resource_identifier #=> String
resp.stack.storage_connectors[0].domains #=> Array
resp.stack.storage_connectors[0].domains[0] #=> String
resp.stack.redirect_url #=> String
resp.stack.feedback_url #=> String
resp.stack.stack_errors #=> Array
resp.stack.stack_errors[0].error_code #=> String, one of "STORAGE_CONNECTOR_ERROR", "INTERNAL_SERVICE_ERROR"
resp.stack.stack_errors[0].error_message #=> String
resp.stack.user_settings #=> Array
resp.stack.user_settings[0].action #=> String, one of "CLIPBOARD_COPY_FROM_LOCAL_DEVICE", "CLIPBOARD_COPY_TO_LOCAL_DEVICE", "FILE_UPLOAD", "FILE_DOWNLOAD", "PRINTING_TO_LOCAL_DEVICE"
resp.stack.user_settings[0].permission #=> String, one of "ENABLED", "DISABLED"
resp.stack.application_settings.enabled #=> true/false
resp.stack.application_settings.settings_group #=> String
resp.stack.application_settings.s3_bucket_name #=> String
resp.stack.access_endpoints #=> Array
resp.stack.access_endpoints[0].endpoint_type #=> String, one of "STREAMING"
resp.stack.access_endpoints[0].vpce_id #=> String
resp.stack.embed_host_domains #=> Array
resp.stack.embed_host_domains[0] #=> String

Options Hash (options):

:display_name (String) —
The stack name to display.
:description (String) —
The description to display.
:name (required, String) —
The name of the stack.
:storage_connectors (Array<Types::StorageConnector>) —
The storage connectors to enable.
:delete_storage_connectors (Boolean) —
Deletes the storage connectors currently enabled for the stack.
:redirect_url (String) —
The URL that users are redirected to after their streaming session ends.
:feedback_url (String) —
The URL that users are redirected to after they choose the Send Feedback link. If no URL is specified, no Send Feedback link is displayed.
:attributes_to_delete (Array<String>) —
The stack attributes to delete.
:user_settings (Array<Types::UserSetting>) —
The actions that are enabled or disabled for users during their streaming sessions. By default, these actions are enabled.
:application_settings (Types::ApplicationSettings) —
The persistent application settings for users of a stack. When these settings are enabled, changes that users make to applications and Windows settings are automatically saved after each session and applied to the next session.
:access_endpoints (Array<Types::AccessEndpoint>) —
The list of interface VPC endpoint (interface endpoint) objects. Users of the stack can connect to AppStream 2.0 only through the specified endpoints.
:embed_host_domains (Array<String>) —
The domains where AppStream 2.0 streaming sessions can be embedded in an iframe. You must approve the domains that you want to host embedded AppStream 2.0 streaming sessions.

Returns:

(Types::UpdateStackResult) —
Returns a response object which responds to the following methods:
- #stack => Types::Stack

See Also:

AWS API Documentation

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

Waiters polls an API operation until a resource enters a desired state.

Basic Usage

Waiters will poll until they are succesful, they fail by entering a terminal state, or until a maximum number of attempts are made.

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

Configuration

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You configure waiters by passing a block to #wait_until:

# poll for ~25 seconds
client.wait_until(...) do |w|
  w.max_attempts = 5
  w.delay = 5
end

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(...) do |w|

  # disable max attempts
  w.max_attempts = nil

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

end

Handling Errors

When a waiter is successful, it returns true. When a waiter fails, it raises an error. All errors raised extend from Waiters::Errors::WaiterFailed.

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

Parameters:

waiter_name (Symbol) —
The name of the waiter. See #waiter_names for a full list of supported waiters.
params (Hash) (defaults to: {}) —
Additional request parameters. See the #waiter_names for a list of supported waiters and what request they call. The called request determines the list of accepted parameters.

Yield Parameters:

waiter (Waiters::Waiter) —
Yields a Waiter object that can be configured prior to waiting.

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.

#waiter_names ⇒ `Array<Symbol>`

Returns the list of supported waiters. The following table lists the supported waiters and the client method they call:

Waiter Name	Client Method	Default Delay:	Default Max Attempts:
`:fleet_started`	#describe_fleets	30	40
`:fleet_stopped`	#describe_fleets	30	40

Returns:

(Array<Symbol>) —
the list of supported waiters.

Class: Aws::AppStream::Client

Overview

Region

Credentials

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

Constructor collapse

API Operations collapse

Instance Method Summary collapse

Methods inherited from Seahorse::Client::Base

Methods included from Seahorse::Client::HandlerBuilder

Constructor Details

#initialize(options = {}) ⇒ Aws::AppStream::Client

Instance Method Details

#associate_fleet(options = {}) ⇒ Struct

#batch_associate_user_stack(options = {}) ⇒ Types::BatchAssociateUserStackResult

#batch_disassociate_user_stack(options = {}) ⇒ Types::BatchDisassociateUserStackResult

#copy_image(options = {}) ⇒ Types::CopyImageResponse

#create_directory_config(options = {}) ⇒ Types::CreateDirectoryConfigResult

#create_fleet(options = {}) ⇒ Types::CreateFleetResult

#create_image_builder(options = {}) ⇒ Types::CreateImageBuilderResult

#create_image_builder_streaming_url(options = {}) ⇒ Types::CreateImageBuilderStreamingURLResult

#create_stack(options = {}) ⇒ Types::CreateStackResult

#create_streaming_url(options = {}) ⇒ Types::CreateStreamingURLResult

#create_usage_report_subscription(options = {}) ⇒ Types::CreateUsageReportSubscriptionResult

#create_user(options = {}) ⇒ Struct

#delete_directory_config(options = {}) ⇒ Struct

#delete_fleet(options = {}) ⇒ Struct

#delete_image(options = {}) ⇒ Types::DeleteImageResult

#delete_image_builder(options = {}) ⇒ Types::DeleteImageBuilderResult

#delete_image_permissions(options = {}) ⇒ Struct

#delete_stack(options = {}) ⇒ Struct

#delete_usage_report_subscription(options = {}) ⇒ Struct

#delete_user(options = {}) ⇒ Struct

#describe_directory_configs(options = {}) ⇒ Types::DescribeDirectoryConfigsResult

#describe_fleets(options = {}) ⇒ Types::DescribeFleetsResult

#describe_image_builders(options = {}) ⇒ Types::DescribeImageBuildersResult

#describe_image_permissions(options = {}) ⇒ Types::DescribeImagePermissionsResult

#describe_images(options = {}) ⇒ Types::DescribeImagesResult

#describe_sessions(options = {}) ⇒ Types::DescribeSessionsResult

#describe_stacks(options = {}) ⇒ Types::DescribeStacksResult

#describe_usage_report_subscriptions(options = {}) ⇒ Types::DescribeUsageReportSubscriptionsResult

#describe_user_stack_associations(options = {}) ⇒ Types::DescribeUserStackAssociationsResult

#describe_users(options = {}) ⇒ Types::DescribeUsersResult

#disable_user(options = {}) ⇒ Struct

#disassociate_fleet(options = {}) ⇒ Struct

#enable_user(options = {}) ⇒ Struct

#expire_session(options = {}) ⇒ Struct

#list_associated_fleets(options = {}) ⇒ Types::ListAssociatedFleetsResult

#list_associated_stacks(options = {}) ⇒ Types::ListAssociatedStacksResult

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

#start_fleet(options = {}) ⇒ Struct

#start_image_builder(options = {}) ⇒ Types::StartImageBuilderResult

#stop_fleet(options = {}) ⇒ Struct

#stop_image_builder(options = {}) ⇒ Types::StopImageBuilderResult

#tag_resource(options = {}) ⇒ Struct

#untag_resource(options = {}) ⇒ Struct

#update_directory_config(options = {}) ⇒ Types::UpdateDirectoryConfigResult

#update_fleet(options = {}) ⇒ Types::UpdateFleetResult

#update_image_permissions(options = {}) ⇒ Struct

#update_stack(options = {}) ⇒ Types::UpdateStackResult

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

Basic Usage

Configuration

Callbacks

Handling Errors

#waiter_names ⇒ Array<Symbol>

#initialize(options = {}) ⇒ `Aws::AppStream::Client`

#associate_fleet(options = {}) ⇒ `Struct`

#batch_associate_user_stack(options = {}) ⇒ `Types::BatchAssociateUserStackResult`

#batch_disassociate_user_stack(options = {}) ⇒ `Types::BatchDisassociateUserStackResult`

#copy_image(options = {}) ⇒ `Types::CopyImageResponse`

#create_directory_config(options = {}) ⇒ `Types::CreateDirectoryConfigResult`

#create_fleet(options = {}) ⇒ `Types::CreateFleetResult`

#create_image_builder(options = {}) ⇒ `Types::CreateImageBuilderResult`

#create_image_builder_streaming_url(options = {}) ⇒ `Types::CreateImageBuilderStreamingURLResult`

#create_stack(options = {}) ⇒ `Types::CreateStackResult`

#create_streaming_url(options = {}) ⇒ `Types::CreateStreamingURLResult`

#create_usage_report_subscription(options = {}) ⇒ `Types::CreateUsageReportSubscriptionResult`

#create_user(options = {}) ⇒ `Struct`

#delete_directory_config(options = {}) ⇒ `Struct`

#delete_fleet(options = {}) ⇒ `Struct`

#delete_image(options = {}) ⇒ `Types::DeleteImageResult`

#delete_image_builder(options = {}) ⇒ `Types::DeleteImageBuilderResult`

#delete_image_permissions(options = {}) ⇒ `Struct`

#delete_stack(options = {}) ⇒ `Struct`

#delete_usage_report_subscription(options = {}) ⇒ `Struct`

#delete_user(options = {}) ⇒ `Struct`

#describe_directory_configs(options = {}) ⇒ `Types::DescribeDirectoryConfigsResult`

#describe_fleets(options = {}) ⇒ `Types::DescribeFleetsResult`

#describe_image_builders(options = {}) ⇒ `Types::DescribeImageBuildersResult`

#describe_image_permissions(options = {}) ⇒ `Types::DescribeImagePermissionsResult`

#describe_images(options = {}) ⇒ `Types::DescribeImagesResult`

#describe_sessions(options = {}) ⇒ `Types::DescribeSessionsResult`

#describe_stacks(options = {}) ⇒ `Types::DescribeStacksResult`

#describe_usage_report_subscriptions(options = {}) ⇒ `Types::DescribeUsageReportSubscriptionsResult`

#describe_user_stack_associations(options = {}) ⇒ `Types::DescribeUserStackAssociationsResult`

#describe_users(options = {}) ⇒ `Types::DescribeUsersResult`

#disable_user(options = {}) ⇒ `Struct`

#disassociate_fleet(options = {}) ⇒ `Struct`

#enable_user(options = {}) ⇒ `Struct`

#expire_session(options = {}) ⇒ `Struct`

#list_associated_fleets(options = {}) ⇒ `Types::ListAssociatedFleetsResult`

#list_associated_stacks(options = {}) ⇒ `Types::ListAssociatedStacksResult`

#list_tags_for_resource(options = {}) ⇒ `Types::ListTagsForResourceResponse`

#start_fleet(options = {}) ⇒ `Struct`

#start_image_builder(options = {}) ⇒ `Types::StartImageBuilderResult`

#stop_fleet(options = {}) ⇒ `Struct`

#stop_image_builder(options = {}) ⇒ `Types::StopImageBuilderResult`

#tag_resource(options = {}) ⇒ `Struct`

#untag_resource(options = {}) ⇒ `Struct`

#update_directory_config(options = {}) ⇒ `Types::UpdateDirectoryConfigResult`

#update_fleet(options = {}) ⇒ `Types::UpdateFleetResult`

#update_image_permissions(options = {}) ⇒ `Struct`

#update_stack(options = {}) ⇒ `Types::UpdateStackResult`

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

#waiter_names ⇒ `Array<Symbol>`