Amazon AppStream

{'ComputeCapacity': {'DesiredSessions': 'integer'},
 'MaxSessionsPerInstance': 'integer'}

{'Fleet': {'ComputeCapacityStatus': {'ActiveUserSessions': 'integer',
                                     'ActualUserSessions': 'integer',
                                     'AvailableUserSessions': 'integer',
                                     'DesiredUserSessions': 'integer'},
           'MaxSessionsPerInstance': 'integer'}}

Creates a fleet. A fleet consists of streaming instances that your users access for their applications and desktops.

See also: AWS API Documentation

Request Syntax

client.create_fleet(
    Name='string',
    ImageName='string',
    ImageArn='string',
    InstanceType='string',
    FleetType='ALWAYS_ON'|'ON_DEMAND'|'ELASTIC',
    ComputeCapacity={
        'DesiredInstances': 123,
        'DesiredSessions': 123
    },
    VpcConfig={
        'SubnetIds': [
            'string',
        ],
        'SecurityGroupIds': [
            'string',
        ]
    },
    MaxUserDurationInSeconds=123,
    DisconnectTimeoutInSeconds=123,
    Description='string',
    DisplayName='string',
    EnableDefaultInternetAccess=True|False,
    DomainJoinInfo={
        'DirectoryName': 'string',
        'OrganizationalUnitDistinguishedName': 'string'
    },
    Tags={
        'string': 'string'
    },
    IdleDisconnectTimeoutInSeconds=123,
    IamRoleArn='string',
    StreamView='APP'|'DESKTOP',
    Platform='WINDOWS'|'WINDOWS_SERVER_2016'|'WINDOWS_SERVER_2019'|'AMAZON_LINUX2',
    MaxConcurrentSessions=123,
    UsbDeviceFilterStrings=[
        'string',
    ],
    SessionScriptS3Location={
        'S3Bucket': 'string',
        'S3Key': 'string'
    },
    MaxSessionsPerInstance=123
)

type Name

string

param Name

[REQUIRED]

A unique name for the fleet.

type ImageName

string

param ImageName

The name of the image used to create the fleet.

type ImageArn

string

param ImageArn

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

type InstanceType

string

param InstanceType

[REQUIRED]

The instance type to use when launching fleet instances. The following instance types are available:

• stream.standard.small

• stream.standard.medium

• stream.standard.large

• stream.standard.xlarge

• stream.standard.2xlarge

• stream.compute.large

• stream.compute.xlarge

• stream.compute.2xlarge

• stream.compute.4xlarge

• stream.compute.8xlarge

• stream.memory.large

• stream.memory.xlarge

• stream.memory.2xlarge

• stream.memory.4xlarge

• stream.memory.8xlarge

• stream.memory.z1d.large

• stream.memory.z1d.xlarge

• stream.memory.z1d.2xlarge

• stream.memory.z1d.3xlarge

• stream.memory.z1d.6xlarge

• stream.memory.z1d.12xlarge

• stream.graphics-design.large

• stream.graphics-design.xlarge

• stream.graphics-design.2xlarge

• stream.graphics-design.4xlarge

• stream.graphics-desktop.2xlarge

• stream.graphics.g4dn.xlarge

• stream.graphics.g4dn.2xlarge

• stream.graphics.g4dn.4xlarge

• stream.graphics.g4dn.8xlarge

• stream.graphics.g4dn.12xlarge

• stream.graphics.g4dn.16xlarge

• stream.graphics-pro.4xlarge

• stream.graphics-pro.8xlarge

• stream.graphics-pro.16xlarge

The following instance types are available for Elastic fleets:

• stream.standard.small

• stream.standard.medium

• stream.standard.large

• stream.standard.xlarge

• stream.standard.2xlarge

type FleetType

string

param FleetType

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.

type ComputeCapacity

dict

param ComputeCapacity

The desired capacity for the fleet. This is not allowed for Elastic fleets. For Elastic fleets, specify MaxConcurrentSessions instead.

• DesiredInstances (integer) --

  The desired number of streaming instances.

• DesiredSessions (integer) --

  The desired number of user sessions for a multi-session fleet. This is not allowed for single-session fleets.

  When you create a fleet, you must set either the DesiredSessions or DesiredInstances attribute, based on the type of fleet you create. You can’t define both attributes or leave both attributes blank.

type VpcConfig

dict

param VpcConfig

The VPC configuration for the fleet. This is required for Elastic fleets, but not required for other fleet types. Elastic fleets require that you specify at least two subnets in different availability zones.

• SubnetIds (list) --

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

  • (string) --

• SecurityGroupIds (list) --

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

  • (string) --

type MaxUserDurationInSeconds

integer

param MaxUserDurationInSeconds

The maximum amount of time that a streaming session can remain active, in seconds. If users are still connected to a streaming instance five minutes before this limit is reached, they are prompted to save any open documents before being disconnected. After this time elapses, the instance is terminated and replaced by a new instance.

Specify a value between 600 and 432000.

type DisconnectTimeoutInSeconds

integer

param DisconnectTimeoutInSeconds

The amount of time that a streaming session remains active after users disconnect. If users try to reconnect to the streaming session after a disconnection or network interruption within this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance.

Specify a value between 60 and 360000.

type Description

string

param Description

The description to display.

type DisplayName

string

param DisplayName

The fleet name to display.

type EnableDefaultInternetAccess

boolean

param EnableDefaultInternetAccess

