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.

Service Description

This is the Amazon AppStream 2.0 API Reference. This reference provides descriptions and syntax for each of the actions and data types in AppStream 2.0. AppStream 2.0 is a fully managed application streaming service. You centrally manage your desktop applications on AppStream 2.0 and securely deliver them to any computer. AppStream 2.0 manages the AWS resources required to host and run your applications, scales automatically, and provides access to your users on demand.

To learn more about AppStream 2.0, see the following resources:

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

Property Summary

Properties inherited from AWS.Service

apiVersions

Method Summary

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.

  • useAccelerateEndpoint (Boolean) —

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean) —

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean) —

    whether to enable endpoint discovery for operations that allow optionally using an endpoint returned by the service. Defaults to 'false'

  • endpointCacheSize (Number) —

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean) —

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

Property Details

endpoint ⇒ AWS.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.

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

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

Service Reference:

Examples:

Calling the batchAssociateUserStack operation

var params = {
  UserStackAssociations: [ /* required */
    {
      AuthenticationType: API | SAML | USERPOOL, /* required */
      StackName: 'STRING_VALUE', /* required */
      UserName: 'STRING_VALUE', /* required */
      SendEmailNotification: true || false
    },
    /* more items */
  ]
};
appstream.batchAssociateUserStack(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: {}) —
    • UserStackAssociations — (Array<map>)

      The list of UserStackAssociation objects.

      • StackName — required — (String)

        The name of the stack that is associated with the user.

      • UserName — required — (String)

        The email address of the user who is associated with the stack.

      • AuthenticationType — required — (String)

        The authentication type for the user.

        Possible values include:
        • "API"
        • "SAML"
        • "USERPOOL"
      • SendEmailNotification — (Boolean)

        Specifies whether a welcome email is sent to a user after the user is created in the user pool.

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:

      • errors — (Array<map>)

        The list of UserStackAssociationError objects.

        • UserStackAssociation — (map)

          Information about the user and associated stack.

          • StackName — required — (String)

            The name of the stack that is associated with the user.

          • UserName — required — (String)

            The email address of the user who is associated with the stack.

          • AuthenticationType — required — (String)

            The authentication type for the user.

            Possible values include:
            • "API"
            • "SAML"
            • "USERPOOL"
          • SendEmailNotification — (Boolean)

            Specifies whether a welcome email is sent to a user after the user is created in the user pool.

        • ErrorCode — (String)

          The error code for the error that is returned when a user can’t be associated with or disassociated from a stack.

          Possible values include:
          • "STACK_NOT_FOUND"
          • "USER_NAME_NOT_FOUND"
          • "INTERNAL_ERROR"
        • ErrorMessage — (String)

          The error message for the error that is returned when a user can’t be associated with or disassociated from a stack.

Returns:

  • (AWS.Request) —

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

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

Disassociates the specified users from the specified stacks.

Service Reference:

Examples:

Calling the batchDisassociateUserStack operation

var params = {
  UserStackAssociations: [ /* required */
    {
      AuthenticationType: API | SAML | USERPOOL, /* required */
      StackName: 'STRING_VALUE', /* required */
      UserName: 'STRING_VALUE', /* required */
      SendEmailNotification: true || false
    },
    /* more items */
  ]
};
appstream.batchDisassociateUserStack(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: {}) —
    • UserStackAssociations — (Array<map>)

      The list of UserStackAssociation objects.

      • StackName — required — (String)

        The name of the stack that is associated with the user.

      • UserName — required — (String)

        The email address of the user who is associated with the stack.

      • AuthenticationType — required — (String)

        The authentication type for the user.

        Possible values include:
        • "API"
        • "SAML"
        • "USERPOOL"
      • SendEmailNotification — (Boolean)

        Specifies whether a welcome email is sent to a user after the user is created in the user pool.

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:

      • errors — (Array<map>)

        The list of UserStackAssociationError objects.

        • UserStackAssociation — (map)

          Information about the user and associated stack.

          • StackName — required — (String)

            The name of the stack that is associated with the user.

          • UserName — required — (String)

            The email address of the user who is associated with the stack.

          • AuthenticationType — required — (String)

            The authentication type for the user.

            Possible values include:
            • "API"
            • "SAML"
            • "USERPOOL"
          • SendEmailNotification — (Boolean)

            Specifies whether a welcome email is sent to a user after the user is created in the user pool.

        • ErrorCode — (String)

          The error code for the error that is returned when a user can’t be associated with or disassociated from a stack.

          Possible values include:
          • "STACK_NOT_FOUND"
          • "USER_NAME_NOT_FOUND"
          • "INTERNAL_ERROR"
        • ErrorMessage — (String)

          The error message for the error that is returned when a user can’t be associated with or disassociated from a stack.

Returns:

  • (AWS.Request) —

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

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

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

Service Reference:

Examples:

Calling the copyImage operation

var params = {
  DestinationImageName: 'STRING_VALUE', /* required */
  DestinationRegion: 'STRING_VALUE', /* required */
  SourceImageName: 'STRING_VALUE', /* required */
  DestinationImageDescription: 'STRING_VALUE'
};
appstream.copyImage(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: {}) —
    • SourceImageName — (String)

      The name of the image to copy.

    • DestinationImageName — (String)

      The name that the image will have when it is copied to the destination.

    • DestinationRegion — (String)

      The destination region to which the image will be copied. This parameter is required, even if you are copying an image within the same region.

    • DestinationImageDescription — (String)

      The description that the image will have when it is copied to the destination.

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:

      • DestinationImageName — (String)

        The name of the destination image.

Returns:

  • (AWS.Request) —

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

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

