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

Associate a fleet to a 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 to associate.

    • StackName — (String)

      The name of the stack to which the fleet is associated.

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.

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

Creates a new 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',
  EnableDefaultInternetAccess: true || false,
  MaxUserDurationInSeconds: 0,
  VpcConfig: {
    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 identifier for the fleet.

    • ImageName — (String)

      Unique name of the image used by the fleet.

    • InstanceType — (String)

      The instance type of compute resources for the fleet. Fleet instances are launched from this instance type.

    • ComputeCapacity — (map)

      The parameters for the capacity allocated to the fleet.

      • DesiredInstancesrequired — (Integer)

        The desired number of streaming instances.

    • VpcConfig — (map)

      The VPC configuration for the fleet.

      • SubnetIds — (Array<String>)

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

    • MaxUserDurationInSeconds — (Integer)

      The maximum time for which a streaming session can run. The input can be any numeric value in seconds between 600 and 57600.

    • DisconnectTimeoutInSeconds — (Integer)

      The time after disconnection when a session is considered to have ended. If a user who got disconnected reconnects within this timeout interval, the user is connected back to their previous session. The input can be any numeric value in seconds between 60 and 57600.

    • Description — (String)

      The description of the fleet.

    • DisplayName — (String)

      The display name of the fleet.

    • EnableDefaultInternetAccess — (Boolean)

      Enables or disables default Internet access for 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. The data object has the following properties:

      • Fleet — (map)

        The details for the created fleet.

        • Arnrequired — (String)

          The ARN for the fleet.

        • Namerequired — (String)

          The name of the fleet.

        • DisplayName — (String)

          The name displayed to end users on the AppStream 2.0 portal.

        • Description — (String)

          The description displayed to end users on the AppStream 2.0 portal.

        • ImageNamerequired — (String)

          The image used by the fleet.

        • InstanceTyperequired — (String)

          The instance type of compute resources for the fleet. The fleet instances are launched from this instance type.

        • ComputeCapacityStatusrequired — (map)

          The capacity information 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 that are being used for streaming.

          • Available — (Integer)

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

        • MaxUserDurationInSeconds — (Integer)

          The maximum time for which a streaming session can run. The value can be any numeric value in seconds between 600 and 57600.

        • DisconnectTimeoutInSeconds — (Integer)

          The time after disconnection when a session is considered to have ended. If a user who got disconnected reconnects within this timeout interval, the user is connected back to their previous session. The input can be any numeric value in seconds 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 list of subnets to which a network interface is established from the fleet instance.

        • CreatedTime — (Date)

          The time at which the fleet was created.

        • FleetErrors — (Array<map>)

          The list of fleet errors is appended to this list.

          • ErrorCode — (String)

            The error code for the fleet error.

            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"
          • ErrorMessage — (String)

            The error message generated when the fleet has errors.

        • EnableDefaultInternetAccess — (Boolean)

          Whether default Internet access is enabled for the fleet.

Returns:

  • (AWS.Request)

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

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

Create a new 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 unique identifier for this stack.

    • Description — (String)

      The description displayed to end users on the AppStream 2.0 portal.

    • DisplayName — (String)

      The name displayed to end users on the AppStream 2.0 portal.

    • StorageConnectors — (Array<map>)

      The storage connectors to be enabled for the stack.

      • ConnectorTyperequired — (String)

        The type of storage connector. The possible values include: HOMEFOLDERS.

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

        The ARN associated with 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)

        The details for the created stack.

        • Arn — (String)

          The ARN of the stack.

        • Namerequired — (String)

          The unique identifier of the stack.

        • Description — (String)

          A meaningful description for the stack.

        • DisplayName — (String)

          A display name for the stack.

        • CreatedTime — (Date)

          The timestamp when the stack was created.

        • StorageConnectors — (Array<map>)

          The storage connectors to be enabled for the stack.

          • ConnectorTyperequired — (String)

            The type of storage connector. The possible values include: HOMEFOLDERS.

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

            The ARN associated with the storage connector.

        • StackErrors — (Array<map>)

          The list of errors associated with the stack.

          • ErrorCode — (String)

            The error code of a stack error.

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

            The error message of a stack error.

Returns:

  • (AWS.Request)

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

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

Creates a URL to start an AppStream 2.0 streaming session for a user. By default, the URL is valid only for 1 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 stack for which the URL is generated.

    • FleetName — (String)

      The fleet for which the URL is generated.

    • UserId — (String)

      A unique user ID for whom the URL is generated.

    • ApplicationId — (String)

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

    • Validity — (Integer)

      The duration up to which the URL returned by this action is valid. The input can be any numeric value in seconds between 1 and 604800 seconds.

    • SessionContext — (String)

      The sessionContext 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)

        Elapsed seconds after the Unix epoch, at which time this URL expires.

Returns:

  • (AWS.Request)

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

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

