workspacesinstances

package module
v1.0.1 Latest Latest
Warning

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

 Go to latest Published: Jul 19, 2025 License: Apache-2.0 Imports: 45 Imported by: 0

Documentation

Overview

Package workspacesinstances provides the API client, operations, and parameter types for Amazon Workspaces Instances.

Amazon WorkSpaces Instances provides an API framework for managing virtual workspace environments across multiple AWS regions, enabling programmatic creation and configuration of desktop infrastructure.

Index

Constants

View Source 
const ServiceAPIVersion = "2022-07-26"
View Source 
const ServiceID = "Workspaces Instances"

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver 

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions 

func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

WithAPIOptions returns a functional option for setting the Client's APIOptions option.

func WithEndpointResolver deprecated 

func WithEndpointResolver(v EndpointResolver) func(*Options)

Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for this field will likely prevent you from using any endpoint-related service features released after the introduction of EndpointResolverV2 and BaseEndpoint.

To migrate an EndpointResolver implementation that uses a custom endpoint, set the client option BaseEndpoint instead.

func WithEndpointResolverV2 

func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)

WithEndpointResolverV2 returns a functional option for setting the Client's EndpointResolverV2 option.

func WithSigV4SigningName 

func WithSigV4SigningName(name string) func(*Options)

WithSigV4SigningName applies an override to the authentication workflow to use the given signing name for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing name from both auth scheme resolution and endpoint resolution.

func WithSigV4SigningRegion 

func WithSigV4SigningRegion(region string) func(*Options)

WithSigV4SigningRegion applies an override to the authentication workflow to use the given signing region for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing region from both auth scheme resolution and endpoint resolution.

Types

type AssociateVolumeInput 

type AssociateVolumeInput struct {

	// Device path for volume attachment.
	//
	// This member is required.
	Device *string

	// Volume to be attached.
	//
	// This member is required.
	VolumeId *string

	// WorkSpace Instance to attach volume to.
	//
	// This member is required.
	WorkspaceInstanceId *string
	// contains filtered or unexported fields
}

Specifies volume attachment parameters.

type AssociateVolumeOutput 

type AssociateVolumeOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Confirms volume attachment.

type AuthResolverParameters 

type AuthResolverParameters struct {
	// The name of the operation being invoked.
	Operation string

	// The region in which the operation is being invoked.
	Region string
}

AuthResolverParameters contains the set of inputs necessary for auth scheme resolution.

type AuthSchemeResolver 

type AuthSchemeResolver interface {
	ResolveAuthSchemes(context.Context, *AuthResolverParameters) ([]*smithyauth.Option, error)
}

AuthSchemeResolver returns a set of possible authentication options for an operation.

type Client 

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

Client provides the API client to make operations call for Amazon Workspaces Instances.

func New 

func New(options Options, optFns ...func(*Options)) *Client

New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

func NewFromConfig 

func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

NewFromConfig returns a new client from the provided config.

func (*Client) AssociateVolume 

func (c *Client) AssociateVolume(ctx context.Context, params *AssociateVolumeInput, optFns ...func(*Options)) (*AssociateVolumeOutput, error)

Attaches a volume to a WorkSpace Instance.

func (*Client) CreateVolume 

func (c *Client) CreateVolume(ctx context.Context, params *CreateVolumeInput, optFns ...func(*Options)) (*CreateVolumeOutput, error)

Creates a new volume for WorkSpace Instances.

func (*Client) CreateWorkspaceInstance 

func (c *Client) CreateWorkspaceInstance(ctx context.Context, params *CreateWorkspaceInstanceInput, optFns ...func(*Options)) (*CreateWorkspaceInstanceOutput, error)

Launches a new WorkSpace Instance with specified configuration parameters, enabling programmatic workspace deployment.

func (*Client) DeleteVolume 

func (c *Client) DeleteVolume(ctx context.Context, params *DeleteVolumeInput, optFns ...func(*Options)) (*DeleteVolumeOutput, error)

Deletes a specified volume.

func (*Client) DeleteWorkspaceInstance 

