ivsrealtime

package
v1.44.261 Latest Latest
Warning

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

 Go to latest Published: May 10, 2023 License: Apache-2.0 Imports: 10 Imported by: 5

Documentation

Overview

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

Introduction

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

Terminology: The IVS stage API sometimes is referred to as the IVS RealTime API.

Resources

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

  • Stage — A stage is a virtual space where multiple participants can exchange audio and video in real time.

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 and "Tag naming limits and requirements"; Amazon IVS stages has no service-specific constraints beyond what is documented there.

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 stage API has these tag-related endpoints: TagResource, UntagResource, and ListTagsForResource. The following resource supports tagging: Stage.

At most 50 tags can be applied to a resource.

Stages Endpoints

  • CreateParticipantToken — Creates an additional token for a specified stage. This can be done after stage creation or when tokens expire.

  • CreateStage — Creates a new stage (and optionally participant tokens).

  • DeleteStage — Shuts down and deletes the specified stage (disconnecting all participants).

  • DisconnectParticipant — Disconnects a specified participant and revokes the participant permanently from a specified stage.

  • GetStage — Gets information for the specified stage.

  • ListStages — Gets summary information about all stages in your account, in the AWS region where the API request is processed.

  • UpdateStage — Updates a stage’s configuration.

Tags Endpoints

  • ListTagsForResource — Gets information about AWS tags for the specified ARN.

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

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

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

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

Using the Client

To contact Amazon Interactive Video Service RealTime 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 RealTime client IVSRealTime for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/ivsrealtime/#New

Index

Constants

