Skip to content

Latest commit

 

History

History

amazonaws_appstream2

Folders and files

NameName
Last commit message
Last commit date

parent directory

..

README.md

README.md

 
 

index.js

index.js

 
 

openapi.json

openapi.json

 
 

package.json

package.json

 
 

README.md

@datafire/amazonaws_appstream2

Client library for Amazon AppStream

Installation and Usage

npm install --save @datafire/amazonaws_appstream2
let amazonaws_appstream2 = require('@datafire/amazonaws_appstream2').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

.then(data => {
  console.log(data);
});

Description

Amazon AppStream 2.0

This is the Amazon AppStream 2.0 API Reference. This documentation provides descriptions and syntax for each of the actions and data types in AppStream 2.0. AppStream 2.0 is a fully managed, secure application streaming service that lets you stream desktop applications to users without rewriting applications. AppStream 2.0 manages the AWS resources that are required to host and run your applications, scales automatically, and provides access to your users on demand.

You can call the AppStream 2.0 API operations by using an interface VPC endpoint (interface endpoint). For more information, see Access AppStream 2.0 API Operations and CLI Commands Through an Interface VPC Endpoint in the Amazon AppStream 2.0 Administration Guide.

To learn more about AppStream 2.0, see the following resources:

Actions

AssociateFleet

amazonaws_appstream2.AssociateFleet({
  "FleetName": null,
  "StackName": null
}, context)

Input

  • input object
    • FleetName required
    • StackName required

Output

BatchAssociateUserStack

amazonaws_appstream2.BatchAssociateUserStack({
  "UserStackAssociations": null
}, context)

Input

Output

BatchDisassociateUserStack

amazonaws_appstream2.BatchDisassociateUserStack({
  "UserStackAssociations": null
}, context)

Input

Output

CopyImage

amazonaws_appstream2.CopyImage({
  "SourceImageName": null,
  "DestinationImageName": null,
  "DestinationRegion": null
}, context)

Input

  • input object
    • DestinationImageDescription
    • DestinationImageName required
    • DestinationRegion required
    • SourceImageName required

Output

CreateDirectoryConfig

amazonaws_appstream2.CreateDirectoryConfig({
  "DirectoryName": null,
  "OrganizationalUnitDistinguishedNames": null
}, context)

Input

  • input object
    • DirectoryName required
    • OrganizationalUnitDistinguishedNames required
    • ServiceAccountCredentials
      • AccountName required
      • AccountPassword required

Output

CreateFleet

amazonaws_appstream2.CreateFleet({
  "Name": null,
  "InstanceType": null,
  "ComputeCapacity": null
}, context)

Input

  • input object
    • ComputeCapacity required
      • DesiredInstances required
    • Description
    • DisconnectTimeoutInSeconds
    • DisplayName
    • DomainJoinInfo
      • DirectoryName
      • OrganizationalUnitDistinguishedName
    • EnableDefaultInternetAccess
    • FleetType
    • IamRoleArn
    • IdleDisconnectTimeoutInSeconds
    • ImageArn
    • ImageName
    • InstanceType required
    • MaxUserDurationInSeconds
    • Name required
    • StreamView
    • Tags
    • VpcConfig

Output

CreateImageBuilder

amazonaws_appstream2.CreateImageBuilder({
  "Name": null,
  "InstanceType": null
}, context)

Input

  • input object
    • AccessEndpoints
    • AppstreamAgentVersion
    • Description
    • DisplayName
    • DomainJoinInfo
      • DirectoryName
      • OrganizationalUnitDistinguishedName
    • EnableDefaultInternetAccess
    • IamRoleArn
    • ImageArn
    • ImageName
    • InstanceType required
    • Name required
    • Tags
    • VpcConfig

Output

CreateImageBuilderStreamingURL

amazonaws_appstream2.CreateImageBuilderStreamingURL({
  "Name": null
}, context)

Input

  • input object
    • Name required
    • Validity

Output

CreateStack

amazonaws_appstream2.CreateStack({
  "Name": null
}, context)

Input

  • input object

Output

CreateStreamingURL

amazonaws_appstream2.CreateStreamingURL({
  "StackName": null,
  "FleetName": null,
  "UserId": null
}, context)

Input

  • input object
    • ApplicationId
    • FleetName required
    • SessionContext
    • StackName required
    • UserId required
    • Validity

Output

CreateUsageReportSubscription

amazonaws_appstream2.CreateUsageReportSubscription({}, context)

Input

  • input object

Output

CreateUser

amazonaws_appstream2.CreateUser({
  "UserName": null,
  "AuthenticationType": null
}, context)

Input

  • input object
    • AuthenticationType required
    • FirstName
    • LastName
    • MessageAction
    • UserName required

Output

DeleteDirectoryConfig

amazonaws_appstream2.DeleteDirectoryConfig({
  "DirectoryName": null
}, context)

Input

  • input object
    • DirectoryName required

Output

DeleteFleet