Creates a Directory Config object in AppStream 2.0. This object includes the information required to join streaming instances to an Active Directory domain.

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.

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

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

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

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

          • AccountPassword — required — (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. A fleet consists of streaming instances that run a specified image.

Service Reference:

Examples:

Calling the createFleet operation

var params = {
  ComputeCapacity: { /* required */
    DesiredInstances: 'NUMBER_VALUE' /* required */
  },
  InstanceType: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE',
  DisconnectTimeoutInSeconds: 'NUMBER_VALUE',
  DisplayName: 'STRING_VALUE',
  DomainJoinInfo: {
    DirectoryName: 'STRING_VALUE',
    OrganizationalUnitDistinguishedName: 'STRING_VALUE'
  },
  EnableDefaultInternetAccess: true || false,
  FleetType: ALWAYS_ON | ON_DEMAND,
  ImageArn: 'STRING_VALUE',
  ImageName: 'STRING_VALUE',
  MaxUserDurationInSeconds: 'NUMBER_VALUE',
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  },
  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 to create the fleet.

    • ImageArn — (String)

      The ARN of the public, private, or shared image to use.

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

      The fleet type.

      ALWAYS_ON

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

      ON_DEMAND

      Provide users with access to applications after they connect, which takes one to two minutes. You are charged for instance streaming when users are connected and a small hourly fee for instances that are not streaming apps.

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

      The desired capacity for the fleet.

      • DesiredInstances — required — (Integer)

        The desired number of streaming instances.

    • VpcConfig — (map)

      The VPC configuration for the fleet.

      • SubnetIds — (Array<String>)

        The identifiers of the subnets to which a network interface is attached from the fleet instance or image builder instance. Fleet instances use one or two subnets. Image builder instances use one subnet.

      • SecurityGroupIds — (Array<String>)

        The identifiers of the security groups for the fleet or image builder.

    • MaxUserDurationInSeconds — (Integer)

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

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

    • Description — (String)

      The description to display.

    • DisplayName — (String)

      The fleet name to display.

    • EnableDefaultInternetAccess — (Boolean)

      Enables or disables default internet access for the fleet.

    • DomainJoinInfo — (map)

      The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory 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.

    • Tags — (map<String>)

      The tags to associate with the fleet. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=.

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

      For more information, see Tagging Your Resources in the Amazon AppStream 2.0 Developer Guide.

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.

        • Arn — required — (String)

          The ARN for the fleet.

        • Name — required — (String)

          The name of the fleet.

        • DisplayName — (String)

          The fleet name to display.

        • Description — (String)

          The description to display.

        • ImageName — (String)

          The name of the image used to create the fleet.

        • ImageArn — (String)

          The ARN for the public, private, or shared image.

        • InstanceType — required — (String)

          The instance type to use when launching fleet instances.

        • FleetType — (String)

          The fleet type.

          ALWAYS_ON

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

          ON_DEMAND

          Provide users with access to applications after they connect, which takes one to two minutes. You are charged for instance streaming when users are connected and a small hourly fee for instances that are not streaming apps.

          Possible values include:
          • "ALWAYS_ON"
          • "ON_DEMAND"
        • ComputeCapacityStatus — required — (map)

          The capacity status for the fleet.

          • Desired — required — (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 360000.

        • 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 360000. By default, this value is 900 seconds (15 minutes).

        • State — required — (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 identifiers of the subnets to which a network interface is attached from the fleet instance or image builder instance. Fleet instances use one or two subnets. Image builder instances use one subnet.

          • SecurityGroupIds — (Array<String>)

            The identifiers of the security groups for the fleet or image builder.

        • 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 name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory 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

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

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

Service Reference:

Examples:

Calling the createImageBuilder operation

var params = {
  InstanceType: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  AppstreamAgentVersion: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  DisplayName: 'STRING_VALUE',
  DomainJoinInfo: {
    DirectoryName: 'STRING_VALUE',
    OrganizationalUnitDistinguishedName: 'STRING_VALUE'
  },
  EnableDefaultInternetAccess: true || false,
  ImageArn: 'STRING_VALUE',
  ImageName: 'STRING_VALUE',
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  },
  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)

      A unique name for the image builder.

    • ImageName — (String)

      The name of the image used to create the image builder.

    • ImageArn — (String)

      The ARN of the public, private, or shared image to use.

    • InstanceType — (String)

      The instance type to use when launching the image builder.

    • Description — (String)

      The description to display.

    • DisplayName — (String)

      The image builder name to display.

    • VpcConfig — (map)

      The VPC configuration for the image builder. You can specify only one subnet.

      • SubnetIds — (Array<String>)

        The identifiers of the subnets to which a network interface is attached from the fleet instance or image builder instance. Fleet instances use one or two subnets. Image builder instances use one subnet.

      • SecurityGroupIds — (Array<String>)

        The identifiers of the security groups for the fleet or image builder.

    • EnableDefaultInternetAccess — (Boolean)

      Enables or disables default internet access for the image builder.

    • DomainJoinInfo — (map)

      The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory 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.

    • AppstreamAgentVersion — (String)

      The version of the AppStream 2.0 agent to use for this image builder. To use the latest version of the AppStream 2.0 agent, specify [LATEST].

    • Tags — (map<String>)

      The tags to associate with the image builder. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=.

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

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

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)

        Information about the image builder.

        • Name — required — (String)

          The name of the image builder.

        • Arn — (String)

          The ARN for the image builder.

        • ImageArn — (String)

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

        • Description — (String)

          The description to display.

        • DisplayName — (String)

          The image builder name to display.

        • VpcConfig — (map)

          The VPC configuration of the image builder.

          • SubnetIds — (Array<String>)

            The identifiers of the subnets to which a network interface is attached from the fleet instance or image builder instance. Fleet instances use one or two subnets. Image builder instances use one subnet.

          • SecurityGroupIds — (Array<String>)

            The identifiers of the security groups for the fleet or image builder.

        • InstanceType — (String)

          The instance type for the image builder.

        • Platform — (String)

          The operating system platform of the image builder.

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

          The state of the image builder.

          Possible values include:
          • "PENDING"
          • "UPDATING_AGENT"
          • "RUNNING"
          • "STOPPING"
          • "STOPPED"
          • "REBOOTING"
          • "SNAPSHOTTING"
          • "DELETING"
          • "FAILED"
        • StateChangeReason — (map)

          The reason why the last state change occurred.

          • Code — (String)

            The state change reason code.

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

            The state change reason message.

        • CreatedTime — (Date)

          The time stamp when the image builder was created.

        • EnableDefaultInternetAccess — (Boolean)

          Enables or disables default internet access for the image builder.

        • DomainJoinInfo — (map)

          The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory 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>)

          The image builder 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.

          • ErrorTimestamp — (Date)

            The time the error occurred.

        • AppstreamAgentVersion — (String)

          The version of the AppStream 2.0 agent that is currently being used by the image builder.

Returns:

  • (AWS.Request) —

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

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

Creates a URL to start an image builder streaming session.

Service Reference:

Examples:

Calling the createImageBuilderStreamingURL operation

var params = {
  Name: 'STRING_VALUE', /* required */
  Validity: 'NUMBER_VALUE'
};
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)

      The name of the image builder.

    • Validity — (Integer)

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

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.

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

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

Service Reference:

Examples:

Calling the createStack operation