Enables or disables default internet access for the fleet.

type DomainJoinInfo

dict

param DomainJoinInfo

The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain. This is not allowed for Elastic fleets.

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

type Tags

dict

param Tags

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

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

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

_ . : / = + - @

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

• (string) --

  • (string) --

type IdleDisconnectTimeoutInSeconds

integer

param IdleDisconnectTimeoutInSeconds

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

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

Note

If you enable this feature, we recommend that you specify a value that corresponds exactly to a whole number of minutes (for example, 60, 120, and 180). If you don't do this, the value is rounded to the nearest minute. For example, if you specify a value of 70, users are disconnected after 1 minute of inactivity. If you specify a value that is at the midpoint between two different minutes, the value is rounded up. For example, if you specify a value of 90, users are disconnected after 2 minutes of inactivity.

type IamRoleArn

string

param IamRoleArn

The Amazon Resource Name (ARN) of the IAM role to apply to the fleet. To assume a role, a fleet instance calls the AWS Security Token Service (STS) AssumeRole API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the appstream_machine_role credential profile on the instance.

For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide .

type StreamView

string

param StreamView

The AppStream 2.0 view that is displayed to your users when they stream from the fleet. When APP is specified, only the windows of applications opened by users display. When DESKTOP is specified, the standard desktop that is provided by the operating system displays.

The default value is APP .

type Platform

string

param Platform

The fleet platform. WINDOWS_SERVER_2019 and AMAZON_LINUX2 are supported for Elastic fleets.

type MaxConcurrentSessions

integer

param MaxConcurrentSessions

The maximum concurrent sessions of the Elastic fleet. This is required for Elastic fleets, and not allowed for other fleet types.

type UsbDeviceFilterStrings

list

param UsbDeviceFilterStrings

The USB device filter strings that specify which USB devices a user can redirect to the fleet streaming session, when using the Windows native client. This is allowed but not required for Elastic fleets.

• (string) --

type SessionScriptS3Location

dict

param SessionScriptS3Location

The S3 location of the session scripts configuration zip file. This only applies to Elastic fleets.

• S3Bucket (string) -- [REQUIRED]

  The S3 bucket of the S3 object.

• S3Key (string) --

  The S3 key of the S3 object.

  This is required when used for the following:

  • IconS3Location (Actions: CreateApplication and UpdateApplication)

  • SessionScriptS3Location (Actions: CreateFleet and UpdateFleet)

  • ScriptDetails (Actions: CreateAppBlock)

  • SourceS3Location when creating an app block with CUSTOM PackagingType (Actions: CreateAppBlock)

  • SourceS3Location when creating an app block with APPSTREAM2 PackagingType, and using an existing application package (VHD file). In this case, S3Key refers to the VHD file. If a new application package is required, then S3Key is not required. (Actions: CreateAppBlock)

type MaxSessionsPerInstance

integer

param MaxSessionsPerInstance

The maximum number of user sessions on an instance. This only applies to multi-session fleets.

rtype

dict

returns

Response Syntax

{
    'Fleet': {
        'Arn': 'string',
        'Name': 'string',
        'DisplayName': 'string',
        'Description': 'string',
        'ImageName': 'string',
        'ImageArn': 'string',
        'InstanceType': 'string',
        'FleetType': 'ALWAYS_ON'|'ON_DEMAND'|'ELASTIC',
        'ComputeCapacityStatus': {
            'Desired': 123,
            'Running': 123,
            'InUse': 123,
            'Available': 123,
            'DesiredUserSessions': 123,
            'AvailableUserSessions': 123,
            'ActiveUserSessions': 123,
            'ActualUserSessions': 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'|'MACHINE_ROLE_IS_MISSING'|'STS_DISABLED_IN_REGION'|'SUBNET_HAS_INSUFFICIENT_IP_ADDRESSES'|'IAM_SERVICE_ROLE_MISSING_DESCRIBE_SUBNET_ACTION'|'SUBNET_NOT_FOUND'|'IMAGE_NOT_FOUND'|'INVALID_SUBNET_CONFIGURATION'|'SECURITY_GROUPS_NOT_FOUND'|'IGW_NOT_ATTACHED'|'IAM_SERVICE_ROLE_MISSING_DESCRIBE_SECURITY_GROUPS_ACTION'|'FLEET_STOPPED'|'FLEET_INSTANCE_PROVISIONING_FAILURE'|'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'
        },
        'IdleDisconnectTimeoutInSeconds': 123,
        'IamRoleArn': 'string',
        'StreamView': 'APP'|'DESKTOP',
        'Platform': 'WINDOWS'|'WINDOWS_SERVER_2016'|'WINDOWS_SERVER_2019'|'AMAZON_LINUX2',
        'MaxConcurrentSessions': 123,
        'UsbDeviceFilterStrings': [
            'string',
        ],
        'SessionScriptS3Location': {
            'S3Bucket': 'string',
            'S3Key': 'string'
        },
        'MaxSessionsPerInstance': 123
    }
}

Response Structure

