nimble

package module
v1.24.4 Latest Latest
Warning

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

 Go to latest Published: Mar 29, 2024 License: Apache-2.0 Imports: 42 Imported by: 2

Documentation

Overview

Package nimble provides the API client, operations, and parameter types for AmazonNimbleStudio.

Welcome to the Amazon Nimble Studio API reference. This API reference provides methods, schema, resources, parameters, and more to help you get the most out of Nimble Studio. Nimble Studio is a virtual studio that empowers visual effects, animation, and interactive content teams to create content securely within a scalable, private cloud service.

Index

Constants

View Source 
const ServiceAPIVersion = "2020-08-01"
View Source 
const ServiceID = "nimble"

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 added in v1.17.0 

func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)

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

func WithSigV4SigningName added in v1.20.2 

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 added in v1.20.2 

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 AcceptEulasInput 

type AcceptEulasInput struct {

	// The studio ID.
	//
	// This member is required.
	StudioId *string

	// Unique, case-sensitive identifier that you provide to ensure the idempotency of
	// the request. If you don’t specify a client token, the Amazon Web Services SDK
	// automatically generates a client token and uses it for the request to ensure
	// idempotency.
	ClientToken *string

	// The EULA ID.
	EulaIds []string
	// contains filtered or unexported fields
}

type AcceptEulasOutput 

type AcceptEulasOutput struct {

	// A collection of EULA acceptances.
	EulaAcceptances []types.EulaAcceptance

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

type AuthResolverParameters added in v1.20.2 

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 added in v1.20.2 

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 AmazonNimbleStudio.

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) AcceptEulas 

func (c *Client) AcceptEulas(ctx context.Context, params *AcceptEulasInput, optFns ...func(*Options)) (*AcceptEulasOutput, error)

Accept EULAs.

func (*Client) CreateLaunchProfile 

func (c *Client) CreateLaunchProfile(ctx context.Context, params *CreateLaunchProfileInput, optFns ...func(*Options)) (*CreateLaunchProfileOutput, error)

Create a launch profile.

func (*Client) CreateStreamingImage 

func (c *Client) CreateStreamingImage(ctx context.Context, params *CreateStreamingImageInput, optFns ...func(*Options)) (*CreateStreamingImageOutput, error)

Creates a streaming image resource in a studio.

func (*Client) CreateStreamingSession 

func (c *Client) CreateStreamingSession(ctx context.Context, params *CreateStreamingSessionInput, optFns ...func(*Options)) (*CreateStreamingSessionOutput, error)

Creates a streaming session in a studio. After invoking this operation, you must poll GetStreamingSession until the streaming session is in the READY state.

func (*Client) CreateStreamingSessionStream 

func (c *Client) CreateStreamingSessionStream(ctx context.Context, params *CreateStreamingSessionStreamInput, optFns ...func(*Options)) (*CreateStreamingSessionStreamOutput, error)

Creates a streaming session stream for a streaming session. After invoking this API, invoke GetStreamingSessionStream with the returned streamId to poll the resource until it is in the READY state.

func (*Client) CreateStudio 

func (c *Client) CreateStudio(ctx context.Context, params *CreateStudioInput, optFns ...func(*Options)) (*CreateStudioOutput, error)

Create a new studio. When creating a studio, two IAM roles must be provided: the admin role and the user role. These roles are assumed by your users when they log in to the Nimble Studio portal. The user role must have the AmazonNimbleStudio-StudioUser managed policy attached for the portal to function properly. The admin role must have the AmazonNimbleStudio-StudioAdmin managed policy attached for the portal to function properly. You may optionally specify a KMS key in the StudioEncryptionConfiguration . In Nimble Studio, resource names, descriptions, initialization scripts, and other data you provide are always encrypted at rest using an KMS key. By default, this key is owned by Amazon Web Services and managed on your behalf. You may provide your own KMS key when calling CreateStudio to encrypt this data using a key you own and manage. When providing an KMS key during studio creation, Nimble Studio creates KMS grants in your account to provide your studio user and admin roles access to these KMS keys. If you delete this grant, the studio will no longer be accessible to your portal users. If you delete the studio KMS key, your studio will no longer be accessible.

func (*Client) CreateStudioComponent 

func (c *Client) CreateStudioComponent(ctx context.Context, params *CreateStudioComponentInput, optFns ...func(*Options)) (*CreateStudioComponentOutput, error)

Creates a studio component resource.

func (*Client) DeleteLaunchProfile 

func (c *Client) DeleteLaunchProfile(ctx context.Context, params *DeleteLaunchProfileInput, optFns ...func(*Options)) (*DeleteLaunchProfileOutput, error)

Permanently delete a launch profile.

func (*Client) DeleteLaunchProfileMember 

func (c *Client) DeleteLaunchProfileMember(ctx context.Context, params *DeleteLaunchProfileMemberInput, optFns ...func(*Options)) (*DeleteLaunchProfileMemberOutput, error)

Delete a user from launch profile membership.

func (*Client) DeleteStreamingImage 

func (c *Client) DeleteStreamingImage(ctx context.Context, params *DeleteStreamingImageInput, optFns ...func(*Options)) (*DeleteStreamingImageOutput, error)

Delete streaming image.

func (*Client) DeleteStreamingSession 

func (c *Client) DeleteStreamingSession(ctx context.Context, params *DeleteStreamingSessionInput, optFns ...func(*Options)) (*DeleteStreamingSessionOutput, error)

Deletes streaming session resource. After invoking this operation, use GetStreamingSession to poll the resource until it transitions to a DELETED state. A streaming session will count against your streaming session quota until it is marked DELETED .

func (*Client) DeleteStudio 

func (c *Client) DeleteStudio(ctx context.Context, params *DeleteStudioInput, optFns ...func(*Options)) (*DeleteStudioOutput, error)

Delete a studio resource.

func (*Client) DeleteStudioComponent 

func (c *Client) DeleteStudioComponent(ctx context.Context, params *DeleteStudioComponentInput, optFns ...func(*Options)) (*DeleteStudioComponentOutput, error)

Deletes a studio component resource.

func (*Client) DeleteStudioMember 

func (c *Client) DeleteStudioMember(ctx context.Context, params *DeleteStudioMemberInput, optFns ...func(*Options)) (*DeleteStudioMemberOutput, error)

Delete a user from studio membership.

func (*Client) GetEula 

func (c *Client) GetEula(ctx context.Context, params *GetEulaInput, optFns ...func(*Options)) (*GetEulaOutput, error)

Get EULA.

func (*Client) GetLaunchProfile 

func (c *Client) GetLaunchProfile(ctx context.Context, params *GetLaunchProfileInput, optFns ...func(*Options)) (*GetLaunchProfileOutput, error)

Get a launch profile.

func (*Client) GetLaunchProfileDetails 

func (c *Client) GetLaunchProfileDetails(ctx context.Context, params *GetLaunchProfileDetailsInput, optFns ...func(*Options)) (*GetLaunchProfileDetailsOutput, error)

Launch profile details include the launch profile resource and summary information of resources that are used by, or available to, the launch profile. This includes the name and description of all studio components used by the launch profiles, and the name and description of streaming images that can be used with this launch profile.

func (*Client) GetLaunchProfileInitialization 

func (c *Client) GetLaunchProfileInitialization(ctx context.Context, params *GetLaunchProfileInitializationInput, optFns ...func(*Options)) (*GetLaunchProfileInitializationOutput, error)

Get a launch profile initialization.

func (*Client) GetLaunchProfileMember 

func (c *Client) GetLaunchProfileMember(ctx context.Context, params *GetLaunchProfileMemberInput, optFns ...func(*Options)) (*GetLaunchProfileMemberOutput, error)

Get a user persona in launch profile membership.

func (*Client) GetStreamingImage 

func (c *Client) GetStreamingImage(ctx context.Context, params *GetStreamingImageInput, optFns ...func(*Options)) (*GetStreamingImageOutput, error)

Get streaming image.

func (*Client) GetStreamingSession 

func (c *Client) GetStreamingSession(ctx context.Context, params *GetStreamingSessionInput, optFns ...func(*Options)) (*GetStreamingSessionOutput, error)

Gets StreamingSession resource. Invoke this operation to poll for a streaming session state while creating or deleting a session.

func (*Client) GetStreamingSessionBackup added in v1.15.0 

func (c *Client) GetStreamingSessionBackup(ctx context.Context, params *GetStreamingSessionBackupInput, optFns ...func(*Options)) (*GetStreamingSessionBackupOutput, error)

Gets StreamingSessionBackup resource. Invoke this operation to poll for a streaming session backup while stopping a streaming session.

func (*Client) GetStreamingSessionStream 

func (c *Client) GetStreamingSessionStream(ctx context.Context, params *GetStreamingSessionStreamInput, optFns ...func(*Options)) (*GetStreamingSessionStreamOutput, error)

Gets a StreamingSessionStream for a streaming session. Invoke this operation to poll the resource after invoking CreateStreamingSessionStream . After the StreamingSessionStream changes to the READY state, the url property will contain a stream to be used with the DCV streaming client.

func (*Client) GetStudio 

func (c *Client) GetStudio(ctx context.Context, params *GetStudioInput, optFns ...func(*Options)) (*GetStudioOutput, error)

Get a studio resource.

func (*Client) GetStudioComponent 

func (c *Client) GetStudioComponent(ctx context.Context, params *GetStudioComponentInput, optFns ...func(*Options)) (*GetStudioComponentOutput, error)

Gets a studio component resource.

func (*Client) GetStudioMember 

func (c *Client) GetStudioMember(ctx context.Context, params *GetStudioMemberInput, optFns ...func(*Options)) (*GetStudioMemberOutput, error)

Get a user's membership in a studio.

func (*Client) ListEulaAcceptances 

func (c *Client) ListEulaAcceptances(ctx context.Context, params *ListEulaAcceptancesInput, optFns ...func(*Options)) (*ListEulaAcceptancesOutput, error)

List EULA acceptances.

func (*Client) ListEulas 

func (c *Client) ListEulas(ctx context.Context, params *ListEulasInput, optFns ...func(*Options)) (*ListEulasOutput, error)

List EULAs.

func (*Client) ListLaunchProfileMembers 

func (c *Client) ListLaunchProfileMembers(ctx context.Context, params *ListLaunchProfileMembersInput, optFns ...func(*Options)) (*ListLaunchProfileMembersOutput, error)

Get all users in a given launch profile membership.

func (*Client) ListLaunchProfiles 

func (c *Client) ListLaunchProfiles(ctx context.Context, params *ListLaunchProfilesInput, optFns ...func(*Options)) (*ListLaunchProfilesOutput, error)

List all the launch profiles a studio.

func (*Client) ListStreamingImages 

func (c *Client) ListStreamingImages(ctx context.Context, params *ListStreamingImagesInput, optFns ...func(*Options)) (*ListStreamingImagesOutput, error)

List the streaming image resources available to this studio. This list will contain both images provided by Amazon Web Services, as well as streaming images that you have created in your studio.

func (*Client) ListStreamingSessionBackups added in v1.15.0 

func (c *Client) ListStreamingSessionBackups(ctx context.Context, params *ListStreamingSessionBackupsInput, optFns ...func(*Options)) (*ListStreamingSessionBackupsOutput, error)

Lists the backups of a streaming session in a studio.

func (*Client) ListStreamingSessions 

func (c *Client) ListStreamingSessions(ctx context.Context, params *ListStreamingSessionsInput, optFns ...func(*Options)) (*ListStreamingSessionsOutput, error)

Lists the streaming sessions in a studio.

func (*Client) ListStudioComponents 

func (c *Client) ListStudioComponents(ctx context.Context, params *ListStudioComponentsInput, optFns ...func(*Options)) (*ListStudioComponentsOutput, error)

Lists the StudioComponents in a studio.

func (*Client) ListStudioMembers 

func (c *Client) ListStudioMembers(ctx context.Context, params *ListStudioMembersInput, optFns ...func(*Options)) (*ListStudioMembersOutput, error)

Get all users in a given studio membership. ListStudioMembers only returns admin members.

func (*Client) ListStudios 

func (c *Client) ListStudios(ctx context.Context, params *ListStudiosInput, optFns ...func(*Options)) (*ListStudiosOutput, error)

List studios in your Amazon Web Services accounts in the requested Amazon Web Services Region.

func (*Client) ListTagsForResource 

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

Gets the tags for a resource, given its Amazon Resource Names (ARN). This operation supports ARNs for all resource types in Nimble Studio that support tags, including studio, studio component, launch profile, streaming image, and streaming session. All resources that can be tagged will contain an ARN property, so you do not have to create this ARN yourself.

func (*Client) Options added in v1.21.0 

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) PutLaunchProfileMembers 

func (c *Client) PutLaunchProfileMembers(ctx context.Context, params *PutLaunchProfileMembersInput, optFns ...func(*Options)) (*PutLaunchProfileMembersOutput, error)

