Class: AWS.AppStream

Inherits:
AWS.Service show all
Identifier:
appstream
API Version:
2016-12-01
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Sending a Request Using AppStream

var appstream = new AWS.AppStream();
appstream.associateFleet(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the AppStream object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var appstream = new AWS.AppStream({apiVersion: '2016-12-01'});

You can also set the API version globally in AWS.config.apiVersions using the appstream service identifier:

AWS.config.apiVersions = {
  appstream: '2016-12-01',
  // other service API versions
};

var appstream = new AWS.AppStream();

Version:

  • 2016-12-01

Waiter Resource States

This service supports a list of resource states that can be polled using the waitFor() method. The resource states are:

fleetStarted, fleetStopped

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, setupRequestListeners, defineService

Constructor Details

new AWS.AppStream(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a AppStream object

var appstream = new AWS.AppStream({apiVersion: '2016-12-01'});

Options Hash (options):

  • params (map)

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String)

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com'.

  • accessKeyId (String)

    your AWS access key ID.

  • secretAccessKey (String)

    your AWS secret access key.

  • sessionToken (AWS.Credentials)

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials)

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain)

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String)

    the region to send service requests to. See AWS.AppStream.region for more information.

  • maxRetries (Integer)

    the maximum amount of retries to attempt with a request. See AWS.AppStream.maxRetries for more information.

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.AppStream.maxRedirects for more information.

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean)

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean)

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean)

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean)

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • retryDelayOptions (map)

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and returns the amount of time to delay in milliseconds. The base option will be ignored if this option is supplied.
  • httpOptions (map)

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date)

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>)

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log)

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number)

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String)

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean)

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean)

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

Property Details

endpointAWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint)

    an Endpoint object representing the endpoint URL for service requests.

Method Details

associateFleet(params = {}, callback) ⇒ AWS.Request

Associates the specified fleet with the specified stack.

Service Reference:

Examples:

Calling the associateFleet operation

var params = {
  FleetName: 'STRING_VALUE', /* required */
  StackName: 'STRING_VALUE' /* required */
};
appstream.associateFleet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FleetName — (String)

      The name of the fleet.

    • StackName — (String)

      The name of the stack.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createDirectoryConfig(params = {}, callback) ⇒ AWS.Request

Creates a directory configuration.

Service Reference:

Examples:

Calling the createDirectoryConfig operation

