Documentation ¶
Overview ¶
Package appstream provides the API client, operations, and parameter types for Amazon AppStream.
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 (https://docs.aws.amazon.com/appstream2/latest/developerguide/access-api-cli-through-interface-vpc-endpoint.html) in the Amazon AppStream 2.0 Administration Guide. To learn more about AppStream 2.0, see the following resources:
* Amazon AppStream 2.0 product page (http://aws.amazon.com/appstream2)
* Amazon AppStream 2.0 documentation (http://aws.amazon.com/documentation/appstream2)
Index ¶
- Constants
- func NewDefaultEndpointResolver() *internalendpoints.Resolver
- func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)
- func WithEndpointResolver(v EndpointResolver) func(*Options)
- type AssociateFleetInput
- type AssociateFleetOutput
- type BatchAssociateUserStackInput
- type BatchAssociateUserStackOutput
- type BatchDisassociateUserStackInput
- type BatchDisassociateUserStackOutput
- type Client
- func (c *Client) AssociateFleet(ctx context.Context, params *AssociateFleetInput, optFns ...func(*Options)) (*AssociateFleetOutput, error)
- func (c *Client) BatchAssociateUserStack(ctx context.Context, params *BatchAssociateUserStackInput, ...) (*BatchAssociateUserStackOutput, error)
- func (c *Client) BatchDisassociateUserStack(ctx context.Context, params *BatchDisassociateUserStackInput, ...) (*BatchDisassociateUserStackOutput, error)
- func (c *Client) CopyImage(ctx context.Context, params *CopyImageInput, optFns ...func(*Options)) (*CopyImageOutput, error)
- func (c *Client) CreateDirectoryConfig(ctx context.Context, params *CreateDirectoryConfigInput, ...) (*CreateDirectoryConfigOutput, error)
- func (c *Client) CreateFleet(ctx context.Context, params *CreateFleetInput, optFns ...func(*Options)) (*CreateFleetOutput, error)
- func (c *Client) CreateImageBuilder(ctx context.Context, params *CreateImageBuilderInput, optFns ...func(*Options)) (*CreateImageBuilderOutput, error)
- func (c *Client) CreateImageBuilderStreamingURL(ctx context.Context, params *CreateImageBuilderStreamingURLInput, ...) (*CreateImageBuilderStreamingURLOutput, error)
- func (c *Client) CreateStack(ctx context.Context, params *CreateStackInput, optFns ...func(*Options)) (*CreateStackOutput, error)
- func (c *Client) CreateStreamingURL(ctx context.Context, params *CreateStreamingURLInput, optFns ...func(*Options)) (*CreateStreamingURLOutput, error)
- func (c *Client) CreateUpdatedImage(ctx context.Context, params *CreateUpdatedImageInput, optFns ...func(*Options)) (*CreateUpdatedImageOutput, error)
- func (c *Client) CreateUsageReportSubscription(ctx context.Context, params *CreateUsageReportSubscriptionInput, ...) (*CreateUsageReportSubscriptionOutput, error)
- func (c *Client) CreateUser(ctx context.Context, params *CreateUserInput, optFns ...func(*Options)) (*CreateUserOutput, error)
- func (c *Client) DeleteDirectoryConfig(ctx context.Context, params *DeleteDirectoryConfigInput, ...) (*DeleteDirectoryConfigOutput, error)
- func (c *Client) DeleteFleet(ctx context.Context, params *DeleteFleetInput, optFns ...func(*Options)) (*DeleteFleetOutput, error)
- func (c *Client) DeleteImage(ctx context.Context, params *DeleteImageInput, optFns ...func(*Options)) (*DeleteImageOutput, error)
- func (c *Client) DeleteImageBuilder(ctx context.Context, params *DeleteImageBuilderInput, optFns ...func(*Options)) (*DeleteImageBuilderOutput, error)
- func (c *Client) DeleteImagePermissions(ctx context.Context, params *DeleteImagePermissionsInput, ...) (*DeleteImagePermissionsOutput, error)
- func (c *Client) DeleteStack(ctx context.Context, params *DeleteStackInput, optFns ...func(*Options)) (*DeleteStackOutput, error)
- func (c *Client) DeleteUsageReportSubscription(ctx context.Context, params *DeleteUsageReportSubscriptionInput, ...) (*DeleteUsageReportSubscriptionOutput, error)
- func (c *Client) DeleteUser(ctx context.Context, params *DeleteUserInput, optFns ...func(*Options)) (*DeleteUserOutput, error)
- func (c *Client) DescribeDirectoryConfigs(ctx context.Context, params *DescribeDirectoryConfigsInput, ...) (*DescribeDirectoryConfigsOutput, error)
- func (c *Client) DescribeFleets(ctx context.Context, params *DescribeFleetsInput, optFns ...func(*Options)) (*DescribeFleetsOutput, error)
- func (c *Client) DescribeImageBuilders(ctx context.Context, params *DescribeImageBuildersInput, ...) (*DescribeImageBuildersOutput, error)
- func (c *Client) DescribeImagePermissions(ctx context.Context, params *DescribeImagePermissionsInput, ...) (*DescribeImagePermissionsOutput, error)
- func (c *Client) DescribeImages(ctx context.Context, params *DescribeImagesInput, optFns ...func(*Options)) (*DescribeImagesOutput, error)
- func (c *Client) DescribeSessions(ctx context.Context, params *DescribeSessionsInput, optFns ...func(*Options)) (*DescribeSessionsOutput, error)
- func (c *Client) DescribeStacks(ctx context.Context, params *DescribeStacksInput, optFns ...func(*Options)) (*DescribeStacksOutput, error)
- func (c *Client) DescribeUsageReportSubscriptions(ctx context.Context, params *DescribeUsageReportSubscriptionsInput, ...) (*DescribeUsageReportSubscriptionsOutput, error)
- func (c *Client) DescribeUserStackAssociations(ctx context.Context, params *DescribeUserStackAssociationsInput, ...) (*DescribeUserStackAssociationsOutput, error)
- func (c *Client) DescribeUsers(ctx context.Context, params *DescribeUsersInput, optFns ...func(*Options)) (*DescribeUsersOutput, error)
- func (c *Client) DisableUser(ctx context.Context, params *DisableUserInput, optFns ...func(*Options)) (*DisableUserOutput, error)
- func (c *Client) DisassociateFleet(ctx context.Context, params *DisassociateFleetInput, optFns ...func(*Options)) (*DisassociateFleetOutput, error)
- func (c *Client) EnableUser(ctx context.Context, params *EnableUserInput, optFns ...func(*Options)) (*EnableUserOutput, error)
- func (c *Client) ExpireSession(ctx context.Context, params *ExpireSessionInput, optFns ...func(*Options)) (*ExpireSessionOutput, error)
- func (c *Client) ListAssociatedFleets(ctx context.Context, params *ListAssociatedFleetsInput, ...) (*ListAssociatedFleetsOutput, error)
- func (c *Client) ListAssociatedStacks(ctx context.Context, params *ListAssociatedStacksInput, ...) (*ListAssociatedStacksOutput, error)
- func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, ...) (*ListTagsForResourceOutput, error)
- func (c *Client) StartFleet(ctx context.Context, params *StartFleetInput, optFns ...func(*Options)) (*StartFleetOutput, error)
- func (c *Client) StartImageBuilder(ctx context.Context, params *StartImageBuilderInput, optFns ...func(*Options)) (*StartImageBuilderOutput, error)
- func (c *Client) StopFleet(ctx context.Context, params *StopFleetInput, optFns ...func(*Options)) (*StopFleetOutput, error)
- func (c *Client) StopImageBuilder(ctx context.Context, params *StopImageBuilderInput, optFns ...func(*Options)) (*StopImageBuilderOutput, error)
- func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)
- func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)
- func (c *Client) UpdateDirectoryConfig(ctx context.Context, params *UpdateDirectoryConfigInput, ...) (*UpdateDirectoryConfigOutput, error)
- func (c *Client) UpdateFleet(ctx context.Context, params *UpdateFleetInput, optFns ...func(*Options)) (*UpdateFleetOutput, error)
- func (c *Client) UpdateImagePermissions(ctx context.Context, params *UpdateImagePermissionsInput, ...) (*UpdateImagePermissionsOutput, error)
- func (c *Client) UpdateStack(ctx context.Context, params *UpdateStackInput, optFns ...func(*Options)) (*UpdateStackOutput, error)
- type CopyImageInput
- type CopyImageOutput
- type CreateDirectoryConfigInput
- type CreateDirectoryConfigOutput
- type CreateFleetInput
- type CreateFleetOutput
- type CreateImageBuilderInput
- type CreateImageBuilderOutput
- type CreateImageBuilderStreamingURLInput
- type CreateImageBuilderStreamingURLOutput
- type CreateStackInput
- type CreateStackOutput
- type CreateStreamingURLInput
- type CreateStreamingURLOutput
- type CreateUpdatedImageInput
- type CreateUpdatedImageOutput
- type CreateUsageReportSubscriptionInput
- type CreateUsageReportSubscriptionOutput
- type CreateUserInput
- type CreateUserOutput
- type DeleteDirectoryConfigInput
- type DeleteDirectoryConfigOutput
- type DeleteFleetInput
- type DeleteFleetOutput
- type DeleteImageBuilderInput
- type DeleteImageBuilderOutput
- type DeleteImageInput
- type DeleteImageOutput
- type DeleteImagePermissionsInput
- type DeleteImagePermissionsOutput
- type DeleteStackInput
- type DeleteStackOutput
- type DeleteUsageReportSubscriptionInput
- type DeleteUsageReportSubscriptionOutput
- type DeleteUserInput
- type DeleteUserOutput
- type DescribeDirectoryConfigsInput
- type DescribeDirectoryConfigsOutput
- type DescribeFleetsAPIClient
- type DescribeFleetsInput
- type DescribeFleetsOutput
- type DescribeImageBuildersInput
- type DescribeImageBuildersOutput
- type DescribeImagePermissionsAPIClient
- type DescribeImagePermissionsInput
- type DescribeImagePermissionsOutput
- type DescribeImagePermissionsPaginator
- type DescribeImagePermissionsPaginatorOptions
- type DescribeImagesAPIClient
- type DescribeImagesInput
- type DescribeImagesOutput
- type DescribeImagesPaginator
- type DescribeImagesPaginatorOptions
- type DescribeSessionsInput
- type DescribeSessionsOutput
- type DescribeStacksInput
- type DescribeStacksOutput
- type DescribeUsageReportSubscriptionsInput
- type DescribeUsageReportSubscriptionsOutput
- type DescribeUserStackAssociationsInput
- type DescribeUserStackAssociationsOutput
- type DescribeUsersInput
- type DescribeUsersOutput
- type DisableUserInput
- type DisableUserOutput
- type DisassociateFleetInput
- type DisassociateFleetOutput
- type EnableUserInput
- type EnableUserOutput
- type EndpointResolver
- type EndpointResolverFunc
- type EndpointResolverOptions
- type ExpireSessionInput
- type ExpireSessionOutput
- type FleetStartedWaiter
- type FleetStartedWaiterOptions
- type FleetStoppedWaiter
- type FleetStoppedWaiterOptions
- type HTTPClient
- type HTTPSignerV4
- type ListAssociatedFleetsInput
- type ListAssociatedFleetsOutput
- type ListAssociatedStacksInput
- type ListAssociatedStacksOutput
- type ListTagsForResourceInput
- type ListTagsForResourceOutput
- type Options
- type ResolveEndpoint
- type StartFleetInput
- type StartFleetOutput
- type StartImageBuilderInput
- type StartImageBuilderOutput
- type StopFleetInput
- type StopFleetOutput
- type StopImageBuilderInput
- type StopImageBuilderOutput
- type TagResourceInput
- type TagResourceOutput
- type UntagResourceInput
- type UntagResourceOutput
- type UpdateDirectoryConfigInput
- type UpdateDirectoryConfigOutput
- type UpdateFleetInput
- type UpdateFleetOutput
- type UpdateImagePermissionsInput
- type UpdateImagePermissionsOutput
- type UpdateStackInput
- type UpdateStackOutput
Constants ¶
const ServiceAPIVersion = "2016-12-01"
const ServiceID = "AppStream"
Variables ¶
This section is empty.
Functions ¶
func NewDefaultEndpointResolver ¶
func NewDefaultEndpointResolver() *internalendpoints.Resolver
NewDefaultEndpointResolver constructs a new service endpoint resolver
func WithAPIOptions ¶ added in v1.0.0
func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)
WithAPIOptions returns a functional option for setting the Client's APIOptions option.
func WithEndpointResolver ¶
func WithEndpointResolver(v EndpointResolver) func(*Options)
WithEndpointResolver returns a functional option for setting the Client's EndpointResolver option.
Types ¶
type AssociateFleetInput ¶
type AssociateFleetOutput ¶
type AssociateFleetOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type BatchAssociateUserStackInput ¶
type BatchAssociateUserStackInput struct { // The list of UserStackAssociation objects. // // This member is required. UserStackAssociations []types.UserStackAssociation // contains filtered or unexported fields }
type BatchAssociateUserStackOutput ¶
type BatchAssociateUserStackOutput struct { // The list of UserStackAssociationError objects. Errors []types.UserStackAssociationError // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type BatchDisassociateUserStackInput ¶
type BatchDisassociateUserStackInput struct { // The list of UserStackAssociation objects. // // This member is required. UserStackAssociations []types.UserStackAssociation // contains filtered or unexported fields }
type BatchDisassociateUserStackOutput ¶
type BatchDisassociateUserStackOutput struct { // The list of UserStackAssociationError objects. Errors []types.UserStackAssociationError // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client provides the API client to make operations call for Amazon AppStream.
func New ¶
New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.
func NewFromConfig ¶
NewFromConfig returns a new client from the provided config.
func (*Client) AssociateFleet ¶
func (c *Client) AssociateFleet(ctx context.Context, params *AssociateFleetInput, optFns ...func(*Options)) (*AssociateFleetOutput, error)
Associates the specified fleet with the specified stack.
func (*Client) BatchAssociateUserStack ¶
func (c *Client) BatchAssociateUserStack(ctx context.Context, params *BatchAssociateUserStackInput, optFns ...func(*Options)) (*BatchAssociateUserStackOutput, error)
Associates the specified users with the specified stacks. Users in a user pool cannot be assigned to stacks with fleets that are joined to an Active Directory domain.
func (*Client) BatchDisassociateUserStack ¶
func (c *Client) BatchDisassociateUserStack(ctx context.Context, params *BatchDisassociateUserStackInput, optFns ...func(*Options)) (*BatchDisassociateUserStackOutput, error)
Disassociates the specified users from the specified stacks.
func (*Client) CopyImage ¶
func (c *Client) CopyImage(ctx context.Context, params *CopyImageInput, optFns ...func(*Options)) (*CopyImageOutput, error)
Copies the image within the same region or to a new region within the same AWS account. Note that any tags you added to the image will not be copied.
func (*Client) CreateDirectoryConfig ¶
func (c *Client) CreateDirectoryConfig(ctx context.Context, params *CreateDirectoryConfigInput, optFns ...func(*Options)) (*CreateDirectoryConfigOutput, error)
Creates a Directory Config object in AppStream 2.0. This object includes the configuration information required to join fleets and image builders to Microsoft Active Directory domains.
func (*Client) CreateFleet ¶
func (c *Client) CreateFleet(ctx context.Context, params *CreateFleetInput, optFns ...func(*Options)) (*CreateFleetOutput, error)
Creates a fleet. A fleet consists of streaming instances that run a specified image.
func (*Client) CreateImageBuilder ¶
func (c *Client) CreateImageBuilder(ctx context.Context, params *CreateImageBuilderInput, optFns ...func(*Options)) (*CreateImageBuilderOutput, error)
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.
func (*Client) CreateImageBuilderStreamingURL ¶
func (c *Client) CreateImageBuilderStreamingURL(ctx context.Context, params *CreateImageBuilderStreamingURLInput, optFns ...func(*Options)) (*CreateImageBuilderStreamingURLOutput, error)
Creates a URL to start an image builder streaming session.
func (*Client) CreateStack ¶
func (c *Client) CreateStack(ctx context.Context, params *CreateStackInput, optFns ...func(*Options)) (*CreateStackOutput, error)
Creates a stack to start streaming applications to users. A stack consists of an associated fleet, user access policies, and storage configurations.
func (*Client) CreateStreamingURL ¶
func (c *Client) CreateStreamingURL(ctx context.Context, params *CreateStreamingURLInput, optFns ...func(*Options)) (*CreateStreamingURLOutput, error)
Creates a temporary URL to start an AppStream 2.0 streaming session for the specified user. A streaming URL enables application streaming to be tested without user setup.
func (*Client) CreateUpdatedImage ¶ added in v1.3.0
func (c *Client) CreateUpdatedImage(ctx context.Context, params *CreateUpdatedImageInput, optFns ...func(*Options)) (*CreateUpdatedImageOutput, error)
Creates a new image with the latest Windows operating system updates, driver updates, and AppStream 2.0 agent software. For more information, see the "Update an Image by Using Managed AppStream 2.0 Image Updates" section in Administer Your AppStream 2.0 Images (https://docs.aws.amazon.com/appstream2/latest/developerguide/administer-images.html), in the Amazon AppStream 2.0 Administration Guide.
func (*Client) CreateUsageReportSubscription ¶
func (c *Client) CreateUsageReportSubscription(ctx context.Context, params *CreateUsageReportSubscriptionInput, optFns ...func(*Options)) (*CreateUsageReportSubscriptionOutput, error)
Creates a usage report subscription. Usage reports are generated daily.
func (*Client) CreateUser ¶
func (c *Client) CreateUser(ctx context.Context, params *CreateUserInput, optFns ...func(*Options)) (*CreateUserOutput, error)
Creates a new user in the user pool.
func (*Client) DeleteDirectoryConfig ¶
func (c *Client) DeleteDirectoryConfig(ctx context.Context, params *DeleteDirectoryConfigInput, optFns ...func(*Options)) (*DeleteDirectoryConfigOutput, error)
Deletes the specified Directory Config object from AppStream 2.0. This object includes the information required to join streaming instances to an Active Directory domain.
func (*Client) DeleteFleet ¶
func (c *Client) DeleteFleet(ctx context.Context, params *DeleteFleetInput, optFns ...func(*Options)) (*DeleteFleetOutput, error)
Deletes the specified fleet.
func (*Client) DeleteImage ¶
func (c *Client) DeleteImage(ctx context.Context, params *DeleteImageInput, optFns ...func(*Options)) (*DeleteImageOutput, error)
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.
func (*Client) DeleteImageBuilder ¶
func (c *Client) DeleteImageBuilder(ctx context.Context, params *DeleteImageBuilderInput, optFns ...func(*Options)) (*DeleteImageBuilderOutput, error)
Deletes the specified image builder and releases the capacity.
func (*Client) DeleteImagePermissions ¶
func (c *Client) DeleteImagePermissions(ctx context.Context, params *DeleteImagePermissionsInput, optFns ...func(*Options)) (*DeleteImagePermissionsOutput, error)
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.
func (*Client) DeleteStack ¶
func (c *Client) DeleteStack(ctx context.Context, params *DeleteStackInput, optFns ...func(*Options)) (*DeleteStackOutput, error)
Deletes the specified stack. After the stack is deleted, the application streaming environment provided by the stack is no longer available to users. Also, any reservations made for application streaming sessions for the stack are released.
func (*Client) DeleteUsageReportSubscription ¶
func (c *Client) DeleteUsageReportSubscription(ctx context.Context, params *DeleteUsageReportSubscriptionInput, optFns ...func(*Options)) (*DeleteUsageReportSubscriptionOutput, error)
Disables usage report generation.
func (*Client) DeleteUser ¶
func (c *Client) DeleteUser(ctx context.Context, params *DeleteUserInput, optFns ...func(*Options)) (*DeleteUserOutput, error)
Deletes a user from the user pool.
func (*Client) DescribeDirectoryConfigs ¶
func (c *Client) DescribeDirectoryConfigs(ctx context.Context, params *DescribeDirectoryConfigsInput, optFns ...func(*Options)) (*DescribeDirectoryConfigsOutput, error)
Retrieves a list that describes one or more specified Directory Config objects for AppStream 2.0, if the names for these objects are provided. Otherwise, all Directory Config objects in the account are described. These objects include the configuration information required to join fleets and image builders to Microsoft Active Directory domains. Although the response syntax in this topic includes the account password, this password is not returned in the actual response.
func (*Client) DescribeFleets ¶
func (c *Client) DescribeFleets(ctx context.Context, params *DescribeFleetsInput, optFns ...func(*Options)) (*DescribeFleetsOutput, error)
Retrieves a list that describes one or more specified fleets, if the fleet names are provided. Otherwise, all fleets in the account are described.
func (*Client) DescribeImageBuilders ¶
func (c *Client) DescribeImageBuilders(ctx context.Context, params *DescribeImageBuildersInput, optFns ...func(*Options)) (*DescribeImageBuildersOutput, error)
Retrieves a list that describes one or more specified image builders, if the image builder names are provided. Otherwise, all image builders in the account are described.
func (*Client) DescribeImagePermissions ¶
func (c *Client) DescribeImagePermissions(ctx context.Context, params *DescribeImagePermissionsInput, optFns ...func(*Options)) (*DescribeImagePermissionsOutput, error)
Retrieves a list that describes the permissions for shared AWS account IDs on a private image that you own.
func (*Client) DescribeImages ¶
func (c *Client) DescribeImages(ctx context.Context, params *DescribeImagesInput, optFns ...func(*Options)) (*DescribeImagesOutput, error)
Retrieves a list that describes one or more specified images, if the image names or image ARNs are provided. Otherwise, all images in the account are described.
func (*Client) DescribeSessions ¶
func (c *Client) DescribeSessions(ctx context.Context, params *DescribeSessionsInput, optFns ...func(*Options)) (*DescribeSessionsOutput, error)
Retrieves a list that describes the streaming sessions for a specified stack and fleet. If a UserId is provided for the stack and fleet, only streaming sessions for that user are described. If an authentication type is not provided, the default is to authenticate users using a streaming URL.
func (*Client) DescribeStacks ¶
func (c *Client) DescribeStacks(ctx context.Context, params *DescribeStacksInput, optFns ...func(*Options)) (*DescribeStacksOutput, error)
Retrieves a list that describes one or more specified stacks, if the stack names are provided. Otherwise, all stacks in the account are described.
func (*Client) DescribeUsageReportSubscriptions ¶
func (c *Client) DescribeUsageReportSubscriptions(ctx context.Context, params *DescribeUsageReportSubscriptionsInput, optFns ...func(*Options)) (*DescribeUsageReportSubscriptionsOutput, error)
Retrieves a list that describes one or more usage report subscriptions.
func (*Client) DescribeUserStackAssociations ¶
func (c *Client) DescribeUserStackAssociations(ctx context.Context, params *DescribeUserStackAssociationsInput, optFns ...func(*Options)) (*DescribeUserStackAssociationsOutput, error)
Retrieves a list that describes the UserStackAssociation objects. You must specify either or both of the following:
* The stack name
* The user name (email address of the user associated with the stack) and the authentication type for the user
func (*Client) DescribeUsers ¶
func (c *Client) DescribeUsers(ctx context.Context, params *DescribeUsersInput, optFns ...func(*Options)) (*DescribeUsersOutput, error)
Retrieves a list that describes one or more specified users in the user pool.
func (*Client) DisableUser ¶
func (c *Client) DisableUser(ctx context.Context, params *DisableUserInput, optFns ...func(*Options)) (*DisableUserOutput, error)
Disables the specified user in the user pool. Users can't sign in to AppStream 2.0 until they are re-enabled. This action does not delete the user.
func (*Client) DisassociateFleet ¶
func (c *Client) DisassociateFleet(ctx context.Context, params *DisassociateFleetInput, optFns ...func(*Options)) (*DisassociateFleetOutput, error)
Disassociates the specified fleet from the specified stack.
func (*Client) EnableUser ¶
func (c *Client) EnableUser(ctx context.Context, params *EnableUserInput, optFns ...func(*Options)) (*EnableUserOutput, error)
Enables a user in the user pool. After being enabled, users can sign in to AppStream 2.0 and open applications from the stacks to which they are assigned.
func (*Client) ExpireSession ¶
func (c *Client) ExpireSession(ctx context.Context, params *ExpireSessionInput, optFns ...func(*Options)) (*ExpireSessionOutput, error)
Immediately stops the specified streaming session.
func (*Client) ListAssociatedFleets ¶
func (c *Client) ListAssociatedFleets(ctx context.Context, params *ListAssociatedFleetsInput, optFns ...func(*Options)) (*ListAssociatedFleetsOutput, error)
Retrieves the name of the fleet that is associated with the specified stack.
func (*Client) ListAssociatedStacks ¶
func (c *Client) ListAssociatedStacks(ctx context.Context, params *ListAssociatedStacksInput, optFns ...func(*Options)) (*ListAssociatedStacksOutput, error)
Retrieves the name of the stack with which the specified fleet is associated.
func (*Client) ListTagsForResource ¶
func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)
Retrieves a list of all tags for the specified AppStream 2.0 resource. You can tag AppStream 2.0 image builders, images, fleets, and stacks. For more information about tags, see Tagging Your Resources (https://docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic.html) in the Amazon AppStream 2.0 Administration Guide.
func (*Client) StartFleet ¶
func (c *Client) StartFleet(ctx context.Context, params *StartFleetInput, optFns ...func(*Options)) (*StartFleetOutput, error)
Starts the specified fleet.
func (*Client) StartImageBuilder ¶
func (c *Client) StartImageBuilder(ctx context.Context, params *StartImageBuilderInput, optFns ...func(*Options)) (*StartImageBuilderOutput, error)
Starts the specified image builder.
func (*Client) StopFleet ¶
func (c *Client) StopFleet(ctx context.Context, params *StopFleetInput, optFns ...func(*Options)) (*StopFleetOutput, error)
Stops the specified fleet.
func (*Client) StopImageBuilder ¶
func (c *Client) StopImageBuilder(ctx context.Context, params *StopImageBuilderInput, optFns ...func(*Options)) (*StopImageBuilderOutput, error)
Stops the specified image builder.
func (*Client) TagResource ¶
func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)
Adds or overwrites one or more tags for the specified AppStream 2.0 resource. You can tag AppStream 2.0 image builders, images, fleets, and stacks. Each tag consists of a key and an optional value. If a resource already has a tag with the same key, this operation updates its value. To list the current tags for your resources, use ListTagsForResource. To disassociate tags from your resources, use UntagResource. For more information about tags, see Tagging Your Resources (https://docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic.html) in the Amazon AppStream 2.0 Administration Guide.
func (*Client) UntagResource ¶
func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)
Disassociates one or more specified tags from the specified AppStream 2.0 resource. To list the current tags for your resources, use ListTagsForResource. For more information about tags, see Tagging Your Resources (https://docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic.html) in the Amazon AppStream 2.0 Administration Guide.
func (*Client) UpdateDirectoryConfig ¶
func (c *Client) UpdateDirectoryConfig(ctx context.Context, params *UpdateDirectoryConfigInput, optFns ...func(*Options)) (*UpdateDirectoryConfigOutput, error)
Updates the specified Directory Config object in AppStream 2.0. This object includes the configuration information required to join fleets and image builders to Microsoft Active Directory domains.
func (*Client) UpdateFleet ¶
func (c *Client) UpdateFleet(ctx context.Context, params *UpdateFleetInput, optFns ...func(*Options)) (*UpdateFleetOutput, error)
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, ComputeCapacity, ImageARN, ImageName, IdleDisconnectTimeoutInSeconds, and DisconnectTimeoutInSeconds attributes. If the fleet is in the STARTING or STOPPING state, you can't update it.
func (*Client) UpdateImagePermissions ¶
func (c *Client) UpdateImagePermissions(ctx context.Context, params *UpdateImagePermissionsInput, optFns ...func(*Options)) (*UpdateImagePermissionsOutput, error)
Adds or updates permissions for the specified private image.
func (*Client) UpdateStack ¶
func (c *Client) UpdateStack(ctx context.Context, params *UpdateStackInput, optFns ...func(*Options)) (*UpdateStackOutput, error)
Updates the specified fields for the specified stack.
type CopyImageInput ¶
type CopyImageInput struct { // The name that the image will have when it is copied to the destination. // // This member is required. DestinationImageName *string // The destination region to which the image will be copied. This parameter is // required, even if you are copying an image within the same region. // // This member is required. DestinationRegion *string // The name of the image to copy. // // This member is required. SourceImageName *string // The description that the image will have when it is copied to the destination. DestinationImageDescription *string // contains filtered or unexported fields }
type CopyImageOutput ¶
type CopyImageOutput struct { // The name of the destination image. DestinationImageName *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CreateDirectoryConfigInput ¶
type CreateDirectoryConfigInput struct { // The fully qualified name of the directory (for example, corp.example.com). // // This member is required. DirectoryName *string // The distinguished names of the organizational units for computer accounts. // // This member is required. OrganizationalUnitDistinguishedNames []string // The credentials for the service account used by the fleet or image builder to // connect to the directory. ServiceAccountCredentials *types.ServiceAccountCredentials // contains filtered or unexported fields }
type CreateDirectoryConfigOutput ¶
type CreateDirectoryConfigOutput struct { // Information about the directory configuration. DirectoryConfig *types.DirectoryConfig // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CreateFleetInput ¶
type CreateFleetInput struct { // The desired capacity for the fleet. // // This member is required. ComputeCapacity *types.ComputeCapacity // The instance type to use when launching fleet instances. The following instance // types are available: // // * stream.standard.small // // * 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.memory.z1d.large // // * // stream.memory.z1d.xlarge // // * stream.memory.z1d.2xlarge // // * // stream.memory.z1d.3xlarge // // * stream.memory.z1d.6xlarge // // * // stream.memory.z1d.12xlarge // // * stream.graphics-design.large // // * // stream.graphics-design.xlarge // // * stream.graphics-design.2xlarge // // * // stream.graphics-design.4xlarge // // * stream.graphics-desktop.2xlarge // // * // stream.graphics.g4dn.xlarge // // * stream.graphics.g4dn.2xlarge // // * // stream.graphics.g4dn.4xlarge // // * stream.graphics.g4dn.8xlarge // // * // stream.graphics.g4dn.12xlarge // // * stream.graphics.g4dn.16xlarge // // * // stream.graphics-pro.4xlarge // // * stream.graphics-pro.8xlarge // // * // stream.graphics-pro.16xlarge // // This member is required. InstanceType *string // A unique name for the fleet. // // This member is required. Name *string // The description to display. Description *string // The amount of time that a streaming session remains active after users // disconnect. If users 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 fleet name to display. DisplayName *string // The name of the directory and organizational unit (OU) to use to join the fleet // to a Microsoft Active Directory domain. DomainJoinInfo *types.DomainJoinInfo // Enables or disables default internet access for the fleet. EnableDefaultInternetAccess *bool // 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 types.FleetType // The Amazon Resource Name (ARN) of the IAM role to apply to the fleet. To assume // a role, a 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. For more information, see Using an IAM Role to Grant Permissions to // Applications and Scripts Running on AppStream 2.0 Streaming Instances // (https://docs.aws.amazon.com/appstream2/latest/developerguide/using-iam-roles-to-grant-permissions-to-applications-scripts-streaming-instances.html) // in the Amazon AppStream 2.0 Administration Guide. IamRoleArn *string // 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 they 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. 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. IdleDisconnectTimeoutInSeconds *int32 // The ARN of the public, private, or shared image to use. ImageArn *string // The name of the image used to create the fleet. ImageName *string // 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 AppStream 2.0 view that is displayed to your users when they stream from the // fleet. When APP is specified, only the windows of applications opened by users // display. When DESKTOP is specified, the standard desktop that is provided by the // operating system displays. The default value is APP. StreamView types.StreamView // The tags to associate with the fleet. A tag is a key-value pair, and the value // is optional. For example, Environment=Test. If you do not specify a value, // Environment=. If you do not specify a value, the value is set to an empty // string. Generally allowed characters are: letters, numbers, and spaces // representable in UTF-8, and the following special characters: _ . : / = + \ - @ // For more information, see Tagging Your Resources // (https://docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic.html) // in the Amazon AppStream 2.0 Administration Guide. Tags map[string]string // The VPC configuration for the fleet. VpcConfig *types.VpcConfig // contains filtered or unexported fields }
type CreateFleetOutput ¶
type CreateFleetOutput struct { // Information about the fleet. Fleet *types.Fleet // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CreateImageBuilderInput ¶
type CreateImageBuilderInput struct { // The instance type to use when launching the image builder. The following // instance types are available: // // * stream.standard.small // // * // 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.memory.z1d.large // // * stream.memory.z1d.xlarge // // * // stream.memory.z1d.2xlarge // // * stream.memory.z1d.3xlarge // // * // stream.memory.z1d.6xlarge // // * stream.memory.z1d.12xlarge // // * // stream.graphics-design.large // // * stream.graphics-design.xlarge // // * // stream.graphics-design.2xlarge // // * stream.graphics-design.4xlarge // // * // stream.graphics-desktop.2xlarge // // * stream.graphics.g4dn.xlarge // // * // stream.graphics.g4dn.2xlarge // // * stream.graphics.g4dn.4xlarge // // * // stream.graphics.g4dn.8xlarge // // * stream.graphics.g4dn.12xlarge // // * // stream.graphics.g4dn.16xlarge // // * stream.graphics-pro.4xlarge // // * // stream.graphics-pro.8xlarge // // * stream.graphics-pro.16xlarge // // This member is required. InstanceType *string // A unique name for the image builder. // // This member is required. Name *string // The list of interface VPC endpoint (interface endpoint) objects. Administrators // can connect to the image builder only through the specified endpoints. AccessEndpoints []types.AccessEndpoint // 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]. AppstreamAgentVersion *string // The description to display. Description *string // The image builder name to display. DisplayName *string // The name of the directory and organizational unit (OU) to use to join the image // builder to a Microsoft Active Directory domain. DomainJoinInfo *types.DomainJoinInfo // Enables or disables default internet access for the image builder. EnableDefaultInternetAccess *bool // The Amazon Resource Name (ARN) of the IAM role to apply 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. For more information, see Using an IAM Role to Grant // Permissions to Applications and Scripts Running on AppStream 2.0 Streaming // Instances // (https://docs.aws.amazon.com/appstream2/latest/developerguide/using-iam-roles-to-grant-permissions-to-applications-scripts-streaming-instances.html) // in the Amazon AppStream 2.0 Administration Guide. IamRoleArn *string // The ARN of the public, private, or shared image to use. ImageArn *string // The name of the image used to create the image builder. ImageName *string // The tags to associate with the image builder. A tag is a key-value pair, and the // value is optional. For example, Environment=Test. If you do not specify a value, // Environment=. Generally allowed characters are: letters, numbers, and spaces // representable in UTF-8, and the following special characters: _ . : / = + \ - @ // If you do not specify a value, the value is set to an empty string. For more // information about tags, see Tagging Your Resources // (https://docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic.html) // in the Amazon AppStream 2.0 Administration Guide. Tags map[string]string // The VPC configuration for the image builder. You can specify only one subnet. VpcConfig *types.VpcConfig // contains filtered or unexported fields }
type CreateImageBuilderOutput ¶
type CreateImageBuilderOutput struct { // Information about the image builder. ImageBuilder *types.ImageBuilder // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CreateImageBuilderStreamingURLInput ¶
type CreateImageBuilderStreamingURLInput struct { // The name of the image builder. // // This member is required. Name *string // The time that the streaming URL will be valid, in seconds. Specify a value // between 1 and 604800 seconds. The default is 3600 seconds. Validity *int64 // contains filtered or unexported fields }
type CreateImageBuilderStreamingURLOutput ¶
type CreateImageBuilderStreamingURLOutput struct { // The elapsed time, in seconds after the Unix epoch, when this URL expires. Expires *time.Time // The URL to start the AppStream 2.0 streaming session. StreamingURL *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CreateStackInput ¶
type CreateStackInput struct { // The name of the stack. // // This member is required. Name *string // The list of interface VPC endpoint (interface endpoint) objects. Users of the // stack can connect to AppStream 2.0 only through the specified endpoints. AccessEndpoints []types.AccessEndpoint // The persistent application settings for users of a stack. When these settings // are enabled, changes that users make to applications and Windows settings are // automatically saved after each session and applied to the next session. ApplicationSettings *types.ApplicationSettings // The description to display. Description *string // The stack name to display. DisplayName *string // 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 they click the Send Feedback link. If // no URL is specified, no Send Feedback link is displayed. FeedbackURL *string // The URL that users are redirected to after their streaming session ends. RedirectURL *string // The storage connectors to enable. StorageConnectors []types.StorageConnector // The tags to associate with the stack. A tag is a key-value pair, and the value // is optional. For example, Environment=Test. If you do not specify a value, // Environment=. If you do not specify a value, the value is set to an empty // string. Generally allowed characters are: letters, numbers, and spaces // representable in UTF-8, and the following special characters: _ . : / = + \ - @ // For more information about tags, see Tagging Your Resources // (https://docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic.html) // in the Amazon AppStream 2.0 Administration Guide. Tags map[string]string // The actions that are enabled or disabled for users during their streaming // sessions. By default, these actions are enabled. UserSettings []types.UserSetting // contains filtered or unexported fields }
type CreateStackOutput ¶
type CreateStackOutput struct { // Information about the stack. Stack *types.Stack // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CreateStreamingURLInput ¶
type CreateStreamingURLInput struct { // The name of the fleet. // // This member is required. FleetName *string // The name of the stack. // // This member is required. StackName *string // The identifier of the user. // // This member is required. UserId *string // The name of the application to launch after the session starts. This is the name // that you specified as Name in the Image Assistant. If your fleet is enabled for // the Desktop stream view, you can also choose to launch directly to the operating // system desktop. To do so, specify Desktop. ApplicationId *string // The session context. For more information, see Session Context // (https://docs.aws.amazon.com/appstream2/latest/developerguide/managing-stacks-fleets.html#managing-stacks-fleets-parameters) // in the Amazon AppStream 2.0 Administration Guide. SessionContext *string // The time that the streaming URL will be valid, in seconds. Specify a value // between 1 and 604800 seconds. The default is 60 seconds. Validity *int64 // contains filtered or unexported fields }
type CreateStreamingURLOutput ¶
type CreateStreamingURLOutput struct { // The elapsed time, in seconds after the Unix epoch, when this URL expires. Expires *time.Time // The URL to start the AppStream 2.0 streaming session. StreamingURL *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CreateUpdatedImageInput ¶ added in v1.3.0
type CreateUpdatedImageInput struct { // The name of the image to update. // // This member is required. ExistingImageName *string // The name of the new image. The name must be unique within the AWS account and // Region. // // This member is required. NewImageName *string // Indicates whether to display the status of image update availability before // AppStream 2.0 initiates the process of creating a new updated image. If this // value is set to true, AppStream 2.0 displays whether image updates are // available. If this value is set to false, AppStream 2.0 initiates the process of // creating a new updated image without displaying whether image updates are // available. DryRun bool // The description to display for the new image. NewImageDescription *string // The name to display for the new image. NewImageDisplayName *string // The tags to associate with the new image. A tag is a key-value pair, and the // value is optional. For example, Environment=Test. If you do not specify a value, // Environment=. Generally allowed characters are: letters, numbers, and spaces // representable in UTF-8, and the following special characters: _ . : / = + \ - @ // If you do not specify a value, the value is set to an empty string. For more // information about tags, see Tagging Your Resources // (https://docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic.html) // in the Amazon AppStream 2.0 Administration Guide. NewImageTags map[string]string // contains filtered or unexported fields }
type CreateUpdatedImageOutput ¶ added in v1.3.0
type CreateUpdatedImageOutput struct { // Indicates whether a new image can be created. CanUpdateImage bool // Describes an image. Image *types.Image // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CreateUsageReportSubscriptionInput ¶
type CreateUsageReportSubscriptionInput struct {
// contains filtered or unexported fields
}
type CreateUsageReportSubscriptionOutput ¶
type CreateUsageReportSubscriptionOutput struct { // The Amazon S3 bucket where generated reports are stored. 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. S3BucketName *string // The schedule for generating usage reports. Schedule types.UsageReportSchedule // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CreateUserInput ¶
type CreateUserInput struct { // The authentication type for the user. You must specify USERPOOL. // // This member is required. AuthenticationType types.AuthenticationType // The email address of the user. Users' email addresses are case-sensitive. During // login, if they specify an email address that doesn't use the same capitalization // as the email address specified when their user pool account was created, a "user // does not exist" error message displays. // // This member is required. UserName *string // The first name, or given name, of the user. FirstName *string // The last name, or surname, of the user. LastName *string // The action to take for the welcome email that is sent to a user after the user // is created in the user pool. If you specify SUPPRESS, no email is sent. If you // specify RESEND, do not specify the first name or last name of the user. If the // value is null, the email is sent. The temporary password in the welcome email is // valid for only 7 days. If users don’t set their passwords within 7 days, you // must send them a new welcome email. MessageAction types.MessageAction // contains filtered or unexported fields }
type CreateUserOutput ¶
type CreateUserOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteDirectoryConfigInput ¶
type DeleteDirectoryConfigInput struct { // The name of the directory configuration. // // This member is required. DirectoryName *string // contains filtered or unexported fields }
type DeleteDirectoryConfigOutput ¶
type DeleteDirectoryConfigOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteFleetInput ¶
type DeleteFleetInput struct { // The name of the fleet. // // This member is required. Name *string // contains filtered or unexported fields }
type DeleteFleetOutput ¶
type DeleteFleetOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteImageBuilderInput ¶
type DeleteImageBuilderInput struct { // The name of the image builder. // // This member is required. Name *string // contains filtered or unexported fields }
type DeleteImageBuilderOutput ¶
type DeleteImageBuilderOutput struct { // Information about the image builder. ImageBuilder *types.ImageBuilder // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteImageInput ¶
type DeleteImageInput struct { // The name of the image. // // This member is required. Name *string // contains filtered or unexported fields }
type DeleteImageOutput ¶
type DeleteImageOutput struct { // Information about the image. Image *types.Image // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteImagePermissionsOutput ¶
type DeleteImagePermissionsOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteStackInput ¶
type DeleteStackInput struct { // The name of the stack. // // This member is required. Name *string // contains filtered or unexported fields }
type DeleteStackOutput ¶
type DeleteStackOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteUsageReportSubscriptionInput ¶
type DeleteUsageReportSubscriptionInput struct {
// contains filtered or unexported fields
}
type DeleteUsageReportSubscriptionOutput ¶
type DeleteUsageReportSubscriptionOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteUserInput ¶
type DeleteUserInput struct { // The authentication type for the user. You must specify USERPOOL. // // This member is required. AuthenticationType types.AuthenticationType // The email address of the user. Users' email addresses are case-sensitive. // // This member is required. UserName *string // contains filtered or unexported fields }
type DeleteUserOutput ¶
type DeleteUserOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeDirectoryConfigsInput ¶
type DescribeDirectoryConfigsInput struct { // The directory names. DirectoryNames []string // The maximum size of each page of results. MaxResults *int32 // 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. NextToken *string // contains filtered or unexported fields }
type DescribeDirectoryConfigsOutput ¶
type DescribeDirectoryConfigsOutput struct { // Information about the directory configurations. Note that although the response // syntax in this topic includes the account password, this password is not // returned in the actual response. DirectoryConfigs []types.DirectoryConfig // 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. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeFleetsAPIClient ¶ added in v0.31.0
type DescribeFleetsAPIClient interface {
DescribeFleets(context.Context, *DescribeFleetsInput, ...func(*Options)) (*DescribeFleetsOutput, error)
}
DescribeFleetsAPIClient is a client that implements the DescribeFleets operation.
type DescribeFleetsInput ¶
type DescribeFleetsOutput ¶
type DescribeFleetsOutput struct { // Information about the fleets. Fleets []types.Fleet // 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. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeImageBuildersInput ¶
type DescribeImageBuildersInput struct { // The maximum size of each page of results. MaxResults *int32 // The names of the image builders to describe. Names []string // The pagination token to use to retrieve the next page of results for this // operation. If this value is null, it retrieves the first page. NextToken *string // contains filtered or unexported fields }
type DescribeImageBuildersOutput ¶
type DescribeImageBuildersOutput struct { // Information about the image builders. ImageBuilders []types.ImageBuilder // 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. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeImagePermissionsAPIClient ¶ added in v0.30.0
type DescribeImagePermissionsAPIClient interface {
DescribeImagePermissions(context.Context, *DescribeImagePermissionsInput, ...func(*Options)) (*DescribeImagePermissionsOutput, error)
}
DescribeImagePermissionsAPIClient is a client that implements the DescribeImagePermissions operation.
type DescribeImagePermissionsInput ¶
type DescribeImagePermissionsInput struct { // The name of the private image for which to describe permissions. The image must // be one that you own. // // This member is required. Name *string // The maximum size of each page of results. MaxResults *int32 // 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. NextToken *string // shared. SharedAwsAccountIds []string // contains filtered or unexported fields }
type DescribeImagePermissionsOutput ¶
type DescribeImagePermissionsOutput struct { // The name of the private image. Name *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. NextToken *string SharedImagePermissionsList []types.SharedImagePermissions // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeImagePermissionsPaginator ¶ added in v0.30.0
type DescribeImagePermissionsPaginator struct {
// contains filtered or unexported fields
}
DescribeImagePermissionsPaginator is a paginator for DescribeImagePermissions
func NewDescribeImagePermissionsPaginator ¶ added in v0.30.0
func NewDescribeImagePermissionsPaginator(client DescribeImagePermissionsAPIClient, params *DescribeImagePermissionsInput, optFns ...func(*DescribeImagePermissionsPaginatorOptions)) *DescribeImagePermissionsPaginator
NewDescribeImagePermissionsPaginator returns a new DescribeImagePermissionsPaginator
func (*DescribeImagePermissionsPaginator) HasMorePages ¶ added in v0.30.0
func (p *DescribeImagePermissionsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeImagePermissionsPaginator) NextPage ¶ added in v0.30.0
func (p *DescribeImagePermissionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeImagePermissionsOutput, error)
NextPage retrieves the next DescribeImagePermissions page.
type DescribeImagePermissionsPaginatorOptions ¶ added in v0.30.0
type DescribeImagePermissionsPaginatorOptions struct { // The maximum size of each page of results. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
DescribeImagePermissionsPaginatorOptions is the paginator options for DescribeImagePermissions
type DescribeImagesAPIClient ¶ added in v0.30.0
type DescribeImagesAPIClient interface {
DescribeImages(context.Context, *DescribeImagesInput, ...func(*Options)) (*DescribeImagesOutput, error)
}
DescribeImagesAPIClient is a client that implements the DescribeImages operation.
type DescribeImagesInput ¶
type DescribeImagesInput struct { // The ARNs of the public, private, and shared images to describe. Arns []string // The maximum size of each page of results. MaxResults *int32 // The names of the public or private images to describe. Names []string // The pagination token to use to retrieve the next page of results for this // operation. If this value is null, it retrieves the first page. NextToken *string // The type of image (public, private, or shared) to describe. Type types.VisibilityType // contains filtered or unexported fields }
type DescribeImagesOutput ¶
type DescribeImagesOutput struct { // Information about the images. Images []types.Image // 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. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeImagesPaginator ¶ added in v0.30.0
type DescribeImagesPaginator struct {
// contains filtered or unexported fields
}
DescribeImagesPaginator is a paginator for DescribeImages
func NewDescribeImagesPaginator ¶ added in v0.30.0
func NewDescribeImagesPaginator(client DescribeImagesAPIClient, params *DescribeImagesInput, optFns ...func(*DescribeImagesPaginatorOptions)) *DescribeImagesPaginator
NewDescribeImagesPaginator returns a new DescribeImagesPaginator
func (*DescribeImagesPaginator) HasMorePages ¶ added in v0.30.0
func (p *DescribeImagesPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeImagesPaginator) NextPage ¶ added in v0.30.0
func (p *DescribeImagesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeImagesOutput, error)
NextPage retrieves the next DescribeImages page.
type DescribeImagesPaginatorOptions ¶ added in v0.30.0
type DescribeImagesPaginatorOptions struct { // The maximum size of each page of results. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
DescribeImagesPaginatorOptions is the paginator options for DescribeImages
type DescribeSessionsInput ¶
type DescribeSessionsInput struct { // The name of the fleet. This value is case-sensitive. // // This member is required. FleetName *string // The name of the stack. This value is case-sensitive. // // This member is required. StackName *string // The authentication method. Specify API for a user authenticated using a // streaming URL or SAML for a SAML federated user. The default is to authenticate // users using a streaming URL. AuthenticationType types.AuthenticationType // The size of each page of results. The default value is 20 and the maximum value // is 50. Limit *int32 // 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. NextToken *string // The user identifier (ID). If you specify a user ID, you must also specify the // authentication type. UserId *string // contains filtered or unexported fields }
type DescribeSessionsOutput ¶
type DescribeSessionsOutput struct { // 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. NextToken *string // Information about the streaming sessions. Sessions []types.Session // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeStacksInput ¶
type DescribeStacksOutput ¶
type DescribeStacksOutput struct { // 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. NextToken *string // Information about the stacks. Stacks []types.Stack // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeUsageReportSubscriptionsInput ¶
type DescribeUsageReportSubscriptionsInput struct { // The maximum size of each page of results. MaxResults *int32 // 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. NextToken *string // contains filtered or unexported fields }
type DescribeUsageReportSubscriptionsOutput ¶
type DescribeUsageReportSubscriptionsOutput struct { // 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. NextToken *string // Information about the usage report subscription. UsageReportSubscriptions []types.UsageReportSubscription // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeUserStackAssociationsInput ¶
type DescribeUserStackAssociationsInput struct { // The authentication type for the user who is associated with the stack. You must // specify USERPOOL. AuthenticationType types.AuthenticationType // The maximum size of each page of results. MaxResults *int32 // 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. NextToken *string // The name of the stack that is associated with the user. StackName *string // The email address of the user who is associated with the stack. Users' email // addresses are case-sensitive. UserName *string // contains filtered or unexported fields }
type DescribeUserStackAssociationsOutput ¶
type DescribeUserStackAssociationsOutput struct { // 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. NextToken *string // The UserStackAssociation objects. UserStackAssociations []types.UserStackAssociation // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeUsersInput ¶
type DescribeUsersInput struct { // The authentication type for the users in the user pool to describe. You must // specify USERPOOL. // // This member is required. AuthenticationType types.AuthenticationType // The maximum size of each page of results. MaxResults *int32 // 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. NextToken *string // contains filtered or unexported fields }
type DescribeUsersOutput ¶
type DescribeUsersOutput struct { // 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. NextToken *string // Information about users in the user pool. Users []types.User // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DisableUserInput ¶
type DisableUserInput struct { // The authentication type for the user. You must specify USERPOOL. // // This member is required. AuthenticationType types.AuthenticationType // The email address of the user. Users' email addresses are case-sensitive. // // This member is required. UserName *string // contains filtered or unexported fields }
type DisableUserOutput ¶
type DisableUserOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DisassociateFleetInput ¶
type DisassociateFleetOutput ¶
type DisassociateFleetOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type EnableUserInput ¶
type EnableUserInput struct { // The authentication type for the user. You must specify USERPOOL. // // This member is required. AuthenticationType types.AuthenticationType // The email address of the user. Users' email addresses are case-sensitive. During // login, if they specify an email address that doesn't use the same capitalization // as the email address specified when their user pool account was created, a "user // does not exist" error message displays. // // This member is required. UserName *string // contains filtered or unexported fields }
type EnableUserOutput ¶
type EnableUserOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type EndpointResolver ¶
type EndpointResolver interface {
ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}
EndpointResolver interface for resolving service endpoints.
func EndpointResolverFromURL ¶ added in v1.1.0
func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver
EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.
type EndpointResolverFunc ¶
type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)
EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.
func (EndpointResolverFunc) ResolveEndpoint ¶
func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)
type EndpointResolverOptions ¶ added in v0.29.0
type EndpointResolverOptions = internalendpoints.Options
EndpointResolverOptions is the service endpoint resolver options
type ExpireSessionInput ¶
type ExpireSessionInput struct { // The identifier of the streaming session. // // This member is required. SessionId *string // contains filtered or unexported fields }
type ExpireSessionOutput ¶
type ExpireSessionOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type FleetStartedWaiter ¶ added in v0.31.0
type FleetStartedWaiter struct {
// contains filtered or unexported fields
}
FleetStartedWaiter defines the waiters for FleetStarted
func NewFleetStartedWaiter ¶ added in v0.31.0
func NewFleetStartedWaiter(client DescribeFleetsAPIClient, optFns ...func(*FleetStartedWaiterOptions)) *FleetStartedWaiter
NewFleetStartedWaiter constructs a FleetStartedWaiter.
func (*FleetStartedWaiter) Wait ¶ added in v0.31.0
func (w *FleetStartedWaiter) Wait(ctx context.Context, params *DescribeFleetsInput, maxWaitDur time.Duration, optFns ...func(*FleetStartedWaiterOptions)) error
Wait calls the waiter function for FleetStarted waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.
type FleetStartedWaiterOptions ¶ added in v0.31.0
type FleetStartedWaiterOptions struct { // Set of options to modify how an operation is invoked. These apply to all // operations invoked for this client. Use functional options on operation call to // modify this list for per operation behavior. APIOptions []func(*middleware.Stack) error // MinDelay is the minimum amount of time to delay between retries. If unset, // FleetStartedWaiter will use default minimum delay of 30 seconds. Note that // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration // MaxDelay is the maximum amount of time to delay between retries. If unset or set // to zero, FleetStartedWaiter will use default max delay of 120 seconds. Note that // MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts LogWaitAttempts bool // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is // used by the waiter to decide if a state is retryable or a terminal state. By // default service-modeled logic will populate this option. This option can thus be // used to define a custom waiter state with fall-back to service-modeled waiter // state mutators.The function returns an error in case of a failure state. In case // of retry state, this function returns a bool value of true and nil error, while // in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeFleetsInput, *DescribeFleetsOutput, error) (bool, error) }
FleetStartedWaiterOptions are waiter options for FleetStartedWaiter
type FleetStoppedWaiter ¶ added in v0.31.0
type FleetStoppedWaiter struct {
// contains filtered or unexported fields
}
FleetStoppedWaiter defines the waiters for FleetStopped
func NewFleetStoppedWaiter ¶ added in v0.31.0
func NewFleetStoppedWaiter(client DescribeFleetsAPIClient, optFns ...func(*FleetStoppedWaiterOptions)) *FleetStoppedWaiter
NewFleetStoppedWaiter constructs a FleetStoppedWaiter.
func (*FleetStoppedWaiter) Wait ¶ added in v0.31.0
func (w *FleetStoppedWaiter) Wait(ctx context.Context, params *DescribeFleetsInput, maxWaitDur time.Duration, optFns ...func(*FleetStoppedWaiterOptions)) error
Wait calls the waiter function for FleetStopped waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.
type FleetStoppedWaiterOptions ¶ added in v0.31.0
type FleetStoppedWaiterOptions struct { // Set of options to modify how an operation is invoked. These apply to all // operations invoked for this client. Use functional options on operation call to // modify this list for per operation behavior. APIOptions []func(*middleware.Stack) error // MinDelay is the minimum amount of time to delay between retries. If unset, // FleetStoppedWaiter will use default minimum delay of 30 seconds. Note that // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration // MaxDelay is the maximum amount of time to delay between retries. If unset or set // to zero, FleetStoppedWaiter will use default max delay of 120 seconds. Note that // MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts LogWaitAttempts bool // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is // used by the waiter to decide if a state is retryable or a terminal state. By // default service-modeled logic will populate this option. This option can thus be // used to define a custom waiter state with fall-back to service-modeled waiter // state mutators.The function returns an error in case of a failure state. In case // of retry state, this function returns a bool value of true and nil error, while // in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeFleetsInput, *DescribeFleetsOutput, error) (bool, error) }
FleetStoppedWaiterOptions are waiter options for FleetStoppedWaiter
type HTTPSignerV4 ¶
type ListAssociatedFleetsInput ¶
type ListAssociatedFleetsInput struct { // The name of the stack. // // This member is required. StackName *string // The pagination token to use to retrieve the next page of results for this // operation. If this value is null, it retrieves the first page. NextToken *string // contains filtered or unexported fields }
type ListAssociatedFleetsOutput ¶
type ListAssociatedFleetsOutput struct { // The name of the fleet. Names []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. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListAssociatedStacksInput ¶
type ListAssociatedStacksInput struct { // The name of the fleet. // // This member is required. FleetName *string // The pagination token to use to retrieve the next page of results for this // operation. If this value is null, it retrieves the first page. NextToken *string // contains filtered or unexported fields }
type ListAssociatedStacksOutput ¶
type ListAssociatedStacksOutput struct { // The name of the stack. Names []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. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListTagsForResourceInput ¶
type ListTagsForResourceInput struct { // The Amazon Resource Name (ARN) of the resource. // // This member is required. ResourceArn *string // contains filtered or unexported fields }
type ListTagsForResourceOutput ¶
type ListTagsForResourceOutput struct { // The information about the tags. Tags map[string]string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type Options ¶
type Options struct { // Set of options to modify how an operation is invoked. These apply to all // operations invoked for this client. Use functional options on operation call to // modify this list for per operation behavior. APIOptions []func(*middleware.Stack) error // Configures the events that will be sent to the configured logger. ClientLogMode aws.ClientLogMode // The credentials object to use when signing requests. Credentials aws.CredentialsProvider // The endpoint options to be used when attempting to resolve an endpoint. EndpointOptions EndpointResolverOptions // The service endpoint resolver. EndpointResolver EndpointResolver // Signature Version 4 (SigV4) Signer HTTPSignerV4 HTTPSignerV4 // The logger writer interface to write logging messages to. Logger logging.Logger // The region to send requests to. (Required) Region string // Retryer guides how HTTP requests should be retried in case of recoverable // failures. When nil the API client will use a default retryer. Retryer aws.Retryer // The HTTP client to invoke API calls with. Defaults to client's default HTTP // implementation if nil. HTTPClient HTTPClient }
type ResolveEndpoint ¶
type ResolveEndpoint struct { Resolver EndpointResolver Options EndpointResolverOptions }
func (*ResolveEndpoint) HandleSerialize ¶
func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) ( out middleware.SerializeOutput, metadata middleware.Metadata, err error, )
func (*ResolveEndpoint) ID ¶
func (*ResolveEndpoint) ID() string
type StartFleetInput ¶
type StartFleetInput struct { // The name of the fleet. // // This member is required. Name *string // contains filtered or unexported fields }
type StartFleetOutput ¶
type StartFleetOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type StartImageBuilderInput ¶
type StartImageBuilderInput struct { // The name of the image builder. // // This member is required. Name *string // 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]. AppstreamAgentVersion *string // contains filtered or unexported fields }
type StartImageBuilderOutput ¶
type StartImageBuilderOutput struct { // Information about the image builder. ImageBuilder *types.ImageBuilder // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type StopFleetInput ¶
type StopFleetInput struct { // The name of the fleet. // // This member is required. Name *string // contains filtered or unexported fields }
type StopFleetOutput ¶
type StopFleetOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type StopImageBuilderInput ¶
type StopImageBuilderInput struct { // The name of the image builder. // // This member is required. Name *string // contains filtered or unexported fields }
type StopImageBuilderOutput ¶
type StopImageBuilderOutput struct { // Information about the image builder. ImageBuilder *types.ImageBuilder // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type TagResourceInput ¶
type TagResourceInput struct { // The Amazon Resource Name (ARN) of the resource. // // This member is required. ResourceArn *string // The tags to associate. A tag is a key-value pair, and the value is optional. For // example, Environment=Test. If you do not specify a value, Environment=. If you // do not specify a value, the value is set to an empty string. Generally allowed // characters are: letters, numbers, and spaces representable in UTF-8, and the // following special characters: _ . : / = + \ - @ // // This member is required. Tags map[string]string // contains filtered or unexported fields }
type TagResourceOutput ¶
type TagResourceOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UntagResourceInput ¶
type UntagResourceOutput ¶
type UntagResourceOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UpdateDirectoryConfigInput ¶
type UpdateDirectoryConfigInput struct { // The name of the Directory Config object. // // This member is required. DirectoryName *string // The distinguished names of the organizational units for computer accounts. OrganizationalUnitDistinguishedNames []string // The credentials for the service account used by the fleet or image builder to // connect to the directory. ServiceAccountCredentials *types.ServiceAccountCredentials // contains filtered or unexported fields }
type UpdateDirectoryConfigOutput ¶
type UpdateDirectoryConfigOutput struct { // Information about the Directory Config object. DirectoryConfig *types.DirectoryConfig // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UpdateFleetInput ¶
type UpdateFleetInput struct { // The fleet attributes to delete. AttributesToDelete []types.FleetAttribute // The desired capacity for the fleet. ComputeCapacity *types.ComputeCapacity // Deletes the VPC association for the specified fleet. // // Deprecated: This member has been deprecated. DeleteVpcConfig bool // The description to display. Description *string // The amount of time that a streaming session remains active after users // disconnect. If users 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 fleet name to display. DisplayName *string // The name of the directory and organizational unit (OU) to use to join the fleet // to a Microsoft Active Directory domain. DomainJoinInfo *types.DomainJoinInfo // Enables or disables default internet access for the fleet. EnableDefaultInternetAccess *bool // The Amazon Resource Name (ARN) of the IAM role to apply to the fleet. To assume // a role, a 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. For more information, see Using an IAM Role to Grant Permissions to // Applications and Scripts Running on AppStream 2.0 Streaming Instances // (https://docs.aws.amazon.com/appstream2/latest/developerguide/using-iam-roles-to-grant-permissions-to-applications-scripts-streaming-instances.html) // in the Amazon AppStream 2.0 Administration Guide. IamRoleArn *string // 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. 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. IdleDisconnectTimeoutInSeconds *int32 // The ARN of the public, private, or shared image to use. ImageArn *string // The name of the image used to create the fleet. ImageName *string // The instance type to use when launching fleet instances. The following instance // types are available: // // * stream.standard.small // // * 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.memory.z1d.large // // * // stream.memory.z1d.xlarge // // * stream.memory.z1d.2xlarge // // * // stream.memory.z1d.3xlarge // // * stream.memory.z1d.6xlarge // // * // stream.memory.z1d.12xlarge // // * stream.graphics-design.large // // * // stream.graphics-design.xlarge // // * stream.graphics-design.2xlarge // // * // stream.graphics-design.4xlarge // // * stream.graphics-desktop.2xlarge // // * // stream.graphics.g4dn.xlarge // // * stream.graphics.g4dn.2xlarge // // * // stream.graphics.g4dn.4xlarge // // * stream.graphics.g4dn.8xlarge // // * // stream.graphics.g4dn.12xlarge // // * stream.graphics.g4dn.16xlarge // // * // stream.graphics-pro.4xlarge // // * stream.graphics-pro.8xlarge // // * // stream.graphics-pro.16xlarge InstanceType *string // 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 // A unique name for the fleet. Name *string // The AppStream 2.0 view that is displayed to your users when they stream from the // fleet. When APP is specified, only the windows of applications opened by users // display. When DESKTOP is specified, the standard desktop that is provided by the // operating system displays. The default value is APP. StreamView types.StreamView // The VPC configuration for the fleet. VpcConfig *types.VpcConfig // contains filtered or unexported fields }
type UpdateFleetOutput ¶
type UpdateFleetOutput struct { // Information about the fleet. Fleet *types.Fleet // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UpdateImagePermissionsInput ¶
type UpdateImagePermissionsInput struct { // The permissions for the image. // // This member is required. ImagePermissions *types.ImagePermissions // The name of the private image. // // This member is required. Name *string // image permissions. // // This member is required. SharedAccountId *string // contains filtered or unexported fields }
type UpdateImagePermissionsOutput ¶
type UpdateImagePermissionsOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UpdateStackInput ¶
type UpdateStackInput struct { // The name of the stack. // // This member is required. Name *string // The list of interface VPC endpoint (interface endpoint) objects. Users of the // stack can connect to AppStream 2.0 only through the specified endpoints. AccessEndpoints []types.AccessEndpoint // The persistent application settings for users of a stack. When these settings // are enabled, changes that users make to applications and Windows settings are // automatically saved after each session and applied to the next session. ApplicationSettings *types.ApplicationSettings // The stack attributes to delete. AttributesToDelete []types.StackAttribute // Deletes the storage connectors currently enabled for the stack. // // Deprecated: This member has been deprecated. DeleteStorageConnectors bool // The description to display. Description *string // The stack name to display. DisplayName *string // 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 they choose the Send Feedback link. // If no URL is specified, no Send Feedback link is displayed. FeedbackURL *string // The URL that users are redirected to after their streaming session ends. RedirectURL *string // The storage connectors to enable. StorageConnectors []types.StorageConnector // The actions that are enabled or disabled for users during their streaming // sessions. By default, these actions are enabled. UserSettings []types.UserSetting // contains filtered or unexported fields }
type UpdateStackOutput ¶
type UpdateStackOutput struct { // Information about the stack. Stack *types.Stack // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
Source Files ¶
- api_client.go
- api_op_AssociateFleet.go
- api_op_BatchAssociateUserStack.go
- api_op_BatchDisassociateUserStack.go
- api_op_CopyImage.go
- api_op_CreateDirectoryConfig.go
- api_op_CreateFleet.go
- api_op_CreateImageBuilder.go
- api_op_CreateImageBuilderStreamingURL.go
- api_op_CreateStack.go
- api_op_CreateStreamingURL.go
- api_op_CreateUpdatedImage.go
- api_op_CreateUsageReportSubscription.go
- api_op_CreateUser.go
- api_op_DeleteDirectoryConfig.go
- api_op_DeleteFleet.go
- api_op_DeleteImage.go
- api_op_DeleteImageBuilder.go
- api_op_DeleteImagePermissions.go
- api_op_DeleteStack.go
- api_op_DeleteUsageReportSubscription.go
- api_op_DeleteUser.go
- api_op_DescribeDirectoryConfigs.go
- api_op_DescribeFleets.go
- api_op_DescribeImageBuilders.go
- api_op_DescribeImagePermissions.go
- api_op_DescribeImages.go
- api_op_DescribeSessions.go
- api_op_DescribeStacks.go
- api_op_DescribeUsageReportSubscriptions.go
- api_op_DescribeUserStackAssociations.go
- api_op_DescribeUsers.go
- api_op_DisableUser.go
- api_op_DisassociateFleet.go
- api_op_EnableUser.go
- api_op_ExpireSession.go
- api_op_ListAssociatedFleets.go
- api_op_ListAssociatedStacks.go
- api_op_ListTagsForResource.go
- api_op_StartFleet.go
- api_op_StartImageBuilder.go
- api_op_StopFleet.go
- api_op_StopImageBuilder.go
- api_op_TagResource.go
- api_op_UntagResource.go
- api_op_UpdateDirectoryConfig.go
- api_op_UpdateFleet.go
- api_op_UpdateImagePermissions.go
- api_op_UpdateStack.go
- deserializers.go
- doc.go
- endpoints.go
- go_module_metadata.go
- serializers.go
- validators.go