ivs

package
v1.44.279 Latest Latest
Warning

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

 Go to latest Published: Jun 8, 2023 License: Apache-2.0 Imports: 10 Imported by: 14

Documentation

Overview

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

Introduction

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

The API is an Amazon Web Services regional service. For a list of supported regions and Amazon IVS HTTPS service endpoints, see the Amazon IVS page (https://docs.aws.amazon.com/general/latest/gr/ivs.html) in the Amazon Web Services General Reference. 

All API request parameters and URLs are case sensitive.

For a summary of notable documentation changes in each release, see Document History (https://docs.aws.amazon.com/ivs/latest/userguide/doc-history.html).

Allowed Header Values

  • Accept: application/json

  • Accept-Encoding: gzip, deflate

  • Content-Type: application/json

Resources

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

  • Channel — Stores configuration data related to your live stream. You first create a channel and then use the channel’s stream key to start your live stream. See the Channel endpoints for more information.

  • Stream key — An identifier assigned by Amazon IVS when you create a channel, which is then used to authorize streaming. See the StreamKey endpoints for more information. Treat the stream key like a secret, since it allows anyone to stream to the channel.

  • Playback key pair — Video playback may be restricted using playback-authorization tokens, which use public-key encryption. A playback key pair is the public-private pair of keys used to sign and validate the playback-authorization token. See the PlaybackKeyPair endpoints for more information.

  • Recording configuration — Stores configuration related to recording a live stream and where to store the recorded content. Multiple channels can reference the same recording configuration. See the Recording Configuration endpoints for more information.

Tagging

A tag is a metadata label that you assign to an Amazon Web Services resource. A tag comprises a key and a value, both set by you. For example, you might set a tag as topic:nature to label a particular video category. See Tagging 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 can help you identify and organize your Amazon Web Services resources. For example, you can use the same tag for different resources to indicate that they are related. You can also use tags to manage access (see Access Tags (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html)).

The Amazon IVS API has these tag-related endpoints: TagResource, UntagResource, and ListTagsForResource. The following resources support tagging: Channels, Stream Keys, Playback Key Pairs, and Recording Configurations.

At most 50 tags can be applied to a resource.

Authentication versus Authorization

Note the differences between these concepts:

  • Authentication is about verifying identity. You need to be authenticated to sign Amazon IVS API requests.

  • Authorization is about granting permissions. Your IAM roles need to have permissions for Amazon IVS API requests. In addition, authorization is needed to view Amazon IVS private channels (https://docs.aws.amazon.com/ivs/latest/userguide/private-channels.html). (Private channels are channels that are enabled for "playback authorization.")

Authentication

All Amazon IVS API requests must be authenticated with a signature. The Amazon Web Services Command-Line Interface (CLI) and Amazon IVS Player SDKs take care of signing the underlying API calls for you. However, if your application calls the Amazon IVS API directly, it’s your responsibility to sign the requests.

You generate a signature using valid Amazon Web Services credentials that have permission to perform the requested action. For example, you must sign PutMetadata requests with a signature generated from a user account that has the ivs:PutMetadata permission.

For more information:

Amazon Resource Names (ARNs)

ARNs uniquely identify AWS resources. An ARN is required when you need to specify a resource unambiguously across all of AWS, such as in IAM policies and API calls. For more information, see Amazon Resource Names (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the AWS General Reference.

Channel Endpoints

  • CreateChannel — Creates a new channel and an associated stream key to start streaming.

  • GetChannel — Gets the channel configuration for the specified channel ARN.

  • BatchGetChannel — Performs GetChannel on multiple ARNs simultaneously.

  • ListChannels — 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 Conflict Exception).

  • UpdateChannel — Updates a channel's configuration. This does not affect an ongoing stream of this channel. You must stop and restart the stream for the changes to take effect.

  • DeleteChannel — Deletes the specified channel.

StreamKey Endpoints

  • CreateStreamKey — Creates a stream key, used to initiate a stream, for the specified channel ARN.

  • GetStreamKey — Gets stream key information for the specified ARN.

  • BatchGetStreamKey — Performs GetStreamKey on multiple ARNs simultaneously.

  • ListStreamKeys — Gets summary information about stream keys for the specified channel.

  • DeleteStreamKey — Deletes the stream key for the specified ARN, so it can no longer be used to stream.

Stream Endpoints

  • GetStream — Gets information about the active (live) stream on a specified channel.

  • GetStreamSession — Gets metadata on a specified stream.

  • ListStreams — Gets summary information about live streams in your account, in the Amazon Web Services region where the API request is processed.

  • ListStreamSessions — 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.

  • StopStream — Disconnects the incoming RTMPS stream for the specified channel. Can be used in conjunction with DeleteStreamKey to prevent further streaming to a channel.

  • PutMetadata — 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.

PlaybackKeyPair Endpoints

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.

  • ImportPlaybackKeyPair — 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 (channels enabled for playback authorization).

  • GetPlaybackKeyPair — 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.

  • ListPlaybackKeyPairs — Gets summary information about playback key pairs.

  • DeletePlaybackKeyPair — Deletes a specified authorization key pair. This invalidates future viewer tokens generated using the key pair’s privateKey.

RecordingConfiguration Endpoints

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

  • GetRecordingConfiguration — Gets the recording-configuration metadata for the specified ARN.

  • ListRecordingConfigurations — Gets summary information about all recording configurations in your account, in the Amazon Web Services region where the API request is processed.

  • DeleteRecordingConfiguration — Deletes the recording configuration for the specified ARN.

Amazon Web Services Tags Endpoints

  • TagResource — Adds or updates tags for the Amazon Web Services resource with the specified ARN.

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

  • ListTagsForResource — Gets information about Amazon Web Services tags for the specified ARN.

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

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

Using the Client

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

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

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

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

Index

Constants

View Source 
const (
	// ChannelLatencyModeNormal is a ChannelLatencyMode enum value
	ChannelLatencyModeNormal = "NORMAL"

	// ChannelLatencyModeLow is a ChannelLatencyMode enum value
	ChannelLatencyModeLow = "LOW"
)
View Source 
const (
	// ChannelTypeBasic is a ChannelType enum value
	ChannelTypeBasic = "BASIC"

	// ChannelTypeStandard is a ChannelType enum value
	ChannelTypeStandard = "STANDARD"

	// ChannelTypeAdvancedSd is a ChannelType enum value
	ChannelTypeAdvancedSd = "ADVANCED_SD"

	// ChannelTypeAdvancedHd is a ChannelType enum value
	ChannelTypeAdvancedHd = "ADVANCED_HD"
)
View Source 
const (
	// RecordingConfigurationStateCreating is a RecordingConfigurationState enum value
	RecordingConfigurationStateCreating = "CREATING"

	// RecordingConfigurationStateCreateFailed is a RecordingConfigurationState enum value
	RecordingConfigurationStateCreateFailed = "CREATE_FAILED"

	// RecordingConfigurationStateActive is a RecordingConfigurationState enum value
	RecordingConfigurationStateActive = "ACTIVE"
)
View Source 
const (
	// RecordingModeDisabled is a RecordingMode enum value
	RecordingModeDisabled = "DISABLED"

	// RecordingModeInterval is a RecordingMode enum value
	RecordingModeInterval = "INTERVAL"
)
View Source 
const (
	// StreamHealthHealthy is a StreamHealth enum value
	StreamHealthHealthy = "HEALTHY"

	// StreamHealthStarving is a StreamHealth enum value
	StreamHealthStarving = "STARVING"

	// StreamHealthUnknown is a StreamHealth enum value
	StreamHealthUnknown = "UNKNOWN"
)
View Source 
const (
	// StreamStateLive is a StreamState enum value
	StreamStateLive = "LIVE"

	// StreamStateOffline is a StreamState enum value
	StreamStateOffline = "OFFLINE"
)
View Source 
const (
	// TranscodePresetHigherBandwidthDelivery is a TranscodePreset enum value
	TranscodePresetHigherBandwidthDelivery = "HIGHER_BANDWIDTH_DELIVERY"

	// TranscodePresetConstrainedBandwidthDelivery is a TranscodePreset enum value
	TranscodePresetConstrainedBandwidthDelivery = "CONSTRAINED_BANDWIDTH_DELIVERY"
)
View Source 
const (

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

	// ErrCodeChannelNotBroadcasting for service response error code
	// "ChannelNotBroadcasting".
	ErrCodeChannelNotBroadcasting = "ChannelNotBroadcasting"

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

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

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

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

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

	// ErrCodeStreamUnavailable for service response error code
	// "StreamUnavailable".
	ErrCodeStreamUnavailable = "StreamUnavailable"

	// ErrCodeThrottlingException for service response error code
	// "ThrottlingException".
	ErrCodeThrottlingException = "ThrottlingException"

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

Service information constants

Variables

This section is empty.

Functions

func ChannelLatencyMode_Values added in v1.34.3 

func ChannelLatencyMode_Values() []string

ChannelLatencyMode_Values returns all elements of the ChannelLatencyMode enum

func ChannelType_Values added in v1.34.3 

func ChannelType_Values() []string

ChannelType_Values returns all elements of the ChannelType enum

func RecordingConfigurationState_Values added in v1.38.15 

func RecordingConfigurationState_Values() []string

RecordingConfigurationState_Values returns all elements of the RecordingConfigurationState enum

func RecordingMode_Values added in v1.42.36 

func RecordingMode_Values() []string

RecordingMode_Values returns all elements of the RecordingMode enum

func StreamHealth_Values added in v1.34.3 

func StreamHealth_Values() []string

StreamHealth_Values returns all elements of the StreamHealth enum

func StreamState_Values added in v1.34.3 

func StreamState_Values() []string

StreamState_Values returns all elements of the StreamState enum

func TranscodePreset_Values added in v1.44.274 

func TranscodePreset_Values() []string

TranscodePreset_Values returns all elements of the TranscodePreset enum

Types

type AccessDeniedException 

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

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

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

func (*AccessDeniedException) Code 

func (s *AccessDeniedException) Code() string

Code returns the exception type name.

func (*AccessDeniedException) Error 

func (s *AccessDeniedException) Error() string

func (AccessDeniedException) GoString 

func (s AccessDeniedException) GoString() string

GoString returns the string representation.

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

func (*AccessDeniedException) Message 

func (s *AccessDeniedException) Message() string

Message returns the exception's message.

func (*AccessDeniedException) OrigErr 

func (s *AccessDeniedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*AccessDeniedException) RequestID 

func (s *AccessDeniedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*AccessDeniedException) StatusCode 

func (s *AccessDeniedException) StatusCode() int

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

func (AccessDeniedException) String 

func (s AccessDeniedException) String() string

String returns the string representation.

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

type AudioConfiguration added in v1.42.8 

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 (AudioConfiguration) GoString added in v1.42.8 

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 (*AudioConfiguration) SetChannels added in v1.42.8 

func (s *AudioConfiguration) SetChannels(v int64) *AudioConfiguration

SetChannels sets the Channels field's value.

func (*AudioConfiguration) SetCodec added in v1.42.8 

func (s *AudioConfiguration) SetCodec(v string) *AudioConfiguration

SetCodec sets the Codec field's value.

func (*AudioConfiguration) SetSampleRate added in v1.42.8 

func (s *AudioConfiguration) SetSampleRate(v int64) *AudioConfiguration

SetSampleRate sets the SampleRate field's value.

func (*AudioConfiguration) SetTargetBitrate added in v1.42.8 

func (s *AudioConfiguration) SetTargetBitrate(v int64) *AudioConfiguration

SetTargetBitrate sets the TargetBitrate field's value.

func (AudioConfiguration) String added in v1.42.8 

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 

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 (BatchError) GoString 

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 (*BatchError) SetArn 

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

SetArn sets the Arn field's value.

func (*BatchError) SetCode 

func (s *BatchError) SetCode(v string) *BatchError

SetCode sets the Code field's value.

func (*BatchError) SetMessage 

func (s *BatchError) SetMessage(v string) *BatchError

SetMessage sets the Message field's value.

func (BatchError) String 

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 

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 (BatchGetChannelInput) GoString 

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 (*BatchGetChannelInput) SetArns 

func (s *BatchGetChannelInput) SetArns(v []*string) *BatchGetChannelInput

SetArns sets the Arns field's value.

func (BatchGetChannelInput) String 

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 (*BatchGetChannelInput) Validate 

func (s *BatchGetChannelInput) Validate() error

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

type BatchGetChannelOutput 

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 (BatchGetChannelOutput) GoString 

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 (*BatchGetChannelOutput) SetChannels 

func (s *BatchGetChannelOutput) SetChannels(v []*Channel) *BatchGetChannelOutput

SetChannels sets the Channels field's value.

func (*BatchGetChannelOutput) SetErrors 

func (s *BatchGetChannelOutput) SetErrors(v []*BatchError) *BatchGetChannelOutput

SetErrors sets the Errors field's value.

func (BatchGetChannelOutput) String 

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 

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 (BatchGetStreamKeyInput) GoString 

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 (*BatchGetStreamKeyInput) SetArns 

func (s *BatchGetStreamKeyInput) SetArns(v []*string) *BatchGetStreamKeyInput

SetArns sets the Arns field's value.

func (BatchGetStreamKeyInput) String 

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 (*BatchGetStreamKeyInput) Validate 

func (s *BatchGetStreamKeyInput) Validate() error

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

type BatchGetStreamKeyOutput 

type BatchGetStreamKeyOutput struct {
	Errors []*BatchError `locationName:"errors" type:"list"`

	StreamKeys []*StreamKey `locationName:"streamKeys" type:"list"`
	// contains filtered or unexported fields
}

func (BatchGetStreamKeyOutput) GoString 

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 (*BatchGetStreamKeyOutput) SetErrors 

func (s *BatchGetStreamKeyOutput) SetErrors(v []*BatchError) *BatchGetStreamKeyOutput

SetErrors sets the Errors field's value.

func (*BatchGetStreamKeyOutput) SetStreamKeys 

func (s *BatchGetStreamKeyOutput) SetStreamKeys(v []*StreamKey) *BatchGetStreamKeyOutput

SetStreamKeys sets the StreamKeys field's value.

func (BatchGetStreamKeyOutput) String 

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 Channel 

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.
	// (Note: In the Amazon IVS console, LOW and NORMAL correspond to Ultra-low
	// and Standard, respectively.)
	LatencyMode *string `locationName:"latencyMode" type:"string" enum:"ChannelLatencyMode"`

	// Channel name.
	Name *string `locationName:"name" 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 value other than an empty string indicates
	// that recording is enabled. 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. Some types generate multiple qualities (renditions)
	// from the original input; this automatically gives viewers the best experience
	// for their devices and network conditions. Some types provide transcoded video;
	// transcoding allows higher playback quality across a range of download speeds.
	// Default: STANDARD. Valid values:
	//
	//    * BASIC: Video is transmuxed: Amazon IVS delivers the original input quality
	//    to viewers. The viewer’s video-quality choice is limited to the original
	//    input. Input resolution can be up to 1080p and bitrate can be up to 1.5
	//    Mbps for 480p and up to 3.5 Mbps for resolutions between 480p and 1080p.
	//    Original audio is passed through.
	//
	//    * STANDARD: Video is transcoded: multiple qualities are generated from
	//    the original input, to automatically give viewers the best experience
	//    for their devices and network conditions. Transcoding allows higher playback
	//    quality across a range of download speeds. Resolution can be up to 1080p
	//    and bitrate can be up to 8.5 Mbps. Audio is transcoded only for renditions
	//    360p and below; above that, audio is passed through. This is the default
	//    when you create a channel.
	//
	//    * ADVANCED_SD: Video is transcoded; multiple qualities are generated from
	//    the original input, to automatically give viewers the best experience
	//    for their devices and network conditions. Input resolution can be up to
	//    1080p and bitrate can be up to 8.5 Mbps; output is capped at SD quality
	//    (480p). You can select an optional transcode preset (see below). Audio
	//    for all renditions is transcoded, and an audio-only rendition is available.
	//
	//    * ADVANCED_HD: Video is transcoded; multiple qualities are generated from
	//    the original input, to automatically give viewers the best experience
	//    for their devices and network conditions. Input resolution can be up to
	//    1080p and bitrate can be up to 8.5 Mbps; output is capped at HD quality
	//    (720p). You can select an optional transcode preset (see below). Audio
	//    for all renditions is transcoded, and an audio-only rendition is available.
	//
	// Optional transcode presets (available for the ADVANCED types) allow you to
	// trade off available download bandwidth and video quality, to optimize the
	// viewing experience. There are two presets:
	//
	//    * Constrained bandwidth delivery uses a lower bitrate for each quality
	//    level. Use it if you have low download bandwidth and/or simple video content
	//    (e.g., talking heads)
	//
	//    * Higher bandwidth delivery uses a higher bitrate for each quality level.
	//    Use it if you have high download bandwidth and/or complex video content
	//    (e.g., flashes and quick scene changes).
	Type *string `locationName:"type" type:"string" enum:"ChannelType"`
	// contains filtered or unexported fields
}

Object specifying a channel.

func (Channel) GoString 

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 (*Channel) SetArn 

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

SetArn sets the Arn field's value.

func (*Channel) SetAuthorized added in v1.34.8 

func (s *Channel) SetAuthorized(v bool) *Channel

SetAuthorized sets the Authorized field's value.

func (*Channel) SetIngestEndpoint 

func (s *Channel) SetIngestEndpoint(v string) *Channel

SetIngestEndpoint sets the IngestEndpoint field's value.

func (*Channel) SetInsecureIngest added in v1.44.233 

func (s *Channel) SetInsecureIngest(v bool) *Channel

SetInsecureIngest sets the InsecureIngest field's value.

func (*Channel) SetLatencyMode 

func (s *Channel) SetLatencyMode(v string) *Channel

SetLatencyMode sets the LatencyMode field's value.

func (*Channel) SetName 

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

SetName sets the Name field's value.

func (*Channel) SetPlaybackUrl 

func (s *Channel) SetPlaybackUrl(v string) *Channel

SetPlaybackUrl sets the PlaybackUrl field's value.

func (*Channel) SetPreset added in v1.44.274 

func (s *Channel) SetPreset(v string) *Channel

SetPreset sets the Preset field's value.

func (*Channel) SetRecordingConfigurationArn added in v1.38.15 

func (s *Channel) SetRecordingConfigurationArn(v string) *Channel

SetRecordingConfigurationArn sets the RecordingConfigurationArn field's value.

func (*Channel) SetTags 

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

SetTags sets the Tags field's value.

func (*Channel) SetType 

func (s *Channel) SetType(v string) *Channel

SetType sets the Type field's value.

func (Channel) String 

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 

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 (*ChannelNotBroadcasting) Code 

func (s *ChannelNotBroadcasting) Code() string

Code returns the exception type name.

func (*ChannelNotBroadcasting) Error 

func (s *ChannelNotBroadcasting) Error() string

func (ChannelNotBroadcasting) GoString 

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 (*ChannelNotBroadcasting) Message 

func (s *ChannelNotBroadcasting) Message() string

Message returns the exception's message.

func (*ChannelNotBroadcasting) OrigErr 

func (s *ChannelNotBroadcasting) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ChannelNotBroadcasting) RequestID 

func (s *ChannelNotBroadcasting) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ChannelNotBroadcasting) StatusCode 

func (s *ChannelNotBroadcasting) StatusCode() int

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

func (ChannelNotBroadcasting) String 

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 

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.
	// (Note: In the Amazon IVS console, LOW and NORMAL correspond to Ultra-low
	// and Standard, respectively.)
	LatencyMode *string `locationName:"latencyMode" type:"string" enum:"ChannelLatencyMode"`

	// Channel name.
	Name *string `locationName:"name" 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 value other than an empty string indicates
	// that recording is enabled. 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. Some types generate multiple qualities (renditions)
	// from the original input; this automatically gives viewers the best experience
	// for their devices and network conditions. Some types provide transcoded video;
	// transcoding allows higher playback quality across a range of download speeds.
	// Default: STANDARD. Valid values:
	//
	//    * BASIC: Video is transmuxed: Amazon IVS delivers the original input quality
	//    to viewers. The viewer’s video-quality choice is limited to the original
	//    input. Input resolution can be up to 1080p and bitrate can be up to 1.5
	//    Mbps for 480p and up to 3.5 Mbps for resolutions between 480p and 1080p.
	//    Original audio is passed through.
	//
	//    * STANDARD: Video is transcoded: multiple qualities are generated from
	//    the original input, to automatically give viewers the best experience
	//    for their devices and network conditions. Transcoding allows higher playback
	//    quality across a range of download speeds. Resolution can be up to 1080p
	//    and bitrate can be up to 8.5 Mbps. Audio is transcoded only for renditions
	//    360p and below; above that, audio is passed through. This is the default
	//    when you create a channel.
	//
	//    * ADVANCED_SD: Video is transcoded; multiple qualities are generated from
	//    the original input, to automatically give viewers the best experience
	//    for their devices and network conditions. Input resolution can be up to
	//    1080p and bitrate can be up to 8.5 Mbps; output is capped at SD quality
	//    (480p). You can select an optional transcode preset (see below). Audio
	//    for all renditions is transcoded, and an audio-only rendition is available.
	//
	//    * ADVANCED_HD: Video is transcoded; multiple qualities are generated from
	//    the original input, to automatically give viewers the best experience
	//    for their devices and network conditions. Input resolution can be up to
	//    1080p and bitrate can be up to 8.5 Mbps; output is capped at HD quality
	//    (720p). You can select an optional transcode preset (see below). Audio
	//    for all renditions is transcoded, and an audio-only rendition is available.
	//
	// Optional transcode presets (available for the ADVANCED types) allow you to
	// trade off available download bandwidth and video quality, to optimize the
	// viewing experience. There are two presets:
	//
	//    * Constrained bandwidth delivery uses a lower bitrate for each quality
	//    level. Use it if you have low download bandwidth and/or simple video content
	//    (e.g., talking heads)
	//
	//    * Higher bandwidth delivery uses a higher bitrate for each quality level.
	//    Use it if you have high download bandwidth and/or complex video content
	//    (e.g., flashes and quick scene changes).
	Type *string `locationName:"type" type:"string" enum:"ChannelType"`
	// contains filtered or unexported fields
}

Summary information about a channel.

func (ChannelSummary) GoString 

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 (*ChannelSummary) SetArn 

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

SetArn sets the Arn field's value.

func (*ChannelSummary) SetAuthorized added in v1.34.8 

func (s *ChannelSummary) SetAuthorized(v bool) *ChannelSummary

SetAuthorized sets the Authorized field's value.

func (*ChannelSummary) SetInsecureIngest added in v1.44.233 

func (s *ChannelSummary) SetInsecureIngest(v bool) *ChannelSummary

SetInsecureIngest sets the InsecureIngest field's value.

func (*ChannelSummary) SetLatencyMode 

func (s *ChannelSummary) SetLatencyMode(v string) *ChannelSummary

SetLatencyMode sets the LatencyMode field's value.

func (*ChannelSummary) SetName 

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

SetName sets the Name field's value.

func (*ChannelSummary) SetPreset added in v1.44.274 

func (s *ChannelSummary) SetPreset(v string) *ChannelSummary

SetPreset sets the Preset field's value.

func (*ChannelSummary) SetRecordingConfigurationArn added in v1.38.15 

func (s *ChannelSummary) SetRecordingConfigurationArn(v string) *ChannelSummary

SetRecordingConfigurationArn sets the RecordingConfigurationArn field's value.

func (*ChannelSummary) SetTags 

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

SetTags sets the Tags field's value.

func (*ChannelSummary) SetType added in v1.44.274 

func (s *ChannelSummary) SetType(v string) *ChannelSummary

SetType sets the Type field's value.

func (ChannelSummary) String 

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 

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

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

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

func (*ConflictException) Code 

func (s *ConflictException) Code() string

Code returns the exception type name.

func (*ConflictException) Error 

func (s *ConflictException) Error() string

func (ConflictException) GoString 

func (s ConflictException) GoString() string

GoString returns the string representation.

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

func (*ConflictException) Message 

func (s *ConflictException) Message() string

Message returns the exception's message.

func (*ConflictException) OrigErr 

func (s *ConflictException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ConflictException) RequestID 

func (s *ConflictException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ConflictException) StatusCode 

func (s *ConflictException) StatusCode() int

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

func (ConflictException) String 

func (s ConflictException) String() string

String returns the string representation.

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

type CreateChannelInput 

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 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. (Note: In the
	// Amazon IVS console, LOW and NORMAL correspond to Ultra-low and Standard,
	// respectively.) Default: LOW.
	LatencyMode *string `locationName:"latencyMode" type:"string" enum:"ChannelLatencyMode"`

	// Channel name.
	Name *string `locationName:"name" 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. 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. Some types generate multiple qualities (renditions)
	// from the original input; this automatically gives viewers the best experience
	// for their devices and network conditions. Some types provide transcoded video;
	// transcoding allows higher playback quality across a range of download speeds.
	// Default: STANDARD. Valid values:
	//
	//    * BASIC: Video is transmuxed: Amazon IVS delivers the original input quality
	//    to viewers. The viewer’s video-quality choice is limited to the original
	//    input. Input resolution can be up to 1080p and bitrate can be up to 1.5
	//    Mbps for 480p and up to 3.5 Mbps for resolutions between 480p and 1080p.
	//    Original audio is passed through.
	//
	//    * STANDARD: Video is transcoded: multiple qualities are generated from
	//    the original input, to automatically give viewers the best experience
	//    for their devices and network conditions. Transcoding allows higher playback
	//    quality across a range of download speeds. Resolution can be up to 1080p
	//    and bitrate can be up to 8.5 Mbps. Audio is transcoded only for renditions
	//    360p and below; above that, audio is passed through. This is the default
	//    when you create a channel.
	//
	//    * ADVANCED_SD: Video is transcoded; multiple qualities are generated from
	//    the original input, to automatically give viewers the best experience
	//    for their devices and network conditions. Input resolution can be up to
	//    1080p and bitrate can be up to 8.5 Mbps; output is capped at SD quality
	//    (480p). You can select an optional transcode preset (see below). Audio
	//    for all renditions is transcoded, and an audio-only rendition is available.
	//
	//    * ADVANCED_HD: Video is transcoded; multiple qualities are generated from
	//    the original input, to automatically give viewers the best experience
	//    for their devices and network conditions. Input resolution can be up to
	//    1080p and bitrate can be up to 8.5 Mbps; output is capped at HD quality
	//    (720p). You can select an optional transcode preset (see below). Audio
	//    for all renditions is transcoded, and an audio-only rendition is available.
	//
	// Optional transcode presets (available for the ADVANCED types) allow you to
	// trade off available download bandwidth and video quality, to optimize the
	// viewing experience. There are two presets:
	//
	//    * Constrained bandwidth delivery uses a lower bitrate for each quality
	//    level. Use it if you have low download bandwidth and/or simple video content
	//    (e.g., talking heads)
	//
	//    * Higher bandwidth delivery uses a higher bitrate for each quality level.
	//    Use it if you have high download bandwidth and/or complex video content
	//    (e.g., flashes and quick scene changes).
	Type *string `locationName:"type" type:"string" enum:"ChannelType"`
	// contains filtered or unexported fields
}

func (CreateChannelInput) GoString 

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 (*CreateChannelInput) SetAuthorized added in v1.34.8 

func (s *CreateChannelInput) SetAuthorized(v bool) *CreateChannelInput

SetAuthorized sets the Authorized field's value.

func (*CreateChannelInput) SetInsecureIngest added in v1.44.233 

func (s *CreateChannelInput) SetInsecureIngest(v bool) *CreateChannelInput

SetInsecureIngest sets the InsecureIngest field's value.

func (*CreateChannelInput) SetLatencyMode 

func (s *CreateChannelInput) SetLatencyMode(v string) *CreateChannelInput

SetLatencyMode sets the LatencyMode field's value.

func (*CreateChannelInput) SetName 

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

SetName sets the Name field's value.

func (*CreateChannelInput) SetPreset added in v1.44.274 

func (s *CreateChannelInput) SetPreset(v string) *CreateChannelInput

SetPreset sets the Preset field's value.

func (*CreateChannelInput) SetRecordingConfigurationArn added in v1.38.15 

func (s *CreateChannelInput) SetRecordingConfigurationArn(v string) *CreateChannelInput

SetRecordingConfigurationArn sets the RecordingConfigurationArn field's value.

func (*CreateChannelInput) SetTags 

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

SetTags sets the Tags field's value.

func (*CreateChannelInput) SetType 

func (s *CreateChannelInput) SetType(v string) *CreateChannelInput

SetType sets the Type field's value.

func (CreateChannelInput) String 

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 

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 (CreateChannelOutput) GoString 

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 (*CreateChannelOutput) SetChannel 

func (s *CreateChannelOutput) SetChannel(v *Channel) *CreateChannelOutput

SetChannel sets the Channel field's value.

func (*CreateChannelOutput) SetStreamKey 

func (s *CreateChannelOutput) SetStreamKey(v *StreamKey) *CreateChannelOutput

SetStreamKey sets the StreamKey field's value.

func (CreateChannelOutput) String 

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

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"`

	// 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 (CreateRecordingConfigurationInput) GoString added in v1.38.15 

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 (*CreateRecordingConfigurationInput) SetDestinationConfiguration added in v1.38.15 

func (s *CreateRecordingConfigurationInput) SetDestinationConfiguration(v *DestinationConfiguration) *CreateRecordingConfigurationInput

SetDestinationConfiguration sets the DestinationConfiguration field's value.

func (*CreateRecordingConfigurationInput) SetName added in v1.38.15 

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

SetName sets the Name field's value.

func (*CreateRecordingConfigurationInput) SetRecordingReconnectWindowSeconds added in v1.44.89 

func (s *CreateRecordingConfigurationInput) SetRecordingReconnectWindowSeconds(v int64) *CreateRecordingConfigurationInput

SetRecordingReconnectWindowSeconds sets the RecordingReconnectWindowSeconds field's value.

func (*CreateRecordingConfigurationInput) SetTags added in v1.38.15 

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

SetTags sets the Tags field's value.

func (*CreateRecordingConfigurationInput) SetThumbnailConfiguration added in v1.42.36 

func (s *CreateRecordingConfigurationInput) SetThumbnailConfiguration(v *ThumbnailConfiguration) *CreateRecordingConfigurationInput

SetThumbnailConfiguration sets the ThumbnailConfiguration field's value.

func (CreateRecordingConfigurationInput) String added in v1.38.15 

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 (*CreateRecordingConfigurationInput) Validate added in v1.38.15 

func (s *CreateRecordingConfigurationInput) Validate() error

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

type CreateRecordingConfigurationOutput added in v1.38.15 

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 (CreateRecordingConfigurationOutput) GoString added in v1.38.15 

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 (*CreateRecordingConfigurationOutput) SetRecordingConfiguration added in v1.38.15 

func (s *CreateRecordingConfigurationOutput) SetRecordingConfiguration(v *RecordingConfiguration) *CreateRecordingConfigurationOutput

SetRecordingConfiguration sets the RecordingConfiguration field's value.

func (CreateRecordingConfigurationOutput) String added in v1.38.15 

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 

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 (CreateStreamKeyInput) GoString 

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 (*CreateStreamKeyInput) SetChannelArn 

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

SetChannelArn sets the ChannelArn field's value.

func (*CreateStreamKeyInput) SetTags 

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

SetTags sets the Tags field's value.

func (CreateStreamKeyInput) String 

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 (*CreateStreamKeyInput) Validate 

func (s *CreateStreamKeyInput) Validate() error

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

type CreateStreamKeyOutput 

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 (CreateStreamKeyOutput) GoString 

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 (*CreateStreamKeyOutput) SetStreamKey 

func (s *CreateStreamKeyOutput) SetStreamKey(v *StreamKey) *CreateStreamKeyOutput

SetStreamKey sets the StreamKey field's value.

func (CreateStreamKeyOutput) String 

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 

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 (DeleteChannelInput) GoString 

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 (*DeleteChannelInput) SetArn 

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

SetArn sets the Arn field's value.

func (DeleteChannelInput) String 

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 (*DeleteChannelInput) Validate 

func (s *DeleteChannelInput) Validate() error

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

type DeleteChannelOutput 

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

func (DeleteChannelOutput) GoString 

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 (DeleteChannelOutput) String 

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

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 (DeletePlaybackKeyPairInput) GoString added in v1.34.8 

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 (*DeletePlaybackKeyPairInput) SetArn added in v1.34.8 

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

SetArn sets the Arn field's value.

func (DeletePlaybackKeyPairInput) String added in v1.34.8 

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 (*DeletePlaybackKeyPairInput) Validate added in v1.34.8 

func (s *DeletePlaybackKeyPairInput) Validate() error

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

type DeletePlaybackKeyPairOutput added in v1.34.8 

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

func (DeletePlaybackKeyPairOutput) GoString added in v1.34.8 

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 (DeletePlaybackKeyPairOutput) String added in v1.34.8 

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

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 (DeleteRecordingConfigurationInput) GoString added in v1.38.15 

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 (*DeleteRecordingConfigurationInput) SetArn added in v1.38.15 

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

SetArn sets the Arn field's value.

func (DeleteRecordingConfigurationInput) String added in v1.38.15 

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 (*DeleteRecordingConfigurationInput) Validate added in v1.38.15 

func (s *DeleteRecordingConfigurationInput) Validate() error

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

type DeleteRecordingConfigurationOutput added in v1.38.15 

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

func (DeleteRecordingConfigurationOutput) GoString added in v1.38.15 

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 (DeleteRecordingConfigurationOutput) String added in v1.38.15 

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 

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 (DeleteStreamKeyInput) GoString 

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 (*DeleteStreamKeyInput) SetArn 

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

SetArn sets the Arn field's value.

func (DeleteStreamKeyInput) String 

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 (*DeleteStreamKeyInput) Validate 

func (s *DeleteStreamKeyInput) Validate() error

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

type DeleteStreamKeyOutput 

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

func (DeleteStreamKeyOutput) GoString 

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 (DeleteStreamKeyOutput) String 

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

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 (DestinationConfiguration) GoString added in v1.38.15 

func (s DestinationConfiguration) GoString() string

GoString returns the string representation.

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

func (*DestinationConfiguration) SetS3 added in v1.38.15 

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

SetS3 sets the S3 field's value.

func (DestinationConfiguration) String added in v1.38.15 

func (s DestinationConfiguration) String() string

String returns the string representation.

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

func (*DestinationConfiguration) Validate added in v1.38.15 

func (s *DestinationConfiguration) Validate() error

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

type GetChannelInput 

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 (GetChannelInput) GoString 

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 (*GetChannelInput) SetArn 

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

SetArn sets the Arn field's value.

func (GetChannelInput) String 

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 (*GetChannelInput) Validate 

func (s *GetChannelInput) Validate() error

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

type GetChannelOutput 

type GetChannelOutput struct {

	// Object specifying a channel.
	Channel *Channel `locationName:"channel" type:"structure"`
	// contains filtered or unexported fields
}

func (GetChannelOutput) GoString 

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 (*GetChannelOutput) SetChannel 

func (s *GetChannelOutput) SetChannel(v *Channel) *GetChannelOutput

SetChannel sets the Channel field's value.

func (GetChannelOutput) String 

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

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 (GetPlaybackKeyPairInput) GoString added in v1.34.8 

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 (*GetPlaybackKeyPairInput) SetArn added in v1.34.8 

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

SetArn sets the Arn field's value.

func (GetPlaybackKeyPairInput) String added in v1.34.8 

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 (*GetPlaybackKeyPairInput) Validate added in v1.34.8 

func (s *GetPlaybackKeyPairInput) Validate() error

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

type GetPlaybackKeyPairOutput added in v1.34.8 

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 (GetPlaybackKeyPairOutput) GoString added in v1.34.8 

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 (*GetPlaybackKeyPairOutput) SetKeyPair added in v1.34.8 

func (s *GetPlaybackKeyPairOutput) SetKeyPair(v *PlaybackKeyPair) *GetPlaybackKeyPairOutput

SetKeyPair sets the KeyPair field's value.

func (GetPlaybackKeyPairOutput) String added in v1.34.8 

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

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 (GetRecordingConfigurationInput) GoString added in v1.38.15 

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 (*GetRecordingConfigurationInput) SetArn added in v1.38.15 

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

SetArn sets the Arn field's value.

func (GetRecordingConfigurationInput) String added in v1.38.15 

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 (*GetRecordingConfigurationInput) Validate added in v1.38.15 

func (s *GetRecordingConfigurationInput) Validate() error

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

type GetRecordingConfigurationOutput added in v1.38.15 

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 (GetRecordingConfigurationOutput) GoString added in v1.38.15 

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 (*GetRecordingConfigurationOutput) SetRecordingConfiguration added in v1.38.15 

func (s *GetRecordingConfigurationOutput) SetRecordingConfiguration(v *RecordingConfiguration) *GetRecordingConfigurationOutput

SetRecordingConfiguration sets the RecordingConfiguration field's value.

func (GetRecordingConfigurationOutput) String added in v1.38.15 

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 

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 (GetStreamInput) GoString 

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 (*GetStreamInput) SetChannelArn 

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

SetChannelArn sets the ChannelArn field's value.

func (GetStreamInput) String 

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 (*GetStreamInput) Validate 

func (s *GetStreamInput) Validate() error

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

type GetStreamKeyInput 

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 (GetStreamKeyInput) GoString 

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 (*GetStreamKeyInput) SetArn 

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

SetArn sets the Arn field's value.

func (GetStreamKeyInput) String 

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 (*GetStreamKeyInput) Validate 

func (s *GetStreamKeyInput) Validate() error

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

type GetStreamKeyOutput 

type GetStreamKeyOutput struct {

	// Object specifying a stream key.
	StreamKey *StreamKey `locationName:"streamKey" type:"structure"`
	// contains filtered or unexported fields
}

func (GetStreamKeyOutput) GoString 

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 (*GetStreamKeyOutput) SetStreamKey 

func (s *GetStreamKeyOutput) SetStreamKey(v *StreamKey) *GetStreamKeyOutput

SetStreamKey sets the StreamKey field's value.

func (GetStreamKeyOutput) String 

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 

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 (GetStreamOutput) GoString 

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 (*GetStreamOutput) SetStream 

func (s *GetStreamOutput) SetStream(v *Stream) *GetStreamOutput

SetStream sets the Stream field's value.

func (GetStreamOutput) String 

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

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 (GetStreamSessionInput) GoString added in v1.42.8 

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 (*GetStreamSessionInput) SetChannelArn added in v1.42.8 

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

SetChannelArn sets the ChannelArn field's value.

func (*GetStreamSessionInput) SetStreamId added in v1.42.8 

func (s *GetStreamSessionInput) SetStreamId(v string) *GetStreamSessionInput

SetStreamId sets the StreamId field's value.

func (GetStreamSessionInput) String added in v1.42.8 

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 (*GetStreamSessionInput) Validate added in v1.42.8 

func (s *GetStreamSessionInput) Validate() error

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

type GetStreamSessionOutput added in v1.42.8 

type GetStreamSessionOutput struct {

	// List of stream details.
	StreamSession *StreamSession `locationName:"streamSession" type:"structure"`
	// contains filtered or unexported fields
}

func (GetStreamSessionOutput) GoString added in v1.42.8 

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 (*GetStreamSessionOutput) SetStreamSession added in v1.42.8 

func (s *GetStreamSessionOutput) SetStreamSession(v *StreamSession) *GetStreamSessionOutput

SetStreamSession sets the StreamSession field's value.

func (GetStreamSessionOutput) String added in v1.42.8 

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 

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 

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 (*IVS) BatchGetChannel 

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 (*IVS) BatchGetChannelRequest 

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 (*IVS) BatchGetChannelWithContext 

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 (*IVS) BatchGetStreamKey 

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 (*IVS) BatchGetStreamKeyRequest 

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 (*IVS) BatchGetStreamKeyWithContext 

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 (*IVS) CreateChannel 

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 (*IVS) CreateChannelRequest 

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 (*IVS) CreateChannelWithContext 

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 (*IVS) CreateRecordingConfiguration added in v1.38.15 

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 (*IVS) CreateRecordingConfigurationRequest added in v1.38.15 

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 (*IVS) CreateRecordingConfigurationWithContext added in v1.38.15 

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 (*IVS) CreateStreamKey 

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 (*IVS) CreateStreamKeyRequest 

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 (*IVS) CreateStreamKeyWithContext 

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 (*IVS) DeleteChannel 

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 (*IVS) DeleteChannelRequest 

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 (*IVS) DeleteChannelWithContext 

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 (*IVS) DeletePlaybackKeyPair added in v1.34.8 

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 (*IVS) DeletePlaybackKeyPairRequest added in v1.34.8 

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 (*IVS) DeletePlaybackKeyPairWithContext added in v1.34.8 

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 (*IVS) DeleteRecordingConfiguration added in v1.38.15 

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 (*IVS) DeleteRecordingConfigurationRequest added in v1.38.15 

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 (*IVS) DeleteRecordingConfigurationWithContext added in v1.38.15 

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 (*IVS) DeleteStreamKey 

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 (*IVS) DeleteStreamKeyRequest 

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 (*IVS) DeleteStreamKeyWithContext 

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 (*IVS) GetChannel 

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 (*IVS) GetChannelRequest 

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 (*IVS) GetChannelWithContext 

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 (*IVS) GetPlaybackKeyPair added in v1.34.8 

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 (*IVS) GetPlaybackKeyPairRequest added in v1.34.8 

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 (*IVS) GetPlaybackKeyPairWithContext added in v1.34.8 

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 (*IVS) GetRecordingConfiguration added in v1.38.15 

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 (*IVS) GetRecordingConfigurationRequest added in v1.38.15 

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 (*IVS) GetRecordingConfigurationWithContext added in v1.38.15 

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 (*IVS) GetStream 

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 (*IVS) GetStreamKey 

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 (*IVS) GetStreamKeyRequest 

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 (*IVS) GetStreamKeyWithContext 

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 (*IVS) GetStreamRequest 

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 (*IVS) GetStreamSession added in v1.42.8 

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 (*IVS) GetStreamSessionRequest added in v1.42.8 

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 (*IVS) GetStreamSessionWithContext added in v1.42.8 

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 (*IVS) GetStreamWithContext 

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 (*IVS) ImportPlaybackKeyPair added in v1.34.8 

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 (*IVS) ImportPlaybackKeyPairRequest added in v1.34.8 

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 (*IVS) ImportPlaybackKeyPairWithContext added in v1.34.8 

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 (*IVS) ListChannels 

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 (*IVS) ListChannelsPages 

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 (*IVS) ListChannelsPagesWithContext 

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 (*IVS) ListChannelsRequest 

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 (*IVS) ListChannelsWithContext 

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 (*IVS) ListPlaybackKeyPairs added in v1.34.8 

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 (*IVS) ListPlaybackKeyPairsPages added in v1.34.8 

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 (*IVS) ListPlaybackKeyPairsPagesWithContext added in v1.34.8 

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 (*IVS) ListPlaybackKeyPairsRequest added in v1.34.8 

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 (*IVS) ListPlaybackKeyPairsWithContext added in v1.34.8 

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 (*IVS) ListRecordingConfigurations added in v1.38.15 

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 (*IVS) ListRecordingConfigurationsPages added in v1.38.15 

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 (*IVS) ListRecordingConfigurationsPagesWithContext added in v1.38.15 

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 (*IVS) ListRecordingConfigurationsRequest added in v1.38.15 

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 (*IVS) ListRecordingConfigurationsWithContext added in v1.38.15 

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 (*IVS) ListStreamKeys 

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 (*IVS) ListStreamKeysPages 

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 (*IVS) ListStreamKeysPagesWithContext 

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 (*IVS) ListStreamKeysRequest 

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 (*IVS) ListStreamKeysWithContext 

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 (*IVS) ListStreamSessions added in v1.42.8 

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 (*IVS) ListStreamSessionsPages added in v1.42.8 

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 (*IVS) ListStreamSessionsPagesWithContext added in v1.42.8 

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 (*IVS) ListStreamSessionsRequest added in v1.42.8 

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 (*IVS) ListStreamSessionsWithContext added in v1.42.8 

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 (*IVS) ListStreams 

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 (*IVS) ListStreamsPages 

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 (*IVS) ListStreamsPagesWithContext 

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 (*IVS) ListStreamsRequest 

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 (*IVS) ListStreamsWithContext 

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 (*IVS) ListTagsForResource 

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 (*IVS) ListTagsForResourceRequest 

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 (*IVS) ListTagsForResourceWithContext 

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 (*IVS) PutMetadata 

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 (*IVS) PutMetadataRequest 

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 (*IVS) PutMetadataWithContext 

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 (*IVS) StopStream 

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 (*IVS) StopStreamRequest 

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 (*IVS) StopStreamWithContext 

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 (*IVS) TagResource 

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 (*IVS) TagResourceRequest 

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 (*IVS) TagResourceWithContext 

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 (*IVS) UntagResource 

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 (*IVS) UntagResourceRequest 

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 (*IVS) UntagResourceWithContext 

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 (*IVS) UpdateChannel 

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 (*IVS) UpdateChannelRequest 

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 (*IVS) UpdateChannelWithContext 

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.

type ImportPlaybackKeyPairInput added in v1.34.8 

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 (ImportPlaybackKeyPairInput) GoString added in v1.34.8 

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 (*ImportPlaybackKeyPairInput) SetName added in v1.34.8 

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

SetName sets the Name field's value.

func (*ImportPlaybackKeyPairInput) SetPublicKeyMaterial added in v1.34.8 

func (s *ImportPlaybackKeyPairInput) SetPublicKeyMaterial(v string) *ImportPlaybackKeyPairInput

SetPublicKeyMaterial sets the PublicKeyMaterial field's value.

func (*ImportPlaybackKeyPairInput) SetTags added in v1.34.8 

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

SetTags sets the Tags field's value.

func (ImportPlaybackKeyPairInput) String added in v1.34.8 

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 (*ImportPlaybackKeyPairInput) Validate added in v1.34.8 

func (s *ImportPlaybackKeyPairInput) Validate() error

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

type ImportPlaybackKeyPairOutput added in v1.34.8 

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 (ImportPlaybackKeyPairOutput) GoString added in v1.34.8 

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 (*ImportPlaybackKeyPairOutput) SetKeyPair added in v1.34.8 

func (s *ImportPlaybackKeyPairOutput) SetKeyPair(v *PlaybackKeyPair) *ImportPlaybackKeyPairOutput

SetKeyPair sets the KeyPair field's value.

func (ImportPlaybackKeyPairOutput) String added in v1.34.8 

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

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 (IngestConfiguration) GoString added in v1.42.8 

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 (*IngestConfiguration) SetAudio added in v1.42.8 

func (s *IngestConfiguration) SetAudio(v *AudioConfiguration) *IngestConfiguration

SetAudio sets the Audio field's value.

func (*IngestConfiguration) SetVideo added in v1.42.8 

func (s *IngestConfiguration) SetVideo(v *VideoConfiguration) *IngestConfiguration

SetVideo sets the Video field's value.

func (IngestConfiguration) String added in v1.42.8 

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 

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

	// Unexpected error during processing of request.
	ExceptionMessage *string `locationName:"exceptionMessage" type:"string"`

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

func (*InternalServerException) Code 

func (s *InternalServerException) Code() string

Code returns the exception type name.

func (*InternalServerException) Error 

func (s *InternalServerException) Error() string

func (InternalServerException) GoString 

func (s InternalServerException) GoString() string

GoString returns the string representation.

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

func (*InternalServerException) Message 

func (s *InternalServerException) Message() string

Message returns the exception's message.

func (*InternalServerException) OrigErr 

func (s *InternalServerException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalServerException) RequestID 

func (s *InternalServerException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalServerException) StatusCode 

func (s *InternalServerException) StatusCode() int

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

func (InternalServerException) String 

func (s InternalServerException) String() string

String returns the string representation.

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

type ListChannelsInput 

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 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 (ListChannelsInput) GoString 

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 (*ListChannelsInput) SetFilterByName 

func (s *ListChannelsInput) SetFilterByName(v string) *ListChannelsInput

SetFilterByName sets the FilterByName field's value.

func (*ListChannelsInput) SetFilterByRecordingConfigurationArn added in v1.38.15 

func (s *ListChannelsInput) SetFilterByRecordingConfigurationArn(v string) *ListChannelsInput

SetFilterByRecordingConfigurationArn sets the FilterByRecordingConfigurationArn field's value.

func (*ListChannelsInput) SetMaxResults 

func (s *ListChannelsInput) SetMaxResults(v int64) *ListChannelsInput

SetMaxResults sets the MaxResults field's value.

func (*ListChannelsInput) SetNextToken 

func (s *ListChannelsInput) SetNextToken(v string) *ListChannelsInput

SetNextToken sets the NextToken field's value.

func (ListChannelsInput) String 

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 (*ListChannelsInput) Validate 

func (s *ListChannelsInput) Validate() error

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

type ListChannelsOutput 

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 (ListChannelsOutput) GoString 

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 (*ListChannelsOutput) SetChannels 

func (s *ListChannelsOutput) SetChannels(v []*ChannelSummary) *ListChannelsOutput

SetChannels sets the Channels field's value.

func (*ListChannelsOutput) SetNextToken 

func (s *ListChannelsOutput) SetNextToken(v string) *ListChannelsOutput

SetNextToken sets the NextToken field's value.

func (ListChannelsOutput) String 

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

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 (ListPlaybackKeyPairsInput) GoString added in v1.34.8 

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 (*ListPlaybackKeyPairsInput) SetMaxResults added in v1.34.8 

func (s *ListPlaybackKeyPairsInput) SetMaxResults(v int64) *ListPlaybackKeyPairsInput

SetMaxResults sets the MaxResults field's value.

func (*ListPlaybackKeyPairsInput) SetNextToken added in v1.34.8 

func (s *ListPlaybackKeyPairsInput) SetNextToken(v string) *ListPlaybackKeyPairsInput

SetNextToken sets the NextToken field's value.

func (ListPlaybackKeyPairsInput) String added in v1.34.8 

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 (*ListPlaybackKeyPairsInput) Validate added in v1.34.8 

func (s *ListPlaybackKeyPairsInput) Validate() error

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

type ListPlaybackKeyPairsOutput added in v1.34.8 

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 (ListPlaybackKeyPairsOutput) GoString added in v1.34.8 

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 (*ListPlaybackKeyPairsOutput) SetKeyPairs added in v1.34.8 

func (s *ListPlaybackKeyPairsOutput) SetKeyPairs(v []*PlaybackKeyPairSummary) *ListPlaybackKeyPairsOutput

SetKeyPairs sets the KeyPairs field's value.

func (*ListPlaybackKeyPairsOutput) SetNextToken added in v1.34.8 

func (s *ListPlaybackKeyPairsOutput) SetNextToken(v string) *ListPlaybackKeyPairsOutput

SetNextToken sets the NextToken field's value.

func (ListPlaybackKeyPairsOutput) String added in v1.34.8 

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

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 (ListRecordingConfigurationsInput) GoString added in v1.38.15 

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 (*ListRecordingConfigurationsInput) SetMaxResults added in v1.38.15 

func (s *ListRecordingConfigurationsInput) SetMaxResults(v int64) *ListRecordingConfigurationsInput

SetMaxResults sets the MaxResults field's value.

func (*ListRecordingConfigurationsInput) SetNextToken added in v1.38.15 

func (s *ListRecordingConfigurationsInput) SetNextToken(v string) *ListRecordingConfigurationsInput

SetNextToken sets the NextToken field's value.

func (ListRecordingConfigurationsInput) String added in v1.38.15 

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 (*ListRecordingConfigurationsInput) Validate added in v1.38.15 

func (s *ListRecordingConfigurationsInput) Validate() error

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

type ListRecordingConfigurationsOutput added in v1.38.15 

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 (ListRecordingConfigurationsOutput) GoString added in v1.38.15 

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 (*ListRecordingConfigurationsOutput) SetNextToken added in v1.38.15 

func (s *ListRecordingConfigurationsOutput) SetNextToken(v string) *ListRecordingConfigurationsOutput

SetNextToken sets the NextToken field's value.

func (*ListRecordingConfigurationsOutput) SetRecordingConfigurations added in v1.38.15 

func (s *ListRecordingConfigurationsOutput) SetRecordingConfigurations(v []*RecordingConfigurationSummary) *ListRecordingConfigurationsOutput

SetRecordingConfigurations sets the RecordingConfigurations field's value.

func (ListRecordingConfigurationsOutput) String added in v1.38.15 

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 

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 (ListStreamKeysInput) GoString 

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 (*ListStreamKeysInput) SetChannelArn 

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

SetChannelArn sets the ChannelArn field's value.

func (*ListStreamKeysInput) SetMaxResults 

func (s *ListStreamKeysInput) SetMaxResults(v int64) *ListStreamKeysInput

SetMaxResults sets the MaxResults field's value.

func (*ListStreamKeysInput) SetNextToken 

func (s *ListStreamKeysInput) SetNextToken(v string) *ListStreamKeysInput

SetNextToken sets the NextToken field's value.

func (ListStreamKeysInput) String 

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 (*ListStreamKeysInput) Validate 

func (s *ListStreamKeysInput) Validate() error

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

type ListStreamKeysOutput 

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 (ListStreamKeysOutput) GoString 

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 (*ListStreamKeysOutput) SetNextToken 

func (s *ListStreamKeysOutput) SetNextToken(v string) *ListStreamKeysOutput

SetNextToken sets the NextToken field's value.

func (*ListStreamKeysOutput) SetStreamKeys 

func (s *ListStreamKeysOutput) SetStreamKeys(v []*StreamKeySummary) *ListStreamKeysOutput

SetStreamKeys sets the StreamKeys field's value.

func (ListStreamKeysOutput) String 

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

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 (ListStreamSessionsInput) GoString added in v1.42.8 

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 (*ListStreamSessionsInput) SetChannelArn added in v1.42.8 

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

SetChannelArn sets the ChannelArn field's value.

func (*ListStreamSessionsInput) SetMaxResults added in v1.42.8 

func (s *ListStreamSessionsInput) SetMaxResults(v int64) *ListStreamSessionsInput

SetMaxResults sets the MaxResults field's value.

func (*ListStreamSessionsInput) SetNextToken added in v1.42.8 

func (s *ListStreamSessionsInput) SetNextToken(v string) *ListStreamSessionsInput

SetNextToken sets the NextToken field's value.

func (ListStreamSessionsInput) String added in v1.42.8 

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 (*ListStreamSessionsInput) Validate added in v1.42.8 

func (s *ListStreamSessionsInput) Validate() error

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

type ListStreamSessionsOutput added in v1.42.8 

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 (ListStreamSessionsOutput) GoString added in v1.42.8 

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 (*ListStreamSessionsOutput) SetNextToken added in v1.42.8 

func (s *ListStreamSessionsOutput) SetNextToken(v string) *ListStreamSessionsOutput

SetNextToken sets the NextToken field's value.

func (*ListStreamSessionsOutput) SetStreamSessions added in v1.42.8 

func (s *ListStreamSessionsOutput) SetStreamSessions(v []*StreamSessionSummary) *ListStreamSessionsOutput

SetStreamSessions sets the StreamSessions field's value.

func (ListStreamSessionsOutput) String added in v1.42.8 

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 

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 (ListStreamsInput) GoString 

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 (*ListStreamsInput) SetFilterBy added in v1.42.8 

func (s *ListStreamsInput) SetFilterBy(v *StreamFilters) *ListStreamsInput

SetFilterBy sets the FilterBy field's value.

func (*ListStreamsInput) SetMaxResults 

func (s *ListStreamsInput) SetMaxResults(v int64) *ListStreamsInput

SetMaxResults sets the MaxResults field's value.

func (*ListStreamsInput) SetNextToken 

func (s *ListStreamsInput) SetNextToken(v string) *ListStreamsInput

SetNextToken sets the NextToken field's value.

func (ListStreamsInput) String 

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 (*ListStreamsInput) Validate 

func (s *ListStreamsInput) Validate() error

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

type ListStreamsOutput 

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 (ListStreamsOutput) GoString 

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 (*ListStreamsOutput) SetNextToken 

func (s *ListStreamsOutput) SetNextToken(v string) *ListStreamsOutput

SetNextToken sets the NextToken field's value.

func (*ListStreamsOutput) SetStreams 

func (s *ListStreamsOutput) SetStreams(v []*StreamSummary) *ListStreamsOutput

SetStreams sets the Streams field's value.

func (ListStreamsOutput) String 

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 

type ListTagsForResourceInput struct {

	// The ARN of the resource to be retrieved. The ARN must be URL-encoded.
	//
	// ResourceArn is a required field
	ResourceArn *string `location:"uri" locationName:"resourceArn" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceInput) GoString 

func (s ListTagsForResourceInput) GoString() string

GoString returns the string representation.

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

func (*ListTagsForResourceInput) SetResourceArn 

func (s *ListTagsForResourceInput) SetResourceArn(v string) *ListTagsForResourceInput

SetResourceArn sets the ResourceArn field's value.

func (ListTagsForResourceInput) String 

func (s ListTagsForResourceInput) String() string

String returns the string representation.

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

func (*ListTagsForResourceInput) Validate 

func (s *ListTagsForResourceInput) Validate() error

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

type ListTagsForResourceOutput 

type ListTagsForResourceOutput struct {

	// Tags attached to the resource. Array of maps, each of the form string:string
	// (key:value).
	//
	// Tags is a required field
	Tags map[string]*string `locationName:"tags" type:"map" required:"true"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceOutput) GoString 

func (s ListTagsForResourceOutput) GoString() string

GoString returns the string representation.

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

func (*ListTagsForResourceOutput) SetTags 

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

SetTags sets the Tags field's value.

func (ListTagsForResourceOutput) String 

func (s ListTagsForResourceOutput) String() string

String returns the string representation.

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

type PendingVerification added in v1.33.14 

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

	// Your account is pending verification.
	ExceptionMessage *string `locationName:"exceptionMessage" type:"string"`

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

func (*PendingVerification) Code added in v1.33.14 

func (s *PendingVerification) Code() string

Code returns the exception type name.

func (*PendingVerification) Error added in v1.33.14 

func (s *PendingVerification) Error() string

func (PendingVerification) GoString added in v1.33.14 

func (s PendingVerification) GoString() string

GoString returns the string representation.

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

func (*PendingVerification) Message added in v1.33.14 

func (s *PendingVerification) Message() string

Message returns the exception's message.

func (*PendingVerification) OrigErr added in v1.33.14 

func (s *PendingVerification) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*PendingVerification) RequestID added in v1.33.14 

func (s *PendingVerification) RequestID() string

RequestID returns the service's response RequestID for request.

func (*PendingVerification) StatusCode added in v1.33.14 

func (s *PendingVerification) StatusCode() int

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

func (PendingVerification) String added in v1.33.14 

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

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 (PlaybackKeyPair) GoString added in v1.34.8 

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 (*PlaybackKeyPair) SetArn added in v1.34.8 

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

SetArn sets the Arn field's value.

func (*PlaybackKeyPair) SetFingerprint added in v1.34.8 

func (s *PlaybackKeyPair) SetFingerprint(v string) *PlaybackKeyPair

SetFingerprint sets the Fingerprint field's value.

func (*PlaybackKeyPair) SetName added in v1.34.8 

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

SetName sets the Name field's value.

func (*PlaybackKeyPair) SetTags added in v1.34.8 

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

SetTags sets the Tags field's value.

func (PlaybackKeyPair) String added in v1.34.8 

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

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 (PlaybackKeyPairSummary) GoString added in v1.34.8 

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 (*PlaybackKeyPairSummary) SetArn added in v1.34.8 

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

SetArn sets the Arn field's value.

func (*PlaybackKeyPairSummary) SetName added in v1.34.8 

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

SetName sets the Name field's value.

func (*PlaybackKeyPairSummary) SetTags added in v1.34.8 

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

SetTags sets the Tags field's value.

func (PlaybackKeyPairSummary) String added in v1.34.8 

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 PutMetadataInput 

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 (PutMetadataInput) GoString 

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 (*PutMetadataInput) SetChannelArn 

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

SetChannelArn sets the ChannelArn field's value.

func (*PutMetadataInput) SetMetadata 

func (s *PutMetadataInput) SetMetadata(v string) *PutMetadataInput

SetMetadata sets the Metadata field's value.

func (PutMetadataInput) String 

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 (*PutMetadataInput) Validate 

func (s *PutMetadataInput) Validate() error

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

type PutMetadataOutput 

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

func (PutMetadataOutput) GoString 

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 (PutMetadataOutput) String 

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

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"`

	// 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 (RecordingConfiguration) GoString added in v1.38.15 

func (s RecordingConfiguration) GoString() string

GoString returns the string representation.

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

func (*RecordingConfiguration) SetArn added in v1.38.15 

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

SetArn sets the Arn field's value.

func (*RecordingConfiguration) SetDestinationConfiguration added in v1.38.15 

func (s *RecordingConfiguration) SetDestinationConfiguration(v *DestinationConfiguration) *RecordingConfiguration

SetDestinationConfiguration sets the DestinationConfiguration field's value.

func (*RecordingConfiguration) SetName added in v1.38.15 

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

SetName sets the Name field's value.

func (*RecordingConfiguration) SetRecordingReconnectWindowSeconds added in v1.44.89 

func (s *RecordingConfiguration) SetRecordingReconnectWindowSeconds(v int64) *RecordingConfiguration

SetRecordingReconnectWindowSeconds sets the RecordingReconnectWindowSeconds field's value.

func (*RecordingConfiguration) SetState added in v1.38.15 

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

SetState sets the State field's value.

func (*RecordingConfiguration) SetTags added in v1.38.15 

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

SetTags sets the Tags field's value.

func (*RecordingConfiguration) SetThumbnailConfiguration added in v1.42.36 

func (s *RecordingConfiguration) SetThumbnailConfiguration(v *ThumbnailConfiguration) *RecordingConfiguration

SetThumbnailConfiguration sets the ThumbnailConfiguration field's value.

func (RecordingConfiguration) String added in v1.38.15 

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

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 (RecordingConfigurationSummary) GoString added in v1.38.15 

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 (*RecordingConfigurationSummary) SetArn added in v1.38.15 

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

SetArn sets the Arn field's value.

func (*RecordingConfigurationSummary) SetDestinationConfiguration added in v1.38.15 

func (s *RecordingConfigurationSummary) SetDestinationConfiguration(v *DestinationConfiguration) *RecordingConfigurationSummary

SetDestinationConfiguration sets the DestinationConfiguration field's value.

func (*RecordingConfigurationSummary) SetName added in v1.38.15 

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

SetName sets the Name field's value.

func (*RecordingConfigurationSummary) SetState added in v1.38.15 

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

SetState sets the State field's value.

func (*RecordingConfigurationSummary) SetTags added in v1.38.15 

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

SetTags sets the Tags field's value.

func (RecordingConfigurationSummary) String added in v1.38.15 

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 ResourceNotFoundException 

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

	// Request references a resource which does not exist.
	ExceptionMessage *string `locationName:"exceptionMessage" type:"string"`

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

func (*ResourceNotFoundException) Code 

func (s *ResourceNotFoundException) Code() string

Code returns the exception type name.

func (*ResourceNotFoundException) Error 

func (s *ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString 

func (s ResourceNotFoundException) GoString() string

GoString returns the string representation.

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

func (*ResourceNotFoundException) Message 

func (s *ResourceNotFoundException) Message() string

Message returns the exception's message.

func (*ResourceNotFoundException) OrigErr 

func (s *ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFoundException) RequestID 

func (s *ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFoundException) StatusCode 

func (s *ResourceNotFoundException) StatusCode() int

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

func (ResourceNotFoundException) String 

func (s ResourceNotFoundException) String() string

String returns the string representation.

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

type S3DestinationConfiguration added in v1.38.15 

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 (S3DestinationConfiguration) GoString added in v1.38.15 

func (s S3DestinationConfiguration) GoString() string

GoString returns the string representation.

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

func (*S3DestinationConfiguration) SetBucketName added in v1.38.15 

func (s *S3DestinationConfiguration) SetBucketName(v string) *S3DestinationConfiguration

SetBucketName sets the BucketName field's value.

func (S3DestinationConfiguration) String added in v1.38.15 

func (s S3DestinationConfiguration) String() string

String returns the string representation.

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

func (*S3DestinationConfiguration) Validate added in v1.38.15 

func (s *S3DestinationConfiguration) Validate() error

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

type ServiceQuotaExceededException 

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

	// Request would cause a service quota to be exceeded.
	ExceptionMessage *string `locationName:"exceptionMessage" type:"string"`

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

func (*ServiceQuotaExceededException) Code 

func (s *ServiceQuotaExceededException) Code() string

Code returns the exception type name.

func (*ServiceQuotaExceededException) Error 

func (s *ServiceQuotaExceededException) Error() string

func (ServiceQuotaExceededException) GoString 

func (s ServiceQuotaExceededException) GoString() string

GoString returns the string representation.

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

func (*ServiceQuotaExceededException) Message 

func (s *ServiceQuotaExceededException) Message() string

Message returns the exception's message.

func (*ServiceQuotaExceededException) OrigErr 

func (s *ServiceQuotaExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ServiceQuotaExceededException) RequestID 

func (s *ServiceQuotaExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ServiceQuotaExceededException) StatusCode 

func (s *ServiceQuotaExceededException) StatusCode() int

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

func (ServiceQuotaExceededException) String 

func (s ServiceQuotaExceededException) String() string

String returns the string representation.

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

type StopStreamInput 

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 (StopStreamInput) GoString 

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 (*StopStreamInput) SetChannelArn 

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

SetChannelArn sets the ChannelArn field's value.

func (StopStreamInput) String 

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 (*StopStreamInput) Validate 

func (s *StopStreamInput) Validate() error

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

type StopStreamOutput 

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

func (StopStreamOutput) GoString 

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 (StopStreamOutput) String 

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 

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 (Stream) GoString 

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 (*Stream) SetChannelArn 

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

SetChannelArn sets the ChannelArn field's value.

func (*Stream) SetHealth 

func (s *Stream) SetHealth(v string) *Stream

SetHealth sets the Health field's value.

func (*Stream) SetPlaybackUrl 

func (s *Stream) SetPlaybackUrl(v string) *Stream

SetPlaybackUrl sets the PlaybackUrl field's value.

func (*Stream) SetStartTime 

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

SetStartTime sets the StartTime field's value.

func (*Stream) SetState 

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

SetState sets the State field's value.

func (*Stream) SetStreamId added in v1.42.8 

func (s *Stream) SetStreamId(v string) *Stream

SetStreamId sets the StreamId field's value.

func (*Stream) SetViewerCount 

func (s *Stream) SetViewerCount(v int64) *Stream

SetViewerCount sets the ViewerCount field's value.

func (Stream) String 

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

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 (StreamEvent) GoString added in v1.42.8 

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 (*StreamEvent) SetEventTime added in v1.42.8 

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

SetEventTime sets the EventTime field's value.

func (*StreamEvent) SetName added in v1.42.8 

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

SetName sets the Name field's value.

func (*StreamEvent) SetType added in v1.42.8 

func (s *StreamEvent) SetType(v string) *StreamEvent

SetType sets the Type field's value.

func (StreamEvent) String added in v1.42.8 

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

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 (StreamFilters) GoString added in v1.42.8 

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 (*StreamFilters) SetHealth added in v1.42.8 

func (s *StreamFilters) SetHealth(v string) *StreamFilters

SetHealth sets the Health field's value.

func (StreamFilters) String added in v1.42.8 

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 

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 (StreamKey) GoString 

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 (*StreamKey) SetArn 

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

SetArn sets the Arn field's value.

func (*StreamKey) SetChannelArn 

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

SetChannelArn sets the ChannelArn field's value.

func (*StreamKey) SetTags 

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

SetTags sets the Tags field's value.

func (*StreamKey) SetValue 

func (s *StreamKey) SetValue(v string) *StreamKey

SetValue sets the Value field's value.

func (StreamKey) String 

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 

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 (StreamKeySummary) GoString 

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 (*StreamKeySummary) SetArn 

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

SetArn sets the Arn field's value.

func (*StreamKeySummary) SetChannelArn 

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

SetChannelArn sets the ChannelArn field's value.

func (*StreamKeySummary) SetTags 

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

SetTags sets the Tags field's value.

func (StreamKeySummary) String 

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

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 (StreamSession) GoString added in v1.42.8 

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 (*StreamSession) SetChannel added in v1.42.8 

func (s *StreamSession) SetChannel(v *Channel) *StreamSession

SetChannel sets the Channel field's value.

func (*StreamSession) SetEndTime added in v1.42.8 

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

SetEndTime sets the EndTime field's value.

func (*StreamSession) SetIngestConfiguration added in v1.42.8 

func (s *StreamSession) SetIngestConfiguration(v *IngestConfiguration) *StreamSession

SetIngestConfiguration sets the IngestConfiguration field's value.

func (*StreamSession) SetRecordingConfiguration added in v1.42.8 

func (s *StreamSession) SetRecordingConfiguration(v *RecordingConfiguration) *StreamSession

SetRecordingConfiguration sets the RecordingConfiguration field's value.

func (*StreamSession) SetStartTime added in v1.42.8 

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

SetStartTime sets the StartTime field's value.

func (*StreamSession) SetStreamId added in v1.42.8 

func (s *StreamSession) SetStreamId(v string) *StreamSession

SetStreamId sets the StreamId field's value.

func (*StreamSession) SetTruncatedEvents added in v1.42.8 

func (s *StreamSession) SetTruncatedEvents(v []*StreamEvent) *StreamSession

SetTruncatedEvents sets the TruncatedEvents field's value.

func (StreamSession) String added in v1.42.8 

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

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 (StreamSessionSummary) GoString added in v1.42.8 

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 (*StreamSessionSummary) SetEndTime added in v1.42.8 

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

SetEndTime sets the EndTime field's value.

func (*StreamSessionSummary) SetHasErrorEvent added in v1.42.8 

func (s *StreamSessionSummary) SetHasErrorEvent(v bool) *StreamSessionSummary

SetHasErrorEvent sets the HasErrorEvent field's value.

func (*StreamSessionSummary) SetStartTime added in v1.42.8 

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

SetStartTime sets the StartTime field's value.

func (*StreamSessionSummary) SetStreamId added in v1.42.8 

func (s *StreamSessionSummary) SetStreamId(v string) *StreamSessionSummary

SetStreamId sets the StreamId field's value.

func (StreamSessionSummary) String added in v1.42.8 

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 

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 (StreamSummary) GoString 

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 (*StreamSummary) SetChannelArn 

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

SetChannelArn sets the ChannelArn field's value.

func (*StreamSummary) SetHealth 

func (s *StreamSummary) SetHealth(v string) *StreamSummary

SetHealth sets the Health field's value.

func (*StreamSummary) SetStartTime 

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

SetStartTime sets the StartTime field's value.

func (*StreamSummary) SetState 

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

SetState sets the State field's value.

func (*StreamSummary) SetStreamId added in v1.42.8 

func (s *StreamSummary) SetStreamId(v string) *StreamSummary

SetStreamId sets the StreamId field's value.

func (*StreamSummary) SetViewerCount 

func (s *StreamSummary) SetViewerCount(v int64) *StreamSummary

SetViewerCount sets the ViewerCount field's value.

func (StreamSummary) String 

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 

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 (*StreamUnavailable) Code 

func (s *StreamUnavailable) Code() string

Code returns the exception type name.

func (*StreamUnavailable) Error 

func (s *StreamUnavailable) Error() string

func (StreamUnavailable) GoString 

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 (*StreamUnavailable) Message 

func (s *StreamUnavailable) Message() string

Message returns the exception's message.

func (*StreamUnavailable) OrigErr 

func (s *StreamUnavailable) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*StreamUnavailable) RequestID 

func (s *StreamUnavailable) RequestID() string

RequestID returns the service's response RequestID for request.

func (*StreamUnavailable) StatusCode 

func (s *StreamUnavailable) StatusCode() int

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

func (StreamUnavailable) String 

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 

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 (TagResourceInput) GoString 

func (s TagResourceInput) GoString() string

GoString returns the string representation.

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

func (*TagResourceInput) SetResourceArn 

func (s *TagResourceInput) SetResourceArn(v string) *TagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*TagResourceInput) SetTags 

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

SetTags sets the Tags field's value.

func (TagResourceInput) String 

func (s TagResourceInput) String() string

String returns the string representation.

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

func (*TagResourceInput) Validate 

func (s *TagResourceInput) Validate() error

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

type TagResourceOutput 

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

func (TagResourceOutput) GoString 

func (s TagResourceOutput) GoString() string

GoString returns the string representation.

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

func (TagResourceOutput) String 

func (s TagResourceOutput) String() string

String returns the string representation.

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

type ThrottlingException 

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 (*ThrottlingException) Code 

func (s *ThrottlingException) Code() string

Code returns the exception type name.

func (*ThrottlingException) Error 

func (s *ThrottlingException) Error() string

func (ThrottlingException) GoString 

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 (*ThrottlingException) Message 

func (s *ThrottlingException) Message() string

Message returns the exception's message.

func (*ThrottlingException) OrigErr 

func (s *ThrottlingException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ThrottlingException) RequestID 

func (s *ThrottlingException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ThrottlingException) StatusCode 

func (s *ThrottlingException) StatusCode() int

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

func (ThrottlingException) String 

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

type ThumbnailConfiguration struct {

	// Thumbnail recording mode. Default: INTERVAL.
	RecordingMode *string `locationName:"recordingMode" type:"string" enum:"RecordingMode"`

	// The targeted thumbnail-generation interval in seconds. This is configurable
	// (and required) only if recordingMode is INTERVAL. Default: 60.
	//
	// Important: 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 (ThumbnailConfiguration) GoString added in v1.42.36 

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 (*ThumbnailConfiguration) SetRecordingMode added in v1.42.36 

func (s *ThumbnailConfiguration) SetRecordingMode(v string) *ThumbnailConfiguration

SetRecordingMode sets the RecordingMode field's value.

func (*ThumbnailConfiguration) SetTargetIntervalSeconds added in v1.42.36 

func (s *ThumbnailConfiguration) SetTargetIntervalSeconds(v int64) *ThumbnailConfiguration

SetTargetIntervalSeconds sets the TargetIntervalSeconds field's value.

func (ThumbnailConfiguration) String added in v1.42.36 

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 (*ThumbnailConfiguration) Validate added in v1.42.36 

func (s *ThumbnailConfiguration) Validate() error

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

type UntagResourceInput 

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 (UntagResourceInput) GoString 

func (s UntagResourceInput) GoString() string

GoString returns the string representation.

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

func (*UntagResourceInput) SetResourceArn 

func (s *UntagResourceInput) SetResourceArn(v string) *UntagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*UntagResourceInput) SetTagKeys 

func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput

SetTagKeys sets the TagKeys field's value.

func (UntagResourceInput) String 

func (s UntagResourceInput) String() string

String returns the string representation.

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

func (*UntagResourceInput) Validate 

func (s *UntagResourceInput) Validate() error

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

type UntagResourceOutput 

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

func (UntagResourceOutput) GoString 

func (s UntagResourceOutput) GoString() string

GoString returns the string representation.

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

func (UntagResourceOutput) String 

func (s UntagResourceOutput) String() string

String returns the string representation.

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

type UpdateChannelInput 

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 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. (Note: In the
	// Amazon IVS console, LOW and NORMAL correspond to Ultra-low and Standard,
	// respectively.)
	LatencyMode *string `locationName:"latencyMode" type:"string" enum:"ChannelLatencyMode"`

	// Channel name.
	Name *string `locationName:"name" 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. If this is set to an empty string, recording
	// is disabled. A value other than an empty string indicates that recording
	// is enabled
	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. Some types generate multiple qualities (renditions)
	// from the original input; this automatically gives viewers the best experience
	// for their devices and network conditions. Some types provide transcoded video;
	// transcoding allows higher playback quality across a range of download speeds.
	// Default: STANDARD. Valid values:
	//
	//    * BASIC: Video is transmuxed: Amazon IVS delivers the original input quality
	//    to viewers. The viewer’s video-quality choice is limited to the original
	//    input. Input resolution can be up to 1080p and bitrate can be up to 1.5
	//    Mbps for 480p and up to 3.5 Mbps for resolutions between 480p and 1080p.
	//    Original audio is passed through.
	//
	//    * STANDARD: Video is transcoded: multiple qualities are generated from
	//    the original input, to automatically give viewers the best experience
	//    for their devices and network conditions. Transcoding allows higher playback
	//    quality across a range of download speeds. Resolution can be up to 1080p
	//    and bitrate can be up to 8.5 Mbps. Audio is transcoded only for renditions
	//    360p and below; above that, audio is passed through. This is the default
	//    when you create a channel.
	//
	//    * ADVANCED_SD: Video is transcoded; multiple qualities are generated from
	//    the original input, to automatically give viewers the best experience
	//    for their devices and network conditions. Input resolution can be up to
	//    1080p and bitrate can be up to 8.5 Mbps; output is capped at SD quality
	//    (480p). You can select an optional transcode preset (see below). Audio
	//    for all renditions is transcoded, and an audio-only rendition is available.
	//
	//    * ADVANCED_HD: Video is transcoded; multiple qualities are generated from
	//    the original input, to automatically give viewers the best experience
	//    for their devices and network conditions. Input resolution can be up to
	//    1080p and bitrate can be up to 8.5 Mbps; output is capped at HD quality
	//    (720p). You can select an optional transcode preset (see below). Audio
	//    for all renditions is transcoded, and an audio-only rendition is available.
	//
	// Optional transcode presets (available for the ADVANCED types) allow you to
	// trade off available download bandwidth and video quality, to optimize the
	// viewing experience. There are two presets:
	//
	//    * Constrained bandwidth delivery uses a lower bitrate for each quality
	//    level. Use it if you have low download bandwidth and/or simple video content
	//    (e.g., talking heads)
	//
	//    * Higher bandwidth delivery uses a higher bitrate for each quality level.
	//    Use it if you have high download bandwidth and/or complex video content
	//    (e.g., flashes and quick scene changes).
	Type *string `locationName:"type" type:"string" enum:"ChannelType"`
	// contains filtered or unexported fields
}

func (UpdateChannelInput) GoString 

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 (*UpdateChannelInput) SetArn 

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

SetArn sets the Arn field's value.

func (*UpdateChannelInput) SetAuthorized added in v1.34.8 

func (s *UpdateChannelInput) SetAuthorized(v bool) *UpdateChannelInput

SetAuthorized sets the Authorized field's value.

func (*UpdateChannelInput) SetInsecureIngest added in v1.44.233 

func (s *UpdateChannelInput) SetInsecureIngest(v bool) *UpdateChannelInput

SetInsecureIngest sets the InsecureIngest field's value.

func (*UpdateChannelInput) SetLatencyMode 

func (s *UpdateChannelInput) SetLatencyMode(v string) *UpdateChannelInput

SetLatencyMode sets the LatencyMode field's value.

func (*UpdateChannelInput) SetName 

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

SetName sets the Name field's value.

func (*UpdateChannelInput) SetPreset added in v1.44.274 

func (s *UpdateChannelInput) SetPreset(v string) *UpdateChannelInput

SetPreset sets the Preset field's value.

func (*UpdateChannelInput) SetRecordingConfigurationArn added in v1.38.15 

func (s *UpdateChannelInput) SetRecordingConfigurationArn(v string) *UpdateChannelInput

SetRecordingConfigurationArn sets the RecordingConfigurationArn field's value.

func (*UpdateChannelInput) SetType 

func (s *UpdateChannelInput) SetType(v string) *UpdateChannelInput

SetType sets the Type field's value.

func (UpdateChannelInput) String 

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 (*UpdateChannelInput) Validate 

func (s *UpdateChannelInput) Validate() error

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

type UpdateChannelOutput 

type UpdateChannelOutput struct {

	// Object specifying a channel.
	Channel *Channel `locationName:"channel" type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateChannelOutput) GoString 

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 (*UpdateChannelOutput) SetChannel 

func (s *UpdateChannelOutput) SetChannel(v *Channel) *UpdateChannelOutput

SetChannel sets the Channel field's value.

func (UpdateChannelOutput) String 

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 ValidationException 

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

	// The input fails to satisfy the constraints specified by an Amazon Web Services
	// service.
	ExceptionMessage *string `locationName:"exceptionMessage" type:"string"`

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

func (*ValidationException) Code 

func (s *ValidationException) Code() string

Code returns the exception type name.

func (*ValidationException) Error 

func (s *ValidationException) Error() string

func (ValidationException) GoString 

func (s ValidationException) GoString() string

GoString returns the string representation.

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

func (*ValidationException) Message 

func (s *ValidationException) Message() string

Message returns the exception's message.

func (*ValidationException) OrigErr 

func (s *ValidationException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ValidationException) RequestID 

func (s *ValidationException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ValidationException) StatusCode 

func (s *ValidationException) StatusCode() int

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

func (ValidationException) String 

func (s ValidationException) String() string

String returns the string representation.

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

type VideoConfiguration added in v1.42.8 

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 (VideoConfiguration) GoString added in v1.42.8 

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 (*VideoConfiguration) SetAvcLevel added in v1.42.8 

func (s *VideoConfiguration) SetAvcLevel(v string) *VideoConfiguration

SetAvcLevel sets the AvcLevel field's value.

func (*VideoConfiguration) SetAvcProfile added in v1.42.8 

func (s *VideoConfiguration) SetAvcProfile(v string) *VideoConfiguration

SetAvcProfile sets the AvcProfile field's value.

func (*VideoConfiguration) SetCodec added in v1.42.8 

func (s *VideoConfiguration) SetCodec(v string) *VideoConfiguration

SetCodec sets the Codec field's value.

func (*VideoConfiguration) SetEncoder added in v1.42.8 

func (s *VideoConfiguration) SetEncoder(v string) *VideoConfiguration

SetEncoder sets the Encoder field's value.

func (*VideoConfiguration) SetTargetBitrate added in v1.42.8 

func (s *VideoConfiguration) SetTargetBitrate(v int64) *VideoConfiguration

SetTargetBitrate sets the TargetBitrate field's value.

func (*VideoConfiguration) SetTargetFramerate added in v1.42.8 

func (s *VideoConfiguration) SetTargetFramerate(v int64) *VideoConfiguration

SetTargetFramerate sets the TargetFramerate field's value.

func (*VideoConfiguration) SetVideoHeight added in v1.42.8 

func (s *VideoConfiguration) SetVideoHeight(v int64) *VideoConfiguration

SetVideoHeight sets the VideoHeight field's value.

func (*VideoConfiguration) SetVideoWidth added in v1.42.8 

func (s *VideoConfiguration) SetVideoWidth(v int64) *VideoConfiguration

SetVideoWidth sets the VideoWidth field's value.

func (VideoConfiguration) String added in v1.42.8 

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

Source Files

View all Source files

Directories

Path Synopsis
Package ivsiface provides an interface to enable mocking the Amazon Interactive Video Service service client for testing your code.
 Package ivsiface provides an interface to enable mocking the Amazon Interactive Video Service service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.