Deletes a 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 to be deleted.

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.

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

Deletes the 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 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.

Returns:

  • (AWS.Request)

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

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

If fleet names are provided, this operation describes the specified fleets; otherwise, all the fleets in the account are described.

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 fleet names to describe. Use null to describe all the fleets for the AWS account.

    • 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>)

        The list of fleet details.

        • Arnrequired — (String)

          The ARN for the fleet.

        • Namerequired — (String)

          The name of the fleet.

        • DisplayName — (String)

          The name displayed to end users on the AppStream 2.0 portal.

        • Description — (String)

          The description displayed to end users on the AppStream 2.0 portal.

        • ImageNamerequired — (String)

          The image used by the fleet.

        • InstanceTyperequired — (String)

          The instance type of compute resources for the fleet. The fleet instances are launched from this instance type.

        • ComputeCapacityStatusrequired — (map)

          The capacity information 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 that are being used for streaming.

          • Available — (Integer)

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

        • MaxUserDurationInSeconds — (Integer)

          The maximum time for which a streaming session can run. The value can be any numeric value in seconds between 600 and 57600.

        • DisconnectTimeoutInSeconds — (Integer)

          The time after disconnection when a session is considered to have ended. If a user who got disconnected reconnects within this timeout interval, the user is connected back to their previous session. The input can be any numeric value in seconds 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 list of subnets to which a network interface is established from the fleet instance.

        • CreatedTime — (Date)

          The time at which the fleet was created.

        • FleetErrors — (Array<map>)

          The list of fleet errors is appended to this list.

          • ErrorCode — (String)

            The error code for the fleet error.

            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"
          • ErrorMessage — (String)

            The error message generated when the fleet has errors.

        • EnableDefaultInternetAccess — (Boolean)

          Whether default Internet access is enabled for the fleet.

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

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

Describes the images. If a list of names is not provided, all images in your account are returned. This operation does not return a paginated result.

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>)

      A specific list of 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>)

        The list of images.

        • Namerequired — (String)

          The unique identifier for the image.

        • Arn — (String)

          The ARN for the image.

        • BaseImageArn — (String)

          The source image ARN from which this image was created.

        • DisplayName — (String)

          The display name for the image.

        • State — (String)

          The image starts in the PENDING state, and then moves to AVAILABLE if image creation succeeds and FAILED if image creation has failed.

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

          The visibility of an image to the user; images can be public or private.

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

          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)

          A meaningful description for the image.

        • StateChangeReason — (map)

          The reason why the last state change occurred.

          • Code — (String)

            The state change reason code of the image.

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

            The state change reason message to the end user.

        • Applications — (Array<map>)

          The applications associated with an image.

          • Name — (String)

            The unique identifier for the application.

          • DisplayName — (String)

            The name of the application shown to the end users.

          • IconURL — (String)

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

          • LaunchPath — (String)

            The path to the application executable in the instance.

          • LaunchParameters — (String)

            A list of arguments that are passed to the application at launch.

          • Enabled — (Boolean)

            An application can be disabled after image creation if there is a problem.

          • Metadata — (map<String>)

            Additional attributes that describe the application.

        • CreatedTime — (Date)

          The timestamp when the image was created.

        • PublicBaseImageReleasedDate — (Date)

          The AWS 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 a stack and a fleet. If a user ID is provided, this operation returns streaming sessions for only that user. Pass this value for the nextToken parameter in a subsequent call to this operation to retrieve the next set of items. If an authentication type is not provided, the operation defaults to users authenticated using a streaming URL.

Service Reference:

Examples:

Calling the describeSessions operation

var params = {
  FleetName: 'STRING_VALUE', /* required */
  StackName: 'STRING_VALUE', /* required */
  AuthenticationType: API | SAML,
  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 for which to list sessions.

    • FleetName — (String)

      The name of the fleet for which to list sessions.

    • UserId — (String)

      The user for whom to list sessions. Use null to describe all the sessions for the stack and 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.

    • Limit — (Integer)

      The size of each page of results. The default value is 20 and the maximum supported value is 50.

    • AuthenticationType — (String)

      The authentication method of the user. It can be API for a user authenticated using a streaming URL, or SAML for a SAML federated user. If an authentication type is not provided, the operation defaults to users authenticated using a streaming URL.

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

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>)

        The list of streaming sessions.

        • Idrequired — (String)

          The unique ID for a streaming session.

        • UserIdrequired — (String)

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

        • StackNamerequired — (String)

          The name of the stack for which the streaming session was created.

        • FleetNamerequired — (String)

          The name of the fleet for which the streaming session was created.

        • Staterequired — (String)

          The current state of the streaming session.

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

          The authentication method of the user for whom the session was created. It can be API for a user authenticated using a streaming URL or SAML for a SAML federated user.

          Possible values include:
          • "API"
          • "SAML"
      • 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

