types

package
v0.26.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 30, 2020 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AccessEndpoint 

type AccessEndpoint struct {
	// The type of interface endpoint.
	EndpointType AccessEndpointType
	// The identifier (ID) of the VPC in which the interface endpoint is used.
	VpceId *string
}

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.

type AccessEndpointType 

type AccessEndpointType string
const (
	AccessEndpointTypeStreaming AccessEndpointType = "STREAMING"
)

Enum values for AccessEndpointType

type Action 

type Action string
const (
	ActionClipboard_copy_from_local_device Action = "CLIPBOARD_COPY_FROM_LOCAL_DEVICE"
	ActionClipboard_copy_to_local_device   Action = "CLIPBOARD_COPY_TO_LOCAL_DEVICE"
	ActionFile_upload                      Action = "FILE_UPLOAD"
	ActionFile_download                    Action = "FILE_DOWNLOAD"
	ActionPrinting_to_local_device         Action = "PRINTING_TO_LOCAL_DEVICE"
)

Enum values for Action

type Application 

type Application struct {
	// The arguments that are passed to the application at launch.
	LaunchParameters *string
	// The application name to display.
	DisplayName *string
	// The name of the application.
	Name *string
	// The path to the application executable in the instance.
	LaunchPath *string
	// Additional attributes that describe the application.
	Metadata map[string]*string
	// If there is a problem, the application can be disabled after image creation.
	Enabled *bool
	// The URL for the application icon. This URL might be time-limited.
	IconURL *string
}

Describes an application in the application catalog.

type ApplicationSettings 

type ApplicationSettings struct {
	// Enables or disables persistent application settings for users during their
	// streaming sessions.
	Enabled *bool
	// The path prefix for the S3 bucket where users’ persistent application settings
	// are stored. You can allow the same persistent application settings to be used
	// across multiple stacks by specifying the same settings group for each stack.
	SettingsGroup *string
}

The persistent application settings for users of a stack.

type ApplicationSettingsResponse 

type ApplicationSettingsResponse struct {
	// The path prefix for the S3 bucket where users’ persistent application settings
	// are stored.
	SettingsGroup *string
	// The S3 bucket where users’ persistent application settings are stored. When
	// persistent application settings are enabled for the first time for an account in
	// an AWS Region, an S3 bucket is created. The bucket is unique to the AWS account
	// and the Region.
	S3BucketName *string
	// Specifies whether persistent application settings are enabled for users during
	// their streaming sessions.
	Enabled *bool
}

Describes the persistent application settings for users of a stack.

type AuthenticationType 

type AuthenticationType string
const (
	AuthenticationTypeApi      AuthenticationType = "API"
	AuthenticationTypeSaml     AuthenticationType = "SAML"
	AuthenticationTypeUserpool AuthenticationType = "USERPOOL"
)

Enum values for AuthenticationType

type ComputeCapacity 

type ComputeCapacity struct {
	// The desired number of streaming instances.
	DesiredInstances *int32
}

Describes the capacity for a fleet.

type ComputeCapacityStatus 

type ComputeCapacityStatus struct {
	// The number of instances in use for streaming.
	InUse *int32
	// The number of currently available instances that can be used to stream sessions.
	Available *int32
	// The desired number of streaming instances.
	Desired *int32
	// The total number of simultaneous streaming instances that are running.
	Running *int32
}

Describes the capacity status for a fleet.

type ConcurrentModificationException 

type ConcurrentModificationException struct {
	Message *string
}

An API error occurred. Wait a few minutes and try again.

func (*ConcurrentModificationException) Error 

func (e *ConcurrentModificationException) Error() string

func (*ConcurrentModificationException) ErrorCode 

func (e *ConcurrentModificationException) ErrorCode() string

func (*ConcurrentModificationException) ErrorFault 

func (e *ConcurrentModificationException) ErrorFault() smithy.ErrorFault

func (*ConcurrentModificationException) ErrorMessage 

func (e *ConcurrentModificationException) ErrorMessage() string

func (*ConcurrentModificationException) GetMessage 

func (e *ConcurrentModificationException) GetMessage() string

func (*ConcurrentModificationException) HasMessage 

func (e *ConcurrentModificationException) HasMessage() bool

type DirectoryConfig 

type DirectoryConfig struct {
	// The credentials for the service account used by the fleet or image builder to
	// connect to the directory.
	ServiceAccountCredentials *ServiceAccountCredentials
	// The fully qualified name of the directory (for example, corp.example.com).
	DirectoryName *string
	// The time the directory configuration was created.
	CreatedTime *time.Time
	// The distinguished names of the organizational units for computer accounts.
	OrganizationalUnitDistinguishedNames []*string
}

Describes the configuration information required to join fleets and image builders to Microsoft Active Directory domains.

type DomainJoinInfo 

type DomainJoinInfo struct {
	// The fully qualified name of the directory (for example, corp.example.com).
	DirectoryName *string
	// The distinguished name of the organizational unit for computer accounts.
	OrganizationalUnitDistinguishedName *string
}

Describes the configuration information required to join fleets and image builders to Microsoft Active Directory domains.

type Fleet 

type Fleet struct {
	// The amount of time that a streaming session remains active after users
	// disconnect. If they try to reconnect to the streaming session after a
	// disconnection or network interruption within this time interval, they are
	// connected to their previous session. Otherwise, they are connected to a new
	// session with a new streaming instance. Specify a value between 60 and 360000.
	DisconnectTimeoutInSeconds *int32
	// The maximum amount of time that a streaming session can remain active, in
	// seconds. If users are still connected to a streaming instance five minutes
	// before this limit is reached, they are prompted to save any open documents
	// before being disconnected. After this time elapses, the instance is terminated
	// and replaced by a new instance. Specify a value between 600 and 360000.
	MaxUserDurationInSeconds *int32
	// The fleet errors.
	FleetErrors []*FleetError
	// The fleet name to display.
	DisplayName *string
	// The VPC configuration for the fleet.
	VpcConfig *VpcConfig
	// The description to display.
	Description *string
	// The Amazon Resource Name (ARN) for the fleet.
	Arn *string
	// The name of the image used to create the fleet.
	ImageName *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.
	FleetType FleetType
	// The current state for the fleet.
	State FleetState
	// The ARN of the IAM role that is applied to the fleet. To assume a role, the
	// fleet instance calls the AWS Security Token Service (STS) AssumeRole API
	// operation and passes the ARN of the role to use. The operation creates a new
	// session with temporary credentials. AppStream 2.0 retrieves the temporary
	// credentials and creates the AppStream_Machine_Role credential profile on the
	// instance.  <p>For more information, see <a
	// href="https://docs.aws.amazon.com/appstream2/latest/developerguide/using-iam-roles-to-grant-permissions-to-applications-scripts-streaming-instances.html">Using
	// an IAM Role to Grant Permissions to Applications and Scripts Running on
	// AppStream 2.0 Streaming Instances</a> in the <i>Amazon AppStream 2.0
	// Administration Guide</i>.</p>
	IamRoleArn *string
	// The capacity status for the fleet.
	ComputeCapacityStatus *ComputeCapacityStatus
	// The ARN for the public, private, or shared image.
	ImageArn *string
	// The name of the fleet.
	Name *string
	// The name of the directory and organizational unit (OU) to use to join the fleet
	// to a Microsoft Active Directory domain.
	DomainJoinInfo *DomainJoinInfo
	// The amount of time that users can be idle (inactive) before they are
	// disconnected from their streaming session and the DisconnectTimeoutInSeconds
	// time interval begins. Users are notified before they are disconnected due to
	// inactivity. If users try to reconnect to the streaming session before the time
	// interval specified in DisconnectTimeoutInSeconds elapses, they are connected to
	// their previous session. Users are considered idle when they stop providing
	// keyboard or mouse input during their streaming session. File uploads and
	// downloads, audio in, audio out, and pixels changing do not qualify as user
	// activity. If users continue to be idle after the time interval in
	// IdleDisconnectTimeoutInSeconds elapses, they are disconnected. To prevent users
	// from being disconnected due to inactivity, specify a value of 0. Otherwise,
	// specify a value between 60 and 3600. The default value is 0.  <note> <p>If you
	// enable this feature, we recommend that you specify a value that corresponds
	// exactly to a whole number of minutes (for example, 60, 120, and 180). If you
	// don't do this, the value is rounded to the nearest minute. For example, if you
	// specify a value of 70, users are disconnected after 1 minute of inactivity. If
	// you specify a value that is at the midpoint between two different minutes, the
	// value is rounded up. For example, if you specify a value of 90, users are
	// disconnected after 2 minutes of inactivity. </p> </note>
	IdleDisconnectTimeoutInSeconds *int32
	// The time the fleet was created.
	CreatedTime *time.Time
	// 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
	InstanceType *string
	// Indicates whether default internet access is enabled for the fleet.
	EnableDefaultInternetAccess *bool
}

Describes a fleet.

type FleetAttribute 

type FleetAttribute string
const (
	FleetAttributeVpc_configuration                    FleetAttribute = "VPC_CONFIGURATION"
	FleetAttributeVpc_configuration_security_group_ids FleetAttribute = "VPC_CONFIGURATION_SECURITY_GROUP_IDS"
	FleetAttributeDomain_join_info                     FleetAttribute = "DOMAIN_JOIN_INFO"
	FleetAttributeIam_role_arn                         FleetAttribute = "IAM_ROLE_ARN"
)

Enum values for FleetAttribute

type FleetError 

type FleetError struct {
	// The error message.
	ErrorMessage *string
	// The error code.
	ErrorCode FleetErrorCode
}

Describes a fleet error.

type FleetErrorCode 

