...
AWS SDK for Go API Reference
We announced the upcoming end-of-support for AWS SDK for Go (v1). We recommend that you migrate to AWS SDK for Go v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.
import "github.com/aws/aws-sdk-go/service/ivsrealtime"
Overview
Constants

Overview ▾

Package ivsrealtime provides the client and types for making API requests to Amazon Interactive Video Service RealTime.

Introduction

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.

Terminology:

  • A stage is a virtual space where participants can exchange video in real time.

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

  • A 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.

  • Server-side composition: The composition process composites participants of a stage into a single video and forwards it to a set of outputs (e.g., IVS channels). Composition endpoints support this process.

  • Server-side composition: A composition controls the look of the outputs, including how participants are positioned in the video.

Resources

The following resources contain information about your IVS live stream (see Getting Started with Amazon IVS Real-Time Streaming (https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/getting-started.html)):

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

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 Tagging AWS Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) for more information, 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 (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html)).

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

At most 50 tags can be applied to a resource.

Stages Endpoints

  • CreateParticipantToken — Creates an additional token for a specified stage. This can be done after stage creation or when tokens expire.

  • CreateStage — Creates a new stage (and optionally participant tokens).

  • DeleteStage — Shuts down and deletes the specified stage (disconnecting all participants).

  • DisconnectParticipant — Disconnects a specified participant and revokes the participant permanently from a specified stage.

  • GetParticipant — Gets information about the specified participant token.

  • GetStage — Gets information for the specified stage.

  • GetStageSession — Gets information for the specified stage session.

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

  • ListParticipants — Lists all participants in a specified stage session.

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

  • ListStageSessions — Gets all sessions for a specified stage.

  • UpdateStage — Updates a stage’s configuration.

Composition Endpoints

  • GetComposition — Gets information about the specified Composition resource.

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

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

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

EncoderConfiguration Endpoints

  • CreateEncoderConfiguration — Creates an EncoderConfiguration object.

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

  • GetEncoderConfiguration — Gets information about the specified EncoderConfiguration resource.

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

StorageConfiguration Endpoints

  • CreateStorageConfiguration — Creates a new storage configuration, used to enable recording to Amazon S3.

  • DeleteStorageConfiguration — Deletes the storage configuration for the specified ARN.

  • GetStorageConfiguration — Gets the storage configuration for the specified ARN.

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

Tags Endpoints

  • ListTagsForResource — Gets information about AWS tags for the specified ARN.

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

  • UntagResource — Removes tags from the resource with the specified ARN.

See https://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14 for more information on this service.

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

Using the Client

To contact Amazon Interactive Video Service RealTime with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

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

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the Amazon Interactive Video Service RealTime client IVSRealTime for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/ivsrealtime/#New

The stub package, ivsrealtimeiface, can be used to provide alternative implementations of service clients, such as mocking the client for testing.

Types ▾

type IVSRealTime
func New(p client.ConfigProvider, cfgs ...*aws.Config) *IVSRealTime
func (c *IVSRealTime) CreateEncoderConfiguration(input *CreateEncoderConfigurationInput) (*CreateEncoderConfigurationOutput, error)
func (c *IVSRealTime) CreateEncoderConfigurationRequest(input *CreateEncoderConfigurationInput) (req *request.Request, output *CreateEncoderConfigurationOutput)
func (c *IVSRealTime) CreateEncoderConfigurationWithContext(ctx aws.Context, input *CreateEncoderConfigurationInput, opts ...request.Option) (*CreateEncoderConfigurationOutput, error)
func (c *IVSRealTime) CreateParticipantToken(input *CreateParticipantTokenInput) (*CreateParticipantTokenOutput, error)
func (c *IVSRealTime) CreateParticipantTokenRequest(input *CreateParticipantTokenInput) (req *request.Request, output *CreateParticipantTokenOutput)
func (c *IVSRealTime) CreateParticipantTokenWithContext(ctx aws.Context, input *CreateParticipantTokenInput, opts ...request.Option) (*CreateParticipantTokenOutput, error)
func (c *IVSRealTime) CreateStage(input *CreateStageInput) (*CreateStageOutput, error)
func (c *IVSRealTime) CreateStageRequest(input *CreateStageInput) (req *request.Request, output *CreateStageOutput)
func (c *IVSRealTime) CreateStageWithContext(ctx aws.Context, input *CreateStageInput, opts ...request.Option) (*CreateStageOutput, error)
func (c *IVSRealTime) CreateStorageConfiguration(input *CreateStorageConfigurationInput) (*CreateStorageConfigurationOutput, error)
func (c *IVSRealTime) CreateStorageConfigurationRequest(input *CreateStorageConfigurationInput) (req *request.Request, output *CreateStorageConfigurationOutput)
func (c *IVSRealTime) CreateStorageConfigurationWithContext(ctx aws.Context, input *CreateStorageConfigurationInput, opts ...request.Option) (*CreateStorageConfigurationOutput, error)
func (c *IVSRealTime) DeleteEncoderConfiguration(input *DeleteEncoderConfigurationInput) (*DeleteEncoderConfigurationOutput, error)
func (c *IVSRealTime) DeleteEncoderConfigurationRequest(input *DeleteEncoderConfigurationInput) (req *request.Request, output *DeleteEncoderConfigurationOutput)
func (c *IVSRealTime) DeleteEncoderConfigurationWithContext(ctx aws.Context, input *DeleteEncoderConfigurationInput, opts ...request.Option) (*DeleteEncoderConfigurationOutput, error)
func (c *IVSRealTime) DeleteStage(input *DeleteStageInput) (*DeleteStageOutput, error)
func (c *IVSRealTime) DeleteStageRequest(input *DeleteStageInput) (req *request.Request, output *DeleteStageOutput)
func (c *IVSRealTime) DeleteStageWithContext(ctx aws.Context, input *DeleteStageInput, opts ...request.Option) (*DeleteStageOutput, error)
func (c *IVSRealTime) DeleteStorageConfiguration(input *DeleteStorageConfigurationInput) (*DeleteStorageConfigurationOutput, error)
func (c *IVSRealTime) DeleteStorageConfigurationRequest(input *DeleteStorageConfigurationInput) (req *request.Request, output *DeleteStorageConfigurationOutput)
func (c *IVSRealTime) DeleteStorageConfigurationWithContext(ctx aws.Context, input *DeleteStorageConfigurationInput, opts ...request.Option) (*DeleteStorageConfigurationOutput, error)
func (c *IVSRealTime) DisconnectParticipant(input *DisconnectParticipantInput) (*DisconnectParticipantOutput, error)
func (c *IVSRealTime) DisconnectParticipantRequest(input *DisconnectParticipantInput) (req *request.Request, output *DisconnectParticipantOutput)
func (c *IVSRealTime) DisconnectParticipantWithContext(ctx aws.Context, input *DisconnectParticipantInput, opts ...request.Option) (*DisconnectParticipantOutput, error)
func (c *IVSRealTime) GetComposition(input *GetCompositionInput) (*GetCompositionOutput, error)
func (c *IVSRealTime) GetCompositionRequest(input *GetCompositionInput) (req *request.Request, output *GetCompositionOutput)
func (c *IVSRealTime) GetCompositionWithContext(ctx aws.Context, input *GetCompositionInput, opts ...request.Option) (*GetCompositionOutput, error)
func (c *IVSRealTime) GetEncoderConfiguration(input *GetEncoderConfigurationInput) (*GetEncoderConfigurationOutput, error)
func (c *IVSRealTime) GetEncoderConfigurationRequest(input *GetEncoderConfigurationInput) (req *request.Request, output *GetEncoderConfigurationOutput)
func (c *IVSRealTime) GetEncoderConfigurationWithContext(ctx aws.Context, input *GetEncoderConfigurationInput, opts ...request.Option) (*GetEncoderConfigurationOutput, error)
func (c *IVSRealTime) GetParticipant(input *GetParticipantInput) (*GetParticipantOutput, error)
func (c *IVSRealTime) GetParticipantRequest(input *GetParticipantInput) (req *request.Request, output *GetParticipantOutput)
func (c *IVSRealTime) GetParticipantWithContext(ctx aws.Context, input *GetParticipantInput, opts ...request.Option) (*GetParticipantOutput, error)
func (c *IVSRealTime) GetStage(input *GetStageInput) (*GetStageOutput, error)
func (c *IVSRealTime) GetStageRequest(input *GetStageInput) (req *request.Request, output *GetStageOutput)
func (c *IVSRealTime) GetStageSession(input *GetStageSessionInput) (*GetStageSessionOutput, error)
func (c *IVSRealTime) GetStageSessionRequest(input *GetStageSessionInput) (req *request.Request, output *GetStageSessionOutput)
func (c *IVSRealTime) GetStageSessionWithContext(ctx aws.Context, input *GetStageSessionInput, opts ...request.Option) (*GetStageSessionOutput, error)
func (c *IVSRealTime) GetStageWithContext(ctx aws.Context, input *GetStageInput, opts ...request.Option) (*GetStageOutput, error)
func (c *IVSRealTime) GetStorageConfiguration(input *GetStorageConfigurationInput) (*GetStorageConfigurationOutput, error)
func (c *IVSRealTime) GetStorageConfigurationRequest(input *GetStorageConfigurationInput) (req *request.Request, output *GetStorageConfigurationOutput)
func (c *IVSRealTime) GetStorageConfigurationWithContext(ctx aws.Context, input *GetStorageConfigurationInput, opts ...request.Option) (*GetStorageConfigurationOutput, error)
func (c *IVSRealTime) ListCompositions(input *ListCompositionsInput) (*ListCompositionsOutput, error)
func (c *IVSRealTime) ListCompositionsPages(input *ListCompositionsInput, fn func(*ListCompositionsOutput, bool) bool) error
func (c *IVSRealTime) ListCompositionsPagesWithContext(ctx aws.Context, input *ListCompositionsInput, fn func(*ListCompositionsOutput, bool) bool, opts ...request.Option) error
func (c *IVSRealTime) ListCompositionsRequest(input *ListCompositionsInput) (req *request.Request, output *ListCompositionsOutput)
func (c *IVSRealTime) ListCompositionsWithContext(ctx aws.Context, input *ListCompositionsInput, opts ...request.Option) (*ListCompositionsOutput, error)
func (c *IVSRealTime) ListEncoderConfigurations(input *ListEncoderConfigurationsInput) (*ListEncoderConfigurationsOutput, error)
func (c *IVSRealTime) ListEncoderConfigurationsPages(input *ListEncoderConfigurationsInput, fn func(*ListEncoderConfigurationsOutput, bool) bool) error
func (c *IVSRealTime) ListEncoderConfigurationsPagesWithContext(ctx aws.Context, input *ListEncoderConfigurationsInput, fn func(*ListEncoderConfigurationsOutput, bool) bool, opts ...request.Option) error
func (c *IVSRealTime) ListEncoderConfigurationsRequest(input *ListEncoderConfigurationsInput) (req *request.Request, output *ListEncoderConfigurationsOutput)
func (c *IVSRealTime) ListEncoderConfigurationsWithContext(ctx aws.Context, input *ListEncoderConfigurationsInput, opts ...request.Option) (*ListEncoderConfigurationsOutput, error)
func (c *IVSRealTime) ListParticipantEvents(input *ListParticipantEventsInput) (*ListParticipantEventsOutput, error)
func (c *IVSRealTime) ListParticipantEventsPages(input *ListParticipantEventsInput, fn func(*ListParticipantEventsOutput, bool) bool) error
func (c *IVSRealTime) ListParticipantEventsPagesWithContext(ctx aws.Context, input *ListParticipantEventsInput, fn func(*ListParticipantEventsOutput, bool) bool, opts ...request.Option) error
func (c *IVSRealTime) ListParticipantEventsRequest(input *ListParticipantEventsInput) (req *request.Request, output *ListParticipantEventsOutput)
func (c *IVSRealTime) ListParticipantEventsWithContext(ctx aws.Context, input *ListParticipantEventsInput, opts ...request.Option) (*ListParticipantEventsOutput, error)
func (c *IVSRealTime) ListParticipants(input *ListParticipantsInput) (*ListParticipantsOutput, error)
func (c *IVSRealTime) ListParticipantsPages(input *ListParticipantsInput, fn func(*ListParticipantsOutput, bool) bool) error
func (c *IVSRealTime) ListParticipantsPagesWithContext(ctx aws.Context, input *ListParticipantsInput, fn func(*ListParticipantsOutput, bool) bool, opts ...request.Option) error
func (c *IVSRealTime) ListParticipantsRequest(input *ListParticipantsInput) (req *request.Request, output *ListParticipantsOutput)
func (c *IVSRealTime) ListParticipantsWithContext(ctx aws.Context, input *ListParticipantsInput, opts ...request.Option) (*ListParticipantsOutput, error)
func (c *IVSRealTime) ListStageSessions(input *ListStageSessionsInput) (*ListStageSessionsOutput, error)
func (c *IVSRealTime) ListStageSessionsPages(input *ListStageSessionsInput, fn func(*ListStageSessionsOutput, bool) bool) error
func (c *IVSRealTime) ListStageSessionsPagesWithContext(ctx aws.Context, input *ListStageSessionsInput, fn func(*ListStageSessionsOutput, bool) bool, opts ...request.Option) error
func (c *IVSRealTime) ListStageSessionsRequest(input *ListStageSessionsInput) (req *request.Request, output *ListStageSessionsOutput)
func (c *IVSRealTime) ListStageSessionsWithContext(ctx aws.Context, input *ListStageSessionsInput, opts ...request.Option) (*ListStageSessionsOutput, error)
func (c *IVSRealTime) ListStages(input *ListStagesInput) (*ListStagesOutput, error)
func (c *IVSRealTime) ListStagesPages(input *ListStagesInput, fn func(*ListStagesOutput, bool) bool) error
func (c *IVSRealTime) ListStagesPagesWithContext(ctx aws.Context, input *ListStagesInput, fn func(*ListStagesOutput, bool) bool, opts ...request.Option) error
func (c *IVSRealTime) ListStagesRequest(input *ListStagesInput) (req *request.Request, output *ListStagesOutput)
func (c *IVSRealTime) ListStagesWithContext(ctx aws.Context, input *ListStagesInput, opts ...request.Option) (*ListStagesOutput, error)
func (c *IVSRealTime) ListStorageConfigurations(input *ListStorageConfigurationsInput) (*ListStorageConfigurationsOutput, error)
func (c *IVSRealTime) ListStorageConfigurationsPages(input *ListStorageConfigurationsInput, fn func(*ListStorageConfigurationsOutput, bool) bool) error
func (c *IVSRealTime) ListStorageConfigurationsPagesWithContext(ctx aws.Context, input *ListStorageConfigurationsInput, fn func(*ListStorageConfigurationsOutput, bool) bool, opts ...request.Option) error
func (c *IVSRealTime) ListStorageConfigurationsRequest(input *ListStorageConfigurationsInput) (req *request.Request, output *ListStorageConfigurationsOutput)
func (c *IVSRealTime) ListStorageConfigurationsWithContext(ctx aws.Context, input *ListStorageConfigurationsInput, opts ...request.Option) (*ListStorageConfigurationsOutput, error)
func (c *IVSRealTime) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)
func (c *IVSRealTime) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput)
func (c *IVSRealTime) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error)
func (c *IVSRealTime) StartComposition(input *StartCompositionInput) (*StartCompositionOutput, error)
func (c *IVSRealTime) StartCompositionRequest(input *StartCompositionInput) (req *request.Request, output *StartCompositionOutput)
func (c *IVSRealTime) StartCompositionWithContext(ctx aws.Context, input *StartCompositionInput, opts ...request.Option) (*StartCompositionOutput, error)
func (c *IVSRealTime) StopComposition(input *StopCompositionInput) (*StopCompositionOutput, error)
func (c *IVSRealTime) StopCompositionRequest(input *StopCompositionInput) (req *request.Request, output *StopCompositionOutput)
func (c *IVSRealTime) StopCompositionWithContext(ctx aws.Context, input *StopCompositionInput, opts ...request.Option) (*StopCompositionOutput, error)
func (c *IVSRealTime) TagResource(input *TagResourceInput) (*TagResourceOutput, error)
func (c *IVSRealTime) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput)
func (c *IVSRealTime) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error)
func (c *IVSRealTime) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)
func (c *IVSRealTime) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput)
func (c *IVSRealTime) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error)
func (c *IVSRealTime) UpdateStage(input *UpdateStageInput) (*UpdateStageOutput, error)
func (c *IVSRealTime) UpdateStageRequest(input *UpdateStageInput) (req *request.Request, output *UpdateStageOutput)
func (c *IVSRealTime) UpdateStageWithContext(ctx aws.Context, input *UpdateStageInput, opts ...request.Option) (*UpdateStageOutput, error)
func CompositionState_Values() []string
func DestinationState_Values() []string
func EventErrorCode_Values() []string
func EventName_Values() []string
func ParticipantState_Values() []string
func ParticipantTokenCapability_Values() []string
func PipBehavior_Values() []string
func PipPosition_Values() []string
func RecordingConfigurationFormat_Values() []string
func VideoAspectRatio_Values() []string
func VideoFillMode_Values() []string
type AccessDeniedException
type ChannelDestinationConfiguration
type Composition
type CompositionSummary
type ConflictException
type CreateEncoderConfigurationInput
type CreateEncoderConfigurationOutput
type CreateParticipantTokenInput
type CreateParticipantTokenOutput
type CreateStageInput
type CreateStageOutput
type CreateStorageConfigurationInput
type CreateStorageConfigurationOutput
type DeleteEncoderConfigurationInput
type DeleteEncoderConfigurationOutput
type DeleteStageInput
type DeleteStageOutput
type DeleteStorageConfigurationInput
type DeleteStorageConfigurationOutput
type Destination
type DestinationConfiguration
type DestinationDetail
type DestinationSummary
type DisconnectParticipantInput
type DisconnectParticipantOutput
type EncoderConfiguration
type EncoderConfigurationSummary
type Event
type GetCompositionInput
type GetCompositionOutput
type GetEncoderConfigurationInput
type GetEncoderConfigurationOutput
type GetParticipantInput
type GetParticipantOutput
type GetStageInput
type GetStageOutput
type GetStageSessionInput
type GetStageSessionOutput
type GetStorageConfigurationInput
type GetStorageConfigurationOutput
type GridConfiguration
type InternalServerException
type LayoutConfiguration
type ListCompositionsInput
type ListCompositionsOutput
type ListEncoderConfigurationsInput
type ListEncoderConfigurationsOutput
type ListParticipantEventsInput
type ListParticipantEventsOutput
type ListParticipantsInput
type ListParticipantsOutput
type ListStageSessionsInput
type ListStageSessionsOutput
type ListStagesInput
type ListStagesOutput
type ListStorageConfigurationsInput
type ListStorageConfigurationsOutput
type ListTagsForResourceInput
type ListTagsForResourceOutput
type Participant
type ParticipantSummary
type ParticipantToken
type ParticipantTokenConfiguration
type PendingVerification
type PipConfiguration
type RecordingConfiguration
type ResourceNotFoundException
type S3DestinationConfiguration
type S3Detail
type S3StorageConfiguration
type ServiceQuotaExceededException
type Stage
type StageSession
type StageSessionSummary
type StageSummary
type StartCompositionInput
type StartCompositionOutput
type StopCompositionInput
type StopCompositionOutput
type StorageConfiguration
type StorageConfigurationSummary
type TagResourceInput
type TagResourceOutput
type UntagResourceInput
type UntagResourceOutput
type UpdateStageInput
type UpdateStageOutput
type ValidationException
type Video

Constants ▾

const (
    // CompositionStateStarting is a CompositionState enum value
    CompositionStateStarting = "STARTING"

    // CompositionStateActive is a CompositionState enum value
    CompositionStateActive = "ACTIVE"

    // CompositionStateStopping is a CompositionState enum value
    CompositionStateStopping = "STOPPING"

    // CompositionStateFailed is a CompositionState enum value
    CompositionStateFailed = "FAILED"

    // CompositionStateStopped is a CompositionState enum value
    CompositionStateStopped = "STOPPED"
)
const (
    // DestinationStateStarting is a DestinationState enum value
    DestinationStateStarting = "STARTING"

    // DestinationStateActive is a DestinationState enum value
    DestinationStateActive = "ACTIVE"

    // DestinationStateStopping is a DestinationState enum value
    DestinationStateStopping = "STOPPING"

    // DestinationStateReconnecting is a DestinationState enum value
    DestinationStateReconnecting = "RECONNECTING"

    // DestinationStateFailed is a DestinationState enum value
    DestinationStateFailed = "FAILED"

    // DestinationStateStopped is a DestinationState enum value
    DestinationStateStopped = "STOPPED"
)
const (
    // EventErrorCodeInsufficientCapabilities is a EventErrorCode enum value
    EventErrorCodeInsufficientCapabilities = "INSUFFICIENT_CAPABILITIES"

    // EventErrorCodeQuotaExceeded is a EventErrorCode enum value
    EventErrorCodeQuotaExceeded = "QUOTA_EXCEEDED"

    // EventErrorCodePublisherNotFound is a EventErrorCode enum value
    EventErrorCodePublisherNotFound = "PUBLISHER_NOT_FOUND"
)
const (
    // EventNameJoined is a EventName enum value
    EventNameJoined = "JOINED"

    // EventNameLeft is a EventName enum value
    EventNameLeft = "LEFT"

    // EventNamePublishStarted is a EventName enum value
    EventNamePublishStarted = "PUBLISH_STARTED"

    // EventNamePublishStopped is a EventName enum value
    EventNamePublishStopped = "PUBLISH_STOPPED"

    // EventNameSubscribeStarted is a EventName enum value
    EventNameSubscribeStarted = "SUBSCRIBE_STARTED"

    // EventNameSubscribeStopped is a EventName enum value
    EventNameSubscribeStopped = "SUBSCRIBE_STOPPED"

    // EventNamePublishError is a EventName enum value
    EventNamePublishError = "PUBLISH_ERROR"

    // EventNameSubscribeError is a EventName enum value
    EventNameSubscribeError = "SUBSCRIBE_ERROR"

    // EventNameJoinError is a EventName enum value
    EventNameJoinError = "JOIN_ERROR"
)
const (
    // ParticipantStateConnected is a ParticipantState enum value
    ParticipantStateConnected = "CONNECTED"

    // ParticipantStateDisconnected is a ParticipantState enum value
    ParticipantStateDisconnected = "DISCONNECTED"
)
const (
    // ParticipantTokenCapabilityPublish is a ParticipantTokenCapability enum value
    ParticipantTokenCapabilityPublish = "PUBLISH"

    // ParticipantTokenCapabilitySubscribe is a ParticipantTokenCapability enum value
    ParticipantTokenCapabilitySubscribe = "SUBSCRIBE"
)
const (
    // PipBehaviorStatic is a PipBehavior enum value
    PipBehaviorStatic = "STATIC"

    // PipBehaviorDynamic is a PipBehavior enum value
    PipBehaviorDynamic = "DYNAMIC"
)
const (
    // PipPositionTopLeft is a PipPosition enum value
    PipPositionTopLeft = "TOP_LEFT"

    // PipPositionTopRight is a PipPosition enum value
    PipPositionTopRight = "TOP_RIGHT"

    // PipPositionBottomLeft is a PipPosition enum value
    PipPositionBottomLeft = "BOTTOM_LEFT"

    // PipPositionBottomRight is a PipPosition enum value
    PipPositionBottomRight = "BOTTOM_RIGHT"
)
const (
    // VideoAspectRatioAuto is a VideoAspectRatio enum value
    VideoAspectRatioAuto = "AUTO"

    // VideoAspectRatioVideo is a VideoAspectRatio enum value
    VideoAspectRatioVideo = "VIDEO"

    // VideoAspectRatioSquare is a VideoAspectRatio enum value
    VideoAspectRatioSquare = "SQUARE"

    // VideoAspectRatioPortrait is a VideoAspectRatio enum value
    VideoAspectRatioPortrait = "PORTRAIT"
)
const (
    // VideoFillModeFill is a VideoFillMode enum value
    VideoFillModeFill = "FILL"

    // VideoFillModeCover is a VideoFillMode enum value
    VideoFillModeCover = "COVER"

    // VideoFillModeContain is a VideoFillMode enum value
    VideoFillModeContain = "CONTAIN"
)
const (

    // ErrCodeAccessDeniedException for service response error code
    // "AccessDeniedException".
    ErrCodeAccessDeniedException = "AccessDeniedException"

    // ErrCodeConflictException for service response error code
    // "ConflictException".
    ErrCodeConflictException = "ConflictException"

    // ErrCodeInternalServerException for service response error code
    // "InternalServerException".
    ErrCodeInternalServerException = "InternalServerException"

    // ErrCodePendingVerification for service response error code
    // "PendingVerification".
    ErrCodePendingVerification = "PendingVerification"

    // ErrCodeResourceNotFoundException for service response error code
    // "ResourceNotFoundException".
    ErrCodeResourceNotFoundException = "ResourceNotFoundException"

    // ErrCodeServiceQuotaExceededException for service response error code
    // "ServiceQuotaExceededException".
    ErrCodeServiceQuotaExceededException = "ServiceQuotaExceededException"

    // ErrCodeValidationException for service response error code
    // "ValidationException".
    ErrCodeValidationException = "ValidationException"
)
const (
    ServiceName = "IVS RealTime" // Name of service.
    EndpointsID = "ivsrealtime"  // ID to lookup a service endpoint with.
    ServiceID   = "IVS RealTime" // ServiceID is a unique identifier of a specific service.
)

Service information constants

const (
    // RecordingConfigurationFormatHls is a RecordingConfigurationFormat enum value
    RecordingConfigurationFormatHls = "HLS"
)

func CompositionState_Values

func CompositionState_Values() []string

CompositionState_Values returns all elements of the CompositionState enum

func DestinationState_Values

func DestinationState_Values() []string

DestinationState_Values returns all elements of the DestinationState enum

func EventErrorCode_Values

func EventErrorCode_Values() []string

EventErrorCode_Values returns all elements of the EventErrorCode enum

func EventName_Values

func EventName_Values() []string

EventName_Values returns all elements of the EventName enum

func ParticipantState_Values

func ParticipantState_Values() []string

ParticipantState_Values returns all elements of the ParticipantState enum

func ParticipantTokenCapability_Values

func ParticipantTokenCapability_Values() []string

ParticipantTokenCapability_Values returns all elements of the ParticipantTokenCapability enum

func PipBehavior_Values

func PipBehavior_Values() []string

PipBehavior_Values returns all elements of the PipBehavior enum

func PipPosition_Values

func PipPosition_Values() []string

PipPosition_Values returns all elements of the PipPosition enum

func RecordingConfigurationFormat_Values

func RecordingConfigurationFormat_Values() []string

RecordingConfigurationFormat_Values returns all elements of the RecordingConfigurationFormat enum

func VideoAspectRatio_Values

func VideoAspectRatio_Values() []string

VideoAspectRatio_Values returns all elements of the VideoAspectRatio enum

func VideoFillMode_Values

func VideoFillMode_Values() []string

VideoFillMode_Values returns all elements of the VideoFillMode enum

type AccessDeniedException

type AccessDeniedException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    // User does not have sufficient access to perform this action.
    ExceptionMessage *string `locationName:"exceptionMessage" type:"string"`

    Message_ *string `locationName:"message" type:"string"`
    // contains filtered or unexported fields
}

func (*AccessDeniedException) Code

func (s *AccessDeniedException) Code() string

Code returns the exception type name.

func (*AccessDeniedException) Error

func (s *AccessDeniedException) Error() string

func (AccessDeniedException) GoString

func (s AccessDeniedException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AccessDeniedException) Message

func (s *AccessDeniedException) Message() string

Message returns the exception's message.

func (*AccessDeniedException) OrigErr

func (s *AccessDeniedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*AccessDeniedException) RequestID

func (s *AccessDeniedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*AccessDeniedException) StatusCode

func (s *AccessDeniedException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (AccessDeniedException) String

func (s AccessDeniedException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ChannelDestinationConfiguration

type ChannelDestinationConfiguration struct {

    // ARN of the channel to use for broadcasting. The channel and stage resources
    // must be in the same AWS account and region. The channel must be offline (not
    // broadcasting).
    //
    // ChannelArn is a required field
    ChannelArn *string `locationName:"channelArn" min:"1" type:"string" required:"true"`

    // ARN of the EncoderConfiguration resource. The encoder configuration and stage
    // resources must be in the same AWS account and region.
    EncoderConfigurationArn *string `locationName:"encoderConfigurationArn" min:"1" type:"string"`
    // contains filtered or unexported fields
}

Object specifying a channel as a destination.

func (ChannelDestinationConfiguration) GoString

func (s ChannelDestinationConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ChannelDestinationConfiguration) SetChannelArn

func (s *ChannelDestinationConfiguration) SetChannelArn(v string) *ChannelDestinationConfiguration

SetChannelArn sets the ChannelArn field's value.

func (*ChannelDestinationConfiguration) SetEncoderConfigurationArn

func (s *ChannelDestinationConfiguration) SetEncoderConfigurationArn(v string) *ChannelDestinationConfiguration

SetEncoderConfigurationArn sets the EncoderConfigurationArn field's value.

func (ChannelDestinationConfiguration) String

func (s ChannelDestinationConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ChannelDestinationConfiguration) Validate

func (s *ChannelDestinationConfiguration) Validate() error

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

type Composition

type Composition struct {

    // ARN of the Composition resource.
    //
    // Arn is a required field
    Arn *string `locationName:"arn" min:"1" type:"string" required:"true"`

    // Array of Destination objects. A Composition can contain either one destination
    // (channel or s3) or two (one channel and one s3).
    //
    // Destinations is a required field
    Destinations []*Destination `locationName:"destinations" min:"1" type:"list" required:"true"`

    // UTC time of the Composition end. This is an ISO 8601 timestamp; note that
    // this is returned as a string.
    EndTime *time.Time `locationName:"endTime" type:"timestamp" timestampFormat:"iso8601"`

    // Layout object to configure composition parameters.
    //
    // Layout is a required field
    Layout *LayoutConfiguration `locationName:"layout" type:"structure" required:"true"`

    // ARN of the stage used as input
    //
    // StageArn is a required field
    StageArn *string `locationName:"stageArn" min:"1" type:"string" required:"true"`

    // UTC time of the Composition start. This is an ISO 8601 timestamp; note that
    // this is returned as a string.
    StartTime *time.Time `locationName:"startTime" type:"timestamp" timestampFormat:"iso8601"`

    // State of the Composition.
    //
    // State is a required field
    State *string `locationName:"state" type:"string" required:"true" enum:"CompositionState"`

    // Tags attached to the resource. Array of maps, each of the form string:string
    // (key:value). See Tagging AWS Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html)
    // 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.
    Tags map[string]*string `locationName:"tags" type:"map"`
    // contains filtered or unexported fields
}

Object specifying a Composition resource.

func (Composition) GoString

func (s Composition) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Composition) SetArn

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

SetArn sets the Arn field's value.

func (*Composition) SetDestinations

func (s *Composition) SetDestinations(v []*Destination) *Composition

SetDestinations sets the Destinations field's value.

func (*Composition) SetEndTime

func (s *Composition) SetEndTime(v time.Time) *Composition

SetEndTime sets the EndTime field's value.

func (*Composition) SetLayout

func (s *Composition) SetLayout(v *LayoutConfiguration) *Composition

SetLayout sets the Layout field's value.

func (*Composition) SetStageArn

func (s *Composition) SetStageArn(v string) *Composition

SetStageArn sets the StageArn field's value.

func (*Composition) SetStartTime

func (s *Composition) SetStartTime(v time.Time) *Composition

SetStartTime sets the StartTime field's value.

func (*Composition) SetState

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

SetState sets the State field's value.

func (*Composition) SetTags

func (s *Composition) SetTags(v map[string]*string) *Composition

SetTags sets the Tags field's value.

func (Composition) String

func (s Composition) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CompositionSummary

type CompositionSummary struct {

    // ARN of the Composition resource.
    //
    // Arn is a required field
    Arn *string `locationName:"arn" min:"1" type:"string" required:"true"`

    // Array of Destination objects.
    //
    // Destinations is a required field
    Destinations []*DestinationSummary `locationName:"destinations" min:"1" type:"list" required:"true"`

    // UTC time of the Composition end. This is an ISO 8601 timestamp; note that
    // this is returned as a string.
    EndTime *time.Time `locationName:"endTime" type:"timestamp" timestampFormat:"iso8601"`

    // ARN of the attached stage.
    //
    // StageArn is a required field
    StageArn *string `locationName:"stageArn" min:"1" type:"string" required:"true"`

    // UTC time of the Composition start. This is an ISO 8601 timestamp; note that
    // this is returned as a string.
    StartTime *time.Time `locationName:"startTime" type:"timestamp" timestampFormat:"iso8601"`

    // State of the Composition resource.
    //
    // State is a required field
    State *string `locationName:"state" type:"string" required:"true" enum:"CompositionState"`

    // Tags attached to the resource. Array of maps, each of the form string:string
    // (key:value). See Tagging AWS Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html)
    // 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.
    Tags map[string]*string `locationName:"tags" type:"map"`
    // contains filtered or unexported fields
}

Summary information about a Composition.

func (CompositionSummary) GoString

func (s CompositionSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CompositionSummary) SetArn

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

SetArn sets the Arn field's value.

func (*CompositionSummary) SetDestinations

func (s *CompositionSummary) SetDestinations(v []*DestinationSummary) *CompositionSummary

SetDestinations sets the Destinations field's value.

func (*CompositionSummary) SetEndTime

func (s *CompositionSummary) SetEndTime(v time.Time) *CompositionSummary

SetEndTime sets the EndTime field's value.

func (*CompositionSummary) SetStageArn

func (s *CompositionSummary) SetStageArn(v string) *CompositionSummary

SetStageArn sets the StageArn field's value.

func (*CompositionSummary) SetStartTime

func (s *CompositionSummary) SetStartTime(v time.Time) *CompositionSummary

SetStartTime sets the StartTime field's value.

func (*CompositionSummary) SetState

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

SetState sets the State field's value.

func (*CompositionSummary) SetTags

func (s *CompositionSummary) SetTags(v map[string]*string) *CompositionSummary

SetTags sets the Tags field's value.

func (CompositionSummary) String

func (s CompositionSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ConflictException

type ConflictException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    // Updating or deleting a resource can cause an inconsistent state.
    ExceptionMessage *string `locationName:"exceptionMessage" type:"string"`

    Message_ *string `locationName:"message" type:"string"`
    // contains filtered or unexported fields
}

func (*ConflictException) Code

func (s *ConflictException) Code() string

Code returns the exception type name.

func (*ConflictException) Error

func (s *ConflictException) Error() string

func (ConflictException) GoString

func (s ConflictException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConflictException) Message

func (s *ConflictException) Message() string

Message returns the exception's message.

func (*ConflictException) OrigErr

func (s *ConflictException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ConflictException) RequestID

func (s *ConflictException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ConflictException) StatusCode

func (s *ConflictException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ConflictException) String

func (s ConflictException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateEncoderConfigurationInput

type CreateEncoderConfigurationInput struct {

    // Optional name to identify the resource.
    Name *string `locationName:"name" type:"string"`

    // Tags attached to the resource. Array of maps, each of the form string:string
    // (key:value). See Tagging AWS Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html)
    // 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.
    Tags map[string]*string `locationName:"tags" type:"map"`

    // Video configuration. Default: video resolution 1280x720, bitrate 2500 kbps,
    // 30 fps.
    Video *Video `locationName:"video" type:"structure"`
    // contains filtered or unexported fields
}

func (CreateEncoderConfigurationInput) GoString

func (s CreateEncoderConfigurationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateEncoderConfigurationInput) SetName

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

SetName sets the Name field's value.

func (*CreateEncoderConfigurationInput) SetTags

func (s *CreateEncoderConfigurationInput) SetTags(v map[string]*string) *CreateEncoderConfigurationInput

SetTags sets the Tags field's value.

func (*CreateEncoderConfigurationInput) SetVideo

func (s *CreateEncoderConfigurationInput) SetVideo(v *Video) *CreateEncoderConfigurationInput

SetVideo sets the Video field's value.

func (CreateEncoderConfigurationInput) String

func (s CreateEncoderConfigurationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateEncoderConfigurationInput) Validate

func (s *CreateEncoderConfigurationInput) Validate() error

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

type CreateEncoderConfigurationOutput

type CreateEncoderConfigurationOutput struct {

    // The EncoderConfiguration that was created.
    EncoderConfiguration *EncoderConfiguration `locationName:"encoderConfiguration" type:"structure"`
    // contains filtered or unexported fields
}

func (CreateEncoderConfigurationOutput) GoString

func (s CreateEncoderConfigurationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateEncoderConfigurationOutput) SetEncoderConfiguration

func (s *CreateEncoderConfigurationOutput) SetEncoderConfiguration(v *EncoderConfiguration) *CreateEncoderConfigurationOutput

SetEncoderConfiguration sets the EncoderConfiguration field's value.

func (CreateEncoderConfigurationOutput) String

func (s CreateEncoderConfigurationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateParticipantTokenInput

type CreateParticipantTokenInput struct {

    // 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 `locationName:"attributes" type:"map"`

    // Set of capabilities that the user is allowed to perform in the stage. Default:
    // PUBLISH, SUBSCRIBE.
    Capabilities []*string `locationName:"capabilities" type:"list" enum:"ParticipantTokenCapability"`

    // Duration (in minutes), after which the token expires. Default: 720 (12 hours).
    Duration *int64 `locationName:"duration" min:"1" type:"integer"`

    // ARN of the stage to which this token is scoped.
    //
    // StageArn is a required field
    StageArn *string `locationName:"stageArn" min:"1" type:"string" required:"true"`

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

func (CreateParticipantTokenInput) GoString

func (s CreateParticipantTokenInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateParticipantTokenInput) SetAttributes

func (s *CreateParticipantTokenInput) SetAttributes(v map[string]*string) *CreateParticipantTokenInput

SetAttributes sets the Attributes field's value.

func (*CreateParticipantTokenInput) SetCapabilities

func (s *CreateParticipantTokenInput) SetCapabilities(v []*string) *CreateParticipantTokenInput

SetCapabilities sets the Capabilities field's value.

func (*CreateParticipantTokenInput) SetDuration

func (s *CreateParticipantTokenInput) SetDuration(v int64) *CreateParticipantTokenInput

SetDuration sets the Duration field's value.

func (*CreateParticipantTokenInput) SetStageArn

func (s *CreateParticipantTokenInput) SetStageArn(v string) *CreateParticipantTokenInput

SetStageArn sets the StageArn field's value.

func (*CreateParticipantTokenInput) SetUserId

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

SetUserId sets the UserId field's value.

func (CreateParticipantTokenInput) String

func (s CreateParticipantTokenInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateParticipantTokenInput) Validate

func (s *CreateParticipantTokenInput) Validate() error

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

type CreateParticipantTokenOutput

type CreateParticipantTokenOutput struct {

    // The participant token that was created.
    ParticipantToken *ParticipantToken `locationName:"participantToken" type:"structure"`
    // contains filtered or unexported fields
}

func (CreateParticipantTokenOutput) GoString

func (s CreateParticipantTokenOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateParticipantTokenOutput) SetParticipantToken

func (s *CreateParticipantTokenOutput) SetParticipantToken(v *ParticipantToken) *CreateParticipantTokenOutput

SetParticipantToken sets the ParticipantToken field's value.

func (CreateParticipantTokenOutput) String

func (s CreateParticipantTokenOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateStageInput

type CreateStageInput struct {

    // Optional name that can be specified for the stage being created.
    Name *string `locationName:"name" type:"string"`

    // Array of participant token configuration objects to attach to the new stage.
    ParticipantTokenConfigurations []*ParticipantTokenConfiguration `locationName:"participantTokenConfigurations" type:"list"`

    // Tags attached to the resource. Array of maps, each of the form string:string
    // (key:value). See Tagging AWS Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html)
    // 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.
    Tags map[string]*string `locationName:"tags" type:"map"`
    // contains filtered or unexported fields
}

func (CreateStageInput) GoString

func (s CreateStageInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateStageInput) SetName

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

SetName sets the Name field's value.

func (*CreateStageInput) SetParticipantTokenConfigurations

func (s *CreateStageInput) SetParticipantTokenConfigurations(v []*ParticipantTokenConfiguration) *CreateStageInput

SetParticipantTokenConfigurations sets the ParticipantTokenConfigurations field's value.

func (*CreateStageInput) SetTags

func (s *CreateStageInput) SetTags(v map[string]*string) *CreateStageInput

SetTags sets the Tags field's value.

func (CreateStageInput) String

func (s CreateStageInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateStageInput) Validate

func (s *CreateStageInput) Validate() error

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

type CreateStageOutput

type CreateStageOutput struct {

    // Participant tokens attached to the stage. These correspond to the participants
    // in the request.
    ParticipantTokens []*ParticipantToken `locationName:"participantTokens" type:"list"`

    // The stage that was created.
    Stage *Stage `locationName:"stage" type:"structure"`
    // contains filtered or unexported fields
}

func (CreateStageOutput) GoString

func (s CreateStageOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateStageOutput) SetParticipantTokens

func (s *CreateStageOutput) SetParticipantTokens(v []*ParticipantToken) *CreateStageOutput

SetParticipantTokens sets the ParticipantTokens field's value.

func (*CreateStageOutput) SetStage

func (s *CreateStageOutput) SetStage(v *Stage) *CreateStageOutput

SetStage sets the Stage field's value.

func (CreateStageOutput) String

func (s CreateStageOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateStorageConfigurationInput

type CreateStorageConfigurationInput struct {

    // Storage configuration name. The value does not need to be unique.
    Name *string `locationName:"name" type:"string"`

    // A complex type that contains a storage configuration for where recorded video
    // will be stored.
    //
    // S3 is a required field
    S3 *S3StorageConfiguration `locationName:"s3" type:"structure" required:"true"`

    // Tags attached to the resource. Array of maps, each of the form string:string
    // (key:value). See Tagging AWS Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html)
    // 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.
    Tags map[string]*string `locationName:"tags" type:"map"`
    // contains filtered or unexported fields
}

func (CreateStorageConfigurationInput) GoString

func (s CreateStorageConfigurationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateStorageConfigurationInput) SetName

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

SetName sets the Name field's value.

func (*CreateStorageConfigurationInput) SetS3

func (s *CreateStorageConfigurationInput) SetS3(v *S3StorageConfiguration) *CreateStorageConfigurationInput

SetS3 sets the S3 field's value.

func (*CreateStorageConfigurationInput) SetTags

func (s *CreateStorageConfigurationInput) SetTags(v map[string]*string) *CreateStorageConfigurationInput

SetTags sets the Tags field's value.

func (CreateStorageConfigurationInput) String

func (s CreateStorageConfigurationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateStorageConfigurationInput) Validate

func (s *CreateStorageConfigurationInput) Validate() error

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

type CreateStorageConfigurationOutput

type CreateStorageConfigurationOutput struct {

    // The StorageConfiguration that was created.
    StorageConfiguration *StorageConfiguration `locationName:"storageConfiguration" type:"structure"`
    // contains filtered or unexported fields
}

func (CreateStorageConfigurationOutput) GoString

func (s CreateStorageConfigurationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateStorageConfigurationOutput) SetStorageConfiguration

func (s *CreateStorageConfigurationOutput) SetStorageConfiguration(v *StorageConfiguration) *CreateStorageConfigurationOutput

SetStorageConfiguration sets the StorageConfiguration field's value.

func (CreateStorageConfigurationOutput) String

func (s CreateStorageConfigurationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteEncoderConfigurationInput

type DeleteEncoderConfigurationInput struct {

    // ARN of the EncoderConfiguration.
    //
    // Arn is a required field
    Arn *string `locationName:"arn" min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DeleteEncoderConfigurationInput) GoString

func (s DeleteEncoderConfigurationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteEncoderConfigurationInput) SetArn

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

SetArn sets the Arn field's value.

func (DeleteEncoderConfigurationInput) String

func (s DeleteEncoderConfigurationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteEncoderConfigurationInput) Validate

func (s *DeleteEncoderConfigurationInput) Validate() error

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

type DeleteEncoderConfigurationOutput

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

func (DeleteEncoderConfigurationOutput) GoString

func (s DeleteEncoderConfigurationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteEncoderConfigurationOutput) String

func (s DeleteEncoderConfigurationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteStageInput

type DeleteStageInput struct {

    // ARN of the stage to be deleted.
    //
    // Arn is a required field
    Arn *string `locationName:"arn" min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DeleteStageInput) GoString

func (s DeleteStageInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteStageInput) SetArn

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

SetArn sets the Arn field's value.

func (DeleteStageInput) String

func (s DeleteStageInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteStageInput) Validate

func (s *DeleteStageInput) Validate() error

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

type DeleteStageOutput

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

func (DeleteStageOutput) GoString

func (s DeleteStageOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteStageOutput) String

func (s DeleteStageOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteStorageConfigurationInput

type DeleteStorageConfigurationInput struct {

    // ARN of the storage configuration to be deleted.
    //
    // Arn is a required field
    Arn *string `locationName:"arn" min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DeleteStorageConfigurationInput) GoString

func (s DeleteStorageConfigurationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteStorageConfigurationInput) SetArn

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

SetArn sets the Arn field's value.

func (DeleteStorageConfigurationInput) String

func (s DeleteStorageConfigurationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteStorageConfigurationInput) Validate

func (s *DeleteStorageConfigurationInput) Validate() error

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

type DeleteStorageConfigurationOutput

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

func (DeleteStorageConfigurationOutput) GoString

func (s DeleteStorageConfigurationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteStorageConfigurationOutput) String

func (s DeleteStorageConfigurationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Destination

type Destination struct {

    // Configuration used to create this destination.
    //
    // Configuration is a required field
    Configuration *DestinationConfiguration `locationName:"configuration" type:"structure" required:"true"`

    // Optional details regarding the status of the destination.
    Detail *DestinationDetail `locationName:"detail" type:"structure"`

    // UTC time of the destination end. This is an ISO 8601 timestamp; note that
    // this is returned as a string.
    EndTime *time.Time `locationName:"endTime" type:"timestamp" timestampFormat:"iso8601"`

    // Unique identifier for this destination, assigned by IVS.
    //
    // Id is a required field
    Id *string `locationName:"id" type:"string" required:"true"`

    // UTC time of the destination start. This is an ISO 8601 timestamp; note that
    // this is returned as a string.
    StartTime *time.Time `locationName:"startTime" type:"timestamp" timestampFormat:"iso8601"`

    // State of the Composition Destination.
    //
    // State is a required field
    State *string `locationName:"state" type:"string" required:"true" enum:"DestinationState"`
    // contains filtered or unexported fields
}

Object specifying the status of a Destination.

func (Destination) GoString

func (s Destination) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Destination) SetConfiguration

func (s *Destination) SetConfiguration(v *DestinationConfiguration) *Destination

SetConfiguration sets the Configuration field's value.

func (*Destination) SetDetail

func (s *Destination) SetDetail(v *DestinationDetail) *Destination

SetDetail sets the Detail field's value.

func (*Destination) SetEndTime

func (s *Destination) SetEndTime(v time.Time) *Destination

SetEndTime sets the EndTime field's value.

func (*Destination) SetId

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

SetId sets the Id field's value.

func (*Destination) SetStartTime

func (s *Destination) SetStartTime(v time.Time) *Destination

SetStartTime sets the StartTime field's value.

func (*Destination) SetState

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

SetState sets the State field's value.

func (Destination) String

func (s Destination) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DestinationConfiguration

type DestinationConfiguration struct {

    // An IVS channel to be used for broadcasting, for server-side composition.
    // Either a channel or an s3 must be specified.
    Channel *ChannelDestinationConfiguration `locationName:"channel" type:"structure"`

    // Name that can be specified to help identify the destination.
    Name *string `locationName:"name" type:"string"`

    // An S3 storage configuration to be used for recording video data. Either a
    // channel or an s3 must be specified.
    S3 *S3DestinationConfiguration `locationName:"s3" type:"structure"`
    // contains filtered or unexported fields
}

Complex data type that defines destination-configuration objects.

func (DestinationConfiguration) GoString

func (s DestinationConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DestinationConfiguration) SetChannel

func (s *DestinationConfiguration) SetChannel(v *ChannelDestinationConfiguration) *DestinationConfiguration

SetChannel sets the Channel field's value.

func (*DestinationConfiguration) SetName

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

SetName sets the Name field's value.

func (*DestinationConfiguration) SetS3

func (s *DestinationConfiguration) SetS3(v *S3DestinationConfiguration) *DestinationConfiguration

SetS3 sets the S3 field's value.

func (DestinationConfiguration) String

func (s DestinationConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DestinationConfiguration) Validate

func (s *DestinationConfiguration) Validate() error

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

type DestinationDetail

type DestinationDetail struct {

    // An S3 detail object to return information about the S3 destination.
    S3 *S3Detail `locationName:"s3" type:"structure"`
    // contains filtered or unexported fields
}

Complex data type that defines destination-detail objects.

func (DestinationDetail) GoString

func (s DestinationDetail) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DestinationDetail) SetS3

func (s *DestinationDetail) SetS3(v *S3Detail) *DestinationDetail

SetS3 sets the S3 field's value.

func (DestinationDetail) String

func (s DestinationDetail) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DestinationSummary

type DestinationSummary struct {

    // UTC time of the destination end. This is an ISO 8601 timestamp; note that
    // this is returned as a string.
    EndTime *time.Time `locationName:"endTime" type:"timestamp" timestampFormat:"iso8601"`

    // Unique identifier for this destination, assigned by IVS.
    //
    // Id is a required field
    Id *string `locationName:"id" type:"string" required:"true"`

    // UTC time of the destination start. This is an ISO 8601 timestamp; note that
    // this is returned as a string.
    StartTime *time.Time `locationName:"startTime" type:"timestamp" timestampFormat:"iso8601"`

    // State of the Composition Destination.
    //
    // State is a required field
    State *string `locationName:"state" type:"string" required:"true" enum:"DestinationState"`
    // contains filtered or unexported fields
}

Summary information about a Destination.

func (DestinationSummary) GoString

func (s DestinationSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DestinationSummary) SetEndTime

func (s *DestinationSummary) SetEndTime(v time.Time) *DestinationSummary

SetEndTime sets the EndTime field's value.

func (*DestinationSummary) SetId

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

SetId sets the Id field's value.

func (*DestinationSummary) SetStartTime

func (s *DestinationSummary) SetStartTime(v time.Time) *DestinationSummary

SetStartTime sets the StartTime field's value.

func (*DestinationSummary) SetState

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

SetState sets the State field's value.

func (DestinationSummary) String

func (s DestinationSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DisconnectParticipantInput

type DisconnectParticipantInput struct {

    // Identifier of the participant to be disconnected. This is assigned by IVS
    // and returned by CreateParticipantToken.
    //
    // ParticipantId is a required field
    ParticipantId *string `locationName:"participantId" type:"string" required:"true"`

    // Description of why this participant is being disconnected.
    Reason *string `locationName:"reason" type:"string"`

    // ARN of the stage to which the participant is attached.
    //
    // StageArn is a required field
    StageArn *string `locationName:"stageArn" min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DisconnectParticipantInput) GoString

func (s DisconnectParticipantInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DisconnectParticipantInput) SetParticipantId

func (s *DisconnectParticipantInput) SetParticipantId(v string) *DisconnectParticipantInput

SetParticipantId sets the ParticipantId field's value.

func (*DisconnectParticipantInput) SetReason

func (s *DisconnectParticipantInput) SetReason(v string) *DisconnectParticipantInput

SetReason sets the Reason field's value.

func (*DisconnectParticipantInput) SetStageArn

func (s *DisconnectParticipantInput) SetStageArn(v string) *DisconnectParticipantInput

SetStageArn sets the StageArn field's value.

func (DisconnectParticipantInput) String

func (s DisconnectParticipantInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DisconnectParticipantInput) Validate

func (s *DisconnectParticipantInput) Validate() error

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

type DisconnectParticipantOutput

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

func (DisconnectParticipantOutput) GoString

func (s DisconnectParticipantOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DisconnectParticipantOutput) String

func (s DisconnectParticipantOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type EncoderConfiguration

type EncoderConfiguration struct {

    // ARN of the EncoderConfiguration resource.
    //
    // Arn is a required field
    Arn *string `locationName:"arn" min:"1" type:"string" required:"true"`

    // Optional name to identify the resource.
    Name *string `locationName:"name" type:"string"`

    // Tags attached to the resource. Array of maps, each of the form string:string
    // (key:value). See Tagging AWS Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html)
    // 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.
    Tags map[string]*string `locationName:"tags" type:"map"`

    // Video configuration. Default: video resolution 1280x720, bitrate 2500 kbps,
    // 30 fps
    Video *Video `locationName:"video" type:"structure"`
    // contains filtered or unexported fields
}

Settings for transcoding.

func (EncoderConfiguration) GoString

func (s EncoderConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EncoderConfiguration) SetArn

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

SetArn sets the Arn field's value.

func (*EncoderConfiguration) SetName

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

SetName sets the Name field's value.

func (*EncoderConfiguration) SetTags

func (s *EncoderConfiguration) SetTags(v map[string]*string) *EncoderConfiguration

SetTags sets the Tags field's value.

func (*EncoderConfiguration) SetVideo

func (s *EncoderConfiguration) SetVideo(v *Video) *EncoderConfiguration

SetVideo sets the Video field's value.

func (EncoderConfiguration) String

func (s EncoderConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type EncoderConfigurationSummary

type EncoderConfigurationSummary struct {

    // ARN of the EncoderConfiguration resource.
    //
    // Arn is a required field
    Arn *string `locationName:"arn" min:"1" type:"string" required:"true"`

    // Optional name to identify the resource.
    Name *string `locationName:"name" type:"string"`

    // Tags attached to the resource. Array of maps, each of the form string:string
    // (key:value). See Tagging AWS Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html)
    // 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.
    Tags map[string]*string `locationName:"tags" type:"map"`
    // contains filtered or unexported fields
}

Summary information about an EncoderConfiguration.

func (EncoderConfigurationSummary) GoString

func (s EncoderConfigurationSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EncoderConfigurationSummary) SetArn

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

SetArn sets the Arn field's value.

func (*EncoderConfigurationSummary) SetName

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

SetName sets the Name field's value.

func (*EncoderConfigurationSummary) SetTags

func (s *EncoderConfigurationSummary) SetTags(v map[string]*string) *EncoderConfigurationSummary

SetTags sets the Tags field's value.

func (EncoderConfigurationSummary) String

func (s EncoderConfigurationSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Event

type Event struct {

    // If the event is an error event, the error code is provided to give insight
    // into the specific error that occurred. If the event is not an error event,
    // this field is null. INSUFFICIENT_CAPABILITIES indicates that the participant
    // tried to take an action that the participant’s token is not allowed to
    // do. For more information about participant capabilities, see the capabilities
    // field in CreateParticipantToken. QUOTA_EXCEEDED indicates that the number
    // of participants who want to publish/subscribe to a stage exceeds the quota;
    // for more information, see Service Quotas (https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/service-quotas.html).
    // PUBLISHER_NOT_FOUND indicates that the participant tried to subscribe to
    // a publisher that doesn’t exist.
    ErrorCode *string `locationName:"errorCode" type:"string" enum:"EventErrorCode"`

    // ISO 8601 timestamp (returned as a string) for when the event occurred.
    EventTime *time.Time `locationName:"eventTime" type:"timestamp" timestampFormat:"iso8601"`

    // The name of the event.
    Name *string `locationName:"name" type:"string" enum:"EventName"`

    // Unique identifier for the participant who triggered the event. This is assigned
    // by IVS.
    ParticipantId *string `locationName:"participantId" type:"string"`

    // Unique identifier for the remote participant. For a subscribe event, this
    // is the publisher. For a publish or join event, this is null. This is assigned
    // by IVS.
    RemoteParticipantId *string `locationName:"remoteParticipantId" type:"string"`
    // contains filtered or unexported fields
}

An occurrence during a stage session.

func (Event) GoString

func (s Event) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Event) SetErrorCode

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

SetErrorCode sets the ErrorCode field's value.

func (*Event) SetEventTime

func (s *Event) SetEventTime(v time.Time) *Event

SetEventTime sets the EventTime field's value.

func (*Event) SetName

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

SetName sets the Name field's value.

func (*Event) SetParticipantId

func (s *Event) SetParticipantId(v string) *Event

SetParticipantId sets the ParticipantId field's value.

func (*Event) SetRemoteParticipantId

func (s *Event) SetRemoteParticipantId(v string) *Event

SetRemoteParticipantId sets the RemoteParticipantId field's value.

func (Event) String

func (s Event) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetCompositionInput

type GetCompositionInput struct {

    // ARN of the Composition resource.
    //
    // Arn is a required field
    Arn *string `locationName:"arn" min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (GetCompositionInput) GoString

func (s GetCompositionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetCompositionInput) SetArn

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

SetArn sets the Arn field's value.

func (GetCompositionInput) String

func (s GetCompositionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetCompositionInput) Validate

func (s *GetCompositionInput) Validate() error

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

type GetCompositionOutput

type GetCompositionOutput struct {

    // The Composition that was returned.
    Composition *Composition `locationName:"composition" type:"structure"`
    // contains filtered or unexported fields
}

func (GetCompositionOutput) GoString

func (s GetCompositionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetCompositionOutput) SetComposition

func (s *GetCompositionOutput) SetComposition(v *Composition) *GetCompositionOutput

SetComposition sets the Composition field's value.

func (GetCompositionOutput) String

func (s GetCompositionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetEncoderConfigurationInput

type GetEncoderConfigurationInput struct {

    // ARN of the EncoderConfiguration resource.
    //
    // Arn is a required field
    Arn *string `locationName:"arn" min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (GetEncoderConfigurationInput) GoString

func (s GetEncoderConfigurationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetEncoderConfigurationInput) SetArn

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

SetArn sets the Arn field's value.

func (GetEncoderConfigurationInput) String

func (s GetEncoderConfigurationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetEncoderConfigurationInput) Validate

func (s *GetEncoderConfigurationInput) Validate() error

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

type GetEncoderConfigurationOutput

type GetEncoderConfigurationOutput struct {

    // The EncoderConfiguration that was returned.
    EncoderConfiguration *EncoderConfiguration `locationName:"encoderConfiguration" type:"structure"`
    // contains filtered or unexported fields
}

func (GetEncoderConfigurationOutput) GoString

func (s GetEncoderConfigurationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetEncoderConfigurationOutput) SetEncoderConfiguration

func (s *GetEncoderConfigurationOutput) SetEncoderConfiguration(v *EncoderConfiguration) *GetEncoderConfigurationOutput

SetEncoderConfiguration sets the EncoderConfiguration field's value.

func (GetEncoderConfigurationOutput) String

func (s GetEncoderConfigurationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetParticipantInput

type GetParticipantInput struct {

    // Unique identifier for the participant. This is assigned by IVS and returned
    // by CreateParticipantToken.
    //
    // ParticipantId is a required field
    ParticipantId *string `locationName:"participantId" type:"string" required:"true"`

    // ID of a session within the stage.
    //
    // SessionId is a required field
    SessionId *string `locationName:"sessionId" min:"16" type:"string" required:"true"`

    // Stage ARN.
    //
    // StageArn is a required field
    StageArn *string `locationName:"stageArn" min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (GetParticipantInput) GoString

func (s GetParticipantInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetParticipantInput) SetParticipantId

func (s *GetParticipantInput) SetParticipantId(v string) *GetParticipantInput

SetParticipantId sets the ParticipantId field's value.

func (*GetParticipantInput) SetSessionId

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

SetSessionId sets the SessionId field's value.

func (*GetParticipantInput) SetStageArn

func (s *GetParticipantInput) SetStageArn(v string) *GetParticipantInput

SetStageArn sets the StageArn field's value.

func (GetParticipantInput) String

func (s GetParticipantInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetParticipantInput) Validate

func (s *GetParticipantInput) Validate() error

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

type GetParticipantOutput

type GetParticipantOutput struct {

    // The participant that is returned.
    Participant *Participant `locationName:"participant" type:"structure"`
    // contains filtered or unexported fields
}

func (GetParticipantOutput) GoString

func (s GetParticipantOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetParticipantOutput) SetParticipant

func (s *GetParticipantOutput) SetParticipant(v *Participant) *GetParticipantOutput

SetParticipant sets the Participant field's value.

func (GetParticipantOutput) String

func (s GetParticipantOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetStageInput

type GetStageInput struct {

    // ARN of the stage for which the information is to be retrieved.
    //
    // Arn is a required field
    Arn *string `locationName:"arn" min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (GetStageInput) GoString

func (s GetStageInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetStageInput) SetArn

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

SetArn sets the Arn field's value.

func (GetStageInput) String

func (s GetStageInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetStageInput) Validate

func (s *GetStageInput) Validate() error

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

type GetStageOutput

type GetStageOutput struct {

    // The stage that is returned.
    Stage *Stage `locationName:"stage" type:"structure"`
    // contains filtered or unexported fields
}

func (GetStageOutput) GoString

func (s GetStageOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetStageOutput) SetStage

func (s *GetStageOutput) SetStage(v *Stage) *GetStageOutput

SetStage sets the Stage field's value.

func (GetStageOutput) String

func (s GetStageOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetStageSessionInput

type GetStageSessionInput struct {

    // ID of a session within the stage.
    //
    // SessionId is a required field
    SessionId *string `locationName:"sessionId" min:"16" type:"string" required:"true"`

    // ARN of the stage for which the information is to be retrieved.
    //
    // StageArn is a required field
    StageArn *string `locationName:"stageArn" min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (GetStageSessionInput) GoString

func (s GetStageSessionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetStageSessionInput) SetSessionId

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

SetSessionId sets the SessionId field's value.

func (*GetStageSessionInput) SetStageArn

func (s *GetStageSessionInput) SetStageArn(v string) *GetStageSessionInput

SetStageArn sets the StageArn field's value.

func (GetStageSessionInput) String

func (s GetStageSessionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetStageSessionInput) Validate

func (s *GetStageSessionInput) Validate() error

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

type GetStageSessionOutput

type GetStageSessionOutput struct {

    // The stage session that is returned.
    StageSession *StageSession `locationName:"stageSession" type:"structure"`
    // contains filtered or unexported fields
}

func (GetStageSessionOutput) GoString

func (s GetStageSessionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetStageSessionOutput) SetStageSession

func (s *GetStageSessionOutput) SetStageSession(v *StageSession) *GetStageSessionOutput

SetStageSession sets the StageSession field's value.

func (GetStageSessionOutput) String

func (s GetStageSessionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetStorageConfigurationInput

type GetStorageConfigurationInput struct {

    // ARN of the storage configuration to be retrieved.
    //
    // Arn is a required field
    Arn *string `locationName:"arn" min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (GetStorageConfigurationInput) GoString

func (s GetStorageConfigurationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetStorageConfigurationInput) SetArn

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

SetArn sets the Arn field's value.

func (GetStorageConfigurationInput) String

func (s GetStorageConfigurationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetStorageConfigurationInput) Validate

func (s *GetStorageConfigurationInput) Validate() error

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

type GetStorageConfigurationOutput

type GetStorageConfigurationOutput struct {

    // The StorageConfiguration that was returned.
    StorageConfiguration *StorageConfiguration `locationName:"storageConfiguration" type:"structure"`
    // contains filtered or unexported fields
}

func (GetStorageConfigurationOutput) GoString

func (s GetStorageConfigurationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetStorageConfigurationOutput) SetStorageConfiguration

func (s *GetStorageConfigurationOutput) SetStorageConfiguration(v *StorageConfiguration) *GetStorageConfigurationOutput

SetStorageConfiguration sets the StorageConfiguration field's value.

func (GetStorageConfigurationOutput) String

func (s GetStorageConfigurationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GridConfiguration

type GridConfiguration struct {

    // This attribute name identifies the featured slot. A participant with this
    // attribute set to "true" (as a string value) in ParticipantTokenConfiguration
    // is placed in the featured slot.
    FeaturedParticipantAttribute *string `locationName:"featuredParticipantAttribute" type:"string"`

    // Specifies the spacing between participant tiles in pixels. Default: 2.
    GridGap *int64 `locationName:"gridGap" type:"integer"`

    // Determines whether to omit participants with stopped video in the composition.
    // Default: false.
    OmitStoppedVideo *bool `locationName:"omitStoppedVideo" type:"boolean"`

    // Sets the non-featured participant display mode. Default: VIDEO.
    VideoAspectRatio *string `locationName:"videoAspectRatio" type:"string" enum:"VideoAspectRatio"`

    // Defines how video fits within the participant tile. When not set, videoFillMode
    // defaults to COVER fill mode for participants in the grid and to CONTAIN fill
    // mode for featured participants.
    VideoFillMode *string `locationName:"videoFillMode" type:"string" enum:"VideoFillMode"`
    // contains filtered or unexported fields
}

Configuration information specific to Grid layout, for server-side composition. See "Layouts" in Server-Side Composition (https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/server-side-composition.html).

func (GridConfiguration) GoString

func (s GridConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GridConfiguration) SetFeaturedParticipantAttribute

func (s *GridConfiguration) SetFeaturedParticipantAttribute(v string) *GridConfiguration

SetFeaturedParticipantAttribute sets the FeaturedParticipantAttribute field's value.

func (*GridConfiguration) SetGridGap

func (s *GridConfiguration) SetGridGap(v int64) *GridConfiguration

SetGridGap sets the GridGap field's value.

func (*GridConfiguration) SetOmitStoppedVideo

func (s *GridConfiguration) SetOmitStoppedVideo(v bool) *GridConfiguration

SetOmitStoppedVideo sets the OmitStoppedVideo field's value.

func (*GridConfiguration) SetVideoAspectRatio

func (s *GridConfiguration) SetVideoAspectRatio(v string) *GridConfiguration

SetVideoAspectRatio sets the VideoAspectRatio field's value.

func (*GridConfiguration) SetVideoFillMode

func (s *GridConfiguration) SetVideoFillMode(v string) *GridConfiguration

SetVideoFillMode sets the VideoFillMode field's value.

func (GridConfiguration) String

func (s GridConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type IVSRealTime

type IVSRealTime struct {
    *client.Client
}

IVSRealTime provides the API operation methods for making requests to Amazon Interactive Video Service RealTime. See this package's package overview docs for details on the service.

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

func New

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

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

Example:

mySession := session.Must(session.NewSession())

// Create a IVSRealTime client from just a session.
svc := ivsrealtime.New(mySession)

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

func (*IVSRealTime) CreateEncoderConfiguration

func (c *IVSRealTime) CreateEncoderConfiguration(input *CreateEncoderConfigurationInput) (*CreateEncoderConfigurationOutput, error)

CreateEncoderConfiguration API operation for Amazon Interactive Video Service RealTime.

Creates an EncoderConfiguration object.

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

See the AWS API reference guide for Amazon Interactive Video Service RealTime's API operation CreateEncoderConfiguration for usage and error information.

Returned Error Types:

  • ResourceNotFoundException

  • ValidationException

  • AccessDeniedException

  • InternalServerException

  • ServiceQuotaExceededException

  • ConflictException

  • PendingVerification

See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/CreateEncoderConfiguration

func (*IVSRealTime) CreateEncoderConfigurationRequest

func (c *IVSRealTime) CreateEncoderConfigurationRequest(input *CreateEncoderConfigurationInput) (req *request.Request, output *CreateEncoderConfigurationOutput)

CreateEncoderConfigurationRequest generates a "aws/request.Request" representing the client's request for the CreateEncoderConfiguration operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateEncoderConfiguration for more information on using the CreateEncoderConfiguration API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/CreateEncoderConfiguration

func (*IVSRealTime) CreateEncoderConfigurationWithContext

func (c *IVSRealTime) CreateEncoderConfigurationWithContext(ctx aws.Context, input *CreateEncoderConfigurationInput, opts ...request.Option) (*CreateEncoderConfigurationOutput, error)

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

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

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

func (*IVSRealTime) CreateParticipantToken

func (c *IVSRealTime) CreateParticipantToken(input *CreateParticipantTokenInput) (*CreateParticipantTokenOutput, error)

CreateParticipantToken API operation for Amazon Interactive Video Service RealTime.

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.

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

See the AWS API reference guide for Amazon Interactive Video Service RealTime's API operation CreateParticipantToken for usage and error information.

Returned Error Types:

  • ResourceNotFoundException

  • ValidationException

  • AccessDeniedException

  • ServiceQuotaExceededException

  • PendingVerification

See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/CreateParticipantToken

func (*IVSRealTime) CreateParticipantTokenRequest

func (c *IVSRealTime) CreateParticipantTokenRequest(input *CreateParticipantTokenInput) (req *request.Request, output *CreateParticipantTokenOutput)

CreateParticipantTokenRequest generates a "aws/request.Request" representing the client's request for the CreateParticipantToken operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateParticipantToken for more information on using the CreateParticipantToken API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/CreateParticipantToken

func (*IVSRealTime) CreateParticipantTokenWithContext

func (c *IVSRealTime) CreateParticipantTokenWithContext(ctx aws.Context, input *CreateParticipantTokenInput, opts ...request.Option) (*CreateParticipantTokenOutput, error)

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

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

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

func (*IVSRealTime) CreateStage

func (c *IVSRealTime) CreateStage(input *CreateStageInput) (*CreateStageOutput, error)

CreateStage API operation for Amazon Interactive Video Service RealTime.

Creates a new stage (and optionally participant tokens).

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

See the AWS API reference guide for Amazon Interactive Video Service RealTime's API operation CreateStage for usage and error information.

Returned Error Types:

  • ValidationException

  • AccessDeniedException

  • ServiceQuotaExceededException

  • PendingVerification

See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/CreateStage

func (*IVSRealTime) CreateStageRequest

func (c *IVSRealTime) CreateStageRequest(input *CreateStageInput) (req *request.Request, output *CreateStageOutput)

CreateStageRequest generates a "aws/request.Request" representing the client's request for the CreateStage operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateStage for more information on using the CreateStage API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/CreateStage

func (*IVSRealTime) CreateStageWithContext

func (c *IVSRealTime) CreateStageWithContext(ctx aws.Context, input *CreateStageInput, opts ...request.Option) (*CreateStageOutput, error)

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

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

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

func (*IVSRealTime) CreateStorageConfiguration

func (c *IVSRealTime) CreateStorageConfiguration(input *CreateStorageConfigurationInput) (*CreateStorageConfigurationOutput, error)

CreateStorageConfiguration API operation for Amazon Interactive Video Service RealTime.

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.

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

See the AWS API reference guide for Amazon Interactive Video Service RealTime's API operation CreateStorageConfiguration for usage and error information.

Returned Error Types:

  • ResourceNotFoundException

  • ValidationException

  • AccessDeniedException

  • InternalServerException

  • ServiceQuotaExceededException

  • ConflictException

  • PendingVerification

See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/CreateStorageConfiguration

func (*IVSRealTime) CreateStorageConfigurationRequest

func (c *IVSRealTime) CreateStorageConfigurationRequest(input *CreateStorageConfigurationInput) (req *request.Request, output *CreateStorageConfigurationOutput)

CreateStorageConfigurationRequest generates a "aws/request.Request" representing the client's request for the CreateStorageConfiguration operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateStorageConfiguration for more information on using the CreateStorageConfiguration API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/CreateStorageConfiguration

func (*IVSRealTime) CreateStorageConfigurationWithContext

func (c *IVSRealTime) CreateStorageConfigurationWithContext(ctx aws.Context, input *CreateStorageConfigurationInput, opts ...request.Option) (*CreateStorageConfigurationOutput, error)

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

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

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

func (*IVSRealTime) DeleteEncoderConfiguration

func (c *IVSRealTime) DeleteEncoderConfiguration(input *DeleteEncoderConfigurationInput) (*DeleteEncoderConfigurationOutput, error)

DeleteEncoderConfiguration API operation for Amazon Interactive Video Service RealTime.

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

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

See the AWS API reference guide for Amazon Interactive Video Service RealTime's API operation DeleteEncoderConfiguration for usage and error information.

Returned Error Types:

  • ResourceNotFoundException

  • ValidationException

  • AccessDeniedException

  • InternalServerException

  • ServiceQuotaExceededException

  • ConflictException

See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/DeleteEncoderConfiguration

func (*IVSRealTime) DeleteEncoderConfigurationRequest

func (c *IVSRealTime) DeleteEncoderConfigurationRequest(input *DeleteEncoderConfigurationInput) (req *request.Request, output *DeleteEncoderConfigurationOutput)

DeleteEncoderConfigurationRequest generates a "aws/request.Request" representing the client's request for the DeleteEncoderConfiguration operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteEncoderConfiguration for more information on using the DeleteEncoderConfiguration API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/DeleteEncoderConfiguration

func (*IVSRealTime) DeleteEncoderConfigurationWithContext

func (c *IVSRealTime) DeleteEncoderConfigurationWithContext(ctx aws.Context, input *DeleteEncoderConfigurationInput, opts ...request.Option) (*DeleteEncoderConfigurationOutput, error)

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

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

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

func (*IVSRealTime) DeleteStage

func (c *IVSRealTime) DeleteStage(input *DeleteStageInput) (*DeleteStageOutput, error)

DeleteStage API operation for Amazon Interactive Video Service RealTime.

Shuts down and deletes the specified stage (disconnecting all participants).

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

See the AWS API reference guide for Amazon Interactive Video Service RealTime's API operation DeleteStage for usage and error information.

Returned Error Types:

  • ResourceNotFoundException

  • ValidationException

  • AccessDeniedException

  • ConflictException

  • PendingVerification

See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/DeleteStage

func (*IVSRealTime) DeleteStageRequest

func (c *IVSRealTime) DeleteStageRequest(input *DeleteStageInput) (req *request.Request, output *DeleteStageOutput)

DeleteStageRequest generates a "aws/request.Request" representing the client's request for the DeleteStage operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteStage for more information on using the DeleteStage API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/DeleteStage

func (*IVSRealTime) DeleteStageWithContext

func (c *IVSRealTime) DeleteStageWithContext(ctx aws.Context, input *DeleteStageInput, opts ...request.Option) (*DeleteStageOutput, error)

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

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

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

func (*IVSRealTime) DeleteStorageConfiguration

func (c *IVSRealTime) DeleteStorageConfiguration(input *DeleteStorageConfigurationInput) (*DeleteStorageConfigurationOutput, error)

DeleteStorageConfiguration API operation for Amazon Interactive Video Service RealTime.

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 StopComposition and wait for it to complete, then use DeleteStorageConfiguration.

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

See the AWS API reference guide for Amazon Interactive Video Service RealTime's API operation DeleteStorageConfiguration for usage and error information.

Returned Error Types:

  • ResourceNotFoundException

  • ValidationException

  • AccessDeniedException

  • InternalServerException

  • ServiceQuotaExceededException

  • ConflictException

See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/DeleteStorageConfiguration

func (*IVSRealTime) DeleteStorageConfigurationRequest

func (c *IVSRealTime) DeleteStorageConfigurationRequest(input *DeleteStorageConfigurationInput) (req *request.Request, output *DeleteStorageConfigurationOutput)

DeleteStorageConfigurationRequest generates a "aws/request.Request" representing the client's request for the DeleteStorageConfiguration operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteStorageConfiguration for more information on using the DeleteStorageConfiguration API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/DeleteStorageConfiguration

func (*IVSRealTime) DeleteStorageConfigurationWithContext

func (c *IVSRealTime) DeleteStorageConfigurationWithContext(ctx aws.Context, input *DeleteStorageConfigurationInput, opts ...request.Option) (*DeleteStorageConfigurationOutput, error)

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

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

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

func (*IVSRealTime) DisconnectParticipant

func (c *IVSRealTime) DisconnectParticipant(input *DisconnectParticipantInput) (*DisconnectParticipantOutput, error)

DisconnectParticipant API operation for Amazon Interactive Video Service RealTime.

Disconnects a specified participant and revokes the participant permanently from a specified stage.

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

See the AWS API reference guide for Amazon Interactive Video Service RealTime's API operation DisconnectParticipant for usage and error information.

Returned Error Types:

  • ResourceNotFoundException

  • ValidationException

  • AccessDeniedException

  • PendingVerification

See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/DisconnectParticipant

func (*IVSRealTime) DisconnectParticipantRequest

func (c *IVSRealTime) DisconnectParticipantRequest(input *DisconnectParticipantInput) (req *request.Request, output *DisconnectParticipantOutput)

DisconnectParticipantRequest generates a "aws/request.Request" representing the client's request for the DisconnectParticipant operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DisconnectParticipant for more information on using the DisconnectParticipant API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/DisconnectParticipant

func (*IVSRealTime) DisconnectParticipantWithContext

func (c *IVSRealTime) DisconnectParticipantWithContext(ctx aws.Context, input *DisconnectParticipantInput, opts ...request.Option) (*DisconnectParticipantOutput, error)

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

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

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

func (*IVSRealTime) GetComposition

func (c *IVSRealTime) GetComposition(input *GetCompositionInput) (*GetCompositionOutput, error)

GetComposition API operation for Amazon Interactive Video Service RealTime.

Get information about the specified Composition resource.

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

See the AWS API reference guide for Amazon Interactive Video Service RealTime's API operation GetComposition for usage and error information.

Returned Error Types:

  • ResourceNotFoundException

  • ValidationException

  • AccessDeniedException

  • InternalServerException

  • ServiceQuotaExceededException

  • ConflictException

See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/GetComposition

func (*IVSRealTime) GetCompositionRequest

func (c *IVSRealTime) GetCompositionRequest(input *GetCompositionInput) (req *request.Request, output *GetCompositionOutput)

GetCompositionRequest generates a "aws/request.Request" representing the client's request for the GetComposition operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetComposition for more information on using the GetComposition API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/GetComposition

func (*IVSRealTime) GetCompositionWithContext

func (c *IVSRealTime) GetCompositionWithContext(ctx aws.Context, input *GetCompositionInput, opts ...request.Option) (*GetCompositionOutput, error)

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

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

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

func (*IVSRealTime) GetEncoderConfiguration

func (c *IVSRealTime) GetEncoderConfiguration(input *GetEncoderConfigurationInput) (*GetEncoderConfigurationOutput, error)

GetEncoderConfiguration API operation for Amazon Interactive Video Service RealTime.

Gets information about the specified EncoderConfiguration resource.

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

See the AWS API reference guide for Amazon Interactive Video Service RealTime's API operation GetEncoderConfiguration for usage and error information.

Returned Error Types:

  • ResourceNotFoundException

  • ValidationException

  • AccessDeniedException

  • InternalServerException

  • ServiceQuotaExceededException

  • ConflictException

See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/GetEncoderConfiguration

func (*IVSRealTime) GetEncoderConfigurationRequest

func (c *IVSRealTime) GetEncoderConfigurationRequest(input *GetEncoderConfigurationInput) (req *request.Request, output *GetEncoderConfigurationOutput)

GetEncoderConfigurationRequest generates a "aws/request.Request" representing the client's request for the GetEncoderConfiguration operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetEncoderConfiguration for more information on using the GetEncoderConfiguration API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/GetEncoderConfiguration

func (*IVSRealTime) GetEncoderConfigurationWithContext

func (c *IVSRealTime) GetEncoderConfigurationWithContext(ctx aws.Context, input *GetEncoderConfigurationInput, opts ...request.Option) (*GetEncoderConfigurationOutput, error)

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

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

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

func (*IVSRealTime) GetParticipant

func (c *IVSRealTime) GetParticipant(input *GetParticipantInput) (*GetParticipantOutput, error)

GetParticipant API operation for Amazon Interactive Video Service RealTime.

Gets information about the specified participant token.

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

See the AWS API reference guide for Amazon Interactive Video Service RealTime's API operation GetParticipant for usage and error information.

Returned Error Types:

  • ResourceNotFoundException

  • ValidationException

  • AccessDeniedException

See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/GetParticipant

func (*IVSRealTime) GetParticipantRequest

func (c *IVSRealTime) GetParticipantRequest(input *GetParticipantInput) (req *request.Request, output *GetParticipantOutput)

GetParticipantRequest generates a "aws/request.Request" representing the client's request for the GetParticipant operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetParticipant for more information on using the GetParticipant API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/GetParticipant

func (*IVSRealTime) GetParticipantWithContext

func (c *IVSRealTime) GetParticipantWithContext(ctx aws.Context, input *GetParticipantInput, opts ...request.Option) (*GetParticipantOutput, error)

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

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

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

func (*IVSRealTime) GetStage

func (c *IVSRealTime) GetStage(input *GetStageInput) (*GetStageOutput, error)

GetStage API operation for Amazon Interactive Video Service RealTime.

Gets information for the specified stage.

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

See the AWS API reference guide for Amazon Interactive Video Service RealTime's API operation GetStage for usage and error information.

Returned Error Types:

  • ResourceNotFoundException

  • ValidationException

  • AccessDeniedException

See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/GetStage

func (*IVSRealTime) GetStageRequest

func (c *IVSRealTime) GetStageRequest(input *GetStageInput) (req *request.Request, output *GetStageOutput)

GetStageRequest generates a "aws/request.Request" representing the client's request for the GetStage operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetStage for more information on using the GetStage API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/GetStage

func (*IVSRealTime) GetStageSession

func (c *IVSRealTime) GetStageSession(input *GetStageSessionInput) (*GetStageSessionOutput, error)

GetStageSession API operation for Amazon Interactive Video Service RealTime.

Gets information for the specified stage session.

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

See the AWS API reference guide for Amazon Interactive Video Service RealTime's API operation GetStageSession for usage and error information.

Returned Error Types:

  • ResourceNotFoundException

  • ValidationException

  • AccessDeniedException

See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/GetStageSession

func (*IVSRealTime) GetStageSessionRequest

func (c *IVSRealTime) GetStageSessionRequest(input *GetStageSessionInput) (req *request.Request, output *GetStageSessionOutput)

GetStageSessionRequest generates a "aws/request.Request" representing the client's request for the GetStageSession operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetStageSession for more information on using the GetStageSession API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/GetStageSession

func (*IVSRealTime) GetStageSessionWithContext

func (c *IVSRealTime) GetStageSessionWithContext(ctx aws.Context, input *GetStageSessionInput, opts ...request.Option) (*GetStageSessionOutput, error)

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

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

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

func (*IVSRealTime) GetStageWithContext

func (c *IVSRealTime) GetStageWithContext(ctx aws.Context, input *GetStageInput, opts ...request.Option) (*GetStageOutput, error)

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

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

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

func (*IVSRealTime) GetStorageConfiguration

func (c *IVSRealTime) GetStorageConfiguration(input *GetStorageConfigurationInput) (*GetStorageConfigurationOutput, error)

GetStorageConfiguration API operation for Amazon Interactive Video Service RealTime.

Gets the storage configuration for the specified ARN.

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

See the AWS API reference guide for Amazon Interactive Video Service RealTime's API operation GetStorageConfiguration for usage and error information.

Returned Error Types:

  • ResourceNotFoundException

  • ValidationException

  • AccessDeniedException

  • InternalServerException

  • ServiceQuotaExceededException

  • ConflictException

See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/GetStorageConfiguration

func (*IVSRealTime) GetStorageConfigurationRequest

func (c *IVSRealTime) GetStorageConfigurationRequest(input *GetStorageConfigurationInput) (req *request.Request, output *GetStorageConfigurationOutput)

GetStorageConfigurationRequest generates a "aws/request.Request" representing the client's request for the GetStorageConfiguration operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetStorageConfiguration for more information on using the GetStorageConfiguration API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/GetStorageConfiguration

func (*IVSRealTime) GetStorageConfigurationWithContext

func (c *IVSRealTime) GetStorageConfigurationWithContext(ctx aws.Context, input *GetStorageConfigurationInput, opts ...request.Option) (*GetStorageConfigurationOutput, error)

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

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

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

func (*IVSRealTime) ListCompositions

func (c *IVSRealTime) ListCompositions(input *ListCompositionsInput) (*ListCompositionsOutput, error)

ListCompositions API operation for Amazon Interactive Video Service RealTime.

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

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

See the AWS API reference guide for Amazon Interactive Video Service RealTime's API operation ListCompositions for usage and error information.

Returned Error Types:

  • ValidationException

  • AccessDeniedException

  • InternalServerException

  • ServiceQuotaExceededException

  • ConflictException

See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/ListCompositions

func (*IVSRealTime) ListCompositionsPages

func (c *IVSRealTime) ListCompositionsPages(input *ListCompositionsInput, fn func(*ListCompositionsOutput, bool) bool) error

ListCompositionsPages iterates over the pages of a ListCompositions operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListCompositions method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListCompositions operation.
pageNum := 0
err := client.ListCompositionsPages(params,
    func(page *ivsrealtime.ListCompositionsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*IVSRealTime) ListCompositionsPagesWithContext

func (c *IVSRealTime) ListCompositionsPagesWithContext(ctx aws.Context, input *ListCompositionsInput, fn func(*ListCompositionsOutput, bool) bool, opts ...request.Option) error

ListCompositionsPagesWithContext same as ListCompositionsPages except it takes a Context and allows setting request options on the pages.

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

func (*IVSRealTime) ListCompositionsRequest

func (c *IVSRealTime) ListCompositionsRequest(input *ListCompositionsInput) (req *request.Request, output *ListCompositionsOutput)

ListCompositionsRequest generates a "aws/request.Request" representing the client's request for the ListCompositions operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListCompositions for more information on using the ListCompositions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/ListCompositions

func (*IVSRealTime) ListCompositionsWithContext

func (c *IVSRealTime) ListCompositionsWithContext(ctx aws.Context, input *ListCompositionsInput, opts ...request.Option) (*ListCompositionsOutput, error)

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

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

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

func (*IVSRealTime) ListEncoderConfigurations

func (c *IVSRealTime) ListEncoderConfigurations(input *ListEncoderConfigurationsInput) (*ListEncoderConfigurationsOutput, error)

ListEncoderConfigurations API operation for Amazon Interactive Video Service RealTime.

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

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

See the AWS API reference guide for Amazon Interactive Video Service RealTime's API operation ListEncoderConfigurations for usage and error information.

Returned Error Types:

  • ValidationException

  • AccessDeniedException

  • InternalServerException

  • ServiceQuotaExceededException

  • ConflictException

See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/ListEncoderConfigurations

func (*IVSRealTime) ListEncoderConfigurationsPages

func (c *IVSRealTime) ListEncoderConfigurationsPages(input *ListEncoderConfigurationsInput, fn func(*ListEncoderConfigurationsOutput, bool) bool) error

ListEncoderConfigurationsPages iterates over the pages of a ListEncoderConfigurations operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListEncoderConfigurations method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListEncoderConfigurations operation.
pageNum := 0
err := client.ListEncoderConfigurationsPages(params,
    func(page *ivsrealtime.ListEncoderConfigurationsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*IVSRealTime) ListEncoderConfigurationsPagesWithContext

func (c *IVSRealTime) ListEncoderConfigurationsPagesWithContext(ctx aws.Context, input *ListEncoderConfigurationsInput, fn func(*ListEncoderConfigurationsOutput, bool) bool, opts ...request.Option) error

ListEncoderConfigurationsPagesWithContext same as ListEncoderConfigurationsPages except it takes a Context and allows setting request options on the pages.

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

func (*IVSRealTime) ListEncoderConfigurationsRequest

func (c *IVSRealTime) ListEncoderConfigurationsRequest(input *ListEncoderConfigurationsInput) (req *request.Request, output *ListEncoderConfigurationsOutput)

ListEncoderConfigurationsRequest generates a "aws/request.Request" representing the client's request for the ListEncoderConfigurations operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListEncoderConfigurations for more information on using the ListEncoderConfigurations API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/ListEncoderConfigurations

func (*IVSRealTime) ListEncoderConfigurationsWithContext

func (c *IVSRealTime) ListEncoderConfigurationsWithContext(ctx aws.Context, input *ListEncoderConfigurationsInput, opts ...request.Option) (*ListEncoderConfigurationsOutput, error)

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

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

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

func (*IVSRealTime) ListParticipantEvents

func (c *IVSRealTime) ListParticipantEvents(input *ListParticipantEventsInput) (*ListParticipantEventsOutput, error)

ListParticipantEvents API operation for Amazon Interactive Video Service RealTime.

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

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

See the AWS API reference guide for Amazon Interactive Video Service RealTime's API operation ListParticipantEvents for usage and error information.

Returned Error Types:

  • ValidationException

  • AccessDeniedException

See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/ListParticipantEvents

func (*IVSRealTime) ListParticipantEventsPages

func (c *IVSRealTime) ListParticipantEventsPages(input *ListParticipantEventsInput, fn func(*ListParticipantEventsOutput, bool) bool) error

ListParticipantEventsPages iterates over the pages of a ListParticipantEvents operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListParticipantEvents method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListParticipantEvents operation.
pageNum := 0
err := client.ListParticipantEventsPages(params,
    func(page *ivsrealtime.ListParticipantEventsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*IVSRealTime) ListParticipantEventsPagesWithContext

func (c *IVSRealTime) ListParticipantEventsPagesWithContext(ctx aws.Context, input *ListParticipantEventsInput, fn func(*ListParticipantEventsOutput, bool) bool, opts ...request.Option) error

ListParticipantEventsPagesWithContext same as ListParticipantEventsPages except it takes a Context and allows setting request options on the pages.

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

func (*IVSRealTime) ListParticipantEventsRequest

func (c *IVSRealTime) ListParticipantEventsRequest(input *ListParticipantEventsInput) (req *request.Request, output *ListParticipantEventsOutput)

ListParticipantEventsRequest generates a "aws/request.Request" representing the client's request for the ListParticipantEvents operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListParticipantEvents for more information on using the ListParticipantEvents API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/ListParticipantEvents

func (*IVSRealTime) ListParticipantEventsWithContext

func (c *IVSRealTime) ListParticipantEventsWithContext(ctx aws.Context, input *ListParticipantEventsInput, opts ...request.Option) (*ListParticipantEventsOutput, error)

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

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

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

func (*IVSRealTime) ListParticipants

func (c *IVSRealTime) ListParticipants(input *ListParticipantsInput) (*ListParticipantsOutput, error)

ListParticipants API operation for Amazon Interactive Video Service RealTime.

Lists all participants in a specified stage session.

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

See the AWS API reference guide for Amazon Interactive Video Service RealTime's API operation ListParticipants for usage and error information.

Returned Error Types:

  • ValidationException

  • AccessDeniedException

See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/ListParticipants

func (*IVSRealTime) ListParticipantsPages

func (c *IVSRealTime) ListParticipantsPages(input *ListParticipantsInput, fn func(*ListParticipantsOutput, bool) bool) error

ListParticipantsPages iterates over the pages of a ListParticipants operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListParticipants method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListParticipants operation.
pageNum := 0
err := client.ListParticipantsPages(params,
    func(page *ivsrealtime.ListParticipantsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*IVSRealTime) ListParticipantsPagesWithContext

func (c *IVSRealTime) ListParticipantsPagesWithContext(ctx aws.Context, input *ListParticipantsInput, fn func(*ListParticipantsOutput, bool) bool, opts ...request.Option) error

ListParticipantsPagesWithContext same as ListParticipantsPages except it takes a Context and allows setting request options on the pages.

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

func (*IVSRealTime) ListParticipantsRequest

func (c *IVSRealTime) ListParticipantsRequest(input *ListParticipantsInput) (req *request.Request, output *ListParticipantsOutput)

ListParticipantsRequest generates a "aws/request.Request" representing the client's request for the ListParticipants operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListParticipants for more information on using the ListParticipants API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/ListParticipants

func (*IVSRealTime) ListParticipantsWithContext

func (c *IVSRealTime) ListParticipantsWithContext(ctx aws.Context, input *ListParticipantsInput, opts ...request.Option) (*ListParticipantsOutput, error)

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

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

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

func (*IVSRealTime) ListStageSessions

func (c *IVSRealTime) ListStageSessions(input *ListStageSessionsInput) (*ListStageSessionsOutput, error)

ListStageSessions API operation for Amazon Interactive Video Service RealTime.

Gets all sessions for a specified stage.

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

See the AWS API reference guide for Amazon Interactive Video Service RealTime's API operation ListStageSessions for usage and error information.

Returned Error Types:

  • ValidationException

  • AccessDeniedException

See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/ListStageSessions

func (*IVSRealTime) ListStageSessionsPages

func (c *IVSRealTime) ListStageSessionsPages(input *ListStageSessionsInput, fn func(*ListStageSessionsOutput, bool) bool) error

ListStageSessionsPages iterates over the pages of a ListStageSessions operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListStageSessions method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListStageSessions operation.
pageNum := 0
err := client.ListStageSessionsPages(params,
    func(page *ivsrealtime.ListStageSessionsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*IVSRealTime) ListStageSessionsPagesWithContext

func (c *IVSRealTime) ListStageSessionsPagesWithContext(ctx aws.Context, input *ListStageSessionsInput, fn func(*ListStageSessionsOutput, bool) bool, opts ...request.Option) error

ListStageSessionsPagesWithContext same as ListStageSessionsPages except it takes a Context and allows setting request options on the pages.

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

func (*IVSRealTime) ListStageSessionsRequest

func (c *IVSRealTime) ListStageSessionsRequest(input *ListStageSessionsInput) (req *request.Request, output *ListStageSessionsOutput)

ListStageSessionsRequest generates a "aws/request.Request" representing the client's request for the ListStageSessions operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListStageSessions for more information on using the ListStageSessions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/ListStageSessions

func (*IVSRealTime) ListStageSessionsWithContext

func (c *IVSRealTime) ListStageSessionsWithContext(ctx aws.Context, input *ListStageSessionsInput, opts ...request.Option) (*ListStageSessionsOutput, error)

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

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

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

func (*IVSRealTime) ListStages

func (c *IVSRealTime) ListStages(input *ListStagesInput) (*ListStagesOutput, error)

ListStages API operation for Amazon Interactive Video Service RealTime.

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

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

See the AWS API reference guide for Amazon Interactive Video Service RealTime's API operation ListStages for usage and error information.

Returned Error Types:

  • ValidationException

  • AccessDeniedException

  • ConflictException

See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/ListStages

func (*IVSRealTime) ListStagesPages

func (c *IVSRealTime) ListStagesPages(input *ListStagesInput, fn func(*ListStagesOutput, bool) bool) error

ListStagesPages iterates over the pages of a ListStages operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListStages method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListStages operation.
pageNum := 0
err := client.ListStagesPages(params,
    func(page *ivsrealtime.ListStagesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*IVSRealTime) ListStagesPagesWithContext

func (c *IVSRealTime) ListStagesPagesWithContext(ctx aws.Context, input *ListStagesInput, fn func(*ListStagesOutput, bool) bool, opts ...request.Option) error

ListStagesPagesWithContext same as ListStagesPages except it takes a Context and allows setting request options on the pages.

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

func (*IVSRealTime) ListStagesRequest

func (c *IVSRealTime) ListStagesRequest(input *ListStagesInput) (req *request.Request, output *ListStagesOutput)

ListStagesRequest generates a "aws/request.Request" representing the client's request for the ListStages operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListStages for more information on using the ListStages API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/ListStages

func (*IVSRealTime) ListStagesWithContext

func (c *IVSRealTime) ListStagesWithContext(ctx aws.Context, input *ListStagesInput, opts ...request.Option) (*ListStagesOutput, error)

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

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

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

func (*IVSRealTime) ListStorageConfigurations

func (c *IVSRealTime) ListStorageConfigurations(input *ListStorageConfigurationsInput) (*ListStorageConfigurationsOutput, error)

ListStorageConfigurations API operation for Amazon Interactive Video Service RealTime.

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

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

See the AWS API reference guide for Amazon Interactive Video Service RealTime's API operation ListStorageConfigurations for usage and error information.

Returned Error Types:

  • ValidationException

  • AccessDeniedException

  • InternalServerException

  • ServiceQuotaExceededException

  • ConflictException

See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/ListStorageConfigurations

func (*IVSRealTime) ListStorageConfigurationsPages

func (c *IVSRealTime) ListStorageConfigurationsPages(input *ListStorageConfigurationsInput, fn func(*ListStorageConfigurationsOutput, bool) bool) error

ListStorageConfigurationsPages iterates over the pages of a ListStorageConfigurations operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListStorageConfigurations method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListStorageConfigurations operation.
pageNum := 0
err := client.ListStorageConfigurationsPages(params,
    func(page *ivsrealtime.ListStorageConfigurationsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*IVSRealTime) ListStorageConfigurationsPagesWithContext

func (c *IVSRealTime) ListStorageConfigurationsPagesWithContext(ctx aws.Context, input *ListStorageConfigurationsInput, fn func(*ListStorageConfigurationsOutput, bool) bool, opts ...request.Option) error

ListStorageConfigurationsPagesWithContext same as ListStorageConfigurationsPages except it takes a Context and allows setting request options on the pages.

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

func (*IVSRealTime) ListStorageConfigurationsRequest

func (c *IVSRealTime) ListStorageConfigurationsRequest(input *ListStorageConfigurationsInput) (req *request.Request, output *ListStorageConfigurationsOutput)

ListStorageConfigurationsRequest generates a "aws/request.Request" representing the client's request for the ListStorageConfigurations operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListStorageConfigurations for more information on using the ListStorageConfigurations API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/ListStorageConfigurations

func (*IVSRealTime) ListStorageConfigurationsWithContext

func (c *IVSRealTime) ListStorageConfigurationsWithContext(ctx aws.Context, input *ListStorageConfigurationsInput, opts ...request.Option) (*ListStorageConfigurationsOutput, error)

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

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

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

func (*IVSRealTime) ListTagsForResource

func (c *IVSRealTime) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)

ListTagsForResource API operation for Amazon Interactive Video Service RealTime.

Gets information about AWS tags for the specified ARN.

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

See the AWS API reference guide for Amazon Interactive Video Service RealTime's API operation ListTagsForResource for usage and error information.

Returned Error Types:

  • ResourceNotFoundException

  • ValidationException

  • InternalServerException

See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/ListTagsForResource

func (*IVSRealTime) ListTagsForResourceRequest

func (c *IVSRealTime) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput)

ListTagsForResourceRequest generates a "aws/request.Request" representing the client's request for the ListTagsForResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListTagsForResource for more information on using the ListTagsForResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/ListTagsForResource

func (*IVSRealTime) ListTagsForResourceWithContext

func (c *IVSRealTime) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error)

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

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

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

func (*IVSRealTime) StartComposition

func (c *IVSRealTime) StartComposition(input *StartCompositionInput) (*StartCompositionOutput, error)

StartComposition API operation for Amazon Interactive Video Service RealTime.

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

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

  • When StopComposition is 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.

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

See the AWS API reference guide for Amazon Interactive Video Service RealTime's API operation StartComposition for usage and error information.

Returned Error Types:

  • ResourceNotFoundException

  • ValidationException

  • AccessDeniedException

  • InternalServerException

  • ServiceQuotaExceededException

  • ConflictException

  • PendingVerification

See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/StartComposition

func (*IVSRealTime) StartCompositionRequest

func (c *IVSRealTime) StartCompositionRequest(input *StartCompositionInput) (req *request.Request, output *StartCompositionOutput)

StartCompositionRequest generates a "aws/request.Request" representing the client's request for the StartComposition operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StartComposition for more information on using the StartComposition API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/StartComposition

func (*IVSRealTime) StartCompositionWithContext

func (c *IVSRealTime) StartCompositionWithContext(ctx aws.Context, input *StartCompositionInput, opts ...request.Option) (*StartCompositionOutput, error)

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

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

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

func (*IVSRealTime) StopComposition

func (c *IVSRealTime) StopComposition(input *StopCompositionInput) (*StopCompositionOutput, error)

StopComposition API operation for Amazon Interactive Video Service RealTime.

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

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

See the AWS API reference guide for Amazon Interactive Video Service RealTime's API operation StopComposition for usage and error information.

Returned Error Types:

  • ResourceNotFoundException

  • ValidationException

  • AccessDeniedException

  • InternalServerException

  • ServiceQuotaExceededException

  • ConflictException

See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/StopComposition

func (*IVSRealTime) StopCompositionRequest

func (c *IVSRealTime) StopCompositionRequest(input *StopCompositionInput) (req *request.Request, output *StopCompositionOutput)

StopCompositionRequest generates a "aws/request.Request" representing the client's request for the StopComposition operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StopComposition for more information on using the StopComposition API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/StopComposition

func (*IVSRealTime) StopCompositionWithContext

func (c *IVSRealTime) StopCompositionWithContext(ctx aws.Context, input *StopCompositionInput, opts ...request.Option) (*StopCompositionOutput, error)

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

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

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

func (*IVSRealTime) TagResource

func (c *IVSRealTime) TagResource(input *TagResourceInput) (*TagResourceOutput, error)

TagResource API operation for Amazon Interactive Video Service RealTime.

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

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

See the AWS API reference guide for Amazon Interactive Video Service RealTime's API operation TagResource for usage and error information.

Returned Error Types:

  • ResourceNotFoundException

  • ValidationException

  • InternalServerException

See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/TagResource

func (*IVSRealTime) TagResourceRequest

func (c *IVSRealTime) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput)

TagResourceRequest generates a "aws/request.Request" representing the client's request for the TagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See TagResource for more information on using the TagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/TagResource

func (*IVSRealTime) TagResourceWithContext

func (c *IVSRealTime) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error)

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

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

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

func (*IVSRealTime) UntagResource

func (c *IVSRealTime) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)

UntagResource API operation for Amazon Interactive Video Service RealTime.

Removes tags from the resource with the specified ARN.

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

See the AWS API reference guide for Amazon Interactive Video Service RealTime's API operation UntagResource for usage and error information.

Returned Error Types:

  • ResourceNotFoundException

  • ValidationException

  • InternalServerException

See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/UntagResource

func (*IVSRealTime) UntagResourceRequest

func (c *IVSRealTime) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput)

UntagResourceRequest generates a "aws/request.Request" representing the client's request for the UntagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UntagResource for more information on using the UntagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/UntagResource

func (*IVSRealTime) UntagResourceWithContext

func (c *IVSRealTime) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error)

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

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

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

func (*IVSRealTime) UpdateStage

func (c *IVSRealTime) UpdateStage(input *UpdateStageInput) (*UpdateStageOutput, error)

UpdateStage API operation for Amazon Interactive Video Service RealTime.

Updates a stage’s configuration.

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

See the AWS API reference guide for Amazon Interactive Video Service RealTime's API operation UpdateStage for usage and error information.

Returned Error Types:

  • ResourceNotFoundException

  • ValidationException

  • AccessDeniedException

  • ServiceQuotaExceededException

  • PendingVerification

See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/UpdateStage

func (*IVSRealTime) UpdateStageRequest

func (c *IVSRealTime) UpdateStageRequest(input *UpdateStageInput) (req *request.Request, output *UpdateStageOutput)

UpdateStageRequest generates a "aws/request.Request" representing the client's request for the UpdateStage operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateStage for more information on using the UpdateStage API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/UpdateStage

func (*IVSRealTime) UpdateStageWithContext

func (c *IVSRealTime) UpdateStageWithContext(ctx aws.Context, input *UpdateStageInput, opts ...request.Option) (*UpdateStageOutput, error)

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

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

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

type InternalServerException

type InternalServerException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    // Unexpected error during processing of request.
    ExceptionMessage *string `locationName:"exceptionMessage" type:"string"`

    Message_ *string `locationName:"message" type:"string"`
    // contains filtered or unexported fields
}

func (*InternalServerException) Code

func (s *InternalServerException) Code() string

Code returns the exception type name.

func (*InternalServerException) Error

func (s *InternalServerException) Error() string

func (InternalServerException) GoString

func (s InternalServerException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InternalServerException) Message

func (s *InternalServerException) Message() string

Message returns the exception's message.

func (*InternalServerException) OrigErr

func (s *InternalServerException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalServerException) RequestID

func (s *InternalServerException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalServerException) StatusCode

func (s *InternalServerException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InternalServerException) String

func (s InternalServerException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type LayoutConfiguration

type LayoutConfiguration struct {

    // Configuration related to grid layout. Default: Grid layout.
    Grid *GridConfiguration `locationName:"grid" type:"structure"`

    // Configuration related to PiP layout.
    Pip *PipConfiguration `locationName:"pip" type:"structure"`
    // contains filtered or unexported fields
}

Configuration information of supported layouts for server-side composition.

func (LayoutConfiguration) GoString

func (s LayoutConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LayoutConfiguration) SetGrid

func (s *LayoutConfiguration) SetGrid(v *GridConfiguration) *LayoutConfiguration

SetGrid sets the Grid field's value.

func (*LayoutConfiguration) SetPip

func (s *LayoutConfiguration) SetPip(v *PipConfiguration) *LayoutConfiguration

SetPip sets the Pip field's value.

func (LayoutConfiguration) String

func (s LayoutConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LayoutConfiguration) Validate

func (s *LayoutConfiguration) Validate() error

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

type ListCompositionsInput

type ListCompositionsInput struct {

    // Filters the Composition list to match the specified EncoderConfiguration
    // attached to at least one of its output.
    FilterByEncoderConfigurationArn *string `locationName:"filterByEncoderConfigurationArn" min:"1" type:"string"`

    // Filters the Composition list to match the specified Stage ARN.
    FilterByStageArn *string `locationName:"filterByStageArn" min:"1" type:"string"`

    // Maximum number of results to return. Default: 100.
    MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"`

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

func (ListCompositionsInput) GoString

func (s ListCompositionsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListCompositionsInput) SetFilterByEncoderConfigurationArn

func (s *ListCompositionsInput) SetFilterByEncoderConfigurationArn(v string) *ListCompositionsInput

SetFilterByEncoderConfigurationArn sets the FilterByEncoderConfigurationArn field's value.

func (*ListCompositionsInput) SetFilterByStageArn

func (s *ListCompositionsInput) SetFilterByStageArn(v string) *ListCompositionsInput

SetFilterByStageArn sets the FilterByStageArn field's value.

func (*ListCompositionsInput) SetMaxResults

func (s *ListCompositionsInput) SetMaxResults(v int64) *ListCompositionsInput

SetMaxResults sets the MaxResults field's value.

func (*ListCompositionsInput) SetNextToken

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

SetNextToken sets the NextToken field's value.

func (ListCompositionsInput) String

func (s ListCompositionsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListCompositionsInput) Validate

func (s *ListCompositionsInput) Validate() error

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

type ListCompositionsOutput

type ListCompositionsOutput struct {

    // List of the matching Compositions (summary information only).
    //
    // Compositions is a required field
    Compositions []*CompositionSummary `locationName:"compositions" type:"list" required:"true"`

    // If there are more compositions than maxResults, use nextToken in the request
    // to get the next set.
    NextToken *string `locationName:"nextToken" type:"string"`
    // contains filtered or unexported fields
}

func (ListCompositionsOutput) GoString

func (s ListCompositionsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListCompositionsOutput) SetCompositions

func (s *ListCompositionsOutput) SetCompositions(v []*CompositionSummary) *ListCompositionsOutput

SetCompositions sets the Compositions field's value.

func (*ListCompositionsOutput) SetNextToken

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

SetNextToken sets the NextToken field's value.

func (ListCompositionsOutput) String

func (s ListCompositionsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListEncoderConfigurationsInput

type ListEncoderConfigurationsInput struct {

    // Maximum number of results to return. Default: 100.
    MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"`

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

func (ListEncoderConfigurationsInput) GoString

func (s ListEncoderConfigurationsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListEncoderConfigurationsInput) SetMaxResults

func (s *ListEncoderConfigurationsInput) SetMaxResults(v int64) *ListEncoderConfigurationsInput

SetMaxResults sets the MaxResults field's value.

func (*ListEncoderConfigurationsInput) SetNextToken

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

SetNextToken sets the NextToken field's value.

func (ListEncoderConfigurationsInput) String

func (s ListEncoderConfigurationsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListEncoderConfigurationsInput) Validate

func (s *ListEncoderConfigurationsInput) Validate() error

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

type ListEncoderConfigurationsOutput

type ListEncoderConfigurationsOutput struct {

    // List of the matching EncoderConfigurations (summary information only).
    //
    // EncoderConfigurations is a required field
    EncoderConfigurations []*EncoderConfigurationSummary `locationName:"encoderConfigurations" type:"list" required:"true"`

    // If there are more encoder configurations than maxResults, use nextToken in
    // the request to get the next set.
    NextToken *string `locationName:"nextToken" type:"string"`
    // contains filtered or unexported fields
}

func (ListEncoderConfigurationsOutput) GoString

func (s ListEncoderConfigurationsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListEncoderConfigurationsOutput) SetEncoderConfigurations

func (s *ListEncoderConfigurationsOutput) SetEncoderConfigurations(v []*EncoderConfigurationSummary) *ListEncoderConfigurationsOutput

SetEncoderConfigurations sets the EncoderConfigurations field's value.

func (*ListEncoderConfigurationsOutput) SetNextToken

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

SetNextToken sets the NextToken field's value.

func (ListEncoderConfigurationsOutput) String

func (s ListEncoderConfigurationsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListParticipantEventsInput

type ListParticipantEventsInput struct {

    // Maximum number of results to return. Default: 50.
    MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"`

    // The first participant event to retrieve. This is used for pagination; see
    // the nextToken response field.
    NextToken *string `locationName:"nextToken" type:"string"`

    // Unique identifier for this participant. This is assigned by IVS and returned
    // by CreateParticipantToken.
    //
    // ParticipantId is a required field
    ParticipantId *string `locationName:"participantId" type:"string" required:"true"`

    // ID of a session within the stage.
    //
    // SessionId is a required field
    SessionId *string `locationName:"sessionId" min:"16" type:"string" required:"true"`

    // Stage ARN.
    //
    // StageArn is a required field
    StageArn *string `locationName:"stageArn" min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (ListParticipantEventsInput) GoString

func (s ListParticipantEventsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListParticipantEventsInput) SetMaxResults

func (s *ListParticipantEventsInput) SetMaxResults(v int64) *ListParticipantEventsInput

SetMaxResults sets the MaxResults field's value.

func (*ListParticipantEventsInput) SetNextToken

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

SetNextToken sets the NextToken field's value.

func (*ListParticipantEventsInput) SetParticipantId

func (s *ListParticipantEventsInput) SetParticipantId(v string) *ListParticipantEventsInput

SetParticipantId sets the ParticipantId field's value.

func (*ListParticipantEventsInput) SetSessionId

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

SetSessionId sets the SessionId field's value.

func (*ListParticipantEventsInput) SetStageArn

func (s *ListParticipantEventsInput) SetStageArn(v string) *ListParticipantEventsInput

SetStageArn sets the StageArn field's value.

func (ListParticipantEventsInput) String

func (s ListParticipantEventsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListParticipantEventsInput) Validate

func (s *ListParticipantEventsInput) Validate() error

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

type ListParticipantEventsOutput

type ListParticipantEventsOutput struct {

    // List of the matching events.
    //
    // Events is a required field
    Events []*Event `locationName:"events" type:"list" required:"true"`

    // If there are more events than maxResults, use nextToken in the request to
    // get the next set.
    NextToken *string `locationName:"nextToken" type:"string"`
    // contains filtered or unexported fields
}

func (ListParticipantEventsOutput) GoString

func (s ListParticipantEventsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListParticipantEventsOutput) SetEvents

func (s *ListParticipantEventsOutput) SetEvents(v []*Event) *ListParticipantEventsOutput

SetEvents sets the Events field's value.

func (*ListParticipantEventsOutput) SetNextToken

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

SetNextToken sets the NextToken field's value.

func (ListParticipantEventsOutput) String

func (s ListParticipantEventsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListParticipantsInput

type ListParticipantsInput struct {

    // Filters the response list to only show participants who published during
    // the stage session. Only one of filterByUserId, filterByPublished, or filterByState
    // can be provided per request.
    FilterByPublished *bool `locationName:"filterByPublished" type:"boolean"`

    // Filters the response list to only show participants in the specified state.
    // Only one of filterByUserId, filterByPublished, or filterByState can be provided
    // per request.
    FilterByState *string `locationName:"filterByState" type:"string" enum:"ParticipantState"`

    // Filters the response list to match the specified user ID. Only one of filterByUserId,
    // filterByPublished, or filterByState 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 `locationName:"filterByUserId" type:"string"`

    // Maximum number of results to return. Default: 50.
    MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"`

    // The first participant to retrieve. This is used for pagination; see the nextToken
    // response field.
    NextToken *string `locationName:"nextToken" type:"string"`

    // ID of the session within the stage.
    //
    // SessionId is a required field
    SessionId *string `locationName:"sessionId" min:"16" type:"string" required:"true"`

    // Stage ARN.
    //
    // StageArn is a required field
    StageArn *string `locationName:"stageArn" min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (ListParticipantsInput) GoString

func (s ListParticipantsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListParticipantsInput) SetFilterByPublished

func (s *ListParticipantsInput) SetFilterByPublished(v bool) *ListParticipantsInput

SetFilterByPublished sets the FilterByPublished field's value.

func (*ListParticipantsInput) SetFilterByState

func (s *ListParticipantsInput) SetFilterByState(v string) *ListParticipantsInput

SetFilterByState sets the FilterByState field's value.

func (*ListParticipantsInput) SetFilterByUserId

func (s *ListParticipantsInput) SetFilterByUserId(v string) *ListParticipantsInput

SetFilterByUserId sets the FilterByUserId field's value.

func (*ListParticipantsInput) SetMaxResults

func (s *ListParticipantsInput) SetMaxResults(v int64) *ListParticipantsInput

SetMaxResults sets the MaxResults field's value.

func (*ListParticipantsInput) SetNextToken

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

SetNextToken sets the NextToken field's value.

func (*ListParticipantsInput) SetSessionId

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

SetSessionId sets the SessionId field's value.

func (*ListParticipantsInput) SetStageArn

func (s *ListParticipantsInput) SetStageArn(v string) *ListParticipantsInput

SetStageArn sets the StageArn field's value.

func (ListParticipantsInput) String

func (s ListParticipantsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListParticipantsInput) Validate

func (s *ListParticipantsInput) Validate() error

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

type ListParticipantsOutput

type ListParticipantsOutput struct {

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

    // List of the matching participants (summary information only).
    //
    // Participants is a required field
    Participants []*ParticipantSummary `locationName:"participants" type:"list" required:"true"`
    // contains filtered or unexported fields
}

func (ListParticipantsOutput) GoString

func (s ListParticipantsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListParticipantsOutput) SetNextToken

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

SetNextToken sets the NextToken field's value.

func (*ListParticipantsOutput) SetParticipants

func (s *ListParticipantsOutput) SetParticipants(v []*ParticipantSummary) *ListParticipantsOutput

SetParticipants sets the Participants field's value.

func (ListParticipantsOutput) String

func (s ListParticipantsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListStageSessionsInput

type ListStageSessionsInput struct {

    // Maximum number of results to return. Default: 50.
    MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"`

    // The first stage session to retrieve. This is used for pagination; see the
    // nextToken response field.
    NextToken *string `locationName:"nextToken" type:"string"`

    // Stage ARN.
    //
    // StageArn is a required field
    StageArn *string `locationName:"stageArn" min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (ListStageSessionsInput) GoString

func (s ListStageSessionsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListStageSessionsInput) SetMaxResults

func (s *ListStageSessionsInput) SetMaxResults(v int64) *ListStageSessionsInput

SetMaxResults sets the MaxResults field's value.

func (*ListStageSessionsInput) SetNextToken

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

SetNextToken sets the NextToken field's value.

func (*ListStageSessionsInput) SetStageArn

func (s *ListStageSessionsInput) SetStageArn(v string) *ListStageSessionsInput

SetStageArn sets the StageArn field's value.

func (ListStageSessionsInput) String

func (s ListStageSessionsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListStageSessionsInput) Validate

func (s *ListStageSessionsInput) Validate() error

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

type ListStageSessionsOutput

type ListStageSessionsOutput struct {

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

    // List of matching stage sessions.
    //
    // StageSessions is a required field
    StageSessions []*StageSessionSummary `locationName:"stageSessions" type:"list" required:"true"`
    // contains filtered or unexported fields
}

func (ListStageSessionsOutput) GoString

func (s ListStageSessionsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListStageSessionsOutput) SetNextToken

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

SetNextToken sets the NextToken field's value.

func (*ListStageSessionsOutput) SetStageSessions

func (s *ListStageSessionsOutput) SetStageSessions(v []*StageSessionSummary) *ListStageSessionsOutput

SetStageSessions sets the StageSessions field's value.

func (ListStageSessionsOutput) String

func (s ListStageSessionsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListStagesInput

type ListStagesInput struct {

    // Maximum number of results to return. Default: 50.
    MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"`

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

func (ListStagesInput) GoString

func (s ListStagesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListStagesInput) SetMaxResults

func (s *ListStagesInput) SetMaxResults(v int64) *ListStagesInput

SetMaxResults sets the MaxResults field's value.

func (*ListStagesInput) SetNextToken

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

SetNextToken sets the NextToken field's value.

func (ListStagesInput) String

func (s ListStagesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListStagesInput) Validate

func (s *ListStagesInput) Validate() error

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

type ListStagesOutput

type ListStagesOutput struct {

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

    // List of the matching stages (summary information only).
    //
    // Stages is a required field
    Stages []*StageSummary `locationName:"stages" type:"list" required:"true"`
    // contains filtered or unexported fields
}

func (ListStagesOutput) GoString

func (s ListStagesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListStagesOutput) SetNextToken

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

SetNextToken sets the NextToken field's value.

func (*ListStagesOutput) SetStages

func (s *ListStagesOutput) SetStages(v []*StageSummary) *ListStagesOutput

SetStages sets the Stages field's value.

func (ListStagesOutput) String

func (s ListStagesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListStorageConfigurationsInput

type ListStorageConfigurationsInput struct {

    // Maximum number of storage configurations to return. Default: your service
    // quota or 100, whichever is smaller.
    MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"`

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

func (ListStorageConfigurationsInput) GoString

func (s ListStorageConfigurationsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListStorageConfigurationsInput) SetMaxResults

func (s *ListStorageConfigurationsInput) SetMaxResults(v int64) *ListStorageConfigurationsInput

SetMaxResults sets the MaxResults field's value.

func (*ListStorageConfigurationsInput) SetNextToken

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

SetNextToken sets the NextToken field's value.

func (ListStorageConfigurationsInput) String

func (s ListStorageConfigurationsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListStorageConfigurationsInput) Validate

func (s *ListStorageConfigurationsInput) Validate() error

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

type ListStorageConfigurationsOutput

type ListStorageConfigurationsOutput struct {

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

    // List of the matching storage configurations.
    //
    // StorageConfigurations is a required field
    StorageConfigurations []*StorageConfigurationSummary `locationName:"storageConfigurations" type:"list" required:"true"`
    // contains filtered or unexported fields
}

func (ListStorageConfigurationsOutput) GoString

func (s ListStorageConfigurationsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListStorageConfigurationsOutput) SetNextToken

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

SetNextToken sets the NextToken field's value.

func (*ListStorageConfigurationsOutput) SetStorageConfigurations

func (s *ListStorageConfigurationsOutput) SetStorageConfigurations(v []*StorageConfigurationSummary) *ListStorageConfigurationsOutput

SetStorageConfigurations sets the StorageConfigurations field's value.

func (ListStorageConfigurationsOutput) String

func (s ListStorageConfigurationsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListTagsForResourceInput

type ListTagsForResourceInput struct {

    // The ARN of the resource to be retrieved. The ARN must be URL-encoded.
    //
    // ResourceArn is a required field
    ResourceArn *string `location:"uri" locationName:"resourceArn" min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (ListTagsForResourceInput) GoString

func (s ListTagsForResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) SetResourceArn

func (s *ListTagsForResourceInput) SetResourceArn(v string) *ListTagsForResourceInput

SetResourceArn sets the ResourceArn field's value.

func (ListTagsForResourceInput) String

func (s ListTagsForResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) Validate

func (s *ListTagsForResourceInput) Validate() error

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

type ListTagsForResourceOutput

type ListTagsForResourceOutput struct {

    // Tags attached to the resource. Array of maps, each of the form string:string
    // (key:value).
    //
    // Tags is a required field
    Tags map[string]*string `locationName:"tags" type:"map" required:"true"`
    // contains filtered or unexported fields
}

func (ListTagsForResourceOutput) GoString

func (s ListTagsForResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceOutput) SetTags

func (s *ListTagsForResourceOutput) SetTags(v map[string]*string) *ListTagsForResourceOutput

SetTags sets the Tags field's value.

func (ListTagsForResourceOutput) String

func (s ListTagsForResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Participant

type Participant struct {

    // 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 `locationName:"attributes" type:"map"`

    // The participant’s browser.
    BrowserName *string `locationName:"browserName" type:"string"`

    // The participant’s browser version.
    BrowserVersion *string `locationName:"browserVersion" type:"string"`

    // ISO 8601 timestamp (returned as a string) when the participant first joined
    // the stage session.
    FirstJoinTime *time.Time `locationName:"firstJoinTime" type:"timestamp" timestampFormat:"iso8601"`

    // The participant’s Internet Service Provider.
    IspName *string `locationName:"ispName" type:"string"`

    // The participant’s operating system.
    OsName *string `locationName:"osName" type:"string"`

    // The participant’s operating system version.
    OsVersion *string `locationName:"osVersion" type:"string"`

    // Unique identifier for this participant, assigned by IVS.
    ParticipantId *string `locationName:"participantId" type:"string"`

    // Whether the participant ever published to the stage session.
    Published *bool `locationName:"published" type:"boolean"`

    // The participant’s SDK version.
    SdkVersion *string `locationName:"sdkVersion" type:"string"`

    // Whether the participant is connected to or disconnected from the stage.
    State *string `locationName:"state" type:"string" enum:"ParticipantState"`

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

Object describing a participant that has joined a stage.

func (Participant) GoString

func (s Participant) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Participant) SetAttributes

func (s *Participant) SetAttributes(v map[string]*string) *Participant

SetAttributes sets the Attributes field's value.

func (*Participant) SetBrowserName

func (s *Participant) SetBrowserName(v string) *Participant

SetBrowserName sets the BrowserName field's value.

func (*Participant) SetBrowserVersion

func (s *Participant) SetBrowserVersion(v string) *Participant

SetBrowserVersion sets the BrowserVersion field's value.

func (*Participant) SetFirstJoinTime

func (s *Participant) SetFirstJoinTime(v time.Time) *Participant

SetFirstJoinTime sets the FirstJoinTime field's value.

func (*Participant) SetIspName

func (s *Participant) SetIspName(v string) *Participant

SetIspName sets the IspName field's value.

func (*Participant) SetOsName

func (s *Participant) SetOsName(v string) *Participant

SetOsName sets the OsName field's value.

func (*Participant) SetOsVersion

func (s *Participant) SetOsVersion(v string) *Participant

SetOsVersion sets the OsVersion field's value.

func (*Participant) SetParticipantId

func (s *Participant) SetParticipantId(v string) *Participant

SetParticipantId sets the ParticipantId field's value.

func (*Participant) SetPublished

func (s *Participant) SetPublished(v bool) *Participant

SetPublished sets the Published field's value.

func (*Participant) SetSdkVersion

func (s *Participant) SetSdkVersion(v string) *Participant

SetSdkVersion sets the SdkVersion field's value.

func (*Participant) SetState

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

SetState sets the State field's value.

func (*Participant) SetUserId

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

SetUserId sets the UserId field's value.

func (Participant) String

func (s Participant) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ParticipantSummary

type ParticipantSummary struct {

    // ISO 8601 timestamp (returned as a string) when the participant first joined
    // the stage session.
    FirstJoinTime *time.Time `locationName:"firstJoinTime" type:"timestamp" timestampFormat:"iso8601"`

    // Unique identifier for this participant, assigned by IVS.
    ParticipantId *string `locationName:"participantId" type:"string"`

    // Whether the participant ever published to the stage session.
    Published *bool `locationName:"published" type:"boolean"`

    // Whether the participant is connected to or disconnected from the stage.
    State *string `locationName:"state" type:"string" enum:"ParticipantState"`

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

Summary object describing a participant that has joined a stage.

func (ParticipantSummary) GoString

func (s ParticipantSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ParticipantSummary) SetFirstJoinTime

func (s *ParticipantSummary) SetFirstJoinTime(v time.Time) *ParticipantSummary

SetFirstJoinTime sets the FirstJoinTime field's value.

func (*ParticipantSummary) SetParticipantId

func (s *ParticipantSummary) SetParticipantId(v string) *ParticipantSummary

SetParticipantId sets the ParticipantId field's value.

func (*ParticipantSummary) SetPublished

func (s *ParticipantSummary) SetPublished(v bool) *ParticipantSummary

SetPublished sets the Published field's value.

func (*ParticipantSummary) SetState

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

SetState sets the State field's value.

func (*ParticipantSummary) SetUserId

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

SetUserId sets the UserId field's value.

func (ParticipantSummary) String

func (s ParticipantSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ParticipantToken

type ParticipantToken struct {

    // Application-provided attributes to encode into the token and attach to a
    // stage. This field is exposed to all stage participants and should not be
    // used for personally identifying, confidential, or sensitive information.
    Attributes map[string]*string `locationName:"attributes" type:"map"`

    // Set of capabilities that the user is allowed to perform in the stage.
    Capabilities []*string `locationName:"capabilities" type:"list" enum:"ParticipantTokenCapability"`

    // Duration (in minutes), after which the participant token expires. Default:
    // 720 (12 hours).
    Duration *int64 `locationName:"duration" min:"1" type:"integer"`

    // ISO 8601 timestamp (returned as a string) for when this token expires.
    ExpirationTime *time.Time `locationName:"expirationTime" type:"timestamp" timestampFormat:"iso8601"`

    // Unique identifier for this participant token, assigned by IVS.
    ParticipantId *string `locationName:"participantId" type:"string"`

    // The issued client token, encrypted.
    //
    // Token is a sensitive parameter and its value will be
    // replaced with "sensitive" in string returned by ParticipantToken's
    // String and GoString methods.
    Token *string `locationName:"token" type:"string" sensitive:"true"`

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

Object specifying a participant token in a stage.

Important: Treat tokens as opaque; i.e., do not build functionality based on token contents. The format of tokens could change in the future.

func (ParticipantToken) GoString

func (s ParticipantToken) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ParticipantToken) SetAttributes

func (s *ParticipantToken) SetAttributes(v map[string]*string) *ParticipantToken

SetAttributes sets the Attributes field's value.

func (*ParticipantToken) SetCapabilities

func (s *ParticipantToken) SetCapabilities(v []*string) *ParticipantToken

SetCapabilities sets the Capabilities field's value.

func (*ParticipantToken) SetDuration

func (s *ParticipantToken) SetDuration(v int64) *ParticipantToken

SetDuration sets the Duration field's value.

func (*ParticipantToken) SetExpirationTime

func (s *ParticipantToken) SetExpirationTime(v time.Time) *ParticipantToken

SetExpirationTime sets the ExpirationTime field's value.

func (*ParticipantToken) SetParticipantId

func (s *ParticipantToken) SetParticipantId(v string) *ParticipantToken

SetParticipantId sets the ParticipantId field's value.

func (*ParticipantToken) SetToken

func (s *ParticipantToken) SetToken(v string) *ParticipantToken

SetToken sets the Token field's value.

func (*ParticipantToken) SetUserId

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

SetUserId sets the UserId field's value.

func (ParticipantToken) String

func (s ParticipantToken) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ParticipantTokenConfiguration

type ParticipantTokenConfiguration struct {

    // Application-provided attributes to encode into the corresponding participant
    // 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 `locationName:"attributes" type:"map"`

    // Set of capabilities that the user is allowed to perform in the stage.
    Capabilities []*string `locationName:"capabilities" type:"list" enum:"ParticipantTokenCapability"`

    // Duration (in minutes), after which the corresponding participant token expires.
    // Default: 720 (12 hours).
    Duration *int64 `locationName:"duration" min:"1" type:"integer"`

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

Object specifying a participant token configuration in a stage.

func (ParticipantTokenConfiguration) GoString

func (s ParticipantTokenConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ParticipantTokenConfiguration) SetAttributes

func (s *ParticipantTokenConfiguration) SetAttributes(v map[string]*string) *ParticipantTokenConfiguration

SetAttributes sets the Attributes field's value.

func (*ParticipantTokenConfiguration) SetCapabilities

func (s *ParticipantTokenConfiguration) SetCapabilities(v []*string) *ParticipantTokenConfiguration

SetCapabilities sets the Capabilities field's value.

func (*ParticipantTokenConfiguration) SetDuration

func (s *ParticipantTokenConfiguration) SetDuration(v int64) *ParticipantTokenConfiguration

SetDuration sets the Duration field's value.

func (*ParticipantTokenConfiguration) SetUserId

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

SetUserId sets the UserId field's value.

func (ParticipantTokenConfiguration) String

func (s ParticipantTokenConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ParticipantTokenConfiguration) Validate

func (s *ParticipantTokenConfiguration) Validate() error

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

type PendingVerification

type PendingVerification struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    // Your account is pending verification.
    ExceptionMessage *string `locationName:"exceptionMessage" type:"string"`

    Message_ *string `locationName:"message" type:"string"`
    // contains filtered or unexported fields
}

func (*PendingVerification) Code

func (s *PendingVerification) Code() string

Code returns the exception type name.

func (*PendingVerification) Error

func (s *PendingVerification) Error() string

func (PendingVerification) GoString

func (s PendingVerification) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PendingVerification) Message

func (s *PendingVerification) Message() string

Message returns the exception's message.

func (*PendingVerification) OrigErr

func (s *PendingVerification) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*PendingVerification) RequestID

func (s *PendingVerification) RequestID() string

RequestID returns the service's response RequestID for request.

func (*PendingVerification) StatusCode

func (s *PendingVerification) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (PendingVerification) String

func (s PendingVerification) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PipConfiguration

type PipConfiguration struct {

    // This attribute name identifies the featured slot. A participant with this
    // attribute set to "true" (as a string value) in ParticipantTokenConfiguration
    // is placed in the featured slot.
    FeaturedParticipantAttribute *string `locationName:"featuredParticipantAttribute" type:"string"`

    // Specifies the spacing between participant tiles in pixels. Default: 0.
    GridGap *int64 `locationName:"gridGap" type:"integer"`

    // Determines whether to omit participants with stopped video in the composition.
    // Default: false.
    OmitStoppedVideo *bool `locationName:"omitStoppedVideo" type:"boolean"`

    // Defines PiP behavior when all participants have left. Default: STATIC.
    PipBehavior *string `locationName:"pipBehavior" type:"string" enum:"PipBehavior"`

    // Specifies the height of the PiP window in pixels. When this is not set explicitly,
    // pipHeight’s value will be based on the size of the composition and the
    // aspect ratio of the participant’s video.
    PipHeight *int64 `locationName:"pipHeight" min:"1" type:"integer"`

    // Sets the PiP window’s offset position in pixels from the closest edges
    // determined by PipPosition. Default: 0.
    PipOffset *int64 `locationName:"pipOffset" type:"integer"`

    // Identifies the PiP slot. A participant with this attribute set to "true"
    // (as a string value) in ParticipantTokenConfiguration is placed in the PiP
    // slot.
    PipParticipantAttribute *string `locationName:"pipParticipantAttribute" type:"string"`

    // Determines the corner position of the PiP window. Default: BOTTOM_RIGHT.
    PipPosition *string `locationName:"pipPosition" type:"string" enum:"PipPosition"`

    // Specifies the width of the PiP window in pixels. When this is not set explicitly,
    // pipWidth’s value will be based on the size of the composition and the aspect
    // ratio of the participant’s video.
    PipWidth *int64 `locationName:"pipWidth" min:"1" type:"integer"`

    // Defines how video fits within the participant tile. Default: COVER.
    VideoFillMode *string `locationName:"videoFillMode" type:"string" enum:"VideoFillMode"`
    // contains filtered or unexported fields
}

Configuration information specific to Picture-in-Picture (PiP) layout, for server-side composition (https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/server-side-composition.html).

func (PipConfiguration) GoString

func (s PipConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PipConfiguration) SetFeaturedParticipantAttribute

func (s *PipConfiguration) SetFeaturedParticipantAttribute(v string) *PipConfiguration

SetFeaturedParticipantAttribute sets the FeaturedParticipantAttribute field's value.

func (*PipConfiguration) SetGridGap

func (s *PipConfiguration) SetGridGap(v int64) *PipConfiguration

SetGridGap sets the GridGap field's value.

func (*PipConfiguration) SetOmitStoppedVideo

func (s *PipConfiguration) SetOmitStoppedVideo(v bool) *PipConfiguration

SetOmitStoppedVideo sets the OmitStoppedVideo field's value.

func (*PipConfiguration) SetPipBehavior

func (s *PipConfiguration) SetPipBehavior(v string) *PipConfiguration

SetPipBehavior sets the PipBehavior field's value.

func (*PipConfiguration) SetPipHeight

func (s *PipConfiguration) SetPipHeight(v int64) *PipConfiguration

SetPipHeight sets the PipHeight field's value.

func (*PipConfiguration) SetPipOffset

func (s *PipConfiguration) SetPipOffset(v int64) *PipConfiguration

SetPipOffset sets the PipOffset field's value.

func (*PipConfiguration) SetPipParticipantAttribute

func (s *PipConfiguration) SetPipParticipantAttribute(v string) *PipConfiguration

SetPipParticipantAttribute sets the PipParticipantAttribute field's value.

func (*PipConfiguration) SetPipPosition

func (s *PipConfiguration) SetPipPosition(v string) *PipConfiguration

SetPipPosition sets the PipPosition field's value.

func (*PipConfiguration) SetPipWidth

func (s *PipConfiguration) SetPipWidth(v int64) *PipConfiguration

SetPipWidth sets the PipWidth field's value.

func (*PipConfiguration) SetVideoFillMode

func (s *PipConfiguration) SetVideoFillMode(v string) *PipConfiguration

SetVideoFillMode sets the VideoFillMode field's value.

func (PipConfiguration) String

func (s PipConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PipConfiguration) Validate

func (s *PipConfiguration) Validate() error

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

type RecordingConfiguration

type RecordingConfiguration struct {

    // The recording format for storing a recording in Amazon S3.
    Format *string `locationName:"format" type:"string" enum:"RecordingConfigurationFormat"`
    // contains filtered or unexported fields
}

An object representing a configuration to record a stage stream.

func (RecordingConfiguration) GoString

func (s RecordingConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RecordingConfiguration) SetFormat

func (s *RecordingConfiguration) SetFormat(v string) *RecordingConfiguration

SetFormat sets the Format field's value.

func (RecordingConfiguration) String

func (s RecordingConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResourceNotFoundException

type ResourceNotFoundException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    // Request references a resource which does not exist.
    ExceptionMessage *string `locationName:"exceptionMessage" type:"string"`

    Message_ *string `locationName:"message" type:"string"`
    // contains filtered or unexported fields
}

func (*ResourceNotFoundException) Code

func (s *ResourceNotFoundException) Code() string

Code returns the exception type name.

func (*ResourceNotFoundException) Error

func (s *ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString

func (s ResourceNotFoundException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceNotFoundException) Message

func (s *ResourceNotFoundException) Message() string

Message returns the exception's message.

func (*ResourceNotFoundException) OrigErr

func (s *ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFoundException) RequestID

func (s *ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFoundException) StatusCode

func (s *ResourceNotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceNotFoundException) String

func (s ResourceNotFoundException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type S3DestinationConfiguration

type S3DestinationConfiguration struct {

    // ARNs of the EncoderConfiguration resource. The encoder configuration and
    // stage resources must be in the same AWS account and region.
    //
    // EncoderConfigurationArns is a required field
    EncoderConfigurationArns []*string `locationName:"encoderConfigurationArns" min:"1" type:"list" required:"true"`

    // Array of maps, each of the form string:string (key:value). This is an optional
    // customer specification, currently used only to specify the recording format
    // for storing a recording in Amazon S3.
    RecordingConfiguration *RecordingConfiguration `locationName:"recordingConfiguration" type:"structure"`

    // ARN of the StorageConfiguration where recorded videos will be stored.
    //
    // StorageConfigurationArn is a required field
    StorageConfigurationArn *string `locationName:"storageConfigurationArn" min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

A complex type that describes an S3 location where recorded videos will be stored.

func (S3DestinationConfiguration) GoString

func (s S3DestinationConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*S3DestinationConfiguration) SetEncoderConfigurationArns

func (s *S3DestinationConfiguration) SetEncoderConfigurationArns(v []*string) *S3DestinationConfiguration

SetEncoderConfigurationArns sets the EncoderConfigurationArns field's value.

func (*S3DestinationConfiguration) SetRecordingConfiguration

func (s *S3DestinationConfiguration) SetRecordingConfiguration(v *RecordingConfiguration) *S3DestinationConfiguration

SetRecordingConfiguration sets the RecordingConfiguration field's value.

func (*S3DestinationConfiguration) SetStorageConfigurationArn

func (s *S3DestinationConfiguration) SetStorageConfigurationArn(v string) *S3DestinationConfiguration

SetStorageConfigurationArn sets the StorageConfigurationArn field's value.

func (S3DestinationConfiguration) String

func (s S3DestinationConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*S3DestinationConfiguration) Validate

func (s *S3DestinationConfiguration) Validate() error

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

type S3Detail

type S3Detail struct {

    // The S3 bucket prefix under which the recording is stored.
    //
    // RecordingPrefix is a required field
    RecordingPrefix *string `locationName:"recordingPrefix" type:"string" required:"true"`
    // contains filtered or unexported fields
}

Complex data type that defines S3Detail objects.

func (S3Detail) GoString

func (s S3Detail) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*S3Detail) SetRecordingPrefix

func (s *S3Detail) SetRecordingPrefix(v string) *S3Detail

SetRecordingPrefix sets the RecordingPrefix field's value.

func (S3Detail) String

func (s S3Detail) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type S3StorageConfiguration

type S3StorageConfiguration struct {

    // Location (S3 bucket name) where recorded videos will be stored. Note that
    // the StorageConfiguration and S3 bucket must be in the same region as the
    // Composition.
    //
    // BucketName is a required field
    BucketName *string `locationName:"bucketName" min:"3" type:"string" required:"true"`
    // contains filtered or unexported fields
}

A complex type that describes an S3 location where recorded videos will be stored.

func (S3StorageConfiguration) GoString

func (s S3StorageConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*S3StorageConfiguration) SetBucketName

func (s *S3StorageConfiguration) SetBucketName(v string) *S3StorageConfiguration

SetBucketName sets the BucketName field's value.

func (S3StorageConfiguration) String

func (s S3StorageConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*S3StorageConfiguration) Validate

func (s *S3StorageConfiguration) Validate() error

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

type ServiceQuotaExceededException

type ServiceQuotaExceededException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    // Request would cause a service quota to be exceeded.
    ExceptionMessage *string `locationName:"exceptionMessage" type:"string"`

    Message_ *string `locationName:"message" type:"string"`
    // contains filtered or unexported fields
}

func (*ServiceQuotaExceededException) Code

func (s *ServiceQuotaExceededException) Code() string

Code returns the exception type name.

func (*ServiceQuotaExceededException) Error

func (s *ServiceQuotaExceededException) Error() string

func (ServiceQuotaExceededException) GoString

func (s ServiceQuotaExceededException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ServiceQuotaExceededException) Message

func (s *ServiceQuotaExceededException) Message() string

Message returns the exception's message.

func (*ServiceQuotaExceededException) OrigErr

func (s *ServiceQuotaExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ServiceQuotaExceededException) RequestID

func (s *ServiceQuotaExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ServiceQuotaExceededException) StatusCode

func (s *ServiceQuotaExceededException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ServiceQuotaExceededException) String

func (s ServiceQuotaExceededException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Stage

type Stage struct {

    // ID of the active session within the stage.
    ActiveSessionId *string `locationName:"activeSessionId" min:"16" type:"string"`

    // Stage ARN.
    //
    // Arn is a required field
    Arn *string `locationName:"arn" min:"1" type:"string" required:"true"`

    // Stage name.
    Name *string `locationName:"name" type:"string"`

    // Tags attached to the resource. Array of maps, each of the form string:string
    // (key:value). See Tagging AWS Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html)
    // 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.
    Tags map[string]*string `locationName:"tags" type:"map"`
    // contains filtered or unexported fields
}

Object specifying a stage.

func (Stage) GoString

func (s Stage) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Stage) SetActiveSessionId

func (s *Stage) SetActiveSessionId(v string) *Stage

SetActiveSessionId sets the ActiveSessionId field's value.

func (*Stage) SetArn

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

SetArn sets the Arn field's value.

func (*Stage) SetName

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

SetName sets the Name field's value.

func (*Stage) SetTags

func (s *Stage) SetTags(v map[string]*string) *Stage

SetTags sets the Tags field's value.

func (Stage) String

func (s Stage) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StageSession

type StageSession struct {

    // ISO 8601 timestamp (returned as a string) when the stage session ended. This
    // is null if the stage is active.
    EndTime *time.Time `locationName:"endTime" type:"timestamp" timestampFormat:"iso8601"`

    // ID of the session within the stage.
    SessionId *string `locationName:"sessionId" min:"16" type:"string"`

    // ISO 8601 timestamp (returned as a string) when this stage session began.
    StartTime *time.Time `locationName:"startTime" type:"timestamp" timestampFormat:"iso8601"`
    // contains filtered or unexported fields
}

A stage session begins when the first participant joins a stage and ends after the last participant leaves the stage. A stage session helps with debugging stages by grouping events and participants into shorter periods of time (i.e., a session), which is helpful when stages are used over long periods of time.

func (StageSession) GoString

func (s StageSession) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StageSession) SetEndTime

func (s *StageSession) SetEndTime(v time.Time) *StageSession

SetEndTime sets the EndTime field's value.

func (*StageSession) SetSessionId

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

SetSessionId sets the SessionId field's value.

func (*StageSession) SetStartTime

func (s *StageSession) SetStartTime(v time.Time) *StageSession

SetStartTime sets the StartTime field's value.

func (StageSession) String

func (s StageSession) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StageSessionSummary

type StageSessionSummary struct {

    // ISO 8601 timestamp (returned as a string) when the stage session ended. This
    // is null if the stage is active.
    EndTime *time.Time `locationName:"endTime" type:"timestamp" timestampFormat:"iso8601"`

    // ID of the session within the stage.
    SessionId *string `locationName:"sessionId" min:"16" type:"string"`

    // ISO 8601 timestamp (returned as a string) when this stage session began.
    StartTime *time.Time `locationName:"startTime" type:"timestamp" timestampFormat:"iso8601"`
    // contains filtered or unexported fields
}

Summary information about a stage session.

func (StageSessionSummary) GoString

func (s StageSessionSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StageSessionSummary) SetEndTime

func (s *StageSessionSummary) SetEndTime(v time.Time) *StageSessionSummary

SetEndTime sets the EndTime field's value.

func (*StageSessionSummary) SetSessionId

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

SetSessionId sets the SessionId field's value.

func (*StageSessionSummary) SetStartTime

func (s *StageSessionSummary) SetStartTime(v time.Time) *StageSessionSummary

SetStartTime sets the StartTime field's value.

func (StageSessionSummary) String

func (s StageSessionSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StageSummary

type StageSummary struct {

    // ID of the active session within the stage.
    ActiveSessionId *string `locationName:"activeSessionId" min:"16" type:"string"`

    // Stage ARN.
    //
    // Arn is a required field
    Arn *string `locationName:"arn" min:"1" type:"string" required:"true"`

    // Stage name.
    Name *string `locationName:"name" type:"string"`

    // Tags attached to the resource. Array of maps, each of the form string:string
    // (key:value). See Tagging AWS Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html)
    // 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.
    Tags map[string]*string `locationName:"tags" type:"map"`
    // contains filtered or unexported fields
}

Summary information about a stage.

func (StageSummary) GoString

func (s StageSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StageSummary) SetActiveSessionId

func (s *StageSummary) SetActiveSessionId(v string) *StageSummary

SetActiveSessionId sets the ActiveSessionId field's value.

func (*StageSummary) SetArn

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

SetArn sets the Arn field's value.

func (*StageSummary) SetName

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

SetName sets the Name field's value.

func (*StageSummary) SetTags

func (s *StageSummary) SetTags(v map[string]*string) *StageSummary

SetTags sets the Tags field's value.

func (StageSummary) String

func (s StageSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StartCompositionInput

type StartCompositionInput struct {

    // Array of destination configuration.
    //
    // Destinations is a required field
    Destinations []*DestinationConfiguration `locationName:"destinations" min:"1" type:"list" required:"true"`

    // Idempotency token.
    IdempotencyToken *string `locationName:"idempotencyToken" min:"1" type:"string" idempotencyToken:"true"`

    // Layout object to configure composition parameters.
    Layout *LayoutConfiguration `locationName:"layout" type:"structure"`

    // ARN of the stage to be used for compositing.
    //
    // StageArn is a required field
    StageArn *string `locationName:"stageArn" min:"1" type:"string" required:"true"`

    // Tags attached to the resource. Array of maps, each of the form string:string
    // (key:value). See Tagging AWS Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html)
    // 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.
    Tags map[string]*string `locationName:"tags" type:"map"`
    // contains filtered or unexported fields
}

func (StartCompositionInput) GoString

func (s StartCompositionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartCompositionInput) SetDestinations

func (s *StartCompositionInput) SetDestinations(v []*DestinationConfiguration) *StartCompositionInput

SetDestinations sets the Destinations field's value.

func (*StartCompositionInput) SetIdempotencyToken

func (s *StartCompositionInput) SetIdempotencyToken(v string) *StartCompositionInput

SetIdempotencyToken sets the IdempotencyToken field's value.

func (*StartCompositionInput) SetLayout

func (s *StartCompositionInput) SetLayout(v *LayoutConfiguration) *StartCompositionInput

SetLayout sets the Layout field's value.

func (*StartCompositionInput) SetStageArn

func (s *StartCompositionInput) SetStageArn(v string) *StartCompositionInput

SetStageArn sets the StageArn field's value.

func (*StartCompositionInput) SetTags

func (s *StartCompositionInput) SetTags(v map[string]*string) *StartCompositionInput

SetTags sets the Tags field's value.

func (StartCompositionInput) String

func (s StartCompositionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartCompositionInput) Validate

func (s *StartCompositionInput) Validate() error

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

type StartCompositionOutput

type StartCompositionOutput struct {

    // The Composition that was created.
    Composition *Composition `locationName:"composition" type:"structure"`
    // contains filtered or unexported fields
}

func (StartCompositionOutput) GoString

func (s StartCompositionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartCompositionOutput) SetComposition

func (s *StartCompositionOutput) SetComposition(v *Composition) *StartCompositionOutput

SetComposition sets the Composition field's value.

func (StartCompositionOutput) String

func (s StartCompositionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StopCompositionInput

type StopCompositionInput struct {

    // ARN of the Composition.
    //
    // Arn is a required field
    Arn *string `locationName:"arn" min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (StopCompositionInput) GoString

func (s StopCompositionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StopCompositionInput) SetArn

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

SetArn sets the Arn field's value.

func (StopCompositionInput) String

func (s StopCompositionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StopCompositionInput) Validate

func (s *StopCompositionInput) Validate() error

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

type StopCompositionOutput

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

func (StopCompositionOutput) GoString

func (s StopCompositionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (StopCompositionOutput) String

func (s StopCompositionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StorageConfiguration

type StorageConfiguration struct {

    // ARN of the storage configuration.
    //
    // Arn is a required field
    Arn *string `locationName:"arn" min:"1" type:"string" required:"true"`

    // Name of the storage configuration.
    Name *string `locationName:"name" type:"string"`

    // An S3 destination configuration where recorded videos will be stored.
    S3 *S3StorageConfiguration `locationName:"s3" type:"structure"`

    // Tags attached to the resource. Array of maps, each of the form string:string
    // (key:value). See Tagging AWS Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html)
    // 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.
    Tags map[string]*string `locationName:"tags" type:"map"`
    // contains filtered or unexported fields
}

A complex type that describes a location where recorded videos will be stored.

func (StorageConfiguration) GoString

func (s StorageConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StorageConfiguration) SetArn

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

SetArn sets the Arn field's value.

func (*StorageConfiguration) SetName

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

SetName sets the Name field's value.

func (*StorageConfiguration) SetS3

func (s *StorageConfiguration) SetS3(v *S3StorageConfiguration) *StorageConfiguration

SetS3 sets the S3 field's value.

func (*StorageConfiguration) SetTags

func (s *StorageConfiguration) SetTags(v map[string]*string) *StorageConfiguration

SetTags sets the Tags field's value.

func (StorageConfiguration) String

func (s StorageConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StorageConfigurationSummary

type StorageConfigurationSummary struct {

    // ARN of the storage configuration.
    //
    // Arn is a required field
    Arn *string `locationName:"arn" min:"1" type:"string" required:"true"`

    // Name of the storage configuration.
    Name *string `locationName:"name" type:"string"`

    // An S3 destination configuration where recorded videos will be stored.
    S3 *S3StorageConfiguration `locationName:"s3" type:"structure"`

    // Tags attached to the resource. Array of maps, each of the form string:string
    // (key:value). See Tagging AWS Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html)
    // 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.
    Tags map[string]*string `locationName:"tags" type:"map"`
    // contains filtered or unexported fields
}

Summary information about a storage configuration.

func (StorageConfigurationSummary) GoString

func (s StorageConfigurationSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StorageConfigurationSummary) SetArn

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

SetArn sets the Arn field's value.

func (*StorageConfigurationSummary) SetName

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

SetName sets the Name field's value.

func (*StorageConfigurationSummary) SetS3

func (s *StorageConfigurationSummary) SetS3(v *S3StorageConfiguration) *StorageConfigurationSummary

SetS3 sets the S3 field's value.

func (*StorageConfigurationSummary) SetTags

func (s *StorageConfigurationSummary) SetTags(v map[string]*string) *StorageConfigurationSummary

SetTags sets the Tags field's value.

func (StorageConfigurationSummary) String

func (s StorageConfigurationSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TagResourceInput

type TagResourceInput struct {

    // The ARN of the resource to be tagged. The ARN must be URL-encoded.
    //
    // ResourceArn is a required field
    ResourceArn *string `location:"uri" locationName:"resourceArn" min:"1" type:"string" required:"true"`

    // Array of tags to be added or updated. Array of maps, each of the form string:string
    // (key:value). See Tagging AWS Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html)
    // for details, including restrictions that apply to tags and "Tag naming limits
    // and requirements"; Amazon IVS has no constraints beyond what is documented
    // there.
    //
    // Tags is a required field
    Tags map[string]*string `locationName:"tags" type:"map" required:"true"`
    // contains filtered or unexported fields
}

func (TagResourceInput) GoString

func (s TagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) SetResourceArn

func (s *TagResourceInput) SetResourceArn(v string) *TagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*TagResourceInput) SetTags

func (s *TagResourceInput) SetTags(v map[string]*string) *TagResourceInput

SetTags sets the Tags field's value.

func (TagResourceInput) String

func (s TagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) Validate

func (s *TagResourceInput) Validate() error

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

type TagResourceOutput

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

func (TagResourceOutput) GoString

func (s TagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (TagResourceOutput) String

func (s TagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UntagResourceInput

type UntagResourceInput struct {

    // The ARN of the resource to be untagged. The ARN must be URL-encoded.
    //
    // ResourceArn is a required field
    ResourceArn *string `location:"uri" locationName:"resourceArn" min:"1" type:"string" required:"true"`

    // Array of tags to be removed. Array of maps, each of the form string:string
    // (key:value). See Tagging AWS Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html)
    // for details, including restrictions that apply to tags and "Tag naming limits
    // and requirements"; Amazon IVS has no constraints beyond what is documented
    // there.
    //
    // TagKeys is a required field
    TagKeys []*string `location:"querystring" locationName:"tagKeys" type:"list" required:"true"`
    // contains filtered or unexported fields
}

func (UntagResourceInput) GoString

func (s UntagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceInput) SetResourceArn

func (s *UntagResourceInput) SetResourceArn(v string) *UntagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*UntagResourceInput) SetTagKeys

func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput

SetTagKeys sets the TagKeys field's value.

func (UntagResourceInput) String

func (s UntagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceInput) Validate

func (s *UntagResourceInput) Validate() error

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

type UntagResourceOutput

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

func (UntagResourceOutput) GoString

func (s UntagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UntagResourceOutput) String

func (s UntagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateStageInput

type UpdateStageInput struct {

    // ARN of the stage to be updated.
    //
    // Arn is a required field
    Arn *string `locationName:"arn" min:"1" type:"string" required:"true"`

    // Name of the stage to be updated.
    Name *string `locationName:"name" type:"string"`
    // contains filtered or unexported fields
}

func (UpdateStageInput) GoString

func (s UpdateStageInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateStageInput) SetArn

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

SetArn sets the Arn field's value.

func (*UpdateStageInput) SetName

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

SetName sets the Name field's value.

func (UpdateStageInput) String

func (s UpdateStageInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateStageInput) Validate

func (s *UpdateStageInput) Validate() error

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

type UpdateStageOutput

type UpdateStageOutput struct {

    // The updated stage.
    Stage *Stage `locationName:"stage" type:"structure"`
    // contains filtered or unexported fields
}

func (UpdateStageOutput) GoString

func (s UpdateStageOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateStageOutput) SetStage

func (s *UpdateStageOutput) SetStage(v *Stage) *UpdateStageOutput

SetStage sets the Stage field's value.

func (UpdateStageOutput) String

func (s UpdateStageOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ValidationException

type ValidationException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    // The input fails to satisfy the constraints specified by an Amazon Web Services
    // service.
    ExceptionMessage *string `locationName:"exceptionMessage" type:"string"`

    Message_ *string `locationName:"message" type:"string"`
    // contains filtered or unexported fields
}

func (*ValidationException) Code

func (s *ValidationException) Code() string

Code returns the exception type name.

func (*ValidationException) Error

func (s *ValidationException) Error() string

func (ValidationException) GoString

func (s ValidationException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ValidationException) Message

func (s *ValidationException) Message() string

Message returns the exception's message.

func (*ValidationException) OrigErr

func (s *ValidationException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ValidationException) RequestID

func (s *ValidationException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ValidationException) StatusCode

func (s *ValidationException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ValidationException) String

func (s ValidationException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Video

type Video struct {

    // Bitrate for generated output, in bps. Default: 2500000.
    Bitrate *int64 `locationName:"bitrate" min:"1" type:"integer"`

    // Video frame rate, in fps. Default: 30.
    Framerate *float64 `locationName:"framerate" min:"1" type:"float"`

    // Video-resolution height. Note that the maximum value is determined by width
    // times height, such that the maximum total pixels is 2073600 (1920x1080 or
    // 1080x1920). Default: 720.
    Height *int64 `locationName:"height" min:"1" type:"integer"`

    // Video-resolution width. Note that the maximum value is determined by width
    // times height, such that the maximum total pixels is 2073600 (1920x1080 or
    // 1080x1920). Default: 1280.
    Width *int64 `locationName:"width" min:"1" type:"integer"`
    // contains filtered or unexported fields
}

Settings for video.

func (Video) GoString

func (s Video) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Video) SetBitrate

func (s *Video) SetBitrate(v int64) *Video

SetBitrate sets the Bitrate field's value.

func (*Video) SetFramerate

func (s *Video) SetFramerate(v float64) *Video

SetFramerate sets the Framerate field's value.

func (*Video) SetHeight

func (s *Video) SetHeight(v int64) *Video

SetHeight sets the Height field's value.

func (*Video) SetWidth

func (s *Video) SetWidth(v int64) *Video

SetWidth sets the Width field's value.

func (Video) String

func (s Video) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Video) Validate

func (s *Video) Validate() error

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