Amazon AppStream

Retrieves a list that describes the permissions for a private image that you own.

See also: AWS API Documentation

Request Syntax

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

type Name:

string

param Name:

[REQUIRED]

The name of the private image for which to describe permissions. The image must be one that you own.

type MaxResults:

integer

param MaxResults:

The maximum size of each results page.

type SharedAwsAccountIds:

list

param SharedAwsAccountIds:

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

• (string) --

type NextToken:

string

param NextToken:

The pagination token to use to retrieve the next page of results. If this value is empty, only the first page is retrieved.

rtype:

dict

returns:

Response Syntax

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

Response Structure

• (dict) --

  • Name (string) --

    The name of the private image.

  • SharedImagePermissionsList (list) --

    The permissions for a private image that you own.

    • (dict) --

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

      • sharedAccountId (string) --

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

      • imagePermissions (dict) --

        Describes the permissions for a shared image.

        • allowFleet (boolean) --

          Indicates whether the image can be used for a fleet.

        • allowImageBuilder (boolean) --

          Indicates whether the image can be used for an image builder.

  • NextToken (string) --

    The pagination token to use to retrieve the next page of results. If this value is empty, only the first page is retrieved.

Deletes permissions for the specified private image. After you delete permissions for an image, AWS accounts to which you previously granted these permissions can no longer use the image.

See also: AWS API Documentation

Request Syntax

client.delete_image_permissions(
    Name='string',
    SharedAccountId='string'
)

type Name:

string

param Name:

[REQUIRED]

The name of the private image.

type SharedAccountId:

string

param SharedAccountId:

[REQUIRED]

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

rtype:

dict

returns:

Response Syntax

{}

Response Structure

• (dict) --

Adds or updates permissions for the specified private image.

See also: AWS API Documentation

Request Syntax

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

type Name:

string

param Name:

[REQUIRED]

The name of the private image.

type SharedAccountId:

string

param SharedAccountId:

[REQUIRED]

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

type ImagePermissions:

dict

param ImagePermissions:

[REQUIRED]

The permissions for the image.

• allowFleet (boolean) --

  Indicates whether the image can be used for a fleet.

• allowImageBuilder (boolean) --

  Indicates whether the image can be used for an image builder.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

• (dict) --

{'ImageArn': 'string'}

{'Fleet': {'ImageArn': 'string'}}

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

See also: AWS API Documentation

Request Syntax

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

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

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:

[REQUIRED]

The desired capacity for the fleet.

• DesiredInstances (integer) -- [REQUIRED]

  The desired number of streaming instances.

type VpcConfig:

dict

param VpcConfig:

The VPC configuration for the fleet.

• SubnetIds (list) --

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

  • (string) --

• SecurityGroupIds (list) --

  The security groups for the fleet.

  • (string) --

type MaxUserDurationInSeconds:

integer

param MaxUserDurationInSeconds:

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

type DisconnectTimeoutInSeconds:

integer

param DisconnectTimeoutInSeconds:

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

type Description:

string

param Description:

The description for display.

type DisplayName:

string

param DisplayName:

The fleet name for display.

type EnableDefaultInternetAccess:

boolean

param EnableDefaultInternetAccess:

Enables or disables default internet access for the fleet.

type DomainJoinInfo:

dict

param DomainJoinInfo:

The information needed to join a Microsoft Active Directory domain.

• DirectoryName (string) --

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

