ivs

package
v1.33.11 Latest Latest
Warning

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

 Go to latest Published: Jul 23, 2020 License: Apache-2.0 Imports: 10 Imported by: 17

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 AWS SNS (http://aws.amazon.com/sns) event stream for responses. JSON is used for both requests and responses, including errors.

The API is an AWS regional service, currently in these regions: us-west-2, us-east-2, and eu-west-1. 

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

Tagging

A tag is a metadata label that you assign to an AWS resource. A tag comprises a key and a value, both set by you. For example, you might set a tag as topic:nature to label a particular video category. See Tagging AWS Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) for more information, including restrictions that apply to tags.

Tags can help you identify and organize your AWS resources. For example, you can use the same tag for different resources to indicate that they are related. You can also use tags to manage access (see Access Tags (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html)).

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

API Endpoints

Channel:

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

  • GetChannel — Gets the channel configuration for a specified channel ARN (Amazon Resource Name).

  • BatchGetChannel — Performs GetChannel on multiple ARNs simultaneously.

  • ListChannels — Gets summary information about channels. This list can be filtered to match a specified string.

  • 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 a specified channel.

StreamKey:

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

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

  • BatchGetStreamKey — Performs GetStreamKey on multiple ARNs simultaneously.

  • ListStreamKeys — Gets a list of stream keys. The list can be filtered to a particular channel.

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

Stream:

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

  • ListStreams — Gets summary information about live streams.

  • StopStream — Disconnects a streamer on a specified channel. This disconnects the incoming RTMP stream from the client. Can be used in conjunction with DeleteStreamKey to prevent further streaming to a channel.

  • PutMetadata Inserts metadata into an RTMP stream for a specified channel. A maximum of 5 requests per second per channel is allowed, each with a maximum 1KB payload.

    AWS Tags (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html):

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

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

  • ListTagsForResource — Gets information about AWS tags for a 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"
)
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 (

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

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

This section is empty.

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

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

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

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

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

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

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

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

type BatchGetStreamKeyInput 

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

func (s BatchGetStreamKeyInput) GoString() string

GoString returns the string representation

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

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

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

type Channel 

type Channel struct {

	// Channel ARN.
	Arn *string `locationName:"arn" min:"1" type:"string"`

	// Channel ingest endpoint, part of the definition of an ingest server, used
	// when you set up streaming software.
	IngestEndpoint *string `locationName:"ingestEndpoint" type:"string"`

	// Channel latency mode. Default: LOW.
	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"`

	// Array of 1-50 maps, each of the form string:string (key:value).
	Tags map[string]*string `locationName:"tags" type:"map"`

	// Channel type, which determines the allowable resolution and bitrate. STANDARD:
	// The stream is transcoded; resolution (width, in landscape orientation) can
	// be up to 1080p or the input source resolution, whichever is lower; and bitrate
	// can be up to 8.5 Mbps. BASIC: The stream is transfixed; resolution can be
	// up to 480p; and bitrate can be up to 1.5 Mbps. Default STANDARD.
	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

func (*Channel) SetArn 

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

SetArn sets the Arn field's value.

func (*Channel) SetIngestEndpoint 

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

SetIngestEndpoint sets the IngestEndpoint 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) 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

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

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

type ChannelSummary 

type ChannelSummary struct {

	// Channel ARN.
	Arn *string `locationName:"arn" min:"1" type:"string"`

	// Channel latency mode. Default: LOW.
	LatencyMode *string `locationName:"latencyMode" type:"string" enum:"ChannelLatencyMode"`

	// Channel name.
	Name *string `locationName:"name" type:"string"`

	// Array of 1-50 maps, each of the form string:string (key:value).
	Tags map[string]*string `locationName:"tags" type:"map"`
	// contains filtered or unexported fields
}

Summary information about a channel.

func (ChannelSummary) GoString 

func (s ChannelSummary) GoString() string

GoString returns the string representation

func (*ChannelSummary) SetArn 

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

SetArn sets the Arn 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) SetTags 

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

SetTags sets the Tags field's value.

func (ChannelSummary) String 

func (s ChannelSummary) String() string

String returns the string representation

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

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

type CreateChannelInput 