var params = {
  DirectoryName: 'STRING_VALUE', /* required */
  OrganizationalUnitDistinguishedNames: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  ServiceAccountCredentials: { /* required */
    AccountName: 'STRING_VALUE', /* required */
    AccountPassword: 'STRING_VALUE' /* required */
  }
};
appstream.createDirectoryConfig(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • DirectoryName — (String)

      The fully qualified name of the directory (for example, corp.example.com).

    • OrganizationalUnitDistinguishedNames — (Array<String>)

      The distinguished names of the organizational units for computer accounts.

    • ServiceAccountCredentials — (map)

      The credentials for the service account used by the streaming instance to connect to the directory.

      • AccountNamerequired — (String)

        The user name of the account. This account must have the following privileges: create computer objects, join computers to the domain, and change/reset the password on descendant computer objects for the organizational units specified.

      • AccountPasswordrequired — (String)

        The password for the account.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DirectoryConfig — (map)

        Information about the directory configuration.

        • DirectoryNamerequired — (String)

          The fully qualified name of the directory (for example, corp.example.com).

        • OrganizationalUnitDistinguishedNames — (Array<String>)

          The distinguished names of the organizational units for computer accounts.

        • ServiceAccountCredentials — (map)

          The credentials for the service account used by the streaming instance to connect to the directory.

          • AccountNamerequired — (String)

            The user name of the account. This account must have the following privileges: create computer objects, join computers to the domain, and change/reset the password on descendant computer objects for the organizational units specified.

          • AccountPasswordrequired — (String)

            The password for the account.

        • CreatedTime — (Date)

          The time the directory configuration was created.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createFleet(params = {}, callback) ⇒ AWS.Request

Creates a fleet.

Service Reference:

Examples:

Calling the createFleet operation

var params = {
  ComputeCapacity: { /* required */
    DesiredInstances: 0 /* required */
  },
  ImageName: 'STRING_VALUE', /* required */
  InstanceType: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE',
  DisconnectTimeoutInSeconds: 0,
  DisplayName: 'STRING_VALUE',
  DomainJoinInfo: {
    DirectoryName: 'STRING_VALUE',
    OrganizationalUnitDistinguishedName: 'STRING_VALUE'
  },
  EnableDefaultInternetAccess: true || false,
  FleetType: ALWAYS_ON | ON_DEMAND,
  MaxUserDurationInSeconds: 0,
  VpcConfig: {
    SecurityGroupIds: [
      'STRING_VALUE',
      /* more items */
    ],
    SubnetIds: [
      'STRING_VALUE',
      /* more items */
    ]
  }
};
appstream.createFleet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Name — (String)

      A unique name for the fleet.

    • ImageName — (String)

      The name of the image used by the fleet.

    • InstanceType — (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.graphics-design.large

      • stream.graphics-design.xlarge

      • stream.graphics-design.2xlarge

      • stream.graphics-design.4xlarge

      • stream.graphics-desktop.2xlarge

      • stream.graphics-pro.4xlarge

      • stream.graphics-pro.8xlarge

      • stream.graphics-pro.16xlarge

    • FleetType — (String) Possible values include:
      • "ALWAYS_ON"
      • "ON_DEMAND"
    • ComputeCapacity — (map)

      The desired capacity for the fleet.

      • DesiredInstancesrequired — (Integer)

        The desired number of streaming instances.

    • VpcConfig — (map)

      The VPC configuration for the fleet.

      • SubnetIds — (Array<String>)

        The subnets to which a network interface is established from the fleet instance.

      • SecurityGroupIds — (Array<String>)

        The security groups for the fleet.

    • MaxUserDurationInSeconds — (Integer)

      The maximum time that a streaming session can run, in seconds. Specify a value between 600 and 57600.

    • DisconnectTimeoutInSeconds — (Integer)

      The time after disconnection when a session is considered to have ended, in seconds. If a user who was disconnected reconnects within this time interval, the user is connected to their previous session. Specify a value between 60 and 57600.

    • Description — (String)

      The description displayed to end users.

    • DisplayName — (String)

      The fleet name displayed to end users.

    • EnableDefaultInternetAccess — (Boolean)

      Enables or disables default internet access for the fleet.

    • DomainJoinInfo — (map)

      The information needed for streaming instances to join a domain.

      • DirectoryName — (String)

        The fully qualified name of the directory (for example, corp.example.com).

      • OrganizationalUnitDistinguishedName — (String)

        The distinguished name of the organizational unit for computer accounts.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Fleet — (map)

        Information about the fleet.

        • Arnrequired — (String)

          The ARN for the fleet.

        • Namerequired — (String)

          The name of the fleet.

        • DisplayName — (String)

          The fleet name displayed to end users.

        • Description — (String)

          The description displayed to end users.

        • ImageNamerequired — (String)

          The image used by the fleet.

        • InstanceTyperequired — (String)

          The instance type to use when launching fleet instances.

        • FleetType — (String) Possible values include:
          • "ALWAYS_ON"
          • "ON_DEMAND"
        • ComputeCapacityStatusrequired — (map)

          The capacity status for the fleet.

          • Desiredrequired — (Integer)

            The desired number of streaming instances.

          • Running — (Integer)

            The total number of simultaneous streaming instances that are running.

          • InUse — (Integer)

            The number of instances in use for streaming.

          • Available — (Integer)

            The number of currently available instances that can be used to stream sessions.

        • MaxUserDurationInSeconds — (Integer)

          The maximum time that a streaming session can run, in seconds. Specify a value between 600 and 57600.

        • DisconnectTimeoutInSeconds — (Integer)

          The time after disconnection when a session is considered to have ended, in seconds. If a user who was disconnected reconnects within this time interval, the user is connected to their previous session. Specify a value between 60 and 57600.

        • Staterequired — (String)

          The current state for the fleet.

          Possible values include:
          • "STARTING"
          • "RUNNING"
          • "STOPPING"
          • "STOPPED"
        • VpcConfig — (map)

          The VPC configuration for the fleet.

          • SubnetIds — (Array<String>)

            The subnets to which a network interface is established from the fleet instance.

          • SecurityGroupIds — (Array<String>)

            The security groups for the fleet.

        • CreatedTime — (Date)

          The time the fleet was created.

        • FleetErrors — (Array<map>)

          The fleet errors.

          • ErrorCode — (String)

            The error code.

            Possible values include:
            • "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"
            • "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"
          • ErrorMessage — (String)

            The error message.

        • EnableDefaultInternetAccess — (Boolean)

          Indicates whether default internet access is enabled for the fleet.

        • DomainJoinInfo — (map)

          The information needed for streaming instances to join a domain.

          • DirectoryName — (String)

            The fully qualified name of the directory (for example, corp.example.com).

          • OrganizationalUnitDistinguishedName — (String)

            The distinguished name of the organizational unit for computer accounts.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createImageBuilder(params = {}, callback) ⇒ AWS.Request

Calls the CreateImageBuilder API operation.

Service Reference:

Examples:

Calling the createImageBuilder operation

var params = {
  ImageName: 'STRING_VALUE', /* required */
  InstanceType: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE',
  DisplayName: 'STRING_VALUE',
  DomainJoinInfo: {
    DirectoryName: 'STRING_VALUE',
    OrganizationalUnitDistinguishedName: 'STRING_VALUE'
  },
  EnableDefaultInternetAccess: true || false,
  VpcConfig: {
    SecurityGroupIds: [
      'STRING_VALUE',
      /* more items */
    ],
    SubnetIds: [
      'STRING_VALUE',
      /* more items */
    ]
  }
};
appstream.createImageBuilder(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Name — (String)
    • ImageName — (String)
    • InstanceType — (String)
    • Description — (String)
    • DisplayName — (String)
    • VpcConfig — (map)

      Describes VPC configuration information.

      • SubnetIds — (Array<String>)

        The subnets to which a network interface is established from the fleet instance.

      • SecurityGroupIds — (Array<String>)

        The security groups for the fleet.

    • EnableDefaultInternetAccess — (Boolean)
    • DomainJoinInfo — (map)

      Contains the information needed for streaming instances to join a domain.

      • DirectoryName — (String)

        The fully qualified name of the directory (for example, corp.example.com).

      • OrganizationalUnitDistinguishedName — (String)

        The distinguished name of the organizational unit for computer accounts.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ImageBuilder — (map)
        • Namerequired — (String)
        • Arn — (String)
        • ImageArn — (String)
        • Description — (String)
        • DisplayName — (String)
        • VpcConfig — (map)

          Describes VPC configuration information.

          • SubnetIds — (Array<String>)

            The subnets to which a network interface is established from the fleet instance.

          • SecurityGroupIds — (Array<String>)

            The security groups for the fleet.

        • InstanceType — (String)
        • Platform — (String) Possible values include:
          • "WINDOWS"
        • State — (String) Possible values include:
          • "PENDING"
          • "RUNNING"
          • "STOPPING"
          • "STOPPED"
          • "REBOOTING"
          • "SNAPSHOTTING"
          • "DELETING"
          • "FAILED"
        • StateChangeReason — (map)
          • Code — (String) Possible values include:
            • "INTERNAL_ERROR"
            • "IMAGE_UNAVAILABLE"
          • Message — (String)
        • CreatedTime — (Date)
        • EnableDefaultInternetAccess — (Boolean)
        • DomainJoinInfo — (map)

          Contains the information needed for streaming instances to join a domain.

          • DirectoryName — (String)

            The fully qualified name of the directory (for example, corp.example.com).

          • OrganizationalUnitDistinguishedName — (String)

            The distinguished name of the organizational unit for computer accounts.

        • ImageBuilderErrors — (Array<map>)
          • ErrorCode — (String) Possible values include:
            • "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"
            • "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"
          • ErrorMessage — (String)
          • ErrorTimestamp — (Date)

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createImageBuilderStreamingURL(params = {}, callback) ⇒ AWS.Request

Calls the CreateImageBuilderStreamingURL API operation.

Service Reference:

Examples:

Calling the createImageBuilderStreamingURL operation

var params = {
  Name: 'STRING_VALUE', /* required */
  Validity: 0
};
appstream.createImageBuilderStreamingURL(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Name — (String)
    • Validity — (Integer)

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • StreamingURL — (String)
      • Expires — (Date)

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createStack(params = {}, callback) ⇒ AWS.Request

Creates a stack.

Service Reference:

Examples:

Calling the createStack operation

var params = {
  Name: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE',
  DisplayName: 'STRING_VALUE',
  StorageConnectors: [
    {
      ConnectorType: HOMEFOLDERS, /* required */
      ResourceIdentifier: 'STRING_VALUE'
    },
    /* more items */
  ]
};
appstream.createStack(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Name — (String)

      The name of the stack.

    • Description — (String)

      The description displayed to end users.

    • DisplayName — (String)

      The stack name displayed to end users.

    • StorageConnectors — (Array<map>)

      The storage connectors to enable.

      • ConnectorTyperequired — (String)

        The type of storage connector.

        Possible values include:
        • "HOMEFOLDERS"
      • ResourceIdentifier — (String)

        The ARN of the storage connector.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Stack — (map)

        Information about the stack.

        • Arn — (String)

          The ARN of the stack.

        • Namerequired — (String)

          The name of the stack.

        • Description — (String)

          The description displayed to end users.

        • DisplayName — (String)

          The stack name displayed to end users.

        • CreatedTime — (Date)

          The time the stack was created.

        • StorageConnectors — (Array<map>)

          The storage connectors to enable.

          • ConnectorTyperequired — (String)

            The type of storage connector.

            Possible values include:
            • "HOMEFOLDERS"
          • ResourceIdentifier — (String)

            The ARN of the storage connector.

        • StackErrors — (Array<map>)

          The errors for the stack.

          • ErrorCode — (String)

            The error code.

            Possible values include:
            • "STORAGE_CONNECTOR_ERROR"
            • "INTERNAL_SERVICE_ERROR"
          • ErrorMessage — (String)

            The error message.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createStreamingURL(params = {}, callback) ⇒ AWS.Request

Creates a URL to start a streaming session for the specified user.

By default, the URL is valid only for one minute from the time that it is generated.

Service Reference:

Examples:

Calling the createStreamingURL operation

var params = {
  FleetName: 'STRING_VALUE', /* required */
  StackName: 'STRING_VALUE', /* required */
  UserId: 'STRING_VALUE', /* required */
  ApplicationId: 'STRING_VALUE',
  SessionContext: 'STRING_VALUE',
  Validity: 0
};
appstream.createStreamingURL(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • StackName — (String)

      The name of the stack.

    • FleetName — (String)

      The name of the fleet.

    • UserId — (String)

      The ID of the user.

    • ApplicationId — (String)

      The ID of the application that must be launched after the session starts.

    • Validity — (Integer)

      The time that the streaming URL will be valid, in seconds. Specify a value between 1 and 604800 seconds.

    • SessionContext — (String)

      The session context of the streaming URL.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • StreamingURL — (String)

        The URL to start the AppStream 2.0 streaming session.

      • Expires — (Date)

        The elapsed time, in seconds after the Unix epoch, when this URL expires.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteDirectoryConfig(params = {}, callback) ⇒ AWS.Request

Deletes the specified directory configuration.

Service Reference:

Examples:

Calling the deleteDirectoryConfig operation

var params = {
  DirectoryName: 'STRING_VALUE' /* required */
};
appstream.deleteDirectoryConfig(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • DirectoryName — (String)

      The name of the directory configuration.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteFleet(params = {}, callback) ⇒ AWS.Request

Deletes the specified fleet.

Service Reference:

Examples:

Calling the deleteFleet operation

var params = {
  Name: 'STRING_VALUE' /* required */
};
appstream.deleteFleet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Name — (String)

      The name of the fleet.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteImage(params = {}, callback) ⇒ AWS.Request

Calls the DeleteImage API operation.

Service Reference:

Examples:

Calling the deleteImage operation

var params = {
  Name: 'STRING_VALUE' /* required */
};
appstream.deleteImage(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Name — (String)

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Image — (map)

        Describes an image.

        • Namerequired — (String)

          The name of the image.

        • Arn — (String)

          The ARN of the image.

        • BaseImageArn — (String)

          The ARN of the image from which this image was created.

        • DisplayName — (String)

          The image name displayed to end users.

        • State — (String)

          The image starts in the PENDING state. If image creation succeeds, the state is AVAILABLE. If image creation fails, the state is FAILED.

          Possible values include:
          • "PENDING"
          • "AVAILABLE"
          • "FAILED"
          • "DELETING"
        • Visibility — (String)

          Indicates whether the image is public or private.

          Possible values include:
          • "PUBLIC"
          • "PRIVATE"
        • ImageBuilderSupported — (Boolean)

          Indicates whether an image builder can be launched from this image.

        • Platform — (String)

          The operating system platform of the image.

          Possible values include:
          • "WINDOWS"
        • Description — (String)

          The description displayed to end users.

        • StateChangeReason — (map)

          The reason why the last state change occurred.

          • Code — (String)

            The state change reason code.

            Possible values include:
            • "INTERNAL_ERROR"
            • "IMAGE_BUILDER_NOT_AVAILABLE"
          • Message — (String)

            The state change reason message.

        • Applications — (Array<map>)

          The applications associated with the image.

          • Name — (String)

            The name of the application.

          • DisplayName — (String)

            The application name displayed to end users.

          • IconURL — (String)

            The URL for the application icon. This URL might be time-limited.

          • LaunchPath — (String)

            The path to the application executable in the instance.

          • LaunchParameters — (String)

            The arguments that are passed to the application at launch.

          • Enabled — (Boolean)

            If there is a problem, the application can be disabled after image creation.

          • Metadata — (map<String>)

            Additional attributes that describe the application.

        • CreatedTime — (Date)

          The time the image was created.

        • PublicBaseImageReleasedDate — (Date)

          The release date of the public base image. For private images, this date is the release date of the base image from which the image was created.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteImageBuilder(params = {}, callback) ⇒ AWS.Request

Calls the DeleteImageBuilder API operation.

Service Reference:

Examples:

Calling the deleteImageBuilder operation

var params = {
  Name: 'STRING_VALUE' /* required */
};
appstream.deleteImageBuilder(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Name — (String)

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ImageBuilder — (map)
        • Namerequired — (String)
        • Arn — (String)
        • ImageArn — (String)
        • Description — (String)
        • DisplayName — (String)
        • VpcConfig — (map)

          Describes VPC configuration information.

          • SubnetIds — (Array<String>)

            The subnets to which a network interface is established from the fleet instance.

          • SecurityGroupIds — (Array<String>)

            The security groups for the fleet.

        • InstanceType — (String)
        • Platform — (String) Possible values include:
          • "WINDOWS"
        • State — (String) Possible values include:
          • "PENDING"
          • "RUNNING"
          • "STOPPING"
          • "STOPPED"
          • "REBOOTING"
          • "SNAPSHOTTING"
          • "DELETING"
          • "FAILED"
        • StateChangeReason — (map)
          • Code — (String) Possible values include:
            • "INTERNAL_ERROR"
            • "IMAGE_UNAVAILABLE"
          • Message — (String)
        • CreatedTime — (Date)
        • EnableDefaultInternetAccess — (Boolean)
        • DomainJoinInfo — (map)

          Contains the information needed for streaming instances to join a domain.

          • DirectoryName — (String)

            The fully qualified name of the directory (for example, corp.example.com).

          • OrganizationalUnitDistinguishedName — (String)

            The distinguished name of the organizational unit for computer accounts.

        • ImageBuilderErrors — (Array<map>)
          • ErrorCode — (String) Possible values include:
            • "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"
            • "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"
          • ErrorMessage — (String)
          • ErrorTimestamp — (Date)

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteStack(params = {}, callback) ⇒ AWS.Request

Deletes the specified stack. After this operation completes, the environment can no longer be activated and any reservations made for the stack are released.

Service Reference:

Examples:

Calling the deleteStack operation

var params = {
  Name: 'STRING_VALUE' /* required */
};
appstream.deleteStack(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Name — (String)

      The name of the stack.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeDirectoryConfigs(params = {}, callback) ⇒ AWS.Request

Describes the specified directory configurations.

Service Reference:

Examples:

Calling the describeDirectoryConfigs operation

var params = {
  DirectoryNames: [
    'STRING_VALUE',
    /* more items */
  ],
  MaxResults: 0,
  NextToken: 'STRING_VALUE'
};
appstream.describeDirectoryConfigs(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • DirectoryNames — (Array<String>)

      The directory names.

    • MaxResults — (Integer)

      The maximum size of each page of results.

    • NextToken — (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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DirectoryConfigs — (Array<map>)

        Information about the directory configurations.

        • DirectoryNamerequired — (String)

          The fully qualified name of the directory (for example, corp.example.com).

        • OrganizationalUnitDistinguishedNames — (Array<String>)

          The distinguished names of the organizational units for computer accounts.

        • ServiceAccountCredentials — (map)

          The credentials for the service account used by the streaming instance to connect to the directory.

          • AccountNamerequired — (String)

            The user name of the account. This account must have the following privileges: create computer objects, join computers to the domain, and change/reset the password on descendant computer objects for the organizational units specified.

          • AccountPasswordrequired — (String)

            The password for the account.

        • CreatedTime — (Date)

          The time the directory configuration was created.

      • NextToken — (String)

        The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeFleets(params = {}, callback) ⇒ AWS.Request

Describes the specified fleets or all fleets in the account.

Service Reference:

Examples:

Calling the describeFleets operation

var params = {
  Names: [
    'STRING_VALUE',
    /* more items */
  ],
  NextToken: 'STRING_VALUE'
};
appstream.describeFleets(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Names — (Array<String>)

      The names of the fleets to describe.

    • NextToken — (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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Fleets — (Array<map>)

        Information about the fleets.

        • Arnrequired — (String)

          The ARN for the fleet.

        • Namerequired — (String)

          The name of the fleet.

        • DisplayName — (String)

          The fleet name displayed to end users.

        • Description — (String)

          The description displayed to end users.

        • ImageNamerequired — (String)

          The image used by the fleet.

        • InstanceTyperequired — (String)

          The instance type to use when launching fleet instances.

        • FleetType — (String) Possible values include:
          • "ALWAYS_ON"
          • "ON_DEMAND"
        • ComputeCapacityStatusrequired — (map)

          The capacity status for the fleet.

          • Desiredrequired — (Integer)

            The desired number of streaming instances.

          • Running — (Integer)

            The total number of simultaneous streaming instances that are running.

          • InUse — (Integer)

            The number of instances in use for streaming.

          • Available — (Integer)

            The number of currently available instances that can be used to stream sessions.

        • MaxUserDurationInSeconds — (Integer)

          The maximum time that a streaming session can run, in seconds. Specify a value between 600 and 57600.

        • DisconnectTimeoutInSeconds — (Integer)

          The time after disconnection when a session is considered to have ended, in seconds. If a user who was disconnected reconnects within this time interval, the user is connected to their previous session. Specify a value between 60 and 57600.

        • Staterequired — (String)

          The current state for the fleet.

          Possible values include:
          • "STARTING"
          • "RUNNING"
          • "STOPPING"
          • "STOPPED"
        • VpcConfig — (map)

          The VPC configuration for the fleet.

          • SubnetIds — (Array<String>)

            The subnets to which a network interface is established from the fleet instance.

          • SecurityGroupIds — (Array<String>)

            The security groups for the fleet.

        • CreatedTime — (Date)

          The time the fleet was created.

        • FleetErrors — (Array<map>)

          The fleet errors.

          • ErrorCode — (String)

            The error code.

            Possible values include:
            • "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"
            • "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"
          • ErrorMessage — (String)

            The error message.

        • EnableDefaultInternetAccess — (Boolean)

          Indicates whether default internet access is enabled for the fleet.

        • DomainJoinInfo — (map)

          The information needed for streaming instances to join a domain.

          • DirectoryName — (String)

            The fully qualified name of the directory (for example, corp.example.com).

          • OrganizationalUnitDistinguishedName — (String)

            The distinguished name of the organizational unit for computer accounts.

      • NextToken — (String)

        The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

Waiter Resource States:

describeImageBuilders(params = {}, callback) ⇒ AWS.Request

Calls the DescribeImageBuilders API operation.

Service Reference:

Examples:

Calling the describeImageBuilders operation

var params = {
  MaxResults: 0,
  Names: [
    'STRING_VALUE',
    /* more items */
  ],
  NextToken: 'STRING_VALUE'
};
appstream.describeImageBuilders(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Names — (Array<String>)
    • MaxResults — (Integer)
    • NextToken — (String)

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ImageBuilders — (Array<map>)
        • Namerequired — (String)
        • Arn — (String)
        • ImageArn — (String)
        • Description — (String)
        • DisplayName — (String)
        • VpcConfig — (map)

          Describes VPC configuration information.

          • SubnetIds — (Array<String>)

            The subnets to which a network interface is established from the fleet instance.

          • SecurityGroupIds — (Array<String>)

            The security groups for the fleet.

        • InstanceType — (String)
        • Platform — (String) Possible values include:
          • "WINDOWS"
        • State — (String) Possible values include:
          • "PENDING"
          • "RUNNING"
          • "STOPPING"
          • "STOPPED"
          • "REBOOTING"
          • "SNAPSHOTTING"
          • "DELETING"
          • "FAILED"
        • StateChangeReason — (map)
          • Code — (String) Possible values include:
            • "INTERNAL_ERROR"
            • "IMAGE_UNAVAILABLE"
          • Message — (String)
        • CreatedTime — (Date)
        • EnableDefaultInternetAccess — (Boolean)
        • DomainJoinInfo — (map)

          Contains the information needed for streaming instances to join a domain.

          • DirectoryName — (String)

            The fully qualified name of the directory (for example, corp.example.com).

          • OrganizationalUnitDistinguishedName — (String)

            The distinguished name of the organizational unit for computer accounts.

        • ImageBuilderErrors — (Array<map>)
          • ErrorCode — (String) Possible values include:
            • "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"
            • "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"
          • ErrorMessage — (String)
          • ErrorTimestamp — (Date)
      • NextToken — (String)

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeImages(params = {}, callback) ⇒ AWS.Request

Describes the specified images or all images in the account.

Service Reference:

Examples:

Calling the describeImages operation

var params = {
  Names: [
    'STRING_VALUE',
    /* more items */
  ]
};
appstream.describeImages(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Names — (Array<String>)

      The names of the images to describe.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Images — (Array<map>)

        Information about the images.

        • Namerequired — (String)

          The name of the image.

        • Arn — (String)

          The ARN of the image.

        • BaseImageArn — (String)

          The ARN of the image from which this image was created.

        • DisplayName — (String)

          The image name displayed to end users.

        • State — (String)

          The image starts in the PENDING state. If image creation succeeds, the state is AVAILABLE. If image creation fails, the state is FAILED.

          Possible values include:
          • "PENDING"
          • "AVAILABLE"
          • "FAILED"
          • "DELETING"
        • Visibility — (String)

          Indicates whether the image is public or private.

          Possible values include:
          • "PUBLIC"
          • "PRIVATE"
        • ImageBuilderSupported — (Boolean)

          Indicates whether an image builder can be launched from this image.

        • Platform — (String)

          The operating system platform of the image.

          Possible values include:
          • "WINDOWS"
        • Description — (String)

          The description displayed to end users.

        • StateChangeReason — (map)

          The reason why the last state change occurred.

          • Code — (String)

            The state change reason code.

            Possible values include:
            • "INTERNAL_ERROR"
            • "IMAGE_BUILDER_NOT_AVAILABLE"
          • Message — (String)

            The state change reason message.

        • Applications — (Array<map>)

          The applications associated with the image.

          • Name — (String)

            The name of the application.

          • DisplayName — (String)

            The application name displayed to end users.

          • IconURL — (String)

            The URL for the application icon. This URL might be time-limited.

          • LaunchPath — (String)

            The path to the application executable in the instance.

          • LaunchParameters — (String)

            The arguments that are passed to the application at launch.

          • Enabled — (Boolean)

            If there is a problem, the application can be disabled after image creation.

          • Metadata — (map<String>)

            Additional attributes that describe the application.

        • CreatedTime — (Date)

          The time the image was created.

        • PublicBaseImageReleasedDate — (Date)

          The release date of the public base image. For private images, this date is the release date of the base image from which the image was created.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeSessions(params = {}, callback) ⇒ AWS.Request

Describes the streaming sessions for the specified stack and fleet. If a user ID is provided, only the streaming sessions for only that user are returned. If an authentication type is not provided, the default is to authenticate users using a streaming URL.

Service Reference:

Examples:

Calling the describeSessions operation

var params = {
  FleetName: 'STRING_VALUE', /* required */
  StackName: 'STRING_VALUE', /* required */
  AuthenticationType: API | SAML | USERPOOL,
  Limit: 0,
  NextToken: 'STRING_VALUE',
  UserId: 'STRING_VALUE'
};
appstream.describeSessions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • StackName — (String)

      The name of the stack.

    • FleetName — (String)

      The name of the fleet.

    • UserId — (String)

      The user ID.

    • NextToken — (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.

    • AuthenticationType — (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.

      Possible values include:
      • "API"
      • "SAML"
      • "USERPOOL"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Sessions — (Array<map>)

        Information about the streaming sessions.

        • Idrequired — (String)

          The ID of the streaming session.

        • UserIdrequired — (String)

          The identifier of the user for whom the session was created.

        • StackNamerequired — (String)

          The name of the stack for the streaming session.

        • FleetNamerequired — (String)

          The name of the fleet for the streaming session.

        • Staterequired — (String)

          The current state of the streaming session.

          Possible values include:
          • "ACTIVE"
          • "PENDING"
          • "EXPIRED"
        • AuthenticationType — (String)

          The authentication method. The user is authenticated using a streaming URL (API) or SAML federation (SAML).

          Possible values include:
          • "API"
          • "SAML"
          • "USERPOOL"
      • NextToken — (String)

        The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeStacks(params = {}, callback) ⇒ AWS.Request

Describes the specified stacks or all stacks in the account.

Service Reference:

Examples:

Calling the describeStacks operation

var params = {
  Names: [
    'STRING_VALUE',
    /* more items */
  ],
  NextToken: 'STRING_VALUE'
};
appstream.describeStacks(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Names — (Array<String>)

      The names of the stacks to describe.

    • NextToken — (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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Stacks — (Array<map>)

        Information about the stacks.

        • Arn — (String)

          The ARN of the stack.

        • Namerequired — (String)

          The name of the stack.

        • Description — (String)

          The description displayed to end users.

        • DisplayName — (String)

          The stack name displayed to end users.

        • CreatedTime — (Date)

          The time the stack was created.

        • StorageConnectors — (Array<map>)

          The storage connectors to enable.

          • ConnectorTyperequired — (String)

            The type of storage connector.

            Possible values include:
            • "HOMEFOLDERS"
          • ResourceIdentifier — (String)

            The ARN of the storage connector.

        • StackErrors — (Array<map>)

          The errors for the stack.

          • ErrorCode — (String)

            The error code.

            Possible values include:
            • "STORAGE_CONNECTOR_ERROR"
            • "INTERNAL_SERVICE_ERROR"
          • ErrorMessage — (String)

            The error message.

      • NextToken — (String)

        The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

disassociateFleet(params = {}, callback) ⇒ AWS.Request

Disassociates the specified fleet from the specified stack.

Service Reference:

Examples:

Calling the disassociateFleet operation

var params = {
  FleetName: 'STRING_VALUE', /* required */
  StackName: 'STRING_VALUE' /* required */
};
appstream.disassociateFleet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FleetName — (String)

      The name of the fleet.

    • StackName — (String)

      The name of the stack.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

expireSession(params = {}, callback) ⇒ AWS.Request

Stops the specified streaming session.

Service Reference:

Examples:

Calling the expireSession operation

var params = {
  SessionId: 'STRING_VALUE' /* required */
};
appstream.expireSession(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • SessionId — (String)

      The ID of the streaming session.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listAssociatedFleets(params = {}, callback) ⇒ AWS.Request

Lists the fleets associated with the specified stack.

Service Reference:

Examples:

Calling the listAssociatedFleets operation

var params = {
  StackName: 'STRING_VALUE', /* required */
  NextToken: 'STRING_VALUE'
};
appstream.listAssociatedFleets(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • StackName — (String)

      The name of the stack.

    • NextToken — (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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Names — (Array<String>)

        The names of the fleets.

      • NextToken — (String)

        The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listAssociatedStacks(params = {}, callback) ⇒ AWS.Request

Lists the stacks associated with the specified fleet.

Service Reference:

Examples:

Calling the listAssociatedStacks operation

var params = {
  FleetName: 'STRING_VALUE', /* required */
  NextToken: 'STRING_VALUE'
};
appstream.listAssociatedStacks(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FleetName — (String)

      The name of the fleet.

    • NextToken — (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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Names — (Array<String>)

        The names of the stacks.

      • NextToken — (String)

        The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

startFleet(params = {}, callback) ⇒ AWS.Request

Starts the specified fleet.

Service Reference:

Examples:

Calling the startFleet operation

var params = {
  Name: 'STRING_VALUE' /* required */
};
appstream.startFleet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Name — (String)

      The name of the fleet.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

startImageBuilder(params = {}, callback) ⇒ AWS.Request

Calls the StartImageBuilder API operation.

Service Reference:

Examples:

Calling the startImageBuilder operation

var params = {
  Name: 'STRING_VALUE' /* required */
};
appstream.startImageBuilder(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Name — (String)

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ImageBuilder — (map)
        • Namerequired — (String)
        • Arn — (String)
        • ImageArn — (String)
        • Description — (String)
        • DisplayName — (String)
        • VpcConfig — (map)

          Describes VPC configuration information.

          • SubnetIds — (Array<String>)

            The subnets to which a network interface is established from the fleet instance.

          • SecurityGroupIds — (Array<String>)

            The security groups for the fleet.

        • InstanceType — (String)
        • Platform — (String) Possible values include:
          • "WINDOWS"
        • State — (String) Possible values include:
          • "PENDING"
          • "RUNNING"
          • "STOPPING"
          • "STOPPED"
          • "REBOOTING"
          • "SNAPSHOTTING"
          • "DELETING"
          • "FAILED"
        • StateChangeReason — (map)
          • Code — (String) Possible values include:
            • "INTERNAL_ERROR"
            • "IMAGE_UNAVAILABLE"
          • Message — (String)
        • CreatedTime — (Date)
        • EnableDefaultInternetAccess — (Boolean)
        • DomainJoinInfo — (map)

          Contains the information needed for streaming instances to join a domain.

          • DirectoryName — (String)

            The fully qualified name of the directory (for example, corp.example.com).

          • OrganizationalUnitDistinguishedName — (String)

            The distinguished name of the organizational unit for computer accounts.

        • ImageBuilderErrors — (Array<map>)
          • ErrorCode — (String) Possible values include:
            • "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"
            • "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"
          • ErrorMessage — (String)
          • ErrorTimestamp — (Date)

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

stopFleet(params = {}, callback) ⇒ AWS.Request

Stops the specified fleet.

Service Reference:

Examples:

Calling the stopFleet operation

var params = {
  Name: 'STRING_VALUE' /* required */
};
appstream.stopFleet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Name — (String)

      The name of the fleet.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

stopImageBuilder(params = {}, callback) ⇒ AWS.Request

Calls the StopImageBuilder API operation.

Service Reference:

Examples:

Calling the stopImageBuilder operation

var params = {
  Name: 'STRING_VALUE' /* required */
};
appstream.stopImageBuilder(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Name — (String)

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ImageBuilder — (map)
        • Namerequired — (String)
        • Arn — (String)
        • ImageArn — (String)
        • Description — (String)
        • DisplayName — (String)
        • VpcConfig — (map)

          Describes VPC configuration information.

          • SubnetIds — (Array<String>)

            The subnets to which a network interface is established from the fleet instance.

          • SecurityGroupIds — (Array<String>)

            The security groups for the fleet.

        • InstanceType — (String)
        • Platform — (String) Possible values include:
          • "WINDOWS"
        • State — (String) Possible values include:
          • "PENDING"
          • "RUNNING"
          • "STOPPING"
          • "STOPPED"
          • "REBOOTING"
          • "SNAPSHOTTING"
          • "DELETING"
          • "FAILED"
        • StateChangeReason — (map)
          • Code — (String) Possible values include:
            • "INTERNAL_ERROR"
            • "IMAGE_UNAVAILABLE"
          • Message — (String)
        • CreatedTime — (Date)
        • EnableDefaultInternetAccess — (Boolean)
        • DomainJoinInfo — (map)

          Contains the information needed for streaming instances to join a domain.

          • DirectoryName — (String)

            The fully qualified name of the directory (for example, corp.example.com).

          • OrganizationalUnitDistinguishedName — (String)

            The distinguished name of the organizational unit for computer accounts.

        • ImageBuilderErrors — (Array<map>)
          • ErrorCode — (String) Possible values include:
            • "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"
            • "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"
          • ErrorMessage — (String)
          • ErrorTimestamp — (Date)

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateDirectoryConfig(params = {}, callback) ⇒ AWS.Request

Updates the specified directory configuration.

Service Reference:

Examples:

Calling the updateDirectoryConfig operation

var params = {
  DirectoryName: 'STRING_VALUE', /* required */
  OrganizationalUnitDistinguishedNames: [
    'STRING_VALUE',
    /* more items */
  ],
  ServiceAccountCredentials: {
    AccountName: 'STRING_VALUE', /* required */
    AccountPassword: 'STRING_VALUE' /* required */
  }
};
appstream.updateDirectoryConfig(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • DirectoryName — (String)

      The name of the directory configuration.

    • OrganizationalUnitDistinguishedNames — (Array<String>)

      The distinguished names of the organizational units for computer accounts.

    • ServiceAccountCredentials — (map)

      The credentials for the service account used by the streaming instance to connect to the directory.

      • AccountNamerequired — (String)

        The user name of the account. This account must have the following privileges: create computer objects, join computers to the domain, and change/reset the password on descendant computer objects for the organizational units specified.

      • AccountPasswordrequired — (String)

        The password for the account.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DirectoryConfig — (map)

        Information about the directory configuration.

        • DirectoryNamerequired — (String)

          The fully qualified name of the directory (for example, corp.example.com).

        • OrganizationalUnitDistinguishedNames — (Array<String>)

          The distinguished names of the organizational units for computer accounts.

        • ServiceAccountCredentials — (map)

          The credentials for the service account used by the streaming instance to connect to the directory.

          • AccountNamerequired — (String)

            The user name of the account. This account must have the following privileges: create computer objects, join computers to the domain, and change/reset the password on descendant computer objects for the organizational units specified.

          • AccountPasswordrequired — (String)

            The password for the account.

        • CreatedTime — (Date)

          The time the directory configuration was created.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateFleet(params = {}, callback) ⇒ AWS.Request

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 and ComputeCapacity attributes. If the fleet is in the STARTING or STOPPING state, you can't update it.

Service Reference:

Examples:

Calling the updateFleet operation

var params = {
  Name: 'STRING_VALUE', /* required */
  AttributesToDelete: [
    VPC_CONFIGURATION | VPC_CONFIGURATION_SECURITY_GROUP_IDS | DOMAIN_JOIN_INFO,
    /* more items */
  ],
  ComputeCapacity: {
    DesiredInstances: 0 /* required */
  },
  DeleteVpcConfig: true || false,
  Description: 'STRING_VALUE',
  DisconnectTimeoutInSeconds: 0,
  DisplayName: 'STRING_VALUE',
  DomainJoinInfo: {
    DirectoryName: 'STRING_VALUE',
    OrganizationalUnitDistinguishedName: 'STRING_VALUE'
  },
  EnableDefaultInternetAccess: true || false,
  ImageName: 'STRING_VALUE',
  InstanceType: 'STRING_VALUE',
  MaxUserDurationInSeconds: 0,
  VpcConfig: {
    SecurityGroupIds: [
      'STRING_VALUE',
      /* more items */
    ],
    SubnetIds: [
      'STRING_VALUE',
      /* more items */
    ]
  }
};
appstream.updateFleet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ImageName — (String)

      The name of the image used by the fleet.

    • Name — (String)

      A unique name for the fleet.

    • InstanceType — (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.graphics-design.large

      • stream.graphics-design.xlarge

      • stream.graphics-design.2xlarge

      • stream.graphics-design.4xlarge

      • stream.graphics-desktop.2xlarge

      • stream.graphics-pro.4xlarge

      • stream.graphics-pro.8xlarge

      • stream.graphics-pro.16xlarge

    • ComputeCapacity — (map)

      The desired capacity for the fleet.

      • DesiredInstancesrequired — (Integer)

        The desired number of streaming instances.

    • VpcConfig — (map)

      The VPC configuration for the fleet.

      • SubnetIds — (Array<String>)

        The subnets to which a network interface is established from the fleet instance.

      • SecurityGroupIds — (Array<String>)

        The security groups for the fleet.

    • MaxUserDurationInSeconds — (Integer)

      The maximum time that a streaming session can run, in seconds. Specify a value between 600 and 57600.

    • DisconnectTimeoutInSeconds — (Integer)

      The time after disconnection when a session is considered to have ended, in seconds. If a user who was disconnected reconnects within this time interval, the user is connected to their previous session. Specify a value between 60 and 57600.

    • DeleteVpcConfig — (Boolean)

      Deletes the VPC association for the specified fleet.

    • Description — (String)

      The description displayed to end users.

    • DisplayName — (String)

      The fleet name displayed to end users.

    • EnableDefaultInternetAccess — (Boolean)

      Enables or disables default internet access for the fleet.

    • DomainJoinInfo — (map)

      The information needed for streaming instances to join a domain.

      • DirectoryName — (String)

        The fully qualified name of the directory (for example, corp.example.com).

      • OrganizationalUnitDistinguishedName — (String)

        The distinguished name of the organizational unit for computer accounts.

    • AttributesToDelete — (Array<String>)

      The fleet attributes to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Fleet — (map)

        Information about the fleet.

        • Arnrequired — (String)

          The ARN for the fleet.

        • Namerequired — (String)

          The name of the fleet.

        • DisplayName — (String)

          The fleet name displayed to end users.

        • Description — (String)

          The description displayed to end users.

        • ImageNamerequired — (String)

          The image used by the fleet.

        • InstanceTyperequired — (String)

          The instance type to use when launching fleet instances.

        • FleetType — (String) Possible values include:
          • "ALWAYS_ON"
          • "ON_DEMAND"
        • ComputeCapacityStatusrequired — (map)

          The capacity status for the fleet.

          • Desiredrequired — (Integer)

            The desired number of streaming instances.

          • Running — (Integer)

            The total number of simultaneous streaming instances that are running.

          • InUse — (Integer)

            The number of instances in use for streaming.

          • Available — (Integer)

            The number of currently available instances that can be used to stream sessions.

        • MaxUserDurationInSeconds — (Integer)

          The maximum time that a streaming session can run, in seconds. Specify a value between 600 and 57600.

        • DisconnectTimeoutInSeconds — (Integer)

          The time after disconnection when a session is considered to have ended, in seconds. If a user who was disconnected reconnects within this time interval, the user is connected to their previous session. Specify a value between 60 and 57600.

        • Staterequired — (String)

          The current state for the fleet.

          Possible values include:
          • "STARTING"
          • "RUNNING"
          • "STOPPING"
          • "STOPPED"
        • VpcConfig — (map)

          The VPC configuration for the fleet.

          • SubnetIds — (Array<String>)

            The subnets to which a network interface is established from the fleet instance.

          • SecurityGroupIds — (Array<String>)

            The security groups for the fleet.

        • CreatedTime — (Date)

          The time the fleet was created.

        • FleetErrors — (Array<map>)

          The fleet errors.

          • ErrorCode — (String)

            The error code.

            Possible values include:
            • "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"
            • "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"
          • ErrorMessage — (String)

            The error message.

        • EnableDefaultInternetAccess — (Boolean)

          Indicates whether default internet access is enabled for the fleet.

        • DomainJoinInfo — (map)

          The information needed for streaming instances to join a domain.

          • DirectoryName — (String)

            The fully qualified name of the directory (for example, corp.example.com).

          • OrganizationalUnitDistinguishedName — (String)

            The distinguished name of the organizational unit for computer accounts.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateStack(params = {}, callback) ⇒ AWS.Request

Updates the specified stack.

Service Reference:

Examples:

Calling the updateStack operation

var params = {
  Name: 'STRING_VALUE', /* required */
  DeleteStorageConnectors: true || false,
  Description: 'STRING_VALUE',
  DisplayName: 'STRING_VALUE',
  StorageConnectors: [
    {
      ConnectorType: HOMEFOLDERS, /* required */
      ResourceIdentifier: 'STRING_VALUE'
    },
    /* more items */
  ]
};
appstream.updateStack(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • DisplayName — (String)

      The stack name displayed to end users.

    • Description — (String)

      The description displayed to end users.

    • Name — (String)

      The name of the stack.

    • StorageConnectors — (Array<map>)

      The storage connectors to enable.

      • ConnectorTyperequired — (String)

        The type of storage connector.

        Possible values include:
        • "HOMEFOLDERS"
      • ResourceIdentifier — (String)

        The ARN of the storage connector.

    • DeleteStorageConnectors — (Boolean)

      Deletes the storage connectors currently enabled for the stack.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Stack — (map)

        Information about the stack.

        • Arn — (String)

          The ARN of the stack.

        • Namerequired — (String)

          The name of the stack.

        • Description — (String)

          The description displayed to end users.

        • DisplayName — (String)

          The stack name displayed to end users.

        • CreatedTime — (Date)

          The time the stack was created.

        • StorageConnectors — (Array<map>)

          The storage connectors to enable.

          • ConnectorTyperequired — (String)

            The type of storage connector.

            Possible values include:
            • "HOMEFOLDERS"
          • ResourceIdentifier — (String)

            The ARN of the storage connector.

        • StackErrors — (Array<map>)

          The errors for the stack.

          • ErrorCode — (String)

            The error code.

            Possible values include:
            • "STORAGE_CONNECTOR_ERROR"
            • "INTERNAL_SERVICE_ERROR"
          • ErrorMessage — (String)

            The error message.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

waitFor(state, params = {}, callback) ⇒ AWS.Request

Waits for a given AppStream resource. The final callback or 'complete' event will be fired only when the resource is either in its final state or the waiter has timed out and stopped polling for the final state.

Examples:

Waiting for the fleetStarted state

var params = {
  // ... input parameters ...
};
appstream.waitFor('fleetStarted', params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • state (String)

    the resource state to wait for. Available states for this service are listed in "Waiter Resource States" below.

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

    a list of parameters for the given state. See each waiter resource state for required parameters.

Callback (callback):

  • function(err, data) { ... }

    Callback containing error and data information. See the respective resource state for the expected error or data information.

    If the waiter times out its requests, it will return a ResourceNotReady error.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

Waiter Resource States:

Waiter Resource Details

appstream.waitFor('fleetStarted', params = {}, [callback]) ⇒ AWS.Request

Waits for the fleetStarted state by periodically calling the underlying AppStream.describeFleets() operation every 30 seconds (at most 40 times).

Examples:

Waiting for the fleetStarted state

var params = {
  // ... input parameters ...
};
appstream.waitFor('fleetStarted', params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object)
    • Names — (Array<String>)

      The names of the fleets to describe.

    • NextToken — (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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Fleets — (Array<map>)

        Information about the fleets.

        • Arnrequired — (String)

          The ARN for the fleet.

        • Namerequired — (String)

          The name of the fleet.

        • DisplayName — (String)

          The fleet name displayed to end users.

        • Description — (String)

          The description displayed to end users.

        • ImageNamerequired — (String)

          The image used by the fleet.

        • InstanceTyperequired — (String)

          The instance type to use when launching fleet instances.

        • FleetType — (String) Possible values include:
          • "ALWAYS_ON"
          • "ON_DEMAND"
        • ComputeCapacityStatusrequired — (map)

          The capacity status for the fleet.

          • Desiredrequired — (Integer)

            The desired number of streaming instances.

          • Running — (Integer)

            The total number of simultaneous streaming instances that are running.

          • InUse — (Integer)

            The number of instances in use for streaming.

          • Available — (Integer)

            The number of currently available instances that can be used to stream sessions.

        • MaxUserDurationInSeconds — (Integer)

          The maximum time that a streaming session can run, in seconds. Specify a value between 600 and 57600.

        • DisconnectTimeoutInSeconds — (Integer)

          The time after disconnection when a session is considered to have ended, in seconds. If a user who was disconnected reconnects within this time interval, the user is connected to their previous session. Specify a value between 60 and 57600.

        • Staterequired — (String)

          The current state for the fleet.

          Possible values include:
          • "STARTING"
          • "RUNNING"
          • "STOPPING"
          • "STOPPED"
        • VpcConfig — (map)

          The VPC configuration for the fleet.

          • SubnetIds — (Array<String>)

            The subnets to which a network interface is established from the fleet instance.

          • SecurityGroupIds — (Array<String>)

            The security groups for the fleet.

        • CreatedTime — (Date)

          The time the fleet was created.

        • FleetErrors — (Array<map>)

          The fleet errors.

          • ErrorCode — (String)

            The error code.

            Possible values include:
            • "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"
            • "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"
          • ErrorMessage — (String)

            The error message.

        • EnableDefaultInternetAccess — (Boolean)

          Indicates whether default internet access is enabled for the fleet.

        • DomainJoinInfo — (map)

          The information needed for streaming instances to join a domain.

          • DirectoryName — (String)

            The fully qualified name of the directory (for example, corp.example.com).

          • OrganizationalUnitDistinguishedName — (String)

            The distinguished name of the organizational unit for computer accounts.

      • NextToken — (String)

        The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

See Also:

appstream.waitFor('fleetStopped', params = {}, [callback]) ⇒ AWS.Request

Waits for the fleetStopped state by periodically calling the underlying AppStream.describeFleets() operation every 30 seconds (at most 40 times).

Examples:

Waiting for the fleetStopped state

var params = {
  // ... input parameters ...
};
appstream.waitFor('fleetStopped', params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object)
    • Names — (Array<String>)

      The names of the fleets to describe.

    • NextToken — (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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Fleets — (Array<map>)

        Information about the fleets.

        • Arnrequired — (String)

          The ARN for the fleet.

        • Namerequired — (String)

          The name of the fleet.

        • DisplayName — (String)

          The fleet name displayed to end users.

        • Description — (String)

          The description displayed to end users.

        • ImageNamerequired — (String)

          The image used by the fleet.

        • InstanceTyperequired — (String)

          The instance type to use when launching fleet instances.

        • FleetType — (String) Possible values include:
          • "ALWAYS_ON"
          • "ON_DEMAND"
        • ComputeCapacityStatusrequired — (map)

          The capacity status for the fleet.

          • Desiredrequired — (Integer)

            The desired number of streaming instances.

          • Running — (Integer)

            The total number of simultaneous streaming instances that are running.

          • InUse — (Integer)

            The number of instances in use for streaming.

          • Available — (Integer)

            The number of currently available instances that can be used to stream sessions.

        • MaxUserDurationInSeconds — (Integer)

          The maximum time that a streaming session can run, in seconds. Specify a value between 600 and 57600.

        • DisconnectTimeoutInSeconds — (Integer)

          The time after disconnection when a session is considered to have ended, in seconds. If a user who was disconnected reconnects within this time interval, the user is connected to their previous session. Specify a value between 60 and 57600.

        • Staterequired — (String)

          The current state for the fleet.

          Possible values include:
          • "STARTING"
          • "RUNNING"
          • "STOPPING"
          • "STOPPED"
        • VpcConfig — (map)

          The VPC configuration for the fleet.

          • SubnetIds — (Array<String>)

            The subnets to which a network interface is established from the fleet instance.

          • SecurityGroupIds — (Array<String>)

            The security groups for the fleet.

        • CreatedTime — (Date)

          The time the fleet was created.

        • FleetErrors — (Array<map>)

          The fleet errors.

          • ErrorCode — (String)

            The error code.

            Possible values include:
            • "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"
            • "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"
          • ErrorMessage — (String)

            The error message.

        • EnableDefaultInternetAccess — (Boolean)

          Indicates whether default internet access is enabled for the fleet.

        • DomainJoinInfo — (map)

          The information needed for streaming instances to join a domain.

          • DirectoryName — (String)

            The fully qualified name of the directory (for example, corp.example.com).

          • OrganizationalUnitDistinguishedName — (String)

            The distinguished name of the organizational unit for computer accounts.

      • NextToken — (String)

        The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

See Also: