appstream

package
v1.10.11 Latest Latest
Warning

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

 Go to latest Published: Jul 14, 2017 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Overview

Package appstream provides the client and types for making API requests to Amazon AppStream.

API documentation for Amazon AppStream 2.0.

See https://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01 for more information on this service.

See appstream package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/appstream/

Using the Client

To use the client for Amazon AppStream you will first need to create a new instance of it.

When creating a client for an AWS service you'll first need to have a Session already created. The Session provides configuration that can be shared between multiple service clients. Additional configuration can be applied to the Session and service's client when they are constructed. The aws package's Config type contains several fields such as Region for the AWS Region the client should make API requests too. The optional Config value can be provided as the variadic argument for Sessions and client creation.

Once the service's client is created you can use it to make API requests the AWS service. These clients are safe to use concurrently. 

// Create a session to share configuration, and load external configuration.
sess := session.Must(session.NewSession())

// Create the service's client with the session.
svc := appstream.New(sess)

See the SDK's documentation for more information on how to use service clients. https://docs.aws.amazon.com/sdk-for-go/api/

See aws package's Config type for more information on configuration options. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the Amazon AppStream client AppStream for more information on creating the service's client. https://docs.aws.amazon.com/sdk-for-go/api/service/appstream/#New

Once the client is created you can make an API request to the service. Each API method takes a input parameter, and returns the service response and an error.

The API method will document which error codes the service can be returned by the operation if the service models the API operation's errors. These errors will also be available as const strings prefixed with "ErrCode". 

result, err := svc.AssociateFleet(params)
if err != nil {
    // Cast err to awserr.Error to handle specific error codes.
    aerr, ok := err.(awserr.Error)
    if ok && aerr.Code() == <error code to check for> {
        // Specific error code handling
    }
    return err
}

fmt.Println("AssociateFleet result:")
fmt.Println(result)

Using the Client with Context

The service's client also provides methods to make API requests with a Context value. This allows you to control the timeout, and cancellation of pending requests. These methods also take request Option as variadic parameter to apply additional configuration to the API request. 

ctx := context.Background()

result, err := svc.AssociateFleetWithContext(ctx, params)

See the request package documentation for more information on using Context pattern with the SDK. https://docs.aws.amazon.com/sdk-for-go/api/aws/request/

Index

Constants

View Source 
const (
	// AuthenticationTypeApi is a AuthenticationType enum value
	AuthenticationTypeApi = "API"

	// AuthenticationTypeSaml is a AuthenticationType enum value
	AuthenticationTypeSaml = "SAML"

	// AuthenticationTypeUserpool is a AuthenticationType enum value
	AuthenticationTypeUserpool = "USERPOOL"
)
View Source 
const (
	// FleetAttributeVpcConfiguration is a FleetAttribute enum value
	FleetAttributeVpcConfiguration = "VPC_CONFIGURATION"

	// FleetAttributeVpcConfigurationSecurityGroupIds is a FleetAttribute enum value
	FleetAttributeVpcConfigurationSecurityGroupIds = "VPC_CONFIGURATION_SECURITY_GROUP_IDS"
)

Fleet attribute.

View Source 
const (
	// FleetErrorCodeIamServiceRoleMissingEniDescribeAction is a FleetErrorCode enum value
	FleetErrorCodeIamServiceRoleMissingEniDescribeAction = "IAM_SERVICE_ROLE_MISSING_ENI_DESCRIBE_ACTION"

	// FleetErrorCodeIamServiceRoleMissingEniCreateAction is a FleetErrorCode enum value
	FleetErrorCodeIamServiceRoleMissingEniCreateAction = "IAM_SERVICE_ROLE_MISSING_ENI_CREATE_ACTION"

	// FleetErrorCodeIamServiceRoleMissingEniDeleteAction is a FleetErrorCode enum value
	FleetErrorCodeIamServiceRoleMissingEniDeleteAction = "IAM_SERVICE_ROLE_MISSING_ENI_DELETE_ACTION"

	// FleetErrorCodeNetworkInterfaceLimitExceeded is a FleetErrorCode enum value
	FleetErrorCodeNetworkInterfaceLimitExceeded = "NETWORK_INTERFACE_LIMIT_EXCEEDED"

	// FleetErrorCodeInternalServiceError is a FleetErrorCode enum value
	FleetErrorCodeInternalServiceError = "INTERNAL_SERVICE_ERROR"

	// FleetErrorCodeIamServiceRoleIsMissing is a FleetErrorCode enum value
	FleetErrorCodeIamServiceRoleIsMissing = "IAM_SERVICE_ROLE_IS_MISSING"

	// FleetErrorCodeSubnetHasInsufficientIpAddresses is a FleetErrorCode enum value
	FleetErrorCodeSubnetHasInsufficientIpAddresses = "SUBNET_HAS_INSUFFICIENT_IP_ADDRESSES"

	// FleetErrorCodeIamServiceRoleMissingDescribeSubnetAction is a FleetErrorCode enum value
	FleetErrorCodeIamServiceRoleMissingDescribeSubnetAction = "IAM_SERVICE_ROLE_MISSING_DESCRIBE_SUBNET_ACTION"

	// FleetErrorCodeSubnetNotFound is a FleetErrorCode enum value
	FleetErrorCodeSubnetNotFound = "SUBNET_NOT_FOUND"

	// FleetErrorCodeImageNotFound is a FleetErrorCode enum value
	FleetErrorCodeImageNotFound = "IMAGE_NOT_FOUND"

	// FleetErrorCodeInvalidSubnetConfiguration is a FleetErrorCode enum value
	FleetErrorCodeInvalidSubnetConfiguration = "INVALID_SUBNET_CONFIGURATION"
)
View Source 
const (
	// FleetStateStarting is a FleetState enum value
	FleetStateStarting = "STARTING"

	// FleetStateRunning is a FleetState enum value
	FleetStateRunning = "RUNNING"

	// FleetStateStopping is a FleetState enum value
	FleetStateStopping = "STOPPING"

	// FleetStateStopped is a FleetState enum value
	FleetStateStopped = "STOPPED"
)
View Source 
const (
	// ImageStatePending is a ImageState enum value
	ImageStatePending = "PENDING"

	// ImageStateAvailable is a ImageState enum value
	ImageStateAvailable = "AVAILABLE"

	// ImageStateFailed is a ImageState enum value
	ImageStateFailed = "FAILED"

	// ImageStateDeleting is a ImageState enum value
	ImageStateDeleting = "DELETING"
)
View Source 
const (
	// ImageStateChangeReasonCodeInternalError is a ImageStateChangeReasonCode enum value
	ImageStateChangeReasonCodeInternalError = "INTERNAL_ERROR"

	// ImageStateChangeReasonCodeImageBuilderNotAvailable is a ImageStateChangeReasonCode enum value
	ImageStateChangeReasonCodeImageBuilderNotAvailable = "IMAGE_BUILDER_NOT_AVAILABLE"
)
View Source 
const (
	// SessionStateActive is a SessionState enum value
	SessionStateActive = "ACTIVE"

	// SessionStatePending is a SessionState enum value
	SessionStatePending = "PENDING"

	// SessionStateExpired is a SessionState enum value
	SessionStateExpired = "EXPIRED"
)

Possible values for the state of a streaming session.

View Source 
const (
	// StackErrorCodeStorageConnectorError is a StackErrorCode enum value
	StackErrorCodeStorageConnectorError = "STORAGE_CONNECTOR_ERROR"

	// StackErrorCodeInternalServiceError is a StackErrorCode enum value
	StackErrorCodeInternalServiceError = "INTERNAL_SERVICE_ERROR"
)
View Source 
const (
	// VisibilityTypePublic is a VisibilityType enum value
	VisibilityTypePublic = "PUBLIC"

	// VisibilityTypePrivate is a VisibilityType enum value
	VisibilityTypePrivate = "PRIVATE"
)
View Source 
const (

	// ErrCodeConcurrentModificationException for service response error code
	// "ConcurrentModificationException".
	//
	// An API error occurred. Wait a few minutes and try again.
	ErrCodeConcurrentModificationException = "ConcurrentModificationException"

	// ErrCodeIncompatibleImageException for service response error code
	// "IncompatibleImageException".
	//
	// The image does not support storage connectors.
	ErrCodeIncompatibleImageException = "IncompatibleImageException"

	// ErrCodeInvalidParameterCombinationException for service response error code
	// "InvalidParameterCombinationException".
	//
	// Indicates an incorrect combination of parameters, or a missing parameter.
	ErrCodeInvalidParameterCombinationException = "InvalidParameterCombinationException"

	// ErrCodeInvalidRoleException for service response error code
	// "InvalidRoleException".
	//
	// The specified role is invalid.
	ErrCodeInvalidRoleException = "InvalidRoleException"

	// ErrCodeLimitExceededException for service response error code
	// "LimitExceededException".
	//
	// The requested limit exceeds the permitted limit for an account.
	ErrCodeLimitExceededException = "LimitExceededException"

	// ErrCodeOperationNotPermittedException for service response error code
	// "OperationNotPermittedException".
	//
	// The attempted operation is not permitted.
	ErrCodeOperationNotPermittedException = "OperationNotPermittedException"

	// ErrCodeResourceAlreadyExistsException for service response error code
	// "ResourceAlreadyExistsException".
	//
	// The specified resource already exists.
	ErrCodeResourceAlreadyExistsException = "ResourceAlreadyExistsException"

	// ErrCodeResourceInUseException for service response error code
	// "ResourceInUseException".
	//
	// The specified resource is in use.
	ErrCodeResourceInUseException = "ResourceInUseException"

	// ErrCodeResourceNotAvailableException for service response error code
	// "ResourceNotAvailableException".
	//
	// The specified resource exists and is not in use, but isn't available.
	ErrCodeResourceNotAvailableException = "ResourceNotAvailableException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// The specified resource was not found.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"
)
View Source 
const (
	ServiceName = "appstream2" // Service endpoint prefix API calls made to.
	EndpointsID = ServiceName  // Service ID for Regions and Endpoints metadata.
)

Service information constants

View Source 
const (
	// PlatformTypeWindows is a PlatformType enum value
	PlatformTypeWindows = "WINDOWS"
)
View Source 
const (
	// StorageConnectorTypeHomefolders is a StorageConnectorType enum value
	StorageConnectorTypeHomefolders = "HOMEFOLDERS"
)

The type of storage connector. The possible values include: HOMEFOLDERS.

Variables

This section is empty.

Functions

This section is empty.

Types

type AppStream 

type AppStream struct {
	*client.Client
}

AppStream provides the API operation methods for making requests to Amazon AppStream. See this package's package overview docs for details on the service.

AppStream methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New 

func New(p client.ConfigProvider, cfgs ...*aws.Config) *AppStream

New creates a new instance of the AppStream client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example: 

// Create a AppStream client from just a session.
svc := appstream.New(mySession)

// Create a AppStream client with additional configuration
svc := appstream.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*AppStream) AssociateFleet 

func (c *AppStream) AssociateFleet(input *AssociateFleetInput) (*AssociateFleetOutput, error)

AssociateFleet API operation for Amazon AppStream.

Associate a fleet to a stack.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon AppStream's API operation AssociateFleet for usage and error information.

Returned Error Codes:

  • ErrCodeLimitExceededException "LimitExceededException" The requested limit exceeds the permitted limit for an account.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource was not found.

  • ErrCodeConcurrentModificationException "ConcurrentModificationException" An API error occurred. Wait a few minutes and try again.

  • ErrCodeIncompatibleImageException "IncompatibleImageException" The image does not support storage connectors.

Please also see https://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/AssociateFleet

func (*AppStream) AssociateFleetRequest 

func (c *AppStream) AssociateFleetRequest(input *AssociateFleetInput) (req *request.Request, output *AssociateFleetOutput)

AssociateFleetRequest generates a "aws/request.Request" representing the client's request for the AssociateFleet operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See AssociateFleet for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the AssociateFleet method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// Example sending a request using the AssociateFleetRequest method.
req, resp := client.AssociateFleetRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/AssociateFleet

func (*AppStream) AssociateFleetWithContext added in v1.8.0 

func (c *AppStream) AssociateFleetWithContext(ctx aws.Context, input *AssociateFleetInput, opts ...request.Option) (*AssociateFleetOutput, error)

AssociateFleetWithContext is the same as AssociateFleet with the addition of the ability to pass a context and additional request options.

See AssociateFleet for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*AppStream) CreateFleet 

func (c *AppStream) CreateFleet(input *CreateFleetInput) (*CreateFleetOutput, error)

CreateFleet API operation for Amazon AppStream.

Creates a new fleet.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon AppStream's API operation CreateFleet for usage and error information.

Returned Error Codes:

  • ErrCodeResourceAlreadyExistsException "ResourceAlreadyExistsException" The specified resource already exists.

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

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource was not found.

  • ErrCodeLimitExceededException "LimitExceededException" The requested limit exceeds the permitted limit for an account.

  • ErrCodeInvalidRoleException "InvalidRoleException" The specified role is invalid.

  • ErrCodeConcurrentModificationException "ConcurrentModificationException" An API error occurred. Wait a few minutes and try again.

Please also see https://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/CreateFleet

func (*AppStream) CreateFleetRequest 

func (c *AppStream) CreateFleetRequest(input *CreateFleetInput) (req *request.Request, output *CreateFleetOutput)

CreateFleetRequest generates a "aws/request.Request" representing the client's request for the CreateFleet operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See CreateFleet for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreateFleet method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// Example sending a request using the CreateFleetRequest method.
req, resp := client.CreateFleetRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/CreateFleet

func (*AppStream) CreateFleetWithContext added in v1.8.0 

func (c *AppStream) CreateFleetWithContext(ctx aws.Context, input *CreateFleetInput, opts ...request.Option) (*CreateFleetOutput, error)

CreateFleetWithContext is the same as CreateFleet with the addition of the ability to pass a context and additional request options.

See CreateFleet for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*AppStream) CreateStack 

func (c *AppStream) CreateStack(input *CreateStackInput) (*CreateStackOutput, error)

CreateStack API operation for Amazon AppStream.

Create a new stack.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon AppStream's API operation CreateStack for usage and error information.

Returned Error Codes:

  • ErrCodeLimitExceededException "LimitExceededException" The requested limit exceeds the permitted limit for an account.

  • ErrCodeResourceAlreadyExistsException "ResourceAlreadyExistsException" The specified resource already exists.

  • ErrCodeConcurrentModificationException "ConcurrentModificationException" An API error occurred. Wait a few minutes and try again.

  • ErrCodeInvalidRoleException "InvalidRoleException" The specified role is invalid.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource was not found.

  • ErrCodeInvalidParameterCombinationException "InvalidParameterCombinationException" Indicates an incorrect combination of parameters, or a missing parameter.

Please also see https://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/CreateStack

func (*AppStream) CreateStackRequest 

func (c *AppStream) CreateStackRequest(input *CreateStackInput) (req *request.Request, output *CreateStackOutput)

CreateStackRequest generates a "aws/request.Request" representing the client's request for the CreateStack operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See CreateStack for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreateStack method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// Example sending a request using the CreateStackRequest method.
req, resp := client.CreateStackRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/CreateStack

func (*AppStream) CreateStackWithContext added in v1.8.0 

func (c *AppStream) CreateStackWithContext(ctx aws.Context, input *CreateStackInput, opts ...request.Option) (*CreateStackOutput, error)

CreateStackWithContext is the same as CreateStack with the addition of the ability to pass a context and additional request options.

See CreateStack for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*AppStream) CreateStreamingURL 

func (c *AppStream) CreateStreamingURL(input *CreateStreamingURLInput) (*CreateStreamingURLOutput, error)

CreateStreamingURL API operation for Amazon AppStream.

Creates a URL to start an AppStream 2.0 streaming session for a user. By default, the URL is valid only for 1 minute from the time that it is generated.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon AppStream's API operation CreateStreamingURL for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource was not found.

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

  • ErrCodeOperationNotPermittedException "OperationNotPermittedException" The attempted operation is not permitted.

  • ErrCodeInvalidParameterCombinationException "InvalidParameterCombinationException" Indicates an incorrect combination of parameters, or a missing parameter.

Please also see https://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/CreateStreamingURL

func (*AppStream) CreateStreamingURLRequest 

func (c *AppStream) CreateStreamingURLRequest(input *CreateStreamingURLInput) (req *request.Request, output *CreateStreamingURLOutput)

CreateStreamingURLRequest generates a "aws/request.Request" representing the client's request for the CreateStreamingURL operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See CreateStreamingURL for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreateStreamingURL method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// Example sending a request using the CreateStreamingURLRequest method.
req, resp := client.CreateStreamingURLRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/CreateStreamingURL

func (*AppStream) CreateStreamingURLWithContext added in v1.8.0 

func (c *AppStream) CreateStreamingURLWithContext(ctx aws.Context, input *CreateStreamingURLInput, opts ...request.Option) (*CreateStreamingURLOutput, error)

CreateStreamingURLWithContext is the same as CreateStreamingURL with the addition of the ability to pass a context and additional request options.

See CreateStreamingURL for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*AppStream) DeleteFleet 

func (c *AppStream) DeleteFleet(input *DeleteFleetInput) (*DeleteFleetOutput, error)

DeleteFleet API operation for Amazon AppStream.

Deletes a fleet.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon AppStream's API operation DeleteFleet for usage and error information.

Returned Error Codes:

  • ErrCodeResourceInUseException "ResourceInUseException" The specified resource is in use.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource was not found.

  • ErrCodeConcurrentModificationException "ConcurrentModificationException" An API error occurred. Wait a few minutes and try again.

Please also see https://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/DeleteFleet

func (*AppStream) DeleteFleetRequest 

func (c *AppStream) DeleteFleetRequest(input *DeleteFleetInput) (req *request.Request, output *DeleteFleetOutput)

DeleteFleetRequest generates a "aws/request.Request" representing the client's request for the DeleteFleet operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See DeleteFleet for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteFleet method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// Example sending a request using the DeleteFleetRequest method.
req, resp := client.DeleteFleetRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/DeleteFleet

func (*AppStream) DeleteFleetWithContext added in v1.8.0 

func (c *AppStream) DeleteFleetWithContext(ctx aws.Context, input *DeleteFleetInput, opts ...request.Option) (*DeleteFleetOutput, error)

DeleteFleetWithContext is the same as DeleteFleet with the addition of the ability to pass a context and additional request options.

See DeleteFleet for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*AppStream) DeleteStack 

func (c *AppStream) DeleteStack(input *DeleteStackInput) (*DeleteStackOutput, error)

DeleteStack API operation for Amazon AppStream.

Deletes the stack. After this operation completes, the environment can no longer be activated, and any reservations made for the stack are released.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon AppStream's API operation DeleteStack for usage and error information.

Returned Error Codes:

  • ErrCodeResourceInUseException "ResourceInUseException" The specified resource is in use.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource was not found.

  • ErrCodeConcurrentModificationException "ConcurrentModificationException" An API error occurred. Wait a few minutes and try again.

Please also see https://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/DeleteStack

func (*AppStream) DeleteStackRequest 

func (c *AppStream) DeleteStackRequest(input *DeleteStackInput) (req *request.Request, output *DeleteStackOutput)

DeleteStackRequest generates a "aws/request.Request" representing the client's request for the DeleteStack operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See DeleteStack for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteStack method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// Example sending a request using the DeleteStackRequest method.
req, resp := client.DeleteStackRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/DeleteStack

func (*AppStream) DeleteStackWithContext added in v1.8.0 

func (c *AppStream) DeleteStackWithContext(ctx aws.Context, input *DeleteStackInput, opts ...request.Option) (*DeleteStackOutput, error)

DeleteStackWithContext is the same as DeleteStack with the addition of the ability to pass a context and additional request options.

See DeleteStack for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*AppStream) DescribeFleets 

func (c *AppStream) DescribeFleets(input *DescribeFleetsInput) (*DescribeFleetsOutput, error)

DescribeFleets API operation for Amazon AppStream.

If fleet names are provided, this operation describes the specified fleets; otherwise, all the fleets in the account are described.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon AppStream's API operation DescribeFleets for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource was not found.

Please also see https://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/DescribeFleets

func (*AppStream) DescribeFleetsRequest 

func (c *AppStream) DescribeFleetsRequest(input *DescribeFleetsInput) (req *request.Request, output *DescribeFleetsOutput)

DescribeFleetsRequest generates a "aws/request.Request" representing the client's request for the DescribeFleets operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See DescribeFleets for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DescribeFleets method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// Example sending a request using the DescribeFleetsRequest method.
req, resp := client.DescribeFleetsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/DescribeFleets

func (*AppStream) DescribeFleetsWithContext added in v1.8.0 

func (c *AppStream) DescribeFleetsWithContext(ctx aws.Context, input *DescribeFleetsInput, opts ...request.Option) (*DescribeFleetsOutput, error)

DescribeFleetsWithContext is the same as DescribeFleets with the addition of the ability to pass a context and additional request options.

See DescribeFleets for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*AppStream) DescribeImages 

func (c *AppStream) DescribeImages(input *DescribeImagesInput) (*DescribeImagesOutput, error)

DescribeImages API operation for Amazon AppStream.

Describes the images. If a list of names is not provided, all images in your account are returned. This operation does not return a paginated result.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon AppStream's API operation DescribeImages for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource was not found.

Please also see https://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/DescribeImages

func (*AppStream) DescribeImagesRequest 

func (c *AppStream) DescribeImagesRequest(input *DescribeImagesInput) (req *request.Request, output *DescribeImagesOutput)

DescribeImagesRequest generates a "aws/request.Request" representing the client's request for the DescribeImages operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See DescribeImages for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DescribeImages method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// Example sending a request using the DescribeImagesRequest method.
req, resp := client.DescribeImagesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/DescribeImages

func (*AppStream) DescribeImagesWithContext added in v1.8.0 

func (c *AppStream) DescribeImagesWithContext(ctx aws.Context, input *DescribeImagesInput, opts ...request.Option) (*DescribeImagesOutput, error)

DescribeImagesWithContext is the same as DescribeImages with the addition of the ability to pass a context and additional request options.

See DescribeImages for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*AppStream) DescribeSessions 

func (c *AppStream) DescribeSessions(input *DescribeSessionsInput) (*DescribeSessionsOutput, error)

DescribeSessions API operation for Amazon AppStream.

Describes the streaming sessions for a stack and a fleet. If a user ID is provided, this operation returns streaming sessions for only that user. Pass this value for the nextToken parameter in a subsequent call to this operation to retrieve the next set of items. If an authentication type is not provided, the operation defaults to users authenticated using a streaming URL.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon AppStream's API operation DescribeSessions for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterCombinationException "InvalidParameterCombinationException" Indicates an incorrect combination of parameters, or a missing parameter.

Please also see https://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/DescribeSessions

func (*AppStream) DescribeSessionsRequest 

func (c *AppStream) DescribeSessionsRequest(input *DescribeSessionsInput) (req *request.Request, output *DescribeSessionsOutput)

DescribeSessionsRequest generates a "aws/request.Request" representing the client's request for the DescribeSessions operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See DescribeSessions for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DescribeSessions method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// Example sending a request using the DescribeSessionsRequest method.
req, resp := client.DescribeSessionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/DescribeSessions

func (*AppStream) DescribeSessionsWithContext added in v1.8.0 

