ivsrealtime

package module
v1.21.1 Latest Latest
Warning

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

 Go to latest Published: Dec 19, 2024 License: Apache-2.0 Imports: 45 Imported by: 6

Documentation

Overview

Package ivsrealtime provides the API client, operations, and parameter types for Amazon Interactive Video Service RealTime.

The Amazon Interactive Video Service (IVS) real-time API is REST compatible, using a standard HTTP API and an AWS EventBridge event stream for responses. JSON is used for both requests and responses, including errors.

Key Concepts

  • Stage — A virtual space where participants can exchange video in real time.

  • Participant token — A token that authenticates a participant when they join a stage.

  • Participant object — Represents participants (people) in the stage and contains information about them. When a token is created, it includes a participant ID; when a participant uses that token to join a stage, the participant is associated with that participant ID. There is a 1:1 mapping between participant tokens and participants.

For server-side composition:

  • Composition process — Composites participants of a stage into a single video and forwards it to a set of outputs (e.g., IVS channels). Composition operations support this process.

  • Composition — Controls the look of the outputs, including how participants are positioned in the video.

For more information about your IVS live stream, also see Getting Started with Amazon IVS Real-Time Streaming.

Tagging

A tag is a metadata label that you assign to an AWS resource. A tag comprises a key and a value, both set by you. For example, you might set a tag as topic:nature to label a particular video category. See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS stages has no service-specific constraints beyond what is documented there.

Tags can help you identify and organize your AWS resources. For example, you can use the same tag for different resources to indicate that they are related. You can also use tags to manage access (see Access Tags).

The Amazon IVS real-time API has these tag-related operations: TagResource, UntagResource, and ListTagsForResource. The following resource supports tagging: Stage.

At most 50 tags can be applied to a resource.

Index

Constants

View Source 
const ServiceAPIVersion = "2020-07-14"
View Source 
const ServiceID = "IVS RealTime"

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

func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)

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

func WithSigV4SigningName added in v1.7.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.7.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 AuthResolverParameters added in v1.7.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.7.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 Amazon Interactive Video Service RealTime.

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) CreateEncoderConfiguration added in v1.8.0 

func (c *Client) CreateEncoderConfiguration(ctx context.Context, params *CreateEncoderConfigurationInput, optFns ...func(*Options)) (*CreateEncoderConfigurationOutput, error)

Creates an EncoderConfiguration object.

func (*Client) CreateIngestConfiguration added in v1.17.0 

func (c *Client) CreateIngestConfiguration(ctx context.Context, params *CreateIngestConfigurationInput, optFns ...func(*Options)) (*CreateIngestConfigurationOutput, error)

Creates a new IngestConfiguration resource, used to specify the ingest protocol for a stage.

func (*Client) CreateParticipantToken 

func (c *Client) CreateParticipantToken(ctx context.Context, params *CreateParticipantTokenInput, optFns ...func(*Options)) (*CreateParticipantTokenOutput, error)

Creates an additional token for a specified stage. This can be done after stage creation or when tokens expire. Tokens always are scoped to the stage for which they are created.

Encryption keys are owned by Amazon IVS and never used directly by your application.

func (*Client) CreateStage 

func (c *Client) CreateStage(ctx context.Context, params *CreateStageInput, optFns ...func(*Options)) (*CreateStageOutput, error)

Creates a new stage (and optionally participant tokens).

func (*Client) CreateStorageConfiguration added in v1.8.0 

func (c *Client) CreateStorageConfiguration(ctx context.Context, params *CreateStorageConfigurationInput, optFns ...func(*Options)) (*CreateStorageConfigurationOutput, error)

Creates a new storage configuration, used to enable recording to Amazon S3. When a StorageConfiguration is created, IVS will modify the S3 bucketPolicy of the provided bucket. This will ensure that IVS has sufficient permissions to write content to the provided bucket.

func (*Client) DeleteEncoderConfiguration added in v1.8.0 

func (c *Client) DeleteEncoderConfiguration(ctx context.Context, params *DeleteEncoderConfigurationInput, optFns ...func(*Options)) (*DeleteEncoderConfigurationOutput, error)

Deletes an EncoderConfiguration resource. Ensures that no Compositions are using this template; otherwise, returns an error.

func (*Client) DeleteIngestConfiguration added in v1.17.0 

func (c *Client) DeleteIngestConfiguration(ctx context.Context, params *DeleteIngestConfigurationInput, optFns ...func(*Options)) (*DeleteIngestConfigurationOutput, error)

Deletes a specified IngestConfiguration, so it can no longer be used to broadcast. An IngestConfiguration cannot be deleted if the publisher is actively streaming to a stage, unless force is set to true .

func (*Client) DeletePublicKey added in v1.16.0 

func (c *Client) DeletePublicKey(ctx context.Context, params *DeletePublicKeyInput, optFns ...func(*Options)) (*DeletePublicKeyOutput, error)

Deletes the specified public key used to sign stage participant tokens. This invalidates future participant tokens generated using the key pair’s private key.

func (*Client) DeleteStage 

func (c *Client) DeleteStage(ctx context.Context, params *DeleteStageInput, optFns ...func(*Options)) (*DeleteStageOutput, error)

Shuts down and deletes the specified stage (disconnecting all participants). This operation also removes the stageArn from the associated IngestConfiguration, if there are participants using the IngestConfiguration to publish to the stage.

func (*Client) DeleteStorageConfiguration added in v1.8.0 

func (c *Client) DeleteStorageConfiguration(ctx context.Context, params *DeleteStorageConfigurationInput, optFns ...func(*Options)) (*DeleteStorageConfigurationOutput, error)

Deletes the storage configuration for the specified ARN.

If you try to delete a storage configuration that is used by a Composition, you will get an error (409 ConflictException). To avoid this, for all Compositions that reference the storage configuration, first use StopCompositionand wait for it to complete, then use DeleteStorageConfiguration.

func (*Client) DisconnectParticipant 

func (c *Client) DisconnectParticipant(ctx context.Context, params *DisconnectParticipantInput, optFns ...func(*Options)) (*DisconnectParticipantOutput, error)

Disconnects a specified participant from a specified stage. If the participant is publishing using an IngestConfiguration, DisconnectParticipant also updates the stageArn in the IngestConfiguration to be an empty string.

func (*Client) GetComposition added in v1.8.0 

