kinesisvideowebrtcstorage

package
v0.0.0-...-30e57c9 Latest Latest
Warning

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

 Go to latest Published: Nov 21, 2024 License: Apache-2.0, Apache-2.0 Imports: 9 Imported by: 0

Documentation

Overview

Package kinesisvideowebrtcstorage provides the client and types for making API requests to Amazon Kinesis Video WebRTC Storage.

See https://docs.aws.amazon.com/goto/WebAPI/kinesis-video-webrtc-storage-2018-05-10 for more information on this service.

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

Using the Client

To contact Amazon Kinesis Video WebRTC Storage 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 Kinesis Video WebRTC Storage client KinesisVideoWebRTCStorage for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/kinesisvideowebrtcstorage/#New

Index

Constants

View Source 
const (

	// ErrCodeAccessDeniedException for service response error code
	// "AccessDeniedException".
	//
	// You do not have required permissions to perform this operation.
	ErrCodeAccessDeniedException = "AccessDeniedException"

	// ErrCodeClientLimitExceededException for service response error code
	// "ClientLimitExceededException".
	//
	// Kinesis Video Streams has throttled the request because you have exceeded
	// the limit of allowed client calls. Try making the call later.
	ErrCodeClientLimitExceededException = "ClientLimitExceededException"

	// ErrCodeInvalidArgumentException for service response error code
	// "InvalidArgumentException".
	//
	// The value for this input parameter is invalid.
	ErrCodeInvalidArgumentException = "InvalidArgumentException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// The specified resource is not found.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"
)
View Source 
const (
	ServiceName = "Kinesis Video WebRTC Storage" // Name of service.
	EndpointsID = "kinesisvideo"                 // ID to lookup a service endpoint with.
	ServiceID   = "Kinesis Video WebRTC Storage" // 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:"-"`

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

You do not have required permissions to perform this operation.

func (*AccessDeniedException) Code 

func (s *AccessDeniedException) Code() string

Code returns the exception type name.

func (*AccessDeniedException) Error 

func (s *AccessDeniedException) Error() string

func (AccessDeniedException) GoString 

func (s AccessDeniedException) GoString() string

GoString returns the string representation.

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

func (*AccessDeniedException) Message 

func (s *AccessDeniedException) Message() string

Message returns the exception's message.

func (*AccessDeniedException) OrigErr 

func (s *AccessDeniedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*AccessDeniedException) RequestID 

func (s *AccessDeniedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*AccessDeniedException) StatusCode 

func (s *AccessDeniedException) StatusCode() int

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

func (AccessDeniedException) String 

func (s AccessDeniedException) String() string

String returns the string representation.

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

type ClientLimitExceededException 

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

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

Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.

func (*ClientLimitExceededException) Code 

func (s *ClientLimitExceededException) Code() string

Code returns the exception type name.

func (*ClientLimitExceededException) Error 

func (s *ClientLimitExceededException) Error() string

func (ClientLimitExceededException) GoString 

func (s ClientLimitExceededException) GoString() string

GoString returns the string representation.

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

func (*ClientLimitExceededException) Message 

func (s *ClientLimitExceededException) Message() string

Message returns the exception's message.

func (*ClientLimitExceededException) OrigErr 

func (s *ClientLimitExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ClientLimitExceededException) RequestID 

func (s *ClientLimitExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ClientLimitExceededException) StatusCode 

func (s *ClientLimitExceededException) StatusCode() int

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

func (ClientLimitExceededException) String 

func (s ClientLimitExceededException) String() string

String returns the string representation.

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

type InvalidArgumentException 

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

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

The value for this input parameter is invalid.

func (*InvalidArgumentException) Code 

func (s *InvalidArgumentException) Code() string

Code returns the exception type name.

func (*InvalidArgumentException) Error 

func (s *InvalidArgumentException) Error() string

func (InvalidArgumentException) GoString 

func (s InvalidArgumentException) GoString() string

GoString returns the string representation.

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

func (*InvalidArgumentException) Message 

func (s *InvalidArgumentException) Message() string

Message returns the exception's message.

func (*InvalidArgumentException) OrigErr 

func (s *InvalidArgumentException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidArgumentException) RequestID 

func (s *InvalidArgumentException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidArgumentException) StatusCode 

func (s *InvalidArgumentException) StatusCode() int

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

func (InvalidArgumentException) String 

func (s InvalidArgumentException) String() string

String returns the string representation.

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

type JoinStorageSessionInput 

type JoinStorageSessionInput struct {

	// The Amazon Resource Name (ARN) of the signaling channel.
	//
	// ChannelArn is a required field
	ChannelArn *string `locationName:"channelArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (JoinStorageSessionInput) GoString 

func (s JoinStorageSessionInput) GoString() string

GoString returns the string representation.

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

func (*JoinStorageSessionInput) SetChannelArn 

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

SetChannelArn sets the ChannelArn field's value.

func (JoinStorageSessionInput) String 

func (s JoinStorageSessionInput) String() string

String returns the string representation.

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

func (*JoinStorageSessionInput) Validate 

func (s *JoinStorageSessionInput) Validate() error

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

type JoinStorageSessionOutput 

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

func (JoinStorageSessionOutput) GoString 

func (s JoinStorageSessionOutput) GoString() string

GoString returns the string representation.

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

func (JoinStorageSessionOutput) String 

func (s JoinStorageSessionOutput) String() string

String returns the string representation.

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

type KinesisVideoWebRTCStorage 

type KinesisVideoWebRTCStorage struct {
	*client.Client
}

KinesisVideoWebRTCStorage provides the API operation methods for making requests to Amazon Kinesis Video WebRTC Storage. See this package's package overview docs for details on the service.

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

New creates a new instance of the KinesisVideoWebRTCStorage 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 KinesisVideoWebRTCStorage client from just a session.
svc := kinesisvideowebrtcstorage.New(mySession)

// Create a KinesisVideoWebRTCStorage client with additional configuration
svc := kinesisvideowebrtcstorage.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*KinesisVideoWebRTCStorage) JoinStorageSession 

func (c *KinesisVideoWebRTCStorage) JoinStorageSession(input *JoinStorageSessionInput) (*JoinStorageSessionOutput, error)

JoinStorageSession API operation for Amazon Kinesis Video WebRTC Storage.

Join the ongoing one way-video and/or multi-way audio WebRTC session as a video producing device for an input channel. If there’s no existing session for the channel, a new streaming session needs to be created, and the Amazon Resource Name (ARN) of the signaling channel must be provided.

Currently for the SINGLE_MASTER type, a video producing device is able to ingest both audio and video media into a stream, while viewers can only ingest audio. Both a video producing device and viewers can join the session first, and wait for other participants.

While participants are having peer to peer conversations through webRTC, the ingested media session will be stored into the Kinesis Video Stream. Multiple viewers are able to playback real-time media.

Customers can also use existing Kinesis Video Streams features like HLS or DASH playback, Image generation, and more with ingested WebRTC media.

Assume that only one video producing device client can be associated with a session for the channel. If more than one client joins the session of a specific channel as a video producing device, the most recent client request takes precedence.

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 Kinesis Video WebRTC Storage's API operation JoinStorageSession for usage and error information.

Returned Error Types:

  • ClientLimitExceededException Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.

  • InvalidArgumentException The value for this input parameter is invalid.

  • AccessDeniedException You do not have required permissions to perform this operation.

  • ResourceNotFoundException The specified resource is not found.

See also, https://docs.aws.amazon.com/goto/WebAPI/kinesis-video-webrtc-storage-2018-05-10/JoinStorageSession

func (*KinesisVideoWebRTCStorage) JoinStorageSessionRequest 

func (c *KinesisVideoWebRTCStorage) JoinStorageSessionRequest(input *JoinStorageSessionInput) (req *request.Request, output *JoinStorageSessionOutput)

JoinStorageSessionRequest generates a "aws/request.Request" representing the client's request for the JoinStorageSession 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 JoinStorageSession for more information on using the JoinStorageSession 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 JoinStorageSessionRequest method.
req, resp := client.JoinStorageSessionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kinesis-video-webrtc-storage-2018-05-10/JoinStorageSession

func (*KinesisVideoWebRTCStorage) JoinStorageSessionWithContext 

func (c *KinesisVideoWebRTCStorage) JoinStorageSessionWithContext(ctx aws.Context, input *JoinStorageSessionInput, opts ...request.Option) (*JoinStorageSessionOutput, error)

JoinStorageSessionWithContext is the same as JoinStorageSession with the addition of the ability to pass a context and additional request options.

See JoinStorageSession 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 ResourceNotFoundException 

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

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

The specified resource is not found.

func (*ResourceNotFoundException) Code 

func (s *ResourceNotFoundException) Code() string

Code returns the exception type name.

func (*ResourceNotFoundException) Error 

func (s *ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString 

func (s ResourceNotFoundException) GoString() string

GoString returns the string representation.

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

func (*ResourceNotFoundException) Message 

func (s *ResourceNotFoundException) Message() string

Message returns the exception's message.

func (*ResourceNotFoundException) OrigErr 

func (s *ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFoundException) RequestID 

func (s *ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFoundException) StatusCode 

func (s *ResourceNotFoundException) StatusCode() int

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

func (ResourceNotFoundException) String 

func (s ResourceNotFoundException) String() string

String returns the string representation.

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

Source Files

View all Source files

Directories

Path Synopsis
Package kinesisvideowebrtcstorageiface provides an interface to enable mocking the Amazon Kinesis Video WebRTC Storage service client for testing your code.
 Package kinesisvideowebrtcstorageiface provides an interface to enable mocking the Amazon Kinesis Video WebRTC Storage 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.