func (c *AppStream) DescribeSessionsWithContext(ctx aws.Context, input *DescribeSessionsInput, opts ...request.Option) (*DescribeSessionsOutput, error)

DescribeSessionsWithContext is the same as DescribeSessions with the addition of the ability to pass a context and additional request options.

See DescribeSessions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*AppStream) DescribeStacks 

func (c *AppStream) DescribeStacks(input *DescribeStacksInput) (*DescribeStacksOutput, error)

DescribeStacks API operation for Amazon AppStream.

If stack names are not provided, this operation describes the specified stacks; otherwise, all stacks in the account are described. Pass the nextToken value in a subsequent call to this operation to retrieve the next set of items.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon AppStream's API operation DescribeStacks for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource was not found.

Please also see https://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/DescribeStacks

func (*AppStream) DescribeStacksRequest 

func (c *AppStream) DescribeStacksRequest(input *DescribeStacksInput) (req *request.Request, output *DescribeStacksOutput)

DescribeStacksRequest generates a "aws/request.Request" representing the client's request for the DescribeStacks operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See DescribeStacks for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DescribeStacks method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// Example sending a request using the DescribeStacksRequest method.
req, resp := client.DescribeStacksRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/DescribeStacks

func (*AppStream) DescribeStacksWithContext added in v1.8.0 

func (c *AppStream) DescribeStacksWithContext(ctx aws.Context, input *DescribeStacksInput, opts ...request.Option) (*DescribeStacksOutput, error)

DescribeStacksWithContext is the same as DescribeStacks with the addition of the ability to pass a context and additional request options.

See DescribeStacks for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*AppStream) DisassociateFleet 

func (c *AppStream) DisassociateFleet(input *DisassociateFleetInput) (*DisassociateFleetOutput, error)

DisassociateFleet API operation for Amazon AppStream.

Disassociates a fleet from a stack.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon AppStream's API operation DisassociateFleet for usage and error information.

Returned Error Codes:

  • ErrCodeResourceInUseException "ResourceInUseException" The specified resource is in use.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource was not found.

  • ErrCodeConcurrentModificationException "ConcurrentModificationException" An API error occurred. Wait a few minutes and try again.

Please also see https://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/DisassociateFleet

func (*AppStream) DisassociateFleetRequest 

func (c *AppStream) DisassociateFleetRequest(input *DisassociateFleetInput) (req *request.Request, output *DisassociateFleetOutput)

DisassociateFleetRequest generates a "aws/request.Request" representing the client's request for the DisassociateFleet operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See DisassociateFleet for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DisassociateFleet method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// Example sending a request using the DisassociateFleetRequest method.
req, resp := client.DisassociateFleetRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/DisassociateFleet

func (*AppStream) DisassociateFleetWithContext added in v1.8.0 

func (c *AppStream) DisassociateFleetWithContext(ctx aws.Context, input *DisassociateFleetInput, opts ...request.Option) (*DisassociateFleetOutput, error)

DisassociateFleetWithContext is the same as DisassociateFleet with the addition of the ability to pass a context and additional request options.

See DisassociateFleet for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*AppStream) ExpireSession 

func (c *AppStream) ExpireSession(input *ExpireSessionInput) (*ExpireSessionOutput, error)

ExpireSession API operation for Amazon AppStream.

This operation immediately stops a streaming session.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon AppStream's API operation ExpireSession for usage and error information. Please also see https://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/ExpireSession

func (*AppStream) ExpireSessionRequest 

func (c *AppStream) ExpireSessionRequest(input *ExpireSessionInput) (req *request.Request, output *ExpireSessionOutput)

ExpireSessionRequest generates a "aws/request.Request" representing the client's request for the ExpireSession operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See ExpireSession for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ExpireSession method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// Example sending a request using the ExpireSessionRequest method.
req, resp := client.ExpireSessionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/ExpireSession

func (*AppStream) ExpireSessionWithContext added in v1.8.0 

func (c *AppStream) ExpireSessionWithContext(ctx aws.Context, input *ExpireSessionInput, opts ...request.Option) (*ExpireSessionOutput, error)

ExpireSessionWithContext is the same as ExpireSession with the addition of the ability to pass a context and additional request options.

See ExpireSession for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*AppStream) ListAssociatedFleets 

func (c *AppStream) ListAssociatedFleets(input *ListAssociatedFleetsInput) (*ListAssociatedFleetsOutput, error)

ListAssociatedFleets API operation for Amazon AppStream.

Lists all fleets associated with the stack.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon AppStream's API operation ListAssociatedFleets for usage and error information. Please also see https://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/ListAssociatedFleets

func (*AppStream) ListAssociatedFleetsRequest 

func (c *AppStream) ListAssociatedFleetsRequest(input *ListAssociatedFleetsInput) (req *request.Request, output *ListAssociatedFleetsOutput)

ListAssociatedFleetsRequest generates a "aws/request.Request" representing the client's request for the ListAssociatedFleets operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See ListAssociatedFleets for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ListAssociatedFleets method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// Example sending a request using the ListAssociatedFleetsRequest method.
req, resp := client.ListAssociatedFleetsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/ListAssociatedFleets

func (*AppStream) ListAssociatedFleetsWithContext added in v1.8.0 

func (c *AppStream) ListAssociatedFleetsWithContext(ctx aws.Context, input *ListAssociatedFleetsInput, opts ...request.Option) (*ListAssociatedFleetsOutput, error)

ListAssociatedFleetsWithContext is the same as ListAssociatedFleets with the addition of the ability to pass a context and additional request options.

See ListAssociatedFleets for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*AppStream) ListAssociatedStacks 

func (c *AppStream) ListAssociatedStacks(input *ListAssociatedStacksInput) (*ListAssociatedStacksOutput, error)

ListAssociatedStacks API operation for Amazon AppStream.

Lists all stacks to which the specified fleet is associated.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon AppStream's API operation ListAssociatedStacks for usage and error information. Please also see https://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/ListAssociatedStacks

func (*AppStream) ListAssociatedStacksRequest 

func (c *AppStream) ListAssociatedStacksRequest(input *ListAssociatedStacksInput) (req *request.Request, output *ListAssociatedStacksOutput)

ListAssociatedStacksRequest generates a "aws/request.Request" representing the client's request for the ListAssociatedStacks operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See ListAssociatedStacks for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ListAssociatedStacks method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// Example sending a request using the ListAssociatedStacksRequest method.
req, resp := client.ListAssociatedStacksRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/ListAssociatedStacks

func (*AppStream) ListAssociatedStacksWithContext added in v1.8.0 

func (c *AppStream) ListAssociatedStacksWithContext(ctx aws.Context, input *ListAssociatedStacksInput, opts ...request.Option) (*ListAssociatedStacksOutput, error)

ListAssociatedStacksWithContext is the same as ListAssociatedStacks with the addition of the ability to pass a context and additional request options.

See ListAssociatedStacks for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*AppStream) StartFleet 

func (c *AppStream) StartFleet(input *StartFleetInput) (*StartFleetOutput, error)

StartFleet API operation for Amazon AppStream.

Starts a fleet.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon AppStream's API operation StartFleet for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource was not found.

  • ErrCodeOperationNotPermittedException "OperationNotPermittedException" The attempted operation is not permitted.

  • ErrCodeLimitExceededException "LimitExceededException" The requested limit exceeds the permitted limit for an account.

  • ErrCodeConcurrentModificationException "ConcurrentModificationException" An API error occurred. Wait a few minutes and try again.

Please also see https://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/StartFleet

func (*AppStream) StartFleetRequest 

func (c *AppStream) StartFleetRequest(input *StartFleetInput) (req *request.Request, output *StartFleetOutput)

StartFleetRequest generates a "aws/request.Request" representing the client's request for the StartFleet operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See StartFleet for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the StartFleet method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// Example sending a request using the StartFleetRequest method.
req, resp := client.StartFleetRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/StartFleet

func (*AppStream) StartFleetWithContext added in v1.8.0 

func (c *AppStream) StartFleetWithContext(ctx aws.Context, input *StartFleetInput, opts ...request.Option) (*StartFleetOutput, error)

StartFleetWithContext is the same as StartFleet with the addition of the ability to pass a context and additional request options.

See StartFleet for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*AppStream) StopFleet 

func (c *AppStream) StopFleet(input *StopFleetInput) (*StopFleetOutput, error)

StopFleet API operation for Amazon AppStream.

Stops a fleet.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon AppStream's API operation StopFleet for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource was not found.

  • ErrCodeConcurrentModificationException "ConcurrentModificationException" An API error occurred. Wait a few minutes and try again.

Please also see https://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/StopFleet

func (*AppStream) StopFleetRequest 

func (c *AppStream) StopFleetRequest(input *StopFleetInput) (req *request.Request, output *StopFleetOutput)

StopFleetRequest generates a "aws/request.Request" representing the client's request for the StopFleet operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See StopFleet for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the StopFleet method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// Example sending a request using the StopFleetRequest method.
req, resp := client.StopFleetRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/StopFleet

func (*AppStream) StopFleetWithContext added in v1.8.0 

func (c *AppStream) StopFleetWithContext(ctx aws.Context, input *StopFleetInput, opts ...request.Option) (*StopFleetOutput, error)

StopFleetWithContext is the same as StopFleet with the addition of the ability to pass a context and additional request options.

See StopFleet for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*AppStream) UpdateFleet 

func (c *AppStream) UpdateFleet(input *UpdateFleetInput) (*UpdateFleetOutput, error)

UpdateFleet API operation for Amazon AppStream.

Updates an existing fleet. All the attributes except the fleet name can be updated in the STOPPED state. When a fleet is in the RUNNING state, only DisplayName and ComputeCapacity can be updated. A fleet cannot be updated in a status of STARTING or STOPPING.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon AppStream's API operation UpdateFleet for usage and error information.

Returned Error Codes:

  • ErrCodeResourceInUseException "ResourceInUseException" The specified resource is in use.

  • ErrCodeLimitExceededException "LimitExceededException" The requested limit exceeds the permitted limit for an account.

  • ErrCodeInvalidRoleException "InvalidRoleException" The specified role is invalid.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource was not found.

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

  • ErrCodeInvalidParameterCombinationException "InvalidParameterCombinationException" Indicates an incorrect combination of parameters, or a missing parameter.

  • ErrCodeConcurrentModificationException "ConcurrentModificationException" An API error occurred. Wait a few minutes and try again.

  • ErrCodeIncompatibleImageException "IncompatibleImageException" The image does not support storage connectors.

Please also see https://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/UpdateFleet

func (*AppStream) UpdateFleetRequest 

func (c *AppStream) UpdateFleetRequest(input *UpdateFleetInput) (req *request.Request, output *UpdateFleetOutput)

UpdateFleetRequest generates a "aws/request.Request" representing the client's request for the UpdateFleet operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See UpdateFleet for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the UpdateFleet method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// Example sending a request using the UpdateFleetRequest method.
req, resp := client.UpdateFleetRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/UpdateFleet

func (*AppStream) UpdateFleetWithContext added in v1.8.0 

func (c *AppStream) UpdateFleetWithContext(ctx aws.Context, input *UpdateFleetInput, opts ...request.Option) (*UpdateFleetOutput, error)

UpdateFleetWithContext is the same as UpdateFleet with the addition of the ability to pass a context and additional request options.

See UpdateFleet for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*AppStream) UpdateStack 

func (c *AppStream) UpdateStack(input *UpdateStackInput) (*UpdateStackOutput, error)

UpdateStack API operation for Amazon AppStream.

Updates the specified fields in the stack with the specified name.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon AppStream's API operation UpdateStack for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource was not found.

  • ErrCodeResourceInUseException "ResourceInUseException" The specified resource is in use.

  • ErrCodeInvalidRoleException "InvalidRoleException" The specified role is invalid.

  • ErrCodeInvalidParameterCombinationException "InvalidParameterCombinationException" Indicates an incorrect combination of parameters, or a missing parameter.

  • ErrCodeLimitExceededException "LimitExceededException" The requested limit exceeds the permitted limit for an account.

  • ErrCodeIncompatibleImageException "IncompatibleImageException" The image does not support storage connectors.