type FleetErrorCode string
const (
	FleetErrorCodeIam_service_role_missing_eni_describe_action             FleetErrorCode = "IAM_SERVICE_ROLE_MISSING_ENI_DESCRIBE_ACTION"
	FleetErrorCodeIam_service_role_missing_eni_create_action               FleetErrorCode = "IAM_SERVICE_ROLE_MISSING_ENI_CREATE_ACTION"
	FleetErrorCodeIam_service_role_missing_eni_delete_action               FleetErrorCode = "IAM_SERVICE_ROLE_MISSING_ENI_DELETE_ACTION"
	FleetErrorCodeNetwork_interface_limit_exceeded                         FleetErrorCode = "NETWORK_INTERFACE_LIMIT_EXCEEDED"
	FleetErrorCodeInternal_service_error                                   FleetErrorCode = "INTERNAL_SERVICE_ERROR"
	FleetErrorCodeIam_service_role_is_missing                              FleetErrorCode = "IAM_SERVICE_ROLE_IS_MISSING"
	FleetErrorCodeMachine_role_is_missing                                  FleetErrorCode = "MACHINE_ROLE_IS_MISSING"
	FleetErrorCodeSts_disabled_in_region                                   FleetErrorCode = "STS_DISABLED_IN_REGION"
	FleetErrorCodeSubnet_has_insufficient_ip_addresses                     FleetErrorCode = "SUBNET_HAS_INSUFFICIENT_IP_ADDRESSES"
	FleetErrorCodeIam_service_role_missing_describe_subnet_action          FleetErrorCode = "IAM_SERVICE_ROLE_MISSING_DESCRIBE_SUBNET_ACTION"
	FleetErrorCodeSubnet_not_found                                         FleetErrorCode = "SUBNET_NOT_FOUND"
	FleetErrorCodeImage_not_found                                          FleetErrorCode = "IMAGE_NOT_FOUND"
	FleetErrorCodeInvalid_subnet_configuration                             FleetErrorCode = "INVALID_SUBNET_CONFIGURATION"
	FleetErrorCodeSecurity_groups_not_found                                FleetErrorCode = "SECURITY_GROUPS_NOT_FOUND"
	FleetErrorCodeIgw_not_attached                                         FleetErrorCode = "IGW_NOT_ATTACHED"
	FleetErrorCodeIam_service_role_missing_describe_security_groups_action FleetErrorCode = "IAM_SERVICE_ROLE_MISSING_DESCRIBE_SECURITY_GROUPS_ACTION"
	FleetErrorCodeDomain_join_error_file_not_found                         FleetErrorCode = "DOMAIN_JOIN_ERROR_FILE_NOT_FOUND"
	FleetErrorCodeDomain_join_error_access_denied                          FleetErrorCode = "DOMAIN_JOIN_ERROR_ACCESS_DENIED"
	FleetErrorCodeDomain_join_error_logon_failure                          FleetErrorCode = "DOMAIN_JOIN_ERROR_LOGON_FAILURE"
	FleetErrorCodeDomain_join_error_invalid_parameter                      FleetErrorCode = "DOMAIN_JOIN_ERROR_INVALID_PARAMETER"
	FleetErrorCodeDomain_join_error_more_data                              FleetErrorCode = "DOMAIN_JOIN_ERROR_MORE_DATA"
	FleetErrorCodeDomain_join_error_no_such_domain                         FleetErrorCode = "DOMAIN_JOIN_ERROR_NO_SUCH_DOMAIN"
	FleetErrorCodeDomain_join_error_not_supported                          FleetErrorCode = "DOMAIN_JOIN_ERROR_NOT_SUPPORTED"
	FleetErrorCodeDomain_join_nerr_invalid_workgroup_name                  FleetErrorCode = "DOMAIN_JOIN_NERR_INVALID_WORKGROUP_NAME"
	FleetErrorCodeDomain_join_nerr_workstation_not_started                 FleetErrorCode = "DOMAIN_JOIN_NERR_WORKSTATION_NOT_STARTED"
	FleetErrorCodeDomain_join_error_ds_machine_account_quota_exceeded      FleetErrorCode = "DOMAIN_JOIN_ERROR_DS_MACHINE_ACCOUNT_QUOTA_EXCEEDED"
	FleetErrorCodeDomain_join_nerr_password_expired                        FleetErrorCode = "DOMAIN_JOIN_NERR_PASSWORD_EXPIRED"
	FleetErrorCodeDomain_join_internal_service_error                       FleetErrorCode = "DOMAIN_JOIN_INTERNAL_SERVICE_ERROR"
)

Enum values for FleetErrorCode

type FleetState 

type FleetState string
const (
	FleetStateStarting FleetState = "STARTING"
	FleetStateRunning  FleetState = "RUNNING"
	FleetStateStopping FleetState = "STOPPING"
	FleetStateStopped  FleetState = "STOPPED"
)

Enum values for FleetState

type FleetType 

type FleetType string
const (
	FleetTypeAlways_on FleetType = "ALWAYS_ON"
	FleetTypeOn_demand FleetType = "ON_DEMAND"
)

Enum values for FleetType

type Image 

type Image struct {
	// The permissions to provide to the destination AWS account for the specified
	// image.
	ImagePermissions *ImagePermissions
	// Indicates whether the image is public or private.
	Visibility VisibilityType
	// The reason why the last state change occurred.
	StateChangeReason *ImageStateChangeReason
	// The image name to display.
	DisplayName *string
	// The ARN of the image from which this image was created.
	BaseImageArn *string
	// The time the image was created.
	CreatedTime *time.Time
	// The description to display.
	Description *string
	// The operating system platform of the image.
	Platform PlatformType
	// The applications associated with the image.
	Applications []*Application
	// The ARN of the image.
	Arn *string
	// The version of the AppStream 2.0 agent to use for instances that are launched
	// from this image.
	AppstreamAgentVersion *string
	// The name of the image.
	Name *string
	// The name of the image builder that was used to create the private image. If the
	// image is shared, this value is null.
	ImageBuilderName *string
	// The image starts in the PENDING state. If image creation succeeds, the state is
	// AVAILABLE. If image creation fails, the state is FAILED.
	State ImageState
	// Indicates whether an image builder can be launched from this image.
	ImageBuilderSupported *bool
	// 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.
	PublicBaseImageReleasedDate *time.Time
}

Describes an image.

type ImageBuilder 

type ImageBuilder struct {
	// The ARN for the image builder.
	Arn *string
	// The VPC configuration of the image builder.
	VpcConfig *VpcConfig
	// The image builder errors.
	ImageBuilderErrors []*ResourceError
	// Enables or disables default internet access for the image builder.
	EnableDefaultInternetAccess *bool
	// The image builder name to display.
	DisplayName *string
	// The instance type for the image builder. 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
	InstanceType *string
	// The name of the directory and organizational unit (OU) to use to join the image
	// builder to a Microsoft Active Directory domain.
	DomainJoinInfo *DomainJoinInfo
	// The name of the image builder.
	Name *string
	// The operating system platform of the image builder.
	Platform PlatformType
	// The time stamp when the image builder was created.
	CreatedTime *time.Time
	// Describes the network details of the fleet or image builder instance.
	NetworkAccessConfiguration *NetworkAccessConfiguration
	// The reason why the last state change occurred.
	StateChangeReason *ImageBuilderStateChangeReason
	// The version of the AppStream 2.0 agent that is currently being used by the image
	// builder.
	AppstreamAgentVersion *string
	// The ARN of the image from which this builder was created.
	ImageArn *string
	// The list of virtual private cloud (VPC) interface endpoint objects.
	// Administrators can connect to the image builder only through the specified
	// endpoints.
	AccessEndpoints []*AccessEndpoint
	// The state of the image builder.
	State ImageBuilderState
	// The description to display.
	Description *string
	// The ARN of the IAM role that is applied to the image builder. To assume a role,
	// the image builder calls the AWS Security Token Service (STS) AssumeRole API
	// operation and passes the ARN of the role to use. The operation creates a new
	// session with temporary credentials. AppStream 2.0 retrieves the temporary
	// credentials and creates the AppStream_Machine_Role credential profile on the
	// instance.  <p>For more information, see <a
	// href="https://docs.aws.amazon.com/appstream2/latest/developerguide/using-iam-roles-to-grant-permissions-to-applications-scripts-streaming-instances.html">Using
	// an IAM Role to Grant Permissions to Applications and Scripts Running on
	// AppStream 2.0 Streaming Instances</a> in the <i>Amazon AppStream 2.0
	// Administration Guide</i>.</p>
	IamRoleArn *string
}

Describes a virtual machine that is used to create an image.

type ImageBuilderState 

type ImageBuilderState string
const (
	ImageBuilderStatePending        ImageBuilderState = "PENDING"
	ImageBuilderStateUpdating_agent ImageBuilderState = "UPDATING_AGENT"
	ImageBuilderStateRunning        ImageBuilderState = "RUNNING"
	ImageBuilderStateStopping       ImageBuilderState = "STOPPING"
	ImageBuilderStateStopped        ImageBuilderState = "STOPPED"
	ImageBuilderStateRebooting      ImageBuilderState = "REBOOTING"
	ImageBuilderStateSnapshotting   ImageBuilderState = "SNAPSHOTTING"
	ImageBuilderStateDeleting       ImageBuilderState = "DELETING"
	ImageBuilderStateFailed         ImageBuilderState = "FAILED"
)

Enum values for ImageBuilderState

type ImageBuilderStateChangeReason 

type ImageBuilderStateChangeReason struct {
	// The state change reason code.
	Code ImageBuilderStateChangeReasonCode
	// The state change reason message.
	Message *string
}

Describes the reason why the last image builder state change occurred.

type ImageBuilderStateChangeReasonCode 

type ImageBuilderStateChangeReasonCode string
const (
	ImageBuilderStateChangeReasonCodeInternal_error    ImageBuilderStateChangeReasonCode = "INTERNAL_ERROR"
	ImageBuilderStateChangeReasonCodeImage_unavailable ImageBuilderStateChangeReasonCode = "IMAGE_UNAVAILABLE"
)

Enum values for ImageBuilderStateChangeReasonCode

type ImagePermissions 

type ImagePermissions struct {
	// Indicates whether the image can be used for a fleet.
	AllowFleet *bool
	// Indicates whether the image can be used for an image builder.
	AllowImageBuilder *bool
}

Describes the permissions for an image.

type ImageState 

type ImageState string
const (
	ImageStatePending   ImageState = "PENDING"
	ImageStateAvailable ImageState = "AVAILABLE"
	ImageStateFailed    ImageState = "FAILED"
	ImageStateCopying   ImageState = "COPYING"
	ImageStateDeleting  ImageState = "DELETING"
)

Enum values for ImageState

type ImageStateChangeReason 

type ImageStateChangeReason struct {
	// The state change reason message.
	Message *string
	// The state change reason code.
	Code ImageStateChangeReasonCode
}

Describes the reason why the last image state change occurred.

type ImageStateChangeReasonCode 

type ImageStateChangeReasonCode string
const (
	ImageStateChangeReasonCodeInternal_error              ImageStateChangeReasonCode = "INTERNAL_ERROR"
	ImageStateChangeReasonCodeImage_builder_not_available ImageStateChangeReasonCode = "IMAGE_BUILDER_NOT_AVAILABLE"
	ImageStateChangeReasonCodeImage_copy_failure          ImageStateChangeReasonCode = "IMAGE_COPY_FAILURE"
)