func (c *Client) GetComposition(ctx context.Context, params *GetCompositionInput, optFns ...func(*Options)) (*GetCompositionOutput, error)

Get information about the specified Composition resource.

func (*Client) GetEncoderConfiguration added in v1.8.0 

func (c *Client) GetEncoderConfiguration(ctx context.Context, params *GetEncoderConfigurationInput, optFns ...func(*Options)) (*GetEncoderConfigurationOutput, error)

Gets information about the specified EncoderConfiguration resource.

func (*Client) GetIngestConfiguration added in v1.17.0 

func (c *Client) GetIngestConfiguration(ctx context.Context, params *GetIngestConfigurationInput, optFns ...func(*Options)) (*GetIngestConfigurationOutput, error)

Gets information about the specified IngestConfiguration.

func (*Client) GetParticipant added in v1.2.0 

func (c *Client) GetParticipant(ctx context.Context, params *GetParticipantInput, optFns ...func(*Options)) (*GetParticipantOutput, error)

Gets information about the specified participant token.

func (*Client) GetPublicKey added in v1.16.0 

func (c *Client) GetPublicKey(ctx context.Context, params *GetPublicKeyInput, optFns ...func(*Options)) (*GetPublicKeyOutput, error)

Gets information for the specified public key.

func (*Client) GetStage 

func (c *Client) GetStage(ctx context.Context, params *GetStageInput, optFns ...func(*Options)) (*GetStageOutput, error)

Gets information for the specified stage.

func (*Client) GetStageSession added in v1.2.0 

func (c *Client) GetStageSession(ctx context.Context, params *GetStageSessionInput, optFns ...func(*Options)) (*GetStageSessionOutput, error)

Gets information for the specified stage session.

func (*Client) GetStorageConfiguration added in v1.8.0 

func (c *Client) GetStorageConfiguration(ctx context.Context, params *GetStorageConfigurationInput, optFns ...func(*Options)) (*GetStorageConfigurationOutput, error)

Gets the storage configuration for the specified ARN.

func (*Client) ImportPublicKey added in v1.16.0 

func (c *Client) ImportPublicKey(ctx context.Context, params *ImportPublicKeyInput, optFns ...func(*Options)) (*ImportPublicKeyOutput, error)

Import a public key to be used for signing stage participant tokens.

func (*Client) ListCompositions added in v1.8.0 

func (c *Client) ListCompositions(ctx context.Context, params *ListCompositionsInput, optFns ...func(*Options)) (*ListCompositionsOutput, error)

Gets summary information about all Compositions in your account, in the AWS region where the API request is processed.

func (*Client) ListEncoderConfigurations added in v1.8.0 

func (c *Client) ListEncoderConfigurations(ctx context.Context, params *ListEncoderConfigurationsInput, optFns ...func(*Options)) (*ListEncoderConfigurationsOutput, error)

Gets summary information about all EncoderConfigurations in your account, in the AWS region where the API request is processed.

func (*Client) ListIngestConfigurations added in v1.17.0 

func (c *Client) ListIngestConfigurations(ctx context.Context, params *ListIngestConfigurationsInput, optFns ...func(*Options)) (*ListIngestConfigurationsOutput, error)

Lists all IngestConfigurations in your account, in the AWS region where the API request is processed.

func (*Client) ListParticipantEvents added in v1.2.0 

func (c *Client) ListParticipantEvents(ctx context.Context, params *ListParticipantEventsInput, optFns ...func(*Options)) (*ListParticipantEventsOutput, error)

Lists events for a specified participant that occurred during a specified stage session.

func (*Client) ListParticipants added in v1.2.0 

func (c *Client) ListParticipants(ctx context.Context, params *ListParticipantsInput, optFns ...func(*Options)) (*ListParticipantsOutput, error)

Lists all participants in a specified stage session.

func (*Client) ListPublicKeys added in v1.16.0 

func (c *Client) ListPublicKeys(ctx context.Context, params *ListPublicKeysInput, optFns ...func(*Options)) (*ListPublicKeysOutput, error)

Gets summary information about all public keys in your account, in the AWS region where the API request is processed.

func (*Client) ListStageSessions added in v1.2.0 

func (c *Client) ListStageSessions(ctx context.Context, params *ListStageSessionsInput, optFns ...func(*Options)) (*ListStageSessionsOutput, error)

Gets all sessions for a specified stage.

func (*Client) ListStages 

func (c *Client) ListStages(ctx context.Context, params *ListStagesInput, optFns ...func(*Options)) (*ListStagesOutput, error)

Gets summary information about all stages in your account, in the AWS region where the API request is processed.

func (*Client) ListStorageConfigurations added in v1.8.0 

func (c *Client) ListStorageConfigurations(ctx context.Context, params *ListStorageConfigurationsInput, optFns ...func(*Options)) (*ListStorageConfigurationsOutput, error)

Gets summary information about all storage configurations in your account, in the AWS region where the API request is processed.

func (*Client) ListTagsForResource 

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

Gets information about AWS tags for the specified ARN.

func (*Client) Options added in v1.9.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) StartComposition added in v1.8.0 

func (c *Client) StartComposition(ctx context.Context, params *StartCompositionInput, optFns ...func(*Options)) (*StartCompositionOutput, error)

Starts a Composition from a stage based on the configuration provided in the request.

A Composition is an ephemeral resource that exists after this operation returns successfully. Composition stops and the resource is deleted:

  • When StopCompositionis called.

  • After a 1-minute timeout, when all participants are disconnected from the stage.

  • After a 1-minute timeout, if there are no participants in the stage when StartComposition is called.

  • When broadcasting to the IVS channel fails and all retries are exhausted.

  • When broadcasting is disconnected and all attempts to reconnect are exhausted.

func (*Client) StopComposition added in v1.8.0 

func (c *Client) StopComposition(ctx context.Context, params *StopCompositionInput, optFns ...func(*Options)) (*StopCompositionOutput, error)

Stops and deletes a Composition resource. Any broadcast from the Composition resource is stopped.

func (*Client) TagResource 

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

Adds or updates tags for the AWS resource with the specified ARN.

func (*Client) UntagResource 

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

Removes tags from the resource with the specified ARN.

func (*Client) UpdateIngestConfiguration added in v1.17.0 