amazonaws_appstream2.DeleteFleet({
  "Name": null
}, context)

Input

  • input object
    • Name required

Output

DeleteImage

amazonaws_appstream2.DeleteImage({
  "Name": null
}, context)

Input

  • input object
    • Name required

Output

DeleteImageBuilder

amazonaws_appstream2.DeleteImageBuilder({
  "Name": null
}, context)

Input

  • input object
    • Name required

Output

DeleteImagePermissions

amazonaws_appstream2.DeleteImagePermissions({
  "Name": null,
  "SharedAccountId": null
}, context)

Input

  • input object
    • Name required
    • SharedAccountId required

Output

DeleteStack

amazonaws_appstream2.DeleteStack({
  "Name": null
}, context)

Input

  • input object
    • Name required

Output

DeleteUsageReportSubscription

amazonaws_appstream2.DeleteUsageReportSubscription({}, context)

Input

  • input object

Output

DeleteUser

amazonaws_appstream2.DeleteUser({
  "UserName": null,
  "AuthenticationType": null
}, context)

Input

  • input object
    • AuthenticationType required
    • UserName required

Output

DescribeDirectoryConfigs

amazonaws_appstream2.DescribeDirectoryConfigs({}, context)

Input

  • input object

Output

DescribeFleets

amazonaws_appstream2.DescribeFleets({}, context)

Input

  • input object
    • Names
    • NextToken

Output

DescribeImageBuilders

amazonaws_appstream2.DescribeImageBuilders({}, context)

Input

  • input object
    • MaxResults
    • Names
    • NextToken

Output

DescribeImagePermissions

amazonaws_appstream2.DescribeImagePermissions({
  "Name": null
}, context)

Input

  • input object
    • MaxResults string
    • NextToken string
    • MaxResults
    • Name required
    • NextToken
    • SharedAwsAccountIds

Output

DescribeImages

amazonaws_appstream2.DescribeImages({}, context)

Input

  • input object
    • MaxResults string
    • NextToken string
    • Arns
    • MaxResults
    • Names
    • NextToken
    • Type

Output

DescribeSessions

amazonaws_appstream2.DescribeSessions({
  "StackName": null,
  "FleetName": null
}, context)

Input

  • input object
    • AuthenticationType
    • FleetName required
    • Limit
    • NextToken
    • StackName required
    • UserId

Output

DescribeStacks

amazonaws_appstream2.DescribeStacks({}, context)

Input

  • input object
    • Names
    • NextToken

Output

DescribeUsageReportSubscriptions

amazonaws_appstream2.DescribeUsageReportSubscriptions({}, context)

Input

  • input object
    • MaxResults
    • NextToken

Output

DescribeUserStackAssociations

amazonaws_appstream2.DescribeUserStackAssociations({}, context)

Input

  • input object
    • AuthenticationType
    • MaxResults
    • NextToken
    • StackName
    • UserName

Output

DescribeUsers

amazonaws_appstream2.DescribeUsers({
  "AuthenticationType": null
}, context)

Input

  • input object
    • AuthenticationType required
    • MaxResults
    • NextToken

Output

DisableUser

amazonaws_appstream2.DisableUser({
  "UserName": null,
  "AuthenticationType": null
}, context)

Input

  • input object
    • AuthenticationType required
    • UserName required

Output

DisassociateFleet

amazonaws_appstream2.DisassociateFleet({
  "FleetName": null,
  "StackName": null
}, context)

Input

  • input object
    • FleetName required
    • StackName required

Output

EnableUser

amazonaws_appstream2.EnableUser({
  "UserName": null,
  "AuthenticationType": null
}, context)

Input

  • input object
    • AuthenticationType required
    • UserName required

Output

ExpireSession

amazonaws_appstream2.ExpireSession({
  "SessionId": null
}, context)

Input

  • input object
    • SessionId required

Output

ListAssociatedFleets

amazonaws_appstream2.ListAssociatedFleets({
  "StackName": null
}, context)

Input

  • input object
    • NextToken
    • StackName required

Output

ListAssociatedStacks

amazonaws_appstream2.ListAssociatedStacks({
  "FleetName": null
}, context)

Input

  • input object
    • FleetName required
    • NextToken

Output

ListTagsForResource

amazonaws_appstream2.ListTagsForResource({
  "ResourceArn": null
}, context)

Input

  • input object
    • ResourceArn required

Output

StartFleet

amazonaws_appstream2.StartFleet({
  "Name": null
}, context)

Input

  • input object
    • Name required

Output

StartImageBuilder

amazonaws_appstream2.StartImageBuilder({
  "Name": null
}, context)

Input

  • input object
    • AppstreamAgentVersion
    • Name required

Output

StopFleet

amazonaws_appstream2.StopFleet({
  "Name": null
}, context)

Input

  • input object
    • Name required

Output

StopImageBuilder

amazonaws_appstream2.StopImageBuilder({
  "Name": null
}, context)

Input

  • input object
    • Name required

Output

TagResource

