Documentation
¶
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.
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.
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
Index ¶
- Constants
- func EventErrorCode_Values() []string
- func EventName_Values() []string
- func ParticipantState_Values() []string
- func ParticipantTokenCapability_Values() []string
- type AccessDeniedException
- func (s *AccessDeniedException) Code() string
- func (s *AccessDeniedException) Error() string
- func (s AccessDeniedException) GoString() string
- func (s *AccessDeniedException) Message() string
- func (s *AccessDeniedException) OrigErr() error
- func (s *AccessDeniedException) RequestID() string
- func (s *AccessDeniedException) StatusCode() int
- func (s AccessDeniedException) String() string
- type ConflictException
- func (s *ConflictException) Code() string
- func (s *ConflictException) Error() string
- func (s ConflictException) GoString() string
- func (s *ConflictException) Message() string
- func (s *ConflictException) OrigErr() error
- func (s *ConflictException) RequestID() string
- func (s *ConflictException) StatusCode() int
- func (s ConflictException) String() string
- type CreateParticipantTokenInput
- func (s CreateParticipantTokenInput) GoString() string
- func (s *CreateParticipantTokenInput) SetAttributes(v map[string]*string) *CreateParticipantTokenInput
- func (s *CreateParticipantTokenInput) SetCapabilities(v []*string) *CreateParticipantTokenInput
- func (s *CreateParticipantTokenInput) SetDuration(v int64) *CreateParticipantTokenInput
- func (s *CreateParticipantTokenInput) SetStageArn(v string) *CreateParticipantTokenInput
- func (s *CreateParticipantTokenInput) SetUserId(v string) *CreateParticipantTokenInput
- func (s CreateParticipantTokenInput) String() string
- func (s *CreateParticipantTokenInput) Validate() error
- type CreateParticipantTokenOutput
- type CreateStageInput
- func (s CreateStageInput) GoString() string
- func (s *CreateStageInput) SetName(v string) *CreateStageInput
- func (s *CreateStageInput) SetParticipantTokenConfigurations(v []*ParticipantTokenConfiguration) *CreateStageInput
- func (s *CreateStageInput) SetTags(v map[string]*string) *CreateStageInput
- func (s CreateStageInput) String() string
- func (s *CreateStageInput) Validate() error
- type CreateStageOutput
- type DeleteStageInput
- type DeleteStageOutput
- type DisconnectParticipantInput
- func (s DisconnectParticipantInput) GoString() string
- func (s *DisconnectParticipantInput) SetParticipantId(v string) *DisconnectParticipantInput
- func (s *DisconnectParticipantInput) SetReason(v string) *DisconnectParticipantInput
- func (s *DisconnectParticipantInput) SetStageArn(v string) *DisconnectParticipantInput
- func (s DisconnectParticipantInput) String() string
- func (s *DisconnectParticipantInput) Validate() error
- type DisconnectParticipantOutput
- type Event
- func (s Event) GoString() string
- func (s *Event) SetErrorCode(v string) *Event
- func (s *Event) SetEventTime(v time.Time) *Event
- func (s *Event) SetName(v string) *Event
- func (s *Event) SetParticipantId(v string) *Event
- func (s *Event) SetRemoteParticipantId(v string) *Event
- func (s Event) String() string
- type GetParticipantInput
- func (s GetParticipantInput) GoString() string
- func (s *GetParticipantInput) SetParticipantId(v string) *GetParticipantInput
- func (s *GetParticipantInput) SetSessionId(v string) *GetParticipantInput
- func (s *GetParticipantInput) SetStageArn(v string) *GetParticipantInput
- func (s GetParticipantInput) String() string
- func (s *GetParticipantInput) Validate() error
- type GetParticipantOutput
- type GetStageInput
- type GetStageOutput
- type GetStageSessionInput
- type GetStageSessionOutput
- type IVSRealTime
- 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) 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) 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) 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) ListParticipantEvents(input *ListParticipantEventsInput) (*ListParticipantEventsOutput, error)
- func (c *IVSRealTime) ListParticipantEventsPages(input *ListParticipantEventsInput, ...) error
- func (c *IVSRealTime) ListParticipantEventsPagesWithContext(ctx aws.Context, input *ListParticipantEventsInput, ...) 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, ...) 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, ...) 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, ...) 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) 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) 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)
- type InternalServerException
- func (s *InternalServerException) Code() string
- func (s *InternalServerException) Error() string
- func (s InternalServerException) GoString() string
- func (s *InternalServerException) Message() string
- func (s *InternalServerException) OrigErr() error
- func (s *InternalServerException) RequestID() string
- func (s *InternalServerException) StatusCode() int
- func (s InternalServerException) String() string
- type ListParticipantEventsInput
- func (s ListParticipantEventsInput) GoString() string
- func (s *ListParticipantEventsInput) SetMaxResults(v int64) *ListParticipantEventsInput
- func (s *ListParticipantEventsInput) SetNextToken(v string) *ListParticipantEventsInput
- func (s *ListParticipantEventsInput) SetParticipantId(v string) *ListParticipantEventsInput
- func (s *ListParticipantEventsInput) SetSessionId(v string) *ListParticipantEventsInput
- func (s *ListParticipantEventsInput) SetStageArn(v string) *ListParticipantEventsInput
- func (s ListParticipantEventsInput) String() string
- func (s *ListParticipantEventsInput) Validate() error
- type ListParticipantEventsOutput
- type ListParticipantsInput
- func (s ListParticipantsInput) GoString() string
- func (s *ListParticipantsInput) SetFilterByPublished(v bool) *ListParticipantsInput
- func (s *ListParticipantsInput) SetFilterByState(v string) *ListParticipantsInput
- func (s *ListParticipantsInput) SetFilterByUserId(v string) *ListParticipantsInput
- func (s *ListParticipantsInput) SetMaxResults(v int64) *ListParticipantsInput
- func (s *ListParticipantsInput) SetNextToken(v string) *ListParticipantsInput
- func (s *ListParticipantsInput) SetSessionId(v string) *ListParticipantsInput
- func (s *ListParticipantsInput) SetStageArn(v string) *ListParticipantsInput
- func (s ListParticipantsInput) String() string
- func (s *ListParticipantsInput) Validate() error
- type ListParticipantsOutput
- type ListStageSessionsInput
- func (s ListStageSessionsInput) GoString() string
- func (s *ListStageSessionsInput) SetMaxResults(v int64) *ListStageSessionsInput
- func (s *ListStageSessionsInput) SetNextToken(v string) *ListStageSessionsInput
- func (s *ListStageSessionsInput) SetStageArn(v string) *ListStageSessionsInput
- func (s ListStageSessionsInput) String() string
- func (s *ListStageSessionsInput) Validate() error
- type ListStageSessionsOutput
- type ListStagesInput
- type ListStagesOutput
- type ListTagsForResourceInput
- type ListTagsForResourceOutput
- type Participant
- func (s Participant) GoString() string
- func (s *Participant) SetAttributes(v map[string]*string) *Participant
- func (s *Participant) SetFirstJoinTime(v time.Time) *Participant
- func (s *Participant) SetParticipantId(v string) *Participant
- func (s *Participant) SetPublished(v bool) *Participant
- func (s *Participant) SetState(v string) *Participant
- func (s *Participant) SetUserId(v string) *Participant
- func (s Participant) String() string
- type ParticipantSummary
- func (s ParticipantSummary) GoString() string
- func (s *ParticipantSummary) SetFirstJoinTime(v time.Time) *ParticipantSummary
- func (s *ParticipantSummary) SetParticipantId(v string) *ParticipantSummary
- func (s *ParticipantSummary) SetPublished(v bool) *ParticipantSummary
- func (s *ParticipantSummary) SetState(v string) *ParticipantSummary
- func (s *ParticipantSummary) SetUserId(v string) *ParticipantSummary
- func (s ParticipantSummary) String() string
- type ParticipantToken
- func (s ParticipantToken) GoString() string
- func (s *ParticipantToken) SetAttributes(v map[string]*string) *ParticipantToken
- func (s *ParticipantToken) SetCapabilities(v []*string) *ParticipantToken
- func (s *ParticipantToken) SetDuration(v int64) *ParticipantToken
- func (s *ParticipantToken) SetExpirationTime(v time.Time) *ParticipantToken
- func (s *ParticipantToken) SetParticipantId(v string) *ParticipantToken
- func (s *ParticipantToken) SetToken(v string) *ParticipantToken
- func (s *ParticipantToken) SetUserId(v string) *ParticipantToken
- func (s ParticipantToken) String() string
- type ParticipantTokenConfiguration
- func (s ParticipantTokenConfiguration) GoString() string
- func (s *ParticipantTokenConfiguration) SetAttributes(v map[string]*string) *ParticipantTokenConfiguration
- func (s *ParticipantTokenConfiguration) SetCapabilities(v []*string) *ParticipantTokenConfiguration
- func (s *ParticipantTokenConfiguration) SetDuration(v int64) *ParticipantTokenConfiguration
- func (s *ParticipantTokenConfiguration) SetUserId(v string) *ParticipantTokenConfiguration
- func (s ParticipantTokenConfiguration) String() string
- func (s *ParticipantTokenConfiguration) Validate() error
- type PendingVerification
- func (s *PendingVerification) Code() string
- func (s *PendingVerification) Error() string
- func (s PendingVerification) GoString() string
- func (s *PendingVerification) Message() string
- func (s *PendingVerification) OrigErr() error
- func (s *PendingVerification) RequestID() string
- func (s *PendingVerification) StatusCode() int
- func (s PendingVerification) String() string
- type ResourceNotFoundException
- func (s *ResourceNotFoundException) Code() string
- func (s *ResourceNotFoundException) Error() string
- func (s ResourceNotFoundException) GoString() string
- func (s *ResourceNotFoundException) Message() string
- func (s *ResourceNotFoundException) OrigErr() error
- func (s *ResourceNotFoundException) RequestID() string
- func (s *ResourceNotFoundException) StatusCode() int
- func (s ResourceNotFoundException) String() string
- type ServiceQuotaExceededException
- func (s *ServiceQuotaExceededException) Code() string
- func (s *ServiceQuotaExceededException) Error() string
- func (s ServiceQuotaExceededException) GoString() string
- func (s *ServiceQuotaExceededException) Message() string
- func (s *ServiceQuotaExceededException) OrigErr() error
- func (s *ServiceQuotaExceededException) RequestID() string
- func (s *ServiceQuotaExceededException) StatusCode() int
- func (s ServiceQuotaExceededException) String() string
- type Stage
- type StageSession
- type StageSessionSummary
- func (s StageSessionSummary) GoString() string
- func (s *StageSessionSummary) SetEndTime(v time.Time) *StageSessionSummary
- func (s *StageSessionSummary) SetSessionId(v string) *StageSessionSummary
- func (s *StageSessionSummary) SetStartTime(v time.Time) *StageSessionSummary
- func (s StageSessionSummary) String() string
- type StageSummary
- func (s StageSummary) GoString() string
- func (s *StageSummary) SetActiveSessionId(v string) *StageSummary
- func (s *StageSummary) SetArn(v string) *StageSummary
- func (s *StageSummary) SetName(v string) *StageSummary
- func (s *StageSummary) SetTags(v map[string]*string) *StageSummary
- func (s StageSummary) String() string
- type TagResourceInput
- type TagResourceOutput
- type UntagResourceInput
- type UntagResourceOutput
- type UpdateStageInput
- type UpdateStageOutput
- type ValidationException
- func (s *ValidationException) Code() string
- func (s *ValidationException) Error() string
- func (s ValidationException) GoString() string
- func (s *ValidationException) Message() string
- func (s *ValidationException) OrigErr() error
- func (s *ValidationException) RequestID() string
- func (s *ValidationException) StatusCode() int
- func (s ValidationException) String() string
Constants ¶
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 ( // 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
Variables ¶
This section is empty.
Functions ¶
func EventErrorCode_Values ¶ added in v1.44.262
func EventErrorCode_Values() []string
EventErrorCode_Values returns all elements of the EventErrorCode enum
func EventName_Values ¶ added in v1.44.262
func EventName_Values() []string
EventName_Values returns all elements of the EventName enum
func ParticipantState_Values ¶ added in v1.44.262
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
Types ¶
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 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 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 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 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 Event ¶ added in v1.44.262
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 ¶ added in v1.44.262
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 ¶ added in v1.44.262
SetErrorCode sets the ErrorCode field's value.
func (*Event) SetEventTime ¶ added in v1.44.262
SetEventTime sets the EventTime field's value.
func (*Event) SetParticipantId ¶ added in v1.44.262
SetParticipantId sets the ParticipantId field's value.
func (*Event) SetRemoteParticipantId ¶ added in v1.44.262
SetRemoteParticipantId sets the RemoteParticipantId field's value.
type GetParticipantInput ¶ added in v1.44.262
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 ¶ added in v1.44.262
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 ¶ added in v1.44.262
func (s *GetParticipantInput) SetParticipantId(v string) *GetParticipantInput
SetParticipantId sets the ParticipantId field's value.
func (*GetParticipantInput) SetSessionId ¶ added in v1.44.262
func (s *GetParticipantInput) SetSessionId(v string) *GetParticipantInput
SetSessionId sets the SessionId field's value.
func (*GetParticipantInput) SetStageArn ¶ added in v1.44.262
func (s *GetParticipantInput) SetStageArn(v string) *GetParticipantInput
SetStageArn sets the StageArn field's value.
func (GetParticipantInput) String ¶ added in v1.44.262
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 ¶ added in v1.44.262
func (s *GetParticipantInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetParticipantOutput ¶ added in v1.44.262
type GetParticipantOutput struct { // The participant that is returned. Participant *Participant `locationName:"participant" type:"structure"` // contains filtered or unexported fields }
func (GetParticipantOutput) GoString ¶ added in v1.44.262
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 ¶ added in v1.44.262
func (s *GetParticipantOutput) SetParticipant(v *Participant) *GetParticipantOutput
SetParticipant sets the Participant field's value.
func (GetParticipantOutput) String ¶ added in v1.44.262
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 ¶ added in v1.44.262
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 ¶ added in v1.44.262
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 ¶ added in v1.44.262
func (s *GetStageSessionInput) SetSessionId(v string) *GetStageSessionInput
SetSessionId sets the SessionId field's value.
func (*GetStageSessionInput) SetStageArn ¶ added in v1.44.262
func (s *GetStageSessionInput) SetStageArn(v string) *GetStageSessionInput
SetStageArn sets the StageArn field's value.
func (GetStageSessionInput) String ¶ added in v1.44.262
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 ¶ added in v1.44.262
func (s *GetStageSessionInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetStageSessionOutput ¶ added in v1.44.262
type GetStageSessionOutput struct { // The stage session that is returned. StageSession *StageSession `locationName:"stageSession" type:"structure"` // contains filtered or unexported fields }
func (GetStageSessionOutput) GoString ¶ added in v1.44.262
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 ¶ added in v1.44.262
func (s *GetStageSessionOutput) SetStageSession(v *StageSession) *GetStageSessionOutput
SetStageSession sets the StageSession field's value.
func (GetStageSessionOutput) String ¶ added in v1.44.262
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 IVSRealTime ¶
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) 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) 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) 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) GetParticipant ¶ added in v1.44.262
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 ¶ added in v1.44.262
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 ¶ added in v1.44.262
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 ¶ added in v1.44.262
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 ¶ added in v1.44.262
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 ¶ added in v1.44.262
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) ListParticipantEvents ¶ added in v1.44.262
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 ¶ added in v1.44.262
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 ¶ added in v1.44.262
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 ¶ added in v1.44.262
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 ¶ added in v1.44.262
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 ¶ added in v1.44.262
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 ¶ added in v1.44.262
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 ¶ added in v1.44.262
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 ¶ added in v1.44.262
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 ¶ added in v1.44.262
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 ¶ added in v1.44.262
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 ¶ added in v1.44.262
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 ¶ added in v1.44.262
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 ¶ added in v1.44.262
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 ¶ added in v1.44.262
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) 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) 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 ListParticipantEventsInput ¶ added in v1.44.262
type ListParticipantEventsInput struct { // 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"` // 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 ¶ added in v1.44.262
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 ¶ added in v1.44.262
func (s *ListParticipantEventsInput) SetMaxResults(v int64) *ListParticipantEventsInput
SetMaxResults sets the MaxResults field's value.
func (*ListParticipantEventsInput) SetNextToken ¶ added in v1.44.262
func (s *ListParticipantEventsInput) SetNextToken(v string) *ListParticipantEventsInput
SetNextToken sets the NextToken field's value.
func (*ListParticipantEventsInput) SetParticipantId ¶ added in v1.44.262
func (s *ListParticipantEventsInput) SetParticipantId(v string) *ListParticipantEventsInput
SetParticipantId sets the ParticipantId field's value.
func (*ListParticipantEventsInput) SetSessionId ¶ added in v1.44.262
func (s *ListParticipantEventsInput) SetSessionId(v string) *ListParticipantEventsInput
SetSessionId sets the SessionId field's value.
func (*ListParticipantEventsInput) SetStageArn ¶ added in v1.44.262
func (s *ListParticipantEventsInput) SetStageArn(v string) *ListParticipantEventsInput
SetStageArn sets the StageArn field's value.
func (ListParticipantEventsInput) String ¶ added in v1.44.262
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 ¶ added in v1.44.262
func (s *ListParticipantEventsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListParticipantEventsOutput ¶ added in v1.44.262
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 rooms 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 ¶ added in v1.44.262
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 ¶ added in v1.44.262
func (s *ListParticipantEventsOutput) SetEvents(v []*Event) *ListParticipantEventsOutput
SetEvents sets the Events field's value.
func (*ListParticipantEventsOutput) SetNextToken ¶ added in v1.44.262
func (s *ListParticipantEventsOutput) SetNextToken(v string) *ListParticipantEventsOutput
SetNextToken sets the NextToken field's value.
func (ListParticipantEventsOutput) String ¶ added in v1.44.262
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 ¶ added in v1.44.262
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 ¶ added in v1.44.262
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 ¶ added in v1.44.262
func (s *ListParticipantsInput) SetFilterByPublished(v bool) *ListParticipantsInput
SetFilterByPublished sets the FilterByPublished field's value.
func (*ListParticipantsInput) SetFilterByState ¶ added in v1.44.262
func (s *ListParticipantsInput) SetFilterByState(v string) *ListParticipantsInput
SetFilterByState sets the FilterByState field's value.
func (*ListParticipantsInput) SetFilterByUserId ¶ added in v1.44.262
func (s *ListParticipantsInput) SetFilterByUserId(v string) *ListParticipantsInput
SetFilterByUserId sets the FilterByUserId field's value.
func (*ListParticipantsInput) SetMaxResults ¶ added in v1.44.262
func (s *ListParticipantsInput) SetMaxResults(v int64) *ListParticipantsInput
SetMaxResults sets the MaxResults field's value.
func (*ListParticipantsInput) SetNextToken ¶ added in v1.44.262
func (s *ListParticipantsInput) SetNextToken(v string) *ListParticipantsInput
SetNextToken sets the NextToken field's value.
func (*ListParticipantsInput) SetSessionId ¶ added in v1.44.262
func (s *ListParticipantsInput) SetSessionId(v string) *ListParticipantsInput
SetSessionId sets the SessionId field's value.
func (*ListParticipantsInput) SetStageArn ¶ added in v1.44.262
func (s *ListParticipantsInput) SetStageArn(v string) *ListParticipantsInput
SetStageArn sets the StageArn field's value.
func (ListParticipantsInput) String ¶ added in v1.44.262
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 ¶ added in v1.44.262
func (s *ListParticipantsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListParticipantsOutput ¶ added in v1.44.262
type ListParticipantsOutput struct { // If there are more rooms 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 ¶ added in v1.44.262
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 ¶ added in v1.44.262
func (s *ListParticipantsOutput) SetNextToken(v string) *ListParticipantsOutput
SetNextToken sets the NextToken field's value.
func (*ListParticipantsOutput) SetParticipants ¶ added in v1.44.262
func (s *ListParticipantsOutput) SetParticipants(v []*ParticipantSummary) *ListParticipantsOutput
SetParticipants sets the Participants field's value.
func (ListParticipantsOutput) String ¶ added in v1.44.262
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 ¶ added in v1.44.262
type ListStageSessionsInput 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"` // 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 ¶ added in v1.44.262
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 ¶ added in v1.44.262
func (s *ListStageSessionsInput) SetMaxResults(v int64) *ListStageSessionsInput
SetMaxResults sets the MaxResults field's value.
func (*ListStageSessionsInput) SetNextToken ¶ added in v1.44.262
func (s *ListStageSessionsInput) SetNextToken(v string) *ListStageSessionsInput
SetNextToken sets the NextToken field's value.
func (*ListStageSessionsInput) SetStageArn ¶ added in v1.44.262
func (s *ListStageSessionsInput) SetStageArn(v string) *ListStageSessionsInput
SetStageArn sets the StageArn field's value.
func (ListStageSessionsInput) String ¶ added in v1.44.262
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 ¶ added in v1.44.262
func (s *ListStageSessionsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListStageSessionsOutput ¶ added in v1.44.262
type ListStageSessionsOutput struct { // If there are more rooms 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 ¶ added in v1.44.262
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 ¶ added in v1.44.262
func (s *ListStageSessionsOutput) SetNextToken(v string) *ListStageSessionsOutput
SetNextToken sets the NextToken field's value.
func (*ListStageSessionsOutput) SetStageSessions ¶ added in v1.44.262
func (s *ListStageSessionsOutput) SetStageSessions(v []*StageSessionSummary) *ListStageSessionsOutput
SetStageSessions sets the StageSessions field's value.
func (ListStageSessionsOutput) String ¶ added in v1.44.262
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 rooms 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 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 ¶ added in v1.44.262
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"` // 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 }
Object describing a participant that has joined a stage.
func (Participant) GoString ¶ added in v1.44.262
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 ¶ added in v1.44.262
func (s *Participant) SetAttributes(v map[string]*string) *Participant
SetAttributes sets the Attributes field's value.
func (*Participant) SetFirstJoinTime ¶ added in v1.44.262
func (s *Participant) SetFirstJoinTime(v time.Time) *Participant
SetFirstJoinTime sets the FirstJoinTime field's value.
func (*Participant) SetParticipantId ¶ added in v1.44.262
func (s *Participant) SetParticipantId(v string) *Participant
SetParticipantId sets the ParticipantId field's value.
func (*Participant) SetPublished ¶ added in v1.44.262
func (s *Participant) SetPublished(v bool) *Participant
SetPublished sets the Published field's value.
func (*Participant) SetState ¶ added in v1.44.262
func (s *Participant) SetState(v string) *Participant
SetState sets the State field's value.
func (*Participant) SetUserId ¶ added in v1.44.262
func (s *Participant) SetUserId(v string) *Participant
SetUserId sets the UserId field's value.
func (Participant) String ¶ added in v1.44.262
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 ¶ added in v1.44.262
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 ¶ added in v1.44.262
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 ¶ added in v1.44.262
func (s *ParticipantSummary) SetFirstJoinTime(v time.Time) *ParticipantSummary
SetFirstJoinTime sets the FirstJoinTime field's value.
func (*ParticipantSummary) SetParticipantId ¶ added in v1.44.262
func (s *ParticipantSummary) SetParticipantId(v string) *ParticipantSummary
SetParticipantId sets the ParticipantId field's value.
func (*ParticipantSummary) SetPublished ¶ added in v1.44.262
func (s *ParticipantSummary) SetPublished(v bool) *ParticipantSummary
SetPublished sets the Published field's value.
func (*ParticipantSummary) SetState ¶ added in v1.44.262
func (s *ParticipantSummary) SetState(v string) *ParticipantSummary
SetState sets the State field's value.
func (*ParticipantSummary) SetUserId ¶ added in v1.44.262
func (s *ParticipantSummary) SetUserId(v string) *ParticipantSummary
SetUserId sets the UserId field's value.
func (ParticipantSummary) String ¶ added in v1.44.262
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.
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 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 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 ¶
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 ¶
SetActiveSessionId sets the ActiveSessionId field's value.
type StageSession ¶ added in v1.44.262
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 ¶ added in v1.44.262
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 ¶ added in v1.44.262
func (s *StageSession) SetEndTime(v time.Time) *StageSession
SetEndTime sets the EndTime field's value.
func (*StageSession) SetSessionId ¶ added in v1.44.262
func (s *StageSession) SetSessionId(v string) *StageSession
SetSessionId sets the SessionId field's value.
func (*StageSession) SetStartTime ¶ added in v1.44.262
func (s *StageSession) SetStartTime(v time.Time) *StageSession
SetStartTime sets the StartTime field's value.
func (StageSession) String ¶ added in v1.44.262
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 ¶ added in v1.44.262
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 ¶ added in v1.44.262
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 ¶ added in v1.44.262
func (s *StageSessionSummary) SetEndTime(v time.Time) *StageSessionSummary
SetEndTime sets the EndTime field's value.
func (*StageSessionSummary) SetSessionId ¶ added in v1.44.262
func (s *StageSessionSummary) SetSessionId(v string) *StageSessionSummary
SetSessionId sets the SessionId field's value.
func (*StageSessionSummary) SetStartTime ¶ added in v1.44.262
func (s *StageSessionSummary) SetStartTime(v time.Time) *StageSessionSummary
SetStartTime sets the StartTime field's value.
func (StageSessionSummary) String ¶ added in v1.44.262
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 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".
Directories
¶
Path | Synopsis |
---|---|
Package ivsrealtimeiface provides an interface to enable mocking the Amazon Interactive Video Service RealTime service client for testing your code.
|
Package ivsrealtimeiface provides an interface to enable mocking the Amazon Interactive Video Service RealTime service client for testing your code. |