ivs

package
v0.24.0 Latest Latest
Warning

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

 Go to latest Published: Jul 22, 2020 License: Apache-2.0 Imports: 8 Imported by: 12

Documentation

Overview

Package ivs provides the client and types for making API requests to Amazon IVS.

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 use Amazon IVS 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 IVS client 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 (
	ServiceName = "Amazon IVS" // Service's name
	ServiceID   = "Ivs"        // Service's identifier
	EndpointsID = "ivs"        // Service's Endpoint identifier
)
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"
)

Variables

This section is empty.

Functions

This section is empty.

Types

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

func (s BatchError) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

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

func (s BatchGetChannelInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

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

func (s BatchGetChannelOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (BatchGetChannelOutput) String 

func (s BatchGetChannelOutput) String() string

String returns the string representation

type BatchGetChannelRequest 

type BatchGetChannelRequest struct {
	*aws.Request
	Input *BatchGetChannelInput
	Copy  func(*BatchGetChannelInput) BatchGetChannelRequest
}

BatchGetChannelRequest is the request type for the BatchGetChannel API operation.

func (BatchGetChannelRequest) Send 

func (r BatchGetChannelRequest) Send(ctx context.Context) (*BatchGetChannelResponse, error)

Send marshals and sends the BatchGetChannel API request.

type BatchGetChannelResponse 

type BatchGetChannelResponse struct {
	*BatchGetChannelOutput
	// contains filtered or unexported fields
}

BatchGetChannelResponse is the response type for the BatchGetChannel API operation.

func (*BatchGetChannelResponse) SDKResponseMetdata 

func (r *BatchGetChannelResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the BatchGetChannel request.

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

func (s BatchGetStreamKeyInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

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

func (s BatchGetStreamKeyOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (BatchGetStreamKeyOutput) String 

func (s BatchGetStreamKeyOutput) String() string

String returns the string representation

type BatchGetStreamKeyRequest 

type BatchGetStreamKeyRequest struct {
	*aws.Request
	Input *BatchGetStreamKeyInput
	Copy  func(*BatchGetStreamKeyInput) BatchGetStreamKeyRequest
}

BatchGetStreamKeyRequest is the request type for the BatchGetStreamKey API operation.

func (BatchGetStreamKeyRequest) Send 

func (r BatchGetStreamKeyRequest) Send(ctx context.Context) (*BatchGetStreamKeyResponse, error)

Send marshals and sends the BatchGetStreamKey API request.

type BatchGetStreamKeyResponse 

type BatchGetStreamKeyResponse struct {
	*BatchGetStreamKeyOutput
	// contains filtered or unexported fields
}

BatchGetStreamKeyResponse is the response type for the BatchGetStreamKey API operation.

func (*BatchGetStreamKeyResponse) SDKResponseMetdata 

func (r *BatchGetStreamKeyResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the BatchGetStreamKey request.

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 ChannelLatencyMode `locationName:"latencyMode" type:"string" enum:"true"`

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

Object specifying a channel.

func (Channel) MarshalFields 

func (s Channel) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (Channel) String 

func (s Channel) String() string

String returns the string representation

type ChannelLatencyMode 

type ChannelLatencyMode string
const (
	ChannelLatencyModeNormal ChannelLatencyMode = "NORMAL"
	ChannelLatencyModeLow    ChannelLatencyMode = "LOW"
)

Enum values for ChannelLatencyMode

func (ChannelLatencyMode) MarshalValue 

func (enum ChannelLatencyMode) MarshalValue() (string, error)

func (ChannelLatencyMode) MarshalValueBuf 

func (enum ChannelLatencyMode) MarshalValueBuf(b []byte) ([]byte, error)

type ChannelSummary 

type ChannelSummary struct {

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

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

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

func (s ChannelSummary) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ChannelSummary) String 

func (s ChannelSummary) String() string

String returns the string representation

type ChannelType 

type ChannelType string
const (
	ChannelTypeBasic    ChannelType = "BASIC"
	ChannelTypeStandard ChannelType = "STANDARD"
)

Enum values for ChannelType

func (ChannelType) MarshalValue 

func (enum ChannelType) MarshalValue() (string, error)

func (ChannelType) MarshalValueBuf 

func (enum ChannelType) MarshalValueBuf(b []byte) ([]byte, error)

type Client 

type Client struct {
	*aws.Client
}

Client provides the API operation methods for making requests to Amazon IVS. See this package's package overview docs for details on the service.

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

func New 

func New(config aws.Config) *Client

New creates a new instance of the client from the provided Config.

Example: 

// Create a client from just a config.
svc := ivs.New(myConfig)

func (*Client) BatchGetChannelRequest 

func (c *Client) BatchGetChannelRequest(input *BatchGetChannelInput) BatchGetChannelRequest

BatchGetChannelRequest returns a request value for making API operation for Amazon Interactive Video Service.

Performs GetChannel on multiple ARNs simultaneously. 

// Example sending a request using BatchGetChannelRequest.
req := client.BatchGetChannelRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/BatchGetChannel

func (*Client) BatchGetStreamKeyRequest 

func (c *Client) BatchGetStreamKeyRequest(input *BatchGetStreamKeyInput) BatchGetStreamKeyRequest

BatchGetStreamKeyRequest returns a request value for making API operation for Amazon Interactive Video Service.

Performs GetStreamKey on multiple ARNs simultaneously. 

// Example sending a request using BatchGetStreamKeyRequest.
req := client.BatchGetStreamKeyRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/BatchGetStreamKey

func (*Client) CreateChannelRequest 

func (c *Client) CreateChannelRequest(input *CreateChannelInput) CreateChannelRequest

CreateChannelRequest returns a request value for making API operation for Amazon Interactive Video Service.

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

// Example sending a request using CreateChannelRequest.
req := client.CreateChannelRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/CreateChannel

func (*Client) CreateStreamKeyRequest 

func (c *Client) CreateStreamKeyRequest(input *CreateStreamKeyInput) CreateStreamKeyRequest

CreateStreamKeyRequest returns a request value for making 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. 

// Example sending a request using CreateStreamKeyRequest.
req := client.CreateStreamKeyRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/CreateStreamKey

func (*Client) DeleteChannelRequest 

func (c *Client) DeleteChannelRequest(input *DeleteChannelInput) DeleteChannelRequest

DeleteChannelRequest returns a request value for making API operation for Amazon Interactive Video Service.

Deletes a specified channel and its associated stream keys. 

// Example sending a request using DeleteChannelRequest.
req := client.DeleteChannelRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/DeleteChannel

func (*Client) DeleteStreamKeyRequest 

func (c *Client) DeleteStreamKeyRequest(input *DeleteStreamKeyInput) DeleteStreamKeyRequest

DeleteStreamKeyRequest returns a request value for making API operation for Amazon Interactive Video Service.

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

// Example sending a request using DeleteStreamKeyRequest.
req := client.DeleteStreamKeyRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/DeleteStreamKey

func (*Client) GetChannelRequest 

func (c *Client) GetChannelRequest(input *GetChannelInput) GetChannelRequest

GetChannelRequest returns a request value for making API operation for Amazon Interactive Video Service.

Gets the channel configuration for a specified channel ARN. See also BatchGetChannel. 

// Example sending a request using GetChannelRequest.
req := client.GetChannelRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/GetChannel

func (*Client) GetStreamKeyRequest 

func (c *Client) GetStreamKeyRequest(input *GetStreamKeyInput) GetStreamKeyRequest

GetStreamKeyRequest returns a request value for making API operation for Amazon Interactive Video Service.

Gets stream-key information for a specified ARN. 

// Example sending a request using GetStreamKeyRequest.
req := client.GetStreamKeyRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/GetStreamKey

func (*Client) GetStreamRequest 

func (c *Client) GetStreamRequest(input *GetStreamInput) GetStreamRequest

GetStreamRequest returns a request value for making API operation for Amazon Interactive Video Service.

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

// Example sending a request using GetStreamRequest.
req := client.GetStreamRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/GetStream

func (*Client) ListChannelsRequest 

func (c *Client) ListChannelsRequest(input *ListChannelsInput) ListChannelsRequest

ListChannelsRequest returns a request value for making API operation for Amazon Interactive Video Service.

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

// Example sending a request using ListChannelsRequest.
req := client.ListChannelsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListChannels

func (*Client) ListStreamKeysRequest 

func (c *Client) ListStreamKeysRequest(input *ListStreamKeysInput) ListStreamKeysRequest

ListStreamKeysRequest returns a request value for making API operation for Amazon Interactive Video Service.

Gets summary information about stream keys. The list can be filtered to a particular channel. 

// Example sending a request using ListStreamKeysRequest.
req := client.ListStreamKeysRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListStreamKeys

func (*Client) ListStreamsRequest 

func (c *Client) ListStreamsRequest(input *ListStreamsInput) ListStreamsRequest

ListStreamsRequest returns a request value for making API operation for Amazon Interactive Video Service.

Gets summary information about live streams. 

// Example sending a request using ListStreamsRequest.
req := client.ListStreamsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListStreams

func (*Client) ListTagsForResourceRequest 

func (c *Client) ListTagsForResourceRequest(input *ListTagsForResourceInput) ListTagsForResourceRequest

ListTagsForResourceRequest returns a request value for making API operation for Amazon Interactive Video Service.

Gets information about the tags for a specified ARN. 

// Example sending a request using ListTagsForResourceRequest.
req := client.ListTagsForResourceRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) PutMetadataRequest 

func (c *Client) PutMetadataRequest(input *PutMetadataInput) PutMetadataRequest

PutMetadataRequest returns a request value for making 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. 

// Example sending a request using PutMetadataRequest.
req := client.PutMetadataRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/PutMetadata

func (*Client) StopStreamRequest 

func (c *Client) StopStreamRequest(input *StopStreamInput) StopStreamRequest

StopStreamRequest returns a request value for making 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. 

// Example sending a request using StopStreamRequest.
req := client.StopStreamRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/StopStream

func (*Client) TagResourceRequest 

func (c *Client) TagResourceRequest(input *TagResourceInput) TagResourceRequest

TagResourceRequest returns a request value for making API operation for Amazon Interactive Video Service.

Adds or updates tags for a resource with a specified ARN. 

// Example sending a request using TagResourceRequest.
req := client.TagResourceRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/TagResource

func (*Client) UntagResourceRequest 

func (c *Client) UntagResourceRequest(input *UntagResourceInput) UntagResourceRequest

UntagResourceRequest returns a request value for making API operation for Amazon Interactive Video Service.

Removes tags for a resource with a specified ARN. 

// Example sending a request using UntagResourceRequest.
req := client.UntagResourceRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/UntagResource

func (*Client) UpdateChannelRequest 

func (c *Client) UpdateChannelRequest(input *UpdateChannelInput) UpdateChannelRequest

UpdateChannelRequest returns a request value for making 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. 

// Example sending a request using UpdateChannelRequest.
req := client.UpdateChannelRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/UpdateChannel

type CreateChannelInput 

type CreateChannelInput struct {

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

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

func (CreateChannelInput) MarshalFields 

func (s CreateChannelInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

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

func (s CreateChannelOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CreateChannelOutput) String 

func (s CreateChannelOutput) String() string

String returns the string representation

type CreateChannelRequest 

type CreateChannelRequest struct {
	*aws.Request
	Input *CreateChannelInput
	Copy  func(*CreateChannelInput) CreateChannelRequest
}

CreateChannelRequest is the request type for the CreateChannel API operation.

func (CreateChannelRequest) Send 

func (r CreateChannelRequest) Send(ctx context.Context) (*CreateChannelResponse, error)

Send marshals and sends the CreateChannel API request.

type CreateChannelResponse 

type CreateChannelResponse struct {
	*CreateChannelOutput
	// contains filtered or unexported fields
}

CreateChannelResponse is the response type for the CreateChannel API operation.

func (*CreateChannelResponse) SDKResponseMetdata 

func (r *CreateChannelResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateChannel request.

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

func (s CreateStreamKeyInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

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

func (s CreateStreamKeyOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CreateStreamKeyOutput) String 

func (s CreateStreamKeyOutput) String() string

String returns the string representation

type CreateStreamKeyRequest 

type CreateStreamKeyRequest struct {
	*aws.Request
	Input *CreateStreamKeyInput
	Copy  func(*CreateStreamKeyInput) CreateStreamKeyRequest
}

CreateStreamKeyRequest is the request type for the CreateStreamKey API operation.

func (CreateStreamKeyRequest) Send 

func (r CreateStreamKeyRequest) Send(ctx context.Context) (*CreateStreamKeyResponse, error)

Send marshals and sends the CreateStreamKey API request.

type CreateStreamKeyResponse 

type CreateStreamKeyResponse struct {
	*CreateStreamKeyOutput
	// contains filtered or unexported fields
}

CreateStreamKeyResponse is the response type for the CreateStreamKey API operation.

func (*CreateStreamKeyResponse) SDKResponseMetdata 

func (r *CreateStreamKeyResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateStreamKey request.

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

func (s DeleteChannelInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

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

func (s DeleteChannelOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteChannelOutput) String 

func (s DeleteChannelOutput) String() string

String returns the string representation

type DeleteChannelRequest 

type DeleteChannelRequest struct {
	*aws.Request
	Input *DeleteChannelInput
	Copy  func(*DeleteChannelInput) DeleteChannelRequest
}

DeleteChannelRequest is the request type for the DeleteChannel API operation.

func (DeleteChannelRequest) Send 

func (r DeleteChannelRequest) Send(ctx context.Context) (*DeleteChannelResponse, error)

Send marshals and sends the DeleteChannel API request.

type DeleteChannelResponse 

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

DeleteChannelResponse is the response type for the DeleteChannel API operation.

func (*DeleteChannelResponse) SDKResponseMetdata 

func (r *DeleteChannelResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteChannel request.

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

func (s DeleteStreamKeyInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

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

func (s DeleteStreamKeyOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteStreamKeyOutput) String 

func (s DeleteStreamKeyOutput) String() string

String returns the string representation

type DeleteStreamKeyRequest 

type DeleteStreamKeyRequest struct {
	*aws.Request
	Input *DeleteStreamKeyInput
	Copy  func(*DeleteStreamKeyInput) DeleteStreamKeyRequest
}

DeleteStreamKeyRequest is the request type for the DeleteStreamKey API operation.

func (DeleteStreamKeyRequest) Send 

func (r DeleteStreamKeyRequest) Send(ctx context.Context) (*DeleteStreamKeyResponse, error)

Send marshals and sends the DeleteStreamKey API request.

type DeleteStreamKeyResponse 

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

DeleteStreamKeyResponse is the response type for the DeleteStreamKey API operation.

func (*DeleteStreamKeyResponse) SDKResponseMetdata 

func (r *DeleteStreamKeyResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteStreamKey request.

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

func (s GetChannelInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

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

func (s GetChannelOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetChannelOutput) String 

func (s GetChannelOutput) String() string

String returns the string representation

type GetChannelRequest 

type GetChannelRequest struct {
	*aws.Request
	Input *GetChannelInput
	Copy  func(*GetChannelInput) GetChannelRequest
}

GetChannelRequest is the request type for the GetChannel API operation.

func (GetChannelRequest) Send 

func (r GetChannelRequest) Send(ctx context.Context) (*GetChannelResponse, error)

Send marshals and sends the GetChannel API request.

type GetChannelResponse 

type GetChannelResponse struct {
	*GetChannelOutput
	// contains filtered or unexported fields
}

GetChannelResponse is the response type for the GetChannel API operation.

func (*GetChannelResponse) SDKResponseMetdata 

func (r *GetChannelResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetChannel request.

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

func (s GetStreamInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

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

func (s GetStreamKeyInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

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

func (s GetStreamKeyOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetStreamKeyOutput) String 

func (s GetStreamKeyOutput) String() string

String returns the string representation

type GetStreamKeyRequest 

type GetStreamKeyRequest struct {
	*aws.Request
	Input *GetStreamKeyInput
	Copy  func(*GetStreamKeyInput) GetStreamKeyRequest
}

GetStreamKeyRequest is the request type for the GetStreamKey API operation.

func (GetStreamKeyRequest) Send 

func (r GetStreamKeyRequest) Send(ctx context.Context) (*GetStreamKeyResponse, error)

Send marshals and sends the GetStreamKey API request.

type GetStreamKeyResponse 

type GetStreamKeyResponse struct {
	*GetStreamKeyOutput
	// contains filtered or unexported fields
}

GetStreamKeyResponse is the response type for the GetStreamKey API operation.

func (*GetStreamKeyResponse) SDKResponseMetdata 

func (r *GetStreamKeyResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetStreamKey request.

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

func (s GetStreamOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetStreamOutput) String 

func (s GetStreamOutput) String() string

String returns the string representation

type GetStreamRequest 

type GetStreamRequest struct {
	*aws.Request
	Input *GetStreamInput
	Copy  func(*GetStreamInput) GetStreamRequest
}

GetStreamRequest is the request type for the GetStream API operation.

func (GetStreamRequest) Send 

func (r GetStreamRequest) Send(ctx context.Context) (*GetStreamResponse, error)

Send marshals and sends the GetStream API request.

type GetStreamResponse 

type GetStreamResponse struct {
	*GetStreamOutput
	// contains filtered or unexported fields
}

GetStreamResponse is the response type for the GetStream API operation.

func (*GetStreamResponse) SDKResponseMetdata 

func (r *GetStreamResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetStream request.

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

func (s ListChannelsInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

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

func (s ListChannelsOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListChannelsOutput) String 

func (s ListChannelsOutput) String() string

String returns the string representation

type ListChannelsPaginator 

type ListChannelsPaginator struct {
	aws.Pager
}

ListChannelsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListChannelsPaginator 

func NewListChannelsPaginator(req ListChannelsRequest) ListChannelsPaginator

NewListChannelsRequestPaginator returns a paginator for ListChannels. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

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

// Example iterating over pages.
req := client.ListChannelsRequest(input)
p := ivs.NewListChannelsRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListChannelsPaginator) CurrentPage 

func (p *ListChannelsPaginator) CurrentPage() *ListChannelsOutput

type ListChannelsRequest 

type ListChannelsRequest struct {
	*aws.Request
	Input *ListChannelsInput
	Copy  func(*ListChannelsInput) ListChannelsRequest
}

ListChannelsRequest is the request type for the ListChannels API operation.

func (ListChannelsRequest) Send 

func (r ListChannelsRequest) Send(ctx context.Context) (*ListChannelsResponse, error)

Send marshals and sends the ListChannels API request.

type ListChannelsResponse 

type ListChannelsResponse struct {
	*ListChannelsOutput
	// contains filtered or unexported fields
}

ListChannelsResponse is the response type for the ListChannels API operation.

func (*ListChannelsResponse) SDKResponseMetdata 

func (r *ListChannelsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListChannels request.

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

func (s ListStreamKeysInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

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

func (s ListStreamKeysOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListStreamKeysOutput) String 

func (s ListStreamKeysOutput) String() string

String returns the string representation

type ListStreamKeysPaginator 

type ListStreamKeysPaginator struct {
	aws.Pager
}

ListStreamKeysPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListStreamKeysPaginator 

func NewListStreamKeysPaginator(req ListStreamKeysRequest) ListStreamKeysPaginator

NewListStreamKeysRequestPaginator returns a paginator for ListStreamKeys. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

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

// Example iterating over pages.
req := client.ListStreamKeysRequest(input)
p := ivs.NewListStreamKeysRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListStreamKeysPaginator) CurrentPage 

func (p *ListStreamKeysPaginator) CurrentPage() *ListStreamKeysOutput

type ListStreamKeysRequest 

type ListStreamKeysRequest struct {
	*aws.Request
	Input *ListStreamKeysInput
	Copy  func(*ListStreamKeysInput) ListStreamKeysRequest
}

ListStreamKeysRequest is the request type for the ListStreamKeys API operation.

func (ListStreamKeysRequest) Send 

func (r ListStreamKeysRequest) Send(ctx context.Context) (*ListStreamKeysResponse, error)

Send marshals and sends the ListStreamKeys API request.

type ListStreamKeysResponse 

type ListStreamKeysResponse struct {
	*ListStreamKeysOutput
	// contains filtered or unexported fields
}

ListStreamKeysResponse is the response type for the ListStreamKeys API operation.

func (*ListStreamKeysResponse) SDKResponseMetdata 

func (r *ListStreamKeysResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListStreamKeys request.

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

func (s ListStreamsInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

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

func (s ListStreamsOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListStreamsOutput) String 

func (s ListStreamsOutput) String() string

String returns the string representation

type ListStreamsPaginator 

type ListStreamsPaginator struct {
	aws.Pager
}

ListStreamsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListStreamsPaginator 

func NewListStreamsPaginator(req ListStreamsRequest) ListStreamsPaginator

NewListStreamsRequestPaginator returns a paginator for ListStreams. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

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

// Example iterating over pages.
req := client.ListStreamsRequest(input)
p := ivs.NewListStreamsRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListStreamsPaginator) CurrentPage 

func (p *ListStreamsPaginator) CurrentPage() *ListStreamsOutput

type ListStreamsRequest 

type ListStreamsRequest struct {
	*aws.Request
	Input *ListStreamsInput
	Copy  func(*ListStreamsInput) ListStreamsRequest
}

ListStreamsRequest is the request type for the ListStreams API operation.

func (ListStreamsRequest) Send 

func (r ListStreamsRequest) Send(ctx context.Context) (*ListStreamsResponse, error)

Send marshals and sends the ListStreams API request.

type ListStreamsResponse 

type ListStreamsResponse struct {
	*ListStreamsOutput
	// contains filtered or unexported fields
}

ListStreamsResponse is the response type for the ListStreams API operation.

func (*ListStreamsResponse) SDKResponseMetdata 

func (r *ListStreamsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListStreams request.

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

func (s ListTagsForResourceInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

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

func (s ListTagsForResourceOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListTagsForResourceOutput) String 

func (s ListTagsForResourceOutput) String() string

String returns the string representation

type ListTagsForResourcePaginator 

type ListTagsForResourcePaginator struct {
	aws.Pager
}

ListTagsForResourcePaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListTagsForResourcePaginator 

func NewListTagsForResourcePaginator(req ListTagsForResourceRequest) ListTagsForResourcePaginator

NewListTagsForResourceRequestPaginator returns a paginator for ListTagsForResource. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

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

// Example iterating over pages.
req := client.ListTagsForResourceRequest(input)
p := ivs.NewListTagsForResourceRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListTagsForResourcePaginator) CurrentPage 

func (p *ListTagsForResourcePaginator) CurrentPage() *ListTagsForResourceOutput

type ListTagsForResourceRequest 

type ListTagsForResourceRequest struct {
	*aws.Request
	Input *ListTagsForResourceInput
	Copy  func(*ListTagsForResourceInput) ListTagsForResourceRequest
}

ListTagsForResourceRequest is the request type for the ListTagsForResource API operation.

func (ListTagsForResourceRequest) Send 

func (r ListTagsForResourceRequest) Send(ctx context.Context) (*ListTagsForResourceResponse, error)

Send marshals and sends the ListTagsForResource API request.

type ListTagsForResourceResponse 

type ListTagsForResourceResponse struct {
	*ListTagsForResourceOutput
	// contains filtered or unexported fields
}

ListTagsForResourceResponse is the response type for the ListTagsForResource API operation.

func (*ListTagsForResourceResponse) SDKResponseMetdata 

func (r *ListTagsForResourceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListTagsForResource request.

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

func (s PutMetadataInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

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

func (s PutMetadataOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PutMetadataOutput) String 

func (s PutMetadataOutput) String() string

String returns the string representation

type PutMetadataRequest 

type PutMetadataRequest struct {
	*aws.Request
	Input *PutMetadataInput
	Copy  func(*PutMetadataInput) PutMetadataRequest
}

PutMetadataRequest is the request type for the PutMetadata API operation.

func (PutMetadataRequest) Send 

func (r PutMetadataRequest) Send(ctx context.Context) (*PutMetadataResponse, error)

Send marshals and sends the PutMetadata API request.

type PutMetadataResponse 

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

PutMetadataResponse is the response type for the PutMetadata API operation.

func (*PutMetadataResponse) SDKResponseMetdata 

func (r *PutMetadataResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the PutMetadata request.

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

func (s StopStreamInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

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

func (s StopStreamOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (StopStreamOutput) String 

func (s StopStreamOutput) String() string

String returns the string representation

type StopStreamRequest 

type StopStreamRequest struct {
	*aws.Request
	Input *StopStreamInput
	Copy  func(*StopStreamInput) StopStreamRequest
}

StopStreamRequest is the request type for the StopStream API operation.

func (StopStreamRequest) Send 

func (r StopStreamRequest) Send(ctx context.Context) (*StopStreamResponse, error)

Send marshals and sends the StopStream API request.

type StopStreamResponse 

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

StopStreamResponse is the response type for the StopStream API operation.

func (*StopStreamResponse) SDKResponseMetdata 

func (r *StopStreamResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the StopStream request.

type Stream 

type Stream struct {

	// Channel ARN for the stream.
	ChannelArn *string `locationName:"channelArn" min:"1" type:"string"`

	// The stream’s health.
	Health StreamHealth `locationName:"health" type:"string" enum:"true"`

	// 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 StreamState `locationName:"state" type:"string" enum:"true"`

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

func (s Stream) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (Stream) String 

func (s Stream) String() string

String returns the string representation

type StreamHealth 

type StreamHealth string
const (
	StreamHealthHealthy  StreamHealth = "HEALTHY"
	StreamHealthStarving StreamHealth = "STARVING"
	StreamHealthUnknown  StreamHealth = "UNKNOWN"
)

Enum values for StreamHealth

func (StreamHealth) MarshalValue 

func (enum StreamHealth) MarshalValue() (string, error)

func (StreamHealth) MarshalValueBuf 

func (enum StreamHealth) MarshalValueBuf(b []byte) ([]byte, error)

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

func (s StreamKey) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

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

func (s StreamKeySummary) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (StreamKeySummary) String 

func (s StreamKeySummary) String() string

String returns the string representation

type StreamState 

type StreamState string
const (
	StreamStateLive    StreamState = "LIVE"
	StreamStateOffline StreamState = "OFFLINE"
)

Enum values for StreamState

func (StreamState) MarshalValue 

func (enum StreamState) MarshalValue() (string, error)

func (StreamState) MarshalValueBuf 

func (enum StreamState) MarshalValueBuf(b []byte) ([]byte, error)

type StreamSummary 

type StreamSummary struct {

	// Channel ARN for the stream.
	ChannelArn *string `locationName:"channelArn" min:"1" type:"string"`

	// The stream’s health.
	Health StreamHealth `locationName:"health" type:"string" enum:"true"`

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

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

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

func (s StreamSummary) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (StreamSummary) String 

func (s StreamSummary) 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) MarshalFields 

func (s TagResourceInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

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

func (s TagResourceOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (TagResourceOutput) String 

func (s TagResourceOutput) String() string

String returns the string representation

type TagResourceRequest 

type TagResourceRequest struct {
	*aws.Request
	Input *TagResourceInput
	Copy  func(*TagResourceInput) TagResourceRequest
}

TagResourceRequest is the request type for the TagResource API operation.

func (TagResourceRequest) Send 

func (r TagResourceRequest) Send(ctx context.Context) (*TagResourceResponse, error)

Send marshals and sends the TagResource API request.

type TagResourceResponse 

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

TagResourceResponse is the response type for the TagResource API operation.

func (*TagResourceResponse) SDKResponseMetdata 

func (r *TagResourceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the TagResource request.

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

func (s UntagResourceInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

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

func (s UntagResourceOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UntagResourceOutput) String 

func (s UntagResourceOutput) String() string

String returns the string representation

type UntagResourceRequest 

type UntagResourceRequest struct {
	*aws.Request
	Input *UntagResourceInput
	Copy  func(*UntagResourceInput) UntagResourceRequest
}

UntagResourceRequest is the request type for the UntagResource API operation.

func (UntagResourceRequest) Send 

func (r UntagResourceRequest) Send(ctx context.Context) (*UntagResourceResponse, error)

Send marshals and sends the UntagResource API request.

type UntagResourceResponse 

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

UntagResourceResponse is the response type for the UntagResource API operation.

func (*UntagResourceResponse) SDKResponseMetdata 

func (r *UntagResourceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UntagResource request.

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 ChannelLatencyMode `locationName:"latencyMode" type:"string" enum:"true"`

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

func (UpdateChannelInput) MarshalFields 

func (s UpdateChannelInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

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

func (s UpdateChannelOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateChannelOutput) String 

func (s UpdateChannelOutput) String() string

String returns the string representation

type UpdateChannelRequest 

type UpdateChannelRequest struct {
	*aws.Request
	Input *UpdateChannelInput
	Copy  func(*UpdateChannelInput) UpdateChannelRequest
}

UpdateChannelRequest is the request type for the UpdateChannel API operation.

func (UpdateChannelRequest) Send 

func (r UpdateChannelRequest) Send(ctx context.Context) (*UpdateChannelResponse, error)

Send marshals and sends the UpdateChannel API request.

type UpdateChannelResponse 

type UpdateChannelResponse struct {
	*UpdateChannelOutput
	// contains filtered or unexported fields
}

UpdateChannelResponse is the response type for the UpdateChannel API operation.

func (*UpdateChannelResponse) SDKResponseMetdata 

func (r *UpdateChannelResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UpdateChannel request.

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.