AppStream

Table of Contents

Client

class AppStream.Client

A low-level client representing Amazon AppStream:

import boto3

client = boto3.client('appstream')

These are the available methods:

associate_fleet(**kwargs)

Associates the specified fleet with the specified stack.

See also: AWS API Documentation

Request Syntax

response = client.associate_fleet(
    FleetName='string',
    StackName='string'
)
Parameters
  • FleetName (string) --

    [REQUIRED]

    The name of the fleet.

  • StackName (string) --

    [REQUIRED]

    The name of the stack.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

batch_associate_user_stack(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.batch_associate_user_stack(
    UserStackAssociations=[
        {
            'StackName': 'string',
            'UserName': 'string',
            'AuthenticationType': 'API'|'SAML'|'USERPOOL',
            'SendEmailNotification': True|False
        },
    ]
)
Parameters
UserStackAssociations (list) --

[REQUIRED]

The list of UserStackAssociation objects.

  • (dict) --

    Describes a user in the user pool and the associated stack.

    • StackName (string) -- [REQUIRED]

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

    • UserName (string) -- [REQUIRED]

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

    • AuthenticationType (string) -- [REQUIRED]

      The authentication type for the user.

    • SendEmailNotification (boolean) --

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

Return type
dict
Returns
Response Syntax
{
    'errors': [
        {
            'UserStackAssociation': {
                'StackName': 'string',
                'UserName': 'string',
                'AuthenticationType': 'API'|'SAML'|'USERPOOL',
                'SendEmailNotification': True|False
            },
            'ErrorCode': 'STACK_NOT_FOUND'|'USER_NAME_NOT_FOUND'|'INTERNAL_ERROR',
            'ErrorMessage': 'string'
        },
    ]
}

Response Structure

  • (dict) --
    • errors (list) --

      The list of UserStackAssociationError objects.

      • (dict) --

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

        • UserStackAssociation (dict) --

          Information about the user and associated stack.

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

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

        • ErrorMessage (string) --

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

batch_disassociate_user_stack(**kwargs)

Disassociates the specified users from the specified stacks.

See also: AWS API Documentation

Request Syntax

response = client.batch_disassociate_user_stack(
    UserStackAssociations=[
        {
            'StackName': 'string',
            'UserName': 'string',
            'AuthenticationType': 'API'|'SAML'|'USERPOOL',
            'SendEmailNotification': True|False
        },
    ]
)
Parameters
UserStackAssociations (list) --

[REQUIRED]

The list of UserStackAssociation objects.

  • (dict) --

    Describes a user in the user pool and the associated stack.

    • StackName (string) -- [REQUIRED]

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

    • UserName (string) -- [REQUIRED]

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

    • AuthenticationType (string) -- [REQUIRED]

      The authentication type for the user.

    • SendEmailNotification (boolean) --

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

Return type
dict
Returns
Response Syntax
{
    'errors': [
        {
            'UserStackAssociation': {
                'StackName': 'string',
                'UserName': 'string',
                'AuthenticationType': 'API'|'SAML'|'USERPOOL',
                'SendEmailNotification': True|False
            },
            'ErrorCode': 'STACK_NOT_FOUND'|'USER_NAME_NOT_FOUND'|'INTERNAL_ERROR',
            'ErrorMessage': 'string'
        },
    ]
}

Response Structure

  • (dict) --
    • errors (list) --

      The list of UserStackAssociationError objects.

      • (dict) --

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

        • UserStackAssociation (dict) --

          Information about the user and associated stack.

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

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

        • ErrorMessage (string) --

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

can_paginate(operation_name)

Check if an operation can be paginated.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns
True if the operation can be paginated, False otherwise.
copy_image(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.copy_image(
    SourceImageName='string',
    DestinationImageName='string',
    DestinationRegion='string',
    DestinationImageDescription='string'
)
Parameters
  • SourceImageName (string) --

    [REQUIRED]

    The name of the image to copy.

  • DestinationImageName (string) --

    [REQUIRED]

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

  • DestinationRegion (string) --

    [REQUIRED]

    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.
Return type

dict

Returns

Response Syntax

{
    'DestinationImageName': 'string'
}

Response Structure

  • (dict) --

    • DestinationImageName (string) --

      The name of the destination image.

create_directory_config(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.create_directory_config(
    DirectoryName='string',
    OrganizationalUnitDistinguishedNames=[
        'string',
    ],
    ServiceAccountCredentials={
        'AccountName': 'string',
        'AccountPassword': 'string'
    }
)
Parameters
  • DirectoryName (string) --

    [REQUIRED]

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

  • OrganizationalUnitDistinguishedNames (list) --

    [REQUIRED]

    The distinguished names of the organizational units for computer accounts.

    • (string) --
  • ServiceAccountCredentials (dict) --

    [REQUIRED]

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

    • AccountName (string) -- [REQUIRED]

      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 (string) -- [REQUIRED]

      The password for the account.

Return type

dict

Returns

Response Syntax

{
    'DirectoryConfig': {
        'DirectoryName': 'string',
        'OrganizationalUnitDistinguishedNames': [
            'string',
        ],
        'ServiceAccountCredentials': {
            'AccountName': 'string',
            'AccountPassword': 'string'
        },
        'CreatedTime': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) --

    • DirectoryConfig (dict) --

      Information about the directory configuration.

      • DirectoryName (string) --

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

      • OrganizationalUnitDistinguishedNames (list) --

        The distinguished names of the organizational units for computer accounts.

        • (string) --
      • ServiceAccountCredentials (dict) --

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

        • AccountName (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 (string) --

          The password for the account.

      • CreatedTime (datetime) --

        The time the directory configuration was created.

create_fleet(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.create_fleet(
    Name='string',
    ImageName='string',
    ImageArn='string',
    InstanceType='string',
    FleetType='ALWAYS_ON'|'ON_DEMAND',
    ComputeCapacity={
        'DesiredInstances': 123
    },
    VpcConfig={
        'SubnetIds': [
            'string',
        ],
        'SecurityGroupIds': [
            'string',
        ]
    },
    MaxUserDurationInSeconds=123,
    DisconnectTimeoutInSeconds=123,
    Description='string',
    DisplayName='string',
    EnableDefaultInternetAccess=True|False,
    DomainJoinInfo={
        'DirectoryName': 'string',
        'OrganizationalUnitDistinguishedName': 'string'
    }
)
Parameters
  • Name (string) --

    [REQUIRED]

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

    [REQUIRED]

    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.

  • ComputeCapacity (dict) --

    [REQUIRED]

    The desired capacity for the fleet.

    • DesiredInstances (integer) -- [REQUIRED]

      The desired number of streaming instances.

  • VpcConfig (dict) --

    The VPC configuration for the fleet.

    • SubnetIds (list) --

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

      • (string) --
    • SecurityGroupIds (list) --

      The security groups for the fleet.

      • (string) --
  • MaxUserDurationInSeconds (integer) -- The maximum time that a streaming session can run, in seconds. Specify a value between 600 and 57600.
  • DisconnectTimeoutInSeconds (integer) -- The time after disconnection when a session is considered to have ended, in seconds. If a user who was disconnected reconnects within this time interval, the user is connected to their previous session. Specify a value between 60 and 57600.
  • Description (string) -- The description for display.
  • DisplayName (string) -- The fleet name for display.
  • EnableDefaultInternetAccess (boolean) -- Enables or disables default internet access for the fleet.
  • DomainJoinInfo (dict) --

    The information needed to join 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.

Return type

dict

Returns

Response Syntax

{
    'Fleet': {
        'Arn': 'string',
        'Name': 'string',
        'DisplayName': 'string',
        'Description': 'string',
        'ImageName': 'string',
        'ImageArn': 'string',
        'InstanceType': 'string',
        'FleetType': 'ALWAYS_ON'|'ON_DEMAND',
        'ComputeCapacityStatus': {
            'Desired': 123,
            'Running': 123,
            'InUse': 123,
            'Available': 123
        },
        'MaxUserDurationInSeconds': 123,
        'DisconnectTimeoutInSeconds': 123,
        'State': 'STARTING'|'RUNNING'|'STOPPING'|'STOPPED',
        'VpcConfig': {
            'SubnetIds': [
                'string',
            ],
            'SecurityGroupIds': [
                'string',
            ]
        },
        'CreatedTime': datetime(2015, 1, 1),
        'FleetErrors': [
            {
                'ErrorCode': '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'
            },
        ],
        'EnableDefaultInternetAccess': True|False,
        'DomainJoinInfo': {
            'DirectoryName': 'string',
            'OrganizationalUnitDistinguishedName': 'string'
        }
    }
}

Response Structure

  • (dict) --

    • Fleet (dict) --

      Information about the fleet.

      • Arn (string) --

        The ARN for the fleet.

      • Name (string) --

        The name of the fleet.

      • DisplayName (string) --

        The fleet name for display.

      • Description (string) --

        The description for 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 (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.

      • ComputeCapacityStatus (dict) --

        The capacity status for the fleet.

        • Desired (integer) --

          The desired number of streaming instances.

        • Running (integer) --

          The total number of simultaneous streaming instances that are running.

        • InUse (integer) --

          The number of instances in use for streaming.

        • Available (integer) --

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

      • MaxUserDurationInSeconds (integer) --

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

      • DisconnectTimeoutInSeconds (integer) --

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

      • State (string) --

        The current state for the fleet.

      • VpcConfig (dict) --

        The VPC configuration for the fleet.

        • SubnetIds (list) --

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

          • (string) --
        • SecurityGroupIds (list) --

          The security groups for the fleet.

          • (string) --
      • CreatedTime (datetime) --

        The time the fleet was created.

      • FleetErrors (list) --

        The fleet errors.

        • (dict) --

          Describes a fleet error.

          • ErrorCode (string) --

            The error code.

          • ErrorMessage (string) --

            The error message.

      • EnableDefaultInternetAccess (boolean) --

        Indicates whether default internet access is enabled for the fleet.

      • DomainJoinInfo (dict) --

        The information needed to join 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.

create_image_builder(**kwargs)

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 .

See also: AWS API Documentation

Request Syntax

response = client.create_image_builder(
    Name='string',
    ImageName='string',
    ImageArn='string',
    InstanceType='string',
    Description='string',
    DisplayName='string',
    VpcConfig={
        'SubnetIds': [
            'string',
        ],
        'SecurityGroupIds': [
            'string',
        ]
    },
    EnableDefaultInternetAccess=True|False,
    DomainJoinInfo={
        'DirectoryName': 'string',
        'OrganizationalUnitDistinguishedName': 'string'
    },
    AppstreamAgentVersion='string'
)
Parameters
  • Name (string) --

    [REQUIRED]

    A unique name for the image builder.

  • ImageName (string) -- The name of the image used to create the builder.
  • ImageArn (string) -- The ARN of the public, private, or shared image to use.
  • InstanceType (string) --

    [REQUIRED]

    The instance type to use when launching the image builder.

  • Description (string) -- The description for display.
  • DisplayName (string) -- The image builder name for display.
  • VpcConfig (dict) --

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

    • SubnetIds (list) --

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

      • (string) --
    • SecurityGroupIds (list) --

      The security groups for the fleet.

      • (string) --
  • EnableDefaultInternetAccess (boolean) -- Enables or disables default internet access for the image builder.
  • DomainJoinInfo (dict) --

    The information needed to join 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].
Return type

dict

Returns

Response Syntax

{
    'ImageBuilder': {
        'Name': 'string',
        'Arn': 'string',
        'ImageArn': 'string',
        'Description': 'string',
        'DisplayName': 'string',
        'VpcConfig': {
            'SubnetIds': [
                'string',
            ],
            'SecurityGroupIds': [
                'string',
            ]
        },
        'InstanceType': 'string',
        'Platform': 'WINDOWS',
        'State': 'PENDING'|'UPDATING_AGENT'|'RUNNING'|'STOPPING'|'STOPPED'|'REBOOTING'|'SNAPSHOTTING'|'DELETING'|'FAILED',
        'StateChangeReason': {
            'Code': 'INTERNAL_ERROR'|'IMAGE_UNAVAILABLE',
            'Message': 'string'
        },
        'CreatedTime': datetime(2015, 1, 1),
        'EnableDefaultInternetAccess': True|False,
        'DomainJoinInfo': {
            'DirectoryName': 'string',
            'OrganizationalUnitDistinguishedName': 'string'
        },
        'ImageBuilderErrors': [
            {
                'ErrorCode': 'IAM_SERVICE_ROLE_MISSING_ENI_DESCRIBE_ACTION'|'IAM_SERVICE_ROLE_MISSING_ENI_CREATE_ACTION'|'IAM_SERVICE_ROLE_MISSING_ENI_DELETE_ACTION'|'NETWORK_INTERFACE_LIMIT_EXCEEDED'|'INTERNAL_SERVICE_ERROR'|'IAM_SERVICE_ROLE_IS_MISSING'|'SUBNET_HAS_INSUFFICIENT_IP_ADDRESSES'|'IAM_SERVICE_ROLE_MISSING_DESCRIBE_SUBNET_ACTION'|'SUBNET_NOT_FOUND'|'IMAGE_NOT_FOUND'|'INVALID_SUBNET_CONFIGURATION'|'SECURITY_GROUPS_NOT_FOUND'|'IGW_NOT_ATTACHED'|'IAM_SERVICE_ROLE_MISSING_DESCRIBE_SECURITY_GROUPS_ACTION'|'DOMAIN_JOIN_ERROR_FILE_NOT_FOUND'|'DOMAIN_JOIN_ERROR_ACCESS_DENIED'|'DOMAIN_JOIN_ERROR_LOGON_FAILURE'|'DOMAIN_JOIN_ERROR_INVALID_PARAMETER'|'DOMAIN_JOIN_ERROR_MORE_DATA'|'DOMAIN_JOIN_ERROR_NO_SUCH_DOMAIN'|'DOMAIN_JOIN_ERROR_NOT_SUPPORTED'|'DOMAIN_JOIN_NERR_INVALID_WORKGROUP_NAME'|'DOMAIN_JOIN_NERR_WORKSTATION_NOT_STARTED'|'DOMAIN_JOIN_ERROR_DS_MACHINE_ACCOUNT_QUOTA_EXCEEDED'|'DOMAIN_JOIN_NERR_PASSWORD_EXPIRED'|'DOMAIN_JOIN_INTERNAL_SERVICE_ERROR',
                'ErrorMessage': 'string',
                'ErrorTimestamp': datetime(2015, 1, 1)
            },
        ],
        'AppstreamAgentVersion': 'string'
    }
}

Response Structure

  • (dict) --

    • ImageBuilder (dict) --

      Information about the image builder.

      • Name (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 for display.

      • DisplayName (string) --

        The image builder name for display.

      • VpcConfig (dict) --

        The VPC configuration of the image builder.

        • SubnetIds (list) --

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

          • (string) --
        • SecurityGroupIds (list) --

          The security groups for the fleet.

          • (string) --
      • InstanceType (string) --

        The instance type for the image builder.

      • Platform (string) --

        The operating system platform of the image builder.

      • State (string) --

        The state of the image builder.

      • StateChangeReason (dict) --

        The reason why the last state change occurred.

        • Code (string) --

          The state change reason code.

        • Message (string) --

          The state change reason message.

      • CreatedTime (datetime) --

        The time stamp when the image builder was created.

      • EnableDefaultInternetAccess (boolean) --

        Enables or disables default internet access for the image builder.

      • DomainJoinInfo (dict) --

        The information needed to join 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 (list) --

        The image builder errors.

        • (dict) --

          Describes a resource error.

          • ErrorCode (string) --

            The error code.

          • ErrorMessage (string) --

            The error message.

          • ErrorTimestamp (datetime) --

            The time the error occurred.

      • AppstreamAgentVersion (string) --

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

create_image_builder_streaming_url(**kwargs)

Creates a URL to start an image builder streaming session.

See also: AWS API Documentation

Request Syntax

response = client.create_image_builder_streaming_url(
    Name='string',
    Validity=123
)
Parameters
  • Name (string) --

    [REQUIRED]

    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.
Return type

dict

Returns

Response Syntax

{
    'StreamingURL': 'string',
    'Expires': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --

    • StreamingURL (string) --

      The URL to start the AppStream 2.0 streaming session.

    • Expires (datetime) --

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

create_stack(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.create_stack(
    Name='string',
    Description='string',
    DisplayName='string',
    StorageConnectors=[
        {
            'ConnectorType': 'HOMEFOLDERS'|'GOOGLE_DRIVE'|'ONE_DRIVE',
            'ResourceIdentifier': 'string',
            'Domains': [
                'string',
            ]
        },
    ],
    RedirectURL='string',
    FeedbackURL='string',
    UserSettings=[
        {
            'Action': 'CLIPBOARD_COPY_FROM_LOCAL_DEVICE'|'CLIPBOARD_COPY_TO_LOCAL_DEVICE'|'FILE_UPLOAD'|'FILE_DOWNLOAD'|'PRINTING_TO_LOCAL_DEVICE',
            'Permission': 'ENABLED'|'DISABLED'
        },
    ],
    ApplicationSettings={
        'Enabled': True|False,
        'SettingsGroup': 'string'
    }
)
Parameters
  • Name (string) --

    [REQUIRED]

    The name of the stack.

  • Description (string) -- The description for display.
  • DisplayName (string) -- The stack name for display.
  • StorageConnectors (list) --

    The storage connectors to enable.

    • (dict) --

      Describes a connector to enable persistent storage for users.

      • ConnectorType (string) -- [REQUIRED]

        The type of storage connector.

      • ResourceIdentifier (string) --

        The ARN of the storage connector.

      • Domains (list) --

        The names of the domains for the G Suite account.

        • (string) -- GSuite domain for GDrive integration.
  • 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 (list) --

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

    • (dict) --

      Describes an action and whether the action is enabled or disabled for users during their streaming sessions.

      • Action (string) -- [REQUIRED]

        The action that is enabled or disabled.

      • Permission (string) -- [REQUIRED]

        Indicates whether the action is enabled or disabled.

  • ApplicationSettings (dict) --

    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 (boolean) -- [REQUIRED]

      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.

Return type

dict

Returns

Response Syntax

{
    'Stack': {
        'Arn': 'string',
        'Name': 'string',
        'Description': 'string',
        'DisplayName': 'string',
        'CreatedTime': datetime(2015, 1, 1),
        'StorageConnectors': [
            {
                'ConnectorType': 'HOMEFOLDERS'|'GOOGLE_DRIVE'|'ONE_DRIVE',
                'ResourceIdentifier': 'string',
                'Domains': [
                    'string',
                ]
            },
        ],
        'RedirectURL': 'string',
        'FeedbackURL': 'string',
        'StackErrors': [
            {
                'ErrorCode': 'STORAGE_CONNECTOR_ERROR'|'INTERNAL_SERVICE_ERROR',
                'ErrorMessage': 'string'
            },
        ],
        'UserSettings': [
            {
                'Action': 'CLIPBOARD_COPY_FROM_LOCAL_DEVICE'|'CLIPBOARD_COPY_TO_LOCAL_DEVICE'|'FILE_UPLOAD'|'FILE_DOWNLOAD'|'PRINTING_TO_LOCAL_DEVICE',
                'Permission': 'ENABLED'|'DISABLED'
            },
        ],
        'ApplicationSettings': {
            'Enabled': True|False,
            'SettingsGroup': 'string',
            'S3BucketName': 'string'
        }
    }
}

Response Structure

  • (dict) --

    • Stack (dict) --

      Information about the stack.

      • Arn (string) --

        The ARN of the stack.

      • Name (string) --

        The name of the stack.

      • Description (string) --

        The description for display.

      • DisplayName (string) --

        The stack name for display.

      • CreatedTime (datetime) --

        The time the stack was created.

      • StorageConnectors (list) --

        The storage connectors to enable.

        • (dict) --

          Describes a connector to enable persistent storage for users.

          • ConnectorType (string) --

            The type of storage connector.

          • ResourceIdentifier (string) --

            The ARN of the storage connector.

          • Domains (list) --

            The names of the domains for the G Suite account.

            • (string) -- GSuite domain for GDrive integration.
      • 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 (list) --

        The errors for the stack.

        • (dict) --

          Describes a stack error.

          • ErrorCode (string) --

            The error code.

          • ErrorMessage (string) --

            The error message.

      • UserSettings (list) --

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

        • (dict) --

          Describes an action and whether the action is enabled or disabled for users during their streaming sessions.

          • Action (string) --

            The action that is enabled or disabled.

          • Permission (string) --

            Indicates whether the action is enabled or disabled.

      • ApplicationSettings (dict) --

        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.

create_streaming_url(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.create_streaming_url(
    StackName='string',
    FleetName='string',
    UserId='string',
    ApplicationId='string',
    Validity=123,
    SessionContext='string'
)
Parameters
  • StackName (string) --

    [REQUIRED]

    The name of the stack.

  • FleetName (string) --

    [REQUIRED]

    The name of the fleet.

  • UserId (string) --

    [REQUIRED]

    The ID 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 .
Return type

dict

Returns

Response Syntax

{
    'StreamingURL': 'string',
    'Expires': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --

    • StreamingURL (string) --

      The URL to start the AppStream 2.0 streaming session.

    • Expires (datetime) --

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

create_user(**kwargs)

Creates a new user in the user pool.

See also: AWS API Documentation

Request Syntax

response = client.create_user(
    UserName='string',
    MessageAction='SUPPRESS'|'RESEND',
    FirstName='string',
    LastName='string',
    AuthenticationType='API'|'SAML'|'USERPOOL'
)
Parameters
  • UserName (string) --

    [REQUIRED]

    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.

  • FirstName (string) -- The first name, or given name, of the user.
  • LastName (string) -- The last name, or surname, of the user.
  • AuthenticationType (string) --

    [REQUIRED]

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

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

delete_directory_config(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.delete_directory_config(
    DirectoryName='string'
)
Parameters
DirectoryName (string) --

[REQUIRED]

The name of the directory configuration.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --
delete_fleet(**kwargs)

Deletes the specified fleet.

See also: AWS API Documentation

Request Syntax

response = client.delete_fleet(
    Name='string'
)
Parameters
Name (string) --

[REQUIRED]

The name of the fleet.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --
delete_image(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.delete_image(
    Name='string'
)
Parameters
Name (string) --

[REQUIRED]

The name of the image.

Return type
dict
Returns
Response Syntax
{
    'Image': {
        'Name': 'string',
        'Arn': 'string',
        'BaseImageArn': 'string',
        'DisplayName': 'string',
        'State': 'PENDING'|'AVAILABLE'|'FAILED'|'COPYING'|'DELETING',
        'Visibility': 'PUBLIC'|'PRIVATE'|'SHARED',
        'ImageBuilderSupported': True|False,
        'Platform': 'WINDOWS',
        'Description': 'string',
        'StateChangeReason': {
            'Code': 'INTERNAL_ERROR'|'IMAGE_BUILDER_NOT_AVAILABLE'|'IMAGE_COPY_FAILURE',
            'Message': 'string'
        },
        'Applications': [
            {
                'Name': 'string',
                'DisplayName': 'string',
                'IconURL': 'string',
                'LaunchPath': 'string',
                'LaunchParameters': 'string',
                'Enabled': True|False,
                'Metadata': {
                    'string': 'string'
                }
            },
        ],
        'CreatedTime': datetime(2015, 1, 1),
        'PublicBaseImageReleasedDate': datetime(2015, 1, 1),
        'AppstreamAgentVersion': 'string',
        'ImagePermissions': {
            'allowFleet': True|False,
            'allowImageBuilder': True|False
        }
    }
}

Response Structure

  • (dict) --
    • Image (dict) --

      Information about the image.

      • Name (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 for 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 .

      • Visibility (string) --

        Indicates whether the image is public or private.

      • ImageBuilderSupported (boolean) --

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

      • Platform (string) --

        The operating system platform of the image.

      • Description (string) --

        The description for display.

      • StateChangeReason (dict) --

        The reason why the last state change occurred.

        • Code (string) --

          The state change reason code.

        • Message (string) --

          The state change reason message.

      • Applications (list) --

        The applications associated with the image.

        • (dict) --

          Describes an application in the application catalog.

          • Name (string) --

            The name of the application.

          • DisplayName (string) --

            The application name for 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 (dict) --

            Additional attributes that describe the application.

            • (string) --
              • (string) --
      • CreatedTime (datetime) --

        The time the image was created.

      • PublicBaseImageReleasedDate (datetime) --

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

        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.

delete_image_builder(**kwargs)

Deletes the specified image builder and releases the capacity.

See also: AWS API Documentation

Request Syntax

response = client.delete_image_builder(
    Name='string'
)
Parameters
Name (string) --

[REQUIRED]

The name of the image builder.

Return type
dict
Returns
Response Syntax
{
    'ImageBuilder': {
        'Name': 'string',
        'Arn': 'string',
        'ImageArn': 'string',
        'Description': 'string',
        'DisplayName': 'string',
        'VpcConfig': {
            'SubnetIds': [
                'string',
            ],
            'SecurityGroupIds': [
                'string',
            ]
        },
        'InstanceType': 'string',
        'Platform': 'WINDOWS',
        'State': 'PENDING'|'UPDATING_AGENT'|'RUNNING'|'STOPPING'|'STOPPED'|'REBOOTING'|'SNAPSHOTTING'|'DELETING'|'FAILED',
        'StateChangeReason': {
            'Code': 'INTERNAL_ERROR'|'IMAGE_UNAVAILABLE',
            'Message': 'string'
        },
        'CreatedTime': datetime(2015, 1, 1),
        'EnableDefaultInternetAccess': True|False,
        'DomainJoinInfo': {
            'DirectoryName': 'string',
            'OrganizationalUnitDistinguishedName': 'string'
        },
        'ImageBuilderErrors': [
            {
                'ErrorCode': 'IAM_SERVICE_ROLE_MISSING_ENI_DESCRIBE_ACTION'|'IAM_SERVICE_ROLE_MISSING_ENI_CREATE_ACTION'|'IAM_SERVICE_ROLE_MISSING_ENI_DELETE_ACTION'|'NETWORK_INTERFACE_LIMIT_EXCEEDED'|'INTERNAL_SERVICE_ERROR'|'IAM_SERVICE_ROLE_IS_MISSING'|'SUBNET_HAS_INSUFFICIENT_IP_ADDRESSES'|'IAM_SERVICE_ROLE_MISSING_DESCRIBE_SUBNET_ACTION'|'SUBNET_NOT_FOUND'|'IMAGE_NOT_FOUND'|'INVALID_SUBNET_CONFIGURATION'|'SECURITY_GROUPS_NOT_FOUND'|'IGW_NOT_ATTACHED'|'IAM_SERVICE_ROLE_MISSING_DESCRIBE_SECURITY_GROUPS_ACTION'|'DOMAIN_JOIN_ERROR_FILE_NOT_FOUND'|'DOMAIN_JOIN_ERROR_ACCESS_DENIED'|'DOMAIN_JOIN_ERROR_LOGON_FAILURE'|'DOMAIN_JOIN_ERROR_INVALID_PARAMETER'|'DOMAIN_JOIN_ERROR_MORE_DATA'|'DOMAIN_JOIN_ERROR_NO_SUCH_DOMAIN'|'DOMAIN_JOIN_ERROR_NOT_SUPPORTED'|'DOMAIN_JOIN_NERR_INVALID_WORKGROUP_NAME'|'DOMAIN_JOIN_NERR_WORKSTATION_NOT_STARTED'|'DOMAIN_JOIN_ERROR_DS_MACHINE_ACCOUNT_QUOTA_EXCEEDED'|'DOMAIN_JOIN_NERR_PASSWORD_EXPIRED'|'DOMAIN_JOIN_INTERNAL_SERVICE_ERROR',
                'ErrorMessage': 'string',
                'ErrorTimestamp': datetime(2015, 1, 1)
            },
        ],
        'AppstreamAgentVersion': 'string'
    }
}

Response Structure

  • (dict) --
    • ImageBuilder (dict) --

      Information about the image builder.

      • Name (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 for display.

      • DisplayName (string) --

        The image builder name for display.

      • VpcConfig (dict) --

        The VPC configuration of the image builder.

        • SubnetIds (list) --

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

          • (string) --
        • SecurityGroupIds (list) --

          The security groups for the fleet.

          • (string) --
      • InstanceType (string) --

        The instance type for the image builder.

      • Platform (string) --

        The operating system platform of the image builder.

      • State (string) --

        The state of the image builder.

      • StateChangeReason (dict) --

        The reason why the last state change occurred.

        • Code (string) --

          The state change reason code.

        • Message (string) --

          The state change reason message.

      • CreatedTime (datetime) --

        The time stamp when the image builder was created.

      • EnableDefaultInternetAccess (boolean) --

        Enables or disables default internet access for the image builder.

      • DomainJoinInfo (dict) --

        The information needed to join 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 (list) --

        The image builder errors.

        • (dict) --

          Describes a resource error.

          • ErrorCode (string) --

            The error code.

          • ErrorMessage (string) --

            The error message.

          • ErrorTimestamp (datetime) --

            The time the error occurred.

      • AppstreamAgentVersion (string) --

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

delete_image_permissions(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.delete_image_permissions(
    Name='string',
    SharedAccountId='string'
)
Parameters
  • Name (string) --

    [REQUIRED]

    The name of the private image.

  • SharedAccountId (string) --

    [REQUIRED]

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

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

delete_stack(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.delete_stack(
    Name='string'
)
Parameters
Name (string) --

[REQUIRED]

The name of the stack.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --
delete_user(**kwargs)

Deletes a user from the user pool.

See also: AWS API Documentation

Request Syntax

response = client.delete_user(
    UserName='string',
    AuthenticationType='API'|'SAML'|'USERPOOL'
)
Parameters
  • UserName (string) --

    [REQUIRED]

    The email address of the user.

  • AuthenticationType (string) --

    [REQUIRED]

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

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

describe_directory_configs(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.describe_directory_configs(
    DirectoryNames=[
        'string',
    ],
    MaxResults=123,
    NextToken='string'
)
Parameters
  • DirectoryNames (list) --

    The directory names.

    • (string) --
  • 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.
Return type

dict

Returns

Response Syntax

{
    'DirectoryConfigs': [
        {
            'DirectoryName': 'string',
            'OrganizationalUnitDistinguishedNames': [
                'string',
            ],
            'ServiceAccountCredentials': {
                'AccountName': 'string',
                'AccountPassword': 'string'
            },
            'CreatedTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • DirectoryConfigs (list) --

      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.

      • (dict) --

        Configuration information for the directory used to join domains.

        • DirectoryName (string) --

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

        • OrganizationalUnitDistinguishedNames (list) --

          The distinguished names of the organizational units for computer accounts.

          • (string) --
        • ServiceAccountCredentials (dict) --

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

          • AccountName (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 (string) --

            The password for the account.

        • CreatedTime (datetime) --

          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.

describe_fleets(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.describe_fleets(
    Names=[
        'string',
    ],
    NextToken='string'
)
Parameters
  • Names (list) --

    The names of the fleets to describe.

    • (string) --
  • 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.
Return type

dict

Returns

Response Syntax

{
    'Fleets': [
        {
            'Arn': 'string',
            'Name': 'string',
            'DisplayName': 'string',
            'Description': 'string',
            'ImageName': 'string',
            'ImageArn': 'string',
            'InstanceType': 'string',
            'FleetType': 'ALWAYS_ON'|'ON_DEMAND',
            'ComputeCapacityStatus': {
                'Desired': 123,
                'Running': 123,
                'InUse': 123,
                'Available': 123
            },
            'MaxUserDurationInSeconds': 123,
            'DisconnectTimeoutInSeconds': 123,
            'State': 'STARTING'|'RUNNING'|'STOPPING'|'STOPPED',
            'VpcConfig': {
                'SubnetIds': [
                    'string',
                ],
                'SecurityGroupIds': [
                    'string',
                ]
            },
            'CreatedTime': datetime(2015, 1, 1),
            'FleetErrors': [
                {
                    'ErrorCode': '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'
                },
            ],
            'EnableDefaultInternetAccess': True|False,
            'DomainJoinInfo': {
                'DirectoryName': 'string',
                'OrganizationalUnitDistinguishedName': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Fleets (list) --

      Information about the fleets.

      • (dict) --

        Contains the parameters for a fleet.

        • Arn (string) --

          The ARN for the fleet.

        • Name (string) --

          The name of the fleet.

        • DisplayName (string) --

          The fleet name for display.

        • Description (string) --

          The description for 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 (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.

        • ComputeCapacityStatus (dict) --

          The capacity status for the fleet.

          • Desired (integer) --

            The desired number of streaming instances.

          • Running (integer) --

            The total number of simultaneous streaming instances that are running.

          • InUse (integer) --

            The number of instances in use for streaming.

          • Available (integer) --

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

        • MaxUserDurationInSeconds (integer) --

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

        • DisconnectTimeoutInSeconds (integer) --

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

        • State (string) --

          The current state for the fleet.

        • VpcConfig (dict) --

          The VPC configuration for the fleet.

          • SubnetIds (list) --

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

            • (string) --
          • SecurityGroupIds (list) --

            The security groups for the fleet.

            • (string) --
        • CreatedTime (datetime) --

          The time the fleet was created.

        • FleetErrors (list) --

          The fleet errors.

          • (dict) --

            Describes a fleet error.

            • ErrorCode (string) --

              The error code.

            • ErrorMessage (string) --

              The error message.

        • EnableDefaultInternetAccess (boolean) --

          Indicates whether default internet access is enabled for the fleet.

        • DomainJoinInfo (dict) --

          The information needed to join 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.

describe_image_builders(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.describe_image_builders(
    Names=[
        'string',
    ],
    MaxResults=123,
    NextToken='string'
)
Parameters
  • Names (list) --

    The names of the image builders to describe.

    • (string) --
  • 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.
Return type

dict

Returns

Response Syntax

{
    'ImageBuilders': [
        {
            'Name': 'string',
            'Arn': 'string',
            'ImageArn': 'string',
            'Description': 'string',
            'DisplayName': 'string',
            'VpcConfig': {
                'SubnetIds': [
                    'string',
                ],
                'SecurityGroupIds': [
                    'string',
                ]
            },
            'InstanceType': 'string',
            'Platform': 'WINDOWS',
            'State': 'PENDING'|'UPDATING_AGENT'|'RUNNING'|'STOPPING'|'STOPPED'|'REBOOTING'|'SNAPSHOTTING'|'DELETING'|'FAILED',
            'StateChangeReason': {
                'Code': 'INTERNAL_ERROR'|'IMAGE_UNAVAILABLE',
                'Message': 'string'
            },
            'CreatedTime': datetime(2015, 1, 1),
            'EnableDefaultInternetAccess': True|False,
            'DomainJoinInfo': {
                'DirectoryName': 'string',
                'OrganizationalUnitDistinguishedName': 'string'
            },
            'ImageBuilderErrors': [
                {
                    'ErrorCode': 'IAM_SERVICE_ROLE_MISSING_ENI_DESCRIBE_ACTION'|'IAM_SERVICE_ROLE_MISSING_ENI_CREATE_ACTION'|'IAM_SERVICE_ROLE_MISSING_ENI_DELETE_ACTION'|'NETWORK_INTERFACE_LIMIT_EXCEEDED'|'INTERNAL_SERVICE_ERROR'|'IAM_SERVICE_ROLE_IS_MISSING'|'SUBNET_HAS_INSUFFICIENT_IP_ADDRESSES'|'IAM_SERVICE_ROLE_MISSING_DESCRIBE_SUBNET_ACTION'|'SUBNET_NOT_FOUND'|'IMAGE_NOT_FOUND'|'INVALID_SUBNET_CONFIGURATION'|'SECURITY_GROUPS_NOT_FOUND'|'IGW_NOT_ATTACHED'|'IAM_SERVICE_ROLE_MISSING_DESCRIBE_SECURITY_GROUPS_ACTION'|'DOMAIN_JOIN_ERROR_FILE_NOT_FOUND'|'DOMAIN_JOIN_ERROR_ACCESS_DENIED'|'DOMAIN_JOIN_ERROR_LOGON_FAILURE'|'DOMAIN_JOIN_ERROR_INVALID_PARAMETER'|'DOMAIN_JOIN_ERROR_MORE_DATA'|'DOMAIN_JOIN_ERROR_NO_SUCH_DOMAIN'|'DOMAIN_JOIN_ERROR_NOT_SUPPORTED'|'DOMAIN_JOIN_NERR_INVALID_WORKGROUP_NAME'|'DOMAIN_JOIN_NERR_WORKSTATION_NOT_STARTED'|'DOMAIN_JOIN_ERROR_DS_MACHINE_ACCOUNT_QUOTA_EXCEEDED'|'DOMAIN_JOIN_NERR_PASSWORD_EXPIRED'|'DOMAIN_JOIN_INTERNAL_SERVICE_ERROR',
                    'ErrorMessage': 'string',
                    'ErrorTimestamp': datetime(2015, 1, 1)
                },
            ],
            'AppstreamAgentVersion': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • ImageBuilders (list) --

      Information about the image builders.

      • (dict) --

        Describes a streaming instance used for editing an image. New images are created from a snapshot through an image builder.

        • Name (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 for display.

        • DisplayName (string) --

          The image builder name for display.

        • VpcConfig (dict) --

          The VPC configuration of the image builder.

          • SubnetIds (list) --

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

            • (string) --
          • SecurityGroupIds (list) --

            The security groups for the fleet.

            • (string) --
        • InstanceType (string) --

          The instance type for the image builder.

        • Platform (string) --

          The operating system platform of the image builder.

        • State (string) --

          The state of the image builder.

        • StateChangeReason (dict) --

          The reason why the last state change occurred.

          • Code (string) --

            The state change reason code.

          • Message (string) --

            The state change reason message.

        • CreatedTime (datetime) --

          The time stamp when the image builder was created.

        • EnableDefaultInternetAccess (boolean) --

          Enables or disables default internet access for the image builder.

        • DomainJoinInfo (dict) --

          The information needed to join 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 (list) --

          The image builder errors.

          • (dict) --

            Describes a resource error.

            • ErrorCode (string) --

              The error code.

            • ErrorMessage (string) --

              The error message.

            • ErrorTimestamp (datetime) --

              The time the error occurred.

        • AppstreamAgentVersion (string) --

          The version of the AppStream 2.0 agent that is currently being used by this 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.

describe_image_permissions(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.describe_image_permissions(
    Name='string',
    MaxResults=123,
    SharedAwsAccountIds=[
        'string',
    ],
    NextToken='string'
)
Parameters
  • Name (string) --

    [REQUIRED]

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

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

    • (string) --
  • 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.
Return type

dict

Returns

Response Syntax

{
    'Name': 'string',
    'SharedImagePermissionsList': [
        {
            'sharedAccountId': 'string',
            'imagePermissions': {
                'allowFleet': True|False,
                'allowImageBuilder': True|False
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Name (string) --

      The name of the private image.

    • SharedImagePermissionsList (list) --

      The permissions for a private image that you own.

      • (dict) --

        Describes the permissions that are available to the specified AWS account for a shared image.

        • sharedAccountId (string) --

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

        • imagePermissions (dict) --

          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.

describe_images(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.describe_images(
    Names=[
        'string',
    ],
    Arns=[
        'string',
    ],
    Type='PUBLIC'|'PRIVATE'|'SHARED',
    NextToken='string',
    MaxResults=123
)
Parameters
  • Names (list) --

    The names of the public or private images to describe.

    • (string) --
  • Arns (list) --

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

    • (string) --
  • Type (string) -- The type of image (public, private, or shared) 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.
  • MaxResults (integer) -- The maximum size of each page of results.
Return type

dict

Returns

Response Syntax

{
    'Images': [
        {
            'Name': 'string',
            'Arn': 'string',
            'BaseImageArn': 'string',
            'DisplayName': 'string',
            'State': 'PENDING'|'AVAILABLE'|'FAILED'|'COPYING'|'DELETING',
            'Visibility': 'PUBLIC'|'PRIVATE'|'SHARED',
            'ImageBuilderSupported': True|False,
            'Platform': 'WINDOWS',
            'Description': 'string',
            'StateChangeReason': {
                'Code': 'INTERNAL_ERROR'|'IMAGE_BUILDER_NOT_AVAILABLE'|'IMAGE_COPY_FAILURE',
                'Message': 'string'
            },
            'Applications': [
                {
                    'Name': 'string',
                    'DisplayName': 'string',
                    'IconURL': 'string',
                    'LaunchPath': 'string',
                    'LaunchParameters': 'string',
                    'Enabled': True|False,
                    'Metadata': {
                        'string': 'string'
                    }
                },
            ],
            'CreatedTime': datetime(2015, 1, 1),
            'PublicBaseImageReleasedDate': datetime(2015, 1, 1),
            'AppstreamAgentVersion': 'string',
            'ImagePermissions': {
                'allowFleet': True|False,
                'allowImageBuilder': True|False
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Images (list) --

      Information about the images.

      • (dict) --

        Describes an image.

        • Name (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 for 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 .

        • Visibility (string) --

          Indicates whether the image is public or private.

        • ImageBuilderSupported (boolean) --

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

        • Platform (string) --

          The operating system platform of the image.

        • Description (string) --

          The description for display.

        • StateChangeReason (dict) --

          The reason why the last state change occurred.

          • Code (string) --

            The state change reason code.

          • Message (string) --

            The state change reason message.

        • Applications (list) --

          The applications associated with the image.

          • (dict) --

            Describes an application in the application catalog.

            • Name (string) --

              The name of the application.

            • DisplayName (string) --

              The application name for 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 (dict) --

              Additional attributes that describe the application.

              • (string) --
                • (string) --
        • CreatedTime (datetime) --

          The time the image was created.

        • PublicBaseImageReleasedDate (datetime) --

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

          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.

describe_sessions(**kwargs)

Retrieves a list that describes the streaming sessions for a specified stack and fleet. If a user ID 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.

See also: AWS API Documentation

Request Syntax

response = client.describe_sessions(
    StackName='string',
    FleetName='string',
    UserId='string',
    NextToken='string',
    Limit=123,
    AuthenticationType='API'|'SAML'|'USERPOOL'
)
Parameters
  • StackName (string) --

    [REQUIRED]

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

  • FleetName (string) --

    [REQUIRED]

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

  • UserId (string) -- The user ID.
  • NextToken (string) -- The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
  • Limit (integer) -- The size of each page of results. The default value is 20 and the maximum value is 50.
  • AuthenticationType (string) -- The authentication method. Specify API for a user authenticated using a streaming URL or SAML for a SAML federated user. The default is to authenticate users using a streaming URL.
Return type

dict

Returns

Response Syntax

{
    'Sessions': [
        {
            'Id': 'string',
            'UserId': 'string',
            'StackName': 'string',
            'FleetName': 'string',
            'State': 'ACTIVE'|'PENDING'|'EXPIRED',
            'AuthenticationType': 'API'|'SAML'|'USERPOOL',
            'NetworkAccessConfiguration': {
                'EniPrivateIpAddress': 'string',
                'EniId': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Sessions (list) --

      Information about the streaming sessions.

      • (dict) --

        Describes a streaming session.

        • Id (string) --

          The ID of the streaming session.

        • UserId (string) --

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

        • StackName (string) --

          The name of the stack for the streaming session.

        • FleetName (string) --

          The name of the fleet for the streaming session.

        • State (string) --

          The current state of the streaming session.

        • AuthenticationType (string) --

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

        • NetworkAccessConfiguration (dict) --

          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.

describe_stacks(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.describe_stacks(
    Names=[
        'string',
    ],
    NextToken='string'
)
Parameters
  • Names (list) --

    The names of the stacks to describe.

    • (string) --
  • 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.
Return type

dict

Returns

Response Syntax

{
    'Stacks': [
        {
            'Arn': 'string',
            'Name': 'string',
            'Description': 'string',
            'DisplayName': 'string',
            'CreatedTime': datetime(2015, 1, 1),
            'StorageConnectors': [
                {
                    'ConnectorType': 'HOMEFOLDERS'|'GOOGLE_DRIVE'|'ONE_DRIVE',
                    'ResourceIdentifier': 'string',
                    'Domains': [
                        'string',
                    ]
                },
            ],
            'RedirectURL': 'string',
            'FeedbackURL': 'string',
            'StackErrors': [
                {
                    'ErrorCode': 'STORAGE_CONNECTOR_ERROR'|'INTERNAL_SERVICE_ERROR',
                    'ErrorMessage': 'string'
                },
            ],
            'UserSettings': [
                {
                    'Action': 'CLIPBOARD_COPY_FROM_LOCAL_DEVICE'|'CLIPBOARD_COPY_TO_LOCAL_DEVICE'|'FILE_UPLOAD'|'FILE_DOWNLOAD'|'PRINTING_TO_LOCAL_DEVICE',
                    'Permission': 'ENABLED'|'DISABLED'
                },
            ],
            'ApplicationSettings': {
                'Enabled': True|False,
                'SettingsGroup': 'string',
                'S3BucketName': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Stacks (list) --

      Information about the stacks.

      • (dict) --

        Describes a stack.

        • Arn (string) --

          The ARN of the stack.

        • Name (string) --

          The name of the stack.

        • Description (string) --

          The description for display.

        • DisplayName (string) --

          The stack name for display.

        • CreatedTime (datetime) --

          The time the stack was created.

        • StorageConnectors (list) --

          The storage connectors to enable.

          • (dict) --

            Describes a connector to enable persistent storage for users.

            • ConnectorType (string) --

              The type of storage connector.

            • ResourceIdentifier (string) --

              The ARN of the storage connector.

            • Domains (list) --

              The names of the domains for the G Suite account.

              • (string) -- GSuite domain for GDrive integration.
        • 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 (list) --

          The errors for the stack.

          • (dict) --

            Describes a stack error.

            • ErrorCode (string) --

              The error code.

            • ErrorMessage (string) --

              The error message.

        • UserSettings (list) --

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

          • (dict) --

            Describes an action and whether the action is enabled or disabled for users during their streaming sessions.

            • Action (string) --

              The action that is enabled or disabled.

            • Permission (string) --

              Indicates whether the action is enabled or disabled.

        • ApplicationSettings (dict) --

          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.

describe_user_stack_associations(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.describe_user_stack_associations(
    StackName='string',
    UserName='string',
    AuthenticationType='API'|'SAML'|'USERPOOL',
    MaxResults=123,
    NextToken='string'
)
Parameters
  • 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.
  • 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.
Return type

dict

Returns

Response Syntax

{
    'UserStackAssociations': [
        {
            'StackName': 'string',
            'UserName': 'string',
            'AuthenticationType': 'API'|'SAML'|'USERPOOL',
            'SendEmailNotification': True|False
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • UserStackAssociations (list) --

      The UserStackAssociation objects.

      • (dict) --

        Describes a user in the user pool and the associated stack.

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

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

describe_users(**kwargs)

Retrieves a list that describes one or more specified users in the user pool, if user names are provided. Otherwise, all users in the user pool are described.

See also: AWS API Documentation

Request Syntax

response = client.describe_users(
    AuthenticationType='API'|'SAML'|'USERPOOL',
    MaxResults=123,
    NextToken='string'
)
Parameters
  • AuthenticationType (string) --

    [REQUIRED]

    The authentication type for the users in the user pool to describe. You must specify 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.
Return type

dict

Returns

Response Syntax

{
    'Users': [
        {
            'Arn': 'string',
            'UserName': 'string',
            'Enabled': True|False,
            'Status': 'string',
            'FirstName': 'string',
            'LastName': 'string',
            'CreatedTime': datetime(2015, 1, 1),
            'AuthenticationType': 'API'|'SAML'|'USERPOOL'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Users (list) --

      Information about users in the user pool.

      • (dict) --

        Describes a user 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 (datetime) --

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

        • AuthenticationType (string) --

          The authentication type for the user.

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

disable_user(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.disable_user(
    UserName='string',
    AuthenticationType='API'|'SAML'|'USERPOOL'
)
Parameters
  • UserName (string) --

    [REQUIRED]

    The email address of the user.

  • AuthenticationType (string) --

    [REQUIRED]

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

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

disassociate_fleet(**kwargs)

Disassociates the specified fleet from the specified stack.

See also: AWS API Documentation

Request Syntax

response = client.disassociate_fleet(
    FleetName='string',
    StackName='string'
)
Parameters
  • FleetName (string) --

    [REQUIRED]

    The name of the fleet.

  • StackName (string) --

    [REQUIRED]

    The name of the stack.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

enable_user(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.enable_user(
    UserName='string',
    AuthenticationType='API'|'SAML'|'USERPOOL'
)
Parameters
  • UserName (string) --

    [REQUIRED]

    The email address of the user.

  • AuthenticationType (string) --

    [REQUIRED]

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

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

expire_session(**kwargs)

Immediately stops the specified streaming session.

See also: AWS API Documentation

Request Syntax

response = client.expire_session(
    SessionId='string'
)
Parameters
SessionId (string) --

[REQUIRED]

The ID of the streaming session.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --
generate_presigned_url(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)

Generate a presigned url given a client, its method, and arguments

Parameters
  • ClientMethod (string) -- The client method to presign for
  • Params (dict) -- The parameters normally passed to ClientMethod.
  • ExpiresIn (int) -- The number of seconds the presigned url is valid for. By default it expires in an hour (3600 seconds)
  • HttpMethod (string) -- The http method to use on the generated url. By default, the http method is whatever is used in the method's model.
Returns

The presigned url

get_paginator(operation_name)

Create a paginator for an operation.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Raises OperationNotPageableError
Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type
L{botocore.paginate.Paginator}
Returns
A paginator object.
get_waiter(waiter_name)

Returns an object that can wait for some condition.

Parameters
waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns
The specified waiter object.
Return type
botocore.waiter.Waiter
list_associated_fleets(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.list_associated_fleets(
    StackName='string',
    NextToken='string'
)
Parameters
  • StackName (string) --

    [REQUIRED]

    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.
Return type

dict

Returns

Response Syntax

{
    'Names': [
        'string',
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Names (list) --

      The name of the fleet.

      • (string) --
    • 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.

list_associated_stacks(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.list_associated_stacks(
    FleetName='string',
    NextToken='string'
)
Parameters
  • FleetName (string) --

    [REQUIRED]

    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.
Return type

dict

Returns

Response Syntax

{
    'Names': [
        'string',
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Names (list) --

      The name of the stack.

      • (string) --
    • 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.

list_tags_for_resource(**kwargs)

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 .

See also: AWS API Documentation

Request Syntax

response = client.list_tags_for_resource(
    ResourceArn='string'
)
Parameters
ResourceArn (string) --

[REQUIRED]

The Amazon Resource Name (ARN) of the resource.

Return type
dict
Returns
Response Syntax
{
    'Tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --
    • Tags (dict) --

      The information about the tags.

      • (string) --
        • (string) --
start_fleet(**kwargs)

Starts the specified fleet.

See also: AWS API Documentation

Request Syntax

response = client.start_fleet(
    Name='string'
)
Parameters
Name (string) --

[REQUIRED]

The name of the fleet.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --
start_image_builder(**kwargs)

Starts the specified image builder.

See also: AWS API Documentation

Request Syntax

response = client.start_image_builder(
    Name='string',
    AppstreamAgentVersion='string'
)
Parameters
  • Name (string) --

    [REQUIRED]

    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].
Return type

dict

Returns

Response Syntax

{
    'ImageBuilder': {
        'Name': 'string',
        'Arn': 'string',
        'ImageArn': 'string',
        'Description': 'string',
        'DisplayName': 'string',
        'VpcConfig': {
            'SubnetIds': [
                'string',
            ],
            'SecurityGroupIds': [
                'string',
            ]
        },
        'InstanceType': 'string',
        'Platform': 'WINDOWS',
        'State': 'PENDING'|'UPDATING_AGENT'|'RUNNING'|'STOPPING'|'STOPPED'|'REBOOTING'|'SNAPSHOTTING'|'DELETING'|'FAILED',
        'StateChangeReason': {
            'Code': 'INTERNAL_ERROR'|'IMAGE_UNAVAILABLE',
            'Message': 'string'
        },
        'CreatedTime': datetime(2015, 1, 1),
        'EnableDefaultInternetAccess': True|False,
        'DomainJoinInfo': {
            'DirectoryName': 'string',
            'OrganizationalUnitDistinguishedName': 'string'
        },
        'ImageBuilderErrors': [
            {
                'ErrorCode': 'IAM_SERVICE_ROLE_MISSING_ENI_DESCRIBE_ACTION'|'IAM_SERVICE_ROLE_MISSING_ENI_CREATE_ACTION'|'IAM_SERVICE_ROLE_MISSING_ENI_DELETE_ACTION'|'NETWORK_INTERFACE_LIMIT_EXCEEDED'|'INTERNAL_SERVICE_ERROR'|'IAM_SERVICE_ROLE_IS_MISSING'|'SUBNET_HAS_INSUFFICIENT_IP_ADDRESSES'|'IAM_SERVICE_ROLE_MISSING_DESCRIBE_SUBNET_ACTION'|'SUBNET_NOT_FOUND'|'IMAGE_NOT_FOUND'|'INVALID_SUBNET_CONFIGURATION'|'SECURITY_GROUPS_NOT_FOUND'|'IGW_NOT_ATTACHED'|'IAM_SERVICE_ROLE_MISSING_DESCRIBE_SECURITY_GROUPS_ACTION'|'DOMAIN_JOIN_ERROR_FILE_NOT_FOUND'|'DOMAIN_JOIN_ERROR_ACCESS_DENIED'|'DOMAIN_JOIN_ERROR_LOGON_FAILURE'|'DOMAIN_JOIN_ERROR_INVALID_PARAMETER'|'DOMAIN_JOIN_ERROR_MORE_DATA'|'DOMAIN_JOIN_ERROR_NO_SUCH_DOMAIN'|'DOMAIN_JOIN_ERROR_NOT_SUPPORTED'|'DOMAIN_JOIN_NERR_INVALID_WORKGROUP_NAME'|'DOMAIN_JOIN_NERR_WORKSTATION_NOT_STARTED'|'DOMAIN_JOIN_ERROR_DS_MACHINE_ACCOUNT_QUOTA_EXCEEDED'|'DOMAIN_JOIN_NERR_PASSWORD_EXPIRED'|'DOMAIN_JOIN_INTERNAL_SERVICE_ERROR',
                'ErrorMessage': 'string',
                'ErrorTimestamp': datetime(2015, 1, 1)
            },
        ],
        'AppstreamAgentVersion': 'string'
    }
}

Response Structure

  • (dict) --

    • ImageBuilder (dict) --

      Information about the image builder.

      • Name (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 for display.

      • DisplayName (string) --

        The image builder name for display.

      • VpcConfig (dict) --

        The VPC configuration of the image builder.

        • SubnetIds (list) --

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

          • (string) --
        • SecurityGroupIds (list) --

          The security groups for the fleet.

          • (string) --
      • InstanceType (string) --

        The instance type for the image builder.

      • Platform (string) --

        The operating system platform of the image builder.

      • State (string) --

        The state of the image builder.

      • StateChangeReason (dict) --

        The reason why the last state change occurred.

        • Code (string) --

          The state change reason code.

        • Message (string) --

          The state change reason message.

      • CreatedTime (datetime) --

        The time stamp when the image builder was created.

      • EnableDefaultInternetAccess (boolean) --

        Enables or disables default internet access for the image builder.

      • DomainJoinInfo (dict) --

        The information needed to join 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 (list) --

        The image builder errors.

        • (dict) --

          Describes a resource error.

          • ErrorCode (string) --

            The error code.

          • ErrorMessage (string) --

            The error message.

          • ErrorTimestamp (datetime) --

            The time the error occurred.

      • AppstreamAgentVersion (string) --

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

stop_fleet(**kwargs)

Stops the specified fleet.

See also: AWS API Documentation

Request Syntax

response = client.stop_fleet(
    Name='string'
)
Parameters
Name (string) --

[REQUIRED]

The name of the fleet.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --
stop_image_builder(**kwargs)

Stops the specified image builder.

See also: AWS API Documentation

Request Syntax

response = client.stop_image_builder(
    Name='string'
)
Parameters
Name (string) --

[REQUIRED]

The name of the image builder.

Return type
dict
Returns
Response Syntax
{
    'ImageBuilder': {
        'Name': 'string',
        'Arn': 'string',
        'ImageArn': 'string',
        'Description': 'string',
        'DisplayName': 'string',
        'VpcConfig': {
            'SubnetIds': [
                'string',
            ],
            'SecurityGroupIds': [
                'string',
            ]
        },
        'InstanceType': 'string',
        'Platform': 'WINDOWS',
        'State': 'PENDING'|'UPDATING_AGENT'|'RUNNING'|'STOPPING'|'STOPPED'|'REBOOTING'|'SNAPSHOTTING'|'DELETING'|'FAILED',
        'StateChangeReason': {
            'Code': 'INTERNAL_ERROR'|'IMAGE_UNAVAILABLE',
            'Message': 'string'
        },
        'CreatedTime': datetime(2015, 1, 1),
        'EnableDefaultInternetAccess': True|False,
        'DomainJoinInfo': {
            'DirectoryName': 'string',
            'OrganizationalUnitDistinguishedName': 'string'
        },
        'ImageBuilderErrors': [
            {
                'ErrorCode': 'IAM_SERVICE_ROLE_MISSING_ENI_DESCRIBE_ACTION'|'IAM_SERVICE_ROLE_MISSING_ENI_CREATE_ACTION'|'IAM_SERVICE_ROLE_MISSING_ENI_DELETE_ACTION'|'NETWORK_INTERFACE_LIMIT_EXCEEDED'|'INTERNAL_SERVICE_ERROR'|'IAM_SERVICE_ROLE_IS_MISSING'|'SUBNET_HAS_INSUFFICIENT_IP_ADDRESSES'|'IAM_SERVICE_ROLE_MISSING_DESCRIBE_SUBNET_ACTION'|'SUBNET_NOT_FOUND'|'IMAGE_NOT_FOUND'|'INVALID_SUBNET_CONFIGURATION'|'SECURITY_GROUPS_NOT_FOUND'|'IGW_NOT_ATTACHED'|'IAM_SERVICE_ROLE_MISSING_DESCRIBE_SECURITY_GROUPS_ACTION'|'DOMAIN_JOIN_ERROR_FILE_NOT_FOUND'|'DOMAIN_JOIN_ERROR_ACCESS_DENIED'|'DOMAIN_JOIN_ERROR_LOGON_FAILURE'|'DOMAIN_JOIN_ERROR_INVALID_PARAMETER'|'DOMAIN_JOIN_ERROR_MORE_DATA'|'DOMAIN_JOIN_ERROR_NO_SUCH_DOMAIN'|'DOMAIN_JOIN_ERROR_NOT_SUPPORTED'|'DOMAIN_JOIN_NERR_INVALID_WORKGROUP_NAME'|'DOMAIN_JOIN_NERR_WORKSTATION_NOT_STARTED'|'DOMAIN_JOIN_ERROR_DS_MACHINE_ACCOUNT_QUOTA_EXCEEDED'|'DOMAIN_JOIN_NERR_PASSWORD_EXPIRED'|'DOMAIN_JOIN_INTERNAL_SERVICE_ERROR',
                'ErrorMessage': 'string',
                'ErrorTimestamp': datetime(2015, 1, 1)
            },
        ],
        'AppstreamAgentVersion': 'string'
    }
}

Response Structure

  • (dict) --
    • ImageBuilder (dict) --

      Information about the image builder.

      • Name (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 for display.

      • DisplayName (string) --

        The image builder name for display.

      • VpcConfig (dict) --

        The VPC configuration of the image builder.

        • SubnetIds (list) --

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

          • (string) --
        • SecurityGroupIds (list) --

          The security groups for the fleet.

          • (string) --
      • InstanceType (string) --

        The instance type for the image builder.

      • Platform (string) --

        The operating system platform of the image builder.

      • State (string) --

        The state of the image builder.

      • StateChangeReason (dict) --

        The reason why the last state change occurred.

        • Code (string) --

          The state change reason code.

        • Message (string) --

          The state change reason message.

      • CreatedTime (datetime) --

        The time stamp when the image builder was created.

      • EnableDefaultInternetAccess (boolean) --

        Enables or disables default internet access for the image builder.

      • DomainJoinInfo (dict) --

        The information needed to join 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 (list) --

        The image builder errors.

        • (dict) --

          Describes a resource error.

          • ErrorCode (string) --

            The error code.

          • ErrorMessage (string) --

            The error message.

          • ErrorTimestamp (datetime) --

            The time the error occurred.

      • AppstreamAgentVersion (string) --

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

tag_resource(**kwargs)

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 .

See also: AWS API Documentation

Request Syntax

response = client.tag_resource(
    ResourceArn='string',
    Tags={
        'string': 'string'
    }
)
Parameters
  • ResourceArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the resource.

  • Tags (dict) --

    [REQUIRED]

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

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

    • (string) --
      • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

untag_resource(**kwargs)

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 .

See also: AWS API Documentation

Request Syntax

response = client.untag_resource(
    ResourceArn='string',
    TagKeys=[
        'string',
    ]
)
Parameters
  • ResourceArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the resource.

  • TagKeys (list) --

    [REQUIRED]

    The tag keys for the tags to disassociate.

    • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

update_directory_config(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.update_directory_config(
    DirectoryName='string',
    OrganizationalUnitDistinguishedNames=[
        'string',
    ],
    ServiceAccountCredentials={
        'AccountName': 'string',
        'AccountPassword': 'string'
    }
)
Parameters
  • DirectoryName (string) --

    [REQUIRED]

    The name of the Directory Config object.

  • OrganizationalUnitDistinguishedNames (list) --

    The distinguished names of the organizational units for computer accounts.

    • (string) --
  • ServiceAccountCredentials (dict) --

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

    • AccountName (string) -- [REQUIRED]

      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 (string) -- [REQUIRED]

      The password for the account.

Return type

dict

Returns

Response Syntax

{
    'DirectoryConfig': {
        'DirectoryName': 'string',
        'OrganizationalUnitDistinguishedNames': [
            'string',
        ],
        'ServiceAccountCredentials': {
            'AccountName': 'string',
            'AccountPassword': 'string'
        },
        'CreatedTime': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) --

    • DirectoryConfig (dict) --

      Information about the Directory Config object.

      • DirectoryName (string) --

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

      • OrganizationalUnitDistinguishedNames (list) --

        The distinguished names of the organizational units for computer accounts.

        • (string) --
      • ServiceAccountCredentials (dict) --

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

        • AccountName (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 (string) --

          The password for the account.

      • CreatedTime (datetime) --

        The time the directory configuration was created.

update_fleet(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.update_fleet(
    ImageName='string',
    ImageArn='string',
    Name='string',
    InstanceType='string',
    ComputeCapacity={
        'DesiredInstances': 123
    },
    VpcConfig={
        'SubnetIds': [
            'string',
        ],
        'SecurityGroupIds': [
            'string',
        ]
    },
    MaxUserDurationInSeconds=123,
    DisconnectTimeoutInSeconds=123,
    DeleteVpcConfig=True|False,
    Description='string',
    DisplayName='string',
    EnableDefaultInternetAccess=True|False,
    DomainJoinInfo={
        'DirectoryName': 'string',
        'OrganizationalUnitDistinguishedName': 'string'
    },
    AttributesToDelete=[
        'VPC_CONFIGURATION'|'VPC_CONFIGURATION_SECURITY_GROUP_IDS'|'DOMAIN_JOIN_INFO',
    ]
)
Parameters
  • 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 (dict) --

    The desired capacity for the fleet.

    • DesiredInstances (integer) -- [REQUIRED]

      The desired number of streaming instances.

  • VpcConfig (dict) --

    The VPC configuration for the fleet.

    • SubnetIds (list) --

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

      • (string) --
    • SecurityGroupIds (list) --

      The security groups for the fleet.

      • (string) --
  • MaxUserDurationInSeconds (integer) -- The maximum time that a streaming session can run, in seconds. Specify a value between 600 and 57600.
  • DisconnectTimeoutInSeconds (integer) -- The time after disconnection when a session is considered to have ended, in seconds. If a user who was disconnected reconnects within this time interval, the user is connected to their previous session. Specify a value between 60 and 57600.
  • DeleteVpcConfig (boolean) -- Deletes the VPC association for the specified fleet.
  • Description (string) -- The description for display.
  • DisplayName (string) -- The fleet name for display.
  • EnableDefaultInternetAccess (boolean) -- Enables or disables default internet access for the fleet.
  • DomainJoinInfo (dict) --

    The information needed to join 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 (list) --

    The fleet attributes to delete.

    • (string) --

      The fleet attribute.

Return type

dict

Returns

Response Syntax

{
    'Fleet': {
        'Arn': 'string',
        'Name': 'string',
        'DisplayName': 'string',
        'Description': 'string',
        'ImageName': 'string',
        'ImageArn': 'string',
        'InstanceType': 'string',
        'FleetType': 'ALWAYS_ON'|'ON_DEMAND',
        'ComputeCapacityStatus': {
            'Desired': 123,
            'Running': 123,
            'InUse': 123,
            'Available': 123
        },
        'MaxUserDurationInSeconds': 123,
        'DisconnectTimeoutInSeconds': 123,
        'State': 'STARTING'|'RUNNING'|'STOPPING'|'STOPPED',
        'VpcConfig': {
            'SubnetIds': [
                'string',
            ],
            'SecurityGroupIds': [
                'string',
            ]
        },
        'CreatedTime': datetime(2015, 1, 1),
        'FleetErrors': [
            {
                'ErrorCode': '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'
            },
        ],
        'EnableDefaultInternetAccess': True|False,
        'DomainJoinInfo': {
            'DirectoryName': 'string',
            'OrganizationalUnitDistinguishedName': 'string'
        }
    }
}

Response Structure

  • (dict) --

    • Fleet (dict) --

      Information about the fleet.

      • Arn (string) --

        The ARN for the fleet.

      • Name (string) --

        The name of the fleet.

      • DisplayName (string) --

        The fleet name for display.

      • Description (string) --

        The description for 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 (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.

      • ComputeCapacityStatus (dict) --

        The capacity status for the fleet.

        • Desired (integer) --

          The desired number of streaming instances.

        • Running (integer) --

          The total number of simultaneous streaming instances that are running.

        • InUse (integer) --

          The number of instances in use for streaming.

        • Available (integer) --

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

      • MaxUserDurationInSeconds (integer) --

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

      • DisconnectTimeoutInSeconds (integer) --

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

      • State (string) --

        The current state for the fleet.

      • VpcConfig (dict) --

        The VPC configuration for the fleet.

        • SubnetIds (list) --

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

          • (string) --
        • SecurityGroupIds (list) --

          The security groups for the fleet.

          • (string) --
      • CreatedTime (datetime) --

        The time the fleet was created.

      • FleetErrors (list) --

        The fleet errors.

        • (dict) --

          Describes a fleet error.

          • ErrorCode (string) --

            The error code.

          • ErrorMessage (string) --

            The error message.

      • EnableDefaultInternetAccess (boolean) --

        Indicates whether default internet access is enabled for the fleet.

      • DomainJoinInfo (dict) --

        The information needed to join 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.

update_image_permissions(**kwargs)

Adds or updates permissions for the specified private image.

See also: AWS API Documentation

Request Syntax

response = client.update_image_permissions(
    Name='string',
    SharedAccountId='string',
    ImagePermissions={
        'allowFleet': True|False,
        'allowImageBuilder': True|False
    }
)
Parameters
  • Name (string) --

    [REQUIRED]

    The name of the private image.

  • SharedAccountId (string) --

    [REQUIRED]

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

  • ImagePermissions (dict) --

    [REQUIRED]

    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.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

update_stack(**kwargs)

Updates the specified fields for the specified stack.

See also: AWS API Documentation

Request Syntax

response = client.update_stack(
    DisplayName='string',
    Description='string',
    Name='string',
    StorageConnectors=[
        {
            'ConnectorType': 'HOMEFOLDERS'|'GOOGLE_DRIVE'|'ONE_DRIVE',
            'ResourceIdentifier': 'string',
            'Domains': [
                'string',
            ]
        },
    ],
    DeleteStorageConnectors=True|False,
    RedirectURL='string',
    FeedbackURL='string',
    AttributesToDelete=[
        'STORAGE_CONNECTORS'|'STORAGE_CONNECTOR_HOMEFOLDERS'|'STORAGE_CONNECTOR_GOOGLE_DRIVE'|'STORAGE_CONNECTOR_ONE_DRIVE'|'REDIRECT_URL'|'FEEDBACK_URL'|'THEME_NAME'|'USER_SETTINGS',
    ],
    UserSettings=[
        {
            'Action': 'CLIPBOARD_COPY_FROM_LOCAL_DEVICE'|'CLIPBOARD_COPY_TO_LOCAL_DEVICE'|'FILE_UPLOAD'|'FILE_DOWNLOAD'|'PRINTING_TO_LOCAL_DEVICE',
            'Permission': 'ENABLED'|'DISABLED'
        },
    ],
    ApplicationSettings={
        'Enabled': True|False,
        'SettingsGroup': 'string'
    }
)
Parameters
  • DisplayName (string) -- The stack name for display.
  • Description (string) -- The description for display.
  • Name (string) --

    [REQUIRED]

    The name of the stack.

  • StorageConnectors (list) --

    The storage connectors to enable.

    • (dict) --

      Describes a connector to enable persistent storage for users.

      • ConnectorType (string) -- [REQUIRED]

        The type of storage connector.

      • ResourceIdentifier (string) --

        The ARN of the storage connector.

      • Domains (list) --

        The names of the domains for the G Suite account.

        • (string) -- GSuite domain for GDrive integration.
  • 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 click the Send Feedback link. If no URL is specified, no Send Feedback link is displayed.
  • AttributesToDelete (list) --

    The stack attributes to delete.

    • (string) --
  • UserSettings (list) --

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

    • (dict) --

      Describes an action and whether the action is enabled or disabled for users during their streaming sessions.

      • Action (string) -- [REQUIRED]

        The action that is enabled or disabled.

      • Permission (string) -- [REQUIRED]

        Indicates whether the action is enabled or disabled.

  • ApplicationSettings (dict) --

    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 (boolean) -- [REQUIRED]

      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.

Return type

dict

Returns

Response Syntax

{
    'Stack': {
        'Arn': 'string',
        'Name': 'string',
        'Description': 'string',
        'DisplayName': 'string',
        'CreatedTime': datetime(2015, 1, 1),
        'StorageConnectors': [
            {
                'ConnectorType': 'HOMEFOLDERS'|'GOOGLE_DRIVE'|'ONE_DRIVE',
                'ResourceIdentifier': 'string',
                'Domains': [
                    'string',
                ]
            },
        ],
        'RedirectURL': 'string',
        'FeedbackURL': 'string',
        'StackErrors': [
            {
                'ErrorCode': 'STORAGE_CONNECTOR_ERROR'|'INTERNAL_SERVICE_ERROR',
                'ErrorMessage': 'string'
            },
        ],
        'UserSettings': [
            {
                'Action': 'CLIPBOARD_COPY_FROM_LOCAL_DEVICE'|'CLIPBOARD_COPY_TO_LOCAL_DEVICE'|'FILE_UPLOAD'|'FILE_DOWNLOAD'|'PRINTING_TO_LOCAL_DEVICE',
                'Permission': 'ENABLED'|'DISABLED'
            },
        ],
        'ApplicationSettings': {
            'Enabled': True|False,
            'SettingsGroup': 'string',
            'S3BucketName': 'string'
        }
    }
}

Response Structure

  • (dict) --

    • Stack (dict) --

      Information about the stack.

      • Arn (string) --

        The ARN of the stack.

      • Name (string) --

        The name of the stack.

      • Description (string) --

        The description for display.

      • DisplayName (string) --

        The stack name for display.

      • CreatedTime (datetime) --

        The time the stack was created.

      • StorageConnectors (list) --

        The storage connectors to enable.

        • (dict) --

          Describes a connector to enable persistent storage for users.

          • ConnectorType (string) --

            The type of storage connector.

          • ResourceIdentifier (string) --

            The ARN of the storage connector.

          • Domains (list) --

            The names of the domains for the G Suite account.

            • (string) -- GSuite domain for GDrive integration.
      • 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 (list) --

        The errors for the stack.

        • (dict) --

          Describes a stack error.

          • ErrorCode (string) --

            The error code.

          • ErrorMessage (string) --

            The error message.

      • UserSettings (list) --

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

        • (dict) --

          Describes an action and whether the action is enabled or disabled for users during their streaming sessions.

          • Action (string) --

            The action that is enabled or disabled.

          • Permission (string) --

            Indicates whether the action is enabled or disabled.

      • ApplicationSettings (dict) --

        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.

Paginators

The available paginators are:

Waiters

The available waiters are:

class AppStream.Waiter.FleetStarted
waiter = client.get_waiter('fleet_started')
wait(**kwargs)

Polls AppStream.Client.describe_fleets() every 30 seconds until a successful state is reached. An error is returned after 40 failed checks.

See also: AWS API Documentation

Request Syntax

waiter.wait(
    Names=[
        'string',
    ],
    NextToken='string',
    WaiterConfig={
        'Delay': 123,
        'MaxAttempts': 123
    }
)
Parameters
  • Names (list) --

    The names of the fleets to describe.

    • (string) --
  • 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.
  • WaiterConfig (dict) --

    A dictionary that provides parameters to control waiting behavior.

    • Delay (integer) --

      The amount of time in seconds to wait between attempts. Default: 30

    • MaxAttempts (integer) --

      The maximum number of attempts to be made. Default: 40

Returns

None

class AppStream.Waiter.FleetStopped
waiter = client.get_waiter('fleet_stopped')
wait(**kwargs)

Polls AppStream.Client.describe_fleets() every 30 seconds until a successful state is reached. An error is returned after 40 failed checks.

See also: AWS API Documentation

Request Syntax

waiter.wait(
    Names=[
        'string',
    ],
    NextToken='string',
    WaiterConfig={
        'Delay': 123,
        'MaxAttempts': 123
    }
)
Parameters
  • Names (list) --

    The names of the fleets to describe.

    • (string) --
  • 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.
  • WaiterConfig (dict) --

    A dictionary that provides parameters to control waiting behavior.

    • Delay (integer) --

      The amount of time in seconds to wait between attempts. Default: 30

    • MaxAttempts (integer) --

      The maximum number of attempts to be made. Default: 40

Returns

None