Add/update users with given persona to launch profile membership.

func (*Client) PutStudioMembers 

func (c *Client) PutStudioMembers(ctx context.Context, params *PutStudioMembersInput, optFns ...func(*Options)) (*PutStudioMembersOutput, error)

Add/update users with given persona to studio membership.

func (*Client) StartStreamingSession added in v1.6.0 

func (c *Client) StartStreamingSession(ctx context.Context, params *StartStreamingSessionInput, optFns ...func(*Options)) (*StartStreamingSessionOutput, error)

Transitions sessions from the STOPPED state into the READY state. The START_IN_PROGRESS state is the intermediate state between the STOPPED and READY states.

func (*Client) StartStudioSSOConfigurationRepair 

func (c *Client) StartStudioSSOConfigurationRepair(ctx context.Context, params *StartStudioSSOConfigurationRepairInput, optFns ...func(*Options)) (*StartStudioSSOConfigurationRepairOutput, error)

Repairs the IAM Identity Center configuration for a given studio. If the studio has a valid IAM Identity Center configuration currently associated with it, this operation will fail with a validation error. If the studio does not have a valid IAM Identity Center configuration currently associated with it, then a new IAM Identity Center application is created for the studio and the studio is changed to the READY state. After the IAM Identity Center application is repaired, you must use the Amazon Nimble Studio console to add administrators and users to your studio.

func (*Client) StopStreamingSession added in v1.6.0 

func (c *Client) StopStreamingSession(ctx context.Context, params *StopStreamingSessionInput, optFns ...func(*Options)) (*StopStreamingSessionOutput, error)

Transitions sessions from the READY state into the STOPPED state. The STOP_IN_PROGRESS state is the intermediate state between the READY and STOPPED states.

func (*Client) TagResource 

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

Creates tags for a resource, given its ARN.

func (*Client) UntagResource 

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

Deletes the tags for a resource.

func (*Client) UpdateLaunchProfile 

func (c *Client) UpdateLaunchProfile(ctx context.Context, params *UpdateLaunchProfileInput, optFns ...func(*Options)) (*UpdateLaunchProfileOutput, error)

Update a launch profile.

func (*Client) UpdateLaunchProfileMember 

func (c *Client) UpdateLaunchProfileMember(ctx context.Context, params *UpdateLaunchProfileMemberInput, optFns ...func(*Options)) (*UpdateLaunchProfileMemberOutput, error)

Update a user persona in launch profile membership.

func (*Client) UpdateStreamingImage 

func (c *Client) UpdateStreamingImage(ctx context.Context, params *UpdateStreamingImageInput, optFns ...func(*Options)) (*UpdateStreamingImageOutput, error)

Update streaming image.

func (*Client) UpdateStudio 

func (c *Client) UpdateStudio(ctx context.Context, params *UpdateStudioInput, optFns ...func(*Options)) (*UpdateStudioOutput, error)

Update a Studio resource. Currently, this operation only supports updating the displayName of your studio.

func (*Client) UpdateStudioComponent 

func (c *Client) UpdateStudioComponent(ctx context.Context, params *UpdateStudioComponentInput, optFns ...func(*Options)) (*UpdateStudioComponentOutput, error)

Updates a studio component resource.

type CreateLaunchProfileInput 

