2017/09/20 - Amazon AppStream - 3 updated api methods
Changes API updates for supporting On-Demand fleets.
{'FleetType': 'ALWAYS_ON | ON_DEMAND'}Response
{'Fleet': {'FleetErrors': {'ErrorCode': ['IGW_NOT_ATTACHED']}, 'FleetType': 'ALWAYS_ON | ON_DEMAND'}}
Creates a new fleet.
See also: AWS API Documentation
Request Syntax
client.create_fleet( Name='string', ImageName='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' } )
string
[REQUIRED]
A unique identifier for the fleet.
string
[REQUIRED]
Unique name of the image used by the fleet.
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
string
dict
[REQUIRED]
The parameters for the capacity allocated to the fleet.
DesiredInstances (integer) -- [REQUIRED]
The desired number of streaming instances.
dict
The VPC configuration for the fleet.
SubnetIds (list) --
The list of subnets to which a network interface is established from the fleet instance.
(string) --
SecurityGroupIds (list) --
Security groups associated with the fleet.
(string) --
integer
The maximum time for which a streaming session can run. The input can be any numeric value in seconds between 600 and 57600.
integer
The time after disconnection when a session is considered to have ended. If a user who got disconnected reconnects within this timeout interval, the user is connected back to their previous session. The input can be any numeric value in seconds between 60 and 57600.
string
The description of the fleet.
string
The display name of the fleet.
boolean
Enables or disables default internet access for the fleet.
dict
The DirectoryName and OrganizationalUnitDistinguishedName values, which are used to join domains for the AppStream 2.0 streaming instances.
DirectoryName (string) --
The fully qualified name of the directory, such as corp.example.com
OrganizationalUnitDistinguishedName (string) --
The distinguished name of the organizational unit to place the computer account in.
dict
Response Syntax
{ 'Fleet': { 'Arn': 'string', 'Name': 'string', 'DisplayName': 'string', 'Description': 'string', 'ImageName': '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) --
The details for the created fleet.
Arn (string) --
The ARN for the fleet.
Name (string) --
The name of the fleet.
DisplayName (string) --
The name displayed to end users on the AppStream 2.0 portal.
Description (string) --
The description displayed to end users on the AppStream 2.0 portal.
ImageName (string) --
The image used by the fleet.
InstanceType (string) --
The instance type to use when launching fleet instances.
FleetType (string) --
ComputeCapacityStatus (dict) --
The capacity information 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 that are being used for streaming.
Available (integer) --
The number of currently available instances that can be used to stream sessions.
MaxUserDurationInSeconds (integer) --
The maximum time for which a streaming session can run. The value can be any numeric value in seconds between 600 and 57600.
DisconnectTimeoutInSeconds (integer) --
The time after disconnection when a session is considered to have ended. If a user who got disconnected reconnects within this timeout interval, the user is connected back to their previous session. The input can be any numeric value in seconds between 60 and 57600.
State (string) --
The current state for the fleet.
VpcConfig (dict) --
The VPC configuration for the fleet.
SubnetIds (list) --
The list of subnets to which a network interface is established from the fleet instance.
(string) --
SecurityGroupIds (list) --
Security groups associated with the fleet.
(string) --
CreatedTime (datetime) --
The time at which the fleet was created.
FleetErrors (list) --
The list of fleet errors is appended to this list.
(dict) --
The details of the fleet error.
ErrorCode (string) --
The error code for the fleet error.
ErrorMessage (string) --
The error message generated when the fleet has errors.
EnableDefaultInternetAccess (boolean) --
Whether default internet access is enabled for the fleet.
DomainJoinInfo (dict) --
The DirectoryName and OrganizationalUnitDistinguishedName values, which are used to join domains for the AppStream 2.0 streaming instances.
DirectoryName (string) --
The fully qualified name of the directory, such as corp.example.com
OrganizationalUnitDistinguishedName (string) --
The distinguished name of the organizational unit to place the computer account in.
{'Fleets': {'FleetErrors': {'ErrorCode': ['IGW_NOT_ATTACHED']}, 'FleetType': 'ALWAYS_ON | ON_DEMAND'}}
If fleet names are provided, this operation describes the specified fleets; otherwise, all the fleets in the account are described.
See also: AWS API Documentation
Request Syntax
client.describe_fleets( Names=[ 'string', ], NextToken='string' )
list
The fleet names to describe. Use null to describe all the fleets for the AWS account.
(string) --
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.
dict
Response Syntax
{ 'Fleets': [ { 'Arn': 'string', 'Name': 'string', 'DisplayName': 'string', 'Description': 'string', 'ImageName': '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) --
The list of fleet details.
(dict) --
Contains the parameters for a fleet.
Arn (string) --
The ARN for the fleet.
Name (string) --
The name of the fleet.
DisplayName (string) --
The name displayed to end users on the AppStream 2.0 portal.
Description (string) --
The description displayed to end users on the AppStream 2.0 portal.
ImageName (string) --
The image used by the fleet.
InstanceType (string) --
The instance type to use when launching fleet instances.
FleetType (string) --
ComputeCapacityStatus (dict) --
The capacity information 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 that are being used for streaming.
Available (integer) --
The number of currently available instances that can be used to stream sessions.
MaxUserDurationInSeconds (integer) --
The maximum time for which a streaming session can run. The value can be any numeric value in seconds between 600 and 57600.
DisconnectTimeoutInSeconds (integer) --
The time after disconnection when a session is considered to have ended. If a user who got disconnected reconnects within this timeout interval, the user is connected back to their previous session. The input can be any numeric value in seconds between 60 and 57600.
State (string) --
The current state for the fleet.
VpcConfig (dict) --
The VPC configuration for the fleet.
SubnetIds (list) --
The list of subnets to which a network interface is established from the fleet instance.
(string) --
SecurityGroupIds (list) --
Security groups associated with the fleet.
(string) --
CreatedTime (datetime) --
The time at which the fleet was created.
FleetErrors (list) --
The list of fleet errors is appended to this list.
(dict) --
The details of the fleet error.
ErrorCode (string) --
The error code for the fleet error.
ErrorMessage (string) --
The error message generated when the fleet has errors.
EnableDefaultInternetAccess (boolean) --
Whether default internet access is enabled for the fleet.
DomainJoinInfo (dict) --
The DirectoryName and OrganizationalUnitDistinguishedName values, which are used to join domains for the AppStream 2.0 streaming instances.
DirectoryName (string) --
The fully qualified name of the directory, such as corp.example.com
OrganizationalUnitDistinguishedName (string) --
The distinguished name of the organizational unit to place the computer account in.
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.
{'Fleet': {'FleetErrors': {'ErrorCode': ['IGW_NOT_ATTACHED']}, 'FleetType': 'ALWAYS_ON | ON_DEMAND'}}
Updates an existing fleet. All the attributes except the fleet name can be updated in the STOPPED state. When a fleet is in the RUNNING state, only DisplayName and ComputeCapacity can be updated. A fleet cannot be updated in a status of STARTING or STOPPING .
See also: AWS API Documentation
Request Syntax
client.update_fleet( ImageName='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', ] )
string
The image name from which a fleet is created.
string
[REQUIRED]
The name of the fleet.
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
dict
The parameters for the capacity allocated to the fleet.
DesiredInstances (integer) -- [REQUIRED]
The desired number of streaming instances.
dict
The VPC configuration for the fleet.
SubnetIds (list) --
The list of subnets to which a network interface is established from the fleet instance.
(string) --
SecurityGroupIds (list) --
Security groups associated with the fleet.
(string) --
integer
The maximum time for which a streaming session can run. The input can be any numeric value in seconds between 600 and 57600.
integer
The time after disconnection when a session is considered to have ended. If a user who got disconnected reconnects within this timeout interval, the user is connected back to their previous session. The input can be any numeric value in seconds between 60 and 57600.
boolean
Delete the VPC association for the specified fleet.
string
The description displayed to end users on the AppStream 2.0 portal.
string
The name displayed to end users on the AppStream 2.0 portal.
boolean
Enables or disables default internet access for the fleet.
dict
The DirectoryName and OrganizationalUnitDistinguishedName values, which are used to join domains for the AppStream 2.0 streaming instances.
DirectoryName (string) --
The fully qualified name of the directory, such as corp.example.com
OrganizationalUnitDistinguishedName (string) --
The distinguished name of the organizational unit to place the computer account in.
list
Fleet attributes to be deleted.
(string) --
Fleet attribute.
dict
Response Syntax
{ 'Fleet': { 'Arn': 'string', 'Name': 'string', 'DisplayName': 'string', 'Description': 'string', 'ImageName': '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) --
A list of fleet details.
Arn (string) --
The ARN for the fleet.
Name (string) --
The name of the fleet.
DisplayName (string) --
The name displayed to end users on the AppStream 2.0 portal.
Description (string) --
The description displayed to end users on the AppStream 2.0 portal.
ImageName (string) --
The image used by the fleet.
InstanceType (string) --
The instance type to use when launching fleet instances.
FleetType (string) --
ComputeCapacityStatus (dict) --
The capacity information 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 that are being used for streaming.
Available (integer) --
The number of currently available instances that can be used to stream sessions.
MaxUserDurationInSeconds (integer) --
The maximum time for which a streaming session can run. The value can be any numeric value in seconds between 600 and 57600.
DisconnectTimeoutInSeconds (integer) --
The time after disconnection when a session is considered to have ended. If a user who got disconnected reconnects within this timeout interval, the user is connected back to their previous session. The input can be any numeric value in seconds between 60 and 57600.
State (string) --
The current state for the fleet.
VpcConfig (dict) --
The VPC configuration for the fleet.
SubnetIds (list) --
The list of subnets to which a network interface is established from the fleet instance.
(string) --
SecurityGroupIds (list) --
Security groups associated with the fleet.
(string) --
CreatedTime (datetime) --
The time at which the fleet was created.
FleetErrors (list) --
The list of fleet errors is appended to this list.
(dict) --
The details of the fleet error.
ErrorCode (string) --
The error code for the fleet error.
ErrorMessage (string) --
The error message generated when the fleet has errors.
EnableDefaultInternetAccess (boolean) --
Whether default internet access is enabled for the fleet.
DomainJoinInfo (dict) --
The DirectoryName and OrganizationalUnitDistinguishedName values, which are used to join domains for the AppStream 2.0 streaming instances.
DirectoryName (string) --
The fully qualified name of the directory, such as corp.example.com
OrganizationalUnitDistinguishedName (string) --
The distinguished name of the organizational unit to place the computer account in.