var params = {
  Name: 'STRING_VALUE', /* required */
  ApplicationSettings: {
    Enabled: true || false, /* required */
    SettingsGroup: 'STRING_VALUE'
  },
  Description: 'STRING_VALUE',
  DisplayName: 'STRING_VALUE',
  FeedbackURL: 'STRING_VALUE',
  RedirectURL: 'STRING_VALUE',
  StorageConnectors: [
    {
      ConnectorType: HOMEFOLDERS | GOOGLE_DRIVE | ONE_DRIVE, /* required */
      Domains: [
        'STRING_VALUE',
        /* more items */
      ],
      ResourceIdentifier: 'STRING_VALUE'
    },
    /* more items */
  ],
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  },
  UserSettings: [
    {
      Action: CLIPBOARD_COPY_FROM_LOCAL_DEVICE | CLIPBOARD_COPY_TO_LOCAL_DEVICE | FILE_UPLOAD | FILE_DOWNLOAD | PRINTING_TO_LOCAL_DEVICE, /* required */
      Permission: ENABLED | DISABLED /* required */
    },
    /* 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 to display.

    • DisplayName — (String)

      The stack name to display.

    • StorageConnectors — (Array<map>)

      The storage connectors to enable.

      • ConnectorType — required — (String)

        The type of storage connector.

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

        The ARN of the storage connector.

      • Domains — (Array<String>)

        The names of the domains for the account.

    • RedirectURL — (String)

      The URL that users are redirected to after their streaming session ends.

    • FeedbackURL — (String)

      The URL that users are redirected to after they click the Send Feedback link. If no URL is specified, no Send Feedback link is displayed.

    • UserSettings — (Array<map>)

      The actions that are enabled or disabled for users during their streaming sessions. By default, these actions are enabled.

      • Action — required — (String)

        The action that is enabled or disabled.

        Possible values include:
        • "CLIPBOARD_COPY_FROM_LOCAL_DEVICE"
        • "CLIPBOARD_COPY_TO_LOCAL_DEVICE"
        • "FILE_UPLOAD"
        • "FILE_DOWNLOAD"
        • "PRINTING_TO_LOCAL_DEVICE"
      • Permission — required — (String)

        Indicates whether the action is enabled or disabled.

        Possible values include:
        • "ENABLED"
        • "DISABLED"
    • ApplicationSettings — (map)

      The persistent application settings for users of a stack. When these settings are enabled, changes that users make to applications and Windows settings are automatically saved after each session and applied to the next session.

      • Enabled — required — (Boolean)

        Enables or disables persistent application settings for users during their streaming sessions.

      • SettingsGroup — (String)

        The path prefix for the S3 bucket where users’ persistent application settings are stored. You can allow the same persistent application settings to be used across multiple stacks by specifying the same settings group for each stack.

    • Tags — (map<String>)

      The tags to associate with the stack. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=.

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

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

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.

        • Name — required — (String)

          The name of the stack.

        • Description — (String)

          The description to display.

        • DisplayName — (String)

          The stack name to display.

        • CreatedTime — (Date)

          The time the stack was created.

        • StorageConnectors — (Array<map>)

          The storage connectors to enable.

          • ConnectorType — required — (String)

            The type of storage connector.

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

            The ARN of the storage connector.

          • Domains — (Array<String>)

            The names of the domains for the account.

        • RedirectURL — (String)

          The URL that users are redirected to after their streaming session ends.

        • FeedbackURL — (String)

          The URL that users are redirected to after they click the Send Feedback link. If no URL is specified, no Send Feedback link is displayed.

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

        • UserSettings — (Array<map>)

          The actions that are enabled or disabled for users during their streaming sessions. By default these actions are enabled.

          • Action — required — (String)

            The action that is enabled or disabled.

            Possible values include:
            • "CLIPBOARD_COPY_FROM_LOCAL_DEVICE"
            • "CLIPBOARD_COPY_TO_LOCAL_DEVICE"
            • "FILE_UPLOAD"
            • "FILE_DOWNLOAD"
            • "PRINTING_TO_LOCAL_DEVICE"
          • Permission — required — (String)

            Indicates whether the action is enabled or disabled.

            Possible values include:
            • "ENABLED"
            • "DISABLED"
        • ApplicationSettings — (map)

          The persistent application settings for users of the stack.

          • Enabled — (Boolean)

            Specifies whether persistent application settings are enabled for users during their streaming sessions.

          • SettingsGroup — (String)

            The path prefix for the S3 bucket where users’ persistent application settings are stored.

          • S3BucketName — (String)

            The S3 bucket where users’ persistent application settings are stored. When persistent application settings are enabled for the first time for an account in an AWS Region, an S3 bucket is created. The bucket is unique to the AWS account and the Region.

Returns:

  • (AWS.Request) —

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

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

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

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: 'NUMBER_VALUE'
};
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 identifier of the user.

    • ApplicationId — (String)

      The name of the application to launch after the session starts. This is the name that you specified as Name in the Image Assistant.

    • Validity — (Integer)

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

    • SessionContext — (String)

      The session context. For more information, see Session Context in the Amazon AppStream 2.0 Developer Guide.

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.

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

Creates a new user in the user pool.

Service Reference:

Examples:

Calling the createUser operation

var params = {
  AuthenticationType: API | SAML | USERPOOL, /* required */
  UserName: 'STRING_VALUE', /* required */
  FirstName: 'STRING_VALUE',
  LastName: 'STRING_VALUE',
  MessageAction: SUPPRESS | RESEND
};
appstream.createUser(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: {}) —
    • UserName — (String)

      The email address of the user.

    • MessageAction — (String)

      The action to take for the welcome email that is sent to a user after the user is created in the user pool. If you specify SUPPRESS, no email is sent. If you specify RESEND, do not specify the first name or last name of the user. If the value is null, the email is sent.

      Note: The temporary password in the welcome email is valid for only 7 days. If users don’t set their passwords within 7 days, you must send them a new welcome email.
      Possible values include:
      • "SUPPRESS"
      • "RESEND"
    • FirstName — (String)

      The first name, or given name, of the user.

    • LastName — (String)

      The last name, or surname, of the user.

    • AuthenticationType — (String)

      The authentication type for the user. You must specify USERPOOL.

      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.