Please also see https://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/UpdateStack

func (*AppStream) UpdateStackRequest 

func (c *AppStream) UpdateStackRequest(input *UpdateStackInput) (req *request.Request, output *UpdateStackOutput)

UpdateStackRequest generates a "aws/request.Request" representing the client's request for the UpdateStack operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See UpdateStack for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the UpdateStack method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// Example sending a request using the UpdateStackRequest method.
req, resp := client.UpdateStackRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/UpdateStack

func (*AppStream) UpdateStackWithContext added in v1.8.0 

func (c *AppStream) UpdateStackWithContext(ctx aws.Context, input *UpdateStackInput, opts ...request.Option) (*UpdateStackOutput, error)

UpdateStackWithContext is the same as UpdateStack with the addition of the ability to pass a context and additional request options.

See UpdateStack for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*AppStream) WaitUntilFleetStarted 

func (c *AppStream) WaitUntilFleetStarted(input *DescribeFleetsInput) error

WaitUntilFleetStarted uses the Amazon AppStream API operation DescribeFleets to wait for a condition to be met before returning. If the condition is not meet within the max attempt window an error will be returned.

func (*AppStream) WaitUntilFleetStartedWithContext added in v1.8.0 

func (c *AppStream) WaitUntilFleetStartedWithContext(ctx aws.Context, input *DescribeFleetsInput, opts ...request.WaiterOption) error

WaitUntilFleetStartedWithContext is an extended version of WaitUntilFleetStarted. With the support for passing in a context and options to configure the Waiter and the underlying request options.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*AppStream) WaitUntilFleetStopped 

func (c *AppStream) WaitUntilFleetStopped(input *DescribeFleetsInput) error

WaitUntilFleetStopped uses the Amazon AppStream API operation DescribeFleets to wait for a condition to be met before returning. If the condition is not meet within the max attempt window an error will be returned.

func (*AppStream) WaitUntilFleetStoppedWithContext added in v1.8.0 

func (c *AppStream) WaitUntilFleetStoppedWithContext(ctx aws.Context, input *DescribeFleetsInput, opts ...request.WaiterOption) error

WaitUntilFleetStoppedWithContext is an extended version of WaitUntilFleetStopped. With the support for passing in a context and options to configure the Waiter and the underlying request options.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type Application 