amazonaws_appstream2.TagResource({
  "ResourceArn": null,
  "Tags": null
}, context)

Input

  • input object
    • ResourceArn required
    • Tags required

Output

UntagResource

amazonaws_appstream2.UntagResource({
  "ResourceArn": null,
  "TagKeys": null
}, context)

Input

  • input object
    • ResourceArn required
    • TagKeys required

Output

UpdateDirectoryConfig

amazonaws_appstream2.UpdateDirectoryConfig({
  "DirectoryName": null
}, context)

Input

  • input object
    • DirectoryName required
    • OrganizationalUnitDistinguishedNames
    • ServiceAccountCredentials
      • AccountName required
      • AccountPassword required

Output

UpdateFleet

amazonaws_appstream2.UpdateFleet({}, context)

Input

  • input object
    • AttributesToDelete
    • ComputeCapacity
      • DesiredInstances required
    • DeleteVpcConfig
    • Description
    • DisconnectTimeoutInSeconds
    • DisplayName
    • DomainJoinInfo
      • DirectoryName
      • OrganizationalUnitDistinguishedName
    • EnableDefaultInternetAccess
    • IamRoleArn
    • IdleDisconnectTimeoutInSeconds
    • ImageArn
    • ImageName
    • InstanceType
    • MaxUserDurationInSeconds
    • Name
    • StreamView
    • VpcConfig

Output

UpdateImagePermissions

amazonaws_appstream2.UpdateImagePermissions({
  "Name": null,
  "SharedAccountId": null,
  "ImagePermissions": null
}, context)

Input

  • input object
    • ImagePermissions required
      • allowFleet
      • allowImageBuilder
    • Name required
    • SharedAccountId required

Output

UpdateStack

amazonaws_appstream2.UpdateStack({
  "Name": null
}, context)

Input

Output

Definitions

AccessEndpoint

  • AccessEndpoint object: Describes an interface VPC endpoint (interface endpoint) that lets you create a private connection between the virtual private cloud (VPC) that you specify and AppStream 2.0. When you specify an interface endpoint for a stack, users of the stack can connect to AppStream 2.0 only through that endpoint. When you specify an interface endpoint for an image builder, administrators can connect to the image builder only through that endpoint.
    • EndpointType required
    • VpceId

AccessEndpointList

AccessEndpointType

  • AccessEndpointType string (values: STREAMING)

AccountName

  • AccountName string

AccountPassword

  • AccountPassword string

Action

  • Action string (values: CLIPBOARD_COPY_FROM_LOCAL_DEVICE, CLIPBOARD_COPY_TO_LOCAL_DEVICE, FILE_UPLOAD, FILE_DOWNLOAD, PRINTING_TO_LOCAL_DEVICE)

Application

  • Application object: Describes an application in the application catalog.
    • DisplayName
    • Enabled
    • IconURL
    • LaunchParameters
    • LaunchPath
    • Metadata
    • Name

ApplicationSettings

  • ApplicationSettings object: The persistent application settings for users of a stack.
    • Enabled required
    • SettingsGroup

ApplicationSettingsResponse

  • ApplicationSettingsResponse object: Describes the persistent application settings for users of a stack.
    • Enabled
    • S3BucketName
    • SettingsGroup

Applications

AppstreamAgentVersion

  • AppstreamAgentVersion string

Arn

  • Arn string

ArnList

  • ArnList array

AssociateFleetRequest

  • AssociateFleetRequest object
    • FleetName required
    • StackName required

AssociateFleetResult

  • AssociateFleetResult object

AuthenticationType

  • AuthenticationType string (values: API, SAML, USERPOOL)

AwsAccountId

  • AwsAccountId string

AwsAccountIdList

BatchAssociateUserStackRequest

BatchAssociateUserStackResult

BatchDisassociateUserStackRequest

  • BatchDisassociateUserStackRequest object

BatchDisassociateUserStackResult

Boolean

  • Boolean boolean

BooleanObject

  • BooleanObject boolean

ComputeCapacity

  • ComputeCapacity object: Describes the capacity for a fleet.
    • DesiredInstances required

ComputeCapacityStatus

  • ComputeCapacityStatus object: Describes the capacity status for a fleet.
    • Available
    • Desired required
    • InUse
    • Running

ConcurrentModificationException

CopyImageRequest

  • CopyImageRequest object
    • DestinationImageDescription
    • DestinationImageName required
    • DestinationRegion required
    • SourceImageName required

CopyImageResponse

  • CopyImageResponse object
    • DestinationImageName

CreateDirectoryConfigRequest

  • CreateDirectoryConfigRequest object
    • DirectoryName required
    • OrganizationalUnitDistinguishedNames required
    • ServiceAccountCredentials
      • AccountName required
      • AccountPassword required

CreateDirectoryConfigResult

  • CreateDirectoryConfigResult object
    • DirectoryConfig
      • CreatedTime
      • DirectoryName required
      • OrganizationalUnitDistinguishedNames
      • ServiceAccountCredentials
        • AccountName required
        • AccountPassword required