Returns:

  • (AWS.Request) —

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

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

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

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

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

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)

      The name of the image.

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)

        Information about the image.

        • Name — required — (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 to display.

        • 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"
          • "COPYING"
          • "DELETING"
        • Visibility — (String)

          Indicates whether the image is public or private.

          Possible values include:
          • "PUBLIC"
          • "PRIVATE"
          • "SHARED"
        • 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 to display.

        • 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"
            • "IMAGE_COPY_FAILURE"
          • 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 to display.

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

        • AppstreamAgentVersion — (String)

          The version of the AppStream 2.0 agent to use for instances that are launched from this image.

        • ImagePermissions — (map)

          The permissions to provide to the destination AWS account for the specified image.

          • allowFleet — (Boolean)

            Indicates whether the image can be used for a fleet.

          • allowImageBuilder — (Boolean)

            Indicates whether the image can be used for an image builder.

Returns:

  • (AWS.Request) —

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

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

Deletes the specified image builder and releases the capacity.

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)

      The name of the image builder.

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)

        Information about the image builder.

        • Name — required — (String)

          The name of the image builder.

        • Arn — (String)

          The ARN for the image builder.

        • ImageArn — (String)

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

        • Description — (String)

          The description to display.

        • DisplayName — (String)

          The image builder name to display.

        • VpcConfig — (map)

          The VPC configuration of the image builder.

          • SubnetIds — (Array<String>)

            The identifiers of the subnets to which a network interface is attached from the fleet instance or image builder instance. Fleet instances use one or two subnets. Image builder instances use one subnet.

          • SecurityGroupIds — (Array<String>)

            The identifiers of the security groups for the fleet or image builder.

        • InstanceType — (String)

          The instance type for the image builder.

        • Platform — (String)

          The operating system platform of the image builder.

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

          The state of the image builder.

          Possible values include:
          • "PENDING"
          • "UPDATING_AGENT"
          • "RUNNING"
          • "STOPPING"
          • "STOPPED"
          • "REBOOTING"
          • "SNAPSHOTTING"
          • "DELETING"
          • "FAILED"
        • StateChangeReason — (map)

          The reason why the last state change occurred.

          • Code — (String)

            The state change reason code.

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

            The state change reason message.

        • CreatedTime — (Date)

          The time stamp when the image builder was created.

        • EnableDefaultInternetAccess — (Boolean)

          Enables or disables default internet access for the image builder.

        • DomainJoinInfo — (map)

          The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory 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>)

          The image builder 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.

          • ErrorTimestamp — (Date)

            The time the error occurred.

        • AppstreamAgentVersion — (String)

          The version of the AppStream 2.0 agent that is currently being used by the image builder.

Returns:

  • (AWS.Request) —

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

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

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

Service Reference:

Examples:

Calling the deleteImagePermissions operation