type Application struct {

	// The name of the application shown to the end users.
	DisplayName *string `min:"1" type:"string"`

	// An application can be disabled after image creation if there is a problem.
	Enabled *bool `type:"boolean"`

	// The URL for the application icon. This URL may be time-limited.
	IconURL *string `min:"1" type:"string"`

	// A list of arguments that are passed to the application at launch.
	LaunchParameters *string `min:"1" type:"string"`

	// The path to the application executable in the instance.
	LaunchPath *string `min:"1" type:"string"`

	// Additional attributes that describe the application.
	Metadata map[string]*string `type:"map"`

	// The unique identifier for the application.
	Name *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

An entry for a single application in the application catalog. Please also see https://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/Application

func (Application) GoString 

func (s Application) GoString() string

GoString returns the string representation

func (*Application) SetDisplayName 

func (s *Application) SetDisplayName(v string) *Application

SetDisplayName sets the DisplayName field's value.

func (*Application) SetEnabled 

func (s *Application) SetEnabled(v bool) *Application

SetEnabled sets the Enabled field's value.

func (*Application) SetIconURL 

func (s *Application) SetIconURL(v string) *Application

SetIconURL sets the IconURL field's value.

func (*Application) SetLaunchParameters 

func (s *Application) SetLaunchParameters(v string) *Application

SetLaunchParameters sets the LaunchParameters field's value.

func (*Application) SetLaunchPath 

func (s *Application) SetLaunchPath(v string) *Application

SetLaunchPath sets the LaunchPath field's value.

func (*Application) SetMetadata 

func (s *Application) SetMetadata(v map[string]*string) *Application

SetMetadata sets the Metadata field's value.

func (*Application) SetName 

func (s *Application) SetName(v string) *Application

SetName sets the Name field's value.

func (Application) String 

func (s Application) String() string

String returns the string representation

type AssociateFleetInput 

type AssociateFleetInput struct {

	// The name of the fleet to associate.
	//
	// FleetName is a required field
	FleetName *string `min:"1" type:"string" required:"true"`

	// The name of the stack to which the fleet is associated.
	//
	// StackName is a required field
	StackName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/AssociateFleetRequest

func (AssociateFleetInput) GoString 

func (s AssociateFleetInput) GoString() string

GoString returns the string representation

func (*AssociateFleetInput) SetFleetName 

func (s *AssociateFleetInput) SetFleetName(v string) *AssociateFleetInput

SetFleetName sets the FleetName field's value.

func (*AssociateFleetInput) SetStackName 

func (s *AssociateFleetInput) SetStackName(v string) *AssociateFleetInput

SetStackName sets the StackName field's value.

func (AssociateFleetInput) String 

func (s AssociateFleetInput) String() string

String returns the string representation

func (*AssociateFleetInput) Validate 

func (s *AssociateFleetInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AssociateFleetOutput 

type AssociateFleetOutput struct {
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/AssociateFleetResult

func (AssociateFleetOutput) GoString 

func (s AssociateFleetOutput) GoString() string

GoString returns the string representation

func (AssociateFleetOutput) String 

func (s AssociateFleetOutput) String() string

String returns the string representation

type ComputeCapacity 

type ComputeCapacity struct {

	// The desired number of streaming instances.
	//
	// DesiredInstances is a required field
	DesiredInstances *int64 `type:"integer" required:"true"`
	// contains filtered or unexported fields
}

The capacity configuration for the fleet. Please also see https://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/ComputeCapacity

func (ComputeCapacity) GoString 

func (s ComputeCapacity) GoString() string

GoString returns the string representation

func (*ComputeCapacity) SetDesiredInstances 

func (s *ComputeCapacity) SetDesiredInstances(v int64) *ComputeCapacity

SetDesiredInstances sets the DesiredInstances field's value.

func (ComputeCapacity) String 

func (s ComputeCapacity) String() string

String returns the string representation

func (*ComputeCapacity) Validate 

func (s *ComputeCapacity) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ComputeCapacityStatus 

type ComputeCapacityStatus struct {

	// The number of currently available instances that can be used to stream sessions.
	Available *int64 `type:"integer"`

	// The desired number of streaming instances.
	//
	// Desired is a required field
	Desired *int64 `type:"integer" required:"true"`

	// The number of instances that are being used for streaming.
	InUse *int64 `type:"integer"`

	// The total number of simultaneous streaming instances that are running.
	Running *int64 `type:"integer"`
	// contains filtered or unexported fields
}

The capacity information for the fleet. Please also see https://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/ComputeCapacityStatus

func (ComputeCapacityStatus) GoString 

func (s ComputeCapacityStatus) GoString() string

GoString returns the string representation

func (*ComputeCapacityStatus) SetAvailable 

func (s *ComputeCapacityStatus) SetAvailable(v int64) *ComputeCapacityStatus

SetAvailable sets the Available field's value.

func (*ComputeCapacityStatus) SetDesired 

func (s *ComputeCapacityStatus) SetDesired(v int64) *ComputeCapacityStatus

SetDesired sets the Desired field's value.

func (*ComputeCapacityStatus) SetInUse 

func (s *ComputeCapacityStatus) SetInUse(v int64) *ComputeCapacityStatus

SetInUse sets the InUse field's value.

func (*ComputeCapacityStatus) SetRunning 

func (s *ComputeCapacityStatus) SetRunning(v int64) *ComputeCapacityStatus

SetRunning sets the Running field's value.

func (ComputeCapacityStatus) String 

func (s ComputeCapacityStatus) String() string

String returns the string representation

type CreateFleetInput 

type CreateFleetInput struct {

	// The parameters for the capacity allocated to the fleet.
	//
	// ComputeCapacity is a required field
	ComputeCapacity *ComputeCapacity `type:"structure" required:"true"`

	// The description of the fleet.
	Description *string `type:"string"`

	// The time after disconnection when a session is considered to have ended.
	// If a user who got disconnected reconnects within this timeout interval, the
	// user is connected back to their previous session. The input can be any numeric
	// value in seconds between 60 and 57600.
	DisconnectTimeoutInSeconds *int64 `type:"integer"`

	// The display name of the fleet.
	DisplayName *string `type:"string"`

	// Enables or disables default Internet access for the fleet.
	EnableDefaultInternetAccess *bool `type:"boolean"`

	// Unique name of the image used by the fleet.
	//
	// ImageName is a required field
	ImageName *string `min:"1" type:"string" required:"true"`

	// The instance type of compute resources for the fleet. Fleet instances are
	// launched from this instance type.
	//
	// InstanceType is a required field
	InstanceType *string `min:"1" type:"string" required:"true"`

	// The maximum time for which a streaming session can run. The input can be
	// any numeric value in seconds between 600 and 57600.
	MaxUserDurationInSeconds *int64 `type:"integer"`

	// A unique identifier for the fleet.
	//
	// Name is a required field
	Name *string `type:"string" required:"true"`

	// The VPC configuration for the fleet.
	VpcConfig *VpcConfig `type:"structure"`
	// contains filtered or unexported fields
}

Contains the parameters for the new fleet to create. Please also see https://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/CreateFleetRequest

func (CreateFleetInput) GoString 

func (s CreateFleetInput) GoString() string

GoString returns the string representation

func (*CreateFleetInput) SetComputeCapacity 

func (s *CreateFleetInput) SetComputeCapacity(v *ComputeCapacity) *CreateFleetInput

SetComputeCapacity sets the ComputeCapacity field's value.

func (*CreateFleetInput) SetDescription 

func (s *CreateFleetInput) SetDescription(v string) *CreateFleetInput

SetDescription sets the Description field's value.

func (*CreateFleetInput) SetDisconnectTimeoutInSeconds 

func (s *CreateFleetInput) SetDisconnectTimeoutInSeconds(v int64) *CreateFleetInput

SetDisconnectTimeoutInSeconds sets the DisconnectTimeoutInSeconds field's value.

func (*CreateFleetInput) SetDisplayName 

func (s *CreateFleetInput) SetDisplayName(v string) *CreateFleetInput

SetDisplayName sets the DisplayName field's value.

func (*CreateFleetInput) SetEnableDefaultInternetAccess added in v1.8.16 

func (s *CreateFleetInput) SetEnableDefaultInternetAccess(v bool) *CreateFleetInput

SetEnableDefaultInternetAccess sets the EnableDefaultInternetAccess field's value.

func (*CreateFleetInput) SetImageName 

func (s *CreateFleetInput) SetImageName(v string) *CreateFleetInput

SetImageName sets the ImageName field's value.

func (*CreateFleetInput) SetInstanceType 

func (s *CreateFleetInput) SetInstanceType(v string) *CreateFleetInput

SetInstanceType sets the InstanceType field's value.

func (*CreateFleetInput) SetMaxUserDurationInSeconds 

func (s *CreateFleetInput) SetMaxUserDurationInSeconds(v int64) *CreateFleetInput

SetMaxUserDurationInSeconds sets the MaxUserDurationInSeconds field's value.

func (*CreateFleetInput) SetName 

func (s *CreateFleetInput) SetName(v string) *CreateFleetInput

SetName sets the Name field's value.

func (*CreateFleetInput) SetVpcConfig 

func (s *CreateFleetInput) SetVpcConfig(v *VpcConfig) *CreateFleetInput

SetVpcConfig sets the VpcConfig field's value.

func (CreateFleetInput) String 

func (s CreateFleetInput) String() string

String returns the string representation

func (*CreateFleetInput) Validate 

func (s *CreateFleetInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateFleetOutput 

type CreateFleetOutput struct {

	// The details for the created fleet.
	Fleet *Fleet `type:"structure"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/CreateFleetResult

func (CreateFleetOutput) GoString 

func (s CreateFleetOutput) GoString() string

GoString returns the string representation

func (*CreateFleetOutput) SetFleet 

func (s *CreateFleetOutput) SetFleet(v *Fleet) *CreateFleetOutput

SetFleet sets the Fleet field's value.

func (CreateFleetOutput) String 

func (s CreateFleetOutput) String() string

String returns the string representation

type CreateStackInput 

type CreateStackInput struct {

	// The description displayed to end users on the AppStream 2.0 portal.
	Description *string `type:"string"`

	// The name displayed to end users on the AppStream 2.0 portal.
	DisplayName *string `type:"string"`

	// The unique identifier for this stack.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

	// The storage connectors to be enabled for the stack.
	StorageConnectors []*StorageConnector `type:"list"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/CreateStackRequest

func (CreateStackInput) GoString 

func (s CreateStackInput) GoString() string

GoString returns the string representation

func (*CreateStackInput) SetDescription 

func (s *CreateStackInput) SetDescription(v string) *CreateStackInput

SetDescription sets the Description field's value.

func (*CreateStackInput) SetDisplayName 

func (s *CreateStackInput) SetDisplayName(v string) *CreateStackInput

SetDisplayName sets the DisplayName field's value.

func (*CreateStackInput) SetName 

func (s *CreateStackInput) SetName(v string) *CreateStackInput

SetName sets the Name field's value.

func (*CreateStackInput) SetStorageConnectors added in v1.8.30 

func (s *CreateStackInput) SetStorageConnectors(v []*StorageConnector) *CreateStackInput

SetStorageConnectors sets the StorageConnectors field's value.

func (CreateStackInput) String 

func (s CreateStackInput) String() string

String returns the string representation

func (*CreateStackInput) Validate 

func (s *CreateStackInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateStackOutput 

type CreateStackOutput struct {

	// The details for the created stack.
	Stack *Stack `type:"structure"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/CreateStackResult

func (CreateStackOutput) GoString 

func (s CreateStackOutput) GoString() string

GoString returns the string representation

func (*CreateStackOutput) SetStack 

func (s *CreateStackOutput) SetStack(v *Stack) *CreateStackOutput

SetStack sets the Stack field's value.

func (CreateStackOutput) String 

func (s CreateStackOutput) String() string

String returns the string representation

type CreateStreamingURLInput 

type CreateStreamingURLInput struct {

	// The ID of the application that must be launched after the session starts.
	ApplicationId *string `min:"1" type:"string"`

	// The fleet for which the URL is generated.
	//
	// FleetName is a required field
	FleetName *string `min:"1" type:"string" required:"true"`

	// The sessionContext of the streaming URL.
	SessionContext *string `min:"1" type:"string"`

	// The stack for which the URL is generated.
	//
	// StackName is a required field
	StackName *string `min:"1" type:"string" required:"true"`

	// A unique user ID for whom the URL is generated.
	//
	// UserId is a required field
	UserId *string `min:"2" type:"string" required:"true"`

	// The duration up to which the URL returned by this action is valid. The input
	// can be any numeric value in seconds between 1 and 604800 seconds.
	Validity *int64 `type:"long"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/CreateStreamingURLRequest

func (CreateStreamingURLInput) GoString 

func (s CreateStreamingURLInput) GoString() string

GoString returns the string representation

func (*CreateStreamingURLInput) SetApplicationId 

func (s *CreateStreamingURLInput) SetApplicationId(v string) *CreateStreamingURLInput

SetApplicationId sets the ApplicationId field's value.

func (*CreateStreamingURLInput) SetFleetName 

func (s *CreateStreamingURLInput) SetFleetName(v string) *CreateStreamingURLInput

SetFleetName sets the FleetName field's value.

func (*CreateStreamingURLInput) SetSessionContext 

func (s *CreateStreamingURLInput) SetSessionContext(v string) *CreateStreamingURLInput

SetSessionContext sets the SessionContext field's value.

func (*CreateStreamingURLInput) SetStackName 

func (s *CreateStreamingURLInput) SetStackName(v string) *CreateStreamingURLInput

SetStackName sets the StackName field's value.

func (*CreateStreamingURLInput) SetUserId 

func (s *CreateStreamingURLInput) SetUserId(v string) *CreateStreamingURLInput

SetUserId sets the UserId field's value.

func (*CreateStreamingURLInput) SetValidity 

func (s *CreateStreamingURLInput) SetValidity(v int64) *CreateStreamingURLInput

SetValidity sets the Validity field's value.

func (CreateStreamingURLInput) String 

func (s CreateStreamingURLInput) String() string

String returns the string representation

func (*CreateStreamingURLInput) Validate 

func (s *CreateStreamingURLInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateStreamingURLOutput 

type CreateStreamingURLOutput struct {

	// Elapsed seconds after the Unix epoch, at which time this URL expires.
	Expires *time.Time `type:"timestamp" timestampFormat:"unix"`

	// The URL to start the AppStream 2.0 streaming session.
	StreamingURL *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/CreateStreamingURLResult

func (CreateStreamingURLOutput) GoString 

func (s CreateStreamingURLOutput) GoString() string

GoString returns the string representation

func (*CreateStreamingURLOutput) SetExpires 

func (s *CreateStreamingURLOutput) SetExpires(v time.Time) *CreateStreamingURLOutput

SetExpires sets the Expires field's value.

func (*CreateStreamingURLOutput) SetStreamingURL 

func (s *CreateStreamingURLOutput) SetStreamingURL(v string) *CreateStreamingURLOutput

SetStreamingURL sets the StreamingURL field's value.

func (CreateStreamingURLOutput) String 

func (s CreateStreamingURLOutput) String() string

String returns the string representation

type DeleteFleetInput 

type DeleteFleetInput struct {

	// The name of the fleet to be deleted.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/DeleteFleetRequest

func (DeleteFleetInput) GoString 

func (s DeleteFleetInput) GoString() string

GoString returns the string representation

func (*DeleteFleetInput) SetName 

func (s *DeleteFleetInput) SetName(v string) *DeleteFleetInput

SetName sets the Name field's value.

func (DeleteFleetInput) String 

func (s DeleteFleetInput) String() string

String returns the string representation

func (*DeleteFleetInput) Validate 

func (s *DeleteFleetInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteFleetOutput 

type DeleteFleetOutput struct {
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/DeleteFleetResult

func (DeleteFleetOutput) GoString 

func (s DeleteFleetOutput) GoString() string

GoString returns the string representation

func (DeleteFleetOutput) String 

func (s DeleteFleetOutput) String() string

String returns the string representation

type DeleteStackInput 

type DeleteStackInput struct {

	// The name of the stack to delete.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/DeleteStackRequest

func (DeleteStackInput) GoString 

func (s DeleteStackInput) GoString() string

GoString returns the string representation

func (*DeleteStackInput) SetName 

func (s *DeleteStackInput) SetName(v string) *DeleteStackInput

SetName sets the Name field's value.

func (DeleteStackInput) String 

func (s DeleteStackInput) String() string

String returns the string representation

func (*DeleteStackInput) Validate 

func (s *DeleteStackInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteStackOutput 

type DeleteStackOutput struct {
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/DeleteStackResult

func (DeleteStackOutput) GoString 

func (s DeleteStackOutput) GoString() string

GoString returns the string representation

func (DeleteStackOutput) String 

func (s DeleteStackOutput) String() string

String returns the string representation

type DescribeFleetsInput 

type DescribeFleetsInput struct {

	// The fleet names to describe. Use null to describe all the fleets for the
	// AWS account.
	Names []*string `type:"list"`

	// 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 `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/DescribeFleetsRequest

func (DescribeFleetsInput) GoString 

func (s DescribeFleetsInput) GoString() string

GoString returns the string representation

func (*DescribeFleetsInput) SetNames 

func (s *DescribeFleetsInput) SetNames(v []*string) *DescribeFleetsInput

SetNames sets the Names field's value.

func (*DescribeFleetsInput) SetNextToken 

func (s *DescribeFleetsInput) SetNextToken(v string) *DescribeFleetsInput

SetNextToken sets the NextToken field's value.

func (DescribeFleetsInput) String 

func (s DescribeFleetsInput) String() string

String returns the string representation

func (*DescribeFleetsInput) Validate 

func (s *DescribeFleetsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeFleetsOutput 

type DescribeFleetsOutput struct {

	// The list of fleet details.
	Fleets []*Fleet `type:"list"`

	// 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 `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/DescribeFleetsResult

func (DescribeFleetsOutput) GoString 

func (s DescribeFleetsOutput) GoString() string

GoString returns the string representation

func (*DescribeFleetsOutput) SetFleets 

func (s *DescribeFleetsOutput) SetFleets(v []*Fleet) *DescribeFleetsOutput

SetFleets sets the Fleets field's value.

func (*DescribeFleetsOutput) SetNextToken 

func (s *DescribeFleetsOutput) SetNextToken(v string) *DescribeFleetsOutput

SetNextToken sets the NextToken field's value.

func (DescribeFleetsOutput) String 

func (s DescribeFleetsOutput) String() string

String returns the string representation

type DescribeImagesInput 

type DescribeImagesInput struct {

	// A specific list of images to describe.
	Names []*string `type:"list"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/DescribeImagesRequest

func (DescribeImagesInput) GoString 

func (s DescribeImagesInput) GoString() string

GoString returns the string representation

func (*DescribeImagesInput) SetNames 

func (s *DescribeImagesInput) SetNames(v []*string) *DescribeImagesInput

SetNames sets the Names field's value.

func (DescribeImagesInput) String 

func (s DescribeImagesInput) String() string

String returns the string representation

type DescribeImagesOutput 

type DescribeImagesOutput struct {

	// The list of images.
	Images []*Image `type:"list"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/DescribeImagesResult

func (DescribeImagesOutput) GoString 

func (s DescribeImagesOutput) GoString() string

GoString returns the string representation

func (*DescribeImagesOutput) SetImages 

func (s *DescribeImagesOutput) SetImages(v []*Image) *DescribeImagesOutput

SetImages sets the Images field's value.

func (DescribeImagesOutput) String 

func (s DescribeImagesOutput) String() string

String returns the string representation

type DescribeSessionsInput 

type DescribeSessionsInput struct {

	// The authentication method of the user. It can be API for a user authenticated
	// using a streaming URL, or SAML for a SAML federated user. If an authentication
	// type is not provided, the operation defaults to users authenticated using
	// a streaming URL.
	AuthenticationType *string `type:"string" enum:"AuthenticationType"`

	// The name of the fleet for which to list sessions.
	//
	// FleetName is a required field
	FleetName *string `min:"1" type:"string" required:"true"`

	// The size of each page of results. The default value is 20 and the maximum
	// supported value is 50.
	Limit *int64 `type:"integer"`

	// 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 `min:"1" type:"string"`

	// The name of the stack for which to list sessions.
	//
	// StackName is a required field
	StackName *string `min:"1" type:"string" required:"true"`

	// The user for whom to list sessions. Use null to describe all the sessions
	// for the stack and fleet.
	UserId *string `min:"2" type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/DescribeSessionsRequest

func (DescribeSessionsInput) GoString 

func (s DescribeSessionsInput) GoString() string

GoString returns the string representation

func (*DescribeSessionsInput) SetAuthenticationType added in v1.8.16 

func (s *DescribeSessionsInput) SetAuthenticationType(v string) *DescribeSessionsInput

SetAuthenticationType sets the AuthenticationType field's value.

func (*DescribeSessionsInput) SetFleetName 

func (s *DescribeSessionsInput) SetFleetName(v string) *DescribeSessionsInput

SetFleetName sets the FleetName field's value.

func (*DescribeSessionsInput) SetLimit 

func (s *DescribeSessionsInput) SetLimit(v int64) *DescribeSessionsInput

SetLimit sets the Limit field's value.

func (*DescribeSessionsInput) SetNextToken 

func (s *DescribeSessionsInput) SetNextToken(v string) *DescribeSessionsInput

SetNextToken sets the NextToken field's value.

func (*DescribeSessionsInput) SetStackName 

func (s *DescribeSessionsInput) SetStackName(v string) *DescribeSessionsInput

SetStackName sets the StackName field's value.

func (*DescribeSessionsInput) SetUserId 

func (s *DescribeSessionsInput) SetUserId(v string) *DescribeSessionsInput

SetUserId sets the UserId field's value.

func (DescribeSessionsInput) String 

func (s DescribeSessionsInput) String() string

String returns the string representation

func (*DescribeSessionsInput) Validate 

func (s *DescribeSessionsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

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 `min:"1" type:"string"`

	// The list of streaming sessions.
	Sessions []*Session `type:"list"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/DescribeSessionsResult

func (DescribeSessionsOutput) GoString 

func (s DescribeSessionsOutput) GoString() string

GoString returns the string representation

func (*DescribeSessionsOutput) SetNextToken 

func (s *DescribeSessionsOutput) SetNextToken(v string) *DescribeSessionsOutput

SetNextToken sets the NextToken field's value.

func (*DescribeSessionsOutput) SetSessions 

func (s *DescribeSessionsOutput) SetSessions(v []*Session) *DescribeSessionsOutput

SetSessions sets the Sessions field's value.

func (DescribeSessionsOutput) String 

func (s DescribeSessionsOutput) String() string

String returns the string representation

type DescribeStacksInput 

type DescribeStacksInput struct {

	// The stack names to describe. Use null to describe all the stacks for the
	// AWS account.
	Names []*string `type:"list"`

	// 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 `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/DescribeStacksRequest

func (DescribeStacksInput) GoString 

func (s DescribeStacksInput) GoString() string

GoString returns the string representation

func (*DescribeStacksInput) SetNames 

func (s *DescribeStacksInput) SetNames(v []*string) *DescribeStacksInput

SetNames sets the Names field's value.

func (*DescribeStacksInput) SetNextToken 

func (s *DescribeStacksInput) SetNextToken(v string) *DescribeStacksInput

SetNextToken sets the NextToken field's value.

func (DescribeStacksInput) String 

func (s DescribeStacksInput) String() string

String returns the string representation

func (*DescribeStacksInput) Validate 

func (s *DescribeStacksInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

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 `min:"1" type:"string"`

	// The list of stack details.
	Stacks []*Stack `type:"list"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/DescribeStacksResult

func (DescribeStacksOutput) GoString 

func (s DescribeStacksOutput) GoString() string

GoString returns the string representation

func (*DescribeStacksOutput) SetNextToken 

func (s *DescribeStacksOutput) SetNextToken(v string) *DescribeStacksOutput

SetNextToken sets the NextToken field's value.

func (*DescribeStacksOutput) SetStacks 

func (s *DescribeStacksOutput) SetStacks(v []*Stack) *DescribeStacksOutput

SetStacks sets the Stacks field's value.

func (DescribeStacksOutput) String 

func (s DescribeStacksOutput) String() string

String returns the string representation

type DisassociateFleetInput 

type DisassociateFleetInput struct {

	// The name of the fleet to disassociate.
	//
	// FleetName is a required field
	FleetName *string `min:"1" type:"string" required:"true"`

	// The name of the stack with which the fleet is associated.
	//
	// StackName is a required field
	StackName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/DisassociateFleetRequest

func (DisassociateFleetInput) GoString 

func (s DisassociateFleetInput) GoString() string

GoString returns the string representation

func (*DisassociateFleetInput) SetFleetName 

func (s *DisassociateFleetInput) SetFleetName(v string) *DisassociateFleetInput

SetFleetName sets the FleetName field's value.

func (*DisassociateFleetInput) SetStackName 

func (s *DisassociateFleetInput) SetStackName(v string) *DisassociateFleetInput

SetStackName sets the StackName field's value.

func (DisassociateFleetInput) String 

func (s DisassociateFleetInput) String() string

String returns the string representation

func (*DisassociateFleetInput) Validate 

func (s *DisassociateFleetInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DisassociateFleetOutput 

type DisassociateFleetOutput struct {
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/DisassociateFleetResult

func (DisassociateFleetOutput) GoString 

func (s DisassociateFleetOutput) GoString() string

GoString returns the string representation

func (DisassociateFleetOutput) String 

func (s DisassociateFleetOutput) String() string

String returns the string representation

type ExpireSessionInput 

type ExpireSessionInput struct {

	// The unique identifier of the streaming session to be stopped.
	//
	// SessionId is a required field
	SessionId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/ExpireSessionRequest

func (ExpireSessionInput) GoString 

func (s ExpireSessionInput) GoString() string

GoString returns the string representation

func (*ExpireSessionInput) SetSessionId 

func (s *ExpireSessionInput) SetSessionId(v string) *ExpireSessionInput

SetSessionId sets the SessionId field's value.

func (ExpireSessionInput) String 

func (s ExpireSessionInput) String() string

String returns the string representation

func (*ExpireSessionInput) Validate 

func (s *ExpireSessionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ExpireSessionOutput 

type ExpireSessionOutput struct {
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/ExpireSessionResult

func (ExpireSessionOutput) GoString 

func (s ExpireSessionOutput) GoString() string

GoString returns the string representation

func (ExpireSessionOutput) String 

func (s ExpireSessionOutput) String() string

String returns the string representation

type Fleet 

type Fleet struct {

	// The ARN for the fleet.
	//
	// Arn is a required field
	Arn *string `type:"string" required:"true"`

	// The capacity information for the fleet.
	//
	// ComputeCapacityStatus is a required field
	ComputeCapacityStatus *ComputeCapacityStatus `type:"structure" required:"true"`

	// The time at which the fleet was created.
	CreatedTime *time.Time `type:"timestamp" timestampFormat:"unix"`

	// The description displayed to end users on the AppStream 2.0 portal.
	Description *string `min:"1" type:"string"`

	// The time after disconnection when a session is considered to have ended.
	// If a user who got disconnected reconnects within this timeout interval, the
	// user is connected back to their previous session. The input can be any numeric
	// value in seconds between 60 and 57600.
	DisconnectTimeoutInSeconds *int64 `type:"integer"`

	// The name displayed to end users on the AppStream 2.0 portal.
	DisplayName *string `min:"1" type:"string"`

	// Whether default Internet access is enabled for the fleet.
	EnableDefaultInternetAccess *bool `type:"boolean"`

	// The list of fleet errors is appended to this list.
	FleetErrors []*FleetError `type:"list"`

	// The image used by the fleet.
	//
	// ImageName is a required field
	ImageName *string `min:"1" type:"string" required:"true"`

	// The instance type of compute resources for the fleet. The fleet instances
	// are launched from this instance type.
	//
	// InstanceType is a required field
	InstanceType *string `min:"1" type:"string" required:"true"`

	// The maximum time for which a streaming session can run. The value can be
	// any numeric value in seconds between 600 and 57600.
	MaxUserDurationInSeconds *int64 `type:"integer"`

	// The name of the fleet.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

	// The current state for the fleet.
	//
	// State is a required field
	State *string `type:"string" required:"true" enum:"FleetState"`

	// The VPC configuration for the fleet.
	VpcConfig *VpcConfig `type:"structure"`
	// contains filtered or unexported fields
}

Contains the parameters for a fleet. Please also see https://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/Fleet

func (Fleet) GoString 

func (s Fleet) GoString() string

GoString returns the string representation

func (*Fleet) SetArn 

func (s *Fleet) SetArn(v string) *Fleet

SetArn sets the Arn field's value.

func (*Fleet) SetComputeCapacityStatus 

func (s *Fleet) SetComputeCapacityStatus(v *ComputeCapacityStatus) *Fleet

SetComputeCapacityStatus sets the ComputeCapacityStatus field's value.

func (*Fleet) SetCreatedTime 

func (s *Fleet) SetCreatedTime(v time.Time) *Fleet

SetCreatedTime sets the CreatedTime field's value.

func (*Fleet) SetDescription 

func (s *Fleet) SetDescription(v string) *Fleet

SetDescription sets the Description field's value.

func (*Fleet) SetDisconnectTimeoutInSeconds 

func (s *Fleet) SetDisconnectTimeoutInSeconds(v int64) *Fleet

SetDisconnectTimeoutInSeconds sets the DisconnectTimeoutInSeconds field's value.

func (*Fleet) SetDisplayName 

func (s *Fleet) SetDisplayName(v string) *Fleet

SetDisplayName sets the DisplayName field's value.

func (*Fleet) SetEnableDefaultInternetAccess added in v1.8.16 

func (s *Fleet) SetEnableDefaultInternetAccess(v bool) *Fleet

SetEnableDefaultInternetAccess sets the EnableDefaultInternetAccess field's value.

func (*Fleet) SetFleetErrors 

func (s *Fleet) SetFleetErrors(v []*FleetError) *Fleet

SetFleetErrors sets the FleetErrors field's value.

func (*Fleet) SetImageName 

func (s *Fleet) SetImageName(v string) *Fleet

SetImageName sets the ImageName field's value.

func (*Fleet) SetInstanceType 

func (s *Fleet) SetInstanceType(v string) *Fleet

SetInstanceType sets the InstanceType field's value.

func (*Fleet) SetMaxUserDurationInSeconds 

func (s *Fleet) SetMaxUserDurationInSeconds(v int64) *Fleet

SetMaxUserDurationInSeconds sets the MaxUserDurationInSeconds field's value.

func (*Fleet) SetName 

func (s *Fleet) SetName(v string) *Fleet

SetName sets the Name field's value.

func (*Fleet) SetState 

func (s *Fleet) SetState(v string) *Fleet

SetState sets the State field's value.

func (*Fleet) SetVpcConfig 

func (s *Fleet) SetVpcConfig(v *VpcConfig) *Fleet

SetVpcConfig sets the VpcConfig field's value.

func (Fleet) String 

func (s Fleet) String() string

String returns the string representation

type FleetError 

type FleetError struct {

	// The error code for the fleet error.
	ErrorCode *string `type:"string" enum:"FleetErrorCode"`

	// The error message generated when the fleet has errors.
	ErrorMessage *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

The details of the fleet error. Please also see https://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/FleetError

func (FleetError) GoString 

func (s FleetError) GoString() string

GoString returns the string representation

func (*FleetError) SetErrorCode 

func (s *FleetError) SetErrorCode(v string) *FleetError

SetErrorCode sets the ErrorCode field's value.

func (*FleetError) SetErrorMessage 

func (s *FleetError) SetErrorMessage(v string) *FleetError

SetErrorMessage sets the ErrorMessage field's value.

func (FleetError) String 

func (s FleetError) String() string

String returns the string representation

type Image 

type Image struct {

	// The applications associated with an image.
	Applications []*Application `type:"list"`

	// The ARN for the image.
	Arn *string `type:"string"`

	// The source image ARN from which this image was created.
	BaseImageArn *string `type:"string"`

	// The timestamp when the image was created.
	CreatedTime *time.Time `type:"timestamp" timestampFormat:"unix"`

	// A meaningful description for the image.
	Description *string `min:"1" type:"string"`

	// The display name for the image.
	DisplayName *string `min:"1" type:"string"`

	// Whether an image builder can be launched from this image.
	ImageBuilderSupported *bool `type:"boolean"`

	// The unique identifier for the image.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

	// The operating system platform of the image.
	Platform *string `type:"string" enum:"PlatformType"`

	// The AWS release date of the public base image. For private images, this date
	// is the release date of the base image from which the image was created.
	PublicBaseImageReleasedDate *time.Time `type:"timestamp" timestampFormat:"unix"`

	// The image starts in the PENDING state, and then moves to AVAILABLE if image
	// creation succeeds and FAILED if image creation has failed.
	State *string `type:"string" enum:"ImageState"`

	// The reason why the last state change occurred.
	StateChangeReason *ImageStateChangeReason `type:"structure"`

	// The visibility of an image to the user; images can be public or private.
	Visibility *string `type:"string" enum:"VisibilityType"`
	// contains filtered or unexported fields
}

New streaming instances are booted from images. The image stores the application catalog and is connected to fleets. Please also see https://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/Image

func (Image) GoString 

func (s Image) GoString() string

GoString returns the string representation

func (*Image) SetApplications 

func (s *Image) SetApplications(v []*Application) *Image

SetApplications sets the Applications field's value.

func (*Image) SetArn 

func (s *Image) SetArn(v string) *Image

SetArn sets the Arn field's value.

func (*Image) SetBaseImageArn 

func (s *Image) SetBaseImageArn(v string) *Image

SetBaseImageArn sets the BaseImageArn field's value.

func (*Image) SetCreatedTime 

func (s *Image) SetCreatedTime(v time.Time) *Image

SetCreatedTime sets the CreatedTime field's value.

func (*Image) SetDescription 

func (s *Image) SetDescription(v string) *Image

SetDescription sets the Description field's value.

func (*Image) SetDisplayName 

func (s *Image) SetDisplayName(v string) *Image

SetDisplayName sets the DisplayName field's value.

func (*Image) SetImageBuilderSupported added in v1.8.16 

func (s *Image) SetImageBuilderSupported(v bool) *Image

SetImageBuilderSupported sets the ImageBuilderSupported field's value.

func (*Image) SetName 

func (s *Image) SetName(v string) *Image

SetName sets the Name field's value.

func (*Image) SetPlatform 

func (s *Image) SetPlatform(v string) *Image

SetPlatform sets the Platform field's value.

func (*Image) SetPublicBaseImageReleasedDate added in v1.8.30 

func (s *Image) SetPublicBaseImageReleasedDate(v time.Time) *Image

SetPublicBaseImageReleasedDate sets the PublicBaseImageReleasedDate field's value.

func (*Image) SetState 

func (s *Image) SetState(v string) *Image

SetState sets the State field's value.

func (*Image) SetStateChangeReason 

func (s *Image) SetStateChangeReason(v *ImageStateChangeReason) *Image

SetStateChangeReason sets the StateChangeReason field's value.

func (*Image) SetVisibility 

func (s *Image) SetVisibility(v string) *Image

SetVisibility sets the Visibility field's value.

func (Image) String 

func (s Image) String() string

String returns the string representation

type ImageStateChangeReason 

type ImageStateChangeReason struct {

	// The state change reason code of the image.
	Code *string `type:"string" enum:"ImageStateChangeReasonCode"`

	// The state change reason message to the end user.
	Message *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

The reason why the last state change occurred. Please also see https://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/ImageStateChangeReason

func (ImageStateChangeReason) GoString 

func (s ImageStateChangeReason) GoString() string

GoString returns the string representation

func (*ImageStateChangeReason) SetCode 

func (s *ImageStateChangeReason) SetCode(v string) *ImageStateChangeReason

SetCode sets the Code field's value.

func (*ImageStateChangeReason) SetMessage 

func (s *ImageStateChangeReason) SetMessage(v string) *ImageStateChangeReason

SetMessage sets the Message field's value.

func (ImageStateChangeReason) String 

func (s ImageStateChangeReason) String() string

String returns the string representation

type ListAssociatedFleetsInput 

type ListAssociatedFleetsInput struct {

	// 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 `min:"1" type:"string"`

	// The name of the stack whose associated fleets are listed.
	//
	// StackName is a required field
	StackName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/ListAssociatedFleetsRequest

func (ListAssociatedFleetsInput) GoString 

func (s ListAssociatedFleetsInput) GoString() string

GoString returns the string representation

func (*ListAssociatedFleetsInput) SetNextToken 

func (s *ListAssociatedFleetsInput) SetNextToken(v string) *ListAssociatedFleetsInput

SetNextToken sets the NextToken field's value.

func (*ListAssociatedFleetsInput) SetStackName 

func (s *ListAssociatedFleetsInput) SetStackName(v string) *ListAssociatedFleetsInput

SetStackName sets the StackName field's value.

func (ListAssociatedFleetsInput) String 

func (s ListAssociatedFleetsInput) String() string

String returns the string representation

func (*ListAssociatedFleetsInput) Validate 

func (s *ListAssociatedFleetsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListAssociatedFleetsOutput 

type ListAssociatedFleetsOutput struct {

	// The names of associated fleets.
	Names []*string `type:"list"`

	// 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 `min:"1" type:"string"`
	// contains filtered or unexported fields
}

The response from a successful operation. Please also see https://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/ListAssociatedFleetsResult

func (ListAssociatedFleetsOutput) GoString 

func (s ListAssociatedFleetsOutput) GoString() string

GoString returns the string representation

func (*ListAssociatedFleetsOutput) SetNames 

func (s *ListAssociatedFleetsOutput) SetNames(v []*string) *ListAssociatedFleetsOutput

SetNames sets the Names field's value.

func (*ListAssociatedFleetsOutput) SetNextToken 

func (s *ListAssociatedFleetsOutput) SetNextToken(v string) *ListAssociatedFleetsOutput

SetNextToken sets the NextToken field's value.

func (ListAssociatedFleetsOutput) String 

func (s ListAssociatedFleetsOutput) String() string

String returns the string representation

type ListAssociatedStacksInput 

type ListAssociatedStacksInput struct {

	// The name of the fleet whose associated stacks are listed.
	//
	// FleetName is a required field
	FleetName *string `min:"1" type:"string" required:"true"`

	// 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 `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/ListAssociatedStacksRequest

func (ListAssociatedStacksInput) GoString 

func (s ListAssociatedStacksInput) GoString() string

GoString returns the string representation

func (*ListAssociatedStacksInput) SetFleetName 

func (s *ListAssociatedStacksInput) SetFleetName(v string) *ListAssociatedStacksInput

SetFleetName sets the FleetName field's value.

func (*ListAssociatedStacksInput) SetNextToken 

func (s *ListAssociatedStacksInput) SetNextToken(v string) *ListAssociatedStacksInput

SetNextToken sets the NextToken field's value.

func (ListAssociatedStacksInput) String 

func (s ListAssociatedStacksInput) String() string

String returns the string representation

func (*ListAssociatedStacksInput) Validate 

func (s *ListAssociatedStacksInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListAssociatedStacksOutput 

type ListAssociatedStacksOutput struct {

	// The names of associated stacks.
	Names []*string `type:"list"`

	// 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 `min:"1" type:"string"`
	// contains filtered or unexported fields
}

The response from a successful operation. Please also see https://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/ListAssociatedStacksResult

func (ListAssociatedStacksOutput) GoString 

func (s ListAssociatedStacksOutput) GoString() string

GoString returns the string representation

func (*ListAssociatedStacksOutput) SetNames 

func (s *ListAssociatedStacksOutput) SetNames(v []*string) *ListAssociatedStacksOutput

SetNames sets the Names field's value.

func (*ListAssociatedStacksOutput) SetNextToken 

func (s *ListAssociatedStacksOutput) SetNextToken(v string) *ListAssociatedStacksOutput

SetNextToken sets the NextToken field's value.

func (ListAssociatedStacksOutput) String 

func (s ListAssociatedStacksOutput) String() string

String returns the string representation

type Session 

type Session struct {

	// The authentication method of the user for whom the session was created. It
	// can be API for a user authenticated using a streaming URL or SAML for a SAML
	// federated user.
	AuthenticationType *string `type:"string" enum:"AuthenticationType"`

	// The name of the fleet for which the streaming session was created.
	//
	// FleetName is a required field
	FleetName *string `min:"1" type:"string" required:"true"`

	// The unique ID for a streaming session.
	//
	// Id is a required field
	Id *string `min:"1" type:"string" required:"true"`

	// The name of the stack for which the streaming session was created.
	//
	// StackName is a required field
	StackName *string `min:"1" type:"string" required:"true"`

	// The current state of the streaming session.
	//
	// State is a required field
	State *string `type:"string" required:"true" enum:"SessionState"`

	// The identifier of the user for whom the session was created.
	//
	// UserId is a required field
	UserId *string `min:"2" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains the parameters for a streaming session. Please also see https://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/Session

func (Session) GoString 

func (s Session) GoString() string

GoString returns the string representation

func (*Session) SetAuthenticationType added in v1.8.16 

func (s *Session) SetAuthenticationType(v string) *Session

SetAuthenticationType sets the AuthenticationType field's value.

func (*Session) SetFleetName 

func (s *Session) SetFleetName(v string) *Session

SetFleetName sets the FleetName field's value.

func (*Session) SetId 

func (s *Session) SetId(v string) *Session

SetId sets the Id field's value.

func (*Session) SetStackName 

func (s *Session) SetStackName(v string) *Session

SetStackName sets the StackName field's value.

func (*Session) SetState 

func (s *Session) SetState(v string) *Session

SetState sets the State field's value.

func (*Session) SetUserId 

func (s *Session) SetUserId(v string) *Session

SetUserId sets the UserId field's value.

func (Session) String 

func (s Session) String() string

String returns the string representation

type Stack 

type Stack struct {

	// The ARN of the stack.
	Arn *string `type:"string"`

	// The timestamp when the stack was created.
	CreatedTime *time.Time `type:"timestamp" timestampFormat:"unix"`

	// A meaningful description for the stack.
	Description *string `min:"1" type:"string"`

	// A display name for the stack.
	DisplayName *string `min:"1" type:"string"`

	// The unique identifier of the stack.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

	// The list of errors associated with the stack.
	StackErrors []*StackError `type:"list"`

	// The storage connectors to be enabled for the stack.
	StorageConnectors []*StorageConnector `type:"list"`
	// contains filtered or unexported fields
}

Details about a stack. Please also see https://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/Stack

func (Stack) GoString 

func (s Stack) GoString() string

GoString returns the string representation

func (*Stack) SetArn 

func (s *Stack) SetArn(v string) *Stack

SetArn sets the Arn field's value.

func (*Stack) SetCreatedTime 

func (s *Stack) SetCreatedTime(v time.Time) *Stack

SetCreatedTime sets the CreatedTime field's value.

func (*Stack) SetDescription 

func (s *Stack) SetDescription(v string) *Stack

SetDescription sets the Description field's value.

func (*Stack) SetDisplayName 

func (s *Stack) SetDisplayName(v string) *Stack

SetDisplayName sets the DisplayName field's value.

func (*Stack) SetName 

func (s *Stack) SetName(v string) *Stack

SetName sets the Name field's value.

func (*Stack) SetStackErrors added in v1.8.30 

func (s *Stack) SetStackErrors(v []*StackError) *Stack

SetStackErrors sets the StackErrors field's value.

func (*Stack) SetStorageConnectors added in v1.8.30 

func (s *Stack) SetStorageConnectors(v []*StorageConnector) *Stack

SetStorageConnectors sets the StorageConnectors field's value.

func (Stack) String 

func (s Stack) String() string

String returns the string representation

type StackError added in v1.8.30 

type StackError struct {

	// The error code of a stack error.
	ErrorCode *string `type:"string" enum:"StackErrorCode"`

	// The error message of a stack error.
	ErrorMessage *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Contains the parameters for a stack error. Please also see https://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/StackError

func (StackError) GoString added in v1.8.30 

func (s StackError) GoString() string

GoString returns the string representation

func (*StackError) SetErrorCode added in v1.8.30 

func (s *StackError) SetErrorCode(v string) *StackError

SetErrorCode sets the ErrorCode field's value.

func (*StackError) SetErrorMessage added in v1.8.30 

func (s *StackError) SetErrorMessage(v string) *StackError

SetErrorMessage sets the ErrorMessage field's value.

func (StackError) String added in v1.8.30 

func (s StackError) String() string

String returns the string representation

type StartFleetInput 

type StartFleetInput struct {

	// The name of the fleet to start.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/StartFleetRequest

func (StartFleetInput) GoString 

func (s StartFleetInput) GoString() string

GoString returns the string representation

func (*StartFleetInput) SetName 

func (s *StartFleetInput) SetName(v string) *StartFleetInput

SetName sets the Name field's value.

func (StartFleetInput) String 

func (s StartFleetInput) String() string

String returns the string representation

func (*StartFleetInput) Validate 

func (s *StartFleetInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StartFleetOutput 

type StartFleetOutput struct {
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/StartFleetResult

func (StartFleetOutput) GoString 

func (s StartFleetOutput) GoString() string

GoString returns the string representation

func (StartFleetOutput) String 

func (s StartFleetOutput) String() string

String returns the string representation

type StopFleetInput 

type StopFleetInput struct {

	// The name of the fleet to stop.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/StopFleetRequest

func (StopFleetInput) GoString 

func (s StopFleetInput) GoString() string

GoString returns the string representation

func (*StopFleetInput) SetName 

func (s *StopFleetInput) SetName(v string) *StopFleetInput

SetName sets the Name field's value.

func (StopFleetInput) String 

func (s StopFleetInput) String() string

String returns the string representation

func (*StopFleetInput) Validate 

func (s *StopFleetInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StopFleetOutput 

type StopFleetOutput struct {
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/StopFleetResult

func (StopFleetOutput) GoString 

func (s StopFleetOutput) GoString() string

GoString returns the string representation

func (StopFleetOutput) String 

func (s StopFleetOutput) String() string

String returns the string representation

type StorageConnector added in v1.8.30 

type StorageConnector struct {

	// The type of storage connector. The possible values include: HOMEFOLDERS.
	//
	// ConnectorType is a required field
	ConnectorType *string `type:"string" required:"true" enum:"StorageConnectorType"`

	// The ARN associated with the storage connector.
	ResourceIdentifier *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Contains the parameters for a storage connector. Please also see https://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/StorageConnector

func (StorageConnector) GoString added in v1.8.30 

func (s StorageConnector) GoString() string

GoString returns the string representation

func (*StorageConnector) SetConnectorType added in v1.8.30 

func (s *StorageConnector) SetConnectorType(v string) *StorageConnector

SetConnectorType sets the ConnectorType field's value.

func (*StorageConnector) SetResourceIdentifier added in v1.8.30 

func (s *StorageConnector) SetResourceIdentifier(v string) *StorageConnector

SetResourceIdentifier sets the ResourceIdentifier field's value.

func (StorageConnector) String added in v1.8.30 

func (s StorageConnector) String() string

String returns the string representation

func (*StorageConnector) Validate added in v1.8.30 

func (s *StorageConnector) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateFleetInput 

type UpdateFleetInput struct {

	// Fleet attributes to be deleted.
	AttributesToDelete []*string `type:"list"`

	// The parameters for the capacity allocated to the fleet.
	ComputeCapacity *ComputeCapacity `type:"structure"`

	// Delete the VPC association for the specified fleet.
	DeleteVpcConfig *bool `deprecated:"true" type:"boolean"`

	// The description displayed to end users on the AppStream 2.0 portal.
	Description *string `type:"string"`

	// The time after disconnection when a session is considered to have ended.
	// If a user who got disconnected reconnects within this timeout interval, the
	// user is connected back to their previous session. The input can be any numeric
	// value in seconds between 60 and 57600.
	DisconnectTimeoutInSeconds *int64 `type:"integer"`

	// The name displayed to end users on the AppStream 2.0 portal.
	DisplayName *string `type:"string"`

	// Enables or disables default Internet access for the fleet.
	EnableDefaultInternetAccess *bool `type:"boolean"`

	// The image name from which a fleet is created.
	ImageName *string `min:"1" type:"string"`

	// The instance type of compute resources for the fleet. Fleet instances are
	// launched from this instance type.
	InstanceType *string `min:"1" type:"string"`

	// The maximum time for which a streaming session can run. The input can be
	// any numeric value in seconds between 600 and 57600.
	MaxUserDurationInSeconds *int64 `type:"integer"`

	// The name of the fleet.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

	// The VPC configuration for the fleet.
	VpcConfig *VpcConfig `type:"structure"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/UpdateFleetRequest

func (UpdateFleetInput) GoString 

func (s UpdateFleetInput) GoString() string

GoString returns the string representation

func (*UpdateFleetInput) SetAttributesToDelete added in v1.8.35 

func (s *UpdateFleetInput) SetAttributesToDelete(v []*string) *UpdateFleetInput

SetAttributesToDelete sets the AttributesToDelete field's value.

func (*UpdateFleetInput) SetComputeCapacity 

func (s *UpdateFleetInput) SetComputeCapacity(v *ComputeCapacity) *UpdateFleetInput

SetComputeCapacity sets the ComputeCapacity field's value.

func (*UpdateFleetInput) SetDeleteVpcConfig 

func (s *UpdateFleetInput) SetDeleteVpcConfig(v bool) *UpdateFleetInput

SetDeleteVpcConfig sets the DeleteVpcConfig field's value.

func (*UpdateFleetInput) SetDescription 

func (s *UpdateFleetInput) SetDescription(v string) *UpdateFleetInput

SetDescription sets the Description field's value.

func (*UpdateFleetInput) SetDisconnectTimeoutInSeconds 

func (s *UpdateFleetInput) SetDisconnectTimeoutInSeconds(v int64) *UpdateFleetInput

SetDisconnectTimeoutInSeconds sets the DisconnectTimeoutInSeconds field's value.

func (*UpdateFleetInput) SetDisplayName 

func (s *UpdateFleetInput) SetDisplayName(v string) *UpdateFleetInput

SetDisplayName sets the DisplayName field's value.

func (*UpdateFleetInput) SetEnableDefaultInternetAccess added in v1.8.16 

func (s *UpdateFleetInput) SetEnableDefaultInternetAccess(v bool) *UpdateFleetInput

SetEnableDefaultInternetAccess sets the EnableDefaultInternetAccess field's value.

func (*UpdateFleetInput) SetImageName 

func (s *UpdateFleetInput) SetImageName(v string) *UpdateFleetInput

SetImageName sets the ImageName field's value.

func (*UpdateFleetInput) SetInstanceType 

func (s *UpdateFleetInput) SetInstanceType(v string) *UpdateFleetInput

SetInstanceType sets the InstanceType field's value.

func (*UpdateFleetInput) SetMaxUserDurationInSeconds 

func (s *UpdateFleetInput) SetMaxUserDurationInSeconds(v int64) *UpdateFleetInput

SetMaxUserDurationInSeconds sets the MaxUserDurationInSeconds field's value.

func (*UpdateFleetInput) SetName 

func (s *UpdateFleetInput) SetName(v string) *UpdateFleetInput

SetName sets the Name field's value.

func (*UpdateFleetInput) SetVpcConfig 

func (s *UpdateFleetInput) SetVpcConfig(v *VpcConfig) *UpdateFleetInput

SetVpcConfig sets the VpcConfig field's value.

func (UpdateFleetInput) String 

func (s UpdateFleetInput) String() string

String returns the string representation

func (*UpdateFleetInput) Validate 

func (s *UpdateFleetInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateFleetOutput 

type UpdateFleetOutput struct {

	// A list of fleet details.
	Fleet *Fleet `type:"structure"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/UpdateFleetResult

func (UpdateFleetOutput) GoString 

func (s UpdateFleetOutput) GoString() string

GoString returns the string representation

func (*UpdateFleetOutput) SetFleet 

func (s *UpdateFleetOutput) SetFleet(v *Fleet) *UpdateFleetOutput

SetFleet sets the Fleet field's value.

func (UpdateFleetOutput) String 

func (s UpdateFleetOutput) String() string

String returns the string representation

type UpdateStackInput 

type UpdateStackInput struct {

	// Remove all the storage connectors currently enabled for the stack.
	DeleteStorageConnectors *bool `type:"boolean"`

	// The description displayed to end users on the AppStream 2.0 portal.
	Description *string `type:"string"`

	// The name displayed to end users on the AppStream 2.0 portal.
	DisplayName *string `type:"string"`

	// The name of the stack to update.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

	// The storage connectors to be enabled for the stack.
	StorageConnectors []*StorageConnector `type:"list"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/UpdateStackRequest

func (UpdateStackInput) GoString 

func (s UpdateStackInput) GoString() string

GoString returns the string representation

func (*UpdateStackInput) SetDeleteStorageConnectors added in v1.8.30 

func (s *UpdateStackInput) SetDeleteStorageConnectors(v bool) *UpdateStackInput

SetDeleteStorageConnectors sets the DeleteStorageConnectors field's value.

func (*UpdateStackInput) SetDescription 

func (s *UpdateStackInput) SetDescription(v string) *UpdateStackInput

SetDescription sets the Description field's value.

func (*UpdateStackInput) SetDisplayName 

func (s *UpdateStackInput) SetDisplayName(v string) *UpdateStackInput

SetDisplayName sets the DisplayName field's value.

func (*UpdateStackInput) SetName 

func (s *UpdateStackInput) SetName(v string) *UpdateStackInput

SetName sets the Name field's value.

func (*UpdateStackInput) SetStorageConnectors added in v1.8.30 

func (s *UpdateStackInput) SetStorageConnectors(v []*StorageConnector) *UpdateStackInput

SetStorageConnectors sets the StorageConnectors field's value.

func (UpdateStackInput) String 

func (s UpdateStackInput) String() string

String returns the string representation

func (*UpdateStackInput) Validate 

func (s *UpdateStackInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateStackOutput 

type UpdateStackOutput struct {

	// A list of stack details.
	Stack *Stack `type:"structure"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/UpdateStackResult

func (UpdateStackOutput) GoString 

func (s UpdateStackOutput) GoString() string

GoString returns the string representation

func (*UpdateStackOutput) SetStack 

func (s *UpdateStackOutput) SetStack(v *Stack) *UpdateStackOutput

SetStack sets the Stack field's value.

func (UpdateStackOutput) String 

func (s UpdateStackOutput) String() string

String returns the string representation

type VpcConfig 

type VpcConfig struct {

	// Security groups associated with the fleet.
	SecurityGroupIds []*string `type:"list"`

	// The list of subnets to which a network interface is established from the
	// fleet instance.
	SubnetIds []*string `type:"list"`
	// contains filtered or unexported fields
}

VPC configuration information. Please also see https://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/VpcConfig

func (VpcConfig) GoString 

func (s VpcConfig) GoString() string

GoString returns the string representation

func (*VpcConfig) SetSecurityGroupIds added in v1.8.35 

func (s *VpcConfig) SetSecurityGroupIds(v []*string) *VpcConfig

SetSecurityGroupIds sets the SecurityGroupIds field's value.

func (*VpcConfig) SetSubnetIds 

func (s *VpcConfig) SetSubnetIds(v []*string) *VpcConfig

SetSubnetIds sets the SubnetIds field's value.

func (VpcConfig) String 

func (s VpcConfig) String() string

String returns the string representation

Source Files

View all Source files

Directories

Path Synopsis
Package appstreamiface provides an interface to enable mocking the Amazon AppStream service client for testing your code.
 Package appstreamiface provides an interface to enable mocking the Amazon AppStream service client for testing your code.

Jump to

Keyboard shortcuts

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