CreateFleetRequest

  • CreateFleetRequest object
    • ComputeCapacity required
      • DesiredInstances required
    • Description
    • DisconnectTimeoutInSeconds
    • DisplayName
    • DomainJoinInfo
      • DirectoryName
      • OrganizationalUnitDistinguishedName
    • EnableDefaultInternetAccess
    • FleetType
    • IamRoleArn
    • IdleDisconnectTimeoutInSeconds
    • ImageArn
    • ImageName
    • InstanceType required
    • MaxUserDurationInSeconds
    • Name required
    • StreamView
    • Tags
    • VpcConfig

CreateFleetResult

  • CreateFleetResult object
    • Fleet
      • Arn required
      • ComputeCapacityStatus required
        • Available
        • Desired required
        • InUse
        • Running
      • CreatedTime
      • Description
      • DisconnectTimeoutInSeconds
      • DisplayName
      • DomainJoinInfo
        • DirectoryName
        • OrganizationalUnitDistinguishedName
      • EnableDefaultInternetAccess
      • FleetErrors
      • FleetType
      • IamRoleArn
      • IdleDisconnectTimeoutInSeconds
      • ImageArn
      • ImageName
      • InstanceType required
      • MaxUserDurationInSeconds
      • Name required
      • State required
      • StreamView
      • VpcConfig

CreateImageBuilderRequest

  • CreateImageBuilderRequest object
    • AccessEndpoints
    • AppstreamAgentVersion
    • Description
    • DisplayName
    • DomainJoinInfo
      • DirectoryName
      • OrganizationalUnitDistinguishedName
    • EnableDefaultInternetAccess
    • IamRoleArn
    • ImageArn
    • ImageName
    • InstanceType required
    • Name required
    • Tags
    • VpcConfig

CreateImageBuilderResult

  • CreateImageBuilderResult object
    • ImageBuilder
      • AccessEndpoints
      • AppstreamAgentVersion
      • Arn
      • CreatedTime
      • Description
      • DisplayName
      • DomainJoinInfo
        • DirectoryName
        • OrganizationalUnitDistinguishedName
      • EnableDefaultInternetAccess
      • IamRoleArn
      • ImageArn
      • ImageBuilderErrors
      • InstanceType
      • Name required
      • NetworkAccessConfiguration NetworkAccessConfiguration
      • Platform
      • State
      • StateChangeReason
        • Code
        • Message
      • VpcConfig

CreateImageBuilderStreamingURLRequest

  • CreateImageBuilderStreamingURLRequest object
    • Name required
    • Validity

CreateImageBuilderStreamingURLResult

  • CreateImageBuilderStreamingURLResult object
    • Expires
    • StreamingURL

CreateStackRequest

  • CreateStackRequest object

CreateStackResult

  • CreateStackResult object

CreateStreamingURLRequest

  • CreateStreamingURLRequest object
    • ApplicationId
    • FleetName required
    • SessionContext
    • StackName required
    • UserId required
    • Validity

CreateStreamingURLResult

  • CreateStreamingURLResult object
    • Expires
    • StreamingURL

CreateUsageReportSubscriptionRequest

  • CreateUsageReportSubscriptionRequest object

CreateUsageReportSubscriptionResult

  • CreateUsageReportSubscriptionResult object
    • S3BucketName
    • Schedule

CreateUserRequest

  • CreateUserRequest object
    • AuthenticationType required
    • FirstName
    • LastName
    • MessageAction
    • UserName required

CreateUserResult

  • CreateUserResult object

DeleteDirectoryConfigRequest

  • DeleteDirectoryConfigRequest object
    • DirectoryName required

DeleteDirectoryConfigResult

  • DeleteDirectoryConfigResult object

DeleteFleetRequest

  • DeleteFleetRequest object
    • Name required

DeleteFleetResult

  • DeleteFleetResult object

DeleteImageBuilderRequest

  • DeleteImageBuilderRequest object
    • Name required

DeleteImageBuilderResult

  • DeleteImageBuilderResult object
    • ImageBuilder
      • AccessEndpoints
      • AppstreamAgentVersion
      • Arn
      • CreatedTime
      • Description
      • DisplayName
      • DomainJoinInfo
        • DirectoryName
        • OrganizationalUnitDistinguishedName
      • EnableDefaultInternetAccess
      • IamRoleArn
      • ImageArn
      • ImageBuilderErrors
      • InstanceType
      • Name required
      • NetworkAccessConfiguration NetworkAccessConfiguration
      • Platform
      • State
      • StateChangeReason
        • Code
        • Message
      • VpcConfig

DeleteImagePermissionsRequest

  • DeleteImagePermissionsRequest object
    • Name required
    • SharedAccountId required

DeleteImagePermissionsResult

  • DeleteImagePermissionsResult object

DeleteImageRequest

  • DeleteImageRequest object
    • Name required

