2016/12/01 - Amazon AppStream - 18 new api methods
Changes Update appstream client to latest version
This operation immediately stops a streaming session.
See also: AWS API Documentation
Request Syntax
client.expire_session(
SessionId='string'
)
string
[REQUIRED]
The unique identifier of the streaming session to be stopped.
dict
Response Syntax
{}
Response Structure
(dict) --
Updates an existing fleet. All the attributes except the fleet name can be updated in the STOPPED state. Only ComputeCapacity and ImageName can be updated in any other state.
See also: AWS API Documentation
Request Syntax
client.update_fleet(
ImageName='string',
Name='string',
InstanceType='string',
ComputeCapacity={
'DesiredInstances': 123
},
VpcConfig={
'SubnetIds': [
'string',
]
},
MaxUserDurationInSeconds=123,
DisconnectTimeoutInSeconds=123,
DeleteVpcConfig=True|False,
Description='string',
DisplayName='string'
)
string
The image name from which a fleet is created.
string
[REQUIRED]
The name of the fleet.
string
The instance type of compute resources for the fleet. Fleet instances are launched from this instance type.
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) -- [REQUIRED]
The list of subnets to which a network interface is established from the fleet instance.
(string) --
integer
The maximum time during which a streaming session can run.
integer
The time after disconnection when a session is considered to have ended. When the user reconnects after a disconnection, the user is connected to the same instance within this time interval.
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.
dict
Response Syntax
{
'Fleet': {
'Arn': 'string',
'Name': 'string',
'DisplayName': 'string',
'Description': 'string',
'ImageName': 'string',
'InstanceType': 'string',
'ComputeCapacityStatus': {
'Desired': 123,
'Running': 123,
'InUse': 123,
'Available': 123
},
'MaxUserDurationInSeconds': 123,
'DisconnectTimeoutInSeconds': 123,
'State': 'STARTING'|'RUNNING'|'STOPPING'|'STOPPED',
'VpcConfig': {
'SubnetIds': [
'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',
'ErrorMessage': '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 of compute resources for the fleet. The fleet instances are launched from this instance type.
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 during which a streaming session can run.
DisconnectTimeoutInSeconds (integer) --
The time after disconnection when a session is considered to have ended. When a user reconnects after a disconnection, the user is connected to the same session and instance within this time interval.
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) --
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.
Lists all fleets associated with the stack.
See also: AWS API Documentation
Request Syntax
client.list_associated_fleets(
StackName='string',
NextToken='string'
)
string
[REQUIRED]
The name of the stack whose associated fleets are listed.
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
{
'Names': [
'string',
],
'NextToken': 'string'
}
Response Structure
(dict) --
The response from a successful operation.
Names (list) --
The names of associated fleets.
(string) --
NextToken (string) --
The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
Associate a fleet to a stack.
See also: AWS API Documentation
Request Syntax
client.associate_fleet(
FleetName='string',
StackName='string'
)
string
[REQUIRED]
The name of the fleet to associate.
string
[REQUIRED]
The name of the stack to which the fleet is associated.
dict
Response Syntax
{}
Response Structure
(dict) --
Deletes the stack. After this operation completes, the environment can no longer be activated, and any reservations made for the stack are released.
See also: AWS API Documentation
Request Syntax
client.delete_stack(
Name='string'
)
string
[REQUIRED]
The name of the stack to delete.
dict
Response Syntax
{}
Response Structure
(dict) --
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',
'ComputeCapacityStatus': {
'Desired': 123,
'Running': 123,
'InUse': 123,
'Available': 123
},
'MaxUserDurationInSeconds': 123,
'DisconnectTimeoutInSeconds': 123,
'State': 'STARTING'|'RUNNING'|'STOPPING'|'STOPPED',
'VpcConfig': {
'SubnetIds': [
'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',
'ErrorMessage': '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 of compute resources for the fleet. The fleet instances are launched from this instance type.
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 during which a streaming session can run.
DisconnectTimeoutInSeconds (integer) --
The time after disconnection when a session is considered to have ended. When a user reconnects after a disconnection, the user is connected to the same session and instance within this time interval.
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) --
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.
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.
Starts a fleet.
See also: AWS API Documentation
Request Syntax
client.start_fleet(
Name='string'
)
string
[REQUIRED]
The name of the fleet to start.
dict
Response Syntax
{}
Response Structure
(dict) --
Create a new stack.
See also: AWS API Documentation
Request Syntax
client.create_stack(
Name='string',
Description='string',
DisplayName='string'
)
string
[REQUIRED]
The unique identifier for this stack.
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.
dict
Response Syntax
{
'Stack': {
'Arn': 'string',
'Name': 'string',
'Description': 'string',
'DisplayName': 'string',
'CreatedTime': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
Stack (dict) --
The details for the created stack.
Arn (string) --
The ARN of the stack.
Name (string) --
The unique identifier of the stack.
Description (string) --
A meaningful description for the stack.
DisplayName (string) --
A display name for the stack.
CreatedTime (datetime) --
The timestamp when the stack was created.
Describes the streaming sessions for a stack and a fleet. If a user ID is provided, this operation returns streaming sessions for only that user. Pass this value for the nextToken parameter in a subsequent call to this operation to retrieve the next set of items.
See also: AWS API Documentation
Request Syntax
client.describe_sessions(
StackName='string',
FleetName='string',
UserId='string',
NextToken='string',
Limit=123
)
string
[REQUIRED]
The name of the stack for which to list sessions.
string
[REQUIRED]
The name of the fleet for which to list sessions.
string
The user for whom to list sessions. Use null to describe all the sessions for the stack and fleet.
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.
integer
The size of each page of results. The default value is 20 and the maximum supported value is 50.
dict
Response Syntax
{
'Sessions': [
{
'Id': 'string',
'UserId': 'string',
'StackName': 'string',
'FleetName': 'string',
'State': 'ACTIVE'|'PENDING'|'EXPIRED'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Sessions (list) --
The list of streaming sessions.
(dict) --
Contains the parameters for a streaming session.
Id (string) --
The unique ID for a streaming session.
UserId (string) --
The identifier of the user for whom the session was created.
StackName (string) --
The name of the stack for which the streaming session was created.
FleetName (string) --
The name of the fleet for which the streaming session was created.
State (string) --
The current state of the streaming 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.
Updates the specified fields in the stack with the specified name.
See also: AWS API Documentation
Request Syntax
client.update_stack(
DisplayName='string',
Description='string',
Name='string'
)
string
The name displayed to end users on the AppStream 2.0 portal.
string
The description displayed to end users on the AppStream 2.0 portal.
string
[REQUIRED]
The name of the stack to update.
dict
Response Syntax
{
'Stack': {
'Arn': 'string',
'Name': 'string',
'Description': 'string',
'DisplayName': 'string',
'CreatedTime': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
Stack (dict) --
A list of stack details.
Arn (string) --
The ARN of the stack.
Name (string) --
The unique identifier of the stack.
Description (string) --
A meaningful description for the stack.
DisplayName (string) --
A display name for the stack.
CreatedTime (datetime) --
The timestamp when the stack was created.
Lists all stacks to which the specified fleet is associated.
See also: AWS API Documentation
Request Syntax
client.list_associated_stacks(
FleetName='string',
NextToken='string'
)
string
[REQUIRED]
The name of the fleet whose associated stacks are listed.
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
{
'Names': [
'string',
],
'NextToken': 'string'
}
Response Structure
(dict) --
The response from a successful operation.
Names (list) --
The names of associated stacks.
(string) --
NextToken (string) --
The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
If stack names are not provided, this operation describes the specified stacks; otherwise, all stacks in the account are described. Pass the nextToken value in a subsequent call to this operation to retrieve the next set of items.
See also: AWS API Documentation
Request Syntax
client.describe_stacks(
Names=[
'string',
],
NextToken='string'
)
list
The stack names to describe. Use null to describe all the stacks 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
{
'Stacks': [
{
'Arn': 'string',
'Name': 'string',
'Description': 'string',
'DisplayName': 'string',
'CreatedTime': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Stacks (list) --
The list of stack details.
(dict) --
Details about a stack.
Arn (string) --
The ARN of the stack.
Name (string) --
The unique identifier of the stack.
Description (string) --
A meaningful description for the stack.
DisplayName (string) --
A display name for the stack.
CreatedTime (datetime) --
The timestamp when the stack was created.
NextToken (string) --
The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
Creates a URL to start an AppStream 2.0 streaming session for a user. By default, the URL is valid only for 1 minute from the time that it is generated.
See also: AWS API Documentation
Request Syntax
client.create_streaming_url(
StackName='string',
FleetName='string',
UserId='string',
ApplicationId='string',
Validity=123,
SessionContext='string'
)
string
[REQUIRED]
The stack for which the URL is generated.
string
[REQUIRED]
The fleet for which the URL is generated.
string
[REQUIRED]
A unique user ID for whom the URL is generated.
string
The ID of the application that must be launched after the session starts.
integer
The validity duration of the URL in seconds. After this duration, the URL returned by this operation becomes invalid.
string
The sessionContext of the streaming URL.
dict
Response Syntax
{
'StreamingURL': 'string',
'Expires': datetime(2015, 1, 1)
}
Response Structure
(dict) --
StreamingURL (string) --
The URL to start the AppStream 2.0 streaming session.
Expires (datetime) --
Elapsed seconds after the Unix epoch, at which time this URL expires.
Describes the images. If a list of names is not provided, all images in your account are returned. This operation does not return a paginated result.
See also: AWS API Documentation
Request Syntax
client.describe_images(
Names=[
'string',
]
)
list
A specific list of images to describe.
(string) --
dict
Response Syntax
{
'Images': [
{
'Name': 'string',
'Arn': 'string',
'BaseImageArn': 'string',
'DisplayName': 'string',
'State': 'PENDING'|'AVAILABLE'|'FAILED'|'DELETING',
'Visibility': 'PUBLIC'|'PRIVATE',
'Platform': 'WINDOWS',
'Description': 'string',
'StateChangeReason': {
'Code': 'INTERNAL_ERROR'|'IMAGE_BUILDER_NOT_AVAILABLE',
'Message': 'string'
},
'Applications': [
{
'Name': 'string',
'DisplayName': 'string',
'IconURL': 'string',
'LaunchPath': 'string',
'LaunchParameters': 'string',
'Enabled': True|False,
'Metadata': {
'string': 'string'
}
},
],
'CreatedTime': datetime(2015, 1, 1)
},
]
}
Response Structure
(dict) --
Images (list) --
The list of images.
(dict) --
New streaming instances are booted from images. The image stores the application catalog and is connected to fleets.
Name (string) --
The unique identifier for the image.
Arn (string) --
The ARN for the image.
BaseImageArn (string) --
The source image ARN from which this image was created.
DisplayName (string) --
The display name for the image.
State (string) --
The image starts in the PENDING state, and then moves to AVAILABLE if image creation succeeds and FAILED if image creation has failed.
Visibility (string) --
The visibility of an image to the user; images can be public or private.
Platform (string) --
The operating system platform of the image.
Description (string) --
A meaningful description for the image.
StateChangeReason (dict) --
The reason why the last state change occurred.
Code (string) --
The state change reason code of the image.
Message (string) --
The state change reason message to the end user.
Applications (list) --
The applications associated with an image.
(dict) --
An entry for a single application in the application catalog.
Name (string) --
The unique identifier for the application.
DisplayName (string) --
The name of the application shown to the end users.
IconURL (string) --
The URL for the application icon. This URL may be time-limited.
LaunchPath (string) --
The path to the application executable in the instance.
LaunchParameters (string) --
A list of arguments that are passed to the application at launch.
Enabled (boolean) --
An application can be disabled after image creation if there is a problem.
Metadata (dict) --
Additional attributes that describes the application.
(string) --
(string) --
CreatedTime (datetime) --
The timestamp when the image was created.
Stops a fleet.
See also: AWS API Documentation
Request Syntax
client.stop_fleet(
Name='string'
)
string
[REQUIRED]
The name of the fleet to stop.
dict
Response Syntax
{}
Response Structure
(dict) --
Deletes a fleet.
See also: AWS API Documentation
Request Syntax
client.delete_fleet(
Name='string'
)
string
[REQUIRED]
The name of the fleet to be deleted.
dict
Response Syntax
{}
Response Structure
(dict) --
Creates a new fleet.
See also: AWS API Documentation
Request Syntax
client.create_fleet(
Name='string',
ImageName='string',
InstanceType='string',
ComputeCapacity={
'DesiredInstances': 123
},
VpcConfig={
'SubnetIds': [
'string',
]
},
MaxUserDurationInSeconds=123,
DisconnectTimeoutInSeconds=123,
Description='string',
DisplayName='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 of compute resources for the fleet. Fleet instances are launched from this instance type.
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) -- [REQUIRED]
The list of subnets to which a network interface is established from the fleet instance.
(string) --
integer
The maximum time up to which a streaming session can run.
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 his/her previous session.
string
The description of the fleet.
string
The display name of the fleet.
dict
Response Syntax
{
'Fleet': {
'Arn': 'string',
'Name': 'string',
'DisplayName': 'string',
'Description': 'string',
'ImageName': 'string',
'InstanceType': 'string',
'ComputeCapacityStatus': {
'Desired': 123,
'Running': 123,
'InUse': 123,
'Available': 123
},
'MaxUserDurationInSeconds': 123,
'DisconnectTimeoutInSeconds': 123,
'State': 'STARTING'|'RUNNING'|'STOPPING'|'STOPPED',
'VpcConfig': {
'SubnetIds': [
'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',
'ErrorMessage': '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 of compute resources for the fleet. The fleet instances are launched from this instance type.
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 during which a streaming session can run.
DisconnectTimeoutInSeconds (integer) --
The time after disconnection when a session is considered to have ended. When a user reconnects after a disconnection, the user is connected to the same session and instance within this time interval.
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) --
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.
Disassociates a fleet from a stack.
See also: AWS API Documentation
Request Syntax
client.disassociate_fleet(
FleetName='string',
StackName='string'
)
string
[REQUIRED]
The name of the fleet to disassociate.
string
[REQUIRED]
The name of the stack with which the fleet is associated.
dict
Response Syntax
{}
Response Structure
(dict) --