• OrganizationalUnitDistinguishedName (string) --

  The distinguished name of the organizational unit for computer accounts.

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',
        'ComputeCapacityStatus': {
            'Desired': 123,
            'Running': 123,
            'InUse': 123,
            'Available': 123
        },
        'MaxUserDurationInSeconds': 123,
        'DisconnectTimeoutInSeconds': 123,
        'State': 'STARTING'|'RUNNING'|'STOPPING'|'STOPPED',
        'VpcConfig': {
            'SubnetIds': [
                'string',
            ],
            'SecurityGroupIds': [
                'string',
            ]
        },
        'CreatedTime': datetime(2015, 1, 1),
        'FleetErrors': [
            {
                'ErrorCode': 'IAM_SERVICE_ROLE_MISSING_ENI_DESCRIBE_ACTION'|'IAM_SERVICE_ROLE_MISSING_ENI_CREATE_ACTION'|'IAM_SERVICE_ROLE_MISSING_ENI_DELETE_ACTION'|'NETWORK_INTERFACE_LIMIT_EXCEEDED'|'INTERNAL_SERVICE_ERROR'|'IAM_SERVICE_ROLE_IS_MISSING'|'SUBNET_HAS_INSUFFICIENT_IP_ADDRESSES'|'IAM_SERVICE_ROLE_MISSING_DESCRIBE_SUBNET_ACTION'|'SUBNET_NOT_FOUND'|'IMAGE_NOT_FOUND'|'INVALID_SUBNET_CONFIGURATION'|'SECURITY_GROUPS_NOT_FOUND'|'IGW_NOT_ATTACHED'|'IAM_SERVICE_ROLE_MISSING_DESCRIBE_SECURITY_GROUPS_ACTION'|'DOMAIN_JOIN_ERROR_FILE_NOT_FOUND'|'DOMAIN_JOIN_ERROR_ACCESS_DENIED'|'DOMAIN_JOIN_ERROR_LOGON_FAILURE'|'DOMAIN_JOIN_ERROR_INVALID_PARAMETER'|'DOMAIN_JOIN_ERROR_MORE_DATA'|'DOMAIN_JOIN_ERROR_NO_SUCH_DOMAIN'|'DOMAIN_JOIN_ERROR_NOT_SUPPORTED'|'DOMAIN_JOIN_NERR_INVALID_WORKGROUP_NAME'|'DOMAIN_JOIN_NERR_WORKSTATION_NOT_STARTED'|'DOMAIN_JOIN_ERROR_DS_MACHINE_ACCOUNT_QUOTA_EXCEEDED'|'DOMAIN_JOIN_NERR_PASSWORD_EXPIRED'|'DOMAIN_JOIN_INTERNAL_SERVICE_ERROR',
                'ErrorMessage': 'string'
            },
        ],
        'EnableDefaultInternetAccess': True|False,
        'DomainJoinInfo': {
            'DirectoryName': 'string',
            'OrganizationalUnitDistinguishedName': 'string'
        }
    }
}

Response Structure

• (dict) --

  • Fleet (dict) --

    Information about the fleet.

    • Arn (string) --

      The ARN for the fleet.

    • Name (string) --

      The name of the fleet.

    • DisplayName (string) --

      The fleet name for display.

    • Description (string) --

      The description for display.

    • ImageName (string) --

      The name of the image used to create the fleet.

    • ImageArn (string) --

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

    • InstanceType (string) --

      The instance type to use when launching fleet instances.

    • FleetType (string) --

      The fleet type.

      ALWAYS_ON

      Provides users with instant-on access to their apps. You are charged for all running instances in your fleet, even if no users are streaming apps.

      ON_DEMAND

      Provide users with access to applications after they connect, which takes one to two minutes. You are charged for instance streaming when users are connected and a small hourly fee for instances that are not streaming apps.

    • ComputeCapacityStatus (dict) --

      The capacity status for the fleet.

      • Desired (integer) --

        The desired number of streaming instances.

      • Running (integer) --

        The total number of simultaneous streaming instances that are running.

      • InUse (integer) --

        The number of instances in use for streaming.

      • Available (integer) --

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

    • MaxUserDurationInSeconds (integer) --

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

    • DisconnectTimeoutInSeconds (integer) --

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

    • State (string) --

      The current state for the fleet.

    • VpcConfig (dict) --

      The VPC configuration for the fleet.

      • SubnetIds (list) --

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

        • (string) --

      • SecurityGroupIds (list) --

        The security groups for the fleet.

        • (string) --

    • CreatedTime (datetime) --

      The time the fleet was created.

    • FleetErrors (list) --

      The fleet errors.

      • (dict) --

        Describes a fleet error.

        • ErrorCode (string) --

          The error code.

        • ErrorMessage (string) --

          The error message.

    • EnableDefaultInternetAccess (boolean) --

      Indicates whether default internet access is enabled for the fleet.

    • DomainJoinInfo (dict) --

      The information needed to join a Microsoft Active Directory domain.

      • DirectoryName (string) --

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

      • OrganizationalUnitDistinguishedName (string) --

        The distinguished name of the organizational unit for computer accounts.