DeleteImageResult

  • DeleteImageResult object
    • Image
      • Applications
      • AppstreamAgentVersion
      • Arn
      • BaseImageArn
      • CreatedTime
      • Description
      • DisplayName
      • ImageBuilderName
      • ImageBuilderSupported
      • ImagePermissions
        • allowFleet
        • allowImageBuilder
      • Name required
      • Platform
      • PublicBaseImageReleasedDate
      • State
      • StateChangeReason
        • Code
        • Message
      • Visibility

DeleteStackRequest

  • DeleteStackRequest object
    • Name required

DeleteStackResult

  • DeleteStackResult object

DeleteUsageReportSubscriptionRequest

  • DeleteUsageReportSubscriptionRequest object

DeleteUsageReportSubscriptionResult

  • DeleteUsageReportSubscriptionResult object

DeleteUserRequest

  • DeleteUserRequest object
    • AuthenticationType required
    • UserName required

DeleteUserResult

  • DeleteUserResult object

DescribeDirectoryConfigsRequest

  • DescribeDirectoryConfigsRequest object

DescribeDirectoryConfigsResult

  • DescribeDirectoryConfigsResult object

DescribeFleetsRequest

  • DescribeFleetsRequest object
    • Names
    • NextToken

DescribeFleetsResult

  • DescribeFleetsResult object
    • Fleets
    • NextToken

DescribeImageBuildersRequest

  • DescribeImageBuildersRequest object
    • MaxResults
    • Names
    • NextToken

DescribeImageBuildersResult

  • DescribeImageBuildersResult object

DescribeImagePermissionsRequest

  • DescribeImagePermissionsRequest object
    • MaxResults
    • Name required
    • NextToken
    • SharedAwsAccountIds

DescribeImagePermissionsResult

  • DescribeImagePermissionsResult object

DescribeImagesMaxResults

  • DescribeImagesMaxResults integer

DescribeImagesRequest

  • DescribeImagesRequest object
    • Arns
    • MaxResults
    • Names
    • NextToken
    • Type

DescribeImagesResult

  • DescribeImagesResult object
    • Images
    • NextToken

DescribeSessionsRequest

  • DescribeSessionsRequest object
    • AuthenticationType
    • FleetName required
    • Limit
    • NextToken
    • StackName required
    • UserId

DescribeSessionsResult

  • DescribeSessionsResult object

DescribeStacksRequest

  • DescribeStacksRequest object
    • Names
    • NextToken

DescribeStacksResult

  • DescribeStacksResult object
    • NextToken
    • Stacks

DescribeUsageReportSubscriptionsRequest

  • DescribeUsageReportSubscriptionsRequest object
    • MaxResults
    • NextToken

DescribeUsageReportSubscriptionsResult

DescribeUserStackAssociationsRequest

  • DescribeUserStackAssociationsRequest object
    • AuthenticationType
    • MaxResults
    • NextToken
    • StackName
    • UserName

DescribeUserStackAssociationsResult

  • DescribeUserStackAssociationsResult object

DescribeUsersRequest

  • DescribeUsersRequest object
    • AuthenticationType required
    • MaxResults
    • NextToken

DescribeUsersResult

  • DescribeUsersResult object
    • NextToken
    • Users

Description

  • Description string

DirectoryConfig

  • DirectoryConfig object: Describes the configuration information required to join fleets and image builders to Microsoft Active Directory domains.
    • CreatedTime
    • DirectoryName required
    • OrganizationalUnitDistinguishedNames
    • ServiceAccountCredentials
      • AccountName required
      • AccountPassword required

DirectoryConfigList

DirectoryName

  • DirectoryName string

DirectoryNameList

DisableUserRequest

  • DisableUserRequest object
    • AuthenticationType required
    • UserName required

DisableUserResult

  • DisableUserResult object

DisassociateFleetRequest

  • DisassociateFleetRequest object
    • FleetName required
    • StackName required

DisassociateFleetResult

  • DisassociateFleetResult object

DisplayName

  • DisplayName string

Domain

  • Domain string: GSuite domain for GDrive integration.

DomainJoinInfo

  • DomainJoinInfo object: Describes the configuration information required to join fleets and image builders to Microsoft Active Directory domains.
    • DirectoryName
    • OrganizationalUnitDistinguishedName

DomainList

  • DomainList array

EmbedHostDomain

  • EmbedHostDomain string: Specifies a valid domain that can embed AppStream. Valid examples include: ["testorigin.tt--com", "testingorigin.com.us", "test.com.us"] Invalid examples include: ["test,com", ".com", "h*llo.com". ""]

EmbedHostDomains

EnableUserRequest

  • EnableUserRequest object
    • AuthenticationType required
    • UserName required

EnableUserResult

  • EnableUserResult object

ExpireSessionRequest

  • ExpireSessionRequest object
    • SessionId required

ExpireSessionResult

  • ExpireSessionResult object

FeedbackURL

  • FeedbackURL string