• (dict) --

  • Fleet (dict) --

    Information about the fleet.

    • Arn (string) --

      The Amazon Resource Name (ARN) for the fleet.

    • Name (string) --

      The name of the fleet.

    • DisplayName (string) --

      The fleet name to display.

    • Description (string) --

      The description to display.

    • ImageName (string) --

      The name of the image used to create the fleet.

    • ImageArn (string) --

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

    • InstanceType (string) --

      The instance type to use when launching fleet instances. The following instance types are available:

      • stream.standard.small

      • stream.standard.medium

      • stream.standard.large

      • stream.compute.large

      • stream.compute.xlarge

      • stream.compute.2xlarge

      • stream.compute.4xlarge

      • stream.compute.8xlarge

      • stream.memory.large

      • stream.memory.xlarge

      • stream.memory.2xlarge

      • stream.memory.4xlarge

      • stream.memory.8xlarge

      • stream.memory.z1d.large

      • stream.memory.z1d.xlarge

      • stream.memory.z1d.2xlarge

      • stream.memory.z1d.3xlarge

      • stream.memory.z1d.6xlarge

      • stream.memory.z1d.12xlarge

      • stream.graphics-design.large

      • stream.graphics-design.xlarge

      • stream.graphics-design.2xlarge

      • stream.graphics-design.4xlarge

      • stream.graphics-desktop.2xlarge

      • stream.graphics.g4dn.xlarge

      • stream.graphics.g4dn.2xlarge

      • stream.graphics.g4dn.4xlarge

      • stream.graphics.g4dn.8xlarge

      • stream.graphics.g4dn.12xlarge

      • stream.graphics.g4dn.16xlarge

      • stream.graphics-pro.4xlarge

      • stream.graphics-pro.8xlarge

      • stream.graphics-pro.16xlarge

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

      • DesiredUserSessions (integer) --

        The total number of sessions slots that are either running or pending. This represents the total number of concurrent streaming sessions your fleet can support in a steady state.

        DesiredUserSessionCapacity = ActualUserSessionCapacity + PendingUserSessionCapacity

        This only applies to multi-session fleets.

      • AvailableUserSessions (integer) --

        The number of idle session slots currently available for user sessions.

        AvailableUserSessionCapacity = ActualUserSessionCapacity - ActiveUserSessions

        This only applies to multi-session fleets.

      • ActiveUserSessions (integer) --

        The number of user sessions currently being used for streaming sessions. This only applies to multi-session fleets.

      • ActualUserSessions (integer) --

        The total number of session slots that are available for streaming or are currently streaming.

        ActualUserSessionCapacity = AvailableUserSessionCapacity + ActiveUserSessions

        This only applies to multi-session fleets.

    • MaxUserDurationInSeconds (integer) --

      The maximum amount of time that a streaming session can remain active, in seconds. If users are still connected to a streaming instance five minutes before this limit is reached, they are prompted to save any open documents before being disconnected. After this time elapses, the instance is terminated and replaced by a new instance.

      Specify a value between 600 and 360000.

    • DisconnectTimeoutInSeconds (integer) --

      The amount of time that a streaming session remains active after users disconnect. If they try to reconnect to the streaming session after a disconnection or network interruption within this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance.

      Specify a value between 60 and 360000.

    • State (string) --

      The current state for the fleet.

    • VpcConfig (dict) --

      The VPC configuration for the fleet.

      • SubnetIds (list) --

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

        • (string) --

      • SecurityGroupIds (list) --

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

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

      • DirectoryName (string) --

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

      • OrganizationalUnitDistinguishedName (string) --

        The distinguished name of the organizational unit for computer accounts.

    • IdleDisconnectTimeoutInSeconds (integer) --

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

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

      Note

      If you enable this feature, we recommend that you specify a value that corresponds exactly to a whole number of minutes (for example, 60, 120, and 180). If you don't do this, the value is rounded to the nearest minute. For example, if you specify a value of 70, users are disconnected after 1 minute of inactivity. If you specify a value that is at the midpoint between two different minutes, the value is rounded up. For example, if you specify a value of 90, users are disconnected after 2 minutes of inactivity.

    • IamRoleArn (string) --

      The ARN of the IAM role that is applied to the fleet. To assume a role, the fleet instance calls the AWS Security Token Service (STS) AssumeRole API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the appstream_machine_role credential profile on the instance.

      For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide .

    • StreamView (string) --

      The AppStream 2.0 view that is displayed to your users when they stream from the fleet. When APP is specified, only the windows of applications opened by users display. When DESKTOP is specified, the standard desktop that is provided by the operating system displays.

      The default value is APP .

    • Platform (string) --

      The platform of the fleet.

    • MaxConcurrentSessions (integer) --

      The maximum number of concurrent sessions for the fleet.

    • UsbDeviceFilterStrings (list) --

      The USB device filter strings associated with the fleet.

      • (string) --

    • SessionScriptS3Location (dict) --

      The S3 location of the session scripts configuration zip file. This only applies to Elastic fleets.

      • S3Bucket (string) --

        The S3 bucket of the S3 object.

      • S3Key (string) --

        The S3 key of the S3 object.

        This is required when used for the following:

        • IconS3Location (Actions: CreateApplication and UpdateApplication)

        • SessionScriptS3Location (Actions: CreateFleet and UpdateFleet)

        • ScriptDetails (Actions: CreateAppBlock)

        • SourceS3Location when creating an app block with CUSTOM PackagingType (Actions: CreateAppBlock)

        • SourceS3Location when creating an app block with APPSTREAM2 PackagingType, and using an existing application package (VHD file). In this case, S3Key refers to the VHD file. If a new application package is required, then S3Key is not required. (Actions: CreateAppBlock)

    • MaxSessionsPerInstance (integer) --

      The maximum number of user sessions on an instance. This only applies to multi-session fleets.