{'ImageArn': 'string'}

Creates an image builder. An image builder is a virtual machine that is used to create an image.

The initial state of the builder is PENDING. When it is ready, the state is RUNNING.

See also: AWS API Documentation

Request Syntax

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

type Name:

string

param Name:

[REQUIRED]

A unique name for the image builder.

type ImageName:

string

param ImageName:

The name of the image used to create the builder.

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 the image builder.

type Description:

string

param Description:

The description for display.

type DisplayName:

string

param DisplayName:

The image builder name for display.

type VpcConfig:

dict

param VpcConfig:

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

• SubnetIds (list) --

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

  • (string) --

• SecurityGroupIds (list) --

  The security groups for the fleet.

  • (string) --

type EnableDefaultInternetAccess:

boolean

param EnableDefaultInternetAccess:

Enables or disables default internet access for the image builder.

type DomainJoinInfo:

dict

param DomainJoinInfo:

The information needed to join a Microsoft Active Directory domain.

• DirectoryName (string) --

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

• OrganizationalUnitDistinguishedName (string) --

  The distinguished name of the organizational unit for computer accounts.

type AppstreamAgentVersion:

string

param AppstreamAgentVersion:

The version of the AppStream 2.0 agent to use for this image builder. To use the latest version of the AppStream 2.0 agent, specify [LATEST].

rtype:

dict

returns:

Response Syntax

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

Response Structure

• (dict) --

  • ImageBuilder (dict) --

    Information about the image builder.

    • Name (string) --

      The name of the image builder.

    • Arn (string) --

      The ARN for the image builder.

    • ImageArn (string) --

      The ARN of the image from which this builder was created.

    • Description (string) --

      The description for display.

    • DisplayName (string) --

      The image builder name for display.

    • VpcConfig (dict) --

      The VPC configuration of the image builder.

      • SubnetIds (list) --

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

        • (string) --

      • SecurityGroupIds (list) --

        The security groups for the fleet.

        • (string) --

    • InstanceType (string) --

      The instance type for the image builder.

    • Platform (string) --

      The operating system platform of the image builder.

    • State (string) --

      The state of the image builder.

    • StateChangeReason (dict) --

      The reason why the last state change occurred.

      • Code (string) --

        The state change reason code.

      • Message (string) --

        The state change reason message.

    • CreatedTime (datetime) --

      The time stamp when the image builder was created.

    • EnableDefaultInternetAccess (boolean) --

      Enables or disables default internet access for the image builder.

    • DomainJoinInfo (dict) --

      The information needed to join a Microsoft Active Directory domain.

      • DirectoryName (string) --

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

      • OrganizationalUnitDistinguishedName (string) --

        The distinguished name of the organizational unit for computer accounts.

    • ImageBuilderErrors (list) --

      The image builder errors.

      • (dict) --

        Describes a resource error.

        • ErrorCode (string) --

          The error code.

        • ErrorMessage (string) --

          The error message.

        • ErrorTimestamp (datetime) --

          The time the error occurred.

    • AppstreamAgentVersion (string) --

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

{'Image': {'ImagePermissions': {'allowFleet': 'boolean',
                                'allowImageBuilder': 'boolean'},
           'Visibility': {'SHARED'}}}

Deletes the specified image. You cannot delete an image when it is in use. After you delete an image, you cannot provision new capacity using the image.

See also: AWS API Documentation

Request Syntax

client.delete_image(
    Name='string'
)

type Name:

string

param Name:

[REQUIRED]

The name of the image.

rtype:

dict

returns:

Response Syntax

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

Response Structure