Fleet

  • Fleet object: Describes a fleet.
    • Arn required
    • ComputeCapacityStatus required
      • Available
      • Desired required
      • InUse
      • Running
    • CreatedTime
    • Description
    • DisconnectTimeoutInSeconds
    • DisplayName
    • DomainJoinInfo
      • DirectoryName
      • OrganizationalUnitDistinguishedName
    • EnableDefaultInternetAccess
    • FleetErrors
    • FleetType
    • IamRoleArn
    • IdleDisconnectTimeoutInSeconds
    • ImageArn
    • ImageName
    • InstanceType required
    • MaxUserDurationInSeconds
    • Name required
    • State required
    • StreamView
    • VpcConfig

FleetAttribute

  • FleetAttribute string (values: VPC_CONFIGURATION, VPC_CONFIGURATION_SECURITY_GROUP_IDS, DOMAIN_JOIN_INFO, IAM_ROLE_ARN): The fleet attribute.

FleetAttributes

FleetError

  • FleetError object: Describes a fleet error.
    • ErrorCode
    • ErrorMessage

FleetErrorCode

  • FleetErrorCode string (values: 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, 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)

FleetErrors

FleetList

  • FleetList array: The fleets.

FleetState

  • FleetState string (values: STARTING, RUNNING, STOPPING, STOPPED)

FleetType

  • FleetType string (values: ALWAYS_ON, ON_DEMAND)

Image

  • Image object: Describes an image.
    • Applications
    • AppstreamAgentVersion
    • Arn
    • BaseImageArn
    • CreatedTime
    • Description
    • DisplayName
    • ImageBuilderName
    • ImageBuilderSupported
    • ImagePermissions
      • allowFleet
      • allowImageBuilder
    • Name required
    • Platform
    • PublicBaseImageReleasedDate
    • State
    • StateChangeReason
      • Code
      • Message
    • Visibility

ImageBuilder

  • ImageBuilder object: Describes a virtual machine that is used to create an image.
    • AccessEndpoints
    • AppstreamAgentVersion
    • Arn
    • CreatedTime
    • Description
    • DisplayName
    • DomainJoinInfo
      • DirectoryName
      • OrganizationalUnitDistinguishedName
    • EnableDefaultInternetAccess
    • IamRoleArn
    • ImageArn
    • ImageBuilderErrors
    • InstanceType
    • Name required
    • NetworkAccessConfiguration NetworkAccessConfiguration
    • Platform
    • State
    • StateChangeReason
      • Code
      • Message
    • VpcConfig

ImageBuilderList

ImageBuilderState

  • ImageBuilderState string (values: PENDING, UPDATING_AGENT, RUNNING, STOPPING, STOPPED, REBOOTING, SNAPSHOTTING, DELETING, FAILED)

ImageBuilderStateChangeReason

  • ImageBuilderStateChangeReason object: Describes the reason why the last image builder state change occurred.
    • Code
    • Message

ImageBuilderStateChangeReasonCode

  • ImageBuilderStateChangeReasonCode string (values: INTERNAL_ERROR, IMAGE_UNAVAILABLE)

ImageList

  • ImageList array

ImagePermissions

  • ImagePermissions object: Describes the permissions for an image.
    • allowFleet
    • allowImageBuilder

ImageState

  • ImageState string (values: PENDING, AVAILABLE, FAILED, COPYING, DELETING)

ImageStateChangeReason

  • ImageStateChangeReason object: Describes the reason why the last image state change occurred.
    • Code
    • Message

ImageStateChangeReasonCode

  • ImageStateChangeReasonCode string (values: INTERNAL_ERROR, IMAGE_BUILDER_NOT_AVAILABLE, IMAGE_COPY_FAILURE)

IncompatibleImageException

Integer

  • Integer integer

InvalidAccountStatusException

InvalidParameterCombinationException

InvalidRoleException

LastReportGenerationExecutionError

  • LastReportGenerationExecutionError object: Describes the error that is returned when a usage report can't be generated.
    • ErrorCode
    • ErrorMessage

LastReportGenerationExecutionErrors

LimitExceededException

ListAssociatedFleetsRequest

  • ListAssociatedFleetsRequest object
    • NextToken
    • StackName required

ListAssociatedFleetsResult

  • ListAssociatedFleetsResult object
    • Names
    • NextToken

ListAssociatedStacksRequest

  • ListAssociatedStacksRequest object
    • FleetName required
    • NextToken

ListAssociatedStacksResult

  • ListAssociatedStacksResult object
    • Names
    • NextToken

ListTagsForResourceRequest

  • ListTagsForResourceRequest object
    • ResourceArn required

ListTagsForResourceResponse

  • ListTagsForResourceResponse object
    • Tags

Long

  • Long integer

MaxResults

  • MaxResults integer

MessageAction

  • MessageAction string (values: SUPPRESS, RESEND)

Metadata

  • Metadata object

Name

  • Name string