func (c *Client) DeleteWorkspaceInstance(ctx context.Context, params *DeleteWorkspaceInstanceInput, optFns ...func(*Options)) (*DeleteWorkspaceInstanceOutput, error)

Deletes the specified WorkSpace

func (*Client) DisassociateVolume 

func (c *Client) DisassociateVolume(ctx context.Context, params *DisassociateVolumeInput, optFns ...func(*Options)) (*DisassociateVolumeOutput, error)

Detaches a volume from a WorkSpace Instance.

func (*Client) GetWorkspaceInstance 

func (c *Client) GetWorkspaceInstance(ctx context.Context, params *GetWorkspaceInstanceInput, optFns ...func(*Options)) (*GetWorkspaceInstanceOutput, error)

Retrieves detailed information about a specific WorkSpace Instance.

func (*Client) ListInstanceTypes 

func (c *Client) ListInstanceTypes(ctx context.Context, params *ListInstanceTypesInput, optFns ...func(*Options)) (*ListInstanceTypesOutput, error)

Retrieves a list of instance types supported by Amazon WorkSpaces Instances, enabling precise workspace infrastructure configuration.

func (*Client) ListRegions 

func (c *Client) ListRegions(ctx context.Context, params *ListRegionsInput, optFns ...func(*Options)) (*ListRegionsOutput, error)

Retrieves a list of AWS regions supported by Amazon WorkSpaces Instances, enabling region discovery for workspace deployments.

func (*Client) ListTagsForResource 

func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)

Retrieves tags for a WorkSpace Instance.

func (*Client) ListWorkspaceInstances 

func (c *Client) ListWorkspaceInstances(ctx context.Context, params *ListWorkspaceInstancesInput, optFns ...func(*Options)) (*ListWorkspaceInstancesOutput, error)

Retrieves a collection of WorkSpaces Instances based on specified filters.

func (*Client) Options 

func (c *Client) Options() Options

Options returns a copy of the client configuration.

Callers SHOULD NOT perform mutations on any inner structures within client config. Config overrides should instead be made on a per-operation basis through functional options.

func (*Client) TagResource 

func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)

Adds tags to a WorkSpace Instance.

func (*Client) UntagResource 

func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)

Removes tags from a WorkSpace Instance.

type CreateVolumeInput 

type CreateVolumeInput struct {

	// Availability zone for the volume.
	//
	// This member is required.
	AvailabilityZone *string

	// Unique token to prevent duplicate volume creation.
	ClientToken *string

	// Indicates if the volume should be encrypted.
	Encrypted *bool

	// Input/output operations per second for the volume.
	Iops *int32

	// KMS key for volume encryption.
	KmsKeyId *string

	// Volume size in gigabytes.
	SizeInGB *int32

	// Source snapshot for volume creation.
	SnapshotId *string

	// Metadata tags for the volume.
	TagSpecifications []types.TagSpecification

	// Volume throughput performance.
	Throughput *int32

	// Type of EBS volume.
	VolumeType types.VolumeTypeEnum
	// contains filtered or unexported fields
}

Specifies volume creation parameters.

type CreateVolumeOutput 