If stack names are not provided, this operation describes the specified stacks; otherwise, all stacks in the account are described. Pass the nextToken value in a subsequent call to this operation to retrieve the next set of items.

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 stack names to describe. Use null to describe all the stacks for the AWS account.

    • 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>)

        The list of stack details.

        • Arn — (String)

          The ARN of the stack.

        • Namerequired — (String)

          The unique identifier of the stack.

        • Description — (String)

          A meaningful description for the stack.

        • DisplayName — (String)

          A display name for the stack.

        • CreatedTime — (Date)

          The timestamp when the stack was created.

        • StorageConnectors — (Array<map>)

          The storage connectors to be enabled for the stack.

          • ConnectorTyperequired — (String)

            The type of storage connector. The possible values include: HOMEFOLDERS.

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

            The ARN associated with the storage connector.

        • StackErrors — (Array<map>)

          The list of errors associated with the stack.

          • ErrorCode — (String)

            The error code of a stack error.

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

            The error message of a stack error.

      • 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 a fleet from a 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 to disassociate.

    • StackName — (String)

      The name of the stack with which the fleet is associated.

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

This operation immediately stops a 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 unique identifier of the streaming session to be stopped.

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 all fleets associated with the 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 whose associated fleets are listed.

    • 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 associated 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 all stacks to which the specified fleet is associated.

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 whose associated stacks are listed.

    • 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 associated 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 a 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 to start.

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.

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

Stops a 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 to stop.

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.

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

Updates an existing fleet. All the attributes except the fleet name can be updated in the STOPPED state. When a fleet is in the RUNNING state, only DisplayName and ComputeCapacity can be updated. A fleet cannot be updated in a status of STARTING or STOPPING.

Service Reference:

Examples:

Calling the updateFleet operation