NetworkAccessConfiguration

  • NetworkAccessConfiguration object: Describes the network details of the fleet or image builder instance.
    • EniId
    • EniPrivateIpAddress

OperationNotPermittedException

OrganizationalUnitDistinguishedName

  • OrganizationalUnitDistinguishedName string

OrganizationalUnitDistinguishedNamesList

Permission

  • Permission string (values: ENABLED, DISABLED)

PlatformType

  • PlatformType string (values: WINDOWS, WINDOWS_SERVER_2016, WINDOWS_SERVER_2019)

RedirectURL

  • RedirectURL string

RegionName

  • RegionName string

RequestLimitExceededException

ResourceAlreadyExistsException

ResourceError

  • ResourceError object: Describes a resource error.
    • ErrorCode
    • ErrorMessage
    • ErrorTimestamp

ResourceErrors

ResourceIdentifier

  • ResourceIdentifier string: The ARN of the resource.

ResourceInUseException

ResourceNotAvailableException

ResourceNotFoundException

SecurityGroupIdList

  • SecurityGroupIdList array: The security group identifiers.

ServiceAccountCredentials

  • ServiceAccountCredentials object: Describes the credentials for the service account used by the fleet or image builder to connect to the directory.
    • AccountName required
    • AccountPassword required

Session

  • Session object: Describes a streaming session.
    • AuthenticationType
    • ConnectionState
    • FleetName required
    • Id required
    • MaxExpirationTime
    • NetworkAccessConfiguration
      • EniId
      • EniPrivateIpAddress
    • StackName required
    • StartTime
    • State required
    • UserId required

SessionConnectionState

  • SessionConnectionState string (values: CONNECTED, NOT_CONNECTED)

SessionList

  • SessionList array: List of sessions.

SessionState

  • SessionState string (values: ACTIVE, PENDING, EXPIRED): Possible values for the state of a streaming session.

SettingsGroup

  • SettingsGroup string

SharedImagePermissions

  • SharedImagePermissions object: Describes the permissions that are available to the specified AWS account for a shared image.
    • imagePermissions required
      • allowFleet
      • allowImageBuilder
    • sharedAccountId required

SharedImagePermissionsList

Stack

  • Stack object: Describes a stack.

StackAttribute

  • StackAttribute string (values: STORAGE_CONNECTORS, STORAGE_CONNECTOR_HOMEFOLDERS, STORAGE_CONNECTOR_GOOGLE_DRIVE, STORAGE_CONNECTOR_ONE_DRIVE, REDIRECT_URL, FEEDBACK_URL, THEME_NAME, USER_SETTINGS, EMBED_HOST_DOMAINS, IAM_ROLE_ARN, ACCESS_ENDPOINTS)

StackAttributes

StackError

  • StackError object: Describes a stack error.
    • ErrorCode
    • ErrorMessage

StackErrorCode

  • StackErrorCode string (values: STORAGE_CONNECTOR_ERROR, INTERNAL_SERVICE_ERROR)

StackErrors

  • StackErrors array: The stack errors.

StackList

  • StackList array: The stacks.

StartFleetRequest

  • StartFleetRequest object
    • Name required

StartFleetResult

  • StartFleetResult object

StartImageBuilderRequest

  • StartImageBuilderRequest object
    • AppstreamAgentVersion
    • Name required

StartImageBuilderResult

  • StartImageBuilderResult object
    • ImageBuilder
      • AccessEndpoints
      • AppstreamAgentVersion
      • Arn
      • CreatedTime
      • Description
      • DisplayName
      • DomainJoinInfo
        • DirectoryName
        • OrganizationalUnitDistinguishedName
      • EnableDefaultInternetAccess
      • IamRoleArn
      • ImageArn
      • ImageBuilderErrors
      • InstanceType
      • Name required
      • NetworkAccessConfiguration NetworkAccessConfiguration
      • Platform
      • State
      • StateChangeReason
        • Code
        • Message
      • VpcConfig

StopFleetRequest

  • StopFleetRequest object
    • Name required

StopFleetResult

  • StopFleetResult object

StopImageBuilderRequest

  • StopImageBuilderRequest object
    • Name required

StopImageBuilderResult

  • StopImageBuilderResult object
    • ImageBuilder
      • AccessEndpoints
      • AppstreamAgentVersion
      • Arn
      • CreatedTime
      • Description
      • DisplayName
      • DomainJoinInfo
        • DirectoryName
        • OrganizationalUnitDistinguishedName
      • EnableDefaultInternetAccess
      • IamRoleArn
      • ImageArn
      • ImageBuilderErrors
      • InstanceType
      • Name required
      • NetworkAccessConfiguration NetworkAccessConfiguration
      • Platform
      • State
      • StateChangeReason
        • Code
        • Message
      • VpcConfig

StorageConnector

  • StorageConnector object: Describes a connector that enables persistent storage for users.
    • ConnectorType required
    • Domains
    • ResourceIdentifier

StorageConnectorList