func (c *Client) UpdateIngestConfiguration(ctx context.Context, params *UpdateIngestConfigurationInput, optFns ...func(*Options)) (*UpdateIngestConfigurationOutput, error)

Updates a specified IngestConfiguration. Only the stage ARN attached to the IngestConfiguration can be updated. An IngestConfiguration that is active cannot be updated.

func (*Client) UpdateStage 

func (c *Client) UpdateStage(ctx context.Context, params *UpdateStageInput, optFns ...func(*Options)) (*UpdateStageOutput, error)

Updates a stage’s configuration.

type CreateEncoderConfigurationInput added in v1.8.0 

type CreateEncoderConfigurationInput struct {

	// Optional name to identify the resource.
	Name *string

	// Tags attached to the resource. Array of maps, each of the form string:string
	// (key:value) . See [Best practices and strategies] in Tagging AWS Resources and Tag Editor for details,
	// including restrictions that apply to tags and "Tag naming limits and
	// requirements"; Amazon IVS has no constraints on tags beyond what is documented
	// there.
	//
	// [Best practices and strategies]: https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html
	Tags map[string]string

	// Video configuration. Default: video resolution 1280x720, bitrate 2500 kbps, 30
	// fps.
	Video *types.Video
	// contains filtered or unexported fields
}

type CreateEncoderConfigurationOutput added in v1.8.0 