type CreateVolumeOutput struct {

	// Unique identifier for the new volume.
	VolumeId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Returns the created volume identifier.

type CreateWorkspaceInstanceInput 

type CreateWorkspaceInstanceInput struct {

	// Comprehensive configuration settings for the WorkSpaces Instance, including
	// network, compute, and storage parameters.
	//
	// This member is required.
	ManagedInstance *types.ManagedInstanceRequest

	// Unique token to ensure idempotent instance creation, preventing duplicate
	// workspace launches.
	ClientToken *string

	// Optional metadata tags for categorizing and managing WorkSpaces Instances.
	Tags []types.Tag
	// contains filtered or unexported fields
}

Defines the configuration parameters for creating a new WorkSpaces Instance.

type CreateWorkspaceInstanceOutput 

type CreateWorkspaceInstanceOutput struct {

	// Unique identifier assigned to the newly created WorkSpaces Instance.
	WorkspaceInstanceId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Returns the unique identifier for the newly created WorkSpaces Instance.

type DeleteVolumeInput 

type DeleteVolumeInput struct {

	// Identifier of the volume to delete.
	//
	// This member is required.
	VolumeId *string
	// contains filtered or unexported fields
}

Specifies the volume to delete.

type DeleteVolumeOutput 

type DeleteVolumeOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Confirms volume deletion.

type DeleteWorkspaceInstanceInput 

type DeleteWorkspaceInstanceInput struct {

	// Unique identifier of the WorkSpaces Instance targeted for deletion.
	//
	// This member is required.
	WorkspaceInstanceId *string
	// contains filtered or unexported fields
}

The WorkSpace to delete

type DeleteWorkspaceInstanceOutput 

type DeleteWorkspaceInstanceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Confirms the successful deletion of the specified WorkSpace Instance.

type DisassociateVolumeInput 

type DisassociateVolumeInput struct {

	// Volume to be detached.
	//
	// This member is required.
	VolumeId *string

	// WorkSpace Instance to detach volume from.
	//
	// This member is required.
	WorkspaceInstanceId *string

	// Device path of volume to detach.
	Device *string

	// Mode for volume detachment.
	DisassociateMode types.DisassociateModeEnum
	// contains filtered or unexported fields
}

Specifies volume detachment parameters.

type DisassociateVolumeOutput 

type DisassociateVolumeOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Confirms volume detachment.

type EndpointParameters 

type EndpointParameters struct {
	// When true, send this request to the FIPS-compliant regional endpoint. If the
	// configured endpoint does not have a FIPS compliant endpoint, dispatching the
	// request will return an error.
	//
	// Defaults to false if no value is
	// provided.
	//
	// AWS::UseFIPS
	UseFIPS *bool

	// Override the endpoint used to send this request
	//
	// Parameter is
	// required.
	//
	// SDK::Endpoint
	Endpoint *string

	// The AWS region used to dispatch the request.
	//
	// Parameter is
	// required.
	//
	// AWS::Region
	Region *string
}

EndpointParameters provides the parameters that influence how endpoints are resolved.

func (EndpointParameters) ValidateRequired 

func (p EndpointParameters) ValidateRequired() error

ValidateRequired validates required parameters are set.

func (EndpointParameters) WithDefaults 

func (p EndpointParameters) WithDefaults() EndpointParameters

WithDefaults returns a shallow copy of EndpointParameterswith default values applied to members where applicable.

type EndpointResolver 

type EndpointResolver interface {
	ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}

EndpointResolver interface for resolving service endpoints.

func EndpointResolverFromURL 

func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

type EndpointResolverFunc 

type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)

EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

func (EndpointResolverFunc) ResolveEndpoint 

func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)

type EndpointResolverOptions 

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type EndpointResolverV2 

type EndpointResolverV2 interface {
	// ResolveEndpoint attempts to resolve the endpoint with the provided options,
	// returning the endpoint if found. Otherwise an error is returned.
	ResolveEndpoint(ctx context.Context, params EndpointParameters) (
		smithyendpoints.Endpoint, error,
	)
}

EndpointResolverV2 provides the interface for resolving service endpoints.

func NewDefaultEndpointResolverV2 

func NewDefaultEndpointResolverV2() EndpointResolverV2

type GetWorkspaceInstanceInput 

type GetWorkspaceInstanceInput struct {

	// Unique identifier of the WorkSpace Instance to retrieve.
	//
	// This member is required.
	WorkspaceInstanceId *string
	// contains filtered or unexported fields
}

Identifies the WorkSpaces Instance to retrieve detailed information for.

type GetWorkspaceInstanceOutput 