• (dict) --

  • Image (dict) --

    Information about the image.

    • Name (string) --

      The name of the image.

    • Arn (string) --

      The ARN of the image.

    • BaseImageArn (string) --

      The ARN of the image from which this image was created.

    • DisplayName (string) --

      The image name for display.

    • State (string) --

      The image starts in the PENDING state. If image creation succeeds, the state is AVAILABLE. If image creation fails, the state is FAILED.

    • Visibility (string) --

      Indicates whether the image is public or private.

    • ImageBuilderSupported (boolean) --

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

    • Platform (string) --

      The operating system platform of the image.

    • Description (string) --

      The description for display.

    • StateChangeReason (dict) --

      The reason why the last state change occurred.

      • Code (string) --

        The state change reason code.

      • Message (string) --

        The state change reason message.

    • Applications (list) --

      The applications associated with the image.

      • (dict) --

        Describes an application in the application catalog.

        • Name (string) --

          The name of the application.

        • DisplayName (string) --

          The application name for display.

        • IconURL (string) --

          The URL for the application icon. This URL might be time-limited.

        • LaunchPath (string) --

          The path to the application executable in the instance.

        • LaunchParameters (string) --

          The arguments that are passed to the application at launch.

        • Enabled (boolean) --

          If there is a problem, the application can be disabled after image creation.

        • Metadata (dict) --

          Additional attributes that describe the application.

          • (string) --

            • (string) --

    • CreatedTime (datetime) --

      The time the image was created.

    • PublicBaseImageReleasedDate (datetime) --

      The release date of the public base image. For private images, this date is the release date of the base image from which the image was created.

    • AppstreamAgentVersion (string) --

      The version of the AppStream 2.0 agent to use for instances that are launched from this image.

    • ImagePermissions (dict) --

      The permissions to provide to the destination AWS account for the specified image.

      • allowFleet (boolean) --

        Indicates whether the image can be used for a fleet.

      • allowImageBuilder (boolean) --

        Indicates whether the image can be used for an image builder.

