AppStream / Client / describe_fleets

describe_fleets#

AppStream.Client.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.

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'|'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'|'WINDOWS_SERVER_2022'|'AMAZON_LINUX2'|'RHEL8'|'ROCKY_LINUX8',
            '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 36000.
    - 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 36000. 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.

Exceptions

AppStream.Client.exceptions.ResourceNotFoundException