Enum values for ImageStateChangeReasonCode

type IncompatibleImageException 

type IncompatibleImageException struct {
	Message *string
}

The image does not support storage connectors.

func (*IncompatibleImageException) Error 

func (e *IncompatibleImageException) Error() string

func (*IncompatibleImageException) ErrorCode 

func (e *IncompatibleImageException) ErrorCode() string

func (*IncompatibleImageException) ErrorFault 

func (e *IncompatibleImageException) ErrorFault() smithy.ErrorFault

func (*IncompatibleImageException) ErrorMessage 

func (e *IncompatibleImageException) ErrorMessage() string

func (*IncompatibleImageException) GetMessage 

func (e *IncompatibleImageException) GetMessage() string

func (*IncompatibleImageException) HasMessage 

func (e *IncompatibleImageException) HasMessage() bool

type InvalidAccountStatusException 

type InvalidAccountStatusException struct {
	Message *string
}

The resource cannot be created because your AWS account is suspended. For assistance, contact AWS Support.

func (*InvalidAccountStatusException) Error 

func (e *InvalidAccountStatusException) Error() string

func (*InvalidAccountStatusException) ErrorCode 

func (e *InvalidAccountStatusException) ErrorCode() string

func (*InvalidAccountStatusException) ErrorFault 

func (e *InvalidAccountStatusException) ErrorFault() smithy.ErrorFault

func (*InvalidAccountStatusException) ErrorMessage 

func (e *InvalidAccountStatusException) ErrorMessage() string

func (*InvalidAccountStatusException) GetMessage 

func (e *InvalidAccountStatusException) GetMessage() string

func (*InvalidAccountStatusException) HasMessage 

func (e *InvalidAccountStatusException) HasMessage() bool

type InvalidParameterCombinationException 

type InvalidParameterCombinationException struct {
	Message *string
}

Indicates an incorrect combination of parameters, or a missing parameter.

func (*InvalidParameterCombinationException) Error 

func (e *InvalidParameterCombinationException) Error() string

func (*InvalidParameterCombinationException) ErrorCode 

func (e *InvalidParameterCombinationException) ErrorCode() string

func (*InvalidParameterCombinationException) ErrorFault 

func (e *InvalidParameterCombinationException) ErrorFault() smithy.ErrorFault

func (*InvalidParameterCombinationException) ErrorMessage 

func (e *InvalidParameterCombinationException) ErrorMessage() string

func (*InvalidParameterCombinationException) GetMessage 

func (e *InvalidParameterCombinationException) GetMessage() string

func (*InvalidParameterCombinationException) HasMessage 

func (e *InvalidParameterCombinationException) HasMessage() bool

type InvalidRoleException 

type InvalidRoleException struct {
	Message *string
}

The specified role is invalid.

func (*InvalidRoleException) Error 

func (e *InvalidRoleException) Error() string

func (*InvalidRoleException) ErrorCode 

func (e *InvalidRoleException) ErrorCode() string

func (*InvalidRoleException) ErrorFault 

func (e *InvalidRoleException) ErrorFault() smithy.ErrorFault

func (*InvalidRoleException) ErrorMessage 

func (e *InvalidRoleException) ErrorMessage() string

func (*InvalidRoleException) GetMessage 

func (e *InvalidRoleException) GetMessage() string

func (*InvalidRoleException) HasMessage 

func (e *InvalidRoleException) HasMessage() bool

type LastReportGenerationExecutionError 

type LastReportGenerationExecutionError struct {
	// The error code for the error that is returned when a usage report can't be
	// generated.
	ErrorCode UsageReportExecutionErrorCode
	// The error message for the error that is returned when a usage report can't be
	// generated.
	ErrorMessage *string
}

Describes the error that is returned when a usage report can't be generated.

type LimitExceededException 

type LimitExceededException struct {
	Message *string
}

The requested limit exceeds the permitted limit for an account.

func (*LimitExceededException) Error 

func (e *LimitExceededException) Error() string

func (*LimitExceededException) ErrorCode 

func (e *LimitExceededException) ErrorCode() string

func (*LimitExceededException) ErrorFault 

func (e *LimitExceededException) ErrorFault() smithy.ErrorFault

func (*LimitExceededException) ErrorMessage 

func (e *LimitExceededException) ErrorMessage() string

func (*LimitExceededException) GetMessage 

func (e *LimitExceededException) GetMessage() string

func (*LimitExceededException) HasMessage 

func (e *LimitExceededException) HasMessage() bool

type MessageAction 

type MessageAction string
const (
	MessageActionSuppress MessageAction = "SUPPRESS"
	MessageActionResend   MessageAction = "RESEND"
)

Enum values for MessageAction

type NetworkAccessConfiguration 

type NetworkAccessConfiguration struct {
	// The private IP address of the elastic network interface that is attached to
	// instances in your VPC.
	EniPrivateIpAddress *string
	// The resource identifier of the elastic network interface that is attached to
	// instances in your VPC. All network interfaces have the eni-xxxxxxxx resource
	// identifier.
	EniId *string
}

Describes the network details of the fleet or image builder instance.

type OperationNotPermittedException 

type OperationNotPermittedException struct {
	Message *string
}

The attempted operation is not permitted.

func (*OperationNotPermittedException) Error 

func (e *OperationNotPermittedException) Error() string

func (*OperationNotPermittedException) ErrorCode 

func (e *OperationNotPermittedException) ErrorCode() string

func (*OperationNotPermittedException) ErrorFault 

func (e *OperationNotPermittedException) ErrorFault() smithy.ErrorFault

func (*OperationNotPermittedException) ErrorMessage 

func (e *OperationNotPermittedException) ErrorMessage() string

func (*OperationNotPermittedException) GetMessage 

func (e *OperationNotPermittedException) GetMessage() string

func (*OperationNotPermittedException) HasMessage 

func (e *OperationNotPermittedException) HasMessage() bool

type Permission 

type Permission string
const (
	PermissionEnabled  Permission = "ENABLED"
	PermissionDisabled Permission = "DISABLED"
)

Enum values for Permission

type PlatformType 

type PlatformType string
const (
	PlatformTypeWindows             PlatformType = "WINDOWS"
	PlatformTypeWindows_server_2016 PlatformType = "WINDOWS_SERVER_2016"
	PlatformTypeWindows_server_2019 PlatformType = "WINDOWS_SERVER_2019"
)

Enum values for PlatformType

type ResourceAlreadyExistsException 

type ResourceAlreadyExistsException struct {
	Message *string
}

The specified resource already exists.

func (*ResourceAlreadyExistsException) Error 

func (e *ResourceAlreadyExistsException) Error() string

func (*ResourceAlreadyExistsException) ErrorCode 

func (e *ResourceAlreadyExistsException) ErrorCode() string

func (*ResourceAlreadyExistsException) ErrorFault 

func (e *ResourceAlreadyExistsException) ErrorFault() smithy.ErrorFault

func (*ResourceAlreadyExistsException) ErrorMessage 

func (e *ResourceAlreadyExistsException) ErrorMessage() string

func (*ResourceAlreadyExistsException) GetMessage 

func (e *ResourceAlreadyExistsException) GetMessage() string

func (*ResourceAlreadyExistsException) HasMessage 

func (e *ResourceAlreadyExistsException) HasMessage() bool

type ResourceError 

type ResourceError struct {
	// The time the error occurred.
	ErrorTimestamp *time.Time
	// The error message.
	ErrorMessage *string
	// The error code.
	ErrorCode FleetErrorCode
}

Describes a resource error.

type ResourceInUseException 

type ResourceInUseException struct {
	Message *string
}

The specified resource is in use.

func (*ResourceInUseException) Error 

func (e *ResourceInUseException) Error() string

func (*ResourceInUseException) ErrorCode 

func (e *ResourceInUseException) ErrorCode() string

func (*ResourceInUseException) ErrorFault 

func (e *ResourceInUseException) ErrorFault() smithy.ErrorFault

func (*ResourceInUseException) ErrorMessage 

func (e *ResourceInUseException) ErrorMessage() string

func (*ResourceInUseException) GetMessage 

func (e *ResourceInUseException) GetMessage() string

func (*ResourceInUseException) HasMessage 

func (e *ResourceInUseException) HasMessage() bool

type ResourceNotAvailableException 

type ResourceNotAvailableException struct {
	Message *string
}

The specified resource exists and is not in use, but isn't available.

func (*ResourceNotAvailableException) Error 

func (e *ResourceNotAvailableException) Error() string

func (*ResourceNotAvailableException) ErrorCode 

func (e *ResourceNotAvailableException) ErrorCode() string

func (*ResourceNotAvailableException) ErrorFault 

func (e *ResourceNotAvailableException) ErrorFault() smithy.ErrorFault

func (*ResourceNotAvailableException) ErrorMessage 

func (e *ResourceNotAvailableException) ErrorMessage() string

func (*ResourceNotAvailableException) GetMessage 

func (e *ResourceNotAvailableException) GetMessage() string

func (*ResourceNotAvailableException) HasMessage 

func (e *ResourceNotAvailableException) HasMessage() bool

type ResourceNotFoundException 

type ResourceNotFoundException struct {
	Message *string
}

The specified resource was not found.

func (*ResourceNotFoundException) Error 

func (e *ResourceNotFoundException) Error() string

func (*ResourceNotFoundException) ErrorCode 

func (e *ResourceNotFoundException) ErrorCode() string

func (*ResourceNotFoundException) ErrorFault 

func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault

func (*ResourceNotFoundException) ErrorMessage 

func (e *ResourceNotFoundException) ErrorMessage() string

func (*ResourceNotFoundException) GetMessage 

func (e *ResourceNotFoundException) GetMessage() string

func (*ResourceNotFoundException) HasMessage 

func (e *ResourceNotFoundException) HasMessage() bool

type ServiceAccountCredentials 

type ServiceAccountCredentials struct {
	// The password for the account.
	AccountPassword *string
	// The user name of the account. This account must have the following privileges:
	// create computer objects, join computers to the domain, and change/reset the
	// password on descendant computer objects for the organizational units specified.
	AccountName *string
}

Describes the credentials for the service account used by the fleet or image builder to connect to the directory.

type Session 