View Source 
const (
	// ParticipantTokenCapabilityPublish is a ParticipantTokenCapability enum value
	ParticipantTokenCapabilityPublish = "PUBLISH"

	// ParticipantTokenCapabilitySubscribe is a ParticipantTokenCapability enum value
	ParticipantTokenCapabilitySubscribe = "SUBSCRIBE"
)
View Source 
const (

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

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

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

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

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

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

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

Service information constants

Variables

This section is empty.

Functions

func ParticipantTokenCapability_Values 

func ParticipantTokenCapability_Values() []string

ParticipantTokenCapability_Values returns all elements of the ParticipantTokenCapability enum

Types

type AccessDeniedException 

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

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

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

func (*AccessDeniedException) Code 

func (s *AccessDeniedException) Code() string

Code returns the exception type name.

func (*AccessDeniedException) Error 

func (s *AccessDeniedException) Error() string

func (AccessDeniedException) GoString 

func (s AccessDeniedException) GoString() string

GoString returns the string representation.

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

func (*AccessDeniedException) Message 

func (s *AccessDeniedException) Message() string

Message returns the exception's message.

func (*AccessDeniedException) OrigErr 

func (s *AccessDeniedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*AccessDeniedException) RequestID 

func (s *AccessDeniedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*AccessDeniedException) StatusCode 

func (s *AccessDeniedException) StatusCode() int

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

func (AccessDeniedException) String 

func (s AccessDeniedException) String() string

String returns the string representation.

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

type ConflictException 

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

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

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

func (*ConflictException) Code 

func (s *ConflictException) Code() string

Code returns the exception type name.

func (*ConflictException) Error 

func (s *ConflictException) Error() string

func (ConflictException) GoString 

func (s ConflictException) GoString() string

GoString returns the string representation.

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

func (*ConflictException) Message 

func (s *ConflictException) Message() string

Message returns the exception's message.

func (*ConflictException) OrigErr 

func (s *ConflictException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ConflictException) RequestID 

func (s *ConflictException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ConflictException) StatusCode 

func (s *ConflictException) StatusCode() int

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

func (ConflictException) String 

func (s ConflictException) String() string

String returns the string representation.

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

type CreateParticipantTokenInput 

type CreateParticipantTokenInput struct {

	// Application-provided attributes to encode into the token and attach to a
	// stage. Map keys and values can contain UTF-8 encoded text. The maximum length
	// of this field is 1 KB total. This field is exposed to all stage participants
	// and should not be used for personally identifying, confidential, or sensitive
	// information.
	Attributes map[string]*string `locationName:"attributes" type:"map"`

	// Set of capabilities that the user is allowed to perform in the stage. Default:
	// PUBLISH, SUBSCRIBE.
	Capabilities []*string `locationName:"capabilities" type:"list" enum:"ParticipantTokenCapability"`

	// Duration (in minutes), after which the token expires. Default: 60 (1 hour).
	Duration *int64 `locationName:"duration" min:"1" type:"integer"`

	// ARN of the stage to which this token is scoped.
	//
	// StageArn is a required field
	StageArn *string `locationName:"stageArn" min:"1" type:"string" required:"true"`

	// Name that can be specified to help identify the token. This can be any UTF-8
	// encoded text. This field is exposed to all stage participants and should
	// not be used for personally identifying, confidential, or sensitive information.
	UserId *string `locationName:"userId" type:"string"`
	// contains filtered or unexported fields
}

func (CreateParticipantTokenInput) GoString 

func (s CreateParticipantTokenInput) 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 (*CreateParticipantTokenInput) SetAttributes 

func (s *CreateParticipantTokenInput) SetAttributes(v map[string]*string) *CreateParticipantTokenInput

SetAttributes sets the Attributes field's value.

func (*CreateParticipantTokenInput) SetCapabilities 

func (s *CreateParticipantTokenInput) SetCapabilities(v []*string) *CreateParticipantTokenInput

SetCapabilities sets the Capabilities field's value.

func (*CreateParticipantTokenInput) SetDuration 

func (s *CreateParticipantTokenInput) SetDuration(v int64) *CreateParticipantTokenInput

SetDuration sets the Duration field's value.

func (*CreateParticipantTokenInput) SetStageArn 

func (s *CreateParticipantTokenInput) SetStageArn(v string) *CreateParticipantTokenInput

SetStageArn sets the StageArn field's value.

func (*CreateParticipantTokenInput) SetUserId 

func (s *CreateParticipantTokenInput) SetUserId(v string) *CreateParticipantTokenInput

SetUserId sets the UserId field's value.

func (CreateParticipantTokenInput) String 

func (s CreateParticipantTokenInput) 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 (*CreateParticipantTokenInput) Validate 

func (s *CreateParticipantTokenInput) Validate() error

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

type CreateParticipantTokenOutput 

type CreateParticipantTokenOutput struct {

	// The participant token that was created.
	ParticipantToken *ParticipantToken `locationName:"participantToken" type:"structure"`
	// contains filtered or unexported fields
}

func (CreateParticipantTokenOutput) GoString 

func (s CreateParticipantTokenOutput) 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 (*CreateParticipantTokenOutput) SetParticipantToken 

func (s *CreateParticipantTokenOutput) SetParticipantToken(v *ParticipantToken) *CreateParticipantTokenOutput

SetParticipantToken sets the ParticipantToken field's value.

func (CreateParticipantTokenOutput) String 

func (s CreateParticipantTokenOutput) 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 CreateStageInput 

type CreateStageInput struct {

	// Optional name that can be specified for the stage being created.
	Name *string `locationName:"name" type:"string"`

	// Array of participant token configuration objects to attach to the new stage.
	ParticipantTokenConfigurations []*ParticipantTokenConfiguration `locationName:"participantTokenConfigurations" type:"list"`

	// Tags attached to the resource. Array of maps, each of the form string:string
	// (key:value). See Tagging AWS Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html)
	// for details, including restrictions that apply to tags and "Tag naming limits
	// and requirements"; Amazon IVS has no constraints on tags beyond what is documented
	// there.
	Tags map[string]*string `locationName:"tags" type:"map"`
	// contains filtered or unexported fields
}

func (CreateStageInput) GoString 

func (s CreateStageInput) 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 (*CreateStageInput) SetName 

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

SetName sets the Name field's value.

func (*CreateStageInput) SetParticipantTokenConfigurations 

func (s *CreateStageInput) SetParticipantTokenConfigurations(v []*ParticipantTokenConfiguration) *CreateStageInput

SetParticipantTokenConfigurations sets the ParticipantTokenConfigurations field's value.

func (*CreateStageInput) SetTags 

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

SetTags sets the Tags field's value.

func (CreateStageInput) String 

func (s CreateStageInput) 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 (*CreateStageInput) Validate 

func (s *CreateStageInput) Validate() error

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

type CreateStageOutput 

type CreateStageOutput struct {

	// Participant tokens attached to the stage. These correspond to the participants
	// in the request.
	ParticipantTokens []*ParticipantToken `locationName:"participantTokens" type:"list"`

	// The stage that was created.
	Stage *Stage `locationName:"stage" type:"structure"`
	// contains filtered or unexported fields
}

func (CreateStageOutput) GoString 

func (s CreateStageOutput) 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 (*CreateStageOutput) SetParticipantTokens 

func (s *CreateStageOutput) SetParticipantTokens(v []*ParticipantToken) *CreateStageOutput

SetParticipantTokens sets the ParticipantTokens field's value.

func (*CreateStageOutput) SetStage 

func (s *CreateStageOutput) SetStage(v *Stage) *CreateStageOutput

SetStage sets the Stage field's value.

func (CreateStageOutput) String 

func (s CreateStageOutput) 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 DeleteStageInput 

type DeleteStageInput struct {

	// ARN of the stage to be deleted.
	//
	// Arn is a required field
	Arn *string `locationName:"arn" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteStageInput) GoString 

func (s DeleteStageInput) 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 (*DeleteStageInput) SetArn 

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

SetArn sets the Arn field's value.

func (DeleteStageInput) String 

func (s DeleteStageInput) 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 (*DeleteStageInput) Validate 

func (s *DeleteStageInput) Validate() error

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

type DeleteStageOutput 

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

func (DeleteStageOutput) GoString 

func (s DeleteStageOutput) 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 (DeleteStageOutput) String 

func (s DeleteStageOutput) 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 DisconnectParticipantInput 

type DisconnectParticipantInput struct {

	// Identifier of the participant to be disconnected. This is returned by CreateParticipantToken.
	//
	// ParticipantId is a required field
	ParticipantId *string `locationName:"participantId" type:"string" required:"true"`

	// Description of why this participant is being disconnected.
	Reason *string `locationName:"reason" type:"string"`

	// ARN of the stage to which the participant is attached.
	//
	// StageArn is a required field
	StageArn *string `locationName:"stageArn" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DisconnectParticipantInput) GoString 

func (s DisconnectParticipantInput) 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 (*DisconnectParticipantInput) SetParticipantId 

func (s *DisconnectParticipantInput) SetParticipantId(v string) *DisconnectParticipantInput

SetParticipantId sets the ParticipantId field's value.

func (*DisconnectParticipantInput) SetReason 

func (s *DisconnectParticipantInput) SetReason(v string) *DisconnectParticipantInput

SetReason sets the Reason field's value.

func (*DisconnectParticipantInput) SetStageArn 

func (s *DisconnectParticipantInput) SetStageArn(v string) *DisconnectParticipantInput

SetStageArn sets the StageArn field's value.

func (DisconnectParticipantInput) String 

func (s DisconnectParticipantInput) 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 (*DisconnectParticipantInput) Validate 

func (s *DisconnectParticipantInput) Validate() error

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

type DisconnectParticipantOutput 

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

func (DisconnectParticipantOutput) GoString 

func (s DisconnectParticipantOutput) 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 (DisconnectParticipantOutput) String 

func (s DisconnectParticipantOutput) 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 GetStageInput 

type GetStageInput struct {

	// ARN of the stage for which the information 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 (GetStageInput) GoString 

func (s GetStageInput) 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 (*GetStageInput) SetArn 

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

SetArn sets the Arn field's value.

func (GetStageInput) String 

func (s GetStageInput) 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 (*GetStageInput) Validate 

func (s *GetStageInput) Validate() error

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

type GetStageOutput 

type GetStageOutput struct {

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

func (GetStageOutput) GoString 

func (s GetStageOutput) 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 (*GetStageOutput) SetStage 

func (s *GetStageOutput) SetStage(v *Stage) *GetStageOutput

SetStage sets the Stage field's value.

func (GetStageOutput) String 

func (s GetStageOutput) 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 IVSRealTime 

type IVSRealTime struct {
	*client.Client
}

IVSRealTime provides the API operation methods for making requests to Amazon Interactive Video Service RealTime. See this package's package overview docs for details on the service.

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

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

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

func (*IVSRealTime) CreateParticipantToken 

func (c *IVSRealTime) CreateParticipantToken(input *CreateParticipantTokenInput) (*CreateParticipantTokenOutput, error)

CreateParticipantToken API operation for Amazon Interactive Video Service RealTime.

Creates an additional token for a specified stage. This can be done after stage creation or when tokens expire. Tokens always are scoped to the stage for which they are created.

Encryption keys are owned by Amazon IVS and never used directly by your application.

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 RealTime's API operation CreateParticipantToken for usage and error information.

Returned Error Types:

  • ResourceNotFoundException

  • ValidationException

  • AccessDeniedException

  • ServiceQuotaExceededException

  • PendingVerification

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

func (*IVSRealTime) CreateParticipantTokenRequest 

func (c *IVSRealTime) CreateParticipantTokenRequest(input *CreateParticipantTokenInput) (req *request.Request, output *CreateParticipantTokenOutput)

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

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

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

func (*IVSRealTime) CreateParticipantTokenWithContext 

func (c *IVSRealTime) CreateParticipantTokenWithContext(ctx aws.Context, input *CreateParticipantTokenInput, opts ...request.Option) (*CreateParticipantTokenOutput, error)

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

See CreateParticipantToken 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 (*IVSRealTime) CreateStage 

func (c *IVSRealTime) CreateStage(input *CreateStageInput) (*CreateStageOutput, error)

CreateStage API operation for Amazon Interactive Video Service RealTime.

Creates a new stage (and optionally participant tokens).

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 RealTime's API operation CreateStage for usage and error information.

Returned Error Types:

  • ValidationException

  • AccessDeniedException

  • ServiceQuotaExceededException

  • PendingVerification

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

func (*IVSRealTime) CreateStageRequest 

func (c *IVSRealTime) CreateStageRequest(input *CreateStageInput) (req *request.Request, output *CreateStageOutput)

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

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

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

func (*IVSRealTime) CreateStageWithContext 

func (c *IVSRealTime) CreateStageWithContext(ctx aws.Context, input *CreateStageInput, opts ...request.Option) (*CreateStageOutput, error)

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

See CreateStage 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 (*IVSRealTime) DeleteStage 

func (c *IVSRealTime) DeleteStage(input *DeleteStageInput) (*DeleteStageOutput, error)

DeleteStage API operation for Amazon Interactive Video Service RealTime.

Shuts down and deletes the specified stage (disconnecting all participants).

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 RealTime's API operation DeleteStage for usage and error information.

Returned Error Types:

  • ResourceNotFoundException

  • ValidationException

  • AccessDeniedException

  • ConflictException

  • PendingVerification

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

func (*IVSRealTime) DeleteStageRequest 

func (c *IVSRealTime) DeleteStageRequest(input *DeleteStageInput) (req *request.Request, output *DeleteStageOutput)

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

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

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

func (*IVSRealTime) DeleteStageWithContext 

func (c *IVSRealTime) DeleteStageWithContext(ctx aws.Context, input *DeleteStageInput, opts ...request.Option) (*DeleteStageOutput, error)

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

See DeleteStage 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 (*IVSRealTime) DisconnectParticipant 

func (c *IVSRealTime) DisconnectParticipant(input *DisconnectParticipantInput) (*DisconnectParticipantOutput, error)

DisconnectParticipant API operation for Amazon Interactive Video Service RealTime.

Disconnects a specified participant and revokes the participant permanently from a specified stage.

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 RealTime's API operation DisconnectParticipant for usage and error information.

Returned Error Types:

  • ResourceNotFoundException

  • ValidationException

  • AccessDeniedException

  • PendingVerification

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

func (*IVSRealTime) DisconnectParticipantRequest 

func (c *IVSRealTime) DisconnectParticipantRequest(input *DisconnectParticipantInput) (req *request.Request, output *DisconnectParticipantOutput)

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

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

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

func (*IVSRealTime) DisconnectParticipantWithContext 

func (c *IVSRealTime) DisconnectParticipantWithContext(ctx aws.Context, input *DisconnectParticipantInput, opts ...request.Option) (*DisconnectParticipantOutput, error)

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

See DisconnectParticipant 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 (*IVSRealTime) GetStage 

func (c *IVSRealTime) GetStage(input *GetStageInput) (*GetStageOutput, error)

GetStage API operation for Amazon Interactive Video Service RealTime.

Gets information for the specified stage.

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 RealTime's API operation GetStage for usage and error information.

Returned Error Types:

  • ResourceNotFoundException

  • ValidationException

  • AccessDeniedException

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

func (*IVSRealTime) GetStageRequest 

func (c *IVSRealTime) GetStageRequest(input *GetStageInput) (req *request.Request, output *GetStageOutput)

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

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

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

func (*IVSRealTime) GetStageWithContext 

func (c *IVSRealTime) GetStageWithContext(ctx aws.Context, input *GetStageInput, opts ...request.Option) (*GetStageOutput, error)

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

See GetStage 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 (*IVSRealTime) ListStages 

func (c *IVSRealTime) ListStages(input *ListStagesInput) (*ListStagesOutput, error)

ListStages API operation for Amazon Interactive Video Service RealTime.

Gets summary information about all stages in your account, in the AWS region where the API request is processed.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Interactive Video Service RealTime's API operation ListStages for usage and error information.

Returned Error Types:

  • ValidationException

  • AccessDeniedException

  • ConflictException

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

func (*IVSRealTime) ListStagesPages 

func (c *IVSRealTime) ListStagesPages(input *ListStagesInput, fn func(*ListStagesOutput, bool) bool) error

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

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

func (*IVSRealTime) ListStagesPagesWithContext 

func (c *IVSRealTime) ListStagesPagesWithContext(ctx aws.Context, input *ListStagesInput, fn func(*ListStagesOutput, bool) bool, opts ...request.Option) error

ListStagesPagesWithContext same as ListStagesPages 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 (*IVSRealTime) ListStagesRequest 

func (c *IVSRealTime) ListStagesRequest(input *ListStagesInput) (req *request.Request, output *ListStagesOutput)

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

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

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

func (*IVSRealTime) ListStagesWithContext 

func (c *IVSRealTime) ListStagesWithContext(ctx aws.Context, input *ListStagesInput, opts ...request.Option) (*ListStagesOutput, error)

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

See ListStages 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 (*IVSRealTime) ListTagsForResource 

func (c *IVSRealTime) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)

ListTagsForResource API operation for Amazon Interactive Video Service RealTime.

Gets information about AWS tags for the specified ARN.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Interactive Video Service RealTime's API operation ListTagsForResource for usage and error information.

Returned Error Types:

  • ResourceNotFoundException

  • ValidationException

  • InternalServerException

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

func (*IVSRealTime) ListTagsForResourceRequest 

func (c *IVSRealTime) 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-realtime-2020-07-14/ListTagsForResource

func (*IVSRealTime) ListTagsForResourceWithContext 

func (c *IVSRealTime) 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 (*IVSRealTime) TagResource 

func (c *IVSRealTime) TagResource(input *TagResourceInput) (*TagResourceOutput, error)

TagResource API operation for Amazon Interactive Video Service RealTime.

Adds or updates tags for the AWS resource with the specified ARN.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Interactive Video Service RealTime's API operation TagResource for usage and error information.

Returned Error Types:

  • ResourceNotFoundException

  • ValidationException

  • InternalServerException

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

func (*IVSRealTime) TagResourceRequest 

func (c *IVSRealTime) 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-realtime-2020-07-14/TagResource

func (*IVSRealTime) TagResourceWithContext 

func (c *IVSRealTime) 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 (*IVSRealTime) UntagResource 

func (c *IVSRealTime) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)

UntagResource API operation for Amazon Interactive Video Service RealTime.

Removes tags from the resource with the specified ARN.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Interactive Video Service RealTime's API operation UntagResource for usage and error information.

Returned Error Types:

  • ResourceNotFoundException

  • ValidationException

  • InternalServerException

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

func (*IVSRealTime) UntagResourceRequest 

func (c *IVSRealTime) 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-realtime-2020-07-14/UntagResource

func (*IVSRealTime) UntagResourceWithContext 

func (c *IVSRealTime) 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 (*IVSRealTime) UpdateStage 

func (c *IVSRealTime) UpdateStage(input *UpdateStageInput) (*UpdateStageOutput, error)

UpdateStage API operation for Amazon Interactive Video Service RealTime.

Updates a stage’s configuration.

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 RealTime's API operation UpdateStage for usage and error information.

Returned Error Types:

  • ResourceNotFoundException

  • ValidationException

  • AccessDeniedException

  • ServiceQuotaExceededException

  • PendingVerification

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

func (*IVSRealTime) UpdateStageRequest 

func (c *IVSRealTime) UpdateStageRequest(input *UpdateStageInput) (req *request.Request, output *UpdateStageOutput)

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

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

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

func (*IVSRealTime) UpdateStageWithContext 

func (c *IVSRealTime) UpdateStageWithContext(ctx aws.Context, input *UpdateStageInput, opts ...request.Option) (*UpdateStageOutput, error)

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

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

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

func (*InternalServerException) Message 

func (s *InternalServerException) Message() string

Message returns the exception's message.

func (*InternalServerException) OrigErr 

func (s *InternalServerException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalServerException) RequestID 

func (s *InternalServerException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalServerException) StatusCode 

func (s *InternalServerException) StatusCode() int

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

func (InternalServerException) String 

func (s InternalServerException) String() string

String returns the string representation.

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

type ListStagesInput 

type ListStagesInput struct {

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

	// The first stage to retrieve. This is used for pagination; see the nextToken
	// response field.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListStagesInput) GoString 

func (s ListStagesInput) 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 (*ListStagesInput) SetMaxResults 

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

SetMaxResults sets the MaxResults field's value.

func (*ListStagesInput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (ListStagesInput) String 

func (s ListStagesInput) 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 (*ListStagesInput) Validate 

func (s *ListStagesInput) Validate() error

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

type ListStagesOutput 

type ListStagesOutput struct {

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

	// List of the matching stages (summary information only).
	//
	// Stages is a required field
	Stages []*StageSummary `locationName:"stages" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (ListStagesOutput) GoString 

func (s ListStagesOutput) 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 (*ListStagesOutput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (*ListStagesOutput) SetStages 

func (s *ListStagesOutput) SetStages(v []*StageSummary) *ListStagesOutput

SetStages sets the Stages field's value.

func (ListStagesOutput) String 

func (s ListStagesOutput) String() string

String returns the string representation.

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

type ListTagsForResourceInput 

type ListTagsForResourceInput struct {

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

func (ListTagsForResourceInput) GoString 

func (s ListTagsForResourceInput) GoString() string

GoString returns the string representation.

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

func (*ListTagsForResourceInput) SetResourceArn 

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

SetResourceArn sets the ResourceArn field's value.

func (ListTagsForResourceInput) String 

func (s ListTagsForResourceInput) String() string

String returns the string representation.

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

func (*ListTagsForResourceInput) Validate 

func (s *ListTagsForResourceInput) Validate() error

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

type ListTagsForResourceOutput 

type ListTagsForResourceOutput struct {

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

func (ListTagsForResourceOutput) GoString 

func (s ListTagsForResourceOutput) GoString() string

GoString returns the string representation.

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

func (*ListTagsForResourceOutput) SetTags 

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

SetTags sets the Tags field's value.

func (ListTagsForResourceOutput) String 

func (s ListTagsForResourceOutput) String() string

String returns the string representation.

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

type ParticipantToken 

type ParticipantToken struct {

	// Application-provided attributes to encode into the token and attach to a
	// stage. This field is exposed to all stage participants and should not be
	// used for personally identifying, confidential, or sensitive information.
	Attributes map[string]*string `locationName:"attributes" type:"map"`

	// Set of capabilities that the user is allowed to perform in the stage.
	Capabilities []*string `locationName:"capabilities" type:"list" enum:"ParticipantTokenCapability"`

	// Duration (in minutes), after which the participant token expires. Default:
	// 60 (1 hour).
	Duration *int64 `locationName:"duration" min:"1" type:"integer"`

	// ISO 8601 timestamp (returned as a string) for when this token expires.
	ExpirationTime *time.Time `locationName:"expirationTime" type:"timestamp" timestampFormat:"iso8601"`

	// Unique identifier for this participant token, assigned by IVS.
	ParticipantId *string `locationName:"participantId" type:"string"`

	// The issued client token, encrypted.
	//
	// Token is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ParticipantToken's
	// String and GoString methods.
	Token *string `locationName:"token" type:"string" sensitive:"true"`

	// Name to help identify the token. This can be any UTF-8 encoded text. This
	// field is exposed to all stage participants and should not be used for personally
	// identifying, confidential, or sensitive information.
	UserId *string `locationName:"userId" type:"string"`
	// contains filtered or unexported fields
}

Object specifying a participant token in a stage.

func (ParticipantToken) GoString 

func (s ParticipantToken) 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 (*ParticipantToken) SetAttributes 

func (s *ParticipantToken) SetAttributes(v map[string]*string) *ParticipantToken

SetAttributes sets the Attributes field's value.

func (*ParticipantToken) SetCapabilities 

func (s *ParticipantToken) SetCapabilities(v []*string) *ParticipantToken

SetCapabilities sets the Capabilities field's value.

func (*ParticipantToken) SetDuration 

func (s *ParticipantToken) SetDuration(v int64) *ParticipantToken

SetDuration sets the Duration field's value.

func (*ParticipantToken) SetExpirationTime 

func (s *ParticipantToken) SetExpirationTime(v time.Time) *ParticipantToken

SetExpirationTime sets the ExpirationTime field's value.

func (*ParticipantToken) SetParticipantId 

func (s *ParticipantToken) SetParticipantId(v string) *ParticipantToken

SetParticipantId sets the ParticipantId field's value.

func (*ParticipantToken) SetToken 

func (s *ParticipantToken) SetToken(v string) *ParticipantToken

SetToken sets the Token field's value.

func (*ParticipantToken) SetUserId 

func (s *ParticipantToken) SetUserId(v string) *ParticipantToken

SetUserId sets the UserId field's value.

func (ParticipantToken) String 

func (s ParticipantToken) 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 ParticipantTokenConfiguration 

type ParticipantTokenConfiguration struct {

	// Application-provided attributes to encode into the corresponding participant
	// token and attach to a stage. Map keys and values can contain UTF-8 encoded
	// text. The maximum length of this field is 1 KB total. This field is exposed
	// to all stage participants and should not be used for personally identifying,
	// confidential, or sensitive information.
	Attributes map[string]*string `locationName:"attributes" type:"map"`

	// Set of capabilities that the user is allowed to perform in the stage.
	Capabilities []*string `locationName:"capabilities" type:"list" enum:"ParticipantTokenCapability"`

	// Duration (in minutes), after which the corresponding participant token expires.
	// Default: 60 (1 hour).
	Duration *int64 `locationName:"duration" min:"1" type:"integer"`

	// Name that can be specified to help identify the corresponding participant
	// token. This can be any UTF-8 encoded text. This field is exposed to all stage
	// participants and should not be used for personally identifying, confidential,
	// or sensitive information.
	UserId *string `locationName:"userId" type:"string"`
	// contains filtered or unexported fields
}

Object specifying a participant token configuration in a stage.

func (ParticipantTokenConfiguration) GoString 

func (s ParticipantTokenConfiguration) 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 (*ParticipantTokenConfiguration) SetAttributes 

func (s *ParticipantTokenConfiguration) SetAttributes(v map[string]*string) *ParticipantTokenConfiguration

SetAttributes sets the Attributes field's value.

func (*ParticipantTokenConfiguration) SetCapabilities 

func (s *ParticipantTokenConfiguration) SetCapabilities(v []*string) *ParticipantTokenConfiguration

SetCapabilities sets the Capabilities field's value.

func (*ParticipantTokenConfiguration) SetDuration 

func (s *ParticipantTokenConfiguration) SetDuration(v int64) *ParticipantTokenConfiguration

SetDuration sets the Duration field's value.

func (*ParticipantTokenConfiguration) SetUserId 

func (s *ParticipantTokenConfiguration) SetUserId(v string) *ParticipantTokenConfiguration

SetUserId sets the UserId field's value.

func (ParticipantTokenConfiguration) String 

func (s ParticipantTokenConfiguration) 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 (*ParticipantTokenConfiguration) Validate 

func (s *ParticipantTokenConfiguration) Validate() error

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

type PendingVerification 

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

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

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

func (*PendingVerification) Code 

func (s *PendingVerification) Code() string

Code returns the exception type name.

func (*PendingVerification) Error 

func (s *PendingVerification) Error() string

func (PendingVerification) GoString 

func (s PendingVerification) GoString() string

GoString returns the string representation.

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

func (*PendingVerification) Message 

func (s *PendingVerification) Message() string

Message returns the exception's message.

func (*PendingVerification) OrigErr 

func (s *PendingVerification) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*PendingVerification) RequestID 

func (s *PendingVerification) RequestID() string

RequestID returns the service's response RequestID for request.

func (*PendingVerification) StatusCode 

func (s *PendingVerification) StatusCode() int

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

func (PendingVerification) String 

func (s PendingVerification) String() string

String returns the string representation.

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

type ResourceNotFoundException 

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

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

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

func (*ResourceNotFoundException) Code 

func (s *ResourceNotFoundException) Code() string

Code returns the exception type name.

func (*ResourceNotFoundException) Error 

func (s *ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString 

func (s ResourceNotFoundException) GoString() string

GoString returns the string representation.

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

func (*ResourceNotFoundException) Message 

func (s *ResourceNotFoundException) Message() string

Message returns the exception's message.

func (*ResourceNotFoundException) OrigErr 

func (s *ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFoundException) RequestID 

func (s *ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFoundException) StatusCode 

func (s *ResourceNotFoundException) StatusCode() int

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

func (ResourceNotFoundException) String 

func (s ResourceNotFoundException) String() string

String returns the string representation.

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

type ServiceQuotaExceededException 

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

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

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

func (*ServiceQuotaExceededException) Code 

func (s *ServiceQuotaExceededException) Code() string

Code returns the exception type name.

func (*ServiceQuotaExceededException) Error 

func (s *ServiceQuotaExceededException) Error() string

func (ServiceQuotaExceededException) GoString 

func (s ServiceQuotaExceededException) GoString() string

GoString returns the string representation.

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

func (*ServiceQuotaExceededException) Message 

func (s *ServiceQuotaExceededException) Message() string

Message returns the exception's message.

func (*ServiceQuotaExceededException) OrigErr 

func (s *ServiceQuotaExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ServiceQuotaExceededException) RequestID 

func (s *ServiceQuotaExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ServiceQuotaExceededException) StatusCode 

func (s *ServiceQuotaExceededException) StatusCode() int

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

func (ServiceQuotaExceededException) String 

func (s ServiceQuotaExceededException) String() string

String returns the string representation.

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

type Stage 

type Stage struct {

	// ID of the active session within the stage.
	ActiveSessionId *string `locationName:"activeSessionId" min:"16" type:"string"`

	// Stage ARN.
	//
	// Arn is a required field
	Arn *string `locationName:"arn" min:"1" type:"string" required:"true"`

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

	// Tags attached to the resource. Array of maps, each of the form string:string
	// (key:value). See Tagging AWS Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html)
	// for details, including restrictions that apply to tags and "Tag naming limits
	// and requirements"; Amazon IVS has no constraints on tags beyond what is documented
	// there.
	Tags map[string]*string `locationName:"tags" type:"map"`
	// contains filtered or unexported fields
}

Object specifying a stage.

func (Stage) GoString 

func (s Stage) 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 (*Stage) SetActiveSessionId 

func (s *Stage) SetActiveSessionId(v string) *Stage

SetActiveSessionId sets the ActiveSessionId field's value.

func (*Stage) SetArn 

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

SetArn sets the Arn field's value.

func (*Stage) SetName 

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

SetName sets the Name field's value.

func (*Stage) SetTags 

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

SetTags sets the Tags field's value.

func (Stage) String 

func (s Stage) 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 StageSummary 

type StageSummary struct {

	// ID of the active session within the stage.
	ActiveSessionId *string `locationName:"activeSessionId" min:"16" type:"string"`

	// Stage ARN.
	//
	// Arn is a required field
	Arn *string `locationName:"arn" min:"1" type:"string" required:"true"`

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

	// Tags attached to the resource. Array of maps, each of the form string:string
	// (key:value). See Tagging AWS Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html)
	// for details, including restrictions that apply to tags and "Tag naming limits
	// and requirements"; Amazon IVS has no constraints on tags beyond what is documented
	// there.
	Tags map[string]*string `locationName:"tags" type:"map"`
	// contains filtered or unexported fields
}

Summary information about a stage.

func (StageSummary) GoString 

func (s StageSummary) 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 (*StageSummary) SetActiveSessionId 

func (s *StageSummary) SetActiveSessionId(v string) *StageSummary

SetActiveSessionId sets the ActiveSessionId field's value.

func (*StageSummary) SetArn 

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

SetArn sets the Arn field's value.

func (*StageSummary) SetName 

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

SetName sets the Name field's value.

func (*StageSummary) SetTags 

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

SetTags sets the Tags field's value.

func (StageSummary) String 

func (s StageSummary) String() string

String returns the string representation.

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

type TagResourceInput 

type TagResourceInput struct {

	// The ARN of the resource to be tagged. The ARN must be URL-encoded.
	//
	// ResourceArn is a required field
	ResourceArn *string `location:"uri" locationName:"resourceArn" min:"1" type:"string" required:"true"`

	// Array of tags to be added or updated. Array of maps, each of the form string:string
	// (key:value). See Tagging AWS Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html)
	// for details, including restrictions that apply to tags and "Tag naming limits
	// and requirements"; Amazon IVS has no constraints beyond what is documented
	// there.
	//
	// Tags is a required field
	Tags map[string]*string `locationName:"tags" type:"map" required:"true"`
	// contains filtered or unexported fields
}

func (TagResourceInput) GoString 

func (s TagResourceInput) GoString() string

GoString returns the string representation.

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

func (*TagResourceInput) SetResourceArn 

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

SetResourceArn sets the ResourceArn field's value.

func (*TagResourceInput) SetTags 

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

SetTags sets the Tags field's value.

func (TagResourceInput) String 

func (s TagResourceInput) String() string

String returns the string representation.

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

func (*TagResourceInput) Validate 

func (s *TagResourceInput) Validate() error

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

type TagResourceOutput 

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

func (TagResourceOutput) GoString 

func (s TagResourceOutput) GoString() string

GoString returns the string representation.

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

func (TagResourceOutput) String 

func (s TagResourceOutput) String() string

String returns the string representation.

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

type UntagResourceInput 

type UntagResourceInput struct {

	// The ARN of the resource to be untagged. The ARN must be URL-encoded.
	//
	// ResourceArn is a required field
	ResourceArn *string `location:"uri" locationName:"resourceArn" min:"1" type:"string" required:"true"`

	// Array of tags to be removed. Array of maps, each of the form string:string
	// (key:value). See Tagging AWS Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html)
	// for details, including restrictions that apply to tags and "Tag naming limits
	// and requirements"; Amazon IVS has no constraints beyond what is documented
	// there.
	//
	// TagKeys is a required field
	TagKeys []*string `location:"querystring" locationName:"tagKeys" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (UntagResourceInput) GoString 

func (s UntagResourceInput) GoString() string

GoString returns the string representation.

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

func (*UntagResourceInput) SetResourceArn 

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

SetResourceArn sets the ResourceArn field's value.

func (*UntagResourceInput) SetTagKeys 

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

SetTagKeys sets the TagKeys field's value.

func (UntagResourceInput) String 

func (s UntagResourceInput) String() string

String returns the string representation.

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

func (*UntagResourceInput) Validate 

func (s *UntagResourceInput) Validate() error

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

type UntagResourceOutput 

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

func (UntagResourceOutput) GoString 

func (s UntagResourceOutput) GoString() string

GoString returns the string representation.

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

func (UntagResourceOutput) String 

func (s UntagResourceOutput) String() string

String returns the string representation.

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

type UpdateStageInput 

type UpdateStageInput struct {

	// ARN of the stage to be updated.
	//
	// Arn is a required field
	Arn *string `locationName:"arn" min:"1" type:"string" required:"true"`

	// Name of the stage to be updated.
	Name *string `locationName:"name" type:"string"`
	// contains filtered or unexported fields
}

func (UpdateStageInput) GoString 

func (s UpdateStageInput) 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 (*UpdateStageInput) SetArn 

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

SetArn sets the Arn field's value.

func (*UpdateStageInput) SetName 

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

SetName sets the Name field's value.

func (UpdateStageInput) String 

func (s UpdateStageInput) 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 (*UpdateStageInput) Validate 

func (s *UpdateStageInput) Validate() error

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

type UpdateStageOutput 

type UpdateStageOutput struct {

	// The updated stage.
	Stage *Stage `locationName:"stage" type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateStageOutput) GoString 

func (s UpdateStageOutput) 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 (*UpdateStageOutput) SetStage 

func (s *UpdateStageOutput) SetStage(v *Stage) *UpdateStageOutput

SetStage sets the Stage field's value.

func (UpdateStageOutput) String 

func (s UpdateStageOutput) String() string

String returns the string representation.

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

type ValidationException 

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

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

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

func (*ValidationException) Code 

func (s *ValidationException) Code() string

Code returns the exception type name.

func (*ValidationException) Error 

func (s *ValidationException) Error() string

func (ValidationException) GoString 

func (s ValidationException) GoString() string

GoString returns the string representation.

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

func (*ValidationException) Message 

func (s *ValidationException) Message() string

Message returns the exception's message.

func (*ValidationException) OrigErr 

func (s *ValidationException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ValidationException) RequestID 

func (s *ValidationException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ValidationException) StatusCode 

func (s *ValidationException) StatusCode() int

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

func (ValidationException) String 

func (s ValidationException) String() string

String returns the string representation.

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

Source Files

View all Source files

Directories

Path Synopsis
Package ivsrealtimeiface provides an interface to enable mocking the Amazon Interactive Video Service RealTime service client for testing your code.
 Package ivsrealtimeiface provides an interface to enable mocking the Amazon Interactive Video Service RealTime 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.