var params = {
  Name: 'STRING_VALUE', /* required */
  ComputeCapacity: {
    DesiredInstances: 0 /* required */
  },
  DeleteVpcConfig: true || false,
  Description: 'STRING_VALUE',
  DisconnectTimeoutInSeconds: 0,
  DisplayName: 'STRING_VALUE',
  EnableDefaultInternetAccess: true || false,
  ImageName: 'STRING_VALUE',
  InstanceType: 'STRING_VALUE',
  MaxUserDurationInSeconds: 0,
  VpcConfig: {
    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 image name from which a fleet is created.

    • Name — (String)

      The name of the fleet.

    • InstanceType — (String)

      The instance type of compute resources for the fleet. Fleet instances are launched from this instance type.

    • ComputeCapacity — (map)

      The parameters for the capacity allocated to the fleet.

      • DesiredInstancesrequired — (Integer)

        The desired number of streaming instances.

    • VpcConfig — (map)

      The VPC configuration for the fleet.

      • SubnetIds — (Array<String>)

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

    • MaxUserDurationInSeconds — (Integer)

      The maximum time for which a streaming session can run. The input can be any numeric value in seconds between 600 and 57600.

    • DisconnectTimeoutInSeconds — (Integer)

      The time after disconnection when a session is considered to have ended. If a user who got disconnected reconnects within this timeout interval, the user is connected back to their previous session. The input can be any numeric value in seconds between 60 and 57600.

    • DeleteVpcConfig — (Boolean)

      Delete the VPC association for the specified fleet.

    • Description — (String)

      The description displayed to end users on the AppStream 2.0 portal.

    • DisplayName — (String)

      The name displayed to end users on the AppStream 2.0 portal.

    • EnableDefaultInternetAccess — (Boolean)

      Enables or disables default Internet access for 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. The data object has the following properties:

      • Fleet — (map)

        A list of fleet details.

        • Arnrequired — (String)

          The ARN for the fleet.

        • Namerequired — (String)

          The name of the fleet.

        • DisplayName — (String)

          The name displayed to end users on the AppStream 2.0 portal.

        • Description — (String)

          The description displayed to end users on the AppStream 2.0 portal.

        • ImageNamerequired — (String)

          The image used by the fleet.

        • InstanceTyperequired — (String)

          The instance type of compute resources for the fleet. The fleet instances are launched from this instance type.

        • ComputeCapacityStatusrequired — (map)

          The capacity information 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 that are being used for streaming.

          • Available — (Integer)

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

        • MaxUserDurationInSeconds — (Integer)

          The maximum time for which a streaming session can run. The value can be any numeric value in seconds between 600 and 57600.

        • DisconnectTimeoutInSeconds — (Integer)

          The time after disconnection when a session is considered to have ended. If a user who got disconnected reconnects within this timeout interval, the user is connected back to their previous session. The input can be any numeric value in seconds 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 list of subnets to which a network interface is established from the fleet instance.

        • CreatedTime — (Date)

          The time at which the fleet was created.

        • FleetErrors — (Array<map>)

          The list of fleet errors is appended to this list.

          • ErrorCode — (String)

            The error code for the fleet error.

            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"
          • ErrorMessage — (String)

            The error message generated when the fleet has errors.

        • EnableDefaultInternetAccess — (Boolean)

          Whether default Internet access is enabled for the fleet.

Returns:

  • (AWS.Request)

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

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

Updates the specified fields in the stack with the specified name.

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 name displayed to end users on the AppStream 2.0 portal.

    • Description — (String)

      The description displayed to end users on the AppStream 2.0 portal.

    • Name — (String)

      The name of the stack to update.

    • StorageConnectors — (Array<map>)

      The storage connectors to be enabled for the stack.

      • ConnectorTyperequired — (String)

        The type of storage connector. The possible values include: HOMEFOLDERS.

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

        The ARN associated with the storage connector.

    • DeleteStorageConnectors — (Boolean)

      Remove all 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)

        A list of stack details.

        • Arn — (String)

          The ARN of the stack.

        • Namerequired — (String)

          The unique identifier of the stack.

        • Description — (String)

          A meaningful description for the stack.

        • DisplayName — (String)

          A display name for the stack.

        • CreatedTime — (Date)

          The timestamp when the stack was created.

        • StorageConnectors — (Array<map>)

          The storage connectors to be enabled for the stack.

          • ConnectorTyperequired — (String)

            The type of storage connector. The possible values include: HOMEFOLDERS.

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

            The ARN associated with the storage connector.

        • StackErrors — (Array<map>)

          The list of errors associated with the stack.

          • ErrorCode — (String)

            The error code of a stack error.

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

            The error message of a stack error.

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 fleet names to describe. Use null to describe all the fleets for the AWS account.

    • 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>)

        The list of fleet details.

        • Arnrequired — (String)

          The ARN for the fleet.

        • Namerequired — (String)

          The name of the fleet.

        • DisplayName — (String)

          The name displayed to end users on the AppStream 2.0 portal.

        • Description — (String)

          The description displayed to end users on the AppStream 2.0 portal.

        • ImageNamerequired — (String)

          The image used by the fleet.

        • InstanceTyperequired — (String)

          The instance type of compute resources for the fleet. The fleet instances are launched from this instance type.

        • ComputeCapacityStatusrequired — (map)

          The capacity information 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 that are being used for streaming.

          • Available — (Integer)

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

        • MaxUserDurationInSeconds — (Integer)

          The maximum time for which a streaming session can run. The value can be any numeric value in seconds between 600 and 57600.

        • DisconnectTimeoutInSeconds — (Integer)

          The time after disconnection when a session is considered to have ended. If a user who got disconnected reconnects within this timeout interval, the user is connected back to their previous session. The input can be any numeric value in seconds 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 list of subnets to which a network interface is established from the fleet instance.

        • CreatedTime — (Date)

          The time at which the fleet was created.

        • FleetErrors — (Array<map>)

          The list of fleet errors is appended to this list.

          • ErrorCode — (String)

            The error code for the fleet error.

            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"
          • ErrorMessage — (String)

            The error message generated when the fleet has errors.

        • EnableDefaultInternetAccess — (Boolean)

          Whether default Internet access is enabled for the fleet.

      • 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 fleet names to describe. Use null to describe all the fleets for the AWS account.

    • 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>)

        The list of fleet details.

        • Arnrequired — (String)

          The ARN for the fleet.

        • Namerequired — (String)

          The name of the fleet.

        • DisplayName — (String)

          The name displayed to end users on the AppStream 2.0 portal.

        • Description — (String)

          The description displayed to end users on the AppStream 2.0 portal.

        • ImageNamerequired — (String)

          The image used by the fleet.

        • InstanceTyperequired — (String)

          The instance type of compute resources for the fleet. The fleet instances are launched from this instance type.

        • ComputeCapacityStatusrequired — (map)

          The capacity information 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 that are being used for streaming.

          • Available — (Integer)

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

        • MaxUserDurationInSeconds — (Integer)

          The maximum time for which a streaming session can run. The value can be any numeric value in seconds between 600 and 57600.

        • DisconnectTimeoutInSeconds — (Integer)

          The time after disconnection when a session is considered to have ended. If a user who got disconnected reconnects within this timeout interval, the user is connected back to their previous session. The input can be any numeric value in seconds 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 list of subnets to which a network interface is established from the fleet instance.

        • CreatedTime — (Date)

          The time at which the fleet was created.

        • FleetErrors — (Array<map>)

          The list of fleet errors is appended to this list.

          • ErrorCode — (String)

            The error code for the fleet error.

            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"
          • ErrorMessage — (String)

            The error message generated when the fleet has errors.

        • EnableDefaultInternetAccess — (Boolean)

          Whether default Internet access is enabled for the fleet.

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