type Session struct {
	// The current state of the streaming session.
	State SessionState
	// The time when a streaming instance is dedicated for the user.
	StartTime *time.Time
	// The time when the streaming session is set to expire. This time is based on the
	// MaxUserDurationinSeconds value, which determines the maximum length of time that
	// a streaming session can run. A streaming session might end earlier than the time
	// specified in SessionMaxExpirationTime, when the DisconnectTimeOutInSeconds
	// elapses or the user chooses to end his or her session. If the
	// DisconnectTimeOutInSeconds elapses, or the user chooses to end his or her
	// session, the streaming instance is terminated and the streaming session ends.
	MaxExpirationTime *time.Time
	// The network details for the streaming session.
	NetworkAccessConfiguration *NetworkAccessConfiguration
	// The identifier of the streaming session.
	Id *string
	// Specifies whether a user is connected to the streaming session.
	ConnectionState SessionConnectionState
	// The authentication method. The user is authenticated using a streaming URL (API)
	// or SAML 2.0 federation (SAML).
	AuthenticationType AuthenticationType
	// The identifier of the user for whom the session was created.
	UserId *string
	// The name of the stack for the streaming session.
	StackName *string
	// The name of the fleet for the streaming session.
	FleetName *string
}

Describes a streaming session.

type SessionConnectionState 

type SessionConnectionState string
const (
	SessionConnectionStateConnected     SessionConnectionState = "CONNECTED"
	SessionConnectionStateNot_connected SessionConnectionState = "NOT_CONNECTED"
)

Enum values for SessionConnectionState

type SessionState 

type SessionState string
const (
	SessionStateActive  SessionState = "ACTIVE"
	SessionStatePending SessionState = "PENDING"
	SessionStateExpired SessionState = "EXPIRED"
)

Enum values for SessionState

type SharedImagePermissions 

type SharedImagePermissions struct {
	// The 12-digit identifier of the AWS account with which the image is shared.
	SharedAccountId *string
	// Describes the permissions for a shared image.
	ImagePermissions *ImagePermissions
}

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

type Stack 

type Stack struct {
	// The storage connectors to enable.
	StorageConnectors []*StorageConnector
	// The time the stack was created.
	CreatedTime *time.Time
	// The name of the stack.
	Name *string
	// The ARN of the stack.
	Arn *string
	// The URL that users are redirected to after they click the Send Feedback link. If
	// no URL is specified, no Send Feedback link is displayed.
	FeedbackURL *string
	// The description to display.
	Description *string
	// The actions that are enabled or disabled for users during their streaming
	// sessions. By default these actions are enabled.
	UserSettings []*UserSetting
	// The errors for the stack.
	StackErrors []*StackError
	// The persistent application settings for users of the stack.
	ApplicationSettings *ApplicationSettingsResponse
	// The domains where AppStream 2.0 streaming sessions can be embedded in an iframe.
	// You must approve the domains that you want to host embedded AppStream 2.0
	// streaming sessions.
	EmbedHostDomains []*string
	// The URL that users are redirected to after their streaming session ends.
	RedirectURL *string
	// The list of virtual private cloud (VPC) interface endpoint objects. Users of the
	// stack can connect to AppStream 2.0 only through the specified endpoints.
	AccessEndpoints []*AccessEndpoint
	// The stack name to display.
	DisplayName *string
}

Describes a stack.

type StackAttribute 

type StackAttribute string
const (
	StackAttributeStorage_connectors             StackAttribute = "STORAGE_CONNECTORS"
	StackAttributeStorage_connector_homefolders  StackAttribute = "STORAGE_CONNECTOR_HOMEFOLDERS"
	StackAttributeStorage_connector_google_drive StackAttribute = "STORAGE_CONNECTOR_GOOGLE_DRIVE"
	StackAttributeStorage_connector_one_drive    StackAttribute = "STORAGE_CONNECTOR_ONE_DRIVE"
	StackAttributeRedirect_url                   StackAttribute = "REDIRECT_URL"
	StackAttributeFeedback_url                   StackAttribute = "FEEDBACK_URL"
	StackAttributeTheme_name                     StackAttribute = "THEME_NAME"
	StackAttributeUser_settings                  StackAttribute = "USER_SETTINGS"
	StackAttributeEmbed_host_domains             StackAttribute = "EMBED_HOST_DOMAINS"
	StackAttributeIam_role_arn                   StackAttribute = "IAM_ROLE_ARN"
	StackAttributeAccess_endpoints               StackAttribute = "ACCESS_ENDPOINTS"
)

Enum values for StackAttribute

type StackError 

type StackError struct {
	// The error message.
	ErrorMessage *string
	// The error code.
	ErrorCode StackErrorCode
}

Describes a stack error.

type StackErrorCode 

type StackErrorCode string
const (
	StackErrorCodeStorage_connector_error StackErrorCode = "STORAGE_CONNECTOR_ERROR"
	StackErrorCodeInternal_service_error  StackErrorCode = "INTERNAL_SERVICE_ERROR"
)

Enum values for StackErrorCode

type StorageConnector 

type StorageConnector struct {
	// The names of the domains for the account.
	Domains []*string
	// The ARN of the storage connector.
	ResourceIdentifier *string
	// The type of storage connector.
	ConnectorType StorageConnectorType
}

Describes a connector that enables persistent storage for users.

type StorageConnectorType 