StorageConnectorType

  • StorageConnectorType string (values: HOMEFOLDERS, GOOGLE_DRIVE, ONE_DRIVE): The type of storage connector.

StreamView

  • StreamView string (values: APP, DESKTOP)

StreamingUrlUserId

  • StreamingUrlUserId string

String

  • String string

StringList

  • StringList array

SubnetIdList

  • SubnetIdList array: The subnet identifiers.

TagKey

  • TagKey string

TagKeyList

  • TagKeyList array

TagResourceRequest

  • TagResourceRequest object
    • ResourceArn required
    • Tags required

TagResourceResponse

  • TagResourceResponse object

TagValue

  • TagValue string

Tags

  • Tags object

Timestamp

  • Timestamp string

UntagResourceRequest

  • UntagResourceRequest object
    • ResourceArn required
    • TagKeys required

UntagResourceResponse

  • UntagResourceResponse object

UpdateDirectoryConfigRequest

  • UpdateDirectoryConfigRequest object
    • DirectoryName required
    • OrganizationalUnitDistinguishedNames
    • ServiceAccountCredentials
      • AccountName required
      • AccountPassword required

UpdateDirectoryConfigResult

  • UpdateDirectoryConfigResult object
    • DirectoryConfig
      • CreatedTime
      • DirectoryName required
      • OrganizationalUnitDistinguishedNames
      • ServiceAccountCredentials
        • AccountName required
        • AccountPassword required

UpdateFleetRequest

  • UpdateFleetRequest object
    • AttributesToDelete
    • ComputeCapacity
      • DesiredInstances required
    • DeleteVpcConfig
    • Description
    • DisconnectTimeoutInSeconds
    • DisplayName
    • DomainJoinInfo
      • DirectoryName
      • OrganizationalUnitDistinguishedName
    • EnableDefaultInternetAccess
    • IamRoleArn
    • IdleDisconnectTimeoutInSeconds
    • ImageArn
    • ImageName
    • InstanceType
    • MaxUserDurationInSeconds
    • Name
    • StreamView
    • VpcConfig

UpdateFleetResult

  • UpdateFleetResult object
    • Fleet
      • Arn required
      • ComputeCapacityStatus required
        • Available
        • Desired required
        • InUse
        • Running
      • CreatedTime
      • Description
      • DisconnectTimeoutInSeconds
      • DisplayName
      • DomainJoinInfo
        • DirectoryName
        • OrganizationalUnitDistinguishedName
      • EnableDefaultInternetAccess
      • FleetErrors
      • FleetType
      • IamRoleArn
      • IdleDisconnectTimeoutInSeconds
      • ImageArn
      • ImageName
      • InstanceType required
      • MaxUserDurationInSeconds
      • Name required
      • State required
      • StreamView
      • VpcConfig

UpdateImagePermissionsRequest

  • UpdateImagePermissionsRequest object
    • ImagePermissions required
      • allowFleet
      • allowImageBuilder
    • Name required
    • SharedAccountId required

UpdateImagePermissionsResult

  • UpdateImagePermissionsResult object

UpdateStackRequest

  • UpdateStackRequest object

UpdateStackResult

  • UpdateStackResult object

UsageReportExecutionErrorCode

  • UsageReportExecutionErrorCode string (values: RESOURCE_NOT_FOUND, ACCESS_DENIED, INTERNAL_SERVICE_ERROR)

UsageReportSchedule

  • UsageReportSchedule string (values: DAILY)

UsageReportSubscription

  • UsageReportSubscription object: Describes information about the usage report subscription.

UsageReportSubscriptionList

User

  • User object: Describes a user in the user pool.
    • Arn
    • AuthenticationType required
    • CreatedTime
    • Enabled
    • FirstName
    • LastName
    • Status
    • UserName

UserAttributeValue

  • UserAttributeValue string

UserId

  • UserId string

UserList

  • UserList array

UserSetting

  • UserSetting object: Describes an action and whether the action is enabled or disabled for users during their streaming sessions.
    • Action required
    • Permission required

UserSettingList

UserStackAssociation

  • UserStackAssociation object: Describes a user in the user pool and the associated stack.
    • AuthenticationType required
    • SendEmailNotification
    • StackName required
    • UserName required

UserStackAssociationError

  • UserStackAssociationError object: Describes the error that is returned when a user can’t be associated with or disassociated from a stack.
    • ErrorCode
    • ErrorMessage
    • UserStackAssociation
      • AuthenticationType required
      • SendEmailNotification
      • StackName required
      • UserName required

UserStackAssociationErrorCode

  • UserStackAssociationErrorCode string (values: STACK_NOT_FOUND, USER_NAME_NOT_FOUND, DIRECTORY_NOT_FOUND, INTERNAL_ERROR)

UserStackAssociationErrorList

UserStackAssociationList

Username

  • Username string

VisibilityType

  • VisibilityType string (values: PUBLIC, PRIVATE, SHARED)

VpcConfig

  • VpcConfig object: Describes VPC configuration information for fleets and image builders.