type CreateEncoderConfigurationOutput struct {

	// The EncoderConfiguration that was created.
	EncoderConfiguration *types.EncoderConfiguration

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

type CreateIngestConfigurationInput added in v1.17.0 

type CreateIngestConfigurationInput struct {

	// Type of ingest protocol that the user employs to broadcast. If this is set to
	// RTMP , insecureIngest must be set to true .
	//
	// This member is required.
	IngestProtocol types.IngestProtocol

	// Application-provided attributes to store in the IngestConfiguration and attach
	// to a stage. Map keys and values can contain UTF-8 encoded text. The maximum
	// length of this field is 1 KB total. This field is exposed to all stage
	// participants and should not be used for personally identifying, confidential, or
	// sensitive information.
	Attributes map[string]string

	// Whether the stage allows insecure RTMP ingest. This must be set to true , if
	// ingestProtocol is set to RTMP . Default: false .
	InsecureIngest bool

	// Optional name that can be specified for the IngestConfiguration being created.
	Name *string

	// ARN of the stage with which the IngestConfiguration is associated.
	StageArn *string

	// Tags attached to the resource. Array of maps, each of the form string:string
	// (key:value) . See [Best practices and strategies] in Tagging AWS Resources and Tag Editor for details,
	// including restrictions that apply to tags and "Tag naming limits and
	// requirements"; Amazon IVS has no constraints on tags beyond what is documented
	// there.
	//
	// [Best practices and strategies]: https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html
	Tags map[string]string

	// Customer-assigned name to help identify the participant using the
	// IngestConfiguration; this can be used to link a participant to a user in the
	// customer’s own systems. This can be any UTF-8 encoded text. This field is
	// exposed to all stage participants and should not be used for personally
	// identifying, confidential, or sensitive information.
	UserId *string
	// contains filtered or unexported fields
}

type CreateIngestConfigurationOutput added in v1.17.0 

type CreateIngestConfigurationOutput struct {

	// The IngestConfiguration that was created.
	IngestConfiguration *types.IngestConfiguration

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

type CreateParticipantTokenInput 

type CreateParticipantTokenInput struct {

	// ARN of the stage to which this token is scoped.
	//
	// This member is required.
	StageArn *string

	// Application-provided attributes to encode into the token and attach to a stage.
	// Map keys and values can contain UTF-8 encoded text. The maximum length of this
	// field is 1 KB total. This field is exposed to all stage participants and should
	// not be used for personally identifying, confidential, or sensitive information.
	Attributes map[string]string

	// Set of capabilities that the user is allowed to perform in the stage. Default:
	// PUBLISH, SUBSCRIBE .
	Capabilities []types.ParticipantTokenCapability

	// Duration (in minutes), after which the token expires. Default: 720 (12 hours).
	Duration *int32

	// Name that can be specified to help identify the token. This can be any UTF-8
	// encoded text. This field is exposed to all stage participants and should not be
	// used for personally identifying, confidential, or sensitive information.
	UserId *string
	// contains filtered or unexported fields
}

type CreateParticipantTokenOutput 

type CreateParticipantTokenOutput struct {

	// The participant token that was created.
	ParticipantToken *types.ParticipantToken

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

type CreateStageInput 

type CreateStageInput struct {

	// Configuration object for individual participant recording, to attach to the new
	// stage.
	AutoParticipantRecordingConfiguration *types.AutoParticipantRecordingConfiguration

	// Optional name that can be specified for the stage being created.
	Name *string

	// Array of participant token configuration objects to attach to the new stage.
	ParticipantTokenConfigurations []types.ParticipantTokenConfiguration

	// Tags attached to the resource. Array of maps, each of the form string:string
	// (key:value) . See [Best practices and strategies] in Tagging AWS Resources and Tag Editor for details,
	// including restrictions that apply to tags and "Tag naming limits and
	// requirements"; Amazon IVS has no constraints on tags beyond what is documented
	// there.
	//
	// [Best practices and strategies]: https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateStageOutput 

type CreateStageOutput struct {

	// Participant tokens attached to the stage. These correspond to the participants
	// in the request.
	ParticipantTokens []types.ParticipantToken

	// The stage that was created.
	Stage *types.Stage

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

type CreateStorageConfigurationInput added in v1.8.0 

type CreateStorageConfigurationInput struct {

	// A complex type that contains a storage configuration for where recorded video
	// will be stored.
	//
	// This member is required.
	S3 *types.S3StorageConfiguration

	// Storage configuration name. The value does not need to be unique.
	Name *string

	// Tags attached to the resource. Array of maps, each of the form string:string
	// (key:value) . See [Best practices and strategies] in Tagging AWS Resources and Tag Editor for details,
	// including restrictions that apply to tags and "Tag naming limits and
	// requirements"; Amazon IVS has no constraints on tags beyond what is documented
	// there.
	//
	// [Best practices and strategies]: https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateStorageConfigurationOutput added in v1.8.0 

type CreateStorageConfigurationOutput struct {

	// The StorageConfiguration that was created.
	StorageConfiguration *types.StorageConfiguration

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

type DeleteEncoderConfigurationInput added in v1.8.0 

type DeleteEncoderConfigurationInput struct {

	// ARN of the EncoderConfiguration.
	//
	// This member is required.
	Arn *string
	// contains filtered or unexported fields
}

type DeleteEncoderConfigurationOutput added in v1.8.0 

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

type DeleteIngestConfigurationInput added in v1.17.0 

type DeleteIngestConfigurationInput struct {

	// ARN of the IngestConfiguration.
	//
	// This member is required.
	Arn *string

	// Optional field to force deletion of the IngestConfiguration. If this is set to
	// true when a participant is actively publishing, the participant is disconnected
	// from the stage, followed by deletion of the IngestConfiguration. Default: false .
	Force bool
	// contains filtered or unexported fields
}

type DeleteIngestConfigurationOutput added in v1.17.0 

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

type DeletePublicKeyInput added in v1.16.0 

type DeletePublicKeyInput struct {

	// ARN of the public key to be deleted.
	//
	// This member is required.
	Arn *string
	// contains filtered or unexported fields
}

type DeletePublicKeyOutput added in v1.16.0 

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

type DeleteStageInput 

type DeleteStageInput struct {

	// ARN of the stage to be deleted.
	//
	// This member is required.
	Arn *string
	// contains filtered or unexported fields
}

type DeleteStageOutput 

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

type DeleteStorageConfigurationInput added in v1.8.0 

type DeleteStorageConfigurationInput struct {

	// ARN of the storage configuration to be deleted.
	//
	// This member is required.
	Arn *string
	// contains filtered or unexported fields
}

type DeleteStorageConfigurationOutput added in v1.8.0 

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

type DisconnectParticipantInput 

type DisconnectParticipantInput struct {

	// Identifier of the participant to be disconnected. IVS assigns this; it is
	// returned by CreateParticipantToken(for streams using WebRTC ingest) or CreateIngestConfiguration (for streams using RTMP
	// ingest).
	//
	// This member is required.
	ParticipantId *string

	// ARN of the stage to which the participant is attached.
	//
	// This member is required.
	StageArn *string

	// Description of why this participant is being disconnected.
	Reason *string
	// contains filtered or unexported fields
}

type DisconnectParticipantOutput 

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

type EndpointParameters added in v1.3.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.3.0 

func (p EndpointParameters) ValidateRequired() error

ValidateRequired validates required parameters are set.

func (EndpointParameters) WithDefaults added in v1.3.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.3.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.3.0 

func NewDefaultEndpointResolverV2() EndpointResolverV2

type GetCompositionInput added in v1.8.0 

type GetCompositionInput struct {

	// ARN of the Composition resource.
	//
	// This member is required.
	Arn *string
	// contains filtered or unexported fields
}

type GetCompositionOutput added in v1.8.0 

type GetCompositionOutput struct {

	// The Composition that was returned.
	Composition *types.Composition

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

type GetEncoderConfigurationInput added in v1.8.0 

type GetEncoderConfigurationInput struct {

	// ARN of the EncoderConfiguration resource.
	//
	// This member is required.
	Arn *string
	// contains filtered or unexported fields
}

type GetEncoderConfigurationOutput added in v1.8.0 

type GetEncoderConfigurationOutput struct {

	// The EncoderConfiguration that was returned.
	EncoderConfiguration *types.EncoderConfiguration

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

type GetIngestConfigurationInput added in v1.17.0 

type GetIngestConfigurationInput struct {

	// ARN of the ingest for which the information is to be retrieved.
	//
	// This member is required.
	Arn *string
	// contains filtered or unexported fields
}

type GetIngestConfigurationOutput added in v1.17.0 

type GetIngestConfigurationOutput struct {

	// The IngestConfiguration that was returned.
	IngestConfiguration *types.IngestConfiguration

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

type GetParticipantInput added in v1.2.0 

type GetParticipantInput struct {

	// Unique identifier for the participant. This is assigned by IVS and returned by CreateParticipantToken.
	//
	// This member is required.
	ParticipantId *string

	// ID of a session within the stage.
	//
	// This member is required.
	SessionId *string

	// Stage ARN.
	//
	// This member is required.
	StageArn *string
	// contains filtered or unexported fields
}

type GetParticipantOutput added in v1.2.0 

type GetParticipantOutput struct {

	// The participant that is returned.
	Participant *types.Participant

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

type GetPublicKeyInput added in v1.16.0 

type GetPublicKeyInput struct {

	// ARN of the public key for which the information is to be retrieved.
	//
	// This member is required.
	Arn *string
	// contains filtered or unexported fields
}

type GetPublicKeyOutput added in v1.16.0 

type GetPublicKeyOutput struct {

	// The public key that is returned.
	PublicKey *types.PublicKey

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

type GetStageInput 

type GetStageInput struct {

	// ARN of the stage for which the information is to be retrieved.
	//
	// This member is required.
	Arn *string
	// contains filtered or unexported fields
}

type GetStageOutput 

type GetStageOutput struct {

	// The stage that is returned.
	Stage *types.Stage

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

type GetStageSessionInput added in v1.2.0 

type GetStageSessionInput struct {

	// ID of a session within the stage.
	//
	// This member is required.
	SessionId *string

	// ARN of the stage for which the information is to be retrieved.
	//
	// This member is required.
	StageArn *string
	// contains filtered or unexported fields
}

type GetStageSessionOutput added in v1.2.0 

type GetStageSessionOutput struct {

	// The stage session that is returned.
	StageSession *types.StageSession

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

type GetStorageConfigurationInput added in v1.8.0 

type GetStorageConfigurationInput struct {

	// ARN of the storage configuration to be retrieved.
	//
	// This member is required.
	Arn *string
	// contains filtered or unexported fields
}

type GetStorageConfigurationOutput added in v1.8.0 

type GetStorageConfigurationOutput struct {

	// The StorageConfiguration that was returned.
	StorageConfiguration *types.StorageConfiguration

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

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

IdempotencyTokenProvider interface for providing idempotency token

type ImportPublicKeyInput added in v1.16.0 

type ImportPublicKeyInput struct {

	// The content of the public key to be imported.
	//
	// This member is required.
	PublicKeyMaterial *string

	// Name of the public key to be imported.
	Name *string

	// Tags attached to the resource. Array of maps, each of the form string:string
	// (key:value) . See [Best practices and strategies] in Tagging AWS Resources and Tag Editor for details,
	// including restrictions that apply to tags and "Tag naming limits and
	// requirements"; Amazon IVS has no constraints on tags beyond what is documented
	// there.
	//
	// [Best practices and strategies]: https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html
	Tags map[string]string
	// contains filtered or unexported fields
}

type ImportPublicKeyOutput added in v1.16.0 

type ImportPublicKeyOutput struct {

	// The public key that was imported.
	PublicKey *types.PublicKey

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

type ListCompositionsAPIClient added in v1.8.0 

type ListCompositionsAPIClient interface {
	ListCompositions(context.Context, *ListCompositionsInput, ...func(*Options)) (*ListCompositionsOutput, error)
}

ListCompositionsAPIClient is a client that implements the ListCompositions operation.

type ListCompositionsInput added in v1.8.0 

type ListCompositionsInput struct {

	// Filters the Composition list to match the specified EncoderConfiguration
	// attached to at least one of its output.
	FilterByEncoderConfigurationArn *string

	// Filters the Composition list to match the specified Stage ARN.
	FilterByStageArn *string

	// Maximum number of results to return. Default: 100.
	MaxResults *int32

	// The first Composition to retrieve. This is used for pagination; see the
	// nextToken response field.
	NextToken *string
	// contains filtered or unexported fields
}

type ListCompositionsOutput added in v1.8.0 

type ListCompositionsOutput struct {

	// List of the matching Compositions (summary information only).
	//
	// This member is required.
	Compositions []types.CompositionSummary

	// If there are more compositions than maxResults , use nextToken in the request
	// to get the next set.
	NextToken *string

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

type ListCompositionsPaginator added in v1.8.0 

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

ListCompositionsPaginator is a paginator for ListCompositions

func NewListCompositionsPaginator added in v1.8.0 

func NewListCompositionsPaginator(client ListCompositionsAPIClient, params *ListCompositionsInput, optFns ...func(*ListCompositionsPaginatorOptions)) *ListCompositionsPaginator

NewListCompositionsPaginator returns a new ListCompositionsPaginator

func (*ListCompositionsPaginator) HasMorePages added in v1.8.0 

func (p *ListCompositionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListCompositionsPaginator) NextPage added in v1.8.0 

func (p *ListCompositionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListCompositionsOutput, error)

NextPage retrieves the next ListCompositions page.

type ListCompositionsPaginatorOptions added in v1.8.0 

type ListCompositionsPaginatorOptions struct {
	// Maximum number of results to return. Default: 100.
	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
}

ListCompositionsPaginatorOptions is the paginator options for ListCompositions

type ListEncoderConfigurationsAPIClient added in v1.8.0 

type ListEncoderConfigurationsAPIClient interface {
	ListEncoderConfigurations(context.Context, *ListEncoderConfigurationsInput, ...func(*Options)) (*ListEncoderConfigurationsOutput, error)
}

ListEncoderConfigurationsAPIClient is a client that implements the ListEncoderConfigurations operation.

type ListEncoderConfigurationsInput added in v1.8.0 

type ListEncoderConfigurationsInput struct {

	// Maximum number of results to return. Default: 100.
	MaxResults *int32

	// The first encoder configuration to retrieve. This is used for pagination; see
	// the nextToken response field.
	NextToken *string
	// contains filtered or unexported fields
}

type ListEncoderConfigurationsOutput added in v1.8.0 

type ListEncoderConfigurationsOutput struct {

	// List of the matching EncoderConfigurations (summary information only).
	//
	// This member is required.
	EncoderConfigurations []types.EncoderConfigurationSummary

	// If there are more encoder configurations than maxResults , use nextToken in the
	// request to get the next set.
	NextToken *string

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

type ListEncoderConfigurationsPaginator added in v1.8.0 

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

ListEncoderConfigurationsPaginator is a paginator for ListEncoderConfigurations

func NewListEncoderConfigurationsPaginator added in v1.8.0 

func NewListEncoderConfigurationsPaginator(client ListEncoderConfigurationsAPIClient, params *ListEncoderConfigurationsInput, optFns ...func(*ListEncoderConfigurationsPaginatorOptions)) *ListEncoderConfigurationsPaginator

NewListEncoderConfigurationsPaginator returns a new ListEncoderConfigurationsPaginator

func (*ListEncoderConfigurationsPaginator) HasMorePages added in v1.8.0 

func (p *ListEncoderConfigurationsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListEncoderConfigurationsPaginator) NextPage added in v1.8.0 

func (p *ListEncoderConfigurationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListEncoderConfigurationsOutput, error)

NextPage retrieves the next ListEncoderConfigurations page.

type ListEncoderConfigurationsPaginatorOptions added in v1.8.0 

type ListEncoderConfigurationsPaginatorOptions struct {
	// Maximum number of results to return. Default: 100.
	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
}

ListEncoderConfigurationsPaginatorOptions is the paginator options for ListEncoderConfigurations

type ListIngestConfigurationsAPIClient added in v1.17.0 

type ListIngestConfigurationsAPIClient interface {
	ListIngestConfigurations(context.Context, *ListIngestConfigurationsInput, ...func(*Options)) (*ListIngestConfigurationsOutput, error)
}

ListIngestConfigurationsAPIClient is a client that implements the ListIngestConfigurations operation.

type ListIngestConfigurationsInput added in v1.17.0 

type ListIngestConfigurationsInput struct {

	// Filters the response list to match the specified stage ARN. Only one filter (by
	// stage ARN or by state) can be used at a time.
	FilterByStageArn *string

	// Filters the response list to match the specified state. Only one filter (by
	// stage ARN or by state) can be used at a time.
	FilterByState types.IngestConfigurationState

	// Maximum number of results to return. Default: 50.
	MaxResults *int32

	// The first IngestConfiguration to retrieve. This is used for pagination; see the
	// nextToken response field.
	NextToken *string
	// contains filtered or unexported fields
}

type ListIngestConfigurationsOutput added in v1.17.0 

type ListIngestConfigurationsOutput struct {

	// List of the matching ingest configurations (summary information only).
	//
	// This member is required.
	IngestConfigurations []types.IngestConfigurationSummary

	// If there are more IngestConfigurations than maxResults , use nextToken in the
	// request to get the next set.
	NextToken *string

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

type ListIngestConfigurationsPaginator added in v1.17.0 

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

ListIngestConfigurationsPaginator is a paginator for ListIngestConfigurations

func NewListIngestConfigurationsPaginator added in v1.17.0 

func NewListIngestConfigurationsPaginator(client ListIngestConfigurationsAPIClient, params *ListIngestConfigurationsInput, optFns ...func(*ListIngestConfigurationsPaginatorOptions)) *ListIngestConfigurationsPaginator

NewListIngestConfigurationsPaginator returns a new ListIngestConfigurationsPaginator

func (*ListIngestConfigurationsPaginator) HasMorePages added in v1.17.0 

func (p *ListIngestConfigurationsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListIngestConfigurationsPaginator) NextPage added in v1.17.0 

func (p *ListIngestConfigurationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListIngestConfigurationsOutput, error)

NextPage retrieves the next ListIngestConfigurations page.

type ListIngestConfigurationsPaginatorOptions added in v1.17.0 

type ListIngestConfigurationsPaginatorOptions struct {
	// Maximum number of results to return. Default: 50.
	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
}

ListIngestConfigurationsPaginatorOptions is the paginator options for ListIngestConfigurations

type ListParticipantEventsAPIClient added in v1.2.0 

type ListParticipantEventsAPIClient interface {
	ListParticipantEvents(context.Context, *ListParticipantEventsInput, ...func(*Options)) (*ListParticipantEventsOutput, error)
}

ListParticipantEventsAPIClient is a client that implements the ListParticipantEvents operation.

type ListParticipantEventsInput added in v1.2.0 

type ListParticipantEventsInput struct {

	// Unique identifier for this participant. This is assigned by IVS and returned by CreateParticipantToken
	// .
	//
	// This member is required.
	ParticipantId *string

	// ID of a session within the stage.
	//
	// This member is required.
	SessionId *string

	// Stage ARN.
	//
	// This member is required.
	StageArn *string

	// Maximum number of results to return. Default: 50.
	MaxResults *int32

	// The first participant event to retrieve. This is used for pagination; see the
	// nextToken response field.
	NextToken *string
	// contains filtered or unexported fields
}

type ListParticipantEventsOutput added in v1.2.0 

type ListParticipantEventsOutput struct {

	// List of the matching events.
	//
	// This member is required.
	Events []types.Event

	// If there are more events than maxResults , use nextToken in the request to get
	// the next set.
	NextToken *string

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

type ListParticipantEventsPaginator added in v1.2.0 

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

ListParticipantEventsPaginator is a paginator for ListParticipantEvents

func NewListParticipantEventsPaginator added in v1.2.0 

func NewListParticipantEventsPaginator(client ListParticipantEventsAPIClient, params *ListParticipantEventsInput, optFns ...func(*ListParticipantEventsPaginatorOptions)) *ListParticipantEventsPaginator

NewListParticipantEventsPaginator returns a new ListParticipantEventsPaginator

func (*ListParticipantEventsPaginator) HasMorePages added in v1.2.0 

func (p *ListParticipantEventsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListParticipantEventsPaginator) NextPage added in v1.2.0 

func (p *ListParticipantEventsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListParticipantEventsOutput, error)

NextPage retrieves the next ListParticipantEvents page.

type ListParticipantEventsPaginatorOptions added in v1.2.0 

type ListParticipantEventsPaginatorOptions struct {
	// Maximum number of results to return. Default: 50.
	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
}

ListParticipantEventsPaginatorOptions is the paginator options for ListParticipantEvents

type ListParticipantsAPIClient added in v1.2.0 

type ListParticipantsAPIClient interface {
	ListParticipants(context.Context, *ListParticipantsInput, ...func(*Options)) (*ListParticipantsOutput, error)
}

ListParticipantsAPIClient is a client that implements the ListParticipants operation.

type ListParticipantsInput added in v1.2.0 

type ListParticipantsInput struct {

	// ID of the session within the stage.
	//
	// This member is required.
	SessionId *string

	// Stage ARN.
	//
	// This member is required.
	StageArn *string

	// Filters the response list to only show participants who published during the
	// stage session. Only one of filterByUserId , filterByPublished , filterByState ,
	// or filterByRecordingState can be provided per request.
	FilterByPublished bool

	// Filters the response list to only show participants with the specified
	// recording state. Only one of filterByUserId , filterByPublished , filterByState
	// , or filterByRecordingState can be provided per request.
	FilterByRecordingState types.ParticipantRecordingFilterByRecordingState

	// Filters the response list to only show participants in the specified state.
	// Only one of filterByUserId , filterByPublished , filterByState , or
	// filterByRecordingState can be provided per request.
	FilterByState types.ParticipantState

	// Filters the response list to match the specified user ID. Only one of
	// filterByUserId , filterByPublished , filterByState , or filterByRecordingState
	// can be provided per request. A userId is a customer-assigned name to help
	// identify the token; this can be used to link a participant to a user in the
	// customer’s own systems.
	FilterByUserId *string

	// Maximum number of results to return. Default: 50.
	MaxResults *int32

	// The first participant to retrieve. This is used for pagination; see the
	// nextToken response field.
	NextToken *string
	// contains filtered or unexported fields
}

type ListParticipantsOutput added in v1.2.0 

type ListParticipantsOutput struct {

	// List of the matching participants (summary information only).
	//
	// This member is required.
	Participants []types.ParticipantSummary

	// If there are more participants than maxResults , use nextToken in the request
	// to get the next set.
	NextToken *string

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

type ListParticipantsPaginator added in v1.2.0 

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

ListParticipantsPaginator is a paginator for ListParticipants

func NewListParticipantsPaginator added in v1.2.0 

func NewListParticipantsPaginator(client ListParticipantsAPIClient, params *ListParticipantsInput, optFns ...func(*ListParticipantsPaginatorOptions)) *ListParticipantsPaginator

NewListParticipantsPaginator returns a new ListParticipantsPaginator

func (*ListParticipantsPaginator) HasMorePages added in v1.2.0 

func (p *ListParticipantsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListParticipantsPaginator) NextPage added in v1.2.0 

func (p *ListParticipantsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListParticipantsOutput, error)

NextPage retrieves the next ListParticipants page.

type ListParticipantsPaginatorOptions added in v1.2.0 

type ListParticipantsPaginatorOptions struct {
	// Maximum number of results to return. Default: 50.
	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
}

ListParticipantsPaginatorOptions is the paginator options for ListParticipants

type ListPublicKeysAPIClient added in v1.16.0 

type ListPublicKeysAPIClient interface {
	ListPublicKeys(context.Context, *ListPublicKeysInput, ...func(*Options)) (*ListPublicKeysOutput, error)
}

ListPublicKeysAPIClient is a client that implements the ListPublicKeys operation.

type ListPublicKeysInput added in v1.16.0 

type ListPublicKeysInput struct {

	// Maximum number of results to return. Default: 50.
	MaxResults *int32

	// The first public key to retrieve. This is used for pagination; see the nextToken
	// response field.
	NextToken *string
	// contains filtered or unexported fields
}

type ListPublicKeysOutput added in v1.16.0 

type ListPublicKeysOutput struct {

	// List of the matching public keys (summary information only).
	//
	// This member is required.
	PublicKeys []types.PublicKeySummary

	// If there are more public keys than maxResults , use nextToken in the request to
	// get the next set.
	NextToken *string

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

type ListPublicKeysPaginator added in v1.16.0 

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

ListPublicKeysPaginator is a paginator for ListPublicKeys

func NewListPublicKeysPaginator added in v1.16.0 

func NewListPublicKeysPaginator(client ListPublicKeysAPIClient, params *ListPublicKeysInput, optFns ...func(*ListPublicKeysPaginatorOptions)) *ListPublicKeysPaginator

NewListPublicKeysPaginator returns a new ListPublicKeysPaginator

func (*ListPublicKeysPaginator) HasMorePages added in v1.16.0 

func (p *ListPublicKeysPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListPublicKeysPaginator) NextPage added in v1.16.0 

func (p *ListPublicKeysPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListPublicKeysOutput, error)

NextPage retrieves the next ListPublicKeys page.

type ListPublicKeysPaginatorOptions added in v1.16.0 

type ListPublicKeysPaginatorOptions struct {
	// Maximum number of results to return. Default: 50.
	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
}

ListPublicKeysPaginatorOptions is the paginator options for ListPublicKeys

type ListStageSessionsAPIClient added in v1.2.0 

type ListStageSessionsAPIClient interface {
	ListStageSessions(context.Context, *ListStageSessionsInput, ...func(*Options)) (*ListStageSessionsOutput, error)
}

ListStageSessionsAPIClient is a client that implements the ListStageSessions operation.

type ListStageSessionsInput added in v1.2.0 

type ListStageSessionsInput struct {

	// Stage ARN.
	//
	// This member is required.
	StageArn *string

	// Maximum number of results to return. Default: 50.
	MaxResults *int32

	// The first stage session to retrieve. This is used for pagination; see the
	// nextToken response field.
	NextToken *string
	// contains filtered or unexported fields
}

type ListStageSessionsOutput added in v1.2.0 

type ListStageSessionsOutput struct {

	// List of matching stage sessions.
	//
	// This member is required.
	StageSessions []types.StageSessionSummary

	// If there are more stage sessions than maxResults , use nextToken in the request
	// to get the next set.
	NextToken *string

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

type ListStageSessionsPaginator added in v1.2.0 

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

ListStageSessionsPaginator is a paginator for ListStageSessions

func NewListStageSessionsPaginator added in v1.2.0 

func NewListStageSessionsPaginator(client ListStageSessionsAPIClient, params *ListStageSessionsInput, optFns ...func(*ListStageSessionsPaginatorOptions)) *ListStageSessionsPaginator

NewListStageSessionsPaginator returns a new ListStageSessionsPaginator

func (*ListStageSessionsPaginator) HasMorePages added in v1.2.0 

func (p *ListStageSessionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListStageSessionsPaginator) NextPage added in v1.2.0 

func (p *ListStageSessionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListStageSessionsOutput, error)

NextPage retrieves the next ListStageSessions page.

type ListStageSessionsPaginatorOptions added in v1.2.0 

type ListStageSessionsPaginatorOptions struct {
	// Maximum number of results to return. Default: 50.
	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
}

ListStageSessionsPaginatorOptions is the paginator options for ListStageSessions

type ListStagesAPIClient 

type ListStagesAPIClient interface {
	ListStages(context.Context, *ListStagesInput, ...func(*Options)) (*ListStagesOutput, error)
}

ListStagesAPIClient is a client that implements the ListStages operation.

type ListStagesInput 

type ListStagesInput struct {

	// Maximum number of results to return. Default: 50.
	MaxResults *int32

	// The first stage to retrieve. This is used for pagination; see the nextToken
	// response field.
	NextToken *string
	// contains filtered or unexported fields
}

type ListStagesOutput 

type ListStagesOutput struct {

	// List of the matching stages (summary information only).
	//
	// This member is required.
	Stages []types.StageSummary

	// If there are more stages than maxResults , use nextToken in the request to get
	// the next set.
	NextToken *string

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

type ListStagesPaginator 

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

ListStagesPaginator is a paginator for ListStages

func NewListStagesPaginator 

func NewListStagesPaginator(client ListStagesAPIClient, params *ListStagesInput, optFns ...func(*ListStagesPaginatorOptions)) *ListStagesPaginator

NewListStagesPaginator returns a new ListStagesPaginator

func (*ListStagesPaginator) HasMorePages 

func (p *ListStagesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListStagesPaginator) NextPage 

func (p *ListStagesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListStagesOutput, error)

NextPage retrieves the next ListStages page.

type ListStagesPaginatorOptions 

type ListStagesPaginatorOptions struct {
	// Maximum number of results to return. Default: 50.
	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
}

ListStagesPaginatorOptions is the paginator options for ListStages

type ListStorageConfigurationsAPIClient added in v1.8.0 

type ListStorageConfigurationsAPIClient interface {
	ListStorageConfigurations(context.Context, *ListStorageConfigurationsInput, ...func(*Options)) (*ListStorageConfigurationsOutput, error)
}

ListStorageConfigurationsAPIClient is a client that implements the ListStorageConfigurations operation.

type ListStorageConfigurationsInput added in v1.8.0 

type ListStorageConfigurationsInput struct {

	// Maximum number of storage configurations to return. Default: your service quota
	// or 100, whichever is smaller.
	MaxResults *int32

	// The first storage configuration to retrieve. This is used for pagination; see
	// the nextToken response field.
	NextToken *string
	// contains filtered or unexported fields
}

type ListStorageConfigurationsOutput added in v1.8.0 

type ListStorageConfigurationsOutput struct {

	// List of the matching storage configurations.
	//
	// This member is required.
	StorageConfigurations []types.StorageConfigurationSummary

	// If there are more storage configurations than maxResults , use nextToken in the
	// request to get the next set.
	NextToken *string

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

type ListStorageConfigurationsPaginator added in v1.8.0 

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

ListStorageConfigurationsPaginator is a paginator for ListStorageConfigurations

func NewListStorageConfigurationsPaginator added in v1.8.0 

func NewListStorageConfigurationsPaginator(client ListStorageConfigurationsAPIClient, params *ListStorageConfigurationsInput, optFns ...func(*ListStorageConfigurationsPaginatorOptions)) *ListStorageConfigurationsPaginator

NewListStorageConfigurationsPaginator returns a new ListStorageConfigurationsPaginator

func (*ListStorageConfigurationsPaginator) HasMorePages added in v1.8.0 

func (p *ListStorageConfigurationsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListStorageConfigurationsPaginator) NextPage added in v1.8.0 

func (p *ListStorageConfigurationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListStorageConfigurationsOutput, error)

NextPage retrieves the next ListStorageConfigurations page.

type ListStorageConfigurationsPaginatorOptions added in v1.8.0 

type ListStorageConfigurationsPaginatorOptions struct {
	// Maximum number of storage configurations to return. Default: your service quota
	// or 100, whichever is smaller.
	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
}

ListStorageConfigurationsPaginatorOptions is the paginator options for ListStorageConfigurations

type ListTagsForResourceInput 

type ListTagsForResourceInput struct {

	// The ARN of the resource to be retrieved. The ARN must be URL-encoded.
	//
	// This member is required.
	ResourceArn *string
	// contains filtered or unexported fields
}

type ListTagsForResourceOutput 

type ListTagsForResourceOutput struct {

	// Tags attached to the resource. Array of maps, each of the form string:string
	// (key:value) .
	//
	// This member is required.
	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 client meter provider.
	MeterProvider metrics.MeterProvider

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

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

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

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

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

	// The client tracer provider.
	TracerProvider tracing.TracerProvider

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

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

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

func (Options) Copy 

func (o Options) Copy() Options

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

func (Options) GetIdentityResolver added in v1.7.2 

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

type ResolveEndpoint 

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

func (*ResolveEndpoint) HandleSerialize 

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

func (*ResolveEndpoint) ID 

func (*ResolveEndpoint) ID() string

type StartCompositionInput added in v1.8.0 

type StartCompositionInput struct {

	// Array of destination configuration.
	//
	// This member is required.
	Destinations []types.DestinationConfiguration

	// ARN of the stage to be used for compositing.
	//
	// This member is required.
	StageArn *string

	// Idempotency token.
	IdempotencyToken *string

	// Layout object to configure composition parameters.
	Layout *types.LayoutConfiguration

	// Tags attached to the resource. Array of maps, each of the form string:string
	// (key:value) . See [Best practices and strategies] in Tagging AWS Resources and Tag Editor for details,
	// including restrictions that apply to tags and "Tag naming limits and
	// requirements"; Amazon IVS has no constraints on tags beyond what is documented
	// there.
	//
	// [Best practices and strategies]: https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html
	Tags map[string]string
	// contains filtered or unexported fields
}

type StartCompositionOutput added in v1.8.0 

type StartCompositionOutput struct {

	// The Composition that was created.
	Composition *types.Composition

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

type StopCompositionInput added in v1.8.0 

type StopCompositionInput struct {

	// ARN of the Composition.
	//
	// This member is required.
	Arn *string
	// contains filtered or unexported fields
}

type StopCompositionOutput added in v1.8.0 

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

type TagResourceInput 

type TagResourceInput struct {

	// The ARN of the resource to be tagged. The ARN must be URL-encoded.
	//
	// This member is required.
	ResourceArn *string

	// Array of tags to be added or updated. Array of maps, each of the form
	// string:string (key:value) . See [Best practices and strategies] in Tagging AWS Resources and Tag Editor for
	// details, including restrictions that apply to tags and "Tag naming limits and
	// requirements"; Amazon IVS has no constraints on tags beyond what is documented
	// there.
	//
	// [Best practices and strategies]: https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html
	//
	// This member is required.
	Tags map[string]string
	// contains filtered or unexported fields
}

type TagResourceOutput 

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

type UntagResourceInput 

type UntagResourceInput struct {

	// The ARN of the resource to be untagged. The ARN must be URL-encoded.
	//
	// This member is required.
	ResourceArn *string

	// Array of tags to be removed. Array of maps, each of the form string:string
	// (key:value) . See [Best practices and strategies] in Tagging AWS Resources and Tag Editor for details,
	// including restrictions that apply to tags and "Tag naming limits and
	// requirements"; Amazon IVS has no constraints on tags beyond what is documented
	// there.
	//
	// [Best practices and strategies]: https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html
	//
	// 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 UpdateIngestConfigurationInput added in v1.17.0 

type UpdateIngestConfigurationInput struct {

	// ARN of the IngestConfiguration, for which the related stage ARN needs to be
	// updated.
	//
	// This member is required.
	Arn *string

	// Stage ARN that needs to be updated.
	StageArn *string
	// contains filtered or unexported fields
}

type UpdateIngestConfigurationOutput added in v1.17.0 

type UpdateIngestConfigurationOutput struct {

	// The updated IngestConfiguration.
	IngestConfiguration *types.IngestConfiguration

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

type UpdateStageInput 

type UpdateStageInput struct {

	// ARN of the stage to be updated.
	//
	// This member is required.
	Arn *string

	// Configuration object for individual participant recording, to attach to the
	// stage. Note that this cannot be updated while recording is active.
	AutoParticipantRecordingConfiguration *types.AutoParticipantRecordingConfiguration

	// Name of the stage to be updated.
	Name *string
	// contains filtered or unexported fields
}

type UpdateStageOutput 

type UpdateStageOutput struct {

	// The updated stage.
	Stage *types.Stage

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