type CreateChannelInput struct {

	// Channel latency mode. Default: LOW.
	LatencyMode *string `locationName:"latencyMode" type:"string" enum:"ChannelLatencyMode"`

	// Channel name.
	Name *string `locationName:"name" type:"string"`

	// See Channel$tags.
	Tags map[string]*string `locationName:"tags" type:"map"`

	// Channel type, which determines the allowable resolution and bitrate. STANDARD:
	// The stream is transcoded; resolution (width, in landscape orientation) can
	// be up to 1080p or the input source resolution, whichever is lower; and bitrate
	// can be up to 8.5 Mbps. BASIC: The stream is transfixed; resolution can be
	// up to 480p; and bitrate can be up to 1.5 Mbps. Default: STANDARD.
	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

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) 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

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

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

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

	// See Channel$tags.
	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

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

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 RTMP 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

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

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

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

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

func (DeleteChannelOutput) String 

func (s DeleteChannelOutput) String() string

String returns the string representation

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

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

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

func (DeleteStreamKeyOutput) String 

func (s DeleteStreamKeyOutput) String() string

String returns the string representation

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

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

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

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

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

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

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

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

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

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

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

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

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:

  • ValidationException

  • AccessDeniedException

  • 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) 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 a 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:

  • ValidationException

  • AccessDeniedException

  • ResourceNotFoundException

  • 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 a specified channel and its associated stream keys.

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:

  • ValidationException

  • AccessDeniedException

  • ResourceNotFoundException

  • 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) DeleteStreamKey 

func (c *IVS) DeleteStreamKey(input *DeleteStreamKeyInput) (*DeleteStreamKeyOutput, error)

DeleteStreamKey API operation for Amazon Interactive Video Service.

Deletes the stream key for a 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:

  • ValidationException

  • AccessDeniedException

  • ResourceNotFoundException

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 a 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:

  • ValidationException

  • AccessDeniedException

  • ResourceNotFoundException

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) 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

  • ValidationException

  • AccessDeniedException

  • 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:

  • ValidationException

  • AccessDeniedException

  • ResourceNotFoundException

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) 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) ListChannels 

func (c *IVS) ListChannels(input *ListChannelsInput) (*ListChannelsOutput, error)

ListChannels API operation for Amazon Interactive Video Service.

Gets summary information about channels. This list can be filtered to match a specified string.

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:

  • ValidationException

  • AccessDeniedException

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) ListStreamKeys 

func (c *IVS) ListStreamKeys(input *ListStreamKeysInput) (*ListStreamKeysOutput, error)

ListStreamKeys API operation for Amazon Interactive Video Service.

Gets summary information about stream keys. The list can be filtered to a particular 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:

  • ValidationException

  • AccessDeniedException

  • ResourceNotFoundException

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) ListStreams 

func (c *IVS) ListStreams(input *ListStreamsInput) (*ListStreamsOutput, error)

ListStreams API operation for Amazon Interactive Video Service.

Gets summary information about live streams.

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

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 the tags 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 ListTagsForResource for usage and error information.

Returned Error Types:

  • InternalServerException

  • ValidationException

  • ResourceNotFoundException

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

func (*IVS) ListTagsForResourcePages 

func (c *IVS) ListTagsForResourcePages(input *ListTagsForResourceInput, fn func(*ListTagsForResourceOutput, bool) bool) error

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

See ListTagsForResource 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 ListTagsForResource operation.
pageNum := 0
err := client.ListTagsForResourcePages(params,
    func(page *ivs.ListTagsForResourceOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*IVS) ListTagsForResourcePagesWithContext 

func (c *IVS) ListTagsForResourcePagesWithContext(ctx aws.Context, input *ListTagsForResourceInput, fn func(*ListTagsForResourceOutput, bool) bool, opts ...request.Option) error

ListTagsForResourcePagesWithContext same as ListTagsForResourcePages 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) 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 an RTMP stream for a specified channel. A maximum of 5 requests per second per channel is allowed, each with a maximum 1KB payload.

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:

  • ThrottlingException

  • ResourceNotFoundException

  • ChannelNotBroadcasting

  • ValidationException

  • AccessDeniedException

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 stream for the specified channel. This disconnects the incoming RTMP stream from the client. Can be used in conjunction with DeleteStreamKey to prevent further streaming to a channel.

Many streaming client-software libraries automatically reconnect a dropped RTMP 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

  • ChannelNotBroadcasting

  • ValidationException

  • AccessDeniedException

  • 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 a resource with 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 TagResource for usage and error information.

Returned Error Types:

  • InternalServerException

  • ValidationException

  • ResourceNotFoundException

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 for a resource with 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 UntagResource for usage and error information.