var params = {
  Name: 'STRING_VALUE', /* required */
  SharedAccountId: 'STRING_VALUE' /* required */
};
appstream.deleteImagePermissions(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 private image.

    • SharedAccountId — (String)

      The 12-digit identifier of the AWS account for which to delete image permissions.

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 specified stack. After the stack is deleted, the application streaming environment provided by the stack is no longer available to users. Also, any reservations made for application streaming sessions for the stack are released.

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.

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

Deletes a user from the user pool.

Service Reference:

Examples:

Calling the deleteUser operation

var params = {
  AuthenticationType: API | SAML | USERPOOL, /* required */
  UserName: 'STRING_VALUE' /* required */
};
appstream.deleteUser(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: {}) —
    • UserName — (String)

      The email address of the user.

    • AuthenticationType — (String)

      The authentication type for the user. You must specify USERPOOL.

      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.

Returns:

  • (AWS.Request) —

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

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

Retrieves a list that describes one or more specified Directory Config objects for AppStream 2.0, if the names for these objects are provided. Otherwise, all Directory Config objects in the account are described. These objects include the information required to join streaming instances to an Active Directory domain.

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

Service Reference:

Examples:

Calling the describeDirectoryConfigs operation

var params = {
  DirectoryNames: [
    'STRING_VALUE',
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  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. Note that although the response syntax in this topic includes the account password, this password is not returned in the actual response.

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

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

          • AccountPassword — required — (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

Retrieves a list that describes one or more specified fleets, if the fleet names are provided. Otherwise, all 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 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.

        • Arn — required — (String)

          The ARN for the fleet.

        • Name — required — (String)

          The name of the fleet.

        • DisplayName — (String)

          The fleet name to display.

        • Description — (String)

          The description to display.

        • ImageName — (String)

          The name of the image used to create the fleet.

        • ImageArn — (String)

          The ARN for the public, private, or shared image.

        • InstanceType — required — (String)

          The instance type to use when launching fleet instances.

        • FleetType — (String)

          The fleet type.

          ALWAYS_ON

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

          ON_DEMAND

          Provide users with access to applications after they connect, which takes one to two minutes. You are charged for instance streaming when users are connected and a small hourly fee for instances that are not streaming apps.

          Possible values include:
          • "ALWAYS_ON"
          • "ON_DEMAND"
        • ComputeCapacityStatus — required — (map)

          The capacity status for the fleet.

          • Desired — required — (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 360000.

        • 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 360000. By default, this value is 900 seconds (15 minutes).

        • State — required — (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 identifiers of the subnets to which a network interface is attached from the fleet instance or image builder instance. Fleet instances use one or two subnets. Image builder instances use one subnet.

          • SecurityGroupIds — (Array<String>)

            The identifiers of the security groups for the fleet or image builder.

        • 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 name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory 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

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

Service Reference:

Examples:

Calling the describeImageBuilders operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  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>)

      The names of the image builders to describe.

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

      • ImageBuilders — (Array<map>)

        Information about the image builders.

        • Name — required — (String)

          The name of the image builder.

        • Arn — (String)

          The ARN for the image builder.

        • ImageArn — (String)

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

        • Description — (String)

          The description to display.

        • DisplayName — (String)

          The image builder name to display.

        • VpcConfig — (map)

          The VPC configuration of the image builder.

          • SubnetIds — (Array<String>)

            The identifiers of the subnets to which a network interface is attached from the fleet instance or image builder instance. Fleet instances use one or two subnets. Image builder instances use one subnet.

          • SecurityGroupIds — (Array<String>)

            The identifiers of the security groups for the fleet or image builder.

        • InstanceType — (String)

          The instance type for the image builder.

        • Platform — (String)

          The operating system platform of the image builder.

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

          The state of the image builder.

          Possible values include:
          • "PENDING"
          • "UPDATING_AGENT"
          • "RUNNING"
          • "STOPPING"
          • "STOPPED"
          • "REBOOTING"
          • "SNAPSHOTTING"
          • "DELETING"
          • "FAILED"
        • StateChangeReason — (map)

          The reason why the last state change occurred.

          • Code — (String)

            The state change reason code.

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

            The state change reason message.

        • CreatedTime — (Date)

          The time stamp when the image builder was created.

        • EnableDefaultInternetAccess — (Boolean)

          Enables or disables default internet access for the image builder.

        • DomainJoinInfo — (map)

          The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory 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>)

          The image builder 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.

          • ErrorTimestamp — (Date)

            The time the error occurred.

        • AppstreamAgentVersion — (String)

          The version of the AppStream 2.0 agent that is currently being used by the image builder.

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

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

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

Service Reference:

Examples:

Calling the describeImagePermissions operation

var params = {
  Name: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  SharedAwsAccountIds: [
    'STRING_VALUE',
    /* more items */
  ]
};
appstream.describeImagePermissions(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 private image for which to describe permissions. The image must be one that you own.

    • MaxResults — (Integer)

      The maximum size of each page of results.

    • SharedAwsAccountIds — (Array<String>)

      The 12-digit identifier of one or more AWS accounts with which the image is shared.

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

      • Name — (String)

        The name of the private image.

      • SharedImagePermissionsList — (Array<map>)

        The permissions for a private image that you own.

        • sharedAccountId — required — (String)

          The 12-digit identifier of the AWS account with which the image is shared.

        • imagePermissions — required — (map)

          Describes the permissions for a shared image.

          • allowFleet — (Boolean)

            Indicates whether the image can be used for a fleet.

          • allowImageBuilder — (Boolean)

            Indicates whether the image can be used for an image builder.

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

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

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

Service Reference:

Examples:

Calling the describeImages operation

var params = {
  Arns: [
    'STRING_VALUE',
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  Names: [
    'STRING_VALUE',
    /* more items */
  ],
  NextToken: 'STRING_VALUE',
  Type: PUBLIC | PRIVATE | SHARED
};
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 public or private images to describe.

    • Arns — (Array<String>)

      The ARNs of the public, private, and shared images to describe.

    • Type — (String)

      The type of image (public, private, or shared) to describe.

      Possible values include:
      • "PUBLIC"
      • "PRIVATE"
      • "SHARED"
    • 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.

    • MaxResults — (Integer)

      The maximum size of each page of results.

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.

        • Name — required — (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 to display.

        • 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"
          • "COPYING"
          • "DELETING"
        • Visibility — (String)

          Indicates whether the image is public or private.

          Possible values include:
          • "PUBLIC"
          • "PRIVATE"
          • "SHARED"
        • 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 to display.

        • 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"
            • "IMAGE_COPY_FAILURE"
          • 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 to display.

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

        • AppstreamAgentVersion — (String)

          The version of the AppStream 2.0 agent to use for instances that are launched from this image.

        • ImagePermissions — (map)

          The permissions to provide to the destination AWS account for the specified image.

          • allowFleet — (Boolean)

            Indicates whether the image can be used for a fleet.

          • allowImageBuilder — (Boolean)

            Indicates whether the image can be used for an image builder.

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

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

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

Service Reference:

Examples:

Calling the describeSessions operation

var params = {
  FleetName: 'STRING_VALUE', /* required */
  StackName: 'STRING_VALUE', /* required */
  AuthenticationType: API | SAML | USERPOOL,
  Limit: 'NUMBER_VALUE',
  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. This value is case-sensitive.

    • FleetName — (String)

      The name of the fleet. This value is case-sensitive.

    • UserId — (String)

      The user identifier.

    • 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, SAML for a SAML 2.0-federated user, or USERPOOL for a user in the AppStream 2.0 user pool. 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.

        • Id — required — (String)

          The identifier of the streaming session.

        • UserId — required — (String)

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

        • StackName — required — (String)

          The name of the stack for the streaming session.

        • FleetName — required — (String)

          The name of the fleet for the streaming session.

        • State — required — (String)

          The current state of the streaming session.

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

          Specifies whether a user is connected to the streaming session.

          Possible values include:
          • "CONNECTED"
          • "NOT_CONNECTED"
        • StartTime — (Date)

          The time when a streaming instance is dedicated for the user.

        • MaxExpirationTime — (Date)

          The time when the streaming session is set to expire. This time is based on the MaxUserDurationinSeconds value, which determines the maximum length of time that a streaming session can run. A streaming session might end earlier than the time specified in SessionMaxExpirationTime, when the DisconnectTimeOutInSeconds elapses or the user chooses to end his or her session. If the DisconnectTimeOutInSeconds elapses, or the user chooses to end his or her session, the streaming instance is terminated and the streaming session ends.

        • AuthenticationType — (String)

          The authentication method. The user is authenticated using a streaming URL (API), SAML 2.0 federation (SAML), or the AppStream 2.0 user pool (USERPOOL). The default is to authenticate users using a streaming URL.

          Possible values include:
          • "API"
          • "SAML"
          • "USERPOOL"
        • NetworkAccessConfiguration — (map)

          The network details for the streaming session.

          • EniPrivateIpAddress — (String)

            The private IP address of the elastic network interface that is attached to instances in your VPC.

          • EniId — (String)

            The resource identifier of the elastic network interface that is attached to instances in your VPC. All network interfaces have the eni-xxxxxxxx resource identifier.

      • 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

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

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.

        • Name — required — (String)

          The name of the stack.

        • Description — (String)

          The description to display.

        • DisplayName — (String)

          The stack name to display.

        • CreatedTime — (Date)

          The time the stack was created.

        • StorageConnectors — (Array<map>)

          The storage connectors to enable.

          • ConnectorType — required — (String)

            The type of storage connector.

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

            The ARN of the storage connector.

          • Domains — (Array<String>)

            The names of the domains for the account.

        • RedirectURL — (String)

          The URL that users are redirected to after their streaming session ends.

        • FeedbackURL — (String)

          The URL that users are redirected to after they click the Send Feedback link. If no URL is specified, no Send Feedback link is displayed.

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

        • UserSettings — (Array<map>)

          The actions that are enabled or disabled for users during their streaming sessions. By default these actions are enabled.

          • Action — required — (String)

            The action that is enabled or disabled.

            Possible values include:
            • "CLIPBOARD_COPY_FROM_LOCAL_DEVICE"
            • "CLIPBOARD_COPY_TO_LOCAL_DEVICE"
            • "FILE_UPLOAD"
            • "FILE_DOWNLOAD"
            • "PRINTING_TO_LOCAL_DEVICE"
          • Permission — required — (String)

            Indicates whether the action is enabled or disabled.

            Possible values include:
            • "ENABLED"
            • "DISABLED"
        • ApplicationSettings — (map)

          The persistent application settings for users of the stack.

          • Enabled — (Boolean)

            Specifies whether persistent application settings are enabled for users during their streaming sessions.

          • SettingsGroup — (String)

            The path prefix for the S3 bucket where users’ persistent application settings are stored.

          • S3BucketName — (String)

            The S3 bucket where users’ persistent application settings are stored. When persistent application settings are enabled for the first time for an account in an AWS Region, an S3 bucket is created. The bucket is unique to the AWS account and the Region.

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

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

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

Service Reference:

Examples:

Calling the describeUsers operation

var params = {
  AuthenticationType: API | SAML | USERPOOL, /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
appstream.describeUsers(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: {}) —
    • AuthenticationType — (String)

      The authentication type for the users in the user pool to describe. You must specify USERPOOL.

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

      • Users — (Array<map>)

        Information about users in the user pool.

        • Arn — (String)

          The ARN of the user.

        • UserName — (String)

          The email address of the user.

        • Enabled — (Boolean)

          Specifies whether the user in the user pool is enabled.

        • Status — (String)

          The status of the user in the user pool. The status can be one of the following:

          • UNCONFIRMED – The user is created but not confirmed.

          • CONFIRMED – The user is confirmed.

          • ARCHIVED – The user is no longer active.

          • COMPROMISED – The user is disabled because of a potential security threat.

          • UNKNOWN – The user status is not known.

        • FirstName — (String)

          The first name, or given name, of the user.

        • LastName — (String)

          The last name, or surname, of the user.

        • CreatedTime — (Date)

          The date and time the user was created in the user pool.

        • AuthenticationType — required — (String)

          The authentication type for the user.

          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.

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

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

  • The stack name

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

Service Reference:

Examples:

Calling the describeUserStackAssociations operation

var params = {
  AuthenticationType: API | SAML | USERPOOL,
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  StackName: 'STRING_VALUE',
  UserName: 'STRING_VALUE'
};
appstream.describeUserStackAssociations(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 that is associated with the user.

    • UserName — (String)

      The email address of the user who is associated with the stack.

    • AuthenticationType — (String)

      The authentication type for the user who is associated with the stack. You must specify USERPOOL.

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

      • UserStackAssociations — (Array<map>)

        The UserStackAssociation objects.

        • StackName — required — (String)

          The name of the stack that is associated with the user.

        • UserName — required — (String)

          The email address of the user who is associated with the stack.

        • AuthenticationType — required — (String)

          The authentication type for the user.

          Possible values include:
          • "API"
          • "SAML"
          • "USERPOOL"
        • SendEmailNotification — (Boolean)

          Specifies whether a welcome email is sent to a user after the user is created in the user pool.

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

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

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

Service Reference:

Examples:

Calling the disableUser operation

var params = {
  AuthenticationType: API | SAML | USERPOOL, /* required */
  UserName: 'STRING_VALUE' /* required */
};
appstream.disableUser(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: {}) —
    • UserName — (String)

      The email address of the user.

    • AuthenticationType — (String)

      The authentication type for the user. You must specify USERPOOL.

      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.

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.

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

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

Service Reference:

Examples:

Calling the enableUser operation

var params = {
  AuthenticationType: API | SAML | USERPOOL, /* required */
  UserName: 'STRING_VALUE' /* required */
};
appstream.enableUser(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: {}) —
    • UserName — (String)

      The email address of the user.

    • AuthenticationType — (String)

      The authentication type for the user. You must specify USERPOOL.

      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.

Returns:

  • (AWS.Request) —

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

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

Immediately 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 identifier 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

Retrieves the name of the fleet that is 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 name of 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.

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

Retrieves the name of the stack with 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.

    • 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 name of the stack.

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

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

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

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

Service Reference:

Examples:

Calling the listTagsForResource operation

var params = {
  ResourceArn: 'STRING_VALUE' /* required */
};
appstream.listTagsForResource(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: {}) —
    • ResourceArn — (String)

      The Amazon Resource Name (ARN) of the resource.

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:

      • Tags — (map<String>)

        The information about the tags.

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

Starts the specified image builder.

Service Reference:

Examples:

Calling the startImageBuilder operation

var params = {
  Name: 'STRING_VALUE', /* required */
  AppstreamAgentVersion: 'STRING_VALUE'
};
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)

      The name of the image builder.

    • AppstreamAgentVersion — (String)

      The version of the AppStream 2.0 agent to use for this image builder. To use the latest version of the AppStream 2.0 agent, specify [LATEST].

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)

        Information about the image builder.

        • Name — required — (String)

          The name of the image builder.

        • Arn — (String)

          The ARN for the image builder.

        • ImageArn — (String)

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

        • Description — (String)

          The description to display.

        • DisplayName — (String)

          The image builder name to display.

        • VpcConfig — (map)

          The VPC configuration of the image builder.

          • SubnetIds — (Array<String>)

            The identifiers of the subnets to which a network interface is attached from the fleet instance or image builder instance. Fleet instances use one or two subnets. Image builder instances use one subnet.

          • SecurityGroupIds — (Array<String>)

            The identifiers of the security groups for the fleet or image builder.

        • InstanceType — (String)

          The instance type for the image builder.

        • Platform — (String)

          The operating system platform of the image builder.

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

          The state of the image builder.

          Possible values include:
          • "PENDING"
          • "UPDATING_AGENT"
          • "RUNNING"
          • "STOPPING"
          • "STOPPED"
          • "REBOOTING"
          • "SNAPSHOTTING"
          • "DELETING"
          • "FAILED"
        • StateChangeReason — (map)

          The reason why the last state change occurred.

          • Code — (String)

            The state change reason code.

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

            The state change reason message.

        • CreatedTime — (Date)

          The time stamp when the image builder was created.

        • EnableDefaultInternetAccess — (Boolean)

          Enables or disables default internet access for the image builder.

        • DomainJoinInfo — (map)

          The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory 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>)

          The image builder 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.

          • ErrorTimestamp — (Date)

            The time the error occurred.

        • AppstreamAgentVersion — (String)

          The version of the AppStream 2.0 agent that is currently being used by the image builder.

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

Stops the specified image builder.

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)

      The name of the image builder.

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)

        Information about the image builder.

        • Name — required — (String)

          The name of the image builder.

        • Arn — (String)

          The ARN for the image builder.

        • ImageArn — (String)

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

        • Description — (String)

          The description to display.

        • DisplayName — (String)

          The image builder name to display.

        • VpcConfig — (map)

          The VPC configuration of the image builder.

          • SubnetIds — (Array<String>)

            The identifiers of the subnets to which a network interface is attached from the fleet instance or image builder instance. Fleet instances use one or two subnets. Image builder instances use one subnet.

          • SecurityGroupIds — (Array<String>)

            The identifiers of the security groups for the fleet or image builder.

        • InstanceType — (String)

          The instance type for the image builder.

        • Platform — (String)

          The operating system platform of the image builder.

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

          The state of the image builder.

          Possible values include:
          • "PENDING"
          • "UPDATING_AGENT"
          • "RUNNING"
          • "STOPPING"
          • "STOPPED"
          • "REBOOTING"
          • "SNAPSHOTTING"
          • "DELETING"
          • "FAILED"
        • StateChangeReason — (map)

          The reason why the last state change occurred.

          • Code — (String)

            The state change reason code.

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

            The state change reason message.

        • CreatedTime — (Date)

          The time stamp when the image builder was created.

        • EnableDefaultInternetAccess — (Boolean)

          Enables or disables default internet access for the image builder.

        • DomainJoinInfo — (map)

          The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory 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>)

          The image builder 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.

          • ErrorTimestamp — (Date)

            The time the error occurred.

        • AppstreamAgentVersion — (String)

          The version of the AppStream 2.0 agent that is currently being used by the image builder.

Returns:

  • (AWS.Request) —

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

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

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

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

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

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

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  Tags: { /* required */
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
appstream.tagResource(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: {}) —
    • ResourceArn — (String)

      The Amazon Resource Name (ARN) of the resource.

    • Tags — (map<String>)

      The tags to associate. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=.

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

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.

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

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

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

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

Service Reference:

Examples:

Calling the untagResource operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
appstream.untagResource(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: {}) —
    • ResourceArn — (String)

      The Amazon Resource Name (ARN) of the resource.

    • TagKeys — (Array<String>)

      The tag keys for the tags to disassociate.

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.

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

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

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 Config object.

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

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

      • AccountPassword — required — (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 Config object.

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

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

          • AccountPassword — required — (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 = {
  AttributesToDelete: [
    VPC_CONFIGURATION | VPC_CONFIGURATION_SECURITY_GROUP_IDS | DOMAIN_JOIN_INFO,
    /* more items */
  ],
  ComputeCapacity: {
    DesiredInstances: 'NUMBER_VALUE' /* required */
  },
  DeleteVpcConfig: true || false,
  Description: 'STRING_VALUE',
  DisconnectTimeoutInSeconds: 'NUMBER_VALUE',
  DisplayName: 'STRING_VALUE',
  DomainJoinInfo: {
    DirectoryName: 'STRING_VALUE',
    OrganizationalUnitDistinguishedName: 'STRING_VALUE'
  },
  EnableDefaultInternetAccess: true || false,
  ImageArn: 'STRING_VALUE',
  ImageName: 'STRING_VALUE',
  InstanceType: 'STRING_VALUE',
  MaxUserDurationInSeconds: 'NUMBER_VALUE',
  Name: 'STRING_VALUE',
  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 to create the fleet.

    • ImageArn — (String)

      The ARN of the public, private, or shared image to use.

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

      • DesiredInstances — required — (Integer)

        The desired number of streaming instances.

    • VpcConfig — (map)

      The VPC configuration for the fleet.

      • SubnetIds — (Array<String>)

        The identifiers of the subnets to which a network interface is attached from the fleet instance or image builder instance. Fleet instances use one or two subnets. Image builder instances use one subnet.

      • SecurityGroupIds — (Array<String>)

        The identifiers of the security groups for the fleet or image builder.

    • MaxUserDurationInSeconds — (Integer)

      The maximum time that a streaming session can run, in seconds. Specify a value between 600 and 360000. By default, the value is 900 seconds (15 minutes).

    • 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 360000. By default, the value is 900 seconds (15 minutes).

    • DeleteVpcConfig — (Boolean)

      Deletes the VPC association for the specified fleet.

    • Description — (String)

      The description to display.

    • DisplayName — (String)

      The fleet name to display.

    • EnableDefaultInternetAccess — (Boolean)

      Enables or disables default internet access for the fleet.

    • DomainJoinInfo — (map)

      The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory 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.

        • Arn — required — (String)

          The ARN for the fleet.

        • Name — required — (String)

          The name of the fleet.

        • DisplayName — (String)

          The fleet name to display.

        • Description — (String)

          The description to display.

        • ImageName — (String)

          The name of the image used to create the fleet.

        • ImageArn — (String)

          The ARN for the public, private, or shared image.

        • InstanceType — required — (String)

          The instance type to use when launching fleet instances.

        • FleetType — (String)

          The fleet type.

          ALWAYS_ON

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

          ON_DEMAND

          Provide users with access to applications after they connect, which takes one to two minutes. You are charged for instance streaming when users are connected and a small hourly fee for instances that are not streaming apps.

          Possible values include:
          • "ALWAYS_ON"
          • "ON_DEMAND"
        • ComputeCapacityStatus — required — (map)

          The capacity status for the fleet.

          • Desired — required — (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 360000.

        • 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 360000. By default, this value is 900 seconds (15 minutes).

        • State — required — (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 identifiers of the subnets to which a network interface is attached from the fleet instance or image builder instance. Fleet instances use one or two subnets. Image builder instances use one subnet.

          • SecurityGroupIds — (Array<String>)

            The identifiers of the security groups for the fleet or image builder.

        • 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 name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory 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.

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

Adds or updates permissions for the specified private image.

Service Reference:

Examples:

Calling the updateImagePermissions operation

var params = {
  ImagePermissions: { /* required */
    allowFleet: true || false,
    allowImageBuilder: true || false
  },
  Name: 'STRING_VALUE', /* required */
  SharedAccountId: 'STRING_VALUE' /* required */
};
appstream.updateImagePermissions(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 private image.

    • SharedAccountId — (String)

      The 12-digit identifier of the AWS account for which you want add or update image permissions.

    • ImagePermissions — (map)

      The permissions for the image.

      • allowFleet — (Boolean)

        Indicates whether the image can be used for a fleet.

      • allowImageBuilder — (Boolean)

        Indicates whether the image can be used for an image builder.

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.

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

Updates the specified fields for the specified stack.

Service Reference:

Examples:

Calling the updateStack operation

var params = {
  Name: 'STRING_VALUE', /* required */
  ApplicationSettings: {
    Enabled: true || false, /* required */
    SettingsGroup: 'STRING_VALUE'
  },
  AttributesToDelete: [
    STORAGE_CONNECTORS | STORAGE_CONNECTOR_HOMEFOLDERS | STORAGE_CONNECTOR_GOOGLE_DRIVE | STORAGE_CONNECTOR_ONE_DRIVE | REDIRECT_URL | FEEDBACK_URL | THEME_NAME | USER_SETTINGS,
    /* more items */
  ],
  DeleteStorageConnectors: true || false,
  Description: 'STRING_VALUE',
  DisplayName: 'STRING_VALUE',
  FeedbackURL: 'STRING_VALUE',
  RedirectURL: 'STRING_VALUE',
  StorageConnectors: [
    {
      ConnectorType: HOMEFOLDERS | GOOGLE_DRIVE | ONE_DRIVE, /* required */
      Domains: [
        'STRING_VALUE',
        /* more items */
      ],
      ResourceIdentifier: 'STRING_VALUE'
    },
    /* more items */
  ],
  UserSettings: [
    {
      Action: CLIPBOARD_COPY_FROM_LOCAL_DEVICE | CLIPBOARD_COPY_TO_LOCAL_DEVICE | FILE_UPLOAD | FILE_DOWNLOAD | PRINTING_TO_LOCAL_DEVICE, /* required */
      Permission: ENABLED | DISABLED /* required */
    },
    /* 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 to display.

    • Description — (String)

      The description to display.

    • Name — (String)

      The name of the stack.

    • StorageConnectors — (Array<map>)

      The storage connectors to enable.

      • ConnectorType — required — (String)

        The type of storage connector.

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

        The ARN of the storage connector.

      • Domains — (Array<String>)

        The names of the domains for the account.

    • DeleteStorageConnectors — (Boolean)

      Deletes the storage connectors currently enabled for the stack.

    • RedirectURL — (String)

      The URL that users are redirected to after their streaming session ends.

    • FeedbackURL — (String)

      The URL that users are redirected to after they choose the Send Feedback link. If no URL is specified, no Send Feedback link is displayed.

    • AttributesToDelete — (Array<String>)

      The stack attributes to delete.

    • UserSettings — (Array<map>)

      The actions that are enabled or disabled for users during their streaming sessions. By default, these actions are enabled.

      • Action — required — (String)

        The action that is enabled or disabled.

        Possible values include:
        • "CLIPBOARD_COPY_FROM_LOCAL_DEVICE"
        • "CLIPBOARD_COPY_TO_LOCAL_DEVICE"
        • "FILE_UPLOAD"
        • "FILE_DOWNLOAD"
        • "PRINTING_TO_LOCAL_DEVICE"
      • Permission — required — (String)

        Indicates whether the action is enabled or disabled.

        Possible values include:
        • "ENABLED"
        • "DISABLED"
    • ApplicationSettings — (map)

      The persistent application settings for users of a stack. When these settings are enabled, changes that users make to applications and Windows settings are automatically saved after each session and applied to the next session.

      • Enabled — required — (Boolean)

        Enables or disables persistent application settings for users during their streaming sessions.

      • SettingsGroup — (String)

        The path prefix for the S3 bucket where users’ persistent application settings are stored. You can allow the same persistent application settings to be used across multiple stacks by specifying the same settings group for each 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.

        • Name — required — (String)

          The name of the stack.

        • Description — (String)

          The description to display.

        • DisplayName — (String)

          The stack name to display.

        • CreatedTime — (Date)

          The time the stack was created.

        • StorageConnectors — (Array<map>)

          The storage connectors to enable.

          • ConnectorType — required — (String)

            The type of storage connector.

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

            The ARN of the storage connector.

          • Domains — (Array<String>)

            The names of the domains for the account.

        • RedirectURL — (String)

          The URL that users are redirected to after their streaming session ends.

        • FeedbackURL — (String)

          The URL that users are redirected to after they click the Send Feedback link. If no URL is specified, no Send Feedback link is displayed.

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

        • UserSettings — (Array<map>)

          The actions that are enabled or disabled for users during their streaming sessions. By default these actions are enabled.

          • Action — required — (String)

            The action that is enabled or disabled.

            Possible values include:
            • "CLIPBOARD_COPY_FROM_LOCAL_DEVICE"
            • "CLIPBOARD_COPY_TO_LOCAL_DEVICE"
            • "FILE_UPLOAD"
            • "FILE_DOWNLOAD"
            • "PRINTING_TO_LOCAL_DEVICE"
          • Permission — required — (String)

            Indicates whether the action is enabled or disabled.

            Possible values include:
            • "ENABLED"
            • "DISABLED"
        • ApplicationSettings — (map)

          The persistent application settings for users of the stack.

          • Enabled — (Boolean)

            Specifies whether persistent application settings are enabled for users during their streaming sessions.

          • SettingsGroup — (String)

            The path prefix for the S3 bucket where users’ persistent application settings are stored.

          • S3BucketName — (String)

            The S3 bucket where users’ persistent application settings are stored. When persistent application settings are enabled for the first time for an account in an AWS Region, an S3 bucket is created. The bucket is unique to the AWS account and the Region.

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.

        • Arn — required — (String)

          The ARN for the fleet.

        • Name — required — (String)

          The name of the fleet.

        • DisplayName — (String)

          The fleet name to display.

        • Description — (String)

          The description to display.

        • ImageName — (String)

          The name of the image used to create the fleet.

        • ImageArn — (String)

          The ARN for the public, private, or shared image.

        • InstanceType — required — (String)

          The instance type to use when launching fleet instances.

        • FleetType — (String)

          The fleet type.

          ALWAYS_ON

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

          ON_DEMAND

          Provide users with access to applications after they connect, which takes one to two minutes. You are charged for instance streaming when users are connected and a small hourly fee for instances that are not streaming apps.

          Possible values include:
          • "ALWAYS_ON"
          • "ON_DEMAND"
        • ComputeCapacityStatus — required — (map)

          The capacity status for the fleet.

          • Desired — required — (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 360000.

        • 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 360000. By default, this value is 900 seconds (15 minutes).

        • State — required — (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 identifiers of the subnets to which a network interface is attached from the fleet instance or image builder instance. Fleet instances use one or two subnets. Image builder instances use one subnet.

          • SecurityGroupIds — (Array<String>)

            The identifiers of the security groups for the fleet or image builder.

        • 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 name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory 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.

        • Arn — required — (String)

          The ARN for the fleet.

        • Name — required — (String)

          The name of the fleet.

        • DisplayName — (String)

          The fleet name to display.

        • Description — (String)

          The description to display.

        • ImageName — (String)

          The name of the image used to create the fleet.

        • ImageArn — (String)

          The ARN for the public, private, or shared image.

        • InstanceType — required — (String)

          The instance type to use when launching fleet instances.

        • FleetType — (String)

          The fleet type.

          ALWAYS_ON

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

          ON_DEMAND

          Provide users with access to applications after they connect, which takes one to two minutes. You are charged for instance streaming when users are connected and a small hourly fee for instances that are not streaming apps.

          Possible values include:
          • "ALWAYS_ON"
          • "ON_DEMAND"
        • ComputeCapacityStatus — required — (map)

          The capacity status for the fleet.

          • Desired — required — (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 360000.

        • 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 360000. By default, this value is 900 seconds (15 minutes).

        • State — required — (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 identifiers of the subnets to which a network interface is attached from the fleet instance or image builder instance. Fleet instances use one or two subnets. Image builder instances use one subnet.

          • SecurityGroupIds — (Array<String>)

            The identifiers of the security groups for the fleet or image builder.

        • 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 name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory 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: