func ChannelLatencyMode_Values() []string
ChannelLatencyMode_Values returns all elements of the ChannelLatencyMode enum
func ChannelType_Values() []string
ChannelType_Values returns all elements of the ChannelType enum
func RecordingConfigurationState_Values() []string
RecordingConfigurationState_Values returns all elements of the RecordingConfigurationState enum
func RecordingMode_Values() []string
RecordingMode_Values returns all elements of the RecordingMode enum
func RenditionConfigurationRenditionSelection_Values() []string
RenditionConfigurationRenditionSelection_Values returns all elements of the RenditionConfigurationRenditionSelection enum
func RenditionConfigurationRendition_Values() []string
RenditionConfigurationRendition_Values returns all elements of the RenditionConfigurationRendition enum
func StreamHealth_Values() []string
StreamHealth_Values returns all elements of the StreamHealth enum
func StreamState_Values() []string
StreamState_Values returns all elements of the StreamState enum
func ThumbnailConfigurationResolution_Values() []string
ThumbnailConfigurationResolution_Values returns all elements of the ThumbnailConfigurationResolution enum
func ThumbnailConfigurationStorage_Values() []string
ThumbnailConfigurationStorage_Values returns all elements of the ThumbnailConfigurationStorage enum
func TranscodePreset_Values() []string
TranscodePreset_Values returns all elements of the TranscodePreset enum
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 (s *AccessDeniedException) Code() string
Code returns the exception type name.
func (s *AccessDeniedException) Error() string
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 (s *AccessDeniedException) Message() string
Message returns the exception's message.
func (s *AccessDeniedException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *AccessDeniedException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *AccessDeniedException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
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 AudioConfiguration struct {
// Number of audio channels.
Channels *int64 `locationName:"channels" type:"long"`
// Codec used for the audio encoding.
Codec *string `locationName:"codec" type:"string"`
// Number of audio samples recorded per second.
SampleRate *int64 `locationName:"sampleRate" type:"long"`
// The expected ingest bitrate (bits per second). This is configured in the
// encoder.
TargetBitrate *int64 `locationName:"targetBitrate" type:"long"`
// contains filtered or unexported fields
}
Object specifying a stream’s audio configuration, as set up by the broadcaster (usually in an encoder). This is part of the IngestConfiguration object and used for monitoring stream health.
func (s AudioConfiguration) 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 (s *AudioConfiguration) SetChannels(v int64) *AudioConfiguration
SetChannels sets the Channels field's value.
func (s *AudioConfiguration) SetCodec(v string) *AudioConfiguration
SetCodec sets the Codec field's value.
func (s *AudioConfiguration) SetSampleRate(v int64) *AudioConfiguration
SetSampleRate sets the SampleRate field's value.
func (s *AudioConfiguration) SetTargetBitrate(v int64) *AudioConfiguration
SetTargetBitrate sets the TargetBitrate field's value.
func (s AudioConfiguration) 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 BatchError struct {
// Channel ARN.
Arn *string `locationName:"arn" min:"1" type:"string"`
// Error code.
Code *string `locationName:"code" type:"string"`
// Error message, determined by the application.
Message *string `locationName:"message" type:"string"`
// contains filtered or unexported fields
}
Error related to a specific channel, specified by its ARN.
func (s BatchError) 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 (s *BatchError) SetArn(v string) *BatchError
SetArn sets the Arn field's value.
func (s *BatchError) SetCode(v string) *BatchError
SetCode sets the Code field's value.
func (s *BatchError) SetMessage(v string) *BatchError
SetMessage sets the Message field's value.
func (s BatchError) 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 BatchGetChannelInput struct {
// Array of ARNs, one per channel.
//
// Arns is a required field
Arns []*string `locationName:"arns" min:"1" type:"list" required:"true"`
// contains filtered or unexported fields
}
func (s BatchGetChannelInput) 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 (s *BatchGetChannelInput) SetArns(v []*string) *BatchGetChannelInput
SetArns sets the Arns field's value.
func (s BatchGetChannelInput) 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 (s *BatchGetChannelInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type BatchGetChannelOutput struct {
Channels []*Channel `locationName:"channels" type:"list"`
// Each error object is related to a specific ARN in the request.
Errors []*BatchError `locationName:"errors" type:"list"`
// contains filtered or unexported fields
}
func (s BatchGetChannelOutput) 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 (s *BatchGetChannelOutput) SetChannels(v []*Channel) *BatchGetChannelOutput
SetChannels sets the Channels field's value.
func (s *BatchGetChannelOutput) SetErrors(v []*BatchError) *BatchGetChannelOutput
SetErrors sets the Errors field's value.
func (s BatchGetChannelOutput) 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 BatchGetStreamKeyInput struct {
// Array of ARNs, one per stream key.
//
// Arns is a required field
Arns []*string `locationName:"arns" min:"1" type:"list" required:"true"`
// contains filtered or unexported fields
}
func (s BatchGetStreamKeyInput) 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 (s *BatchGetStreamKeyInput) SetArns(v []*string) *BatchGetStreamKeyInput
SetArns sets the Arns field's value.
func (s BatchGetStreamKeyInput) 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 (s *BatchGetStreamKeyInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type BatchGetStreamKeyOutput struct {
Errors []*BatchError `locationName:"errors" type:"list"`
StreamKeys []*StreamKey `locationName:"streamKeys" type:"list"`
// contains filtered or unexported fields
}
func (s BatchGetStreamKeyOutput) 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 (s *BatchGetStreamKeyOutput) SetErrors(v []*BatchError) *BatchGetStreamKeyOutput
SetErrors sets the Errors field's value.
func (s *BatchGetStreamKeyOutput) SetStreamKeys(v []*StreamKey) *BatchGetStreamKeyOutput
SetStreamKeys sets the StreamKeys field's value.
func (s BatchGetStreamKeyOutput) 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 BatchStartViewerSessionRevocationError struct {
// Channel ARN.
//
// ChannelArn is a required field
ChannelArn *string `locationName:"channelArn" min:"1" type:"string" required:"true"`
// Error code.
Code *string `locationName:"code" type:"string"`
// Error message, determined by the application.
Message *string `locationName:"message" type:"string"`
// The ID of the viewer session to revoke.
//
// ViewerId is a required field
ViewerId *string `locationName:"viewerId" min:"1" type:"string" required:"true"`
// contains filtered or unexported fields
}
Error for a request in the batch for BatchStartViewerSessionRevocation. Each error is related to a specific channel-ARN and viewer-ID pair.
func (s BatchStartViewerSessionRevocationError) 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 (s *BatchStartViewerSessionRevocationError) SetChannelArn(v string) *BatchStartViewerSessionRevocationError
SetChannelArn sets the ChannelArn field's value.
func (s *BatchStartViewerSessionRevocationError) SetCode(v string) *BatchStartViewerSessionRevocationError
SetCode sets the Code field's value.
func (s *BatchStartViewerSessionRevocationError) SetMessage(v string) *BatchStartViewerSessionRevocationError
SetMessage sets the Message field's value.
func (s *BatchStartViewerSessionRevocationError) SetViewerId(v string) *BatchStartViewerSessionRevocationError
SetViewerId sets the ViewerId field's value.
func (s BatchStartViewerSessionRevocationError) 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 BatchStartViewerSessionRevocationInput struct {
// Array of viewer sessions, one per channel-ARN and viewer-ID pair.
//
// ViewerSessions is a required field
ViewerSessions []*BatchStartViewerSessionRevocationViewerSession `locationName:"viewerSessions" min:"1" type:"list" required:"true"`
// contains filtered or unexported fields
}
func (s BatchStartViewerSessionRevocationInput) 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 (s *BatchStartViewerSessionRevocationInput) SetViewerSessions(v []*BatchStartViewerSessionRevocationViewerSession) *BatchStartViewerSessionRevocationInput
SetViewerSessions sets the ViewerSessions field's value.
func (s BatchStartViewerSessionRevocationInput) 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 (s *BatchStartViewerSessionRevocationInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type BatchStartViewerSessionRevocationOutput struct {
// Each error object is related to a specific channelArn and viewerId pair in
// the request.
Errors []*BatchStartViewerSessionRevocationError `locationName:"errors" type:"list"`
// contains filtered or unexported fields
}
func (s BatchStartViewerSessionRevocationOutput) 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 (s *BatchStartViewerSessionRevocationOutput) SetErrors(v []*BatchStartViewerSessionRevocationError) *BatchStartViewerSessionRevocationOutput
SetErrors sets the Errors field's value.
func (s BatchStartViewerSessionRevocationOutput) 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 BatchStartViewerSessionRevocationViewerSession struct {
// The ARN of the channel associated with the viewer session to revoke.
//
// ChannelArn is a required field
ChannelArn *string `locationName:"channelArn" min:"1" type:"string" required:"true"`
// The ID of the viewer associated with the viewer session to revoke. Do not
// use this field for personally identifying, confidential, or sensitive information.
//
// ViewerId is a required field
ViewerId *string `locationName:"viewerId" min:"1" type:"string" required:"true"`
// An optional filter on which versions of the viewer session to revoke. All
// versions less than or equal to the specified version will be revoked. Default:
// 0.
ViewerSessionVersionsLessThanOrEqualTo *int64 `locationName:"viewerSessionVersionsLessThanOrEqualTo" type:"integer"`
// contains filtered or unexported fields
}
A viewer session to revoke in the call to BatchStartViewerSessionRevocation.
func (s BatchStartViewerSessionRevocationViewerSession) 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 (s *BatchStartViewerSessionRevocationViewerSession) SetChannelArn(v string) *BatchStartViewerSessionRevocationViewerSession
SetChannelArn sets the ChannelArn field's value.
func (s *BatchStartViewerSessionRevocationViewerSession) SetViewerId(v string) *BatchStartViewerSessionRevocationViewerSession
SetViewerId sets the ViewerId field's value.
func (s *BatchStartViewerSessionRevocationViewerSession) SetViewerSessionVersionsLessThanOrEqualTo(v int64) *BatchStartViewerSessionRevocationViewerSession
SetViewerSessionVersionsLessThanOrEqualTo sets the ViewerSessionVersionsLessThanOrEqualTo field's value.
func (s BatchStartViewerSessionRevocationViewerSession) 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 (s *BatchStartViewerSessionRevocationViewerSession) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type Channel struct {
// Channel ARN.
Arn *string `locationName:"arn" min:"1" type:"string"`
// Whether the channel is private (enabled for playback authorization). Default:
// false.
Authorized *bool `locationName:"authorized" type:"boolean"`
// Channel ingest endpoint, part of the definition of an ingest server, used
// when you set up streaming software.
IngestEndpoint *string `locationName:"ingestEndpoint" type:"string"`
// Whether the channel allows insecure RTMP ingest. Default: false.
InsecureIngest *bool `locationName:"insecureIngest" type:"boolean"`
// Channel latency mode. Use NORMAL to broadcast and deliver live video up to
// Full HD. Use LOW for near-real-time interaction with viewers. Default: LOW.
LatencyMode *string `locationName:"latencyMode" type:"string" enum:"ChannelLatencyMode"`
// Channel name.
Name *string `locationName:"name" type:"string"`
// Playback-restriction-policy ARN. A valid ARN value here both specifies the
// ARN and enables playback restriction. Default: "" (empty string, no playback
// restriction policy is applied).
PlaybackRestrictionPolicyArn *string `locationName:"playbackRestrictionPolicyArn" type:"string"`
// Channel playback URL.
PlaybackUrl *string `locationName:"playbackUrl" type:"string"`
// Optional transcode preset for the channel. This is selectable only for ADVANCED_HD
// and ADVANCED_SD channel types. For those channel types, the default preset
// is HIGHER_BANDWIDTH_DELIVERY. For other channel types (BASIC and STANDARD),
// preset is the empty string ("").
Preset *string `locationName:"preset" type:"string" enum:"TranscodePreset"`
// Recording-configuration ARN. A valid ARN value here both specifies the ARN
// and enables recording. Default: "" (empty string, recording is disabled).
RecordingConfigurationArn *string `locationName:"recordingConfigurationArn" type:"string"`
// Specifies the endpoint and optional passphrase for streaming with the SRT
// protocol.
Srt *Srt `locationName:"srt" type:"structure"`
// Tags attached to the resource. Array of 1-50 maps, each of the form string:string
// (key:value). See Tagging Amazon Web Services 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 has no service-specific constraints
// beyond what is documented there.
Tags map[string]*string `locationName:"tags" type:"map"`
// Channel type, which determines the allowable resolution and bitrate. If you
// exceed the allowable input resolution or bitrate, the stream probably will
// disconnect immediately. Default: STANDARD. For details, see Channel Types
// (https://docs.aws.amazon.com/ivs/latest/LowLatencyAPIReference/channel-types.html).
Type *string `locationName:"type" type:"string" enum:"ChannelType"`
// contains filtered or unexported fields
}
Object specifying a channel.
func (s Channel) 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 (s *Channel) SetArn(v string) *Channel
SetArn sets the Arn field's value.
func (s *Channel) SetAuthorized(v bool) *Channel
SetAuthorized sets the Authorized field's value.
func (s *Channel) SetIngestEndpoint(v string) *Channel
SetIngestEndpoint sets the IngestEndpoint field's value.
func (s *Channel) SetInsecureIngest(v bool) *Channel
SetInsecureIngest sets the InsecureIngest field's value.
func (s *Channel) SetLatencyMode(v string) *Channel
SetLatencyMode sets the LatencyMode field's value.
func (s *Channel) SetName(v string) *Channel
SetName sets the Name field's value.
func (s *Channel) SetPlaybackRestrictionPolicyArn(v string) *Channel
SetPlaybackRestrictionPolicyArn sets the PlaybackRestrictionPolicyArn field's value.
func (s *Channel) SetPlaybackUrl(v string) *Channel
SetPlaybackUrl sets the PlaybackUrl field's value.
func (s *Channel) SetPreset(v string) *Channel
SetPreset sets the Preset field's value.
func (s *Channel) SetRecordingConfigurationArn(v string) *Channel
SetRecordingConfigurationArn sets the RecordingConfigurationArn field's value.
func (s *Channel) SetSrt(v *Srt) *Channel
SetSrt sets the Srt field's value.
func (s *Channel) SetTags(v map[string]*string) *Channel
SetTags sets the Tags field's value.
func (s *Channel) SetType(v string) *Channel
SetType sets the Type field's value.
func (s Channel) 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 ChannelNotBroadcasting struct {
RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
// The stream is offline for the given channel ARN.
ExceptionMessage *string `locationName:"exceptionMessage" type:"string"`
Message_ *string `locationName:"message" type:"string"`
// contains filtered or unexported fields
}
func (s *ChannelNotBroadcasting) Code() string
Code returns the exception type name.
func (s *ChannelNotBroadcasting) Error() string
func (s ChannelNotBroadcasting) 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 (s *ChannelNotBroadcasting) Message() string
Message returns the exception's message.
func (s *ChannelNotBroadcasting) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ChannelNotBroadcasting) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *ChannelNotBroadcasting) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s ChannelNotBroadcasting) 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 ChannelSummary struct {
// Channel ARN.
Arn *string `locationName:"arn" min:"1" type:"string"`
// Whether the channel is private (enabled for playback authorization). Default:
// false.
Authorized *bool `locationName:"authorized" type:"boolean"`
// Whether the channel allows insecure RTMP ingest. Default: false.
InsecureIngest *bool `locationName:"insecureIngest" type:"boolean"`
// Channel latency mode. Use NORMAL to broadcast and deliver live video up to
// Full HD. Use LOW for near-real-time interaction with viewers. Default: LOW.
LatencyMode *string `locationName:"latencyMode" type:"string" enum:"ChannelLatencyMode"`
// Channel name.
Name *string `locationName:"name" type:"string"`
// Playback-restriction-policy ARN. A valid ARN value here both specifies the
// ARN and enables playback restriction. Default: "" (empty string, no playback
// restriction policy is applied).
PlaybackRestrictionPolicyArn *string `locationName:"playbackRestrictionPolicyArn" type:"string"`
// Optional transcode preset for the channel. This is selectable only for ADVANCED_HD
// and ADVANCED_SD channel types. For those channel types, the default preset
// is HIGHER_BANDWIDTH_DELIVERY. For other channel types (BASIC and STANDARD),
// preset is the empty string ("").
Preset *string `locationName:"preset" type:"string" enum:"TranscodePreset"`
// Recording-configuration ARN. A valid ARN value here both specifies the ARN
// and enables recording. Default: "" (empty string, recording is disabled).
RecordingConfigurationArn *string `locationName:"recordingConfigurationArn" type:"string"`
// Tags attached to the resource. Array of 1-50 maps, each of the form string:string
// (key:value). See Tagging Amazon Web Services 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 has no service-specific constraints
// beyond what is documented there.
Tags map[string]*string `locationName:"tags" type:"map"`
// Channel type, which determines the allowable resolution and bitrate. If you
// exceed the allowable input resolution or bitrate, the stream probably will
// disconnect immediately. Default: STANDARD. For details, see Channel Types
// (https://docs.aws.amazon.com/ivs/latest/LowLatencyAPIReference/channel-types.html).
Type *string `locationName:"type" type:"string" enum:"ChannelType"`
// contains filtered or unexported fields
}
Summary information about a channel.
func (s ChannelSummary) 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 (s *ChannelSummary) SetArn(v string) *ChannelSummary
SetArn sets the Arn field's value.
func (s *ChannelSummary) SetAuthorized(v bool) *ChannelSummary
SetAuthorized sets the Authorized field's value.
func (s *ChannelSummary) SetInsecureIngest(v bool) *ChannelSummary
SetInsecureIngest sets the InsecureIngest field's value.
func (s *ChannelSummary) SetLatencyMode(v string) *ChannelSummary
SetLatencyMode sets the LatencyMode field's value.
func (s *ChannelSummary) SetName(v string) *ChannelSummary
SetName sets the Name field's value.
func (s *ChannelSummary) SetPlaybackRestrictionPolicyArn(v string) *ChannelSummary
SetPlaybackRestrictionPolicyArn sets the PlaybackRestrictionPolicyArn field's value.
func (s *ChannelSummary) SetPreset(v string) *ChannelSummary
SetPreset sets the Preset field's value.
func (s *ChannelSummary) SetRecordingConfigurationArn(v string) *ChannelSummary
SetRecordingConfigurationArn sets the RecordingConfigurationArn field's value.
func (s *ChannelSummary) SetTags(v map[string]*string) *ChannelSummary
SetTags sets the Tags field's value.
func (s *ChannelSummary) SetType(v string) *ChannelSummary
SetType sets the Type field's value.
func (s ChannelSummary) 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 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 (s *ConflictException) Code() string
Code returns the exception type name.
func (s *ConflictException) Error() string
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 (s *ConflictException) Message() string
Message returns the exception's message.
func (s *ConflictException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ConflictException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *ConflictException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
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 CreateChannelInput struct {
// Whether the channel is private (enabled for playback authorization). Default:
// false.
Authorized *bool `locationName:"authorized" type:"boolean"`
// Whether the channel allows insecure RTMP and SRT ingest. Default: false.
InsecureIngest *bool `locationName:"insecureIngest" type:"boolean"`
// Channel latency mode. Use NORMAL to broadcast and deliver live video up to
// Full HD. Use LOW for near-real-time interaction with viewers. Default: LOW.
LatencyMode *string `locationName:"latencyMode" type:"string" enum:"ChannelLatencyMode"`
// Channel name.
Name *string `locationName:"name" type:"string"`
// Playback-restriction-policy ARN. A valid ARN value here both specifies the
// ARN and enables playback restriction. Default: "" (empty string, no playback
// restriction policy is applied).
PlaybackRestrictionPolicyArn *string `locationName:"playbackRestrictionPolicyArn" type:"string"`
// Optional transcode preset for the channel. This is selectable only for ADVANCED_HD
// and ADVANCED_SD channel types. For those channel types, the default preset
// is HIGHER_BANDWIDTH_DELIVERY. For other channel types (BASIC and STANDARD),
// preset is the empty string ("").
Preset *string `locationName:"preset" type:"string" enum:"TranscodePreset"`
// Recording-configuration ARN. A valid ARN value here both specifies the ARN
// and enables recording. Default: "" (empty string, recording is disabled).
RecordingConfigurationArn *string `locationName:"recordingConfigurationArn" type:"string"`
// Array of 1-50 maps, each of the form string:string (key:value). See Tagging
// Amazon Web Services 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 has no service-specific constraints
// beyond what is documented there.
Tags map[string]*string `locationName:"tags" type:"map"`
// Channel type, which determines the allowable resolution and bitrate. If you
// exceed the allowable input resolution or bitrate, the stream probably will
// disconnect immediately. Default: STANDARD. For details, see Channel Types
// (https://docs.aws.amazon.com/ivs/latest/LowLatencyAPIReference/channel-types.html).
Type *string `locationName:"type" type:"string" enum:"ChannelType"`
// contains filtered or unexported fields
}
func (s CreateChannelInput) 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 (s *CreateChannelInput) SetAuthorized(v bool) *CreateChannelInput
SetAuthorized sets the Authorized field's value.
func (s *CreateChannelInput) SetInsecureIngest(v bool) *CreateChannelInput
SetInsecureIngest sets the InsecureIngest field's value.
func (s *CreateChannelInput) SetLatencyMode(v string) *CreateChannelInput
SetLatencyMode sets the LatencyMode field's value.
func (s *CreateChannelInput) SetName(v string) *CreateChannelInput
SetName sets the Name field's value.
func (s *CreateChannelInput) SetPlaybackRestrictionPolicyArn(v string) *CreateChannelInput
SetPlaybackRestrictionPolicyArn sets the PlaybackRestrictionPolicyArn field's value.
func (s *CreateChannelInput) SetPreset(v string) *CreateChannelInput
SetPreset sets the Preset field's value.
func (s *CreateChannelInput) SetRecordingConfigurationArn(v string) *CreateChannelInput
SetRecordingConfigurationArn sets the RecordingConfigurationArn field's value.
func (s *CreateChannelInput) SetTags(v map[string]*string) *CreateChannelInput
SetTags sets the Tags field's value.
func (s *CreateChannelInput) SetType(v string) *CreateChannelInput
SetType sets the Type field's value.
func (s CreateChannelInput) 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 CreateChannelOutput struct {
// Object specifying a channel.
Channel *Channel `locationName:"channel" type:"structure"`
// Object specifying a stream key.
StreamKey *StreamKey `locationName:"streamKey" type:"structure"`
// contains filtered or unexported fields
}
func (s CreateChannelOutput) 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 (s *CreateChannelOutput) SetChannel(v *Channel) *CreateChannelOutput
SetChannel sets the Channel field's value.
func (s *CreateChannelOutput) SetStreamKey(v *StreamKey) *CreateChannelOutput
SetStreamKey sets the StreamKey field's value.
func (s CreateChannelOutput) 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 CreatePlaybackRestrictionPolicyInput struct {
// A list of country codes that control geoblocking restriction. Allowed values
// are the officially assigned ISO 3166-1 alpha-2 (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
// codes. Default: All countries (an empty array).
AllowedCountries []*string `locationName:"allowedCountries" type:"list"`
// A list of origin sites that control CORS restriction. Allowed values are
// the same as valid values of the Origin header defined at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin
// (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin). Default:
// All origins (an empty array).
AllowedOrigins []*string `locationName:"allowedOrigins" type:"list"`
// Whether channel playback is constrained by origin site. Default: false.
EnableStrictOriginEnforcement *bool `locationName:"enableStrictOriginEnforcement" type:"boolean"`
// Playback-restriction-policy name. The value does not need to be unique.
Name *string `locationName:"name" type:"string"`
// Array of 1-50 maps, each of the form string:string (key:value). See Tagging
// Amazon Web Services 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 has no service-specific constraints
// beyond what is documented there.
Tags map[string]*string `locationName:"tags" type:"map"`
// contains filtered or unexported fields
}
func (s CreatePlaybackRestrictionPolicyInput) 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 (s *CreatePlaybackRestrictionPolicyInput) SetAllowedCountries(v []*string) *CreatePlaybackRestrictionPolicyInput
SetAllowedCountries sets the AllowedCountries field's value.
func (s *CreatePlaybackRestrictionPolicyInput) SetAllowedOrigins(v []*string) *CreatePlaybackRestrictionPolicyInput
SetAllowedOrigins sets the AllowedOrigins field's value.
func (s *CreatePlaybackRestrictionPolicyInput) SetEnableStrictOriginEnforcement(v bool) *CreatePlaybackRestrictionPolicyInput
SetEnableStrictOriginEnforcement sets the EnableStrictOriginEnforcement field's value.
func (s *CreatePlaybackRestrictionPolicyInput) SetName(v string) *CreatePlaybackRestrictionPolicyInput
SetName sets the Name field's value.
func (s *CreatePlaybackRestrictionPolicyInput) SetTags(v map[string]*string) *CreatePlaybackRestrictionPolicyInput
SetTags sets the Tags field's value.
func (s CreatePlaybackRestrictionPolicyInput) 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 CreatePlaybackRestrictionPolicyOutput struct {
// An object representing a policy to constrain playback by country and/or origin
// sites.
PlaybackRestrictionPolicy *PlaybackRestrictionPolicy `locationName:"playbackRestrictionPolicy" type:"structure"`
// contains filtered or unexported fields
}
func (s CreatePlaybackRestrictionPolicyOutput) 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 (s *CreatePlaybackRestrictionPolicyOutput) SetPlaybackRestrictionPolicy(v *PlaybackRestrictionPolicy) *CreatePlaybackRestrictionPolicyOutput
SetPlaybackRestrictionPolicy sets the PlaybackRestrictionPolicy field's value.
func (s CreatePlaybackRestrictionPolicyOutput) 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 CreateRecordingConfigurationInput struct {
// A complex type that contains a destination configuration for where recorded
// video will be stored.
//
// DestinationConfiguration is a required field
DestinationConfiguration *DestinationConfiguration `locationName:"destinationConfiguration" type:"structure" required:"true"`
// Recording-configuration name. The value does not need to be unique.
Name *string `locationName:"name" type:"string"`
// If a broadcast disconnects and then reconnects within the specified interval,
// the multiple streams will be considered a single broadcast and merged together.
// Default: 0.
RecordingReconnectWindowSeconds *int64 `locationName:"recordingReconnectWindowSeconds" type:"integer"`
// Object that describes which renditions should be recorded for a stream.
RenditionConfiguration *RenditionConfiguration `locationName:"renditionConfiguration" type:"structure"`
// Array of 1-50 maps, each of the form string:string (key:value). See Tagging
// Amazon Web Services 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 has no service-specific constraints
// beyond what is documented there.
Tags map[string]*string `locationName:"tags" type:"map"`
// A complex type that allows you to enable/disable the recording of thumbnails
// for a live session and modify the interval at which thumbnails are generated
// for the live session.
ThumbnailConfiguration *ThumbnailConfiguration `locationName:"thumbnailConfiguration" type:"structure"`
// contains filtered or unexported fields
}
func (s CreateRecordingConfigurationInput) 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 (s *CreateRecordingConfigurationInput) SetDestinationConfiguration(v *DestinationConfiguration) *CreateRecordingConfigurationInput
SetDestinationConfiguration sets the DestinationConfiguration field's value.
func (s *CreateRecordingConfigurationInput) SetName(v string) *CreateRecordingConfigurationInput
SetName sets the Name field's value.
func (s *CreateRecordingConfigurationInput) SetRecordingReconnectWindowSeconds(v int64) *CreateRecordingConfigurationInput
SetRecordingReconnectWindowSeconds sets the RecordingReconnectWindowSeconds field's value.
func (s *CreateRecordingConfigurationInput) SetRenditionConfiguration(v *RenditionConfiguration) *CreateRecordingConfigurationInput
SetRenditionConfiguration sets the RenditionConfiguration field's value.
func (s *CreateRecordingConfigurationInput) SetTags(v map[string]*string) *CreateRecordingConfigurationInput
SetTags sets the Tags field's value.
func (s *CreateRecordingConfigurationInput) SetThumbnailConfiguration(v *ThumbnailConfiguration) *CreateRecordingConfigurationInput
SetThumbnailConfiguration sets the ThumbnailConfiguration field's value.
func (s CreateRecordingConfigurationInput) 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 (s *CreateRecordingConfigurationInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateRecordingConfigurationOutput struct {
// An object representing a configuration to record a channel stream.
RecordingConfiguration *RecordingConfiguration `locationName:"recordingConfiguration" type:"structure"`
// contains filtered or unexported fields
}
func (s CreateRecordingConfigurationOutput) 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 (s *CreateRecordingConfigurationOutput) SetRecordingConfiguration(v *RecordingConfiguration) *CreateRecordingConfigurationOutput
SetRecordingConfiguration sets the RecordingConfiguration field's value.
func (s CreateRecordingConfigurationOutput) 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 CreateStreamKeyInput struct {
// ARN of the channel for which to create the stream key.
//
// ChannelArn is a required field
ChannelArn *string `locationName:"channelArn" min:"1" type:"string" required:"true"`
// Array of 1-50 maps, each of the form string:string (key:value). See Tagging
// Amazon Web Services 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 has no service-specific constraints
// beyond what is documented there.
Tags map[string]*string `locationName:"tags" type:"map"`
// contains filtered or unexported fields
}
func (s CreateStreamKeyInput) 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 (s *CreateStreamKeyInput) SetChannelArn(v string) *CreateStreamKeyInput
SetChannelArn sets the ChannelArn field's value.
func (s *CreateStreamKeyInput) SetTags(v map[string]*string) *CreateStreamKeyInput
SetTags sets the Tags field's value.
func (s CreateStreamKeyInput) 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 (s *CreateStreamKeyInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateStreamKeyOutput struct {
// Stream key used to authenticate an RTMPS stream for ingestion.
StreamKey *StreamKey `locationName:"streamKey" type:"structure"`
// contains filtered or unexported fields
}
func (s CreateStreamKeyOutput) 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 (s *CreateStreamKeyOutput) SetStreamKey(v *StreamKey) *CreateStreamKeyOutput
SetStreamKey sets the StreamKey field's value.
func (s CreateStreamKeyOutput) 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 DeleteChannelInput struct {
// ARN of the channel to be deleted.
//
// Arn is a required field
Arn *string `locationName:"arn" min:"1" type:"string" required:"true"`
// contains filtered or unexported fields
}
func (s DeleteChannelInput) 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 (s *DeleteChannelInput) SetArn(v string) *DeleteChannelInput
SetArn sets the Arn field's value.
func (s DeleteChannelInput) 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 (s *DeleteChannelInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteChannelOutput struct {
// contains filtered or unexported fields
}
func (s DeleteChannelOutput) 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 (s DeleteChannelOutput) 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 DeletePlaybackKeyPairInput struct {
// ARN of the key pair to be deleted.
//
// Arn is a required field
Arn *string `locationName:"arn" min:"1" type:"string" required:"true"`
// contains filtered or unexported fields
}
func (s DeletePlaybackKeyPairInput) 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 (s *DeletePlaybackKeyPairInput) SetArn(v string) *DeletePlaybackKeyPairInput
SetArn sets the Arn field's value.
func (s DeletePlaybackKeyPairInput) 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 (s *DeletePlaybackKeyPairInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeletePlaybackKeyPairOutput struct {
// contains filtered or unexported fields
}
func (s DeletePlaybackKeyPairOutput) 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 (s DeletePlaybackKeyPairOutput) 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 DeletePlaybackRestrictionPolicyInput struct {
// ARN of the playback restriction policy to be deleted.
//
// Arn is a required field
Arn *string `locationName:"arn" min:"1" type:"string" required:"true"`
// contains filtered or unexported fields
}
func (s DeletePlaybackRestrictionPolicyInput) 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 (s *DeletePlaybackRestrictionPolicyInput) SetArn(v string) *DeletePlaybackRestrictionPolicyInput
SetArn sets the Arn field's value.
func (s DeletePlaybackRestrictionPolicyInput) 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 (s *DeletePlaybackRestrictionPolicyInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeletePlaybackRestrictionPolicyOutput struct {
// contains filtered or unexported fields
}
func (s DeletePlaybackRestrictionPolicyOutput) 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 (s DeletePlaybackRestrictionPolicyOutput) 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 DeleteRecordingConfigurationInput struct {
// ARN of the recording configuration to be deleted.
//
// Arn is a required field
Arn *string `locationName:"arn" type:"string" required:"true"`
// contains filtered or unexported fields
}
func (s DeleteRecordingConfigurationInput) 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 (s *DeleteRecordingConfigurationInput) SetArn(v string) *DeleteRecordingConfigurationInput
SetArn sets the Arn field's value.
func (s DeleteRecordingConfigurationInput) 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 (s *DeleteRecordingConfigurationInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteRecordingConfigurationOutput struct {
// contains filtered or unexported fields
}
func (s DeleteRecordingConfigurationOutput) 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 (s DeleteRecordingConfigurationOutput) 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 DeleteStreamKeyInput struct {
// ARN of the stream key to be deleted.
//
// Arn is a required field
Arn *string `locationName:"arn" min:"1" type:"string" required:"true"`
// contains filtered or unexported fields
}
func (s DeleteStreamKeyInput) 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 (s *DeleteStreamKeyInput) SetArn(v string) *DeleteStreamKeyInput
SetArn sets the Arn field's value.
func (s DeleteStreamKeyInput) 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 (s *DeleteStreamKeyInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteStreamKeyOutput struct {
// contains filtered or unexported fields
}
func (s DeleteStreamKeyOutput) 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 (s DeleteStreamKeyOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DestinationConfiguration struct {
// An S3 destination configuration where recorded videos will be stored.
S3 *S3DestinationConfiguration `locationName:"s3" type:"structure"`
// contains filtered or unexported fields
}
A complex type that describes a location where recorded videos will be stored. Each member represents a type of destination configuration. For recording, you define one and only one type of destination configuration.
func (s DestinationConfiguration) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DestinationConfiguration) SetS3(v *S3DestinationConfiguration) *DestinationConfiguration
SetS3 sets the S3 field's value.
func (s DestinationConfiguration) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DestinationConfiguration) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetChannelInput struct {
// ARN of the channel for which the configuration 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 (s GetChannelInput) 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 (s *GetChannelInput) SetArn(v string) *GetChannelInput
SetArn sets the Arn field's value.
func (s GetChannelInput) 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 (s *GetChannelInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetChannelOutput struct {
// Object specifying a channel.
Channel *Channel `locationName:"channel" type:"structure"`
// contains filtered or unexported fields
}
func (s GetChannelOutput) 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 (s *GetChannelOutput) SetChannel(v *Channel) *GetChannelOutput
SetChannel sets the Channel field's value.
func (s GetChannelOutput) 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 GetPlaybackKeyPairInput struct {
// ARN of the key pair to be returned.
//
// Arn is a required field
Arn *string `locationName:"arn" min:"1" type:"string" required:"true"`
// contains filtered or unexported fields
}
func (s GetPlaybackKeyPairInput) 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 (s *GetPlaybackKeyPairInput) SetArn(v string) *GetPlaybackKeyPairInput
SetArn sets the Arn field's value.
func (s GetPlaybackKeyPairInput) 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 (s *GetPlaybackKeyPairInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetPlaybackKeyPairOutput struct {
// A key pair used to sign and validate a playback authorization token.
KeyPair *PlaybackKeyPair `locationName:"keyPair" type:"structure"`
// contains filtered or unexported fields
}
func (s GetPlaybackKeyPairOutput) 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 (s *GetPlaybackKeyPairOutput) SetKeyPair(v *PlaybackKeyPair) *GetPlaybackKeyPairOutput
SetKeyPair sets the KeyPair field's value.
func (s GetPlaybackKeyPairOutput) 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 GetPlaybackRestrictionPolicyInput struct {
// ARN of the playback restriction policy to be returned.
//
// Arn is a required field
Arn *string `locationName:"arn" min:"1" type:"string" required:"true"`
// contains filtered or unexported fields
}
func (s GetPlaybackRestrictionPolicyInput) 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 (s *GetPlaybackRestrictionPolicyInput) SetArn(v string) *GetPlaybackRestrictionPolicyInput
SetArn sets the Arn field's value.
func (s GetPlaybackRestrictionPolicyInput) 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 (s *GetPlaybackRestrictionPolicyInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetPlaybackRestrictionPolicyOutput struct {
// An object representing a policy to constrain playback by country and/or origin
// sites.
PlaybackRestrictionPolicy *PlaybackRestrictionPolicy `locationName:"playbackRestrictionPolicy" type:"structure"`
// contains filtered or unexported fields
}
func (s GetPlaybackRestrictionPolicyOutput) 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 (s *GetPlaybackRestrictionPolicyOutput) SetPlaybackRestrictionPolicy(v *PlaybackRestrictionPolicy) *GetPlaybackRestrictionPolicyOutput
SetPlaybackRestrictionPolicy sets the PlaybackRestrictionPolicy field's value.
func (s GetPlaybackRestrictionPolicyOutput) 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 GetRecordingConfigurationInput struct {
// ARN of the recording configuration to be retrieved.
//
// Arn is a required field
Arn *string `locationName:"arn" type:"string" required:"true"`
// contains filtered or unexported fields
}
func (s GetRecordingConfigurationInput) 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 (s *GetRecordingConfigurationInput) SetArn(v string) *GetRecordingConfigurationInput
SetArn sets the Arn field's value.
func (s GetRecordingConfigurationInput) 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 (s *GetRecordingConfigurationInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetRecordingConfigurationOutput struct {
// An object representing a configuration to record a channel stream.
RecordingConfiguration *RecordingConfiguration `locationName:"recordingConfiguration" type:"structure"`
// contains filtered or unexported fields
}
func (s GetRecordingConfigurationOutput) 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 (s *GetRecordingConfigurationOutput) SetRecordingConfiguration(v *RecordingConfiguration) *GetRecordingConfigurationOutput
SetRecordingConfiguration sets the RecordingConfiguration field's value.
func (s GetRecordingConfigurationOutput) 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 GetStreamInput struct {
// Channel ARN for stream to be accessed.
//
// ChannelArn is a required field
ChannelArn *string `locationName:"channelArn" min:"1" type:"string" required:"true"`
// contains filtered or unexported fields
}
func (s GetStreamInput) 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 (s *GetStreamInput) SetChannelArn(v string) *GetStreamInput
SetChannelArn sets the ChannelArn field's value.
func (s GetStreamInput) 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 (s *GetStreamInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetStreamKeyInput struct {
// ARN for the stream key to be retrieved.
//
// Arn is a required field
Arn *string `locationName:"arn" min:"1" type:"string" required:"true"`
// contains filtered or unexported fields
}
func (s GetStreamKeyInput) 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 (s *GetStreamKeyInput) SetArn(v string) *GetStreamKeyInput
SetArn sets the Arn field's value.
func (s GetStreamKeyInput) 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 (s *GetStreamKeyInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetStreamKeyOutput struct {
// Object specifying a stream key.
StreamKey *StreamKey `locationName:"streamKey" type:"structure"`
// contains filtered or unexported fields
}
func (s GetStreamKeyOutput) 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 (s *GetStreamKeyOutput) SetStreamKey(v *StreamKey) *GetStreamKeyOutput
SetStreamKey sets the StreamKey field's value.
func (s GetStreamKeyOutput) 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 GetStreamOutput struct {
// Specifies a live video stream that has been ingested and distributed.
Stream *Stream `locationName:"stream" type:"structure"`
// contains filtered or unexported fields
}
func (s GetStreamOutput) 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 (s *GetStreamOutput) SetStream(v *Stream) *GetStreamOutput
SetStream sets the Stream field's value.
func (s GetStreamOutput) 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 GetStreamSessionInput struct {
// ARN of the channel resource
//
// ChannelArn is a required field
ChannelArn *string `locationName:"channelArn" min:"1" type:"string" required:"true"`
// Unique identifier for a live or previously live stream in the specified channel.
// If no streamId is provided, this returns the most recent stream session for
// the channel, if it exists.
StreamId *string `locationName:"streamId" min:"26" type:"string"`
// contains filtered or unexported fields
}
func (s GetStreamSessionInput) 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 (s *GetStreamSessionInput) SetChannelArn(v string) *GetStreamSessionInput
SetChannelArn sets the ChannelArn field's value.
func (s *GetStreamSessionInput) SetStreamId(v string) *GetStreamSessionInput
SetStreamId sets the StreamId field's value.
func (s GetStreamSessionInput) 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 (s *GetStreamSessionInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetStreamSessionOutput struct {
// List of stream details.
StreamSession *StreamSession `locationName:"streamSession" type:"structure"`
// contains filtered or unexported fields
}
func (s GetStreamSessionOutput) 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 (s *GetStreamSessionOutput) SetStreamSession(v *StreamSession) *GetStreamSessionOutput
SetStreamSession sets the StreamSession field's value.
func (s GetStreamSessionOutput) 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 IVS struct {
*client.Client
}
IVS provides the API operation methods for making requests to Amazon Interactive Video Service. See this package's package overview docs for details on the service.
IVS methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.
func New(p client.ConfigProvider, cfgs ...*aws.Config) *IVS
New creates a new instance of the IVS 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 IVS client from just a session.
svc := ivs.New(mySession)
// Create a IVS client with additional configuration
svc := ivs.New(mySession, aws.NewConfig().WithRegion("us-west-2"))
func (c *IVS) BatchGetChannel(input *BatchGetChannelInput) (*BatchGetChannelOutput, error)
BatchGetChannel API operation for Amazon Interactive Video Service.
Performs GetChannel on multiple ARNs simultaneously.
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's API operation BatchGetChannel for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/BatchGetChannel
func (c *IVS) BatchGetChannelRequest(input *BatchGetChannelInput) (req *request.Request, output *BatchGetChannelOutput)
BatchGetChannelRequest generates a "aws/request.Request" representing the client's request for the BatchGetChannel 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 BatchGetChannel for more information on using the BatchGetChannel 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 BatchGetChannelRequest method.
req, resp := client.BatchGetChannelRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/BatchGetChannel
func (c *IVS) BatchGetChannelWithContext(ctx aws.Context, input *BatchGetChannelInput, opts ...request.Option) (*BatchGetChannelOutput, error)
BatchGetChannelWithContext is the same as BatchGetChannel with the addition of the ability to pass a context and additional request options.
See BatchGetChannel 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 (c *IVS) BatchGetStreamKey(input *BatchGetStreamKeyInput) (*BatchGetStreamKeyOutput, error)
BatchGetStreamKey API operation for Amazon Interactive Video Service.
Performs GetStreamKey on multiple ARNs simultaneously.
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's API operation BatchGetStreamKey for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/BatchGetStreamKey
func (c *IVS) BatchGetStreamKeyRequest(input *BatchGetStreamKeyInput) (req *request.Request, output *BatchGetStreamKeyOutput)
BatchGetStreamKeyRequest generates a "aws/request.Request" representing the client's request for the BatchGetStreamKey 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 BatchGetStreamKey for more information on using the BatchGetStreamKey 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 BatchGetStreamKeyRequest method.
req, resp := client.BatchGetStreamKeyRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/BatchGetStreamKey
func (c *IVS) BatchGetStreamKeyWithContext(ctx aws.Context, input *BatchGetStreamKeyInput, opts ...request.Option) (*BatchGetStreamKeyOutput, error)
BatchGetStreamKeyWithContext is the same as BatchGetStreamKey with the addition of the ability to pass a context and additional request options.
See BatchGetStreamKey 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 (c *IVS) BatchStartViewerSessionRevocation(input *BatchStartViewerSessionRevocationInput) (*BatchStartViewerSessionRevocationOutput, error)
BatchStartViewerSessionRevocation API operation for Amazon Interactive Video Service.
Performs StartViewerSessionRevocation on multiple channel ARN and viewer ID pairs simultaneously.
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's API operation BatchStartViewerSessionRevocation for usage and error information.
Returned Error Types:
AccessDeniedException
ValidationException
PendingVerification
ThrottlingException
See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/BatchStartViewerSessionRevocation
func (c *IVS) BatchStartViewerSessionRevocationRequest(input *BatchStartViewerSessionRevocationInput) (req *request.Request, output *BatchStartViewerSessionRevocationOutput)
BatchStartViewerSessionRevocationRequest generates a "aws/request.Request" representing the client's request for the BatchStartViewerSessionRevocation 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 BatchStartViewerSessionRevocation for more information on using the BatchStartViewerSessionRevocation 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 BatchStartViewerSessionRevocationRequest method.
req, resp := client.BatchStartViewerSessionRevocationRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/BatchStartViewerSessionRevocation
func (c *IVS) BatchStartViewerSessionRevocationWithContext(ctx aws.Context, input *BatchStartViewerSessionRevocationInput, opts ...request.Option) (*BatchStartViewerSessionRevocationOutput, error)
BatchStartViewerSessionRevocationWithContext is the same as BatchStartViewerSessionRevocation with the addition of the ability to pass a context and additional request options.
See BatchStartViewerSessionRevocation 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 (c *IVS) CreateChannel(input *CreateChannelInput) (*CreateChannelOutput, error)
CreateChannel API operation for Amazon Interactive Video Service.
Creates a new channel and an associated stream key to start streaming.
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's API operation CreateChannel for usage and error information.
Returned Error Types:
ResourceNotFoundException
AccessDeniedException
ValidationException
PendingVerification
ServiceQuotaExceededException
See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/CreateChannel
func (c *IVS) CreateChannelRequest(input *CreateChannelInput) (req *request.Request, output *CreateChannelOutput)
CreateChannelRequest generates a "aws/request.Request" representing the client's request for the CreateChannel 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 CreateChannel for more information on using the CreateChannel 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 CreateChannelRequest method.
req, resp := client.CreateChannelRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/CreateChannel
func (c *IVS) CreateChannelWithContext(ctx aws.Context, input *CreateChannelInput, opts ...request.Option) (*CreateChannelOutput, error)
CreateChannelWithContext is the same as CreateChannel with the addition of the ability to pass a context and additional request options.
See CreateChannel 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 (c *IVS) CreatePlaybackRestrictionPolicy(input *CreatePlaybackRestrictionPolicyInput) (*CreatePlaybackRestrictionPolicyOutput, error)
CreatePlaybackRestrictionPolicy API operation for Amazon Interactive Video Service.
Creates a new playback restriction policy, for constraining playback by countries and/or origins.
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's API operation CreatePlaybackRestrictionPolicy for usage and error information.
Returned Error Types:
AccessDeniedException
ValidationException
PendingVerification
ThrottlingException
ServiceQuotaExceededException
See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/CreatePlaybackRestrictionPolicy
func (c *IVS) CreatePlaybackRestrictionPolicyRequest(input *CreatePlaybackRestrictionPolicyInput) (req *request.Request, output *CreatePlaybackRestrictionPolicyOutput)
CreatePlaybackRestrictionPolicyRequest generates a "aws/request.Request" representing the client's request for the CreatePlaybackRestrictionPolicy 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 CreatePlaybackRestrictionPolicy for more information on using the CreatePlaybackRestrictionPolicy 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 CreatePlaybackRestrictionPolicyRequest method.
req, resp := client.CreatePlaybackRestrictionPolicyRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/CreatePlaybackRestrictionPolicy
func (c *IVS) CreatePlaybackRestrictionPolicyWithContext(ctx aws.Context, input *CreatePlaybackRestrictionPolicyInput, opts ...request.Option) (*CreatePlaybackRestrictionPolicyOutput, error)
CreatePlaybackRestrictionPolicyWithContext is the same as CreatePlaybackRestrictionPolicy with the addition of the ability to pass a context and additional request options.
See CreatePlaybackRestrictionPolicy 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 (c *IVS) CreateRecordingConfiguration(input *CreateRecordingConfigurationInput) (*CreateRecordingConfigurationOutput, error)
CreateRecordingConfiguration API operation for Amazon Interactive Video Service.
Creates a new recording configuration, used to enable recording to Amazon S3.
Known issue: In the us-east-1 region, if you use the Amazon Web Services CLI to create a recording configuration, it returns success even if the S3 bucket is in a different region. In this case, the state of the recording configuration is CREATE_FAILED (instead of ACTIVE). (In other regions, the CLI correctly returns failure if the bucket is in a different region.)
Workaround: Ensure that your S3 bucket is in the same region as the recording configuration. If you create a recording configuration in a different region as your S3 bucket, delete that recording configuration and create a new one with an S3 bucket from the correct region.
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's API operation CreateRecordingConfiguration for usage and error information.
Returned Error Types:
InternalServerException
AccessDeniedException
ValidationException
PendingVerification
ConflictException
ServiceQuotaExceededException
See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/CreateRecordingConfiguration
func (c *IVS) CreateRecordingConfigurationRequest(input *CreateRecordingConfigurationInput) (req *request.Request, output *CreateRecordingConfigurationOutput)
CreateRecordingConfigurationRequest generates a "aws/request.Request" representing the client's request for the CreateRecordingConfiguration 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 CreateRecordingConfiguration for more information on using the CreateRecordingConfiguration 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 CreateRecordingConfigurationRequest method.
req, resp := client.CreateRecordingConfigurationRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/CreateRecordingConfiguration
func (c *IVS) CreateRecordingConfigurationWithContext(ctx aws.Context, input *CreateRecordingConfigurationInput, opts ...request.Option) (*CreateRecordingConfigurationOutput, error)
CreateRecordingConfigurationWithContext is the same as CreateRecordingConfiguration with the addition of the ability to pass a context and additional request options.
See CreateRecordingConfiguration 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 (c *IVS) CreateStreamKey(input *CreateStreamKeyInput) (*CreateStreamKeyOutput, error)
CreateStreamKey API operation for Amazon Interactive Video Service.
Creates a stream key, used to initiate a stream, for the specified channel ARN.
Note that CreateChannel creates a stream key. If you subsequently use CreateStreamKey on the same channel, it will fail because a stream key already exists and there is a limit of 1 stream key per channel. To reset the stream key on a channel, use DeleteStreamKey and then CreateStreamKey.
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's API operation CreateStreamKey for usage and error information.
Returned Error Types:
ResourceNotFoundException
AccessDeniedException
ValidationException
PendingVerification
ServiceQuotaExceededException
See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/CreateStreamKey
func (c *IVS) CreateStreamKeyRequest(input *CreateStreamKeyInput) (req *request.Request, output *CreateStreamKeyOutput)
CreateStreamKeyRequest generates a "aws/request.Request" representing the client's request for the CreateStreamKey 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 CreateStreamKey for more information on using the CreateStreamKey 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 CreateStreamKeyRequest method.
req, resp := client.CreateStreamKeyRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/CreateStreamKey
func (c *IVS) CreateStreamKeyWithContext(ctx aws.Context, input *CreateStreamKeyInput, opts ...request.Option) (*CreateStreamKeyOutput, error)
CreateStreamKeyWithContext is the same as CreateStreamKey with the addition of the ability to pass a context and additional request options.
See CreateStreamKey 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 (c *IVS) DeleteChannel(input *DeleteChannelInput) (*DeleteChannelOutput, error)
DeleteChannel API operation for Amazon Interactive Video Service.
Deletes the specified channel and its associated stream keys.
If you try to delete a live channel, you will get an error (409 ConflictException). To delete a channel that is live, call StopStream, wait for the Amazon EventBridge "Stream End" event (to verify that the stream's state is no longer Live), then call DeleteChannel. (See Using EventBridge with Amazon IVS (https://docs.aws.amazon.com/ivs/latest/userguide/eventbridge.html).)
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's API operation DeleteChannel for usage and error information.
Returned Error Types:
ResourceNotFoundException
AccessDeniedException
ValidationException
PendingVerification
ConflictException
See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/DeleteChannel
func (c *IVS) DeleteChannelRequest(input *DeleteChannelInput) (req *request.Request, output *DeleteChannelOutput)
DeleteChannelRequest generates a "aws/request.Request" representing the client's request for the DeleteChannel 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 DeleteChannel for more information on using the DeleteChannel 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 DeleteChannelRequest method.
req, resp := client.DeleteChannelRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/DeleteChannel
func (c *IVS) DeleteChannelWithContext(ctx aws.Context, input *DeleteChannelInput, opts ...request.Option) (*DeleteChannelOutput, error)
DeleteChannelWithContext is the same as DeleteChannel with the addition of the ability to pass a context and additional request options.
See DeleteChannel 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 (c *IVS) DeletePlaybackKeyPair(input *DeletePlaybackKeyPairInput) (*DeletePlaybackKeyPairOutput, error)
DeletePlaybackKeyPair API operation for Amazon Interactive Video Service.
Deletes a specified authorization key pair. This invalidates future viewer tokens generated using the key pair’s privateKey. For more information, see Setting Up Private Channels (https://docs.aws.amazon.com/ivs/latest/userguide/private-channels.html) in the Amazon IVS User Guide.
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's API operation DeletePlaybackKeyPair for usage and error information.
Returned Error Types:
ResourceNotFoundException
AccessDeniedException
ValidationException
PendingVerification
See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/DeletePlaybackKeyPair
func (c *IVS) DeletePlaybackKeyPairRequest(input *DeletePlaybackKeyPairInput) (req *request.Request, output *DeletePlaybackKeyPairOutput)
DeletePlaybackKeyPairRequest generates a "aws/request.Request" representing the client's request for the DeletePlaybackKeyPair 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 DeletePlaybackKeyPair for more information on using the DeletePlaybackKeyPair 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 DeletePlaybackKeyPairRequest method.
req, resp := client.DeletePlaybackKeyPairRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/DeletePlaybackKeyPair
func (c *IVS) DeletePlaybackKeyPairWithContext(ctx aws.Context, input *DeletePlaybackKeyPairInput, opts ...request.Option) (*DeletePlaybackKeyPairOutput, error)
DeletePlaybackKeyPairWithContext is the same as DeletePlaybackKeyPair with the addition of the ability to pass a context and additional request options.
See DeletePlaybackKeyPair 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 (c *IVS) DeletePlaybackRestrictionPolicy(input *DeletePlaybackRestrictionPolicyInput) (*DeletePlaybackRestrictionPolicyOutput, error)
DeletePlaybackRestrictionPolicy API operation for Amazon Interactive Video Service.
Deletes the specified playback restriction policy.
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's API operation DeletePlaybackRestrictionPolicy for usage and error information.
Returned Error Types:
ResourceNotFoundException
AccessDeniedException
ValidationException
PendingVerification
ConflictException
See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/DeletePlaybackRestrictionPolicy
func (c *IVS) DeletePlaybackRestrictionPolicyRequest(input *DeletePlaybackRestrictionPolicyInput) (req *request.Request, output *DeletePlaybackRestrictionPolicyOutput)
DeletePlaybackRestrictionPolicyRequest generates a "aws/request.Request" representing the client's request for the DeletePlaybackRestrictionPolicy 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 DeletePlaybackRestrictionPolicy for more information on using the DeletePlaybackRestrictionPolicy 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 DeletePlaybackRestrictionPolicyRequest method.
req, resp := client.DeletePlaybackRestrictionPolicyRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/DeletePlaybackRestrictionPolicy
func (c *IVS) DeletePlaybackRestrictionPolicyWithContext(ctx aws.Context, input *DeletePlaybackRestrictionPolicyInput, opts ...request.Option) (*DeletePlaybackRestrictionPolicyOutput, error)
DeletePlaybackRestrictionPolicyWithContext is the same as DeletePlaybackRestrictionPolicy with the addition of the ability to pass a context and additional request options.
See DeletePlaybackRestrictionPolicy 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 (c *IVS) DeleteRecordingConfiguration(input *DeleteRecordingConfigurationInput) (*DeleteRecordingConfigurationOutput, error)
DeleteRecordingConfiguration API operation for Amazon Interactive Video Service.
Deletes the recording configuration for the specified ARN.
If you try to delete a recording configuration that is associated with a channel, you will get an error (409 ConflictException). To avoid this, for all channels that reference the recording configuration, first use UpdateChannel to set the recordingConfigurationArn field to an empty string, then use DeleteRecordingConfiguration.
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's API operation DeleteRecordingConfiguration for usage and error information.
Returned Error Types:
ResourceNotFoundException
InternalServerException
AccessDeniedException
ValidationException
ConflictException
See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/DeleteRecordingConfiguration
func (c *IVS) DeleteRecordingConfigurationRequest(input *DeleteRecordingConfigurationInput) (req *request.Request, output *DeleteRecordingConfigurationOutput)
DeleteRecordingConfigurationRequest generates a "aws/request.Request" representing the client's request for the DeleteRecordingConfiguration 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 DeleteRecordingConfiguration for more information on using the DeleteRecordingConfiguration 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 DeleteRecordingConfigurationRequest method.
req, resp := client.DeleteRecordingConfigurationRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/DeleteRecordingConfiguration
func (c *IVS) DeleteRecordingConfigurationWithContext(ctx aws.Context, input *DeleteRecordingConfigurationInput, opts ...request.Option) (*DeleteRecordingConfigurationOutput, error)
DeleteRecordingConfigurationWithContext is the same as DeleteRecordingConfiguration with the addition of the ability to pass a context and additional request options.
See DeleteRecordingConfiguration 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 (c *IVS) DeleteStreamKey(input *DeleteStreamKeyInput) (*DeleteStreamKeyOutput, error)
DeleteStreamKey API operation for Amazon Interactive Video Service.
Deletes the stream key for the specified ARN, so it can no longer be used to stream.
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's API operation DeleteStreamKey for usage and error information.
Returned Error Types:
ResourceNotFoundException
AccessDeniedException
ValidationException
PendingVerification
See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/DeleteStreamKey
func (c *IVS) DeleteStreamKeyRequest(input *DeleteStreamKeyInput) (req *request.Request, output *DeleteStreamKeyOutput)
DeleteStreamKeyRequest generates a "aws/request.Request" representing the client's request for the DeleteStreamKey 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 DeleteStreamKey for more information on using the DeleteStreamKey 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 DeleteStreamKeyRequest method.
req, resp := client.DeleteStreamKeyRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/DeleteStreamKey
func (c *IVS) DeleteStreamKeyWithContext(ctx aws.Context, input *DeleteStreamKeyInput, opts ...request.Option) (*DeleteStreamKeyOutput, error)
DeleteStreamKeyWithContext is the same as DeleteStreamKey with the addition of the ability to pass a context and additional request options.
See DeleteStreamKey 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 (c *IVS) GetChannel(input *GetChannelInput) (*GetChannelOutput, error)
GetChannel API operation for Amazon Interactive Video Service.
Gets the channel configuration for the specified channel ARN. See also BatchGetChannel.
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's API operation GetChannel for usage and error information.
Returned Error Types:
ResourceNotFoundException
AccessDeniedException
ValidationException
See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/GetChannel
func (c *IVS) GetChannelRequest(input *GetChannelInput) (req *request.Request, output *GetChannelOutput)
GetChannelRequest generates a "aws/request.Request" representing the client's request for the GetChannel 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 GetChannel for more information on using the GetChannel 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 GetChannelRequest method.
req, resp := client.GetChannelRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/GetChannel
func (c *IVS) GetChannelWithContext(ctx aws.Context, input *GetChannelInput, opts ...request.Option) (*GetChannelOutput, error)
GetChannelWithContext is the same as GetChannel with the addition of the ability to pass a context and additional request options.
See GetChannel 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 (c *IVS) GetPlaybackKeyPair(input *GetPlaybackKeyPairInput) (*GetPlaybackKeyPairOutput, error)
GetPlaybackKeyPair API operation for Amazon Interactive Video Service.
Gets a specified playback authorization key pair and returns the arn and fingerprint. The privateKey held by the caller can be used to generate viewer authorization tokens, to grant viewers access to private channels. For more information, see Setting Up Private Channels (https://docs.aws.amazon.com/ivs/latest/userguide/private-channels.html) in the Amazon IVS User Guide.
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's API operation GetPlaybackKeyPair for usage and error information.
Returned Error Types:
ResourceNotFoundException
AccessDeniedException
ValidationException
See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/GetPlaybackKeyPair
func (c *IVS) GetPlaybackKeyPairRequest(input *GetPlaybackKeyPairInput) (req *request.Request, output *GetPlaybackKeyPairOutput)
GetPlaybackKeyPairRequest generates a "aws/request.Request" representing the client's request for the GetPlaybackKeyPair 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 GetPlaybackKeyPair for more information on using the GetPlaybackKeyPair 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 GetPlaybackKeyPairRequest method.
req, resp := client.GetPlaybackKeyPairRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/GetPlaybackKeyPair
func (c *IVS) GetPlaybackKeyPairWithContext(ctx aws.Context, input *GetPlaybackKeyPairInput, opts ...request.Option) (*GetPlaybackKeyPairOutput, error)
GetPlaybackKeyPairWithContext is the same as GetPlaybackKeyPair with the addition of the ability to pass a context and additional request options.
See GetPlaybackKeyPair 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 (c *IVS) GetPlaybackRestrictionPolicy(input *GetPlaybackRestrictionPolicyInput) (*GetPlaybackRestrictionPolicyOutput, error)
GetPlaybackRestrictionPolicy API operation for Amazon Interactive Video Service.
Gets the specified playback restriction policy.
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's API operation GetPlaybackRestrictionPolicy for usage and error information.
Returned Error Types:
ResourceNotFoundException
AccessDeniedException
ValidationException
PendingVerification
See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/GetPlaybackRestrictionPolicy
func (c *IVS) GetPlaybackRestrictionPolicyRequest(input *GetPlaybackRestrictionPolicyInput) (req *request.Request, output *GetPlaybackRestrictionPolicyOutput)
GetPlaybackRestrictionPolicyRequest generates a "aws/request.Request" representing the client's request for the GetPlaybackRestrictionPolicy 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 GetPlaybackRestrictionPolicy for more information on using the GetPlaybackRestrictionPolicy 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 GetPlaybackRestrictionPolicyRequest method.
req, resp := client.GetPlaybackRestrictionPolicyRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/GetPlaybackRestrictionPolicy
func (c *IVS) GetPlaybackRestrictionPolicyWithContext(ctx aws.Context, input *GetPlaybackRestrictionPolicyInput, opts ...request.Option) (*GetPlaybackRestrictionPolicyOutput, error)
GetPlaybackRestrictionPolicyWithContext is the same as GetPlaybackRestrictionPolicy with the addition of the ability to pass a context and additional request options.
See GetPlaybackRestrictionPolicy 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 (c *IVS) GetRecordingConfiguration(input *GetRecordingConfigurationInput) (*GetRecordingConfigurationOutput, error)
GetRecordingConfiguration API operation for Amazon Interactive Video Service.
Gets the recording configuration for the specified ARN.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Interactive Video Service's API operation GetRecordingConfiguration for usage and error information.
Returned Error Types:
ResourceNotFoundException
InternalServerException
AccessDeniedException
ValidationException
See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/GetRecordingConfiguration
func (c *IVS) GetRecordingConfigurationRequest(input *GetRecordingConfigurationInput) (req *request.Request, output *GetRecordingConfigurationOutput)
GetRecordingConfigurationRequest generates a "aws/request.Request" representing the client's request for the GetRecordingConfiguration 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 GetRecordingConfiguration for more information on using the GetRecordingConfiguration 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 GetRecordingConfigurationRequest method.
req, resp := client.GetRecordingConfigurationRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/GetRecordingConfiguration
func (c *IVS) GetRecordingConfigurationWithContext(ctx aws.Context, input *GetRecordingConfigurationInput, opts ...request.Option) (*GetRecordingConfigurationOutput, error)
GetRecordingConfigurationWithContext is the same as GetRecordingConfiguration with the addition of the ability to pass a context and additional request options.
See GetRecordingConfiguration 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 (c *IVS) GetStream(input *GetStreamInput) (*GetStreamOutput, error)
GetStream API operation for Amazon Interactive Video Service.
Gets information about the active (live) stream on a specified channel.
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's API operation GetStream for usage and error information.
Returned Error Types:
ResourceNotFoundException
AccessDeniedException
ValidationException
ChannelNotBroadcasting
See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/GetStream
func (c *IVS) GetStreamKey(input *GetStreamKeyInput) (*GetStreamKeyOutput, error)
GetStreamKey API operation for Amazon Interactive Video Service.
Gets stream-key information for a 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's API operation GetStreamKey for usage and error information.
Returned Error Types:
ResourceNotFoundException
AccessDeniedException
ValidationException
See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/GetStreamKey
func (c *IVS) GetStreamKeyRequest(input *GetStreamKeyInput) (req *request.Request, output *GetStreamKeyOutput)
GetStreamKeyRequest generates a "aws/request.Request" representing the client's request for the GetStreamKey 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 GetStreamKey for more information on using the GetStreamKey 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 GetStreamKeyRequest method.
req, resp := client.GetStreamKeyRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/GetStreamKey
func (c *IVS) GetStreamKeyWithContext(ctx aws.Context, input *GetStreamKeyInput, opts ...request.Option) (*GetStreamKeyOutput, error)
GetStreamKeyWithContext is the same as GetStreamKey with the addition of the ability to pass a context and additional request options.
See GetStreamKey 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 (c *IVS) GetStreamRequest(input *GetStreamInput) (req *request.Request, output *GetStreamOutput)
GetStreamRequest generates a "aws/request.Request" representing the client's request for the GetStream 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 GetStream for more information on using the GetStream 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 GetStreamRequest method.
req, resp := client.GetStreamRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/GetStream
func (c *IVS) GetStreamSession(input *GetStreamSessionInput) (*GetStreamSessionOutput, error)
GetStreamSession API operation for Amazon Interactive Video Service.
Gets metadata on a specified stream.
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's API operation GetStreamSession for usage and error information.
Returned Error Types:
ResourceNotFoundException
AccessDeniedException
ValidationException
See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/GetStreamSession
func (c *IVS) GetStreamSessionRequest(input *GetStreamSessionInput) (req *request.Request, output *GetStreamSessionOutput)
GetStreamSessionRequest generates a "aws/request.Request" representing the client's request for the GetStreamSession 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 GetStreamSession for more information on using the GetStreamSession 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 GetStreamSessionRequest method.
req, resp := client.GetStreamSessionRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/GetStreamSession
func (c *IVS) GetStreamSessionWithContext(ctx aws.Context, input *GetStreamSessionInput, opts ...request.Option) (*GetStreamSessionOutput, error)
GetStreamSessionWithContext is the same as GetStreamSession with the addition of the ability to pass a context and additional request options.
See GetStreamSession 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 (c *IVS) GetStreamWithContext(ctx aws.Context, input *GetStreamInput, opts ...request.Option) (*GetStreamOutput, error)
GetStreamWithContext is the same as GetStream with the addition of the ability to pass a context and additional request options.
See GetStream 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 (c *IVS) ImportPlaybackKeyPair(input *ImportPlaybackKeyPairInput) (*ImportPlaybackKeyPairOutput, error)
ImportPlaybackKeyPair API operation for Amazon Interactive Video Service.
Imports the public portion of a new key pair and returns its arn and fingerprint. The privateKey can then be used to generate viewer authorization tokens, to grant viewers access to private channels. For more information, see Setting Up Private Channels (https://docs.aws.amazon.com/ivs/latest/userguide/private-channels.html) in the Amazon IVS User Guide.
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's API operation ImportPlaybackKeyPair for usage and error information.
Returned Error Types:
AccessDeniedException
ValidationException
PendingVerification
ConflictException
ServiceQuotaExceededException
See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ImportPlaybackKeyPair
func (c *IVS) ImportPlaybackKeyPairRequest(input *ImportPlaybackKeyPairInput) (req *request.Request, output *ImportPlaybackKeyPairOutput)
ImportPlaybackKeyPairRequest generates a "aws/request.Request" representing the client's request for the ImportPlaybackKeyPair 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 ImportPlaybackKeyPair for more information on using the ImportPlaybackKeyPair 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 ImportPlaybackKeyPairRequest method.
req, resp := client.ImportPlaybackKeyPairRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ImportPlaybackKeyPair
func (c *IVS) ImportPlaybackKeyPairWithContext(ctx aws.Context, input *ImportPlaybackKeyPairInput, opts ...request.Option) (*ImportPlaybackKeyPairOutput, error)
ImportPlaybackKeyPairWithContext is the same as ImportPlaybackKeyPair with the addition of the ability to pass a context and additional request options.
See ImportPlaybackKeyPair 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 (c *IVS) ListChannels(input *ListChannelsInput) (*ListChannelsOutput, error)
ListChannels API operation for Amazon Interactive Video Service.
Gets summary information about all channels in your account, in the Amazon Web Services region where the API request is processed. This list can be filtered to match a specified name or recording-configuration ARN. Filters are mutually exclusive and cannot be used together. If you try to use both filters, you will get an error (409 ConflictException).
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's API operation ListChannels for usage and error information.
Returned Error Types:
AccessDeniedException
ValidationException
ConflictException
See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListChannels
func (c *IVS) ListChannelsPages(input *ListChannelsInput, fn func(*ListChannelsOutput, bool) bool) error
ListChannelsPages iterates over the pages of a ListChannels operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See ListChannels 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 ListChannels operation.
pageNum := 0
err := client.ListChannelsPages(params,
func(page *ivs.ListChannelsOutput, lastPage bool) bool {
pageNum++
fmt.Println(page)
return pageNum <= 3
})
func (c *IVS) ListChannelsPagesWithContext(ctx aws.Context, input *ListChannelsInput, fn func(*ListChannelsOutput, bool) bool, opts ...request.Option) error
ListChannelsPagesWithContext same as ListChannelsPages 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 (c *IVS) ListChannelsRequest(input *ListChannelsInput) (req *request.Request, output *ListChannelsOutput)
ListChannelsRequest generates a "aws/request.Request" representing the client's request for the ListChannels 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 ListChannels for more information on using the ListChannels 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 ListChannelsRequest method.
req, resp := client.ListChannelsRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListChannels
func (c *IVS) ListChannelsWithContext(ctx aws.Context, input *ListChannelsInput, opts ...request.Option) (*ListChannelsOutput, error)
ListChannelsWithContext is the same as ListChannels with the addition of the ability to pass a context and additional request options.
See ListChannels 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 (c *IVS) ListPlaybackKeyPairs(input *ListPlaybackKeyPairsInput) (*ListPlaybackKeyPairsOutput, error)
ListPlaybackKeyPairs API operation for Amazon Interactive Video Service.
Gets summary information about playback key pairs. For more information, see Setting Up Private Channels (https://docs.aws.amazon.com/ivs/latest/userguide/private-channels.html) in the Amazon IVS User Guide.
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's API operation ListPlaybackKeyPairs for usage and error information.
Returned Error Types:
AccessDeniedException
ValidationException
See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListPlaybackKeyPairs
func (c *IVS) ListPlaybackKeyPairsPages(input *ListPlaybackKeyPairsInput, fn func(*ListPlaybackKeyPairsOutput, bool) bool) error
ListPlaybackKeyPairsPages iterates over the pages of a ListPlaybackKeyPairs operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See ListPlaybackKeyPairs 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 ListPlaybackKeyPairs operation.
pageNum := 0
err := client.ListPlaybackKeyPairsPages(params,
func(page *ivs.ListPlaybackKeyPairsOutput, lastPage bool) bool {
pageNum++
fmt.Println(page)
return pageNum <= 3
})
func (c *IVS) ListPlaybackKeyPairsPagesWithContext(ctx aws.Context, input *ListPlaybackKeyPairsInput, fn func(*ListPlaybackKeyPairsOutput, bool) bool, opts ...request.Option) error
ListPlaybackKeyPairsPagesWithContext same as ListPlaybackKeyPairsPages 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 (c *IVS) ListPlaybackKeyPairsRequest(input *ListPlaybackKeyPairsInput) (req *request.Request, output *ListPlaybackKeyPairsOutput)
ListPlaybackKeyPairsRequest generates a "aws/request.Request" representing the client's request for the ListPlaybackKeyPairs 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 ListPlaybackKeyPairs for more information on using the ListPlaybackKeyPairs 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 ListPlaybackKeyPairsRequest method.
req, resp := client.ListPlaybackKeyPairsRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListPlaybackKeyPairs
func (c *IVS) ListPlaybackKeyPairsWithContext(ctx aws.Context, input *ListPlaybackKeyPairsInput, opts ...request.Option) (*ListPlaybackKeyPairsOutput, error)
ListPlaybackKeyPairsWithContext is the same as ListPlaybackKeyPairs with the addition of the ability to pass a context and additional request options.
See ListPlaybackKeyPairs 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 (c *IVS) ListPlaybackRestrictionPolicies(input *ListPlaybackRestrictionPoliciesInput) (*ListPlaybackRestrictionPoliciesOutput, error)
ListPlaybackRestrictionPolicies API operation for Amazon Interactive Video Service.
Gets summary information about playback restriction policies.
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's API operation ListPlaybackRestrictionPolicies for usage and error information.
Returned Error Types:
AccessDeniedException
ValidationException
PendingVerification
ConflictException
See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListPlaybackRestrictionPolicies
func (c *IVS) ListPlaybackRestrictionPoliciesPages(input *ListPlaybackRestrictionPoliciesInput, fn func(*ListPlaybackRestrictionPoliciesOutput, bool) bool) error
ListPlaybackRestrictionPoliciesPages iterates over the pages of a ListPlaybackRestrictionPolicies operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See ListPlaybackRestrictionPolicies 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 ListPlaybackRestrictionPolicies operation.
pageNum := 0
err := client.ListPlaybackRestrictionPoliciesPages(params,
func(page *ivs.ListPlaybackRestrictionPoliciesOutput, lastPage bool) bool {
pageNum++
fmt.Println(page)
return pageNum <= 3
})
func (c *IVS) ListPlaybackRestrictionPoliciesPagesWithContext(ctx aws.Context, input *ListPlaybackRestrictionPoliciesInput, fn func(*ListPlaybackRestrictionPoliciesOutput, bool) bool, opts ...request.Option) error
ListPlaybackRestrictionPoliciesPagesWithContext same as ListPlaybackRestrictionPoliciesPages 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 (c *IVS) ListPlaybackRestrictionPoliciesRequest(input *ListPlaybackRestrictionPoliciesInput) (req *request.Request, output *ListPlaybackRestrictionPoliciesOutput)
ListPlaybackRestrictionPoliciesRequest generates a "aws/request.Request" representing the client's request for the ListPlaybackRestrictionPolicies 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 ListPlaybackRestrictionPolicies for more information on using the ListPlaybackRestrictionPolicies 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 ListPlaybackRestrictionPoliciesRequest method.
req, resp := client.ListPlaybackRestrictionPoliciesRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListPlaybackRestrictionPolicies
func (c *IVS) ListPlaybackRestrictionPoliciesWithContext(ctx aws.Context, input *ListPlaybackRestrictionPoliciesInput, opts ...request.Option) (*ListPlaybackRestrictionPoliciesOutput, error)
ListPlaybackRestrictionPoliciesWithContext is the same as ListPlaybackRestrictionPolicies with the addition of the ability to pass a context and additional request options.
See ListPlaybackRestrictionPolicies 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 (c *IVS) ListRecordingConfigurations(input *ListRecordingConfigurationsInput) (*ListRecordingConfigurationsOutput, error)
ListRecordingConfigurations API operation for Amazon Interactive Video Service.
Gets summary information about all recording configurations in your account, in the Amazon Web Services 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's API operation ListRecordingConfigurations for usage and error information.
Returned Error Types:
InternalServerException
AccessDeniedException
ValidationException
See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListRecordingConfigurations
func (c *IVS) ListRecordingConfigurationsPages(input *ListRecordingConfigurationsInput, fn func(*ListRecordingConfigurationsOutput, bool) bool) error
ListRecordingConfigurationsPages iterates over the pages of a ListRecordingConfigurations operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See ListRecordingConfigurations 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 ListRecordingConfigurations operation.
pageNum := 0
err := client.ListRecordingConfigurationsPages(params,
func(page *ivs.ListRecordingConfigurationsOutput, lastPage bool) bool {
pageNum++
fmt.Println(page)
return pageNum <= 3
})
func (c *IVS) ListRecordingConfigurationsPagesWithContext(ctx aws.Context, input *ListRecordingConfigurationsInput, fn func(*ListRecordingConfigurationsOutput, bool) bool, opts ...request.Option) error
ListRecordingConfigurationsPagesWithContext same as ListRecordingConfigurationsPages 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 (c *IVS) ListRecordingConfigurationsRequest(input *ListRecordingConfigurationsInput) (req *request.Request, output *ListRecordingConfigurationsOutput)
ListRecordingConfigurationsRequest generates a "aws/request.Request" representing the client's request for the ListRecordingConfigurations 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 ListRecordingConfigurations for more information on using the ListRecordingConfigurations 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 ListRecordingConfigurationsRequest method.
req, resp := client.ListRecordingConfigurationsRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListRecordingConfigurations
func (c *IVS) ListRecordingConfigurationsWithContext(ctx aws.Context, input *ListRecordingConfigurationsInput, opts ...request.Option) (*ListRecordingConfigurationsOutput, error)
ListRecordingConfigurationsWithContext is the same as ListRecordingConfigurations with the addition of the ability to pass a context and additional request options.
See ListRecordingConfigurations 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 (c *IVS) ListStreamKeys(input *ListStreamKeysInput) (*ListStreamKeysOutput, error)
ListStreamKeys API operation for Amazon Interactive Video Service.
Gets summary information about stream keys for the specified channel.
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's API operation ListStreamKeys for usage and error information.
Returned Error Types:
ResourceNotFoundException
AccessDeniedException
ValidationException
See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListStreamKeys
func (c *IVS) ListStreamKeysPages(input *ListStreamKeysInput, fn func(*ListStreamKeysOutput, bool) bool) error
ListStreamKeysPages iterates over the pages of a ListStreamKeys operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See ListStreamKeys 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 ListStreamKeys operation.
pageNum := 0
err := client.ListStreamKeysPages(params,
func(page *ivs.ListStreamKeysOutput, lastPage bool) bool {
pageNum++
fmt.Println(page)
return pageNum <= 3
})
func (c *IVS) ListStreamKeysPagesWithContext(ctx aws.Context, input *ListStreamKeysInput, fn func(*ListStreamKeysOutput, bool) bool, opts ...request.Option) error
ListStreamKeysPagesWithContext same as ListStreamKeysPages 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 (c *IVS) ListStreamKeysRequest(input *ListStreamKeysInput) (req *request.Request, output *ListStreamKeysOutput)
ListStreamKeysRequest generates a "aws/request.Request" representing the client's request for the ListStreamKeys 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 ListStreamKeys for more information on using the ListStreamKeys 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 ListStreamKeysRequest method.
req, resp := client.ListStreamKeysRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListStreamKeys
func (c *IVS) ListStreamKeysWithContext(ctx aws.Context, input *ListStreamKeysInput, opts ...request.Option) (*ListStreamKeysOutput, error)
ListStreamKeysWithContext is the same as ListStreamKeys with the addition of the ability to pass a context and additional request options.
See ListStreamKeys 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 (c *IVS) ListStreamSessions(input *ListStreamSessionsInput) (*ListStreamSessionsOutput, error)
ListStreamSessions API operation for Amazon Interactive Video Service.
Gets a summary of current and previous streams for a specified channel 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's API operation ListStreamSessions for usage and error information.
Returned Error Types:
ResourceNotFoundException
AccessDeniedException
ValidationException
See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListStreamSessions
func (c *IVS) ListStreamSessionsPages(input *ListStreamSessionsInput, fn func(*ListStreamSessionsOutput, bool) bool) error
ListStreamSessionsPages iterates over the pages of a ListStreamSessions operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See ListStreamSessions 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 ListStreamSessions operation.
pageNum := 0
err := client.ListStreamSessionsPages(params,
func(page *ivs.ListStreamSessionsOutput, lastPage bool) bool {
pageNum++
fmt.Println(page)
return pageNum <= 3
})
func (c *IVS) ListStreamSessionsPagesWithContext(ctx aws.Context, input *ListStreamSessionsInput, fn func(*ListStreamSessionsOutput, bool) bool, opts ...request.Option) error
ListStreamSessionsPagesWithContext same as ListStreamSessionsPages 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 (c *IVS) ListStreamSessionsRequest(input *ListStreamSessionsInput) (req *request.Request, output *ListStreamSessionsOutput)
ListStreamSessionsRequest generates a "aws/request.Request" representing the client's request for the ListStreamSessions 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 ListStreamSessions for more information on using the ListStreamSessions 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 ListStreamSessionsRequest method.
req, resp := client.ListStreamSessionsRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListStreamSessions
func (c *IVS) ListStreamSessionsWithContext(ctx aws.Context, input *ListStreamSessionsInput, opts ...request.Option) (*ListStreamSessionsOutput, error)
ListStreamSessionsWithContext is the same as ListStreamSessions with the addition of the ability to pass a context and additional request options.
See ListStreamSessions 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 (c *IVS) ListStreams(input *ListStreamsInput) (*ListStreamsOutput, error)
ListStreams API operation for Amazon Interactive Video Service.
Gets summary information about live streams in your account, in the Amazon Web Services 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's API operation ListStreams for usage and error information.
Returned Error Types:
AccessDeniedException
ValidationException
See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListStreams
func (c *IVS) ListStreamsPages(input *ListStreamsInput, fn func(*ListStreamsOutput, bool) bool) error
ListStreamsPages iterates over the pages of a ListStreams operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See ListStreams 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 ListStreams operation.
pageNum := 0
err := client.ListStreamsPages(params,
func(page *ivs.ListStreamsOutput, lastPage bool) bool {
pageNum++
fmt.Println(page)
return pageNum <= 3
})
func (c *IVS) ListStreamsPagesWithContext(ctx aws.Context, input *ListStreamsInput, fn func(*ListStreamsOutput, bool) bool, opts ...request.Option) error
ListStreamsPagesWithContext same as ListStreamsPages 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 (c *IVS) ListStreamsRequest(input *ListStreamsInput) (req *request.Request, output *ListStreamsOutput)
ListStreamsRequest generates a "aws/request.Request" representing the client's request for the ListStreams 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 ListStreams for more information on using the ListStreams 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 ListStreamsRequest method.
req, resp := client.ListStreamsRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListStreams
func (c *IVS) ListStreamsWithContext(ctx aws.Context, input *ListStreamsInput, opts ...request.Option) (*ListStreamsOutput, error)
ListStreamsWithContext is the same as ListStreams with the addition of the ability to pass a context and additional request options.
See ListStreams 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 (c *IVS) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)
ListTagsForResource API operation for Amazon Interactive Video Service.
Gets information about Amazon Web Services 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's API operation ListTagsForResource for usage and error information.
Returned Error Types:
ResourceNotFoundException
InternalServerException
ValidationException
See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListTagsForResource
func (c *IVS) 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-2020-07-14/ListTagsForResource
func (c *IVS) 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 (c *IVS) PutMetadata(input *PutMetadataInput) (*PutMetadataOutput, error)
PutMetadata API operation for Amazon Interactive Video Service.
Inserts metadata into the active stream of the specified channel. At most 5 requests per second per channel are allowed, each with a maximum 1 KB payload. (If 5 TPS is not sufficient for your needs, we recommend batching your data into a single PutMetadata call.) At most 155 requests per second per account are allowed. Also see Embedding Metadata within a Video Stream (https://docs.aws.amazon.com/ivs/latest/userguide/metadata.html) in the Amazon IVS User Guide.
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's API operation PutMetadata for usage and error information.
Returned Error Types:
ResourceNotFoundException
AccessDeniedException
ValidationException
ChannelNotBroadcasting
ThrottlingException
See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/PutMetadata
func (c *IVS) PutMetadataRequest(input *PutMetadataInput) (req *request.Request, output *PutMetadataOutput)
PutMetadataRequest generates a "aws/request.Request" representing the client's request for the PutMetadata 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 PutMetadata for more information on using the PutMetadata 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 PutMetadataRequest method.
req, resp := client.PutMetadataRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/PutMetadata
func (c *IVS) PutMetadataWithContext(ctx aws.Context, input *PutMetadataInput, opts ...request.Option) (*PutMetadataOutput, error)
PutMetadataWithContext is the same as PutMetadata with the addition of the ability to pass a context and additional request options.
See PutMetadata 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 (c *IVS) StartViewerSessionRevocation(input *StartViewerSessionRevocationInput) (*StartViewerSessionRevocationOutput, error)
StartViewerSessionRevocation API operation for Amazon Interactive Video Service.
Starts the process of revoking the viewer session associated with a specified channel ARN and viewer ID. Optionally, you can provide a version to revoke viewer sessions less than and including that version. For instructions on associating a viewer ID with a viewer session, see Setting Up Private Channels (https://docs.aws.amazon.com/ivs/latest/userguide/private-channels.html).
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's API operation StartViewerSessionRevocation for usage and error information.
Returned Error Types:
ResourceNotFoundException
InternalServerException
AccessDeniedException
ValidationException
PendingVerification
ThrottlingException
See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/StartViewerSessionRevocation
func (c *IVS) StartViewerSessionRevocationRequest(input *StartViewerSessionRevocationInput) (req *request.Request, output *StartViewerSessionRevocationOutput)
StartViewerSessionRevocationRequest generates a "aws/request.Request" representing the client's request for the StartViewerSessionRevocation 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 StartViewerSessionRevocation for more information on using the StartViewerSessionRevocation 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 StartViewerSessionRevocationRequest method.
req, resp := client.StartViewerSessionRevocationRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/StartViewerSessionRevocation
func (c *IVS) StartViewerSessionRevocationWithContext(ctx aws.Context, input *StartViewerSessionRevocationInput, opts ...request.Option) (*StartViewerSessionRevocationOutput, error)
StartViewerSessionRevocationWithContext is the same as StartViewerSessionRevocation with the addition of the ability to pass a context and additional request options.
See StartViewerSessionRevocation 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 (c *IVS) StopStream(input *StopStreamInput) (*StopStreamOutput, error)
StopStream API operation for Amazon Interactive Video Service.
Disconnects the incoming RTMPS stream for the specified channel. Can be used in conjunction with DeleteStreamKey to prevent further streaming to a channel.
Many streaming client-software libraries automatically reconnect a dropped RTMPS session, so to stop the stream permanently, you may want to first revoke the streamKey attached to the channel.
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's API operation StopStream for usage and error information.
Returned Error Types:
ResourceNotFoundException
AccessDeniedException
ValidationException
ChannelNotBroadcasting
StreamUnavailable
See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/StopStream
func (c *IVS) StopStreamRequest(input *StopStreamInput) (req *request.Request, output *StopStreamOutput)
StopStreamRequest generates a "aws/request.Request" representing the client's request for the StopStream 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 StopStream for more information on using the StopStream 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 StopStreamRequest method.
req, resp := client.StopStreamRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/StopStream
func (c *IVS) StopStreamWithContext(ctx aws.Context, input *StopStreamInput, opts ...request.Option) (*StopStreamOutput, error)
StopStreamWithContext is the same as StopStream with the addition of the ability to pass a context and additional request options.
See StopStream 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 (c *IVS) TagResource(input *TagResourceInput) (*TagResourceOutput, error)
TagResource API operation for Amazon Interactive Video Service.
Adds or updates tags for the Amazon Web Services 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's API operation TagResource for usage and error information.
Returned Error Types:
ResourceNotFoundException
InternalServerException
ValidationException
See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/TagResource
func (c *IVS) 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-2020-07-14/TagResource
func (c *IVS) 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 (c *IVS) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)
UntagResource API operation for Amazon Interactive Video Service.
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's API operation UntagResource for usage and error information.
Returned Error Types:
ResourceNotFoundException
InternalServerException
ValidationException
See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/UntagResource
func (c *IVS) 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-2020-07-14/UntagResource
func (c *IVS) 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 (c *IVS) UpdateChannel(input *UpdateChannelInput) (*UpdateChannelOutput, error)
UpdateChannel API operation for Amazon Interactive Video Service.
Updates a channel's configuration. Live channels cannot be updated. You must stop the ongoing stream, update the channel, and restart the stream for the changes to take effect.
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's API operation UpdateChannel for usage and error information.
Returned Error Types:
ResourceNotFoundException
AccessDeniedException
ValidationException
PendingVerification
ConflictException
See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/UpdateChannel
func (c *IVS) UpdateChannelRequest(input *UpdateChannelInput) (req *request.Request, output *UpdateChannelOutput)
UpdateChannelRequest generates a "aws/request.Request" representing the client's request for the UpdateChannel 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 UpdateChannel for more information on using the UpdateChannel 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 UpdateChannelRequest method.
req, resp := client.UpdateChannelRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/UpdateChannel
func (c *IVS) UpdateChannelWithContext(ctx aws.Context, input *UpdateChannelInput, opts ...request.Option) (*UpdateChannelOutput, error)
UpdateChannelWithContext is the same as UpdateChannel with the addition of the ability to pass a context and additional request options.
See UpdateChannel 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 (c *IVS) UpdatePlaybackRestrictionPolicy(input *UpdatePlaybackRestrictionPolicyInput) (*UpdatePlaybackRestrictionPolicyOutput, error)
UpdatePlaybackRestrictionPolicy API operation for Amazon Interactive Video Service.
Updates a specified playback restriction policy.
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's API operation UpdatePlaybackRestrictionPolicy for usage and error information.
Returned Error Types:
ResourceNotFoundException
AccessDeniedException
ValidationException
PendingVerification
ConflictException
See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/UpdatePlaybackRestrictionPolicy
func (c *IVS) UpdatePlaybackRestrictionPolicyRequest(input *UpdatePlaybackRestrictionPolicyInput) (req *request.Request, output *UpdatePlaybackRestrictionPolicyOutput)
UpdatePlaybackRestrictionPolicyRequest generates a "aws/request.Request" representing the client's request for the UpdatePlaybackRestrictionPolicy 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 UpdatePlaybackRestrictionPolicy for more information on using the UpdatePlaybackRestrictionPolicy 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 UpdatePlaybackRestrictionPolicyRequest method.
req, resp := client.UpdatePlaybackRestrictionPolicyRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/UpdatePlaybackRestrictionPolicy
func (c *IVS) UpdatePlaybackRestrictionPolicyWithContext(ctx aws.Context, input *UpdatePlaybackRestrictionPolicyInput, opts ...request.Option) (*UpdatePlaybackRestrictionPolicyOutput, error)
UpdatePlaybackRestrictionPolicyWithContext is the same as UpdatePlaybackRestrictionPolicy with the addition of the ability to pass a context and additional request options.
See UpdatePlaybackRestrictionPolicy 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 ImportPlaybackKeyPairInput struct {
// Playback-key-pair name. The value does not need to be unique.
Name *string `locationName:"name" type:"string"`
// The public portion of a customer-generated key pair.
//
// PublicKeyMaterial is a required field
PublicKeyMaterial *string `locationName:"publicKeyMaterial" type:"string" required:"true"`
// Any tags provided with the request are added to the playback key pair tags.
// See Tagging Amazon Web Services 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 has no service-specific constraints
// beyond what is documented there.
Tags map[string]*string `locationName:"tags" type:"map"`
// contains filtered or unexported fields
}
func (s ImportPlaybackKeyPairInput) 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 (s *ImportPlaybackKeyPairInput) SetName(v string) *ImportPlaybackKeyPairInput
SetName sets the Name field's value.
func (s *ImportPlaybackKeyPairInput) SetPublicKeyMaterial(v string) *ImportPlaybackKeyPairInput
SetPublicKeyMaterial sets the PublicKeyMaterial field's value.
func (s *ImportPlaybackKeyPairInput) SetTags(v map[string]*string) *ImportPlaybackKeyPairInput
SetTags sets the Tags field's value.
func (s ImportPlaybackKeyPairInput) 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 (s *ImportPlaybackKeyPairInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ImportPlaybackKeyPairOutput struct {
// A key pair used to sign and validate a playback authorization token.
KeyPair *PlaybackKeyPair `locationName:"keyPair" type:"structure"`
// contains filtered or unexported fields
}
func (s ImportPlaybackKeyPairOutput) 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 (s *ImportPlaybackKeyPairOutput) SetKeyPair(v *PlaybackKeyPair) *ImportPlaybackKeyPairOutput
SetKeyPair sets the KeyPair field's value.
func (s ImportPlaybackKeyPairOutput) 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 IngestConfiguration struct {
// Encoder settings for audio.
Audio *AudioConfiguration `locationName:"audio" type:"structure"`
// Encoder settings for video.
Video *VideoConfiguration `locationName:"video" type:"structure"`
// contains filtered or unexported fields
}
Object specifying the ingest configuration set up by the broadcaster, usually in an encoder.
func (s IngestConfiguration) 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 (s *IngestConfiguration) SetAudio(v *AudioConfiguration) *IngestConfiguration
SetAudio sets the Audio field's value.
func (s *IngestConfiguration) SetVideo(v *VideoConfiguration) *IngestConfiguration
SetVideo sets the Video field's value.
func (s IngestConfiguration) 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 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 (s *InternalServerException) Code() string
Code returns the exception type name.
func (s *InternalServerException) Error() string
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 (s *InternalServerException) Message() string
Message returns the exception's message.
func (s *InternalServerException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *InternalServerException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *InternalServerException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
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 ListChannelsInput struct {
// Filters the channel list to match the specified name.
FilterByName *string `locationName:"filterByName" type:"string"`
// Filters the channel list to match the specified policy.
FilterByPlaybackRestrictionPolicyArn *string `locationName:"filterByPlaybackRestrictionPolicyArn" type:"string"`
// Filters the channel list to match the specified recording-configuration ARN.
FilterByRecordingConfigurationArn *string `locationName:"filterByRecordingConfigurationArn" type:"string"`
// Maximum number of channels to return. Default: 100.
MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"`
// The first channel to retrieve. This is used for pagination; see the nextToken
// response field.
NextToken *string `locationName:"nextToken" type:"string"`
// contains filtered or unexported fields
}
func (s ListChannelsInput) 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 (s *ListChannelsInput) SetFilterByName(v string) *ListChannelsInput
SetFilterByName sets the FilterByName field's value.
func (s *ListChannelsInput) SetFilterByPlaybackRestrictionPolicyArn(v string) *ListChannelsInput
SetFilterByPlaybackRestrictionPolicyArn sets the FilterByPlaybackRestrictionPolicyArn field's value.
func (s *ListChannelsInput) SetFilterByRecordingConfigurationArn(v string) *ListChannelsInput
SetFilterByRecordingConfigurationArn sets the FilterByRecordingConfigurationArn field's value.
func (s *ListChannelsInput) SetMaxResults(v int64) *ListChannelsInput
SetMaxResults sets the MaxResults field's value.
func (s *ListChannelsInput) SetNextToken(v string) *ListChannelsInput
SetNextToken sets the NextToken field's value.
func (s ListChannelsInput) 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 (s *ListChannelsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListChannelsOutput struct {
// List of the matching channels.
//
// Channels is a required field
Channels []*ChannelSummary `locationName:"channels" type:"list" required:"true"`
// If there are more channels than maxResults, use nextToken in the request
// to get the next set.
NextToken *string `locationName:"nextToken" type:"string"`
// contains filtered or unexported fields
}
func (s ListChannelsOutput) 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 (s *ListChannelsOutput) SetChannels(v []*ChannelSummary) *ListChannelsOutput
SetChannels sets the Channels field's value.
func (s *ListChannelsOutput) SetNextToken(v string) *ListChannelsOutput
SetNextToken sets the NextToken field's value.
func (s ListChannelsOutput) 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 ListPlaybackKeyPairsInput struct {
// Maximum number of key pairs to return. Default: your service quota or 100,
// whichever is smaller.
MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"`
// The first key pair to retrieve. This is used for pagination; see the nextToken
// response field.
NextToken *string `locationName:"nextToken" type:"string"`
// contains filtered or unexported fields
}
func (s ListPlaybackKeyPairsInput) 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 (s *ListPlaybackKeyPairsInput) SetMaxResults(v int64) *ListPlaybackKeyPairsInput
SetMaxResults sets the MaxResults field's value.
func (s *ListPlaybackKeyPairsInput) SetNextToken(v string) *ListPlaybackKeyPairsInput
SetNextToken sets the NextToken field's value.
func (s ListPlaybackKeyPairsInput) 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 (s *ListPlaybackKeyPairsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListPlaybackKeyPairsOutput struct {
// List of key pairs.
//
// KeyPairs is a required field
KeyPairs []*PlaybackKeyPairSummary `locationName:"keyPairs" type:"list" required:"true"`
// If there are more key pairs than maxResults, use nextToken in the request
// to get the next set.
NextToken *string `locationName:"nextToken" type:"string"`
// contains filtered or unexported fields
}
func (s ListPlaybackKeyPairsOutput) 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 (s *ListPlaybackKeyPairsOutput) SetKeyPairs(v []*PlaybackKeyPairSummary) *ListPlaybackKeyPairsOutput
SetKeyPairs sets the KeyPairs field's value.
func (s *ListPlaybackKeyPairsOutput) SetNextToken(v string) *ListPlaybackKeyPairsOutput
SetNextToken sets the NextToken field's value.
func (s ListPlaybackKeyPairsOutput) 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 ListPlaybackRestrictionPoliciesInput struct {
// Maximum number of policies to return. Default: 1.
MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"`
// The first policy to retrieve. This is used for pagination; see the nextToken
// response field.
NextToken *string `locationName:"nextToken" type:"string"`
// contains filtered or unexported fields
}
func (s ListPlaybackRestrictionPoliciesInput) 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 (s *ListPlaybackRestrictionPoliciesInput) SetMaxResults(v int64) *ListPlaybackRestrictionPoliciesInput
SetMaxResults sets the MaxResults field's value.
func (s *ListPlaybackRestrictionPoliciesInput) SetNextToken(v string) *ListPlaybackRestrictionPoliciesInput
SetNextToken sets the NextToken field's value.
func (s ListPlaybackRestrictionPoliciesInput) 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 (s *ListPlaybackRestrictionPoliciesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListPlaybackRestrictionPoliciesOutput struct {
// If there are more channels than maxResults, use nextToken in the request
// to get the next set.
NextToken *string `locationName:"nextToken" type:"string"`
// List of the matching policies.
//
// PlaybackRestrictionPolicies is a required field
PlaybackRestrictionPolicies []*PlaybackRestrictionPolicySummary `locationName:"playbackRestrictionPolicies" type:"list" required:"true"`
// contains filtered or unexported fields
}
func (s ListPlaybackRestrictionPoliciesOutput) 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 (s *ListPlaybackRestrictionPoliciesOutput) SetNextToken(v string) *ListPlaybackRestrictionPoliciesOutput
SetNextToken sets the NextToken field's value.
func (s *ListPlaybackRestrictionPoliciesOutput) SetPlaybackRestrictionPolicies(v []*PlaybackRestrictionPolicySummary) *ListPlaybackRestrictionPoliciesOutput
SetPlaybackRestrictionPolicies sets the PlaybackRestrictionPolicies field's value.
func (s ListPlaybackRestrictionPoliciesOutput) 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 ListRecordingConfigurationsInput struct {
// Maximum number of recording configurations to return. Default: your service
// quota or 100, whichever is smaller.
MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"`
// The first recording configuration to retrieve. This is used for pagination;
// see the nextToken response field.
NextToken *string `locationName:"nextToken" type:"string"`
// contains filtered or unexported fields
}
func (s ListRecordingConfigurationsInput) 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 (s *ListRecordingConfigurationsInput) SetMaxResults(v int64) *ListRecordingConfigurationsInput
SetMaxResults sets the MaxResults field's value.
func (s *ListRecordingConfigurationsInput) SetNextToken(v string) *ListRecordingConfigurationsInput
SetNextToken sets the NextToken field's value.
func (s ListRecordingConfigurationsInput) 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 (s *ListRecordingConfigurationsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListRecordingConfigurationsOutput struct {
// If there are more recording configurations than maxResults, use nextToken
// in the request to get the next set.
NextToken *string `locationName:"nextToken" type:"string"`
// List of the matching recording configurations.
//
// RecordingConfigurations is a required field
RecordingConfigurations []*RecordingConfigurationSummary `locationName:"recordingConfigurations" type:"list" required:"true"`
// contains filtered or unexported fields
}
func (s ListRecordingConfigurationsOutput) 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 (s *ListRecordingConfigurationsOutput) SetNextToken(v string) *ListRecordingConfigurationsOutput
SetNextToken sets the NextToken field's value.
func (s *ListRecordingConfigurationsOutput) SetRecordingConfigurations(v []*RecordingConfigurationSummary) *ListRecordingConfigurationsOutput
SetRecordingConfigurations sets the RecordingConfigurations field's value.
func (s ListRecordingConfigurationsOutput) 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 ListStreamKeysInput struct {
// Channel ARN used to filter the list.
//
// ChannelArn is a required field
ChannelArn *string `locationName:"channelArn" min:"1" type:"string" required:"true"`
// Maximum number of streamKeys to return. Default: 1.
MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"`
// The first stream key to retrieve. This is used for pagination; see the nextToken
// response field.
NextToken *string `locationName:"nextToken" type:"string"`
// contains filtered or unexported fields
}
func (s ListStreamKeysInput) 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 (s *ListStreamKeysInput) SetChannelArn(v string) *ListStreamKeysInput
SetChannelArn sets the ChannelArn field's value.
func (s *ListStreamKeysInput) SetMaxResults(v int64) *ListStreamKeysInput
SetMaxResults sets the MaxResults field's value.
func (s *ListStreamKeysInput) SetNextToken(v string) *ListStreamKeysInput
SetNextToken sets the NextToken field's value.
func (s ListStreamKeysInput) 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 (s *ListStreamKeysInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListStreamKeysOutput struct {
// If there are more stream keys than maxResults, use nextToken in the request
// to get the next set.
NextToken *string `locationName:"nextToken" type:"string"`
// List of stream keys.
//
// StreamKeys is a required field
StreamKeys []*StreamKeySummary `locationName:"streamKeys" type:"list" required:"true"`
// contains filtered or unexported fields
}
func (s ListStreamKeysOutput) 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 (s *ListStreamKeysOutput) SetNextToken(v string) *ListStreamKeysOutput
SetNextToken sets the NextToken field's value.
func (s *ListStreamKeysOutput) SetStreamKeys(v []*StreamKeySummary) *ListStreamKeysOutput
SetStreamKeys sets the StreamKeys field's value.
func (s ListStreamKeysOutput) 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 ListStreamSessionsInput struct {
// Channel ARN used to filter the list.
//
// ChannelArn is a required field
ChannelArn *string `locationName:"channelArn" min:"1" type:"string" required:"true"`
// Maximum number of streams to return. Default: 100.
MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"`
// The first stream to retrieve. This is used for pagination; see the nextToken
// response field.
NextToken *string `locationName:"nextToken" type:"string"`
// contains filtered or unexported fields
}
func (s ListStreamSessionsInput) 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 (s *ListStreamSessionsInput) SetChannelArn(v string) *ListStreamSessionsInput
SetChannelArn sets the ChannelArn field's value.
func (s *ListStreamSessionsInput) SetMaxResults(v int64) *ListStreamSessionsInput
SetMaxResults sets the MaxResults field's value.
func (s *ListStreamSessionsInput) SetNextToken(v string) *ListStreamSessionsInput
SetNextToken sets the NextToken field's value.
func (s ListStreamSessionsInput) 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 (s *ListStreamSessionsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListStreamSessionsOutput struct {
// If there are more streams than maxResults, use nextToken in the request to
// get the next set.
NextToken *string `locationName:"nextToken" type:"string"`
// List of stream sessions.
//
// StreamSessions is a required field
StreamSessions []*StreamSessionSummary `locationName:"streamSessions" type:"list" required:"true"`
// contains filtered or unexported fields
}
func (s ListStreamSessionsOutput) 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 (s *ListStreamSessionsOutput) SetNextToken(v string) *ListStreamSessionsOutput
SetNextToken sets the NextToken field's value.
func (s *ListStreamSessionsOutput) SetStreamSessions(v []*StreamSessionSummary) *ListStreamSessionsOutput
SetStreamSessions sets the StreamSessions field's value.
func (s ListStreamSessionsOutput) 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 ListStreamsInput struct {
// Filters the stream list to match the specified criterion.
FilterBy *StreamFilters `locationName:"filterBy" type:"structure"`
// Maximum number of streams to return. Default: 100.
MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"`
// The first stream to retrieve. This is used for pagination; see the nextToken
// response field.
NextToken *string `locationName:"nextToken" type:"string"`
// contains filtered or unexported fields
}
func (s ListStreamsInput) 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 (s *ListStreamsInput) SetFilterBy(v *StreamFilters) *ListStreamsInput
SetFilterBy sets the FilterBy field's value.
func (s *ListStreamsInput) SetMaxResults(v int64) *ListStreamsInput
SetMaxResults sets the MaxResults field's value.
func (s *ListStreamsInput) SetNextToken(v string) *ListStreamsInput
SetNextToken sets the NextToken field's value.
func (s ListStreamsInput) 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 (s *ListStreamsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListStreamsOutput struct {
// If there are more streams than maxResults, use nextToken in the request to
// get the next set.
NextToken *string `locationName:"nextToken" type:"string"`
// List of streams.
//
// Streams is a required field
Streams []*StreamSummary `locationName:"streams" type:"list" required:"true"`
// contains filtered or unexported fields
}
func (s ListStreamsOutput) 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 (s *ListStreamsOutput) SetNextToken(v string) *ListStreamsOutput
SetNextToken sets the NextToken field's value.
func (s *ListStreamsOutput) SetStreams(v []*StreamSummary) *ListStreamsOutput
SetStreams sets the Streams field's value.
func (s ListStreamsOutput) 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 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 (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 (s *ListTagsForResourceInput) SetResourceArn(v string) *ListTagsForResourceInput
SetResourceArn sets the ResourceArn field's value.
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 (s *ListTagsForResourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (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 (s *ListTagsForResourceOutput) SetTags(v map[string]*string) *ListTagsForResourceOutput
SetTags sets the Tags field's value.
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 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 (s *PendingVerification) Code() string
Code returns the exception type name.
func (s *PendingVerification) Error() string
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 (s *PendingVerification) Message() string
Message returns the exception's message.
func (s *PendingVerification) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *PendingVerification) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *PendingVerification) StatusCode() int
Status code returns the HTTP status code for the request's response error.
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 PlaybackKeyPair struct {
// Key-pair ARN.
Arn *string `locationName:"arn" min:"1" type:"string"`
// Key-pair identifier.
Fingerprint *string `locationName:"fingerprint" type:"string"`
// Playback-key-pair name. The value does not need to be unique.
Name *string `locationName:"name" type:"string"`
// Tags attached to the resource. Array of 1-50 maps, each of the form string:string
// (key:value). See Tagging Amazon Web Services 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 has no service-specific constraints
// beyond what is documented there.
Tags map[string]*string `locationName:"tags" type:"map"`
// contains filtered or unexported fields
}
A key pair used to sign and validate a playback authorization token.
func (s PlaybackKeyPair) 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 (s *PlaybackKeyPair) SetArn(v string) *PlaybackKeyPair
SetArn sets the Arn field's value.
func (s *PlaybackKeyPair) SetFingerprint(v string) *PlaybackKeyPair
SetFingerprint sets the Fingerprint field's value.
func (s *PlaybackKeyPair) SetName(v string) *PlaybackKeyPair
SetName sets the Name field's value.
func (s *PlaybackKeyPair) SetTags(v map[string]*string) *PlaybackKeyPair
SetTags sets the Tags field's value.
func (s PlaybackKeyPair) 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 PlaybackKeyPairSummary struct {
// Key-pair ARN.
Arn *string `locationName:"arn" min:"1" type:"string"`
// Playback-key-pair name. The value does not need to be unique.
Name *string `locationName:"name" type:"string"`
// Tags attached to the resource. Array of 1-50 maps, each of the form string:string
// (key:value). See Tagging Amazon Web Services 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 has no service-specific constraints
// beyond what is documented there.
Tags map[string]*string `locationName:"tags" type:"map"`
// contains filtered or unexported fields
}
Summary information about a playback key pair.
func (s PlaybackKeyPairSummary) 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 (s *PlaybackKeyPairSummary) SetArn(v string) *PlaybackKeyPairSummary
SetArn sets the Arn field's value.
func (s *PlaybackKeyPairSummary) SetName(v string) *PlaybackKeyPairSummary
SetName sets the Name field's value.
func (s *PlaybackKeyPairSummary) SetTags(v map[string]*string) *PlaybackKeyPairSummary
SetTags sets the Tags field's value.
func (s PlaybackKeyPairSummary) 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 PlaybackRestrictionPolicy struct {
// A list of country codes that control geoblocking restriction. Allowed values
// are the officially assigned ISO 3166-1 alpha-2 (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
// codes. Default: All countries (an empty array).
//
// AllowedCountries is a required field
AllowedCountries []*string `locationName:"allowedCountries" type:"list" required:"true"`
// A list of origin sites that control CORS restriction. Allowed values are
// the same as valid values of the Origin header defined at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin
// (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin). Default:
// All origins (an empty array).
//
// AllowedOrigins is a required field
AllowedOrigins []*string `locationName:"allowedOrigins" type:"list" required:"true"`
// Playback-restriction-policy ARN
//
// Arn is a required field
Arn *string `locationName:"arn" min:"1" type:"string" required:"true"`
// Whether channel playback is constrained by origin site. Default: false.
EnableStrictOriginEnforcement *bool `locationName:"enableStrictOriginEnforcement" type:"boolean"`
// Playback-restriction-policy name. The value does not need to be unique.
Name *string `locationName:"name" type:"string"`
// Tags attached to the resource. Array of 1-50 maps, each of the form string:string
// (key:value). See Tagging Amazon Web Services 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 has no service-specific constraints
// beyond what is documented there.
Tags map[string]*string `locationName:"tags" type:"map"`
// contains filtered or unexported fields
}
An object representing a policy to constrain playback by country and/or origin sites.
func (s PlaybackRestrictionPolicy) 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 (s *PlaybackRestrictionPolicy) SetAllowedCountries(v []*string) *PlaybackRestrictionPolicy
SetAllowedCountries sets the AllowedCountries field's value.
func (s *PlaybackRestrictionPolicy) SetAllowedOrigins(v []*string) *PlaybackRestrictionPolicy
SetAllowedOrigins sets the AllowedOrigins field's value.
func (s *PlaybackRestrictionPolicy) SetArn(v string) *PlaybackRestrictionPolicy
SetArn sets the Arn field's value.
func (s *PlaybackRestrictionPolicy) SetEnableStrictOriginEnforcement(v bool) *PlaybackRestrictionPolicy
SetEnableStrictOriginEnforcement sets the EnableStrictOriginEnforcement field's value.
func (s *PlaybackRestrictionPolicy) SetName(v string) *PlaybackRestrictionPolicy
SetName sets the Name field's value.
func (s *PlaybackRestrictionPolicy) SetTags(v map[string]*string) *PlaybackRestrictionPolicy
SetTags sets the Tags field's value.
func (s PlaybackRestrictionPolicy) 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 PlaybackRestrictionPolicySummary struct {
// A list of country codes that control geoblocking restriction. Allowed values
// are the officially assigned ISO 3166-1 alpha-2 (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
// codes. Default: All countries (an empty array).
//
// AllowedCountries is a required field
AllowedCountries []*string `locationName:"allowedCountries" type:"list" required:"true"`
// A list of origin sites that control CORS restriction. Allowed values are
// the same as valid values of the Origin header defined at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin
// (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin). Default:
// All origins (an empty array).
//
// AllowedOrigins is a required field
AllowedOrigins []*string `locationName:"allowedOrigins" type:"list" required:"true"`
// Playback-restriction-policy ARN
//
// Arn is a required field
Arn *string `locationName:"arn" min:"1" type:"string" required:"true"`
// Whether channel playback is constrained by origin site. Default: false.
EnableStrictOriginEnforcement *bool `locationName:"enableStrictOriginEnforcement" type:"boolean"`
// Playback-restriction-policy name. The value does not need to be unique.
Name *string `locationName:"name" type:"string"`
// Tags attached to the resource. Array of 1-50 maps, each of the form string:string
// (key:value). See Tagging Amazon Web Services 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 has no service-specific constraints
// beyond what is documented there.
Tags map[string]*string `locationName:"tags" type:"map"`
// contains filtered or unexported fields
}
Summary information about a PlaybackRestrictionPolicy.
func (s PlaybackRestrictionPolicySummary) 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 (s *PlaybackRestrictionPolicySummary) SetAllowedCountries(v []*string) *PlaybackRestrictionPolicySummary
SetAllowedCountries sets the AllowedCountries field's value.
func (s *PlaybackRestrictionPolicySummary) SetAllowedOrigins(v []*string) *PlaybackRestrictionPolicySummary
SetAllowedOrigins sets the AllowedOrigins field's value.
func (s *PlaybackRestrictionPolicySummary) SetArn(v string) *PlaybackRestrictionPolicySummary
SetArn sets the Arn field's value.
func (s *PlaybackRestrictionPolicySummary) SetEnableStrictOriginEnforcement(v bool) *PlaybackRestrictionPolicySummary
SetEnableStrictOriginEnforcement sets the EnableStrictOriginEnforcement field's value.
func (s *PlaybackRestrictionPolicySummary) SetName(v string) *PlaybackRestrictionPolicySummary
SetName sets the Name field's value.
func (s *PlaybackRestrictionPolicySummary) SetTags(v map[string]*string) *PlaybackRestrictionPolicySummary
SetTags sets the Tags field's value.
func (s PlaybackRestrictionPolicySummary) 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 PutMetadataInput struct {
// ARN of the channel into which metadata is inserted. This channel must have
// an active stream.
//
// ChannelArn is a required field
ChannelArn *string `locationName:"channelArn" min:"1" type:"string" required:"true"`
// Metadata to insert into the stream. Maximum: 1 KB per request.
//
// Metadata is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by PutMetadataInput's
// String and GoString methods.
//
// Metadata is a required field
Metadata *string `locationName:"metadata" min:"1" type:"string" required:"true" sensitive:"true"`
// contains filtered or unexported fields
}
func (s PutMetadataInput) 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 (s *PutMetadataInput) SetChannelArn(v string) *PutMetadataInput
SetChannelArn sets the ChannelArn field's value.
func (s *PutMetadataInput) SetMetadata(v string) *PutMetadataInput
SetMetadata sets the Metadata field's value.
func (s PutMetadataInput) 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 (s *PutMetadataInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type PutMetadataOutput struct {
// contains filtered or unexported fields
}
func (s PutMetadataOutput) 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 (s PutMetadataOutput) 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 RecordingConfiguration struct {
// Recording-configuration ARN.
//
// Arn is a required field
Arn *string `locationName:"arn" type:"string" required:"true"`
// A complex type that contains information about where recorded video will
// be stored.
//
// DestinationConfiguration is a required field
DestinationConfiguration *DestinationConfiguration `locationName:"destinationConfiguration" type:"structure" required:"true"`
// Recording-configuration name. The value does not need to be unique.
Name *string `locationName:"name" type:"string"`
// If a broadcast disconnects and then reconnects within the specified interval,
// the multiple streams will be considered a single broadcast and merged together.
// Default: 0.
RecordingReconnectWindowSeconds *int64 `locationName:"recordingReconnectWindowSeconds" type:"integer"`
// Object that describes which renditions should be recorded for a stream.
RenditionConfiguration *RenditionConfiguration `locationName:"renditionConfiguration" type:"structure"`
// Indicates the current state of the recording configuration. When the state
// is ACTIVE, the configuration is ready for recording a channel stream.
//
// State is a required field
State *string `locationName:"state" type:"string" required:"true" enum:"RecordingConfigurationState"`
// Tags attached to the resource. Array of 1-50 maps, each of the form string:string
// (key:value). See Tagging Amazon Web Services 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 has no service-specific constraints
// beyond what is documented there.
Tags map[string]*string `locationName:"tags" type:"map"`
// A complex type that allows you to enable/disable the recording of thumbnails
// for a live session and modify the interval at which thumbnails are generated
// for the live session.
ThumbnailConfiguration *ThumbnailConfiguration `locationName:"thumbnailConfiguration" type:"structure"`
// contains filtered or unexported fields
}
An object representing a configuration to record a channel stream.
func (s RecordingConfiguration) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *RecordingConfiguration) SetArn(v string) *RecordingConfiguration
SetArn sets the Arn field's value.
func (s *RecordingConfiguration) SetDestinationConfiguration(v *DestinationConfiguration) *RecordingConfiguration
SetDestinationConfiguration sets the DestinationConfiguration field's value.
func (s *RecordingConfiguration) SetName(v string) *RecordingConfiguration
SetName sets the Name field's value.
func (s *RecordingConfiguration) SetRecordingReconnectWindowSeconds(v int64) *RecordingConfiguration
SetRecordingReconnectWindowSeconds sets the RecordingReconnectWindowSeconds field's value.
func (s *RecordingConfiguration) SetRenditionConfiguration(v *RenditionConfiguration) *RecordingConfiguration
SetRenditionConfiguration sets the RenditionConfiguration field's value.
func (s *RecordingConfiguration) SetState(v string) *RecordingConfiguration
SetState sets the State field's value.
func (s *RecordingConfiguration) SetTags(v map[string]*string) *RecordingConfiguration
SetTags sets the Tags field's value.
func (s *RecordingConfiguration) SetThumbnailConfiguration(v *ThumbnailConfiguration) *RecordingConfiguration
SetThumbnailConfiguration sets the ThumbnailConfiguration field's value.
func (s RecordingConfiguration) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type RecordingConfigurationSummary struct {
// Recording-configuration ARN.
//
// Arn is a required field
Arn *string `locationName:"arn" type:"string" required:"true"`
// A complex type that contains information about where recorded video will
// be stored.
//
// DestinationConfiguration is a required field
DestinationConfiguration *DestinationConfiguration `locationName:"destinationConfiguration" type:"structure" required:"true"`
// Recording-configuration name. The value does not need to be unique.
Name *string `locationName:"name" type:"string"`
// Indicates the current state of the recording configuration. When the state
// is ACTIVE, the configuration is ready for recording a channel stream.
//
// State is a required field
State *string `locationName:"state" type:"string" required:"true" enum:"RecordingConfigurationState"`
// Tags attached to the resource. Array of 1-50 maps, each of the form string:string
// (key:value). See Tagging Amazon Web Services 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 has no service-specific constraints
// beyond what is documented there.
Tags map[string]*string `locationName:"tags" type:"map"`
// contains filtered or unexported fields
}
Summary information about a RecordingConfiguration.
func (s RecordingConfigurationSummary) 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 (s *RecordingConfigurationSummary) SetArn(v string) *RecordingConfigurationSummary
SetArn sets the Arn field's value.
func (s *RecordingConfigurationSummary) SetDestinationConfiguration(v *DestinationConfiguration) *RecordingConfigurationSummary
SetDestinationConfiguration sets the DestinationConfiguration field's value.
func (s *RecordingConfigurationSummary) SetName(v string) *RecordingConfigurationSummary
SetName sets the Name field's value.
func (s *RecordingConfigurationSummary) SetState(v string) *RecordingConfigurationSummary
SetState sets the State field's value.
func (s *RecordingConfigurationSummary) SetTags(v map[string]*string) *RecordingConfigurationSummary
SetTags sets the Tags field's value.
func (s RecordingConfigurationSummary) 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 RenditionConfiguration struct {
// Indicates which set of renditions are recorded for a stream. For BASIC channels,
// the CUSTOM value has no effect. If CUSTOM is specified, a set of renditions
// must be specified in the renditions field. Default: ALL.
RenditionSelection *string `locationName:"renditionSelection" type:"string" enum:"RenditionConfigurationRenditionSelection"`
// Indicates which renditions are recorded for a stream, if renditionSelection
// is CUSTOM; otherwise, this field is irrelevant. The selected renditions are
// recorded if they are available during the stream. If a selected rendition
// is unavailable, the best available rendition is recorded. For details on
// the resolution dimensions of each rendition, see Auto-Record to Amazon S3
// (https://docs.aws.amazon.com/ivs/latest/userguide/record-to-s3.html).
Renditions []*string `locationName:"renditions" type:"list" enum:"RenditionConfigurationRendition"`
// contains filtered or unexported fields
}
Object that describes which renditions should be recorded for a stream.
func (s RenditionConfiguration) 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 (s *RenditionConfiguration) SetRenditionSelection(v string) *RenditionConfiguration
SetRenditionSelection sets the RenditionSelection field's value.
func (s *RenditionConfiguration) SetRenditions(v []*string) *RenditionConfiguration
SetRenditions sets the Renditions field's value.
func (s RenditionConfiguration) 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 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 (s *ResourceNotFoundException) Code() string
Code returns the exception type name.
func (s *ResourceNotFoundException) Error() string
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 (s *ResourceNotFoundException) Message() string
Message returns the exception's message.
func (s *ResourceNotFoundException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ResourceNotFoundException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *ResourceNotFoundException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s ResourceNotFoundException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type S3DestinationConfiguration struct {
// Location (S3 bucket name) where recorded videos will be stored.
//
// BucketName is a required field
BucketName *string `locationName:"bucketName" min:"3" type:"string" required:"true"`
// contains filtered or unexported fields
}
A complex type that describes an S3 location where recorded videos will be stored.
func (s S3DestinationConfiguration) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *S3DestinationConfiguration) SetBucketName(v string) *S3DestinationConfiguration
SetBucketName sets the BucketName field's value.
func (s S3DestinationConfiguration) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *S3DestinationConfiguration) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (s *ServiceQuotaExceededException) Code() string
Code returns the exception type name.
func (s *ServiceQuotaExceededException) Error() string
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 (s *ServiceQuotaExceededException) Message() string
Message returns the exception's message.
func (s *ServiceQuotaExceededException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ServiceQuotaExceededException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *ServiceQuotaExceededException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
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 Srt struct {
// The endpoint to be used when streaming with IVS using the SRT protocol.
Endpoint *string `locationName:"endpoint" type:"string"`
// Auto-generated passphrase to enable encryption. This field is applicable
// only if the end user has not enabled the insecureIngest option for the channel.
//
// Passphrase is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by Srt's
// String and GoString methods.
Passphrase *string `locationName:"passphrase" type:"string" sensitive:"true"`
// contains filtered or unexported fields
}
Specifies information needed to stream using the SRT protocol.
func (s Srt) 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 (s *Srt) SetEndpoint(v string) *Srt
SetEndpoint sets the Endpoint field's value.
func (s *Srt) SetPassphrase(v string) *Srt
SetPassphrase sets the Passphrase field's value.
func (s Srt) 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 StartViewerSessionRevocationInput struct {
// The ARN of the channel associated with the viewer session to revoke.
//
// ChannelArn is a required field
ChannelArn *string `locationName:"channelArn" min:"1" type:"string" required:"true"`
// The ID of the viewer associated with the viewer session to revoke. Do not
// use this field for personally identifying, confidential, or sensitive information.
//
// ViewerId is a required field
ViewerId *string `locationName:"viewerId" min:"1" type:"string" required:"true"`
// An optional filter on which versions of the viewer session to revoke. All
// versions less than or equal to the specified version will be revoked. Default:
// 0.
ViewerSessionVersionsLessThanOrEqualTo *int64 `locationName:"viewerSessionVersionsLessThanOrEqualTo" type:"integer"`
// contains filtered or unexported fields
}
func (s StartViewerSessionRevocationInput) 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 (s *StartViewerSessionRevocationInput) SetChannelArn(v string) *StartViewerSessionRevocationInput
SetChannelArn sets the ChannelArn field's value.
func (s *StartViewerSessionRevocationInput) SetViewerId(v string) *StartViewerSessionRevocationInput
SetViewerId sets the ViewerId field's value.
func (s *StartViewerSessionRevocationInput) SetViewerSessionVersionsLessThanOrEqualTo(v int64) *StartViewerSessionRevocationInput
SetViewerSessionVersionsLessThanOrEqualTo sets the ViewerSessionVersionsLessThanOrEqualTo field's value.
func (s StartViewerSessionRevocationInput) 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 (s *StartViewerSessionRevocationInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type StartViewerSessionRevocationOutput struct {
// contains filtered or unexported fields
}
func (s StartViewerSessionRevocationOutput) 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 (s StartViewerSessionRevocationOutput) 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 StopStreamInput struct {
// ARN of the channel for which the stream is to be stopped.
//
// ChannelArn is a required field
ChannelArn *string `locationName:"channelArn" min:"1" type:"string" required:"true"`
// contains filtered or unexported fields
}
func (s StopStreamInput) 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 (s *StopStreamInput) SetChannelArn(v string) *StopStreamInput
SetChannelArn sets the ChannelArn field's value.
func (s StopStreamInput) 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 (s *StopStreamInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type StopStreamOutput struct {
// contains filtered or unexported fields
}
func (s StopStreamOutput) 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 (s StopStreamOutput) 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 Stream struct {
// Channel ARN for the stream.
ChannelArn *string `locationName:"channelArn" min:"1" type:"string"`
// The stream’s health.
Health *string `locationName:"health" type:"string" enum:"StreamHealth"`
// URL of the master playlist, required by the video player to play the HLS
// stream.
PlaybackUrl *string `locationName:"playbackUrl" type:"string"`
// Time of the stream’s start. This is an ISO 8601 timestamp; note that this
// is returned as a string.
StartTime *time.Time `locationName:"startTime" type:"timestamp" timestampFormat:"iso8601"`
// The stream’s state. Do not rely on the OFFLINE state, as the API may not
// return it; instead, a "NotBroadcasting" error will indicate that the stream
// is not live.
State *string `locationName:"state" type:"string" enum:"StreamState"`
// Unique identifier for a live or previously live stream in the specified channel.
StreamId *string `locationName:"streamId" min:"26" type:"string"`
// A count of concurrent views of the stream. Typically, a new view appears
// in viewerCount within 15 seconds of when video playback starts and a view
// is removed from viewerCount within 1 minute of when video playback ends.
// A value of -1 indicates that the request timed out; in this case, retry.
ViewerCount *int64 `locationName:"viewerCount" type:"long"`
// contains filtered or unexported fields
}
Specifies a live video stream that has been ingested and distributed.
func (s Stream) 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 (s *Stream) SetChannelArn(v string) *Stream
SetChannelArn sets the ChannelArn field's value.
func (s *Stream) SetHealth(v string) *Stream
SetHealth sets the Health field's value.
func (s *Stream) SetPlaybackUrl(v string) *Stream
SetPlaybackUrl sets the PlaybackUrl field's value.
func (s *Stream) SetStartTime(v time.Time) *Stream
SetStartTime sets the StartTime field's value.
func (s *Stream) SetState(v string) *Stream
SetState sets the State field's value.
func (s *Stream) SetStreamId(v string) *Stream
SetStreamId sets the StreamId field's value.
func (s *Stream) SetViewerCount(v int64) *Stream
SetViewerCount sets the ViewerCount field's value.
func (s Stream) 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 StreamEvent struct {
// Time when the event occurred. This is an ISO 8601 timestamp; note that this
// is returned as a string.
EventTime *time.Time `locationName:"eventTime" type:"timestamp" timestampFormat:"iso8601"`
// Name that identifies the stream event within a type.
Name *string `locationName:"name" type:"string"`
// Logical group for certain events.
Type *string `locationName:"type" type:"string"`
// contains filtered or unexported fields
}
Object specifying a stream’s events. For a list of events, see Using Amazon EventBridge with Amazon IVS (https://docs.aws.amazon.com/ivs/latest/userguide/eventbridge.html).
func (s StreamEvent) 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 (s *StreamEvent) SetEventTime(v time.Time) *StreamEvent
SetEventTime sets the EventTime field's value.
func (s *StreamEvent) SetName(v string) *StreamEvent
SetName sets the Name field's value.
func (s *StreamEvent) SetType(v string) *StreamEvent
SetType sets the Type field's value.
func (s StreamEvent) 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 StreamFilters struct {
// The stream’s health.
Health *string `locationName:"health" type:"string" enum:"StreamHealth"`
// contains filtered or unexported fields
}
Object specifying the stream attribute on which to filter.
func (s StreamFilters) 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 (s *StreamFilters) SetHealth(v string) *StreamFilters
SetHealth sets the Health field's value.
func (s StreamFilters) 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 StreamKey struct {
// Stream-key ARN.
Arn *string `locationName:"arn" min:"1" type:"string"`
// Channel ARN for the stream.
ChannelArn *string `locationName:"channelArn" min:"1" type:"string"`
// Tags attached to the resource. Array of 1-50 maps, each of the form string:string
// (key:value). See Tagging Amazon Web Services 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 has no service-specific constraints
// beyond what is documented there.
Tags map[string]*string `locationName:"tags" type:"map"`
// Stream-key value.
//
// Value is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by StreamKey's
// String and GoString methods.
Value *string `locationName:"value" type:"string" sensitive:"true"`
// contains filtered or unexported fields
}
Object specifying a stream key.
func (s StreamKey) 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 (s *StreamKey) SetArn(v string) *StreamKey
SetArn sets the Arn field's value.
func (s *StreamKey) SetChannelArn(v string) *StreamKey
SetChannelArn sets the ChannelArn field's value.
func (s *StreamKey) SetTags(v map[string]*string) *StreamKey
SetTags sets the Tags field's value.
func (s *StreamKey) SetValue(v string) *StreamKey
SetValue sets the Value field's value.
func (s StreamKey) 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 StreamKeySummary struct {
// Stream-key ARN.
Arn *string `locationName:"arn" min:"1" type:"string"`
// Channel ARN for the stream.
ChannelArn *string `locationName:"channelArn" min:"1" type:"string"`
// Tags attached to the resource. Array of 1-50 maps, each of the form string:string
// (key:value). See Tagging Amazon Web Services 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 has no service-specific constraints
// beyond what is documented there.
Tags map[string]*string `locationName:"tags" type:"map"`
// contains filtered or unexported fields
}
Summary information about a stream key.
func (s StreamKeySummary) 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 (s *StreamKeySummary) SetArn(v string) *StreamKeySummary
SetArn sets the Arn field's value.
func (s *StreamKeySummary) SetChannelArn(v string) *StreamKeySummary
SetChannelArn sets the ChannelArn field's value.
func (s *StreamKeySummary) SetTags(v map[string]*string) *StreamKeySummary
SetTags sets the Tags field's value.
func (s StreamKeySummary) 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 StreamSession struct {
// The properties of the channel at the time of going live.
Channel *Channel `locationName:"channel" type:"structure"`
// Time when the channel went offline. This is an ISO 8601 timestamp; note that
// this is returned as a string. For live streams, this is NULL.
EndTime *time.Time `locationName:"endTime" type:"timestamp" timestampFormat:"iso8601"`
// The properties of the incoming RTMP stream for the stream.
IngestConfiguration *IngestConfiguration `locationName:"ingestConfiguration" type:"structure"`
// The properties of recording the live stream.
RecordingConfiguration *RecordingConfiguration `locationName:"recordingConfiguration" type:"structure"`
// Time when the channel went live. This is an ISO 8601 timestamp; note that
// this is returned as a string.
StartTime *time.Time `locationName:"startTime" type:"timestamp" timestampFormat:"iso8601"`
// Unique identifier for a live or previously live stream in the specified channel.
StreamId *string `locationName:"streamId" min:"26" type:"string"`
// List of Amazon IVS events that the stream encountered. The list is sorted
// by most recent events and contains up to 500 events. For Amazon IVS events,
// see Using Amazon EventBridge with Amazon IVS (https://docs.aws.amazon.com/ivs/latest/userguide/eventbridge.html).
TruncatedEvents []*StreamEvent `locationName:"truncatedEvents" type:"list"`
// contains filtered or unexported fields
}
Object that captures the Amazon IVS configuration that the customer provisioned, the ingest configurations that the broadcaster used, and the most recent Amazon IVS stream events it encountered.
func (s StreamSession) 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 (s *StreamSession) SetChannel(v *Channel) *StreamSession
SetChannel sets the Channel field's value.
func (s *StreamSession) SetEndTime(v time.Time) *StreamSession
SetEndTime sets the EndTime field's value.
func (s *StreamSession) SetIngestConfiguration(v *IngestConfiguration) *StreamSession
SetIngestConfiguration sets the IngestConfiguration field's value.
func (s *StreamSession) SetRecordingConfiguration(v *RecordingConfiguration) *StreamSession
SetRecordingConfiguration sets the RecordingConfiguration field's value.
func (s *StreamSession) SetStartTime(v time.Time) *StreamSession
SetStartTime sets the StartTime field's value.
func (s *StreamSession) SetStreamId(v string) *StreamSession
SetStreamId sets the StreamId field's value.
func (s *StreamSession) SetTruncatedEvents(v []*StreamEvent) *StreamSession
SetTruncatedEvents sets the TruncatedEvents field's value.
func (s StreamSession) 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 StreamSessionSummary struct {
// Time when the channel went offline. This is an ISO 8601 timestamp; note that
// this is returned as a string. For live streams, this is NULL.
EndTime *time.Time `locationName:"endTime" type:"timestamp" timestampFormat:"iso8601"`
// If true, this stream encountered a quota breach or failure.
HasErrorEvent *bool `locationName:"hasErrorEvent" type:"boolean"`
// Time when the channel went live. This is an ISO 8601 timestamp; note that
// this is returned as a string.
StartTime *time.Time `locationName:"startTime" type:"timestamp" timestampFormat:"iso8601"`
// Unique identifier for a live or previously live stream in the specified channel.
StreamId *string `locationName:"streamId" min:"26" type:"string"`
// contains filtered or unexported fields
}
Summary information about a stream session.
func (s StreamSessionSummary) 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 (s *StreamSessionSummary) SetEndTime(v time.Time) *StreamSessionSummary
SetEndTime sets the EndTime field's value.
func (s *StreamSessionSummary) SetHasErrorEvent(v bool) *StreamSessionSummary
SetHasErrorEvent sets the HasErrorEvent field's value.
func (s *StreamSessionSummary) SetStartTime(v time.Time) *StreamSessionSummary
SetStartTime sets the StartTime field's value.
func (s *StreamSessionSummary) SetStreamId(v string) *StreamSessionSummary
SetStreamId sets the StreamId field's value.
func (s StreamSessionSummary) 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 StreamSummary struct {
// Channel ARN for the stream.
ChannelArn *string `locationName:"channelArn" min:"1" type:"string"`
// The stream’s health.
Health *string `locationName:"health" type:"string" enum:"StreamHealth"`
// Time of the stream’s start. This is an ISO 8601 timestamp; note that this
// is returned as a string.
StartTime *time.Time `locationName:"startTime" type:"timestamp" timestampFormat:"iso8601"`
// The stream’s state. Do not rely on the OFFLINE state, as the API may not
// return it; instead, a "NotBroadcasting" error will indicate that the stream
// is not live.
State *string `locationName:"state" type:"string" enum:"StreamState"`
// Unique identifier for a live or previously live stream in the specified channel.
StreamId *string `locationName:"streamId" min:"26" type:"string"`
// A count of concurrent views of the stream. Typically, a new view appears
// in viewerCount within 15 seconds of when video playback starts and a view
// is removed from viewerCount within 1 minute of when video playback ends.
// A value of -1 indicates that the request timed out; in this case, retry.
ViewerCount *int64 `locationName:"viewerCount" type:"long"`
// contains filtered or unexported fields
}
Summary information about a stream.
func (s StreamSummary) 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 (s *StreamSummary) SetChannelArn(v string) *StreamSummary
SetChannelArn sets the ChannelArn field's value.
func (s *StreamSummary) SetHealth(v string) *StreamSummary
SetHealth sets the Health field's value.
func (s *StreamSummary) SetStartTime(v time.Time) *StreamSummary
SetStartTime sets the StartTime field's value.
func (s *StreamSummary) SetState(v string) *StreamSummary
SetState sets the State field's value.
func (s *StreamSummary) SetStreamId(v string) *StreamSummary
SetStreamId sets the StreamId field's value.
func (s *StreamSummary) SetViewerCount(v int64) *StreamSummary
SetViewerCount sets the ViewerCount field's value.
func (s StreamSummary) 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 StreamUnavailable struct {
RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
// The stream is temporarily unavailable.
ExceptionMessage *string `locationName:"exceptionMessage" type:"string"`
Message_ *string `locationName:"message" type:"string"`
// contains filtered or unexported fields
}
func (s *StreamUnavailable) Code() string
Code returns the exception type name.
func (s *StreamUnavailable) Error() string
func (s StreamUnavailable) 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 (s *StreamUnavailable) Message() string
Message returns the exception's message.
func (s *StreamUnavailable) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *StreamUnavailable) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *StreamUnavailable) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s StreamUnavailable) 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 struct {
// ARN of the resource for which tags are to be added or updated. 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 Amazon Web Services 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 has no service-specific 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 (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 (s *TagResourceInput) SetResourceArn(v string) *TagResourceInput
SetResourceArn sets the ResourceArn field's value.
func (s *TagResourceInput) SetTags(v map[string]*string) *TagResourceInput
SetTags sets the Tags field's value.
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 (s *TagResourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type TagResourceOutput struct {
// contains filtered or unexported fields
}
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 (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 ThrottlingException struct {
RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
// Request was denied due to request throttling.
ExceptionMessage *string `locationName:"exceptionMessage" type:"string"`
Message_ *string `locationName:"message" type:"string"`
// contains filtered or unexported fields
}
func (s *ThrottlingException) Code() string
Code returns the exception type name.
func (s *ThrottlingException) Error() string
func (s ThrottlingException) 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 (s *ThrottlingException) Message() string
Message returns the exception's message.
func (s *ThrottlingException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ThrottlingException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *ThrottlingException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s ThrottlingException) 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 ThumbnailConfiguration struct {
// Thumbnail recording mode. Default: INTERVAL.
RecordingMode *string `locationName:"recordingMode" type:"string" enum:"RecordingMode"`
// Indicates the desired resolution of recorded thumbnails. Thumbnails are recorded
// at the selected resolution if the corresponding rendition is available during
// the stream; otherwise, they are recorded at source resolution. For more information
// about resolution values and their corresponding height and width dimensions,
// see Auto-Record to Amazon S3 (https://docs.aws.amazon.com/ivs/latest/userguide/record-to-s3.html).
// Default: Null (source resolution is returned).
Resolution *string `locationName:"resolution" type:"string" enum:"ThumbnailConfigurationResolution"`
// Indicates the format in which thumbnails are recorded. SEQUENTIAL records
// all generated thumbnails in a serial manner, to the media/thumbnails directory.
// LATEST saves the latest thumbnail in media/latest_thumbnail/thumb.jpg and
// overwrites it at the interval specified by targetIntervalSeconds. You can
// enable both SEQUENTIAL and LATEST. Default: SEQUENTIAL.
Storage []*string `locationName:"storage" type:"list" enum:"ThumbnailConfigurationStorage"`
// The targeted thumbnail-generation interval in seconds. This is configurable
// (and required) only if recordingMode is INTERVAL. Default: 60.
//
// Important: For the BASIC channel type, setting a value for targetIntervalSeconds
// does not guarantee that thumbnails are generated at the specified interval.
// For thumbnails to be generated at the targetIntervalSeconds interval, the
// IDR/Keyframe value for the input video must be less than the targetIntervalSeconds
// value. See Amazon IVS Streaming Configuration (https://docs.aws.amazon.com/ivs/latest/userguide/streaming-config.html)
// for information on setting IDR/Keyframe to the recommended value in video-encoder
// settings.
TargetIntervalSeconds *int64 `locationName:"targetIntervalSeconds" min:"1" type:"long"`
// contains filtered or unexported fields
}
An object representing a configuration of thumbnails for recorded video.
func (s ThumbnailConfiguration) 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 (s *ThumbnailConfiguration) SetRecordingMode(v string) *ThumbnailConfiguration
SetRecordingMode sets the RecordingMode field's value.
func (s *ThumbnailConfiguration) SetResolution(v string) *ThumbnailConfiguration
SetResolution sets the Resolution field's value.
func (s *ThumbnailConfiguration) SetStorage(v []*string) *ThumbnailConfiguration
SetStorage sets the Storage field's value.
func (s *ThumbnailConfiguration) SetTargetIntervalSeconds(v int64) *ThumbnailConfiguration
SetTargetIntervalSeconds sets the TargetIntervalSeconds field's value.
func (s ThumbnailConfiguration) 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 (s *ThumbnailConfiguration) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UntagResourceInput struct {
// ARN of the resource for which tags are to be removed. 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 Amazon Web Services 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 has no service-specific 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 (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 (s *UntagResourceInput) SetResourceArn(v string) *UntagResourceInput
SetResourceArn sets the ResourceArn field's value.
func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput
SetTagKeys sets the TagKeys field's value.
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 (s *UntagResourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UntagResourceOutput struct {
// contains filtered or unexported fields
}
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 (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 UpdateChannelInput struct {
// ARN of the channel to be updated.
//
// Arn is a required field
Arn *string `locationName:"arn" min:"1" type:"string" required:"true"`
// Whether the channel is private (enabled for playback authorization).
Authorized *bool `locationName:"authorized" type:"boolean"`
// Whether the channel allows insecure RTMP and SRT ingest. Default: false.
InsecureIngest *bool `locationName:"insecureIngest" type:"boolean"`
// Channel latency mode. Use NORMAL to broadcast and deliver live video up to
// Full HD. Use LOW for near-real-time interaction with viewers.
LatencyMode *string `locationName:"latencyMode" type:"string" enum:"ChannelLatencyMode"`
// Channel name.
Name *string `locationName:"name" type:"string"`
// Playback-restriction-policy ARN. A valid ARN value here both specifies the
// ARN and enables playback restriction. If this is set to an empty string,
// playback restriction policy is disabled.
PlaybackRestrictionPolicyArn *string `locationName:"playbackRestrictionPolicyArn" type:"string"`
// Optional transcode preset for the channel. This is selectable only for ADVANCED_HD
// and ADVANCED_SD channel types. For those channel types, the default preset
// is HIGHER_BANDWIDTH_DELIVERY. For other channel types (BASIC and STANDARD),
// preset is the empty string ("").
Preset *string `locationName:"preset" type:"string" enum:"TranscodePreset"`
// Recording-configuration ARN. A valid ARN value here both specifies the ARN
// and enables recording. If this is set to an empty string, recording is disabled.
RecordingConfigurationArn *string `locationName:"recordingConfigurationArn" type:"string"`
// Channel type, which determines the allowable resolution and bitrate. If you
// exceed the allowable input resolution or bitrate, the stream probably will
// disconnect immediately. Default: STANDARD. For details, see Channel Types
// (https://docs.aws.amazon.com/ivs/latest/LowLatencyAPIReference/channel-types.html).
Type *string `locationName:"type" type:"string" enum:"ChannelType"`
// contains filtered or unexported fields
}
func (s UpdateChannelInput) 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 (s *UpdateChannelInput) SetArn(v string) *UpdateChannelInput
SetArn sets the Arn field's value.
func (s *UpdateChannelInput) SetAuthorized(v bool) *UpdateChannelInput
SetAuthorized sets the Authorized field's value.
func (s *UpdateChannelInput) SetInsecureIngest(v bool) *UpdateChannelInput
SetInsecureIngest sets the InsecureIngest field's value.
func (s *UpdateChannelInput) SetLatencyMode(v string) *UpdateChannelInput
SetLatencyMode sets the LatencyMode field's value.
func (s *UpdateChannelInput) SetName(v string) *UpdateChannelInput
SetName sets the Name field's value.
func (s *UpdateChannelInput) SetPlaybackRestrictionPolicyArn(v string) *UpdateChannelInput
SetPlaybackRestrictionPolicyArn sets the PlaybackRestrictionPolicyArn field's value.
func (s *UpdateChannelInput) SetPreset(v string) *UpdateChannelInput
SetPreset sets the Preset field's value.
func (s *UpdateChannelInput) SetRecordingConfigurationArn(v string) *UpdateChannelInput
SetRecordingConfigurationArn sets the RecordingConfigurationArn field's value.
func (s *UpdateChannelInput) SetType(v string) *UpdateChannelInput
SetType sets the Type field's value.
func (s UpdateChannelInput) 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 (s *UpdateChannelInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateChannelOutput struct {
// Object specifying the updated channel.
Channel *Channel `locationName:"channel" type:"structure"`
// contains filtered or unexported fields
}
func (s UpdateChannelOutput) 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 (s *UpdateChannelOutput) SetChannel(v *Channel) *UpdateChannelOutput
SetChannel sets the Channel field's value.
func (s UpdateChannelOutput) 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 UpdatePlaybackRestrictionPolicyInput struct {
// A list of country codes that control geoblocking restriction. Allowed values
// are the officially assigned ISO 3166-1 alpha-2 (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
// codes. Default: All countries (an empty array).
AllowedCountries []*string `locationName:"allowedCountries" type:"list"`
// A list of origin sites that control CORS restriction. Allowed values are
// the same as valid values of the Origin header defined at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin
// (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin). Default:
// All origins (an empty array).
AllowedOrigins []*string `locationName:"allowedOrigins" type:"list"`
// ARN of the playback-restriction-policy to be updated.
//
// Arn is a required field
Arn *string `locationName:"arn" min:"1" type:"string" required:"true"`
// Whether channel playback is constrained by origin site. Default: false.
EnableStrictOriginEnforcement *bool `locationName:"enableStrictOriginEnforcement" type:"boolean"`
// Playback-restriction-policy name. The value does not need to be unique.
Name *string `locationName:"name" type:"string"`
// contains filtered or unexported fields
}
func (s UpdatePlaybackRestrictionPolicyInput) 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 (s *UpdatePlaybackRestrictionPolicyInput) SetAllowedCountries(v []*string) *UpdatePlaybackRestrictionPolicyInput
SetAllowedCountries sets the AllowedCountries field's value.
func (s *UpdatePlaybackRestrictionPolicyInput) SetAllowedOrigins(v []*string) *UpdatePlaybackRestrictionPolicyInput
SetAllowedOrigins sets the AllowedOrigins field's value.
func (s *UpdatePlaybackRestrictionPolicyInput) SetArn(v string) *UpdatePlaybackRestrictionPolicyInput
SetArn sets the Arn field's value.
func (s *UpdatePlaybackRestrictionPolicyInput) SetEnableStrictOriginEnforcement(v bool) *UpdatePlaybackRestrictionPolicyInput
SetEnableStrictOriginEnforcement sets the EnableStrictOriginEnforcement field's value.
func (s *UpdatePlaybackRestrictionPolicyInput) SetName(v string) *UpdatePlaybackRestrictionPolicyInput
SetName sets the Name field's value.
func (s UpdatePlaybackRestrictionPolicyInput) 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 (s *UpdatePlaybackRestrictionPolicyInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdatePlaybackRestrictionPolicyOutput struct {
// Object specifying the updated policy.
PlaybackRestrictionPolicy *PlaybackRestrictionPolicy `locationName:"playbackRestrictionPolicy" type:"structure"`
// contains filtered or unexported fields
}
func (s UpdatePlaybackRestrictionPolicyOutput) 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 (s *UpdatePlaybackRestrictionPolicyOutput) SetPlaybackRestrictionPolicy(v *PlaybackRestrictionPolicy) *UpdatePlaybackRestrictionPolicyOutput
SetPlaybackRestrictionPolicy sets the PlaybackRestrictionPolicy field's value.
func (s UpdatePlaybackRestrictionPolicyOutput) 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 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 (s *ValidationException) Code() string
Code returns the exception type name.
func (s *ValidationException) Error() string
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 (s *ValidationException) Message() string
Message returns the exception's message.
func (s *ValidationException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ValidationException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *ValidationException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s ValidationException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type VideoConfiguration struct {
// Indicates the degree of required decoder performance for a profile. Normally
// this is set automatically by the encoder. For details, see the H.264 specification.
AvcLevel *string `locationName:"avcLevel" type:"string"`
// Indicates to the decoder the requirements for decoding the stream. For definitions
// of the valid values, see the H.264 specification.
AvcProfile *string `locationName:"avcProfile" type:"string"`
// Codec used for the video encoding.
Codec *string `locationName:"codec" type:"string"`
// Software or hardware used to encode the video.
Encoder *string `locationName:"encoder" type:"string"`
// The expected ingest bitrate (bits per second). This is configured in the
// encoder.
TargetBitrate *int64 `locationName:"targetBitrate" type:"long"`
// The expected ingest framerate. This is configured in the encoder.
TargetFramerate *int64 `locationName:"targetFramerate" type:"long"`
// Video-resolution height in pixels.
VideoHeight *int64 `locationName:"videoHeight" type:"long"`
// Video-resolution width in pixels.
VideoWidth *int64 `locationName:"videoWidth" type:"long"`
// contains filtered or unexported fields
}
Object specifying a stream’s video configuration, as set up by the broadcaster (usually in an encoder). This is part of the IngestConfiguration object and used for monitoring stream health.
func (s VideoConfiguration) 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 (s *VideoConfiguration) SetAvcLevel(v string) *VideoConfiguration
SetAvcLevel sets the AvcLevel field's value.
func (s *VideoConfiguration) SetAvcProfile(v string) *VideoConfiguration
SetAvcProfile sets the AvcProfile field's value.
func (s *VideoConfiguration) SetCodec(v string) *VideoConfiguration
SetCodec sets the Codec field's value.
func (s *VideoConfiguration) SetEncoder(v string) *VideoConfiguration
SetEncoder sets the Encoder field's value.
func (s *VideoConfiguration) SetTargetBitrate(v int64) *VideoConfiguration
SetTargetBitrate sets the TargetBitrate field's value.
func (s *VideoConfiguration) SetTargetFramerate(v int64) *VideoConfiguration
SetTargetFramerate sets the TargetFramerate field's value.
func (s *VideoConfiguration) SetVideoHeight(v int64) *VideoConfiguration
SetVideoHeight sets the VideoHeight field's value.
func (s *VideoConfiguration) SetVideoWidth(v int64) *VideoConfiguration
SetVideoWidth sets the VideoWidth field's value.
func (s VideoConfiguration) 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".