{'Fleets': {'ImageArn': 'string'}}

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',
            'ComputeCapacityStatus': {
                'Desired': 123,
                'Running': 123,
                'InUse': 123,
                'Available': 123
            },
            'MaxUserDurationInSeconds': 123,
            'DisconnectTimeoutInSeconds': 123,
            'State': 'STARTING'|'RUNNING'|'STOPPING'|'STOPPED',
            'VpcConfig': {
                'SubnetIds': [
                    'string',
                ],
                'SecurityGroupIds': [
                    'string',
                ]
            },
            'CreatedTime': datetime(2015, 1, 1),
            'FleetErrors': [
                {
                    'ErrorCode': 'IAM_SERVICE_ROLE_MISSING_ENI_DESCRIBE_ACTION'|'IAM_SERVICE_ROLE_MISSING_ENI_CREATE_ACTION'|'IAM_SERVICE_ROLE_MISSING_ENI_DELETE_ACTION'|'NETWORK_INTERFACE_LIMIT_EXCEEDED'|'INTERNAL_SERVICE_ERROR'|'IAM_SERVICE_ROLE_IS_MISSING'|'SUBNET_HAS_INSUFFICIENT_IP_ADDRESSES'|'IAM_SERVICE_ROLE_MISSING_DESCRIBE_SUBNET_ACTION'|'SUBNET_NOT_FOUND'|'IMAGE_NOT_FOUND'|'INVALID_SUBNET_CONFIGURATION'|'SECURITY_GROUPS_NOT_FOUND'|'IGW_NOT_ATTACHED'|'IAM_SERVICE_ROLE_MISSING_DESCRIBE_SECURITY_GROUPS_ACTION'|'DOMAIN_JOIN_ERROR_FILE_NOT_FOUND'|'DOMAIN_JOIN_ERROR_ACCESS_DENIED'|'DOMAIN_JOIN_ERROR_LOGON_FAILURE'|'DOMAIN_JOIN_ERROR_INVALID_PARAMETER'|'DOMAIN_JOIN_ERROR_MORE_DATA'|'DOMAIN_JOIN_ERROR_NO_SUCH_DOMAIN'|'DOMAIN_JOIN_ERROR_NOT_SUPPORTED'|'DOMAIN_JOIN_NERR_INVALID_WORKGROUP_NAME'|'DOMAIN_JOIN_NERR_WORKSTATION_NOT_STARTED'|'DOMAIN_JOIN_ERROR_DS_MACHINE_ACCOUNT_QUOTA_EXCEEDED'|'DOMAIN_JOIN_NERR_PASSWORD_EXPIRED'|'DOMAIN_JOIN_INTERNAL_SERVICE_ERROR',
                    'ErrorMessage': 'string'
                },
            ],
            'EnableDefaultInternetAccess': True|False,
            'DomainJoinInfo': {
                'DirectoryName': 'string',
                'OrganizationalUnitDistinguishedName': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • Fleets (list) --

    Information about the fleets.

    • (dict) --

      Contains the parameters for a fleet.

      • Arn (string) --

        The ARN for the fleet.

      • Name (string) --

        The name of the fleet.

      • DisplayName (string) --

        The fleet name for display.

      • Description (string) --

        The description for display.

      • ImageName (string) --

        The name of the image used to create the fleet.

      • ImageArn (string) --

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

      • InstanceType (string) --

        The instance type to use when launching fleet instances.

      • FleetType (string) --

        The fleet type.

        ALWAYS_ON

        Provides users with instant-on access to their apps. You are charged for all running instances in your fleet, even if no users are streaming apps.

        ON_DEMAND

        Provide users with access to applications after they connect, which takes one to two minutes. You are charged for instance streaming when users are connected and a small hourly fee for instances that are not streaming apps.

      • ComputeCapacityStatus (dict) --

        The capacity status for the fleet.

        • Desired (integer) --

          The desired number of streaming instances.

        • Running (integer) --

          The total number of simultaneous streaming instances that are running.

        • InUse (integer) --

          The number of instances in use for streaming.

        • Available (integer) --

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

      • MaxUserDurationInSeconds (integer) --

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

      • DisconnectTimeoutInSeconds (integer) --

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

      • State (string) --

        The current state for the fleet.

      • VpcConfig (dict) --

        The VPC configuration for the fleet.

        • SubnetIds (list) --

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

          • (string) --

        • SecurityGroupIds (list) --

          The security groups for the fleet.

          • (string) --

      • CreatedTime (datetime) --

        The time the fleet was created.

      • FleetErrors (list) --

        The fleet errors.

        • (dict) --

          Describes a fleet error.

          • ErrorCode (string) --

            The error code.

          • ErrorMessage (string) --

            The error message.

      • EnableDefaultInternetAccess (boolean) --

        Indicates whether default internet access is enabled for the fleet.

      • DomainJoinInfo (dict) --

        The information needed to join a Microsoft Active Directory domain.

        • DirectoryName (string) --

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

        • OrganizationalUnitDistinguishedName (string) --

          The distinguished name of the organizational unit for computer accounts.

  • NextToken (string) --

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

{'Arns': ['string'], 'Type': 'PUBLIC | PRIVATE | SHARED'}

{'Images': {'ImagePermissions': {'allowFleet': 'boolean',
                                 'allowImageBuilder': 'boolean'},
            'Visibility': {'SHARED'}}}

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

See also: AWS API Documentation

Request Syntax

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

type Names:

list

param Names:

The names of the images to describe.

• (string) --

type Arns:

list

param Arns:

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

• (string) --

type Type:

string

param Type:

The type of image (public, private, or shared) to describe.

type NextToken:

string

param NextToken:

The pagination token to use to retrieve the next page of results. If this value is empty, only the first page is retrieved.

type MaxResults:

integer

param MaxResults:

The maximum size of each page of results.

rtype:

dict

returns:

Response Syntax

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

Response Structure

• (dict) --

  • Images (list) --

    Information about the images.

    • (dict) --

      Describes an image.

      • Name (string) --

        The name of the image.

      • Arn (string) --

        The ARN of the image.

      • BaseImageArn (string) --

        The ARN of the image from which this image was created.

      • DisplayName (string) --

        The image name for display.

      • State (string) --

        The image starts in the PENDING state. If image creation succeeds, the state is AVAILABLE. If image creation fails, the state is FAILED.

      • Visibility (string) --

        Indicates whether the image is public or private.

      • ImageBuilderSupported (boolean) --

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

      • Platform (string) --

        The operating system platform of the image.

      • Description (string) --

        The description for display.

      • StateChangeReason (dict) --

        The reason why the last state change occurred.

        • Code (string) --

          The state change reason code.

        • Message (string) --

          The state change reason message.

      • Applications (list) --

        The applications associated with the image.

        • (dict) --

          Describes an application in the application catalog.

          • Name (string) --

            The name of the application.

          • DisplayName (string) --

            The application name for display.

          • IconURL (string) --

            The URL for the application icon. This URL might be time-limited.

          • LaunchPath (string) --

            The path to the application executable in the instance.

          • LaunchParameters (string) --

            The arguments that are passed to the application at launch.

          • Enabled (boolean) --

            If there is a problem, the application can be disabled after image creation.

          • Metadata (dict) --

            Additional attributes that describe the application.

            • (string) --

              • (string) --

      • CreatedTime (datetime) --

        The time the image was created.

      • PublicBaseImageReleasedDate (datetime) --

        The release date of the public base image. For private images, this date is the release date of the base image from which the image was created.

      • AppstreamAgentVersion (string) --

        The version of the AppStream 2.0 agent to use for instances that are launched from this image.

      • ImagePermissions (dict) --

        The permissions to provide to the destination AWS account for the specified image.

        • allowFleet (boolean) --

          Indicates whether the image can be used for a fleet.

        • allowImageBuilder (boolean) --

          Indicates whether the image can be used for an image builder.

  • NextToken (string) --

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

{'ImageArn': 'string'}

{'Fleet': {'ImageArn': 'string'}}

Updates the specified fleet.

If the fleet is in the STOPPED state, you can update any attribute except the fleet name. If the fleet is in the RUNNING state, you can update the DisplayName and ComputeCapacity attributes. If the fleet is in the STARTING or STOPPING state, you can't update it.

See also: AWS API Documentation

Request Syntax

client.update_fleet(
    ImageName='string',
    ImageArn='string',
    Name='string',
    InstanceType='string',
    ComputeCapacity={
        'DesiredInstances': 123
    },
    VpcConfig={
        'SubnetIds': [
            'string',
        ],
        'SecurityGroupIds': [
            'string',
        ]
    },
    MaxUserDurationInSeconds=123,
    DisconnectTimeoutInSeconds=123,
    DeleteVpcConfig=True|False,
    Description='string',
    DisplayName='string',
    EnableDefaultInternetAccess=True|False,
    DomainJoinInfo={
        'DirectoryName': 'string',
        'OrganizationalUnitDistinguishedName': 'string'
    },
    AttributesToDelete=[
        'VPC_CONFIGURATION'|'VPC_CONFIGURATION_SECURITY_GROUP_IDS'|'DOMAIN_JOIN_INFO',
    ]
)

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

type ComputeCapacity:

dict

param ComputeCapacity:

The desired capacity for the fleet.

• DesiredInstances (integer) -- [REQUIRED]

  The desired number of streaming instances.

type VpcConfig:

dict

param VpcConfig:

The VPC configuration for the fleet.

• SubnetIds (list) --

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

  • (string) --

• SecurityGroupIds (list) --

  The security groups for the fleet.

  • (string) --

type MaxUserDurationInSeconds:

integer

param MaxUserDurationInSeconds:

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

type DisconnectTimeoutInSeconds:

integer

param DisconnectTimeoutInSeconds:

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

type DeleteVpcConfig:

boolean

param DeleteVpcConfig:

Deletes the VPC association for the specified fleet.

type Description:

string

param Description:

The description for display.

type DisplayName:

string

param DisplayName:

The fleet name for display.

type EnableDefaultInternetAccess:

boolean

param EnableDefaultInternetAccess:

Enables or disables default internet access for the fleet.

type DomainJoinInfo:

dict

param DomainJoinInfo:

The information needed to join a Microsoft Active Directory domain.

• DirectoryName (string) --

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

• OrganizationalUnitDistinguishedName (string) --

  The distinguished name of the organizational unit for computer accounts.

type AttributesToDelete:

list

param AttributesToDelete:

The fleet attributes to delete.

• (string) --

  The fleet attribute.

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',
        'ComputeCapacityStatus': {
            'Desired': 123,
            'Running': 123,
            'InUse': 123,
            'Available': 123
        },
        'MaxUserDurationInSeconds': 123,
        'DisconnectTimeoutInSeconds': 123,
        'State': 'STARTING'|'RUNNING'|'STOPPING'|'STOPPED',
        'VpcConfig': {
            'SubnetIds': [
                'string',
            ],
            'SecurityGroupIds': [
                'string',
            ]
        },
        'CreatedTime': datetime(2015, 1, 1),
        'FleetErrors': [
            {
                'ErrorCode': 'IAM_SERVICE_ROLE_MISSING_ENI_DESCRIBE_ACTION'|'IAM_SERVICE_ROLE_MISSING_ENI_CREATE_ACTION'|'IAM_SERVICE_ROLE_MISSING_ENI_DELETE_ACTION'|'NETWORK_INTERFACE_LIMIT_EXCEEDED'|'INTERNAL_SERVICE_ERROR'|'IAM_SERVICE_ROLE_IS_MISSING'|'SUBNET_HAS_INSUFFICIENT_IP_ADDRESSES'|'IAM_SERVICE_ROLE_MISSING_DESCRIBE_SUBNET_ACTION'|'SUBNET_NOT_FOUND'|'IMAGE_NOT_FOUND'|'INVALID_SUBNET_CONFIGURATION'|'SECURITY_GROUPS_NOT_FOUND'|'IGW_NOT_ATTACHED'|'IAM_SERVICE_ROLE_MISSING_DESCRIBE_SECURITY_GROUPS_ACTION'|'DOMAIN_JOIN_ERROR_FILE_NOT_FOUND'|'DOMAIN_JOIN_ERROR_ACCESS_DENIED'|'DOMAIN_JOIN_ERROR_LOGON_FAILURE'|'DOMAIN_JOIN_ERROR_INVALID_PARAMETER'|'DOMAIN_JOIN_ERROR_MORE_DATA'|'DOMAIN_JOIN_ERROR_NO_SUCH_DOMAIN'|'DOMAIN_JOIN_ERROR_NOT_SUPPORTED'|'DOMAIN_JOIN_NERR_INVALID_WORKGROUP_NAME'|'DOMAIN_JOIN_NERR_WORKSTATION_NOT_STARTED'|'DOMAIN_JOIN_ERROR_DS_MACHINE_ACCOUNT_QUOTA_EXCEEDED'|'DOMAIN_JOIN_NERR_PASSWORD_EXPIRED'|'DOMAIN_JOIN_INTERNAL_SERVICE_ERROR',
                'ErrorMessage': 'string'
            },
        ],
        'EnableDefaultInternetAccess': True|False,
        'DomainJoinInfo': {
            'DirectoryName': 'string',
            'OrganizationalUnitDistinguishedName': 'string'
        }
    }
}