type StorageConnectorType string
const (
	StorageConnectorTypeHomefolders  StorageConnectorType = "HOMEFOLDERS"
	StorageConnectorTypeGoogle_drive StorageConnectorType = "GOOGLE_DRIVE"
	StorageConnectorTypeOne_drive    StorageConnectorType = "ONE_DRIVE"
)

Enum values for StorageConnectorType

type UsageReportExecutionErrorCode 

type UsageReportExecutionErrorCode string
const (
	UsageReportExecutionErrorCodeResource_not_found     UsageReportExecutionErrorCode = "RESOURCE_NOT_FOUND"
	UsageReportExecutionErrorCodeAccess_denied          UsageReportExecutionErrorCode = "ACCESS_DENIED"
	UsageReportExecutionErrorCodeInternal_service_error UsageReportExecutionErrorCode = "INTERNAL_SERVICE_ERROR"
)

Enum values for UsageReportExecutionErrorCode

type UsageReportSchedule 

type UsageReportSchedule string
const (
	UsageReportScheduleDaily UsageReportSchedule = "DAILY"
)

Enum values for UsageReportSchedule

type UsageReportSubscription 

type UsageReportSubscription struct {
	// The time when the last usage report was generated.
	LastGeneratedReportDate *time.Time
	// The schedule for generating usage reports.
	Schedule UsageReportSchedule
	// The errors that were returned if usage reports couldn't be generated.
	SubscriptionErrors []*LastReportGenerationExecutionError
	// The Amazon S3 bucket where generated reports are stored.  <p>If you enabled
	// on-instance session scripts and Amazon S3 logging for your session script
	// configuration, AppStream 2.0 created an S3 bucket to store the script output.
	// The bucket is unique to your account and Region. When you enable usage reporting
	// in this case, AppStream 2.0 uses the same bucket to store your usage reports. If
	// you haven't already enabled on-instance session scripts, when you enable usage
	// reports, AppStream 2.0 creates a new S3 bucket.</p>
	S3BucketName *string
}

Describes information about the usage report subscription.

type User 

type User struct {
	// Specifies whether the user in the user pool is enabled.
	Enabled *bool
	// The authentication type for the user.
	AuthenticationType AuthenticationType
	// The email address of the user.  <note> <p>Users' email addresses are
	// case-sensitive.</p> </note>
	UserName *string
	// The status of the user in the user pool. The status can be one of the
	// following:
	//
	//     * UNCONFIRMED – The user is created but not confirmed.
	//
	//     *
	// CONFIRMED – The user is confirmed.
	//
	//     * ARCHIVED – The user is no longer
	// active.
	//
	//     * COMPROMISED – The user is disabled because of a potential
	// security threat.
	//
	//     * UNKNOWN – The user status is not known.
	Status *string
	// The first name, or given name, of the user.
	FirstName *string
	// The ARN of the user.
	Arn *string
	// The date and time the user was created in the user pool.
	CreatedTime *time.Time
	// The last name, or surname, of the user.
	LastName *string
}

Describes a user in the user pool.

type UserSetting 

type UserSetting struct {
	// Indicates whether the action is enabled or disabled.
	Permission Permission
	// The action that is enabled or disabled.
	Action Action
}

Describes an action and whether the action is enabled or disabled for users during their streaming sessions.

type UserStackAssociation 

type UserStackAssociation struct {
	// The name of the stack that is associated with the user.
	StackName *string
	// The authentication type for the user.
	AuthenticationType AuthenticationType
	// Specifies whether a welcome email is sent to a user after the user is created in
	// the user pool.
	SendEmailNotification *bool
	// The email address of the user who is associated with the stack.  <note>
	// <p>Users' email addresses are case-sensitive.</p> </note>
	UserName *string
}

Describes a user in the user pool and the associated stack.

type UserStackAssociationError 

type UserStackAssociationError struct {
	// Information about the user and associated stack.
	UserStackAssociation *UserStackAssociation
	// The error code for the error that is returned when a user can’t be associated
	// with or disassociated from a stack.
	ErrorCode UserStackAssociationErrorCode
	// The error message for the error that is returned when a user can’t be associated
	// with or disassociated from a stack.
	ErrorMessage *string
}

Describes the error that is returned when a user can’t be associated with or disassociated from a stack.

type UserStackAssociationErrorCode 

type UserStackAssociationErrorCode string
const (
	UserStackAssociationErrorCodeStack_not_found     UserStackAssociationErrorCode = "STACK_NOT_FOUND"
	UserStackAssociationErrorCodeUser_name_not_found UserStackAssociationErrorCode = "USER_NAME_NOT_FOUND"
	UserStackAssociationErrorCodeInternal_error      UserStackAssociationErrorCode = "INTERNAL_ERROR"
)

Enum values for UserStackAssociationErrorCode

type VisibilityType 

type VisibilityType string
const (
	VisibilityTypePublic  VisibilityType = "PUBLIC"
	VisibilityTypePrivate VisibilityType = "PRIVATE"
	VisibilityTypeShared  VisibilityType = "SHARED"
)

Enum values for VisibilityType

type VpcConfig 

type VpcConfig struct {
	// The identifiers of the security groups for the fleet or image builder.
	SecurityGroupIds []*string
	// The identifiers of the subnets to which a network interface is attached from the
	// fleet instance or image builder instance. Fleet instances use one or more
	// subnets. Image builder instances use one subnet.
	SubnetIds []*string
}

Describes VPC configuration information for fleets and image builders.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.