type CreateLaunchProfileInput struct {

	// Specifies the IDs of the EC2 subnets where streaming sessions will be
	// accessible from. These subnets must support the specified instance types.
	//
	// This member is required.
	Ec2SubnetIds []string

	// The version number of the protocol that is used by the launch profile. The only
	// valid version is "2021-03-31".
	//
	// This member is required.
	LaunchProfileProtocolVersions []string

	// The name for the launch profile.
	//
	// This member is required.
	Name *string

	// A configuration for a streaming session.
	//
	// This member is required.
	StreamConfiguration *types.StreamConfigurationCreate

	// Unique identifiers for a collection of studio components that can be used with
	// this launch profile.
	//
	// This member is required.
	StudioComponentIds []string

	// The studio ID.
	//
	// This member is required.
	StudioId *string

	// Unique, case-sensitive identifier that you provide to ensure the idempotency of
	// the request. If you don’t specify a client token, the Amazon Web Services SDK
	// automatically generates a client token and uses it for the request to ensure
	// idempotency.
	ClientToken *string

	// The description.
	Description *string

	// A collection of labels, in the form of key-value pairs, that apply to this
	// resource.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateLaunchProfileOutput 

type CreateLaunchProfileOutput struct {

	// The launch profile.
	LaunchProfile *types.LaunchProfile

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

type CreateStreamingImageInput 

type CreateStreamingImageInput struct {

	// The ID of an EC2 machine image with which to create this streaming image.
	//
	// This member is required.
	Ec2ImageId *string

	// A friendly name for a streaming image resource.
	//
	// This member is required.
	Name *string

	// The studio ID.
	//
	// This member is required.
	StudioId *string

	// Unique, case-sensitive identifier that you provide to ensure the idempotency of
	// the request. If you don’t specify a client token, the Amazon Web Services SDK
	// automatically generates a client token and uses it for the request to ensure
	// idempotency.
	ClientToken *string

	// A human-readable description of the streaming image.
	Description *string

	// A collection of labels, in the form of key-value pairs, that apply to this
	// resource.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateStreamingImageOutput 

type CreateStreamingImageOutput struct {

	// The streaming image.
	StreamingImage *types.StreamingImage

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

type CreateStreamingSessionInput 

type CreateStreamingSessionInput struct {

	// The ID of the launch profile used to control access from the streaming session.
	//
	// This member is required.
	LaunchProfileId *string

	// The studio ID.
	//
	// This member is required.
	StudioId *string

	// Unique, case-sensitive identifier that you provide to ensure the idempotency of
	// the request. If you don’t specify a client token, the Amazon Web Services SDK
	// automatically generates a client token and uses it for the request to ensure
	// idempotency.
	ClientToken *string

	// The EC2 Instance type used for the streaming session.
	Ec2InstanceType types.StreamingInstanceType

	// The user ID of the user that owns the streaming session. The user that owns the
	// session will be logging into the session and interacting with the virtual
	// workstation.
	OwnedBy *string

	// The ID of the streaming image.
	StreamingImageId *string

	// A collection of labels, in the form of key-value pairs, that apply to this
	// resource.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateStreamingSessionOutput 

type CreateStreamingSessionOutput struct {

	// The session.
	Session *types.StreamingSession

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

type CreateStreamingSessionStreamInput 

type CreateStreamingSessionStreamInput struct {

	// The streaming session ID.
	//
	// This member is required.
	SessionId *string

	// The studio ID.
	//
	// This member is required.
	StudioId *string

	// Unique, case-sensitive identifier that you provide to ensure the idempotency of
	// the request. If you don’t specify a client token, the Amazon Web Services SDK
	// automatically generates a client token and uses it for the request to ensure
	// idempotency.
	ClientToken *string

	// The expiration time in seconds.
	ExpirationInSeconds *int32
	// contains filtered or unexported fields
}

type CreateStreamingSessionStreamOutput 

type CreateStreamingSessionStreamOutput struct {

	// The stream.
	Stream *types.StreamingSessionStream

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

type CreateStudioComponentInput 

type CreateStudioComponentInput struct {

	// The name for the studio component.
	//
	// This member is required.
	Name *string

	// The studio ID.
	//
	// This member is required.
	StudioId *string

	// The type of the studio component.
	//
	// This member is required.
	Type types.StudioComponentType

	// Unique, case-sensitive identifier that you provide to ensure the idempotency of
	// the request. If you don’t specify a client token, the Amazon Web Services SDK
	// automatically generates a client token and uses it for the request to ensure
	// idempotency.
	ClientToken *string

	// The configuration of the studio component, based on component type.
	Configuration *types.StudioComponentConfiguration

	// The description.
	Description *string

	// The EC2 security groups that control access to the studio component.
	Ec2SecurityGroupIds []string

	// Initialization scripts for studio components.
	InitializationScripts []types.StudioComponentInitializationScript

	// An IAM role attached to a Studio Component that gives the studio component
	// access to Amazon Web Services resources at anytime while the instance is
	// running.
	RuntimeRoleArn *string

	// Parameters for the studio component scripts.
	ScriptParameters []types.ScriptParameterKeyValue

	// An IAM role attached to Studio Component when the system initialization script
	// runs which give the studio component access to Amazon Web Services resources
	// when the system initialization script runs.
	SecureInitializationRoleArn *string

	// The specific subtype of a studio component.
	Subtype types.StudioComponentSubtype

	// A collection of labels, in the form of key-value pairs, that apply to this
	// resource.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateStudioComponentOutput 

type CreateStudioComponentOutput struct {

	// Information about the studio component.
	StudioComponent *types.StudioComponent

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

type CreateStudioInput 

type CreateStudioInput struct {

	// The IAM role that studio admins will assume when logging in to the Nimble
	// Studio portal.
	//
	// This member is required.
	AdminRoleArn *string

	// A friendly name for the studio.
	//
	// This member is required.
	DisplayName *string

	// The studio name that is used in the URL of the Nimble Studio portal when
	// accessed by Nimble Studio users.
	//
	// This member is required.
	StudioName *string

	// The IAM role that studio users will assume when logging in to the Nimble Studio
	// portal.
	//
	// This member is required.
	UserRoleArn *string

	// Unique, case-sensitive identifier that you provide to ensure the idempotency of
	// the request. If you don’t specify a client token, the Amazon Web Services SDK
	// automatically generates a client token and uses it for the request to ensure
	// idempotency.
	ClientToken *string

	// The studio encryption configuration.
	StudioEncryptionConfiguration *types.StudioEncryptionConfiguration

	// A collection of labels, in the form of key-value pairs, that apply to this
	// resource.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateStudioOutput 

type CreateStudioOutput struct {

	// Information about a studio.
	Studio *types.Studio

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

type DeleteLaunchProfileInput 

type DeleteLaunchProfileInput struct {

	// The ID of the launch profile used to control access from the streaming session.
	//
	// This member is required.
	LaunchProfileId *string

	// The studio ID.
	//
	// This member is required.
	StudioId *string

	// Unique, case-sensitive identifier that you provide to ensure the idempotency of
	// the request. If you don’t specify a client token, the Amazon Web Services SDK
	// automatically generates a client token and uses it for the request to ensure
	// idempotency.
	ClientToken *string
	// contains filtered or unexported fields
}

type DeleteLaunchProfileMemberInput 

type DeleteLaunchProfileMemberInput struct {

	// The ID of the launch profile used to control access from the streaming session.
	//
	// This member is required.
	LaunchProfileId *string

	// The principal ID. This currently supports a IAM Identity Center UserId.
	//
	// This member is required.
	PrincipalId *string

	// The studio ID.
	//
	// This member is required.
	StudioId *string

	// Unique, case-sensitive identifier that you provide to ensure the idempotency of
	// the request. If you don’t specify a client token, the Amazon Web Services SDK
	// automatically generates a client token and uses it for the request to ensure
	// idempotency.
	ClientToken *string
	// contains filtered or unexported fields
}

type DeleteLaunchProfileMemberOutput 

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

type DeleteLaunchProfileOutput 

type DeleteLaunchProfileOutput struct {

	// The launch profile.
	LaunchProfile *types.LaunchProfile

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

type DeleteStreamingImageInput 

type DeleteStreamingImageInput struct {

	// The streaming image ID.
	//
	// This member is required.
	StreamingImageId *string

	// The studio ID.
	//
	// This member is required.
	StudioId *string

	// Unique, case-sensitive identifier that you provide to ensure the idempotency of
	// the request. If you don’t specify a client token, the Amazon Web Services SDK
	// automatically generates a client token and uses it for the request to ensure
	// idempotency.
	ClientToken *string
	// contains filtered or unexported fields
}

type DeleteStreamingImageOutput 

type DeleteStreamingImageOutput struct {

	// The streaming image.
	StreamingImage *types.StreamingImage

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

type DeleteStreamingSessionInput 

type DeleteStreamingSessionInput struct {

	// The streaming session ID.
	//
	// This member is required.
	SessionId *string

	// The studio ID.
	//
	// This member is required.
	StudioId *string

	// Unique, case-sensitive identifier that you provide to ensure the idempotency of
	// the request. If you don’t specify a client token, the Amazon Web Services SDK
	// automatically generates a client token and uses it for the request to ensure
	// idempotency.
	ClientToken *string
	// contains filtered or unexported fields
}

type DeleteStreamingSessionOutput 

type DeleteStreamingSessionOutput struct {

	// The session.
	Session *types.StreamingSession

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

type DeleteStudioComponentInput 

type DeleteStudioComponentInput struct {

	// The studio component ID.
	//
	// This member is required.
	StudioComponentId *string

	// The studio ID.
	//
	// This member is required.
	StudioId *string

	// Unique, case-sensitive identifier that you provide to ensure the idempotency of
	// the request. If you don’t specify a client token, the Amazon Web Services SDK
	// automatically generates a client token and uses it for the request to ensure
	// idempotency.
	ClientToken *string
	// contains filtered or unexported fields
}

type DeleteStudioComponentOutput 

type DeleteStudioComponentOutput struct {

	// Information about the studio component.
	StudioComponent *types.StudioComponent

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

type DeleteStudioInput 

type DeleteStudioInput struct {

	// The studio ID.
	//
	// This member is required.
	StudioId *string

	// Unique, case-sensitive identifier that you provide to ensure the idempotency of
	// the request. If you don’t specify a client token, the Amazon Web Services SDK
	// automatically generates a client token and uses it for the request to ensure
	// idempotency.
	ClientToken *string
	// contains filtered or unexported fields
}

type DeleteStudioMemberInput 

type DeleteStudioMemberInput struct {

	// The principal ID. This currently supports a IAM Identity Center UserId.
	//
	// This member is required.
	PrincipalId *string

	// The studio ID.
	//
	// This member is required.
	StudioId *string

	// Unique, case-sensitive identifier that you provide to ensure the idempotency of
	// the request. If you don’t specify a client token, the Amazon Web Services SDK
	// automatically generates a client token and uses it for the request to ensure
	// idempotency.
	ClientToken *string
	// contains filtered or unexported fields
}

type DeleteStudioMemberOutput 

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

type DeleteStudioOutput 

type DeleteStudioOutput struct {

	// Information about a studio.
	//
	// This member is required.
	Studio *types.Studio

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

type EndpointParameters added in v1.17.0 

type EndpointParameters struct {
	// The AWS region used to dispatch the request.
	//
	// Parameter is
	// required.
	//
	// AWS::Region
	Region *string

	// When true, use the dual-stack endpoint. If the configured endpoint does not
	// support dual-stack, dispatching the request MAY return an error.
	//
	// Defaults to
	// false if no value is provided.
	//
	// AWS::UseDualStack
	UseDualStack *bool

	// 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
}

EndpointParameters provides the parameters that influence how endpoints are resolved.

func (EndpointParameters) ValidateRequired added in v1.17.0 

func (p EndpointParameters) ValidateRequired() error

ValidateRequired validates required parameters are set.

func (EndpointParameters) WithDefaults added in v1.17.0 

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 added in v1.17.0 

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 added in v1.17.0 

func NewDefaultEndpointResolverV2() EndpointResolverV2

type GetEulaInput 

type GetEulaInput struct {

	// The EULA ID.
	//
	// This member is required.
	EulaId *string
	// contains filtered or unexported fields
}

type GetEulaOutput 

type GetEulaOutput struct {

	// The EULA.
	Eula *types.Eula

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

type GetLaunchProfileAPIClient added in v1.6.0 

type GetLaunchProfileAPIClient interface {
	GetLaunchProfile(context.Context, *GetLaunchProfileInput, ...func(*Options)) (*GetLaunchProfileOutput, error)
}

GetLaunchProfileAPIClient is a client that implements the GetLaunchProfile operation.

type GetLaunchProfileDetailsInput 

type GetLaunchProfileDetailsInput struct {

	// The ID of the launch profile used to control access from the streaming session.
	//
	// This member is required.
	LaunchProfileId *string

	// The studio ID.
	//
	// This member is required.
	StudioId *string
	// contains filtered or unexported fields
}

type GetLaunchProfileDetailsOutput 

type GetLaunchProfileDetailsOutput struct {

	// The launch profile.
	LaunchProfile *types.LaunchProfile

	// A collection of streaming images.
	StreamingImages []types.StreamingImage

	// A collection of studio component summaries.
	StudioComponentSummaries []types.StudioComponentSummary

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

type GetLaunchProfileInitializationInput 

type GetLaunchProfileInitializationInput struct {

	// The ID of the launch profile used to control access from the streaming session.
	//
	// This member is required.
	LaunchProfileId *string

	// The launch profile protocol versions supported by the client.
	//
	// This member is required.
	LaunchProfileProtocolVersions []string

	// The launch purpose.
	//
	// This member is required.
	LaunchPurpose *string

	// The platform where this Launch Profile will be used, either Windows or Linux.
	//
	// This member is required.
	Platform *string

	// The studio ID.
	//
	// This member is required.
	StudioId *string
	// contains filtered or unexported fields
}

type GetLaunchProfileInitializationOutput 

type GetLaunchProfileInitializationOutput struct {

	// The launch profile initialization.
	LaunchProfileInitialization *types.LaunchProfileInitialization

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

type GetLaunchProfileInput 

type GetLaunchProfileInput struct {

	// The ID of the launch profile used to control access from the streaming session.
	//
	// This member is required.
	LaunchProfileId *string

	// The studio ID.
	//
	// This member is required.
	StudioId *string
	// contains filtered or unexported fields
}

type GetLaunchProfileMemberInput 

type GetLaunchProfileMemberInput struct {

	// The ID of the launch profile used to control access from the streaming session.
	//
	// This member is required.
	LaunchProfileId *string

	// The principal ID. This currently supports a IAM Identity Center UserId.
	//
	// This member is required.
	PrincipalId *string

	// The studio ID.
	//
	// This member is required.
	StudioId *string
	// contains filtered or unexported fields
}

type GetLaunchProfileMemberOutput 

type GetLaunchProfileMemberOutput struct {

	// The member.
	Member *types.LaunchProfileMembership

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

type GetLaunchProfileOutput 

type GetLaunchProfileOutput struct {

	// The launch profile.
	LaunchProfile *types.LaunchProfile

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

type GetStreamingImageAPIClient added in v1.6.0 

type GetStreamingImageAPIClient interface {
	GetStreamingImage(context.Context, *GetStreamingImageInput, ...func(*Options)) (*GetStreamingImageOutput, error)
}

GetStreamingImageAPIClient is a client that implements the GetStreamingImage operation.

type GetStreamingImageInput 

type GetStreamingImageInput struct {

	// The streaming image ID.
	//
	// This member is required.
	StreamingImageId *string

	// The studio ID.
	//
	// This member is required.
	StudioId *string
	// contains filtered or unexported fields
}

type GetStreamingImageOutput 

type GetStreamingImageOutput struct {

	// The streaming image.
	StreamingImage *types.StreamingImage

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

type GetStreamingSessionAPIClient added in v1.6.0 

type GetStreamingSessionAPIClient interface {
	GetStreamingSession(context.Context, *GetStreamingSessionInput, ...func(*Options)) (*GetStreamingSessionOutput, error)
}

GetStreamingSessionAPIClient is a client that implements the GetStreamingSession operation.

type GetStreamingSessionBackupInput added in v1.15.0 

type GetStreamingSessionBackupInput struct {

	// The ID of the backup.
	//
	// This member is required.
	BackupId *string

	// The studio ID.
	//
	// This member is required.
	StudioId *string
	// contains filtered or unexported fields
}

type GetStreamingSessionBackupOutput added in v1.15.0 

type GetStreamingSessionBackupOutput struct {

	// Information about the streaming session backup.
	StreamingSessionBackup *types.StreamingSessionBackup

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

type GetStreamingSessionInput 

type GetStreamingSessionInput struct {

	// The streaming session ID.
	//
	// This member is required.
	SessionId *string

	// The studio ID.
	//
	// This member is required.
	StudioId *string
	// contains filtered or unexported fields
}

type GetStreamingSessionOutput 

type GetStreamingSessionOutput struct {

	// The session.
	Session *types.StreamingSession

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

type GetStreamingSessionStreamAPIClient added in v1.6.0 

type GetStreamingSessionStreamAPIClient interface {
	GetStreamingSessionStream(context.Context, *GetStreamingSessionStreamInput, ...func(*Options)) (*GetStreamingSessionStreamOutput, error)
}

GetStreamingSessionStreamAPIClient is a client that implements the GetStreamingSessionStream operation.

type GetStreamingSessionStreamInput 

type GetStreamingSessionStreamInput struct {

	// The streaming session ID.
	//
	// This member is required.
	SessionId *string

	// The streaming session stream ID.
	//
	// This member is required.
	StreamId *string

	// The studio ID.
	//
	// This member is required.
	StudioId *string
	// contains filtered or unexported fields
}

type GetStreamingSessionStreamOutput 

type GetStreamingSessionStreamOutput struct {

	// The stream.
	Stream *types.StreamingSessionStream

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

type GetStudioAPIClient added in v1.6.0 

type GetStudioAPIClient interface {
	GetStudio(context.Context, *GetStudioInput, ...func(*Options)) (*GetStudioOutput, error)
}

GetStudioAPIClient is a client that implements the GetStudio operation.

type GetStudioComponentAPIClient added in v1.6.0 

type GetStudioComponentAPIClient interface {
	GetStudioComponent(context.Context, *GetStudioComponentInput, ...func(*Options)) (*GetStudioComponentOutput, error)
}

GetStudioComponentAPIClient is a client that implements the GetStudioComponent operation.

type GetStudioComponentInput 

type GetStudioComponentInput struct {

	// The studio component ID.
	//
	// This member is required.
	StudioComponentId *string

	// The studio ID.
	//
	// This member is required.
	StudioId *string
	// contains filtered or unexported fields
}

type GetStudioComponentOutput 

type GetStudioComponentOutput struct {

	// Information about the studio component.
	StudioComponent *types.StudioComponent

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

type GetStudioInput 

type GetStudioInput struct {

	// The studio ID.
	//
	// This member is required.
	StudioId *string
	// contains filtered or unexported fields
}

type GetStudioMemberInput 

type GetStudioMemberInput struct {

	// The principal ID. This currently supports a IAM Identity Center UserId.
	//
	// This member is required.
	PrincipalId *string

	// The studio ID.
	//
	// This member is required.
	StudioId *string
	// contains filtered or unexported fields
}

type GetStudioMemberOutput 

type GetStudioMemberOutput struct {

	// The member.
	Member *types.StudioMembership

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

type GetStudioOutput 

type GetStudioOutput struct {

	// Information about a studio.
	//
	// This member is required.
	Studio *types.Studio

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

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 LaunchProfileDeletedWaiter added in v1.6.0 

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

LaunchProfileDeletedWaiter defines the waiters for LaunchProfileDeleted

func NewLaunchProfileDeletedWaiter added in v1.6.0 

func NewLaunchProfileDeletedWaiter(client GetLaunchProfileAPIClient, optFns ...func(*LaunchProfileDeletedWaiterOptions)) *LaunchProfileDeletedWaiter

NewLaunchProfileDeletedWaiter constructs a LaunchProfileDeletedWaiter.

func (*LaunchProfileDeletedWaiter) Wait added in v1.6.0 

func (w *LaunchProfileDeletedWaiter) Wait(ctx context.Context, params *GetLaunchProfileInput, maxWaitDur time.Duration, optFns ...func(*LaunchProfileDeletedWaiterOptions)) error

Wait calls the waiter function for LaunchProfileDeleted waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

func (*LaunchProfileDeletedWaiter) WaitForOutput added in v1.7.0 

func (w *LaunchProfileDeletedWaiter) WaitForOutput(ctx context.Context, params *GetLaunchProfileInput, maxWaitDur time.Duration, optFns ...func(*LaunchProfileDeletedWaiterOptions)) (*GetLaunchProfileOutput, error)

WaitForOutput calls the waiter function for LaunchProfileDeleted waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

type LaunchProfileDeletedWaiterOptions added in v1.6.0 

type LaunchProfileDeletedWaiterOptions 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.
	//
	// Passing options here is functionally equivalent to passing values to this
	// config's ClientOptions field that extend the inner client's APIOptions directly.
	APIOptions []func(*middleware.Stack) error

	// Functional options to be passed to all operations invoked by this client.
	//
	// Function values that modify the inner APIOptions are applied after the waiter
	// config's own APIOptions modifiers.
	ClientOptions []func(*Options)

	// MinDelay is the minimum amount of time to delay between retries. If unset,
	// LaunchProfileDeletedWaiter will use default minimum delay of 5 seconds. Note
	// that MinDelay must resolve to a value lesser than or equal to the MaxDelay.
	MinDelay time.Duration

	// MaxDelay is the maximum amount of time to delay between retries. If unset or
	// set to zero, LaunchProfileDeletedWaiter will use default max delay of 750
	// seconds. Note that MaxDelay must resolve to value greater than or equal to the
	// MinDelay.
	MaxDelay time.Duration

	// LogWaitAttempts is used to enable logging for waiter retry attempts
	LogWaitAttempts bool

	// Retryable is function that can be used to override the service defined
	// waiter-behavior based on operation output, or returned error. This function is
	// used by the waiter to decide if a state is retryable or a terminal state. By
	// default service-modeled logic will populate this option. This option can thus be
	// used to define a custom waiter state with fall-back to service-modeled waiter
	// state mutators.The function returns an error in case of a failure state. In case
	// of retry state, this function returns a bool value of true and nil error, while
	// in case of success it returns a bool value of false and nil error.
	Retryable func(context.Context, *GetLaunchProfileInput, *GetLaunchProfileOutput, error) (bool, error)
}

LaunchProfileDeletedWaiterOptions are waiter options for LaunchProfileDeletedWaiter

type LaunchProfileReadyWaiter added in v1.6.0 

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

LaunchProfileReadyWaiter defines the waiters for LaunchProfileReady

func NewLaunchProfileReadyWaiter added in v1.6.0 

func NewLaunchProfileReadyWaiter(client GetLaunchProfileAPIClient, optFns ...func(*LaunchProfileReadyWaiterOptions)) *LaunchProfileReadyWaiter

NewLaunchProfileReadyWaiter constructs a LaunchProfileReadyWaiter.

func (*LaunchProfileReadyWaiter) Wait added in v1.6.0 

func (w *LaunchProfileReadyWaiter) Wait(ctx context.Context, params *GetLaunchProfileInput, maxWaitDur time.Duration, optFns ...func(*LaunchProfileReadyWaiterOptions)) error

Wait calls the waiter function for LaunchProfileReady waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

func (*LaunchProfileReadyWaiter) WaitForOutput added in v1.7.0 

func (w *LaunchProfileReadyWaiter) WaitForOutput(ctx context.Context, params *GetLaunchProfileInput, maxWaitDur time.Duration, optFns ...func(*LaunchProfileReadyWaiterOptions)) (*GetLaunchProfileOutput, error)

WaitForOutput calls the waiter function for LaunchProfileReady waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

type LaunchProfileReadyWaiterOptions added in v1.6.0 

type LaunchProfileReadyWaiterOptions 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.
	//
	// Passing options here is functionally equivalent to passing values to this
	// config's ClientOptions field that extend the inner client's APIOptions directly.
	APIOptions []func(*middleware.Stack) error

	// Functional options to be passed to all operations invoked by this client.
	//
	// Function values that modify the inner APIOptions are applied after the waiter
	// config's own APIOptions modifiers.
	ClientOptions []func(*Options)

	// MinDelay is the minimum amount of time to delay between retries. If unset,
	// LaunchProfileReadyWaiter will use default minimum delay of 5 seconds. Note that
	// MinDelay must resolve to a value lesser than or equal to the MaxDelay.
	MinDelay time.Duration

	// MaxDelay is the maximum amount of time to delay between retries. If unset or
	// set to zero, LaunchProfileReadyWaiter will use default max delay of 750 seconds.
	// Note that MaxDelay must resolve to value greater than or equal to the MinDelay.
	MaxDelay time.Duration

	// LogWaitAttempts is used to enable logging for waiter retry attempts
	LogWaitAttempts bool

	// Retryable is function that can be used to override the service defined
	// waiter-behavior based on operation output, or returned error. This function is
	// used by the waiter to decide if a state is retryable or a terminal state. By
	// default service-modeled logic will populate this option. This option can thus be
	// used to define a custom waiter state with fall-back to service-modeled waiter
	// state mutators.The function returns an error in case of a failure state. In case
	// of retry state, this function returns a bool value of true and nil error, while
	// in case of success it returns a bool value of false and nil error.
	Retryable func(context.Context, *GetLaunchProfileInput, *GetLaunchProfileOutput, error) (bool, error)
}

LaunchProfileReadyWaiterOptions are waiter options for LaunchProfileReadyWaiter

type ListEulaAcceptancesAPIClient added in v1.6.0 

type ListEulaAcceptancesAPIClient interface {
	ListEulaAcceptances(context.Context, *ListEulaAcceptancesInput, ...func(*Options)) (*ListEulaAcceptancesOutput, error)
}

ListEulaAcceptancesAPIClient is a client that implements the ListEulaAcceptances operation.

type ListEulaAcceptancesInput 

type ListEulaAcceptancesInput struct {

	// The studio ID.
	//
	// This member is required.
	StudioId *string

	// The list of EULA IDs that have been previously accepted.
	EulaIds []string

	// The token for the next set of results, or null if there are no more results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListEulaAcceptancesOutput 

type ListEulaAcceptancesOutput struct {

	// A collection of EULA acceptances.
	EulaAcceptances []types.EulaAcceptance

	// The token for the next set of results, or null if there are no more results.
	NextToken *string

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

type ListEulaAcceptancesPaginator added in v1.6.0 

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

ListEulaAcceptancesPaginator is a paginator for ListEulaAcceptances

func NewListEulaAcceptancesPaginator added in v1.6.0 

func NewListEulaAcceptancesPaginator(client ListEulaAcceptancesAPIClient, params *ListEulaAcceptancesInput, optFns ...func(*ListEulaAcceptancesPaginatorOptions)) *ListEulaAcceptancesPaginator

NewListEulaAcceptancesPaginator returns a new ListEulaAcceptancesPaginator

func (*ListEulaAcceptancesPaginator) HasMorePages added in v1.6.0 

func (p *ListEulaAcceptancesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListEulaAcceptancesPaginator) NextPage added in v1.6.0 

func (p *ListEulaAcceptancesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListEulaAcceptancesOutput, error)

NextPage retrieves the next ListEulaAcceptances page.

type ListEulaAcceptancesPaginatorOptions added in v1.6.0 

type ListEulaAcceptancesPaginatorOptions struct {
	// 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
}

ListEulaAcceptancesPaginatorOptions is the paginator options for ListEulaAcceptances

type ListEulasAPIClient added in v1.6.0 

type ListEulasAPIClient interface {
	ListEulas(context.Context, *ListEulasInput, ...func(*Options)) (*ListEulasOutput, error)
}

ListEulasAPIClient is a client that implements the ListEulas operation.

type ListEulasInput 

type ListEulasInput struct {

	// The list of EULA IDs that should be returned
	EulaIds []string

	// The token for the next set of results, or null if there are no more results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListEulasOutput 

type ListEulasOutput struct {

	// A collection of EULA resources.
	Eulas []types.Eula

	// The token for the next set of results, or null if there are no more results.
	NextToken *string

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

type ListEulasPaginator added in v1.6.0 

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

ListEulasPaginator is a paginator for ListEulas

func NewListEulasPaginator added in v1.6.0 

func NewListEulasPaginator(client ListEulasAPIClient, params *ListEulasInput, optFns ...func(*ListEulasPaginatorOptions)) *ListEulasPaginator

NewListEulasPaginator returns a new ListEulasPaginator

func (*ListEulasPaginator) HasMorePages added in v1.6.0 

func (p *ListEulasPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListEulasPaginator) NextPage added in v1.6.0 

func (p *ListEulasPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListEulasOutput, error)

NextPage retrieves the next ListEulas page.

type ListEulasPaginatorOptions added in v1.6.0 

type ListEulasPaginatorOptions struct {
	// 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
}

ListEulasPaginatorOptions is the paginator options for ListEulas

type ListLaunchProfileMembersAPIClient added in v1.6.0 

type ListLaunchProfileMembersAPIClient interface {
	ListLaunchProfileMembers(context.Context, *ListLaunchProfileMembersInput, ...func(*Options)) (*ListLaunchProfileMembersOutput, error)
}

ListLaunchProfileMembersAPIClient is a client that implements the ListLaunchProfileMembers operation.

type ListLaunchProfileMembersInput 

type ListLaunchProfileMembersInput struct {

	// The ID of the launch profile used to control access from the streaming session.
	//
	// This member is required.
	LaunchProfileId *string

	// The studio ID.
	//
	// This member is required.
	StudioId *string

	// The max number of results to return in the response.
	MaxResults *int32

	// The token for the next set of results, or null if there are no more results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListLaunchProfileMembersOutput 

type ListLaunchProfileMembersOutput struct {

	// A list of members.
	Members []types.LaunchProfileMembership

	// The token for the next set of results, or null if there are no more results.
	NextToken *string

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

type ListLaunchProfileMembersPaginator added in v1.6.0 

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

ListLaunchProfileMembersPaginator is a paginator for ListLaunchProfileMembers

func NewListLaunchProfileMembersPaginator added in v1.6.0 

func NewListLaunchProfileMembersPaginator(client ListLaunchProfileMembersAPIClient, params *ListLaunchProfileMembersInput, optFns ...func(*ListLaunchProfileMembersPaginatorOptions)) *ListLaunchProfileMembersPaginator

NewListLaunchProfileMembersPaginator returns a new ListLaunchProfileMembersPaginator

func (*ListLaunchProfileMembersPaginator) HasMorePages added in v1.6.0 

func (p *ListLaunchProfileMembersPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListLaunchProfileMembersPaginator) NextPage added in v1.6.0 

func (p *ListLaunchProfileMembersPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListLaunchProfileMembersOutput, error)

NextPage retrieves the next ListLaunchProfileMembers page.

type ListLaunchProfileMembersPaginatorOptions added in v1.6.0 

type ListLaunchProfileMembersPaginatorOptions struct {
	// The max number of results to return in the 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
}

ListLaunchProfileMembersPaginatorOptions is the paginator options for ListLaunchProfileMembers

type ListLaunchProfilesAPIClient added in v1.6.0 

type ListLaunchProfilesAPIClient interface {
	ListLaunchProfiles(context.Context, *ListLaunchProfilesInput, ...func(*Options)) (*ListLaunchProfilesOutput, error)
}

ListLaunchProfilesAPIClient is a client that implements the ListLaunchProfiles operation.

type ListLaunchProfilesInput 

type ListLaunchProfilesInput struct {

	// The studio ID.
	//
	// This member is required.
	StudioId *string

	// The max number of results to return in the response.
	MaxResults *int32

	// The token for the next set of results, or null if there are no more results.
	NextToken *string

	// The principal ID. This currently supports a IAM Identity Center UserId.
	PrincipalId *string

	// Filter this request to launch profiles in any of the given states.
	States []types.LaunchProfileState
	// contains filtered or unexported fields
}

type ListLaunchProfilesOutput 

type ListLaunchProfilesOutput struct {

	// A collection of launch profiles.
	LaunchProfiles []types.LaunchProfile

	// The token for the next set of results, or null if there are no more results.
	NextToken *string

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

type ListLaunchProfilesPaginator added in v1.6.0 

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

ListLaunchProfilesPaginator is a paginator for ListLaunchProfiles

func NewListLaunchProfilesPaginator added in v1.6.0 

func NewListLaunchProfilesPaginator(client ListLaunchProfilesAPIClient, params *ListLaunchProfilesInput, optFns ...func(*ListLaunchProfilesPaginatorOptions)) *ListLaunchProfilesPaginator

NewListLaunchProfilesPaginator returns a new ListLaunchProfilesPaginator

func (*ListLaunchProfilesPaginator) HasMorePages added in v1.6.0 

func (p *ListLaunchProfilesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListLaunchProfilesPaginator) NextPage added in v1.6.0 

func (p *ListLaunchProfilesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListLaunchProfilesOutput, error)

NextPage retrieves the next ListLaunchProfiles page.

type ListLaunchProfilesPaginatorOptions added in v1.6.0 

type ListLaunchProfilesPaginatorOptions struct {
	// The max number of results to return in the 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
}

ListLaunchProfilesPaginatorOptions is the paginator options for ListLaunchProfiles

type ListStreamingImagesAPIClient added in v1.6.0 

type ListStreamingImagesAPIClient interface {
	ListStreamingImages(context.Context, *ListStreamingImagesInput, ...func(*Options)) (*ListStreamingImagesOutput, error)
}

ListStreamingImagesAPIClient is a client that implements the ListStreamingImages operation.

type ListStreamingImagesInput 

type ListStreamingImagesInput struct {

	// The studio ID.
	//
	// This member is required.
	StudioId *string

	// The token for the next set of results, or null if there are no more results.
	NextToken *string

	// Filter this request to streaming images with the given owner
	Owner *string
	// contains filtered or unexported fields
}

type ListStreamingImagesOutput 

type ListStreamingImagesOutput struct {

	// The token for the next set of results, or null if there are no more results.
	NextToken *string

	// A collection of streaming images.
	StreamingImages []types.StreamingImage

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

type ListStreamingImagesPaginator added in v1.6.0 

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

ListStreamingImagesPaginator is a paginator for ListStreamingImages

func NewListStreamingImagesPaginator added in v1.6.0 

func NewListStreamingImagesPaginator(client ListStreamingImagesAPIClient, params *ListStreamingImagesInput, optFns ...func(*ListStreamingImagesPaginatorOptions)) *ListStreamingImagesPaginator

NewListStreamingImagesPaginator returns a new ListStreamingImagesPaginator

func (*ListStreamingImagesPaginator) HasMorePages added in v1.6.0 

func (p *ListStreamingImagesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListStreamingImagesPaginator) NextPage added in v1.6.0 

func (p *ListStreamingImagesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListStreamingImagesOutput, error)

NextPage retrieves the next ListStreamingImages page.

type ListStreamingImagesPaginatorOptions added in v1.6.0 

type ListStreamingImagesPaginatorOptions struct {
	// 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
}

ListStreamingImagesPaginatorOptions is the paginator options for ListStreamingImages

type ListStreamingSessionBackupsAPIClient added in v1.15.0 

type ListStreamingSessionBackupsAPIClient interface {
	ListStreamingSessionBackups(context.Context, *ListStreamingSessionBackupsInput, ...func(*Options)) (*ListStreamingSessionBackupsOutput, error)
}

ListStreamingSessionBackupsAPIClient is a client that implements the ListStreamingSessionBackups operation.

type ListStreamingSessionBackupsInput added in v1.15.0 

type ListStreamingSessionBackupsInput struct {

	// The studio ID.
	//
	// This member is required.
	StudioId *string

	// The token for the next set of results, or null if there are no more results.
	NextToken *string

	// The user ID of the user that owns the streaming session.
	OwnedBy *string
	// contains filtered or unexported fields
}

type ListStreamingSessionBackupsOutput added in v1.15.0 

type ListStreamingSessionBackupsOutput struct {

	// The token for the next set of results, or null if there are no more results.
	NextToken *string

	// Information about the streaming session backups.
	StreamingSessionBackups []types.StreamingSessionBackup

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

type ListStreamingSessionBackupsPaginator added in v1.15.0 

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

ListStreamingSessionBackupsPaginator is a paginator for ListStreamingSessionBackups

func NewListStreamingSessionBackupsPaginator added in v1.15.0 

func NewListStreamingSessionBackupsPaginator(client ListStreamingSessionBackupsAPIClient, params *ListStreamingSessionBackupsInput, optFns ...func(*ListStreamingSessionBackupsPaginatorOptions)) *ListStreamingSessionBackupsPaginator

NewListStreamingSessionBackupsPaginator returns a new ListStreamingSessionBackupsPaginator

func (*ListStreamingSessionBackupsPaginator) HasMorePages added in v1.15.0 

func (p *ListStreamingSessionBackupsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListStreamingSessionBackupsPaginator) NextPage added in v1.15.0 

func (p *ListStreamingSessionBackupsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListStreamingSessionBackupsOutput, error)

NextPage retrieves the next ListStreamingSessionBackups page.

type ListStreamingSessionBackupsPaginatorOptions added in v1.15.0 

type ListStreamingSessionBackupsPaginatorOptions struct {
	// 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
}

ListStreamingSessionBackupsPaginatorOptions is the paginator options for ListStreamingSessionBackups

type ListStreamingSessionsAPIClient added in v1.6.0 

type ListStreamingSessionsAPIClient interface {
	ListStreamingSessions(context.Context, *ListStreamingSessionsInput, ...func(*Options)) (*ListStreamingSessionsOutput, error)
}

ListStreamingSessionsAPIClient is a client that implements the ListStreamingSessions operation.

type ListStreamingSessionsInput 

type ListStreamingSessionsInput struct {

	// The studio ID.
	//
	// This member is required.
	StudioId *string

	// Filters the request to streaming sessions created by the given user.
	CreatedBy *string

	// The token for the next set of results, or null if there are no more results.
	NextToken *string

	// Filters the request to streaming session owned by the given user
	OwnedBy *string

	// Filters the request to only the provided session IDs.
	SessionIds *string
	// contains filtered or unexported fields
}

type ListStreamingSessionsOutput 

type ListStreamingSessionsOutput struct {

	// The token for the next set of results, or null if there are no more results.
	NextToken *string

	// A collection of streaming sessions.
	Sessions []types.StreamingSession

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

type ListStreamingSessionsPaginator added in v1.6.0 

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

ListStreamingSessionsPaginator is a paginator for ListStreamingSessions

func NewListStreamingSessionsPaginator added in v1.6.0 

func NewListStreamingSessionsPaginator(client ListStreamingSessionsAPIClient, params *ListStreamingSessionsInput, optFns ...func(*ListStreamingSessionsPaginatorOptions)) *ListStreamingSessionsPaginator

NewListStreamingSessionsPaginator returns a new ListStreamingSessionsPaginator

func (*ListStreamingSessionsPaginator) HasMorePages added in v1.6.0 

func (p *ListStreamingSessionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListStreamingSessionsPaginator) NextPage added in v1.6.0 

func (p *ListStreamingSessionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListStreamingSessionsOutput, error)

NextPage retrieves the next ListStreamingSessions page.

type ListStreamingSessionsPaginatorOptions added in v1.6.0 

type ListStreamingSessionsPaginatorOptions struct {
	// 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
}

ListStreamingSessionsPaginatorOptions is the paginator options for ListStreamingSessions

type ListStudioComponentsAPIClient added in v1.6.0 

type ListStudioComponentsAPIClient interface {
	ListStudioComponents(context.Context, *ListStudioComponentsInput, ...func(*Options)) (*ListStudioComponentsOutput, error)
}

ListStudioComponentsAPIClient is a client that implements the ListStudioComponents operation.

type ListStudioComponentsInput 

type ListStudioComponentsInput struct {

	// The studio ID.
	//
	// This member is required.
	StudioId *string

	// The max number of results to return in the response.
	MaxResults *int32

	// The token for the next set of results, or null if there are no more results.
	NextToken *string

	// Filters the request to studio components that are in one of the given states.
	States []types.StudioComponentState

	// Filters the request to studio components that are of one of the given types.
	Types []types.StudioComponentType
	// contains filtered or unexported fields
}

type ListStudioComponentsOutput 

type ListStudioComponentsOutput struct {

	// The token for the next set of results, or null if there are no more results.
	NextToken *string

	// A collection of studio components.
	StudioComponents []types.StudioComponent

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

type ListStudioComponentsPaginator added in v1.6.0 

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

ListStudioComponentsPaginator is a paginator for ListStudioComponents

func NewListStudioComponentsPaginator added in v1.6.0 

func NewListStudioComponentsPaginator(client ListStudioComponentsAPIClient, params *ListStudioComponentsInput, optFns ...func(*ListStudioComponentsPaginatorOptions)) *ListStudioComponentsPaginator

NewListStudioComponentsPaginator returns a new ListStudioComponentsPaginator

func (*ListStudioComponentsPaginator) HasMorePages added in v1.6.0 

func (p *ListStudioComponentsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListStudioComponentsPaginator) NextPage added in v1.6.0 

func (p *ListStudioComponentsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListStudioComponentsOutput, error)

NextPage retrieves the next ListStudioComponents page.

type ListStudioComponentsPaginatorOptions added in v1.6.0 

type ListStudioComponentsPaginatorOptions struct {
	// The max number of results to return in the 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
}

ListStudioComponentsPaginatorOptions is the paginator options for ListStudioComponents

type ListStudioMembersAPIClient added in v1.6.0 

type ListStudioMembersAPIClient interface {
	ListStudioMembers(context.Context, *ListStudioMembersInput, ...func(*Options)) (*ListStudioMembersOutput, error)
}

ListStudioMembersAPIClient is a client that implements the ListStudioMembers operation.

type ListStudioMembersInput 

type ListStudioMembersInput struct {

	// The studio ID.
	//
	// This member is required.
	StudioId *string

	// The max number of results to return in the response.
	MaxResults *int32

	// The token for the next set of results, or null if there are no more results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListStudioMembersOutput 

type ListStudioMembersOutput struct {

	// A list of admin members.
	Members []types.StudioMembership

	// The token for the next set of results, or null if there are no more results.
	NextToken *string

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

type ListStudioMembersPaginator added in v1.6.0 

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

ListStudioMembersPaginator is a paginator for ListStudioMembers

func NewListStudioMembersPaginator added in v1.6.0 

func NewListStudioMembersPaginator(client ListStudioMembersAPIClient, params *ListStudioMembersInput, optFns ...func(*ListStudioMembersPaginatorOptions)) *ListStudioMembersPaginator

NewListStudioMembersPaginator returns a new ListStudioMembersPaginator

func (*ListStudioMembersPaginator) HasMorePages added in v1.6.0 

func (p *ListStudioMembersPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListStudioMembersPaginator) NextPage added in v1.6.0 

func (p *ListStudioMembersPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListStudioMembersOutput, error)

NextPage retrieves the next ListStudioMembers page.

type ListStudioMembersPaginatorOptions added in v1.6.0 

type ListStudioMembersPaginatorOptions struct {
	// The max number of results to return in the 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
}

ListStudioMembersPaginatorOptions is the paginator options for ListStudioMembers

type ListStudiosAPIClient added in v1.6.0 

type ListStudiosAPIClient interface {
	ListStudios(context.Context, *ListStudiosInput, ...func(*Options)) (*ListStudiosOutput, error)
}

ListStudiosAPIClient is a client that implements the ListStudios operation.

type ListStudiosInput 

type ListStudiosInput struct {

	// The token for the next set of results, or null if there are no more results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListStudiosOutput 

type ListStudiosOutput struct {

	// A collection of studios.
	//
	// This member is required.
	Studios []types.Studio

	// The token for the next set of results, or null if there are no more results.
	NextToken *string

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

type ListStudiosPaginator added in v1.6.0 

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

ListStudiosPaginator is a paginator for ListStudios

func NewListStudiosPaginator added in v1.6.0 

func NewListStudiosPaginator(client ListStudiosAPIClient, params *ListStudiosInput, optFns ...func(*ListStudiosPaginatorOptions)) *ListStudiosPaginator

NewListStudiosPaginator returns a new ListStudiosPaginator

func (*ListStudiosPaginator) HasMorePages added in v1.6.0 

func (p *ListStudiosPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListStudiosPaginator) NextPage added in v1.6.0 

func (p *ListStudiosPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListStudiosOutput, error)

NextPage retrieves the next ListStudios page.

type ListStudiosPaginatorOptions added in v1.6.0 

type ListStudiosPaginatorOptions struct {
	// 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
}

ListStudiosPaginatorOptions is the paginator options for ListStudios

type ListTagsForResourceInput 

type ListTagsForResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource for which you want to list tags.
	//
	// This member is required.
	ResourceArn *string
	// contains filtered or unexported fields
}

type ListTagsForResourceOutput 

type ListTagsForResourceOutput struct {

	// A collection of labels, in the form of key-value pairs, that apply to this
	// resource.
	Tags map[string]string

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

type Options 

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

	// 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 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 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 added in v1.20.2 

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

type PutLaunchProfileMembersInput 

type PutLaunchProfileMembersInput struct {

	// The ID of the identity store.
	//
	// This member is required.
	IdentityStoreId *string

	// The ID of the launch profile used to control access from the streaming session.
	//
	// This member is required.
	LaunchProfileId *string

	// A list of members.
	//
	// This member is required.
	Members []types.NewLaunchProfileMember

	// The studio ID.
	//
	// This member is required.
	StudioId *string

	// Unique, case-sensitive identifier that you provide to ensure the idempotency of
	// the request. If you don’t specify a client token, the Amazon Web Services SDK
	// automatically generates a client token and uses it for the request to ensure
	// idempotency.
	ClientToken *string
	// contains filtered or unexported fields
}

type PutLaunchProfileMembersOutput 

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

type PutStudioMembersInput 

type PutStudioMembersInput struct {

	// The ID of the identity store.
	//
	// This member is required.
	IdentityStoreId *string

	// A list of members.
	//
	// This member is required.
	Members []types.NewStudioMember

	// The studio ID.
	//
	// This member is required.
	StudioId *string

	// Unique, case-sensitive identifier that you provide to ensure the idempotency of
	// the request. If you don’t specify a client token, the Amazon Web Services SDK
	// automatically generates a client token and uses it for the request to ensure
	// idempotency.
	ClientToken *string
	// contains filtered or unexported fields
}

type PutStudioMembersOutput 

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

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 StartStreamingSessionInput added in v1.6.0 

type StartStreamingSessionInput struct {

	// The streaming session ID for the StartStreamingSessionRequest .
	//
	// This member is required.
	SessionId *string

	// The studio ID for the StartStreamingSessionRequest.
	//
	// This member is required.
	StudioId *string

	// The ID of the backup.
	BackupId *string

	// Unique, case-sensitive identifier that you provide to ensure the idempotency of
	// the request. If you don’t specify a client token, the Amazon Web Services SDK
	// automatically generates a client token and uses it for the request to ensure
	// idempotency.
	ClientToken *string
	// contains filtered or unexported fields
}

type StartStreamingSessionOutput added in v1.6.0 

type StartStreamingSessionOutput struct {

	// A streaming session is a virtual workstation created using a particular launch
	// profile.
	Session *types.StreamingSession

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

type StartStudioSSOConfigurationRepairInput 

type StartStudioSSOConfigurationRepairInput struct {

	// The studio ID.
	//
	// This member is required.
	StudioId *string

	// Unique, case-sensitive identifier that you provide to ensure the idempotency of
	// the request. If you don’t specify a client token, the Amazon Web Services SDK
	// automatically generates a client token and uses it for the request to ensure
	// idempotency.
	ClientToken *string
	// contains filtered or unexported fields
}

type StartStudioSSOConfigurationRepairOutput 

type StartStudioSSOConfigurationRepairOutput struct {

	// Information about a studio.
	//
	// This member is required.
	Studio *types.Studio

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

type StopStreamingSessionInput added in v1.6.0 

type StopStreamingSessionInput struct {

	// The streaming session ID for the StopStreamingSessionRequest .
	//
	// This member is required.
	SessionId *string

	// The studioId for the StopStreamingSessionRequest.
	//
	// This member is required.
	StudioId *string

	// Unique, case-sensitive identifier that you provide to ensure the idempotency of
	// the request. If you don’t specify a client token, the Amazon Web Services SDK
	// automatically generates a client token and uses it for the request to ensure
	// idempotency.
	ClientToken *string

	// Adds additional instructions to a streaming session stop action to either
	// retain the EBS volumes or delete the EBS volumes.
	VolumeRetentionMode types.VolumeRetentionMode
	// contains filtered or unexported fields
}

type StopStreamingSessionOutput added in v1.6.0 

type StopStreamingSessionOutput struct {

	// A streaming session is a virtual workstation created using a particular launch
	// profile.
	Session *types.StreamingSession

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

type StreamingImageDeletedWaiter added in v1.6.0 

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

StreamingImageDeletedWaiter defines the waiters for StreamingImageDeleted

func NewStreamingImageDeletedWaiter added in v1.6.0 

func NewStreamingImageDeletedWaiter(client GetStreamingImageAPIClient, optFns ...func(*StreamingImageDeletedWaiterOptions)) *StreamingImageDeletedWaiter

NewStreamingImageDeletedWaiter constructs a StreamingImageDeletedWaiter.

func (*StreamingImageDeletedWaiter) Wait added in v1.6.0 

func (w *StreamingImageDeletedWaiter) Wait(ctx context.Context, params *GetStreamingImageInput, maxWaitDur time.Duration, optFns ...func(*StreamingImageDeletedWaiterOptions)) error

Wait calls the waiter function for StreamingImageDeleted waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

func (*StreamingImageDeletedWaiter) WaitForOutput added in v1.7.0 

func (w *StreamingImageDeletedWaiter) WaitForOutput(ctx context.Context, params *GetStreamingImageInput, maxWaitDur time.Duration, optFns ...func(*StreamingImageDeletedWaiterOptions)) (*GetStreamingImageOutput, error)

WaitForOutput calls the waiter function for StreamingImageDeleted waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

type StreamingImageDeletedWaiterOptions added in v1.6.0 

type StreamingImageDeletedWaiterOptions 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.
	//
	// Passing options here is functionally equivalent to passing values to this
	// config's ClientOptions field that extend the inner client's APIOptions directly.
	APIOptions []func(*middleware.Stack) error

	// Functional options to be passed to all operations invoked by this client.
	//
	// Function values that modify the inner APIOptions are applied after the waiter
	// config's own APIOptions modifiers.
	ClientOptions []func(*Options)

	// MinDelay is the minimum amount of time to delay between retries. If unset,
	// StreamingImageDeletedWaiter will use default minimum delay of 2 seconds. Note
	// that MinDelay must resolve to a value lesser than or equal to the MaxDelay.
	MinDelay time.Duration

	// MaxDelay is the maximum amount of time to delay between retries. If unset or
	// set to zero, StreamingImageDeletedWaiter will use default max delay of 120
	// seconds. Note that MaxDelay must resolve to value greater than or equal to the
	// MinDelay.
	MaxDelay time.Duration

	// LogWaitAttempts is used to enable logging for waiter retry attempts
	LogWaitAttempts bool

	// Retryable is function that can be used to override the service defined
	// waiter-behavior based on operation output, or returned error. This function is
	// used by the waiter to decide if a state is retryable or a terminal state. By
	// default service-modeled logic will populate this option. This option can thus be
	// used to define a custom waiter state with fall-back to service-modeled waiter
	// state mutators.The function returns an error in case of a failure state. In case
	// of retry state, this function returns a bool value of true and nil error, while
	// in case of success it returns a bool value of false and nil error.
	Retryable func(context.Context, *GetStreamingImageInput, *GetStreamingImageOutput, error) (bool, error)
}

StreamingImageDeletedWaiterOptions are waiter options for StreamingImageDeletedWaiter

type StreamingImageReadyWaiter added in v1.6.0 

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

StreamingImageReadyWaiter defines the waiters for StreamingImageReady

func NewStreamingImageReadyWaiter added in v1.6.0 

func NewStreamingImageReadyWaiter(client GetStreamingImageAPIClient, optFns ...func(*StreamingImageReadyWaiterOptions)) *StreamingImageReadyWaiter

NewStreamingImageReadyWaiter constructs a StreamingImageReadyWaiter.

func (*StreamingImageReadyWaiter) Wait added in v1.6.0 

func (w *StreamingImageReadyWaiter) Wait(ctx context.Context, params *GetStreamingImageInput, maxWaitDur time.Duration, optFns ...func(*StreamingImageReadyWaiterOptions)) error

Wait calls the waiter function for StreamingImageReady waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

func (*StreamingImageReadyWaiter) WaitForOutput added in v1.7.0 

func (w *StreamingImageReadyWaiter) WaitForOutput(ctx context.Context, params *GetStreamingImageInput, maxWaitDur time.Duration, optFns ...func(*StreamingImageReadyWaiterOptions)) (*GetStreamingImageOutput, error)

WaitForOutput calls the waiter function for StreamingImageReady waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

type StreamingImageReadyWaiterOptions added in v1.6.0 

type StreamingImageReadyWaiterOptions 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.
	//
	// Passing options here is functionally equivalent to passing values to this
	// config's ClientOptions field that extend the inner client's APIOptions directly.
	APIOptions []func(*middleware.Stack) error

	// Functional options to be passed to all operations invoked by this client.
	//
	// Function values that modify the inner APIOptions are applied after the waiter
	// config's own APIOptions modifiers.
	ClientOptions []func(*Options)

	// MinDelay is the minimum amount of time to delay between retries. If unset,
	// StreamingImageReadyWaiter will use default minimum delay of 2 seconds. Note that
	// MinDelay must resolve to a value lesser than or equal to the MaxDelay.
	MinDelay time.Duration

	// MaxDelay is the maximum amount of time to delay between retries. If unset or
	// set to zero, StreamingImageReadyWaiter will use default max delay of 120
	// seconds. Note that MaxDelay must resolve to value greater than or equal to the
	// MinDelay.
	MaxDelay time.Duration

	// LogWaitAttempts is used to enable logging for waiter retry attempts
	LogWaitAttempts bool

	// Retryable is function that can be used to override the service defined
	// waiter-behavior based on operation output, or returned error. This function is
	// used by the waiter to decide if a state is retryable or a terminal state. By
	// default service-modeled logic will populate this option. This option can thus be
	// used to define a custom waiter state with fall-back to service-modeled waiter
	// state mutators.The function returns an error in case of a failure state. In case
	// of retry state, this function returns a bool value of true and nil error, while
	// in case of success it returns a bool value of false and nil error.
	Retryable func(context.Context, *GetStreamingImageInput, *GetStreamingImageOutput, error) (bool, error)
}

StreamingImageReadyWaiterOptions are waiter options for StreamingImageReadyWaiter

type StreamingSessionDeletedWaiter added in v1.6.0 

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

StreamingSessionDeletedWaiter defines the waiters for StreamingSessionDeleted

func NewStreamingSessionDeletedWaiter added in v1.6.0 

func NewStreamingSessionDeletedWaiter(client GetStreamingSessionAPIClient, optFns ...func(*StreamingSessionDeletedWaiterOptions)) *StreamingSessionDeletedWaiter

NewStreamingSessionDeletedWaiter constructs a StreamingSessionDeletedWaiter.

func (*StreamingSessionDeletedWaiter) Wait added in v1.6.0 

func (w *StreamingSessionDeletedWaiter) Wait(ctx context.Context, params *GetStreamingSessionInput, maxWaitDur time.Duration, optFns ...func(*StreamingSessionDeletedWaiterOptions)) error

Wait calls the waiter function for StreamingSessionDeleted waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

func (*StreamingSessionDeletedWaiter) WaitForOutput added in v1.7.0 

func (w *StreamingSessionDeletedWaiter) WaitForOutput(ctx context.Context, params *GetStreamingSessionInput, maxWaitDur time.Duration, optFns ...func(*StreamingSessionDeletedWaiterOptions)) (*GetStreamingSessionOutput, error)

WaitForOutput calls the waiter function for StreamingSessionDeleted waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

type StreamingSessionDeletedWaiterOptions added in v1.6.0 

type StreamingSessionDeletedWaiterOptions 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.
	//
	// Passing options here is functionally equivalent to passing values to this
	// config's ClientOptions field that extend the inner client's APIOptions directly.
	APIOptions []func(*middleware.Stack) error

	// Functional options to be passed to all operations invoked by this client.
	//
	// Function values that modify the inner APIOptions are applied after the waiter
	// config's own APIOptions modifiers.
	ClientOptions []func(*Options)

	// MinDelay is the minimum amount of time to delay between retries. If unset,
	// StreamingSessionDeletedWaiter will use default minimum delay of 5 seconds. Note
	// that MinDelay must resolve to a value lesser than or equal to the MaxDelay.
	MinDelay time.Duration

	// MaxDelay is the maximum amount of time to delay between retries. If unset or
	// set to zero, StreamingSessionDeletedWaiter will use default max delay of 900
	// seconds. Note that MaxDelay must resolve to value greater than or equal to the
	// MinDelay.
	MaxDelay time.Duration

	// LogWaitAttempts is used to enable logging for waiter retry attempts
	LogWaitAttempts bool

	// Retryable is function that can be used to override the service defined
	// waiter-behavior based on operation output, or returned error. This function is
	// used by the waiter to decide if a state is retryable or a terminal state. By
	// default service-modeled logic will populate this option. This option can thus be
	// used to define a custom waiter state with fall-back to service-modeled waiter
	// state mutators.The function returns an error in case of a failure state. In case
	// of retry state, this function returns a bool value of true and nil error, while
	// in case of success it returns a bool value of false and nil error.
	Retryable func(context.Context, *GetStreamingSessionInput, *GetStreamingSessionOutput, error) (bool, error)
}

StreamingSessionDeletedWaiterOptions are waiter options for StreamingSessionDeletedWaiter

type StreamingSessionReadyWaiter added in v1.6.0 

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

StreamingSessionReadyWaiter defines the waiters for StreamingSessionReady

func NewStreamingSessionReadyWaiter added in v1.6.0 

func NewStreamingSessionReadyWaiter(client GetStreamingSessionAPIClient, optFns ...func(*StreamingSessionReadyWaiterOptions)) *StreamingSessionReadyWaiter

NewStreamingSessionReadyWaiter constructs a StreamingSessionReadyWaiter.

func (*StreamingSessionReadyWaiter) Wait added in v1.6.0 

func (w *StreamingSessionReadyWaiter) Wait(ctx context.Context, params *GetStreamingSessionInput, maxWaitDur time.Duration, optFns ...func(*StreamingSessionReadyWaiterOptions)) error

Wait calls the waiter function for StreamingSessionReady waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

func (*StreamingSessionReadyWaiter) WaitForOutput added in v1.7.0 

func (w *StreamingSessionReadyWaiter) WaitForOutput(ctx context.Context, params *GetStreamingSessionInput, maxWaitDur time.Duration, optFns ...func(*StreamingSessionReadyWaiterOptions)) (*GetStreamingSessionOutput, error)

WaitForOutput calls the waiter function for StreamingSessionReady waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

type StreamingSessionReadyWaiterOptions added in v1.6.0 

type StreamingSessionReadyWaiterOptions 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.
	//
	// Passing options here is functionally equivalent to passing values to this
	// config's ClientOptions field that extend the inner client's APIOptions directly.
	APIOptions []func(*middleware.Stack) error

	// Functional options to be passed to all operations invoked by this client.
	//
	// Function values that modify the inner APIOptions are applied after the waiter
	// config's own APIOptions modifiers.
	ClientOptions []func(*Options)

	// MinDelay is the minimum amount of time to delay between retries. If unset,
	// StreamingSessionReadyWaiter will use default minimum delay of 10 seconds. Note
	// that MinDelay must resolve to a value lesser than or equal to the MaxDelay.
	MinDelay time.Duration

	// MaxDelay is the maximum amount of time to delay between retries. If unset or
	// set to zero, StreamingSessionReadyWaiter will use default max delay of 1800
	// seconds. Note that MaxDelay must resolve to value greater than or equal to the
	// MinDelay.
	MaxDelay time.Duration

	// LogWaitAttempts is used to enable logging for waiter retry attempts
	LogWaitAttempts bool

	// Retryable is function that can be used to override the service defined
	// waiter-behavior based on operation output, or returned error. This function is
	// used by the waiter to decide if a state is retryable or a terminal state. By
	// default service-modeled logic will populate this option. This option can thus be
	// used to define a custom waiter state with fall-back to service-modeled waiter
	// state mutators.The function returns an error in case of a failure state. In case
	// of retry state, this function returns a bool value of true and nil error, while
	// in case of success it returns a bool value of false and nil error.
	Retryable func(context.Context, *GetStreamingSessionInput, *GetStreamingSessionOutput, error) (bool, error)
}

StreamingSessionReadyWaiterOptions are waiter options for StreamingSessionReadyWaiter

type StreamingSessionStoppedWaiter added in v1.6.0 

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

StreamingSessionStoppedWaiter defines the waiters for StreamingSessionStopped

func NewStreamingSessionStoppedWaiter added in v1.6.0 

func NewStreamingSessionStoppedWaiter(client GetStreamingSessionAPIClient, optFns ...func(*StreamingSessionStoppedWaiterOptions)) *StreamingSessionStoppedWaiter

NewStreamingSessionStoppedWaiter constructs a StreamingSessionStoppedWaiter.

func (*StreamingSessionStoppedWaiter) Wait added in v1.6.0 

func (w *StreamingSessionStoppedWaiter) Wait(ctx context.Context, params *GetStreamingSessionInput, maxWaitDur time.Duration, optFns ...func(*StreamingSessionStoppedWaiterOptions)) error

Wait calls the waiter function for StreamingSessionStopped waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

func (*StreamingSessionStoppedWaiter) WaitForOutput added in v1.7.0 

func (w *StreamingSessionStoppedWaiter) WaitForOutput(ctx context.Context, params *GetStreamingSessionInput, maxWaitDur time.Duration, optFns ...func(*StreamingSessionStoppedWaiterOptions)) (*GetStreamingSessionOutput, error)

WaitForOutput calls the waiter function for StreamingSessionStopped waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

type StreamingSessionStoppedWaiterOptions added in v1.6.0 

type StreamingSessionStoppedWaiterOptions 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.
	//
	// Passing options here is functionally equivalent to passing values to this
	// config's ClientOptions field that extend the inner client's APIOptions directly.
	APIOptions []func(*middleware.Stack) error

	// Functional options to be passed to all operations invoked by this client.
	//
	// Function values that modify the inner APIOptions are applied after the waiter
	// config's own APIOptions modifiers.
	ClientOptions []func(*Options)

	// MinDelay is the minimum amount of time to delay between retries. If unset,
	// StreamingSessionStoppedWaiter will use default minimum delay of 5 seconds. Note
	// that MinDelay must resolve to a value lesser than or equal to the MaxDelay.
	MinDelay time.Duration

	// MaxDelay is the maximum amount of time to delay between retries. If unset or
	// set to zero, StreamingSessionStoppedWaiter will use default max delay of 900
	// seconds. Note that MaxDelay must resolve to value greater than or equal to the
	// MinDelay.
	MaxDelay time.Duration

	// LogWaitAttempts is used to enable logging for waiter retry attempts
	LogWaitAttempts bool

	// Retryable is function that can be used to override the service defined
	// waiter-behavior based on operation output, or returned error. This function is
	// used by the waiter to decide if a state is retryable or a terminal state. By
	// default service-modeled logic will populate this option. This option can thus be
	// used to define a custom waiter state with fall-back to service-modeled waiter
	// state mutators.The function returns an error in case of a failure state. In case
	// of retry state, this function returns a bool value of true and nil error, while
	// in case of success it returns a bool value of false and nil error.
	Retryable func(context.Context, *GetStreamingSessionInput, *GetStreamingSessionOutput, error) (bool, error)
}

StreamingSessionStoppedWaiterOptions are waiter options for StreamingSessionStoppedWaiter

type StreamingSessionStreamReadyWaiter added in v1.6.0 

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

StreamingSessionStreamReadyWaiter defines the waiters for StreamingSessionStreamReady

func NewStreamingSessionStreamReadyWaiter added in v1.6.0 

func NewStreamingSessionStreamReadyWaiter(client GetStreamingSessionStreamAPIClient, optFns ...func(*StreamingSessionStreamReadyWaiterOptions)) *StreamingSessionStreamReadyWaiter

NewStreamingSessionStreamReadyWaiter constructs a StreamingSessionStreamReadyWaiter.

func (*StreamingSessionStreamReadyWaiter) Wait added in v1.6.0 

func (w *StreamingSessionStreamReadyWaiter) Wait(ctx context.Context, params *GetStreamingSessionStreamInput, maxWaitDur time.Duration, optFns ...func(*StreamingSessionStreamReadyWaiterOptions)) error

Wait calls the waiter function for StreamingSessionStreamReady waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

func (*StreamingSessionStreamReadyWaiter) WaitForOutput added in v1.7.0 

func (w *StreamingSessionStreamReadyWaiter) WaitForOutput(ctx context.Context, params *GetStreamingSessionStreamInput, maxWaitDur time.Duration, optFns ...func(*StreamingSessionStreamReadyWaiterOptions)) (*GetStreamingSessionStreamOutput, error)

WaitForOutput calls the waiter function for StreamingSessionStreamReady waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

type StreamingSessionStreamReadyWaiterOptions added in v1.6.0 

type StreamingSessionStreamReadyWaiterOptions 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.
	//
	// Passing options here is functionally equivalent to passing values to this
	// config's ClientOptions field that extend the inner client's APIOptions directly.
	APIOptions []func(*middleware.Stack) error

	// Functional options to be passed to all operations invoked by this client.
	//
	// Function values that modify the inner APIOptions are applied after the waiter
	// config's own APIOptions modifiers.
	ClientOptions []func(*Options)

	// MinDelay is the minimum amount of time to delay between retries. If unset,
	// StreamingSessionStreamReadyWaiter will use default minimum delay of 5 seconds.
	// Note that MinDelay must resolve to a value lesser than or equal to the MaxDelay.
	MinDelay time.Duration

	// MaxDelay is the maximum amount of time to delay between retries. If unset or
	// set to zero, StreamingSessionStreamReadyWaiter will use default max delay of 150
	// seconds. Note that MaxDelay must resolve to value greater than or equal to the
	// MinDelay.
	MaxDelay time.Duration

	// LogWaitAttempts is used to enable logging for waiter retry attempts
	LogWaitAttempts bool

	// Retryable is function that can be used to override the service defined
	// waiter-behavior based on operation output, or returned error. This function is
	// used by the waiter to decide if a state is retryable or a terminal state. By
	// default service-modeled logic will populate this option. This option can thus be
	// used to define a custom waiter state with fall-back to service-modeled waiter
	// state mutators.The function returns an error in case of a failure state. In case
	// of retry state, this function returns a bool value of true and nil error, while
	// in case of success it returns a bool value of false and nil error.
	Retryable func(context.Context, *GetStreamingSessionStreamInput, *GetStreamingSessionStreamOutput, error) (bool, error)
}

StreamingSessionStreamReadyWaiterOptions are waiter options for StreamingSessionStreamReadyWaiter

type StudioComponentDeletedWaiter added in v1.6.0 

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

StudioComponentDeletedWaiter defines the waiters for StudioComponentDeleted

func NewStudioComponentDeletedWaiter added in v1.6.0 

func NewStudioComponentDeletedWaiter(client GetStudioComponentAPIClient, optFns ...func(*StudioComponentDeletedWaiterOptions)) *StudioComponentDeletedWaiter

NewStudioComponentDeletedWaiter constructs a StudioComponentDeletedWaiter.

func (*StudioComponentDeletedWaiter) Wait added in v1.6.0 

func (w *StudioComponentDeletedWaiter) Wait(ctx context.Context, params *GetStudioComponentInput, maxWaitDur time.Duration, optFns ...func(*StudioComponentDeletedWaiterOptions)) error

Wait calls the waiter function for StudioComponentDeleted waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

func (*StudioComponentDeletedWaiter) WaitForOutput added in v1.7.0 

func (w *StudioComponentDeletedWaiter) WaitForOutput(ctx context.Context, params *GetStudioComponentInput, maxWaitDur time.Duration, optFns ...func(*StudioComponentDeletedWaiterOptions)) (*GetStudioComponentOutput, error)

WaitForOutput calls the waiter function for StudioComponentDeleted waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

type StudioComponentDeletedWaiterOptions added in v1.6.0 

type StudioComponentDeletedWaiterOptions 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.
	//
	// Passing options here is functionally equivalent to passing values to this
	// config's ClientOptions field that extend the inner client's APIOptions directly.
	APIOptions []func(*middleware.Stack) error

	// Functional options to be passed to all operations invoked by this client.
	//
	// Function values that modify the inner APIOptions are applied after the waiter
	// config's own APIOptions modifiers.
	ClientOptions []func(*Options)

	// MinDelay is the minimum amount of time to delay between retries. If unset,
	// StudioComponentDeletedWaiter will use default minimum delay of 1 seconds. Note
	// that MinDelay must resolve to a value lesser than or equal to the MaxDelay.
	MinDelay time.Duration

	// MaxDelay is the maximum amount of time to delay between retries. If unset or
	// set to zero, StudioComponentDeletedWaiter will use default max delay of 120
	// seconds. Note that MaxDelay must resolve to value greater than or equal to the
	// MinDelay.
	MaxDelay time.Duration

	// LogWaitAttempts is used to enable logging for waiter retry attempts
	LogWaitAttempts bool

	// Retryable is function that can be used to override the service defined
	// waiter-behavior based on operation output, or returned error. This function is
	// used by the waiter to decide if a state is retryable or a terminal state. By
	// default service-modeled logic will populate this option. This option can thus be
	// used to define a custom waiter state with fall-back to service-modeled waiter
	// state mutators.The function returns an error in case of a failure state. In case
	// of retry state, this function returns a bool value of true and nil error, while
	// in case of success it returns a bool value of false and nil error.
	Retryable func(context.Context, *GetStudioComponentInput, *GetStudioComponentOutput, error) (bool, error)
}

StudioComponentDeletedWaiterOptions are waiter options for StudioComponentDeletedWaiter

type StudioComponentReadyWaiter added in v1.6.0 

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

StudioComponentReadyWaiter defines the waiters for StudioComponentReady

func NewStudioComponentReadyWaiter added in v1.6.0 

func NewStudioComponentReadyWaiter(client GetStudioComponentAPIClient, optFns ...func(*StudioComponentReadyWaiterOptions)) *StudioComponentReadyWaiter

NewStudioComponentReadyWaiter constructs a StudioComponentReadyWaiter.

func (*StudioComponentReadyWaiter) Wait added in v1.6.0 

func (w *StudioComponentReadyWaiter) Wait(ctx context.Context, params *GetStudioComponentInput, maxWaitDur time.Duration, optFns ...func(*StudioComponentReadyWaiterOptions)) error

Wait calls the waiter function for StudioComponentReady waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

func (*StudioComponentReadyWaiter) WaitForOutput added in v1.7.0 

func (w *StudioComponentReadyWaiter) WaitForOutput(ctx context.Context, params *GetStudioComponentInput, maxWaitDur time.Duration, optFns ...func(*StudioComponentReadyWaiterOptions)) (*GetStudioComponentOutput, error)

WaitForOutput calls the waiter function for StudioComponentReady waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

type StudioComponentReadyWaiterOptions added in v1.6.0 

type StudioComponentReadyWaiterOptions 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.
	//
	// Passing options here is functionally equivalent to passing values to this
	// config's ClientOptions field that extend the inner client's APIOptions directly.
	APIOptions []func(*middleware.Stack) error

	// Functional options to be passed to all operations invoked by this client.
	//
	// Function values that modify the inner APIOptions are applied after the waiter
	// config's own APIOptions modifiers.
	ClientOptions []func(*Options)

	// MinDelay is the minimum amount of time to delay between retries. If unset,
	// StudioComponentReadyWaiter will use default minimum delay of 2 seconds. Note
	// that MinDelay must resolve to a value lesser than or equal to the MaxDelay.
	MinDelay time.Duration

	// MaxDelay is the maximum amount of time to delay between retries. If unset or
	// set to zero, StudioComponentReadyWaiter will use default max delay of 120
	// seconds. Note that MaxDelay must resolve to value greater than or equal to the
	// MinDelay.
	MaxDelay time.Duration

	// LogWaitAttempts is used to enable logging for waiter retry attempts
	LogWaitAttempts bool

	// Retryable is function that can be used to override the service defined
	// waiter-behavior based on operation output, or returned error. This function is
	// used by the waiter to decide if a state is retryable or a terminal state. By
	// default service-modeled logic will populate this option. This option can thus be
	// used to define a custom waiter state with fall-back to service-modeled waiter
	// state mutators.The function returns an error in case of a failure state. In case
	// of retry state, this function returns a bool value of true and nil error, while
	// in case of success it returns a bool value of false and nil error.
	Retryable func(context.Context, *GetStudioComponentInput, *GetStudioComponentOutput, error) (bool, error)
}

StudioComponentReadyWaiterOptions are waiter options for StudioComponentReadyWaiter

type StudioDeletedWaiter added in v1.6.0 

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

StudioDeletedWaiter defines the waiters for StudioDeleted

func NewStudioDeletedWaiter added in v1.6.0 

func NewStudioDeletedWaiter(client GetStudioAPIClient, optFns ...func(*StudioDeletedWaiterOptions)) *StudioDeletedWaiter

NewStudioDeletedWaiter constructs a StudioDeletedWaiter.

func (*StudioDeletedWaiter) Wait added in v1.6.0 

func (w *StudioDeletedWaiter) Wait(ctx context.Context, params *GetStudioInput, maxWaitDur time.Duration, optFns ...func(*StudioDeletedWaiterOptions)) error

Wait calls the waiter function for StudioDeleted waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

func (*StudioDeletedWaiter) WaitForOutput added in v1.7.0 

func (w *StudioDeletedWaiter) WaitForOutput(ctx context.Context, params *GetStudioInput, maxWaitDur time.Duration, optFns ...func(*StudioDeletedWaiterOptions)) (*GetStudioOutput, error)

WaitForOutput calls the waiter function for StudioDeleted waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

type StudioDeletedWaiterOptions added in v1.6.0 

type StudioDeletedWaiterOptions 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.
	//
	// Passing options here is functionally equivalent to passing values to this
	// config's ClientOptions field that extend the inner client's APIOptions directly.
	APIOptions []func(*middleware.Stack) error

	// Functional options to be passed to all operations invoked by this client.
	//
	// Function values that modify the inner APIOptions are applied after the waiter
	// config's own APIOptions modifiers.
	ClientOptions []func(*Options)

	// MinDelay is the minimum amount of time to delay between retries. If unset,
	// StudioDeletedWaiter will use default minimum delay of 2 seconds. Note that
	// MinDelay must resolve to a value lesser than or equal to the MaxDelay.
	MinDelay time.Duration

	// MaxDelay is the maximum amount of time to delay between retries. If unset or
	// set to zero, StudioDeletedWaiter will use default max delay of 120 seconds. Note
	// that MaxDelay must resolve to value greater than or equal to the MinDelay.
	MaxDelay time.Duration

	// LogWaitAttempts is used to enable logging for waiter retry attempts
	LogWaitAttempts bool

	// Retryable is function that can be used to override the service defined
	// waiter-behavior based on operation output, or returned error. This function is
	// used by the waiter to decide if a state is retryable or a terminal state. By
	// default service-modeled logic will populate this option. This option can thus be
	// used to define a custom waiter state with fall-back to service-modeled waiter
	// state mutators.The function returns an error in case of a failure state. In case
	// of retry state, this function returns a bool value of true and nil error, while
	// in case of success it returns a bool value of false and nil error.
	Retryable func(context.Context, *GetStudioInput, *GetStudioOutput, error) (bool, error)
}

StudioDeletedWaiterOptions are waiter options for StudioDeletedWaiter

type StudioReadyWaiter added in v1.6.0 

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

StudioReadyWaiter defines the waiters for StudioReady

func NewStudioReadyWaiter added in v1.6.0 

func NewStudioReadyWaiter(client GetStudioAPIClient, optFns ...func(*StudioReadyWaiterOptions)) *StudioReadyWaiter

NewStudioReadyWaiter constructs a StudioReadyWaiter.

func (*StudioReadyWaiter) Wait added in v1.6.0 

func (w *StudioReadyWaiter) Wait(ctx context.Context, params *GetStudioInput, maxWaitDur time.Duration, optFns ...func(*StudioReadyWaiterOptions)) error

Wait calls the waiter function for StudioReady waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

func (*StudioReadyWaiter) WaitForOutput added in v1.7.0 

func (w *StudioReadyWaiter) WaitForOutput(ctx context.Context, params *GetStudioInput, maxWaitDur time.Duration, optFns ...func(*StudioReadyWaiterOptions)) (*GetStudioOutput, error)

WaitForOutput calls the waiter function for StudioReady waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

type StudioReadyWaiterOptions added in v1.6.0 

type StudioReadyWaiterOptions 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.
	//
	// Passing options here is functionally equivalent to passing values to this
	// config's ClientOptions field that extend the inner client's APIOptions directly.
	APIOptions []func(*middleware.Stack) error

	// Functional options to be passed to all operations invoked by this client.
	//
	// Function values that modify the inner APIOptions are applied after the waiter
	// config's own APIOptions modifiers.
	ClientOptions []func(*Options)

	// MinDelay is the minimum amount of time to delay between retries. If unset,
	// StudioReadyWaiter will use default minimum delay of 2 seconds. Note that
	// MinDelay must resolve to a value lesser than or equal to the MaxDelay.
	MinDelay time.Duration

	// MaxDelay is the maximum amount of time to delay between retries. If unset or
	// set to zero, StudioReadyWaiter will use default max delay of 120 seconds. Note
	// that MaxDelay must resolve to value greater than or equal to the MinDelay.
	MaxDelay time.Duration

	// LogWaitAttempts is used to enable logging for waiter retry attempts
	LogWaitAttempts bool

	// Retryable is function that can be used to override the service defined
	// waiter-behavior based on operation output, or returned error. This function is
	// used by the waiter to decide if a state is retryable or a terminal state. By
	// default service-modeled logic will populate this option. This option can thus be
	// used to define a custom waiter state with fall-back to service-modeled waiter
	// state mutators.The function returns an error in case of a failure state. In case
	// of retry state, this function returns a bool value of true and nil error, while
	// in case of success it returns a bool value of false and nil error.
	Retryable func(context.Context, *GetStudioInput, *GetStudioOutput, error) (bool, error)
}

StudioReadyWaiterOptions are waiter options for StudioReadyWaiter

type TagResourceInput 

type TagResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource you want to add tags to.
	//
	// This member is required.
	ResourceArn *string

	// A collection of labels, in the form of key-value pairs, that apply to this
	// resource.
	Tags map[string]string
	// contains filtered or unexported fields
}

type TagResourceOutput 

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

type UntagResourceInput 

type UntagResourceInput struct {

	// Identifies the Amazon Resource Name(ARN) key from which you are removing tags.
	//
	// This member is required.
	ResourceArn *string

	// One or more tag keys. Specify only the tag keys, not the tag values.
	//
	// This member is required.
	TagKeys []string
	// contains filtered or unexported fields
}

type UntagResourceOutput 

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

type UpdateLaunchProfileInput 

type UpdateLaunchProfileInput struct {

	// The ID of the launch profile used to control access from the streaming session.
	//
	// This member is required.
	LaunchProfileId *string

	// The studio ID.
	//
	// This member is required.
	StudioId *string

	// Unique, case-sensitive identifier that you provide to ensure the idempotency of
	// the request. If you don’t specify a client token, the Amazon Web Services SDK
	// automatically generates a client token and uses it for the request to ensure
	// idempotency.
	ClientToken *string

	// The description.
	Description *string

	// The version number of the protocol that is used by the launch profile. The only
	// valid version is "2021-03-31".
	LaunchProfileProtocolVersions []string

	// The name for the launch profile.
	Name *string

	// A configuration for a streaming session.
	StreamConfiguration *types.StreamConfigurationCreate

	// Unique identifiers for a collection of studio components that can be used with
	// this launch profile.
	StudioComponentIds []string
	// contains filtered or unexported fields
}

type UpdateLaunchProfileMemberInput 

type UpdateLaunchProfileMemberInput struct {

	// The ID of the launch profile used to control access from the streaming session.
	//
	// This member is required.
	LaunchProfileId *string

	// The persona.
	//
	// This member is required.
	Persona types.LaunchProfilePersona

	// The principal ID. This currently supports a IAM Identity Center UserId.
	//
	// This member is required.
	PrincipalId *string

	// The studio ID.
	//
	// This member is required.
	StudioId *string

	// Unique, case-sensitive identifier that you provide to ensure the idempotency of
	// the request. If you don’t specify a client token, the Amazon Web Services SDK
	// automatically generates a client token and uses it for the request to ensure
	// idempotency.
	ClientToken *string
	// contains filtered or unexported fields
}

type UpdateLaunchProfileMemberOutput 

type UpdateLaunchProfileMemberOutput struct {

	// The updated member.
	Member *types.LaunchProfileMembership

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

type UpdateLaunchProfileOutput 

type UpdateLaunchProfileOutput struct {

	// The launch profile.
	LaunchProfile *types.LaunchProfile

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

type UpdateStreamingImageInput 

type UpdateStreamingImageInput struct {

	// The streaming image ID.
	//
	// This member is required.
	StreamingImageId *string

	// The studio ID.
	//
	// This member is required.
	StudioId *string

	// Unique, case-sensitive identifier that you provide to ensure the idempotency of
	// the request. If you don’t specify a client token, the Amazon Web Services SDK
	// automatically generates a client token and uses it for the request to ensure
	// idempotency.
	ClientToken *string

	// The description.
	Description *string

	// The name for the streaming image.
	Name *string
	// contains filtered or unexported fields
}

type UpdateStreamingImageOutput 

type UpdateStreamingImageOutput struct {

	// Represents a streaming image resource. Streaming images are used by studio
	// users to select which operating system and software they want to use in a Nimble
	// Studio streaming session. Amazon provides a number of streaming images that
	// include popular 3rd-party software. You can create your own streaming images
	// using an Amazon EC2 machine image that you create for this purpose. You can also
	// include software that your users require.
	StreamingImage *types.StreamingImage

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

type UpdateStudioComponentInput 

type UpdateStudioComponentInput struct {

	// The studio component ID.
	//
	// This member is required.
	StudioComponentId *string

	// The studio ID.
	//
	// This member is required.
	StudioId *string

	// Unique, case-sensitive identifier that you provide to ensure the idempotency of
	// the request. If you don’t specify a client token, the Amazon Web Services SDK
	// automatically generates a client token and uses it for the request to ensure
	// idempotency.
	ClientToken *string

	// The configuration of the studio component, based on component type.
	Configuration *types.StudioComponentConfiguration

	// The description.
	Description *string

	// The EC2 security groups that control access to the studio component.
	Ec2SecurityGroupIds []string

	// Initialization scripts for studio components.
	InitializationScripts []types.StudioComponentInitializationScript

	// The name for the studio component.
	Name *string

	// An IAM role attached to a Studio Component that gives the studio component
	// access to Amazon Web Services resources at anytime while the instance is
	// running.
	RuntimeRoleArn *string

	// Parameters for the studio component scripts.
	ScriptParameters []types.ScriptParameterKeyValue

	// An IAM role attached to Studio Component when the system initialization script
	// runs which give the studio component access to Amazon Web Services resources
	// when the system initialization script runs.
	SecureInitializationRoleArn *string

	// The specific subtype of a studio component.
	Subtype types.StudioComponentSubtype

	// The type of the studio component.
	Type types.StudioComponentType
	// contains filtered or unexported fields
}

type UpdateStudioComponentOutput 

type UpdateStudioComponentOutput struct {

	// Information about the studio component.
	StudioComponent *types.StudioComponent

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

type UpdateStudioInput 

type UpdateStudioInput struct {

	// The studio ID.
	//
	// This member is required.
	StudioId *string

	// The IAM role that Studio Admins will assume when logging in to the Nimble
	// Studio portal.
	AdminRoleArn *string

	// Unique, case-sensitive identifier that you provide to ensure the idempotency of
	// the request. If you don’t specify a client token, the Amazon Web Services SDK
	// automatically generates a client token and uses it for the request to ensure
	// idempotency.
	ClientToken *string

	// A friendly name for the studio.
	DisplayName *string

	// The IAM role that Studio Users will assume when logging in to the Nimble Studio
	// portal.
	UserRoleArn *string
	// contains filtered or unexported fields
}

type UpdateStudioOutput 

type UpdateStudioOutput struct {

	// Information about a studio.
	//
	// This member is required.
	Studio *types.Studio

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

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.