Returned Error Types:

  • InternalServerException

  • ValidationException

  • ResourceNotFoundException

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. This does not affect an ongoing stream of this channel. You must stop 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:

  • ValidationException

  • AccessDeniedException

  • ResourceNotFoundException

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

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

type ListChannelsInput 

type ListChannelsInput struct {

	// Filters the channel list to match the specified name.
	FilterByName *string `locationName:"filterByName" type:"string"`

	// Maximum number of channels to return.
	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

func (*ListChannelsInput) SetFilterByName 

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

SetFilterByName sets the FilterByName 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

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

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

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

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

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

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

type ListStreamsInput 

type ListStreamsInput struct {

	// Maximum number of streams to return.
	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

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

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

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

type ListTagsForResourceInput 

type ListTagsForResourceInput struct {

	// Maximum number of tags to return.
	MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"`

	// The first tag to retrieve. This is used for pagination; see the nextToken
	// response field.
	NextToken *string `locationName:"nextToken" type:"string"`

	// The ARN of the resource to be retrieved.
	//
	// 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

func (*ListTagsForResourceInput) SetMaxResults 

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

SetMaxResults sets the MaxResults field's value.

func (*ListTagsForResourceInput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

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

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 {

	// If there are more tags than maxResults, use nextToken in the request to get
	// the next set.
	NextToken *string `locationName:"nextToken" type:"string"`

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

func (*ListTagsForResourceOutput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

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

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 required field
	Metadata *string `locationName:"metadata" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (PutMetadataInput) GoString 

func (s PutMetadataInput) GoString() string

GoString returns the string representation

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

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

func (PutMetadataOutput) String 

func (s PutMetadataOutput) String() string

String returns the string representation

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

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

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

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

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

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

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

func (StopStreamOutput) String 

func (s StopStreamOutput) String() string

String returns the string representation

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 video master manifest, required by the video player to play the
	// HLS stream.
	PlaybackUrl *string `locationName:"playbackUrl" type:"string"`

	// ISO-8601 formatted timestamp of the stream’s start.
	StartTime *time.Time `locationName:"startTime" type:"timestamp"`

	// The stream’s state.
	State *string `locationName:"state" type:"string" enum:"StreamState"`

	// Number of current viewers of the stream.
	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

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) 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

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

	// Array of 1-50 maps, each of the form string:string (key:value)
	Tags map[string]*string `locationName:"tags" type:"map"`

	// Stream-key value.
	Value *string `locationName:"value" type:"string"`
	// contains filtered or unexported fields
}

Object specifying a stream key.

func (StreamKey) GoString 

func (s StreamKey) GoString() string

GoString returns the string representation

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

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

	// Array of 1-50 maps, each of the form string:string (key:value)
	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

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

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

	// ISO-8601 formatted timestamp of the stream’s start.
	StartTime *time.Time `locationName:"startTime" type:"timestamp"`

	// The stream’s state.
	State *string `locationName:"state" type:"string" enum:"StreamState"`

	// Number of current viewers of the stream.
	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

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) 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

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

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

type TagResourceInput 

type TagResourceInput struct {

	// ARN of the resource for which tags are to be added or updated.
	//
	// 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.
	//
	// 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

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

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

func (TagResourceOutput) String 

func (s TagResourceOutput) String() string

String returns the string representation

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

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

type UntagResourceInput 

type UntagResourceInput struct {

	// ARN of the resource for which tags are to be removed.
	//
	// ResourceArn is a required field
	ResourceArn *string `location:"uri" locationName:"resourceArn" min:"1" type:"string" required:"true"`

	// Array of tags to be removed.
	//
	// 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

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

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

func (UntagResourceOutput) String 

func (s UntagResourceOutput) String() string

String returns the string representation

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

	// Channel latency mode. Default: LOW.
	LatencyMode *string `locationName:"latencyMode" type:"string" enum:"ChannelLatencyMode"`

	// Channel name.
	Name *string `locationName:"name" type:"string"`

	// Channel type, which determines the allowable resolution and bitrate. STANDARD:
	// The stream is transcoded; resolution (width, in landscape orientation) can
	// be up to 1080p or the input source resolution, whichever is lower; and bitrate
	// can be up to 8.5 Mbps. BASIC: The stream is transfixed; resolution can be
	// up to 480p; and bitrate can be up to 1.5 Mbps. Default STANDARD.
	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

func (*UpdateChannelInput) SetArn 

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

SetArn sets the Arn 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) 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

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

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

type ValidationException 

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

	// The input fails to satisfy the constraints specified by an AWS 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

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

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.