Response Structure

• (dict) --

  • Fleet (dict) --

    Information about the fleet.

    • Arn (string) --

      The ARN for the fleet.

    • Name (string) --

      The name of the fleet.

    • DisplayName (string) --

      The fleet name for display.

    • Description (string) --

      The description for display.

    • ImageName (string) --

      The name of the image used to create the fleet.

    • ImageArn (string) --

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

    • InstanceType (string) --

      The instance type to use when launching fleet instances.

    • FleetType (string) --

      The fleet type.

      ALWAYS_ON

      Provides users with instant-on access to their apps. You are charged for all running instances in your fleet, even if no users are streaming apps.

      ON_DEMAND

      Provide users with access to applications after they connect, which takes one to two minutes. You are charged for instance streaming when users are connected and a small hourly fee for instances that are not streaming apps.

    • ComputeCapacityStatus (dict) --

      The capacity status for the fleet.

      • Desired (integer) --

        The desired number of streaming instances.

      • Running (integer) --

        The total number of simultaneous streaming instances that are running.

      • InUse (integer) --

        The number of instances in use for streaming.

      • Available (integer) --

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

    • MaxUserDurationInSeconds (integer) --

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

    • DisconnectTimeoutInSeconds (integer) --

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

    • State (string) --

      The current state for the fleet.

    • VpcConfig (dict) --

      The VPC configuration for the fleet.

      • SubnetIds (list) --

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

        • (string) --

      • SecurityGroupIds (list) --

        The security groups for the fleet.

        • (string) --

    • CreatedTime (datetime) --

      The time the fleet was created.

    • FleetErrors (list) --

      The fleet errors.

      • (dict) --

        Describes a fleet error.

        • ErrorCode (string) --

          The error code.

        • ErrorMessage (string) --

          The error message.

    • EnableDefaultInternetAccess (boolean) --

      Indicates whether default internet access is enabled for the fleet.

    • DomainJoinInfo (dict) --

      The information needed to join a Microsoft Active Directory domain.

      • DirectoryName (string) --

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

      • OrganizationalUnitDistinguishedName (string) --

        The distinguished name of the organizational unit for computer accounts.