type GetWorkspaceInstanceOutput struct {

	// Includes any underlying EC2 instance errors encountered.
	EC2InstanceErrors []types.EC2InstanceError

	// Details of the associated EC2 managed instance.
	EC2ManagedInstance *types.EC2ManagedInstance

	// Current provisioning state of the WorkSpaces Instance.
	ProvisionState types.ProvisionStateEnum

	// Captures any errors specific to the WorkSpace Instance lifecycle.
	WorkspaceInstanceErrors []types.WorkspaceInstanceError

	// Unique identifier of the retrieved WorkSpaces Instance.
	WorkspaceInstanceId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Provides comprehensive details about the requested WorkSpaces Instance.

type HTTPClient 

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

type HTTPSignerV4 

type HTTPSignerV4 interface {
	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error
}

type IdempotencyTokenProvider 

type IdempotencyTokenProvider interface {
	GetIdempotencyToken() (string, error)
}

IdempotencyTokenProvider interface for providing idempotency token

type ListInstanceTypesAPIClient 

type ListInstanceTypesAPIClient interface {
	ListInstanceTypes(context.Context, *ListInstanceTypesInput, ...func(*Options)) (*ListInstanceTypesOutput, error)
}

ListInstanceTypesAPIClient is a client that implements the ListInstanceTypes operation.

type ListInstanceTypesInput 

type ListInstanceTypesInput struct {

	// Maximum number of instance types to return in a single API call. Enables
	// pagination of instance type results.
	MaxResults *int32

	// Pagination token for retrieving subsequent pages of instance type results.
	NextToken *string
	// contains filtered or unexported fields
}

Defines input parameters for retrieving supported WorkSpaces Instances instance types.

type ListInstanceTypesOutput 

type ListInstanceTypesOutput struct {

	// Collection of supported instance types for WorkSpaces Instances.
	//
	// This member is required.
	InstanceTypes []types.InstanceTypeInfo

	// Token for retrieving additional instance types if the result set is paginated.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Contains the list of instance types supported by WorkSpaces Instances.

type ListInstanceTypesPaginator 

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

ListInstanceTypesPaginator is a paginator for ListInstanceTypes

func NewListInstanceTypesPaginator 

func NewListInstanceTypesPaginator(client ListInstanceTypesAPIClient, params *ListInstanceTypesInput, optFns ...func(*ListInstanceTypesPaginatorOptions)) *ListInstanceTypesPaginator

NewListInstanceTypesPaginator returns a new ListInstanceTypesPaginator

func (*ListInstanceTypesPaginator) HasMorePages 

func (p *ListInstanceTypesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListInstanceTypesPaginator) NextPage 

func (p *ListInstanceTypesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListInstanceTypesOutput, error)

NextPage retrieves the next ListInstanceTypes page.

type ListInstanceTypesPaginatorOptions 

type ListInstanceTypesPaginatorOptions struct {
	// Maximum number of instance types to return in a single API call. Enables
	// pagination of instance type results.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListInstanceTypesPaginatorOptions is the paginator options for ListInstanceTypes

type ListRegionsAPIClient 

type ListRegionsAPIClient interface {
	ListRegions(context.Context, *ListRegionsInput, ...func(*Options)) (*ListRegionsOutput, error)
}

ListRegionsAPIClient is a client that implements the ListRegions operation.

type ListRegionsInput 

type ListRegionsInput struct {

	// Maximum number of regions to return in a single API call. Enables pagination of
	// region results.
	MaxResults *int32

	// Pagination token for retrieving subsequent pages of region results.
	NextToken *string
	// contains filtered or unexported fields
}

Defines input parameters for retrieving supported WorkSpaces Instances regions.

type ListRegionsOutput 

type ListRegionsOutput struct {

	// Collection of AWS regions supported by WorkSpaces Instances.
	//
	// This member is required.
	Regions []types.Region

	// Token for retrieving additional regions if the result set is paginated.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Contains the list of supported AWS regions for WorkSpaces Instances.

type ListRegionsPaginator 

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

ListRegionsPaginator is a paginator for ListRegions

func NewListRegionsPaginator 

func NewListRegionsPaginator(client ListRegionsAPIClient, params *ListRegionsInput, optFns ...func(*ListRegionsPaginatorOptions)) *ListRegionsPaginator

NewListRegionsPaginator returns a new ListRegionsPaginator

func (*ListRegionsPaginator) HasMorePages 

func (p *ListRegionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListRegionsPaginator) NextPage 

func (p *ListRegionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListRegionsOutput, error)

NextPage retrieves the next ListRegions page.

type ListRegionsPaginatorOptions 

type ListRegionsPaginatorOptions struct {
	// Maximum number of regions to return in a single API call. Enables pagination of
	// region results.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListRegionsPaginatorOptions is the paginator options for ListRegions

type ListTagsForResourceInput 

type ListTagsForResourceInput struct {

	// Unique identifier of the WorkSpace Instance.
	//
	// This member is required.
	WorkspaceInstanceId *string
	// contains filtered or unexported fields
}

Specifies the WorkSpace Instance to retrieve tags for.

type ListTagsForResourceOutput 

type ListTagsForResourceOutput struct {

	// Collection of tags associated with the WorkSpace Instance.
	Tags []types.Tag

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Returns the list of tags for the specified WorkSpace Instance.

type ListWorkspaceInstancesAPIClient 

type ListWorkspaceInstancesAPIClient interface {
	ListWorkspaceInstances(context.Context, *ListWorkspaceInstancesInput, ...func(*Options)) (*ListWorkspaceInstancesOutput, error)
}

ListWorkspaceInstancesAPIClient is a client that implements the ListWorkspaceInstances operation.

type ListWorkspaceInstancesInput 

type ListWorkspaceInstancesInput struct {

	// Maximum number of WorkSpaces Instances to return in a single response.
	MaxResults *int32

	// Pagination token for retrieving subsequent pages of WorkSpaces Instances.
	NextToken *string

	// Filter WorkSpaces Instances by their current provisioning states.
	ProvisionStates []types.ProvisionStateEnum
	// contains filtered or unexported fields
}

Defines filters and pagination parameters for retrieving WorkSpaces Instances.

type ListWorkspaceInstancesOutput 

type ListWorkspaceInstancesOutput struct {

	// Collection of WorkSpaces Instances returned by the query.
	//
	// This member is required.
	WorkspaceInstances []types.WorkspaceInstance

	// Token for retrieving additional WorkSpaces Instances if the result set is
	// paginated.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Contains the list of WorkSpaces Instances matching the specified criteria.

type ListWorkspaceInstancesPaginator 

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

ListWorkspaceInstancesPaginator is a paginator for ListWorkspaceInstances

func NewListWorkspaceInstancesPaginator 

func NewListWorkspaceInstancesPaginator(client ListWorkspaceInstancesAPIClient, params *ListWorkspaceInstancesInput, optFns ...func(*ListWorkspaceInstancesPaginatorOptions)) *ListWorkspaceInstancesPaginator

NewListWorkspaceInstancesPaginator returns a new ListWorkspaceInstancesPaginator

func (*ListWorkspaceInstancesPaginator) HasMorePages 

func (p *ListWorkspaceInstancesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListWorkspaceInstancesPaginator) NextPage 

func (p *ListWorkspaceInstancesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListWorkspaceInstancesOutput, error)

NextPage retrieves the next ListWorkspaceInstances page.

type ListWorkspaceInstancesPaginatorOptions 

type ListWorkspaceInstancesPaginatorOptions struct {
	// Maximum number of WorkSpaces Instances to return in a single response.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListWorkspaceInstancesPaginatorOptions is the paginator options for ListWorkspaceInstances

type Options 

type Options struct {
	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	APIOptions []func(*middleware.Stack) error

	// The optional application specific identifier appended to the User-Agent header.
	AppID string

	// This endpoint will be given as input to an EndpointResolverV2. It is used for
	// providing a custom base endpoint that is subject to modifications by the
	// processing EndpointResolverV2.
	BaseEndpoint *string

	// Configures the events that will be sent to the configured logger.
	ClientLogMode aws.ClientLogMode

	// The credentials object to use when signing requests.
	Credentials aws.CredentialsProvider

	// The configuration DefaultsMode that the SDK should use when constructing the
	// clients initial default settings.
	DefaultsMode aws.DefaultsMode

	// The endpoint options to be used when attempting to resolve an endpoint.
	EndpointOptions EndpointResolverOptions

	// The service endpoint resolver.
	//
	// Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a
	// value for this field will likely prevent you from using any endpoint-related
	// service features released after the introduction of EndpointResolverV2 and
	// BaseEndpoint.
	//
	// To migrate an EndpointResolver implementation that uses a custom endpoint, set
	// the client option BaseEndpoint instead.
	EndpointResolver EndpointResolver

	// Resolves the endpoint used for a particular service operation. This should be
	// used over the deprecated EndpointResolver.
	EndpointResolverV2 EndpointResolverV2

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// Provides idempotency tokens values that will be automatically populated into
	// idempotent API operations.
	IdempotencyTokenProvider IdempotencyTokenProvider

	// The logger writer interface to write logging messages to.
	Logger logging.Logger

	// The client meter provider.
	MeterProvider metrics.MeterProvider

	// The region to send requests to. (Required)
	Region string

	// RetryMaxAttempts specifies the maximum number attempts an API client will call
	// an operation that fails with a retryable error. A value of 0 is ignored, and
	// will not be used to configure the API client created default retryer, or modify
	// per operation call's retry max attempts.
	//
	// If specified in an operation call's functional options with a value that is
	// different than the constructed client's Options, the Client's Retryer will be
	// wrapped to use the operation's specific RetryMaxAttempts value.
	RetryMaxAttempts int

	// RetryMode specifies the retry mode the API client will be created with, if
	// Retryer option is not also specified.
	//
	// When creating a new API Clients this member will only be used if the Retryer
	// Options member is nil. This value will be ignored if Retryer is not nil.
	//
	// Currently does not support per operation call overrides, may in the future.
	RetryMode aws.RetryMode

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer. The kind of
	// default retry created by the API client can be changed with the RetryMode
	// option.
	Retryer aws.Retryer

	// The RuntimeEnvironment configuration, only populated if the DefaultsMode is set
	// to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You
	// should not populate this structure programmatically, or rely on the values here
	// within your applications.
	RuntimeEnvironment aws.RuntimeEnvironment

	// The client tracer provider.
	TracerProvider tracing.TracerProvider

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient

	// The auth scheme resolver which determines how to authenticate for each
	// operation.
	AuthSchemeResolver AuthSchemeResolver

	// The list of auth schemes supported by the client.
	AuthSchemes []smithyhttp.AuthScheme
	// contains filtered or unexported fields
}

func (Options) Copy 

func (o Options) Copy() Options

Copy creates a clone where the APIOptions list is deep copied.

func (Options) GetIdentityResolver 

func (o Options) GetIdentityResolver(schemeID string) smithyauth.IdentityResolver

type ResolveEndpoint 

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

func (*ResolveEndpoint) HandleSerialize 

func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) (
	out middleware.SerializeOutput, metadata middleware.Metadata, err error,
)

func (*ResolveEndpoint) ID 

func (*ResolveEndpoint) ID() string

type TagResourceInput 

type TagResourceInput struct {

	// Tags to be added to the WorkSpace Instance.
	//
	// This member is required.
	Tags []types.Tag

	// Unique identifier of the WorkSpace Instance to tag.
	//
	// This member is required.
	WorkspaceInstanceId *string
	// contains filtered or unexported fields
}

Specifies tags to add to a WorkSpace Instance.

type TagResourceOutput 

type TagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Confirms successful tag addition.

type UntagResourceInput 

type UntagResourceInput struct {

	// Keys of tags to be removed.
	//
	// This member is required.
	TagKeys []string

	// Unique identifier of the WorkSpace Instance to untag.
	//
	// This member is required.
	WorkspaceInstanceId *string
	// contains filtered or unexported fields
}

Specifies tags to remove from a WorkSpace Instance.

type UntagResourceOutput 

type UntagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Confirms successful tag removal.

Source Files

View all Source files

Directories

Path Synopsis
internal
endpoints

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.