{'Fleets': {'ComputeCapacityStatus': {'ActiveUserSessions': 'integer',
                                      'ActualUserSessions': 'integer',
                                      'AvailableUserSessions': 'integer',
                                      'DesiredUserSessions': 'integer'},
            'MaxSessionsPerInstance': 'integer'}}

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

client.describe_fleets(
    Names=[
        'string',
    ],
    NextToken='string'
)

type Names

list

param Names

The names of the fleets to describe.

• (string) --

type NextToken

string

param NextToken

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.

rtype

dict

returns

Response Syntax

{
    'Fleets': [
        {
            'Arn': 'string',
            'Name': 'string',
            'DisplayName': 'string',
            'Description': 'string',
            'ImageName': 'string',
            'ImageArn': 'string',
            'InstanceType': 'string',
            'FleetType': 'ALWAYS_ON'|'ON_DEMAND'|'ELASTIC',
            'ComputeCapacityStatus': {
                'Desired': 123,
                'Running': 123,
                'InUse': 123,
                'Available': 123,
                'DesiredUserSessions': 123,
                'AvailableUserSessions': 123,
                'ActiveUserSessions': 123,
                'ActualUserSessions': 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'|'MACHINE_ROLE_IS_MISSING'|'STS_DISABLED_IN_REGION'|'SUBNET_HAS_INSUFFICIENT_IP_ADDRESSES'|'IAM_SERVICE_ROLE_MISSING_DESCRIBE_SUBNET_ACTION'|'SUBNET_NOT_FOUND'|'IMAGE_NOT_FOUND'|'INVALID_SUBNET_CONFIGURATION'|'SECURITY_GROUPS_NOT_FOUND'|'IGW_NOT_ATTACHED'|'IAM_SERVICE_ROLE_MISSING_DESCRIBE_SECURITY_GROUPS_ACTION'|'FLEET_STOPPED'|'FLEET_INSTANCE_PROVISIONING_FAILURE'|'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'
            },
            'IdleDisconnectTimeoutInSeconds': 123,
            'IamRoleArn': 'string',
            'StreamView': 'APP'|'DESKTOP',
            'Platform': 'WINDOWS'|'WINDOWS_SERVER_2016'|'WINDOWS_SERVER_2019'|'AMAZON_LINUX2',
            'MaxConcurrentSessions': 123,
            'UsbDeviceFilterStrings': [
                'string',
            ],
            'SessionScriptS3Location': {
                'S3Bucket': 'string',
                'S3Key': 'string'
            },
            'MaxSessionsPerInstance': 123
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • Fleets (list) --

    Information about the fleets.

    • (dict) --

      Describes a fleet.

      • Arn (string) --

        The Amazon Resource Name (ARN) for the fleet.

      • Name (string) --

        The name of the fleet.

      • DisplayName (string) --

        The fleet name to display.

      • Description (string) --

        The description to display.

      • ImageName (string) --

        The name of the image used to create the fleet.

      • ImageArn (string) --

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

      • InstanceType (string) --

        The instance type to use when launching fleet instances. The following instance types are available:

        • stream.standard.small

        • stream.standard.medium

        • stream.standard.large

        • stream.compute.large

        • stream.compute.xlarge

        • stream.compute.2xlarge

        • stream.compute.4xlarge

        • stream.compute.8xlarge

        • stream.memory.large

        • stream.memory.xlarge

        • stream.memory.2xlarge

        • stream.memory.4xlarge

        • stream.memory.8xlarge

        • stream.memory.z1d.large

        • stream.memory.z1d.xlarge

        • stream.memory.z1d.2xlarge

        • stream.memory.z1d.3xlarge

        • stream.memory.z1d.6xlarge

        • stream.memory.z1d.12xlarge

        • stream.graphics-design.large

        • stream.graphics-design.xlarge

        • stream.graphics-design.2xlarge

        • stream.graphics-design.4xlarge

        • stream.graphics-desktop.2xlarge

        • stream.graphics.g4dn.xlarge

        • stream.graphics.g4dn.2xlarge

        • stream.graphics.g4dn.4xlarge

        • stream.graphics.g4dn.8xlarge

        • stream.graphics.g4dn.12xlarge

        • stream.graphics.g4dn.16xlarge

        • stream.graphics-pro.4xlarge

        • stream.graphics-pro.8xlarge

        • stream.graphics-pro.16xlarge

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

        • DesiredUserSessions (integer) --

          The total number of sessions slots that are either running or pending. This represents the total number of concurrent streaming sessions your fleet can support in a steady state.

          DesiredUserSessionCapacity = ActualUserSessionCapacity + PendingUserSessionCapacity

          This only applies to multi-session fleets.

        • AvailableUserSessions (integer) --

          The number of idle session slots currently available for user sessions.

          AvailableUserSessionCapacity = ActualUserSessionCapacity - ActiveUserSessions

          This only applies to multi-session fleets.

        • ActiveUserSessions (integer) --

          The number of user sessions currently being used for streaming sessions. This only applies to multi-session fleets.

        • ActualUserSessions (integer) --

          The total number of session slots that are available for streaming or are currently streaming.

          ActualUserSessionCapacity = AvailableUserSessionCapacity + ActiveUserSessions

          This only applies to multi-session fleets.

      • MaxUserDurationInSeconds (integer) --

        The maximum amount of time that a streaming session can remain active, in seconds. If users are still connected to a streaming instance five minutes before this limit is reached, they are prompted to save any open documents before being disconnected. After this time elapses, the instance is terminated and replaced by a new instance.

        Specify a value between 600 and 360000.

      • DisconnectTimeoutInSeconds (integer) --

        The amount of time that a streaming session remains active after users disconnect. If they try to reconnect to the streaming session after a disconnection or network interruption within this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance.

        Specify a value between 60 and 360000.

      • State (string) --

        The current state for the fleet.

      • VpcConfig (dict) --

        The VPC configuration for the fleet.

        • SubnetIds (list) --

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

          • (string) --

        • SecurityGroupIds (list) --

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

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

        • DirectoryName (string) --

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

        • OrganizationalUnitDistinguishedName (string) --

          The distinguished name of the organizational unit for computer accounts.

      • IdleDisconnectTimeoutInSeconds (integer) --

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

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

        Note

        If you enable this feature, we recommend that you specify a value that corresponds exactly to a whole number of minutes (for example, 60, 120, and 180). If you don't do this, the value is rounded to the nearest minute. For example, if you specify a value of 70, users are disconnected after 1 minute of inactivity. If you specify a value that is at the midpoint between two different minutes, the value is rounded up. For example, if you specify a value of 90, users are disconnected after 2 minutes of inactivity.

      • IamRoleArn (string) --

        The ARN of the IAM role that is applied to the fleet. To assume a role, the fleet instance calls the AWS Security Token Service (STS) AssumeRole API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the appstream_machine_role credential profile on the instance.

        For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide .

      • StreamView (string) --

        The AppStream 2.0 view that is displayed to your users when they stream from the fleet. When APP is specified, only the windows of applications opened by users display. When DESKTOP is specified, the standard desktop that is provided by the operating system displays.

        The default value is APP .

      • Platform (string) --

        The platform of the fleet.

      • MaxConcurrentSessions (integer) --

        The maximum number of concurrent sessions for the fleet.

      • UsbDeviceFilterStrings (list) --

        The USB device filter strings associated with the fleet.

        • (string) --

      • SessionScriptS3Location (dict) --

        The S3 location of the session scripts configuration zip file. This only applies to Elastic fleets.

        • S3Bucket (string) --

          The S3 bucket of the S3 object.

        • S3Key (string) --

          The S3 key of the S3 object.

          This is required when used for the following:

          • IconS3Location (Actions: CreateApplication and UpdateApplication)

          • SessionScriptS3Location (Actions: CreateFleet and UpdateFleet)

          • ScriptDetails (Actions: CreateAppBlock)

          • SourceS3Location when creating an app block with CUSTOM PackagingType (Actions: CreateAppBlock)

          • SourceS3Location when creating an app block with APPSTREAM2 PackagingType, and using an existing application package (VHD file). In this case, S3Key refers to the VHD file. If a new application package is required, then S3Key is not required. (Actions: CreateAppBlock)

      • MaxSessionsPerInstance (integer) --

        The maximum number of user sessions on an instance. This only applies to multi-session fleets.

  • NextToken (string) --

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

{'InstanceId': 'string'}

{'Sessions': {'InstanceId': 'string'}}

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

See also: AWS API Documentation

Request Syntax

client.describe_sessions(
    StackName='string',
    FleetName='string',
    UserId='string',
    NextToken='string',
    Limit=123,
    AuthenticationType='API'|'SAML'|'USERPOOL'|'AWS_AD',
    InstanceId='string'
)

type StackName

string

param StackName

[REQUIRED]

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

type FleetName

string

param FleetName

[REQUIRED]

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

type UserId

string

param UserId

The user identifier (ID). If you specify a user ID, you must also specify the authentication type.

type NextToken

string

param NextToken

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.

type Limit

integer

param Limit

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

type AuthenticationType

string

param AuthenticationType

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.

type InstanceId

string

param InstanceId

The identifier for the instance hosting the session.

rtype

dict

returns

Response Syntax

{
    'Sessions': [
        {
            'Id': 'string',
            'UserId': 'string',
            'StackName': 'string',
            'FleetName': 'string',
            'State': 'ACTIVE'|'PENDING'|'EXPIRED',
            'ConnectionState': 'CONNECTED'|'NOT_CONNECTED',
            'StartTime': datetime(2015, 1, 1),
            'MaxExpirationTime': datetime(2015, 1, 1),
            'AuthenticationType': 'API'|'SAML'|'USERPOOL'|'AWS_AD',
            'NetworkAccessConfiguration': {
                'EniPrivateIpAddress': 'string',
                'EniId': 'string'
            },
            'InstanceId': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • Sessions (list) --

    Information about the streaming sessions.

    • (dict) --

      Describes a streaming session.

      • Id (string) --

        The identifier 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.

      • ConnectionState (string) --

        Specifies whether a user is connected to the streaming session.

      • StartTime (datetime) --

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

      • MaxExpirationTime (datetime) --

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

      • AuthenticationType (string) --

        The authentication method. The user is authenticated using a streaming URL ( API ) or SAML 2.0 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.

      • InstanceId (string) --

        The identifier for the instance hosting the session.

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

{'AttributesToDelete': {'MAX_SESSIONS_PER_INSTANCE'},
 'ComputeCapacity': {'DesiredSessions': 'integer'},
 'MaxSessionsPerInstance': 'integer'}

{'Fleet': {'ComputeCapacityStatus': {'ActiveUserSessions': 'integer',
                                     'ActualUserSessions': 'integer',
                                     'AvailableUserSessions': 'integer',
                                     'DesiredUserSessions': 'integer'},
           'MaxSessionsPerInstance': 'integer'}}

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 following based on the fleet type:

• Always-On and On-Demand fleet types You can update the DisplayName , ComputeCapacity , ImageARN , ImageName , IdleDisconnectTimeoutInSeconds , and DisconnectTimeoutInSeconds attributes.

• Elastic fleet type You can update the DisplayName , IdleDisconnectTimeoutInSeconds , DisconnectTimeoutInSeconds , MaxConcurrentSessions , SessionScriptS3Location and UsbDeviceFilterStrings attributes.

If the fleet is in the STARTING or STOPPED state, you can't update it.

See also: AWS API Documentation

Request Syntax

client.update_fleet(
    ImageName='string',
    ImageArn='string',
    Name='string',
    InstanceType='string',
    ComputeCapacity={
        'DesiredInstances': 123,
        'DesiredSessions': 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'
    },
    IdleDisconnectTimeoutInSeconds=123,
    AttributesToDelete=[
        'VPC_CONFIGURATION'|'VPC_CONFIGURATION_SECURITY_GROUP_IDS'|'DOMAIN_JOIN_INFO'|'IAM_ROLE_ARN'|'USB_DEVICE_FILTER_STRINGS'|'SESSION_SCRIPT_S3_LOCATION'|'MAX_SESSIONS_PER_INSTANCE',
    ],
    IamRoleArn='string',
    StreamView='APP'|'DESKTOP',
    Platform='WINDOWS'|'WINDOWS_SERVER_2016'|'WINDOWS_SERVER_2019'|'AMAZON_LINUX2',
    MaxConcurrentSessions=123,
    UsbDeviceFilterStrings=[
        'string',
    ],
    SessionScriptS3Location={
        'S3Bucket': 'string',
        'S3Key': 'string'
    },
    MaxSessionsPerInstance=123
)

type ImageName

string

param ImageName

The name of the image used to create the fleet.

type ImageArn

string

param ImageArn

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

type Name

string

param Name

A unique name for the fleet.

type InstanceType

string

param InstanceType

The instance type to use when launching fleet instances. The following instance types are available:

• stream.standard.small

• stream.standard.medium

• stream.standard.large

• stream.standard.xlarge

• stream.standard.2xlarge

• stream.compute.large

• stream.compute.xlarge

• stream.compute.2xlarge

• stream.compute.4xlarge

• stream.compute.8xlarge

• stream.memory.large

• stream.memory.xlarge

• stream.memory.2xlarge

• stream.memory.4xlarge

• stream.memory.8xlarge

• stream.memory.z1d.large

• stream.memory.z1d.xlarge

• stream.memory.z1d.2xlarge

• stream.memory.z1d.3xlarge

• stream.memory.z1d.6xlarge

• stream.memory.z1d.12xlarge

• stream.graphics-design.large

• stream.graphics-design.xlarge

• stream.graphics-design.2xlarge

• stream.graphics-design.4xlarge

• stream.graphics-desktop.2xlarge

• stream.graphics.g4dn.xlarge

• stream.graphics.g4dn.2xlarge

• stream.graphics.g4dn.4xlarge

• stream.graphics.g4dn.8xlarge

• stream.graphics.g4dn.12xlarge

• stream.graphics.g4dn.16xlarge

• stream.graphics-pro.4xlarge

• stream.graphics-pro.8xlarge

• stream.graphics-pro.16xlarge

The following instance types are available for Elastic fleets:

• stream.standard.small

• stream.standard.medium

• stream.standard.large

• stream.standard.xlarge

• stream.standard.2xlarge

type ComputeCapacity

dict

param ComputeCapacity

The desired capacity for the fleet. This is not allowed for Elastic fleets.

• DesiredInstances (integer) --

  The desired number of streaming instances.

• DesiredSessions (integer) --

  The desired number of user sessions for a multi-session fleet. This is not allowed for single-session fleets.

  When you create a fleet, you must set either the DesiredSessions or DesiredInstances attribute, based on the type of fleet you create. You can’t define both attributes or leave both attributes blank.

type VpcConfig

dict

param VpcConfig

The VPC configuration for the fleet. This is required for Elastic fleets, but not required for other fleet types. Elastic fleets require that you specify at least two subnets in different availability zones.

• SubnetIds (list) --

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

  • (string) --

• SecurityGroupIds (list) --

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

  • (string) --

type MaxUserDurationInSeconds

integer

param MaxUserDurationInSeconds

The maximum amount of time that a streaming session can remain active, in seconds. If users are still connected to a streaming instance five minutes before this limit is reached, they are prompted to save any open documents before being disconnected. After this time elapses, the instance is terminated and replaced by a new instance.

Specify a value between 600 and 432000.

type DisconnectTimeoutInSeconds

integer

param DisconnectTimeoutInSeconds

The amount of time that a streaming session remains active after users disconnect. If users try to reconnect to the streaming session after a disconnection or network interruption within this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance.

Specify a value between 60 and 360000.

type DeleteVpcConfig

boolean

param DeleteVpcConfig

Deletes the VPC association for the specified fleet.

type Description

string

param Description

The description to display.

type DisplayName

string

param DisplayName

The fleet name to display.

type EnableDefaultInternetAccess

boolean

param EnableDefaultInternetAccess

Enables or disables default internet access for the fleet.

type DomainJoinInfo

dict

param DomainJoinInfo

The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain.

• DirectoryName (string) --

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

• OrganizationalUnitDistinguishedName (string) --

  The distinguished name of the organizational unit for computer accounts.

type IdleDisconnectTimeoutInSeconds

integer

param IdleDisconnectTimeoutInSeconds

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

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

Note

If you enable this feature, we recommend that you specify a value that corresponds exactly to a whole number of minutes (for example, 60, 120, and 180). If you don't do this, the value is rounded to the nearest minute. For example, if you specify a value of 70, users are disconnected after 1 minute of inactivity. If you specify a value that is at the midpoint between two different minutes, the value is rounded up. For example, if you specify a value of 90, users are disconnected after 2 minutes of inactivity.

type AttributesToDelete

list

param AttributesToDelete

The fleet attributes to delete.

• (string) --

  The fleet attribute.

type IamRoleArn

string

param IamRoleArn

The Amazon Resource Name (ARN) of the IAM role to apply to the fleet. To assume a role, a fleet instance calls the AWS Security Token Service (STS) AssumeRole API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the appstream_machine_role credential profile on the instance.

For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide .

type StreamView

string

param StreamView

The AppStream 2.0 view that is displayed to your users when they stream from the fleet. When APP is specified, only the windows of applications opened by users display. When DESKTOP is specified, the standard desktop that is provided by the operating system displays.

The default value is APP .

type Platform

string

param Platform

The platform of the fleet. WINDOWS_SERVER_2019 and AMAZON_LINUX2 are supported for Elastic fleets.

type MaxConcurrentSessions

integer

param MaxConcurrentSessions

The maximum number of concurrent sessions for a fleet.

type UsbDeviceFilterStrings

list

param UsbDeviceFilterStrings

The USB device filter strings that specify which USB devices a user can redirect to the fleet streaming session, when using the Windows native client. This is allowed but not required for Elastic fleets.

• (string) --

type SessionScriptS3Location

dict

param SessionScriptS3Location

The S3 location of the session scripts configuration zip file. This only applies to Elastic fleets.

• S3Bucket (string) -- [REQUIRED]

  The S3 bucket of the S3 object.

• S3Key (string) --

  The S3 key of the S3 object.

  This is required when used for the following:

  • IconS3Location (Actions: CreateApplication and UpdateApplication)

  • SessionScriptS3Location (Actions: CreateFleet and UpdateFleet)

  • ScriptDetails (Actions: CreateAppBlock)

  • SourceS3Location when creating an app block with CUSTOM PackagingType (Actions: CreateAppBlock)

  • SourceS3Location when creating an app block with APPSTREAM2 PackagingType, and using an existing application package (VHD file). In this case, S3Key refers to the VHD file. If a new application package is required, then S3Key is not required. (Actions: CreateAppBlock)

type MaxSessionsPerInstance

integer

param MaxSessionsPerInstance

The maximum number of user sessions on an instance. This only applies to multi-session fleets.

rtype

dict

returns

Response Syntax

{
    'Fleet': {
        'Arn': 'string',
        'Name': 'string',
        'DisplayName': 'string',
        'Description': 'string',
        'ImageName': 'string',
        'ImageArn': 'string',
        'InstanceType': 'string',
        'FleetType': 'ALWAYS_ON'|'ON_DEMAND'|'ELASTIC',
        'ComputeCapacityStatus': {
            'Desired': 123,
            'Running': 123,
            'InUse': 123,
            'Available': 123,
            'DesiredUserSessions': 123,
            'AvailableUserSessions': 123,
            'ActiveUserSessions': 123,
            'ActualUserSessions': 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'|'MACHINE_ROLE_IS_MISSING'|'STS_DISABLED_IN_REGION'|'SUBNET_HAS_INSUFFICIENT_IP_ADDRESSES'|'IAM_SERVICE_ROLE_MISSING_DESCRIBE_SUBNET_ACTION'|'SUBNET_NOT_FOUND'|'IMAGE_NOT_FOUND'|'INVALID_SUBNET_CONFIGURATION'|'SECURITY_GROUPS_NOT_FOUND'|'IGW_NOT_ATTACHED'|'IAM_SERVICE_ROLE_MISSING_DESCRIBE_SECURITY_GROUPS_ACTION'|'FLEET_STOPPED'|'FLEET_INSTANCE_PROVISIONING_FAILURE'|'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'
        },
        'IdleDisconnectTimeoutInSeconds': 123,
        'IamRoleArn': 'string',
        'StreamView': 'APP'|'DESKTOP',
        'Platform': 'WINDOWS'|'WINDOWS_SERVER_2016'|'WINDOWS_SERVER_2019'|'AMAZON_LINUX2',
        'MaxConcurrentSessions': 123,
        'UsbDeviceFilterStrings': [
            'string',
        ],
        'SessionScriptS3Location': {
            'S3Bucket': 'string',
            'S3Key': 'string'
        },
        'MaxSessionsPerInstance': 123
    }
}

Response Structure

• (dict) --

  • Fleet (dict) --

    Information about the fleet.

    • Arn (string) --

      The Amazon Resource Name (ARN) for the fleet.

    • Name (string) --

      The name of the fleet.

    • DisplayName (string) --

      The fleet name to display.

    • Description (string) --

      The description to display.

    • ImageName (string) --

      The name of the image used to create the fleet.

    • ImageArn (string) --

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

    • InstanceType (string) --

      The instance type to use when launching fleet instances. The following instance types are available:

      • stream.standard.small

      • stream.standard.medium

      • stream.standard.large

      • stream.compute.large

      • stream.compute.xlarge

      • stream.compute.2xlarge

      • stream.compute.4xlarge

      • stream.compute.8xlarge

      • stream.memory.large

      • stream.memory.xlarge

      • stream.memory.2xlarge

      • stream.memory.4xlarge

      • stream.memory.8xlarge

      • stream.memory.z1d.large

      • stream.memory.z1d.xlarge

      • stream.memory.z1d.2xlarge

      • stream.memory.z1d.3xlarge

      • stream.memory.z1d.6xlarge

      • stream.memory.z1d.12xlarge

      • stream.graphics-design.large

      • stream.graphics-design.xlarge

      • stream.graphics-design.2xlarge

      • stream.graphics-design.4xlarge

      • stream.graphics-desktop.2xlarge

      • stream.graphics.g4dn.xlarge

      • stream.graphics.g4dn.2xlarge

      • stream.graphics.g4dn.4xlarge

      • stream.graphics.g4dn.8xlarge

      • stream.graphics.g4dn.12xlarge

      • stream.graphics.g4dn.16xlarge

      • stream.graphics-pro.4xlarge

      • stream.graphics-pro.8xlarge

      • stream.graphics-pro.16xlarge

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

      • DesiredUserSessions (integer) --

        The total number of sessions slots that are either running or pending. This represents the total number of concurrent streaming sessions your fleet can support in a steady state.

        DesiredUserSessionCapacity = ActualUserSessionCapacity + PendingUserSessionCapacity

        This only applies to multi-session fleets.

      • AvailableUserSessions (integer) --

        The number of idle session slots currently available for user sessions.

        AvailableUserSessionCapacity = ActualUserSessionCapacity - ActiveUserSessions

        This only applies to multi-session fleets.

      • ActiveUserSessions (integer) --

        The number of user sessions currently being used for streaming sessions. This only applies to multi-session fleets.

      • ActualUserSessions (integer) --

        The total number of session slots that are available for streaming or are currently streaming.

        ActualUserSessionCapacity = AvailableUserSessionCapacity + ActiveUserSessions

        This only applies to multi-session fleets.

    • MaxUserDurationInSeconds (integer) --

      The maximum amount of time that a streaming session can remain active, in seconds. If users are still connected to a streaming instance five minutes before this limit is reached, they are prompted to save any open documents before being disconnected. After this time elapses, the instance is terminated and replaced by a new instance.

      Specify a value between 600 and 360000.

    • DisconnectTimeoutInSeconds (integer) --

      The amount of time that a streaming session remains active after users disconnect. If they try to reconnect to the streaming session after a disconnection or network interruption within this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance.

      Specify a value between 60 and 360000.

    • State (string) --

      The current state for the fleet.

    • VpcConfig (dict) --

      The VPC configuration for the fleet.

      • SubnetIds (list) --

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

        • (string) --

      • SecurityGroupIds (list) --

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

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

      • DirectoryName (string) --

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

      • OrganizationalUnitDistinguishedName (string) --

        The distinguished name of the organizational unit for computer accounts.

    • IdleDisconnectTimeoutInSeconds (integer) --

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

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

      Note

      If you enable this feature, we recommend that you specify a value that corresponds exactly to a whole number of minutes (for example, 60, 120, and 180). If you don't do this, the value is rounded to the nearest minute. For example, if you specify a value of 70, users are disconnected after 1 minute of inactivity. If you specify a value that is at the midpoint between two different minutes, the value is rounded up. For example, if you specify a value of 90, users are disconnected after 2 minutes of inactivity.

    • IamRoleArn (string) --

      The ARN of the IAM role that is applied to the fleet. To assume a role, the fleet instance calls the AWS Security Token Service (STS) AssumeRole API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the appstream_machine_role credential profile on the instance.

      For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide .

    • StreamView (string) --

      The AppStream 2.0 view that is displayed to your users when they stream from the fleet. When APP is specified, only the windows of applications opened by users display. When DESKTOP is specified, the standard desktop that is provided by the operating system displays.

      The default value is APP .

    • Platform (string) --

      The platform of the fleet.

    • MaxConcurrentSessions (integer) --

      The maximum number of concurrent sessions for the fleet.

    • UsbDeviceFilterStrings (list) --

      The USB device filter strings associated with the fleet.

      • (string) --

    • SessionScriptS3Location (dict) --

      The S3 location of the session scripts configuration zip file. This only applies to Elastic fleets.

      • S3Bucket (string) --

        The S3 bucket of the S3 object.

      • S3Key (string) --

        The S3 key of the S3 object.

        This is required when used for the following:

        • IconS3Location (Actions: CreateApplication and UpdateApplication)

        • SessionScriptS3Location (Actions: CreateFleet and UpdateFleet)

        • ScriptDetails (Actions: CreateAppBlock)

        • SourceS3Location when creating an app block with CUSTOM PackagingType (Actions: CreateAppBlock)

        • SourceS3Location when creating an app block with APPSTREAM2 PackagingType, and using an existing application package (VHD file). In this case, S3Key refers to the VHD file. If a new application package is required, then S3Key is not required. (Actions: CreateAppBlock)

    • MaxSessionsPerInstance (integer) --

      The maximum number of user sessions on an instance. This only applies to multi-session fleets.