ivschat

package
v1.55.5 Latest Latest
Warning

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

 Go to latest Published: Jul 30, 2024 License: Apache-2.0 Imports: 10 Imported by: 8

Documentation

Overview

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

Introduction

The Amazon IVS Chat control-plane API enables you to create and manage Amazon IVS Chat resources. You also need to integrate with the Amazon IVS Chat Messaging API (https://docs.aws.amazon.com/ivs/latest/chatmsgapireference/chat-messaging-api.html), to enable users to interact with chat rooms in real time.

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

This document describes HTTP operations. There is a separate messaging API for managing Chat resources; see the Amazon IVS Chat Messaging API Reference (https://docs.aws.amazon.com/ivs/latest/chatmsgapireference/chat-messaging-api.html).

Notes on terminology:

  • You create service applications using the Amazon IVS Chat API. We refer to these as applications.

  • You create front-end client applications (browser and Android/iOS apps) using the Amazon IVS Chat Messaging API. We refer to these as clients.

Resources

The following resources are part of Amazon IVS Chat:

  • LoggingConfiguration — A configuration that allows customers to store and record sent messages in a chat room. See the Logging Configuration endpoints for more information.

  • Room — The central Amazon IVS Chat resource through which clients connect to and exchange chat messages. See the Room endpoints for more information.

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

At most 50 tags can be applied to a resource.

API Access Security

Your Amazon IVS Chat applications (service applications and clients) must be authenticated and authorized to access Amazon IVS Chat resources. Note the differences between these concepts:

  • Authentication is about verifying identity. Requests to the Amazon IVS Chat API must be signed to verify your identity.

  • Authorization is about granting permissions. Your IAM roles need to have permissions for Amazon IVS Chat API requests.

Users (viewers) connect to a room using secure access tokens that you create using the CreateChatToken endpoint through the AWS SDK. You call CreateChatToken for every user’s chat session, passing identity and authorization information about the user.

Signing API Requests

HTTP API requests must be signed with an AWS SigV4 signature using your AWS security credentials. The AWS Command Line Interface (CLI) and the AWS SDKs take care of signing the underlying API calls for you. However, if your application calls the Amazon IVS Chat HTTP API directly, it’s your responsibility to sign the requests.

You generate a signature using valid AWS credentials for an IAM role that has permission to perform the requested action. For example, DeleteMessage requests must be made using an IAM role that has the ivschat:DeleteMessage permission.

For more information:

Amazon Resource Names (ARNs)

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

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

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

Using the Client

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

Index

Constants

View Source 
const (
	// ChatTokenCapabilitySendMessage is a ChatTokenCapability enum value
	ChatTokenCapabilitySendMessage = "SEND_MESSAGE"

	// ChatTokenCapabilityDisconnectUser is a ChatTokenCapability enum value
	ChatTokenCapabilityDisconnectUser = "DISCONNECT_USER"

	// ChatTokenCapabilityDeleteMessage is a ChatTokenCapability enum value
	ChatTokenCapabilityDeleteMessage = "DELETE_MESSAGE"
)
View Source 
const (
	// FallbackResultAllow is a FallbackResult enum value
	FallbackResultAllow = "ALLOW"

	// FallbackResultDeny is a FallbackResult enum value
	FallbackResultDeny = "DENY"
)
View Source 
const (
	// LoggingConfigurationStateCreating is a LoggingConfigurationState enum value
	LoggingConfigurationStateCreating = "CREATING"

	// LoggingConfigurationStateCreateFailed is a LoggingConfigurationState enum value
	LoggingConfigurationStateCreateFailed = "CREATE_FAILED"

	// LoggingConfigurationStateDeleting is a LoggingConfigurationState enum value
	LoggingConfigurationStateDeleting = "DELETING"

	// LoggingConfigurationStateDeleteFailed is a LoggingConfigurationState enum value
	LoggingConfigurationStateDeleteFailed = "DELETE_FAILED"

	// LoggingConfigurationStateUpdating is a LoggingConfigurationState enum value
	LoggingConfigurationStateUpdating = "UPDATING"

	// LoggingConfigurationStateUpdateFailed is a LoggingConfigurationState enum value
	LoggingConfigurationStateUpdateFailed = "UPDATE_FAILED"

	// LoggingConfigurationStateActive is a LoggingConfigurationState enum value
	LoggingConfigurationStateActive = "ACTIVE"
)
View Source 
const (
	// ValidationExceptionReasonUnknownOperation is a ValidationExceptionReason enum value
	ValidationExceptionReasonUnknownOperation = "UNKNOWN_OPERATION"

	// ValidationExceptionReasonFieldValidationFailed is a ValidationExceptionReason enum value
	ValidationExceptionReasonFieldValidationFailed = "FIELD_VALIDATION_FAILED"

	// ValidationExceptionReasonOther is a ValidationExceptionReason enum value
	ValidationExceptionReasonOther = "OTHER"
)
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"

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

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

Service information constants

View Source 
const (
	// CreateLoggingConfigurationStateActive is a CreateLoggingConfigurationState enum value
	CreateLoggingConfigurationStateActive = "ACTIVE"
)
View Source 
const (
	// ResourceTypeRoom is a ResourceType enum value
	ResourceTypeRoom = "ROOM"
)
View Source 
const (
	// UpdateLoggingConfigurationStateActive is a UpdateLoggingConfigurationState enum value
	UpdateLoggingConfigurationStateActive = "ACTIVE"
)

Variables

This section is empty.

Functions

func ChatTokenCapability_Values 

func ChatTokenCapability_Values() []string

ChatTokenCapability_Values returns all elements of the ChatTokenCapability enum

func CreateLoggingConfigurationState_Values added in v1.44.140 

func CreateLoggingConfigurationState_Values() []string

CreateLoggingConfigurationState_Values returns all elements of the CreateLoggingConfigurationState enum

func FallbackResult_Values 

func FallbackResult_Values() []string

FallbackResult_Values returns all elements of the FallbackResult enum

func LoggingConfigurationState_Values added in v1.44.140 

func LoggingConfigurationState_Values() []string

LoggingConfigurationState_Values returns all elements of the LoggingConfigurationState enum

func ResourceType_Values 

func ResourceType_Values() []string

ResourceType_Values returns all elements of the ResourceType enum

func UpdateLoggingConfigurationState_Values added in v1.44.140 

func UpdateLoggingConfigurationState_Values() []string

UpdateLoggingConfigurationState_Values returns all elements of the UpdateLoggingConfigurationState enum

func ValidationExceptionReason_Values 

func ValidationExceptionReason_Values() []string

ValidationExceptionReason_Values returns all elements of the ValidationExceptionReason enum

Types

type AccessDeniedException 

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

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

type CloudWatchLogsDestinationConfiguration struct {

	// Name of the Amazon Cloudwatch Logs destination where chat activity will be
	// logged.
	//
	// LogGroupName is a required field
	LogGroupName *string `locationName:"logGroupName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Specifies a CloudWatch Logs location where chat logs will be stored.

func (CloudWatchLogsDestinationConfiguration) GoString added in v1.44.140 

func (s CloudWatchLogsDestinationConfiguration) 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 (*CloudWatchLogsDestinationConfiguration) SetLogGroupName added in v1.44.140 

func (s *CloudWatchLogsDestinationConfiguration) SetLogGroupName(v string) *CloudWatchLogsDestinationConfiguration

SetLogGroupName sets the LogGroupName field's value.

func (CloudWatchLogsDestinationConfiguration) String added in v1.44.140 

func (s CloudWatchLogsDestinationConfiguration) 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 (*CloudWatchLogsDestinationConfiguration) Validate added in v1.44.140 

func (s *CloudWatchLogsDestinationConfiguration) Validate() error

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

type ConflictException 

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

	Message_ *string `locationName:"message" type:"string"`

	// ResourceId is a required field
	ResourceId *string `locationName:"resourceId" type:"string" required:"true"`

	// ResourceType is a required field
	ResourceType *string `locationName:"resourceType" type:"string" required:"true" enum:"ResourceType"`
	// 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 CreateChatTokenInput 

type CreateChatTokenInput struct {

	// Application-provided attributes to encode into the token and attach to a
	// chat session. Map keys and values can contain UTF-8 encoded text. The maximum
	// length of this field is 1 KB total.
	//
	// Attributes is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by CreateChatTokenInput's
	// String and GoString methods.
	Attributes map[string]*string `locationName:"attributes" type:"map" sensitive:"true"`

	// Set of capabilities that the user is allowed to perform in the room. Default:
	// None (the capability to view messages is implicitly included in all requests).
	Capabilities []*string `locationName:"capabilities" type:"list" enum:"ChatTokenCapability"`

	// Identifier of the room that the client is trying to access. Currently this
	// must be an ARN.
	//
	// RoomIdentifier is a required field
	RoomIdentifier *string `locationName:"roomIdentifier" min:"1" type:"string" required:"true"`

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

	// Application-provided ID that uniquely identifies the user associated with
	// this token. This can be any UTF-8 encoded text.
	//
	// UserId is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by CreateChatTokenInput's
	// String and GoString methods.
	//
	// UserId is a required field
	UserId *string `locationName:"userId" min:"1" type:"string" required:"true" sensitive:"true"`
	// contains filtered or unexported fields
}

func (CreateChatTokenInput) GoString 

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

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

SetAttributes sets the Attributes field's value.

func (*CreateChatTokenInput) SetCapabilities 

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

SetCapabilities sets the Capabilities field's value.

func (*CreateChatTokenInput) SetRoomIdentifier 

func (s *CreateChatTokenInput) SetRoomIdentifier(v string) *CreateChatTokenInput

SetRoomIdentifier sets the RoomIdentifier field's value.

func (*CreateChatTokenInput) SetSessionDurationInMinutes 

func (s *CreateChatTokenInput) SetSessionDurationInMinutes(v int64) *CreateChatTokenInput

SetSessionDurationInMinutes sets the SessionDurationInMinutes field's value.

func (*CreateChatTokenInput) SetUserId 

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

SetUserId sets the UserId field's value.

func (CreateChatTokenInput) String 

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

func (s *CreateChatTokenInput) Validate() error

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

type CreateChatTokenOutput 

type CreateChatTokenOutput struct {

	// Time after which an end user's session is no longer valid. This is an ISO
	// 8601 timestamp; note that this is returned as a string.
	SessionExpirationTime *time.Time `locationName:"sessionExpirationTime" type:"timestamp" timestampFormat:"iso8601"`

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

	// Time after which the token is no longer valid and cannot be used to connect
	// to a room. This is an ISO 8601 timestamp; note that this is returned as a
	// string.
	TokenExpirationTime *time.Time `locationName:"tokenExpirationTime" type:"timestamp" timestampFormat:"iso8601"`
	// contains filtered or unexported fields
}

func (CreateChatTokenOutput) GoString 

func (s CreateChatTokenOutput) 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 (*CreateChatTokenOutput) SetSessionExpirationTime 

func (s *CreateChatTokenOutput) SetSessionExpirationTime(v time.Time) *CreateChatTokenOutput

SetSessionExpirationTime sets the SessionExpirationTime field's value.

func (*CreateChatTokenOutput) SetToken 

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

SetToken sets the Token field's value.

func (*CreateChatTokenOutput) SetTokenExpirationTime 

func (s *CreateChatTokenOutput) SetTokenExpirationTime(v time.Time) *CreateChatTokenOutput

SetTokenExpirationTime sets the TokenExpirationTime field's value.

func (CreateChatTokenOutput) String 

func (s CreateChatTokenOutput) 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 CreateLoggingConfigurationInput added in v1.44.140 

type CreateLoggingConfigurationInput struct {

	// A complex type that contains a destination configuration for where chat content
	// will be logged. There can be only one type of destination (cloudWatchLogs,
	// firehose, or s3) in a destinationConfiguration.
	//
	// DestinationConfiguration is a required field
	DestinationConfiguration *DestinationConfiguration `locationName:"destinationConfiguration" type:"structure" required:"true"`

	// Logging-configuration name. The value does not need to be unique.
	Name *string `locationName:"name" type:"string"`

	// Tags to attach 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 Chat has no constraints on tags beyond what
	// is documented there.
	Tags map[string]*string `locationName:"tags" type:"map"`
	// contains filtered or unexported fields
}

func (CreateLoggingConfigurationInput) GoString added in v1.44.140 

func (s CreateLoggingConfigurationInput) 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 (*CreateLoggingConfigurationInput) SetDestinationConfiguration added in v1.44.140 

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

SetDestinationConfiguration sets the DestinationConfiguration field's value.

func (*CreateLoggingConfigurationInput) SetName added in v1.44.140 

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

SetName sets the Name field's value.

func (*CreateLoggingConfigurationInput) SetTags added in v1.44.140 

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

SetTags sets the Tags field's value.

func (CreateLoggingConfigurationInput) String added in v1.44.140 

func (s CreateLoggingConfigurationInput) 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 (*CreateLoggingConfigurationInput) Validate added in v1.44.140 

func (s *CreateLoggingConfigurationInput) Validate() error

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

type CreateLoggingConfigurationOutput added in v1.44.140 

type CreateLoggingConfigurationOutput struct {

	// Logging-configuration ARN, assigned by the system.
	Arn *string `locationName:"arn" min:"1" type:"string"`

	// Time when the logging configuration was created. This is an ISO 8601 timestamp;
	// note that this is returned as a string.
	CreateTime *time.Time `locationName:"createTime" type:"timestamp" timestampFormat:"iso8601"`

	// A complex type that contains a destination configuration for where chat content
	// will be logged, from the request. There is only one type of destination (cloudWatchLogs,
	// firehose, or s3) in a destinationConfiguration.
	DestinationConfiguration *DestinationConfiguration `locationName:"destinationConfiguration" type:"structure"`

	// Logging-configuration ID, generated by the system. This is a relative identifier,
	// the part of the ARN that uniquely identifies the logging configuration.
	Id *string `locationName:"id" min:"12" type:"string"`

	// Logging-configuration name, from the request (if specified).
	Name *string `locationName:"name" type:"string"`

	// The state of the logging configuration. When the state is ACTIVE, the configuration
	// is ready to log chat content.
	State *string `locationName:"state" type:"string" enum:"CreateLoggingConfigurationState"`

	// Tags attached to the resource, from the request (if specified). Array of
	// maps, each of the form string:string (key:value).
	Tags map[string]*string `locationName:"tags" type:"map"`

	// Time of the logging configuration’s last update. This is an ISO 8601 timestamp;
	// note that this is returned as a string.
	UpdateTime *time.Time `locationName:"updateTime" type:"timestamp" timestampFormat:"iso8601"`
	// contains filtered or unexported fields
}

func (CreateLoggingConfigurationOutput) GoString added in v1.44.140 

func (s CreateLoggingConfigurationOutput) 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 (*CreateLoggingConfigurationOutput) SetArn added in v1.44.140 

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

SetArn sets the Arn field's value.

func (*CreateLoggingConfigurationOutput) SetCreateTime added in v1.44.140 

func (s *CreateLoggingConfigurationOutput) SetCreateTime(v time.Time) *CreateLoggingConfigurationOutput

SetCreateTime sets the CreateTime field's value.

func (*CreateLoggingConfigurationOutput) SetDestinationConfiguration added in v1.44.140 

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

SetDestinationConfiguration sets the DestinationConfiguration field's value.

func (*CreateLoggingConfigurationOutput) SetId added in v1.44.140 

func (s *CreateLoggingConfigurationOutput) SetId(v string) *CreateLoggingConfigurationOutput

SetId sets the Id field's value.

func (*CreateLoggingConfigurationOutput) SetName added in v1.44.140 

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

SetName sets the Name field's value.

func (*CreateLoggingConfigurationOutput) SetState added in v1.44.140 

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

SetState sets the State field's value.

func (*CreateLoggingConfigurationOutput) SetTags added in v1.44.140 

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

SetTags sets the Tags field's value.

func (*CreateLoggingConfigurationOutput) SetUpdateTime added in v1.44.140 

func (s *CreateLoggingConfigurationOutput) SetUpdateTime(v time.Time) *CreateLoggingConfigurationOutput

SetUpdateTime sets the UpdateTime field's value.

func (CreateLoggingConfigurationOutput) String added in v1.44.140 

func (s CreateLoggingConfigurationOutput) 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 CreateRoomInput 

type CreateRoomInput struct {

	// Array of logging-configuration identifiers attached to the room.
	LoggingConfigurationIdentifiers []*string `locationName:"loggingConfigurationIdentifiers" type:"list"`

	// Maximum number of characters in a single message. Messages are expected to
	// be UTF-8 encoded and this limit applies specifically to rune/code-point count,
	// not number of bytes. Default: 500.
	MaximumMessageLength *int64 `locationName:"maximumMessageLength" min:"1" type:"integer"`

	// Maximum number of messages per second that can be sent to the room (by all
	// clients). Default: 10.
	MaximumMessageRatePerSecond *int64 `locationName:"maximumMessageRatePerSecond" min:"1" type:"integer"`

	// Configuration information for optional review of messages.
	MessageReviewHandler *MessageReviewHandler `locationName:"messageReviewHandler" type:"structure"`

	// Room name. The value does not need to be unique.
	Name *string `locationName:"name" type:"string"`

	// Tags to attach 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 Chat has no constraints beyond what is documented
	// there.
	Tags map[string]*string `locationName:"tags" type:"map"`
	// contains filtered or unexported fields
}

func (CreateRoomInput) GoString 

func (s CreateRoomInput) 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 (*CreateRoomInput) SetLoggingConfigurationIdentifiers added in v1.44.140 

func (s *CreateRoomInput) SetLoggingConfigurationIdentifiers(v []*string) *CreateRoomInput

SetLoggingConfigurationIdentifiers sets the LoggingConfigurationIdentifiers field's value.

func (*CreateRoomInput) SetMaximumMessageLength 

func (s *CreateRoomInput) SetMaximumMessageLength(v int64) *CreateRoomInput

SetMaximumMessageLength sets the MaximumMessageLength field's value.

func (*CreateRoomInput) SetMaximumMessageRatePerSecond 

func (s *CreateRoomInput) SetMaximumMessageRatePerSecond(v int64) *CreateRoomInput

SetMaximumMessageRatePerSecond sets the MaximumMessageRatePerSecond field's value.

func (*CreateRoomInput) SetMessageReviewHandler 

func (s *CreateRoomInput) SetMessageReviewHandler(v *MessageReviewHandler) *CreateRoomInput

SetMessageReviewHandler sets the MessageReviewHandler field's value.

func (*CreateRoomInput) SetName 

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

SetName sets the Name field's value.

func (*CreateRoomInput) SetTags 

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

SetTags sets the Tags field's value.

func (CreateRoomInput) String 

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

func (s *CreateRoomInput) Validate() error

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

type CreateRoomOutput 

type CreateRoomOutput struct {

	// Room ARN, assigned by the system.
	Arn *string `locationName:"arn" min:"1" type:"string"`

	// Time when the room was created. This is an ISO 8601 timestamp; note that
	// this is returned as a string.
	CreateTime *time.Time `locationName:"createTime" type:"timestamp" timestampFormat:"iso8601"`

	// Room ID, generated by the system. This is a relative identifier, the part
	// of the ARN that uniquely identifies the room.
	Id *string `locationName:"id" min:"12" type:"string"`

	// Array of logging configurations attached to the room, from the request (if
	// specified).
	LoggingConfigurationIdentifiers []*string `locationName:"loggingConfigurationIdentifiers" type:"list"`

	// Maximum number of characters in a single message, from the request (if specified).
	MaximumMessageLength *int64 `locationName:"maximumMessageLength" min:"1" type:"integer"`

	// Maximum number of messages per second that can be sent to the room (by all
	// clients), from the request (if specified).
	MaximumMessageRatePerSecond *int64 `locationName:"maximumMessageRatePerSecond" min:"1" type:"integer"`

	// Configuration information for optional review of messages.
	MessageReviewHandler *MessageReviewHandler `locationName:"messageReviewHandler" type:"structure"`

	// Room name, from the request (if specified).
	Name *string `locationName:"name" type:"string"`

	// Tags attached to the resource, from the request (if specified).
	Tags map[string]*string `locationName:"tags" type:"map"`

	// Time of the room’s last update. This is an ISO 8601 timestamp; note that
	// this is returned as a string.
	UpdateTime *time.Time `locationName:"updateTime" type:"timestamp" timestampFormat:"iso8601"`
	// contains filtered or unexported fields
}

func (CreateRoomOutput) GoString 

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

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

SetArn sets the Arn field's value.

func (*CreateRoomOutput) SetCreateTime 

func (s *CreateRoomOutput) SetCreateTime(v time.Time) *CreateRoomOutput

SetCreateTime sets the CreateTime field's value.

func (*CreateRoomOutput) SetId 

func (s *CreateRoomOutput) SetId(v string) *CreateRoomOutput

SetId sets the Id field's value.

func (*CreateRoomOutput) SetLoggingConfigurationIdentifiers added in v1.44.140 

func (s *CreateRoomOutput) SetLoggingConfigurationIdentifiers(v []*string) *CreateRoomOutput

SetLoggingConfigurationIdentifiers sets the LoggingConfigurationIdentifiers field's value.

func (*CreateRoomOutput) SetMaximumMessageLength 

func (s *CreateRoomOutput) SetMaximumMessageLength(v int64) *CreateRoomOutput

SetMaximumMessageLength sets the MaximumMessageLength field's value.

func (*CreateRoomOutput) SetMaximumMessageRatePerSecond 

func (s *CreateRoomOutput) SetMaximumMessageRatePerSecond(v int64) *CreateRoomOutput

SetMaximumMessageRatePerSecond sets the MaximumMessageRatePerSecond field's value.

func (*CreateRoomOutput) SetMessageReviewHandler 

func (s *CreateRoomOutput) SetMessageReviewHandler(v *MessageReviewHandler) *CreateRoomOutput

SetMessageReviewHandler sets the MessageReviewHandler field's value.

func (*CreateRoomOutput) SetName 

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

SetName sets the Name field's value.

func (*CreateRoomOutput) SetTags 

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

SetTags sets the Tags field's value.

func (*CreateRoomOutput) SetUpdateTime 

func (s *CreateRoomOutput) SetUpdateTime(v time.Time) *CreateRoomOutput

SetUpdateTime sets the UpdateTime field's value.

func (CreateRoomOutput) String 

func (s CreateRoomOutput) 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 DeleteLoggingConfigurationInput added in v1.44.140 

type DeleteLoggingConfigurationInput struct {

	// Identifier of the logging configuration to be deleted.
	//
	// Identifier is a required field
	Identifier *string `locationName:"identifier" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteLoggingConfigurationInput) GoString added in v1.44.140 

func (s DeleteLoggingConfigurationInput) 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 (*DeleteLoggingConfigurationInput) SetIdentifier added in v1.44.140 

func (s *DeleteLoggingConfigurationInput) SetIdentifier(v string) *DeleteLoggingConfigurationInput

SetIdentifier sets the Identifier field's value.

func (DeleteLoggingConfigurationInput) String added in v1.44.140 

func (s DeleteLoggingConfigurationInput) 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 (*DeleteLoggingConfigurationInput) Validate added in v1.44.140 

func (s *DeleteLoggingConfigurationInput) Validate() error

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

type DeleteLoggingConfigurationOutput added in v1.44.140 

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

func (DeleteLoggingConfigurationOutput) GoString added in v1.44.140 

func (s DeleteLoggingConfigurationOutput) 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 (DeleteLoggingConfigurationOutput) String added in v1.44.140 

func (s DeleteLoggingConfigurationOutput) 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 DeleteMessageInput 

type DeleteMessageInput struct {

	// ID of the message to be deleted. This is the Id field in the received message
	// (see Message (Subscribe) (https://docs.aws.amazon.com/ivs/latest/chatmsgapireference/actions-message-subscribe.html)
	// in the Chat Messaging API).
	//
	// Id is a required field
	Id *string `locationName:"id" min:"12" type:"string" required:"true"`

	// Reason for deleting the message.
	Reason *string `locationName:"reason" min:"1" type:"string"`

	// Identifier of the room where the message should be deleted. Currently this
	// must be an ARN.
	//
	// RoomIdentifier is a required field
	RoomIdentifier *string `locationName:"roomIdentifier" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteMessageInput) GoString 

func (s DeleteMessageInput) 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 (*DeleteMessageInput) SetId 

func (s *DeleteMessageInput) SetId(v string) *DeleteMessageInput

SetId sets the Id field's value.

func (*DeleteMessageInput) SetReason 

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

SetReason sets the Reason field's value.

func (*DeleteMessageInput) SetRoomIdentifier 

func (s *DeleteMessageInput) SetRoomIdentifier(v string) *DeleteMessageInput

SetRoomIdentifier sets the RoomIdentifier field's value.

func (DeleteMessageInput) String 

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

func (s *DeleteMessageInput) Validate() error

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

type DeleteMessageOutput 

type DeleteMessageOutput struct {

	// Operation identifier, generated by Amazon IVS Chat.
	Id *string `locationName:"id" min:"12" type:"string"`
	// contains filtered or unexported fields
}

func (DeleteMessageOutput) GoString 

func (s DeleteMessageOutput) 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 (*DeleteMessageOutput) SetId 

func (s *DeleteMessageOutput) SetId(v string) *DeleteMessageOutput

SetId sets the Id field's value.

func (DeleteMessageOutput) String 

func (s DeleteMessageOutput) 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 DeleteRoomInput 

type DeleteRoomInput struct {

	// Identifier of the room to be deleted. Currently this must be an ARN.
	//
	// Identifier is a required field
	Identifier *string `locationName:"identifier" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteRoomInput) GoString 

func (s DeleteRoomInput) 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 (*DeleteRoomInput) SetIdentifier 

func (s *DeleteRoomInput) SetIdentifier(v string) *DeleteRoomInput

SetIdentifier sets the Identifier field's value.

func (DeleteRoomInput) String 

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

func (s *DeleteRoomInput) Validate() error

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

type DeleteRoomOutput 

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

func (DeleteRoomOutput) GoString 

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

func (s DeleteRoomOutput) String() string

String returns the string representation.

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

type DestinationConfiguration added in v1.44.140 

type DestinationConfiguration struct {

	// An Amazon CloudWatch Logs destination configuration where chat activity will
	// be logged.
	CloudWatchLogs *CloudWatchLogsDestinationConfiguration `locationName:"cloudWatchLogs" type:"structure"`

	// An Amazon Kinesis Data Firehose destination configuration where chat activity
	// will be logged.
	Firehose *FirehoseDestinationConfiguration `locationName:"firehose" type:"structure"`

	// An Amazon S3 destination configuration where chat activity will be logged.
	S3 *S3DestinationConfiguration `locationName:"s3" type:"structure"`
	// contains filtered or unexported fields
}

A complex type that describes a location where chat logs will be stored. Each member represents the configuration of one log destination. For logging, you define only one type of destination (for CloudWatch Logs, Kinesis Firehose, or S3).

func (DestinationConfiguration) GoString added in v1.44.140 

func (s DestinationConfiguration) GoString() string

GoString returns the string representation.

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

func (*DestinationConfiguration) SetCloudWatchLogs added in v1.44.140 

func (s *DestinationConfiguration) SetCloudWatchLogs(v *CloudWatchLogsDestinationConfiguration) *DestinationConfiguration

SetCloudWatchLogs sets the CloudWatchLogs field's value.

func (*DestinationConfiguration) SetFirehose added in v1.44.140 

func (s *DestinationConfiguration) SetFirehose(v *FirehoseDestinationConfiguration) *DestinationConfiguration

SetFirehose sets the Firehose field's value.

func (*DestinationConfiguration) SetS3 added in v1.44.140 

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

SetS3 sets the S3 field's value.

func (DestinationConfiguration) String added in v1.44.140 

func (s DestinationConfiguration) String() string

String returns the string representation.

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

func (*DestinationConfiguration) Validate added in v1.44.140 

func (s *DestinationConfiguration) Validate() error

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

type DisconnectUserInput 

type DisconnectUserInput struct {

	// Reason for disconnecting the user.
	Reason *string `locationName:"reason" min:"1" type:"string"`

	// Identifier of the room from which the user's clients should be disconnected.
	// Currently this must be an ARN.
	//
	// RoomIdentifier is a required field
	RoomIdentifier *string `locationName:"roomIdentifier" min:"1" type:"string" required:"true"`

	// ID of the user (connection) to disconnect from the room.
	//
	// UserId is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by DisconnectUserInput's
	// String and GoString methods.
	//
	// UserId is a required field
	UserId *string `locationName:"userId" min:"1" type:"string" required:"true" sensitive:"true"`
	// contains filtered or unexported fields
}

func (DisconnectUserInput) GoString 

func (s DisconnectUserInput) 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 (*DisconnectUserInput) SetReason 

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

SetReason sets the Reason field's value.

func (*DisconnectUserInput) SetRoomIdentifier 

func (s *DisconnectUserInput) SetRoomIdentifier(v string) *DisconnectUserInput

SetRoomIdentifier sets the RoomIdentifier field's value.

func (*DisconnectUserInput) SetUserId 

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

SetUserId sets the UserId field's value.

func (DisconnectUserInput) String 

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

func (s *DisconnectUserInput) Validate() error

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

type DisconnectUserOutput 

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

func (DisconnectUserOutput) GoString 

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

func (s DisconnectUserOutput) 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 FirehoseDestinationConfiguration added in v1.44.140 

type FirehoseDestinationConfiguration struct {

	// Name of the Amazon Kinesis Firehose delivery stream where chat activity will
	// be logged.
	//
	// DeliveryStreamName is a required field
	DeliveryStreamName *string `locationName:"deliveryStreamName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Specifies a Kinesis Firehose location where chat logs will be stored.

func (FirehoseDestinationConfiguration) GoString added in v1.44.140 

func (s FirehoseDestinationConfiguration) 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 (*FirehoseDestinationConfiguration) SetDeliveryStreamName added in v1.44.140 

func (s *FirehoseDestinationConfiguration) SetDeliveryStreamName(v string) *FirehoseDestinationConfiguration

SetDeliveryStreamName sets the DeliveryStreamName field's value.

func (FirehoseDestinationConfiguration) String added in v1.44.140 

func (s FirehoseDestinationConfiguration) 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 (*FirehoseDestinationConfiguration) Validate added in v1.44.140 

func (s *FirehoseDestinationConfiguration) Validate() error

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

type GetLoggingConfigurationInput added in v1.44.140 

type GetLoggingConfigurationInput struct {

	// Identifier of the logging configuration to be retrieved.
	//
	// Identifier is a required field
	Identifier *string `locationName:"identifier" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetLoggingConfigurationInput) GoString added in v1.44.140 

func (s GetLoggingConfigurationInput) 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 (*GetLoggingConfigurationInput) SetIdentifier added in v1.44.140 

func (s *GetLoggingConfigurationInput) SetIdentifier(v string) *GetLoggingConfigurationInput

SetIdentifier sets the Identifier field's value.

func (GetLoggingConfigurationInput) String added in v1.44.140 

func (s GetLoggingConfigurationInput) 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 (*GetLoggingConfigurationInput) Validate added in v1.44.140 

func (s *GetLoggingConfigurationInput) Validate() error

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

type GetLoggingConfigurationOutput added in v1.44.140 

type GetLoggingConfigurationOutput struct {

	// Logging-configuration ARN, from the request (if identifier was an ARN).
	Arn *string `locationName:"arn" min:"1" type:"string"`

	// Time when the logging configuration was created. This is an ISO 8601 timestamp;
	// note that this is returned as a string.
	CreateTime *time.Time `locationName:"createTime" type:"timestamp" timestampFormat:"iso8601"`

	// A complex type that contains a destination configuration for where chat content
	// will be logged. There is only one type of destination (cloudWatchLogs, firehose,
	// or s3) in a destinationConfiguration.
	DestinationConfiguration *DestinationConfiguration `locationName:"destinationConfiguration" type:"structure"`

	// Logging-configuration ID, generated by the system. This is a relative identifier,
	// the part of the ARN that uniquely identifies the logging configuration.
	Id *string `locationName:"id" min:"12" type:"string"`

	// Logging-configuration name. This value does not need to be unique.
	Name *string `locationName:"name" type:"string"`

	// The state of the logging configuration. When the state is ACTIVE, the configuration
	// is ready to log chat content.
	State *string `locationName:"state" type:"string" enum:"LoggingConfigurationState"`

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

	// Time of the logging configuration’s last update. This is an ISO 8601 timestamp;
	// note that this is returned as a string.
	UpdateTime *time.Time `locationName:"updateTime" type:"timestamp" timestampFormat:"iso8601"`
	// contains filtered or unexported fields
}

func (GetLoggingConfigurationOutput) GoString added in v1.44.140 

func (s GetLoggingConfigurationOutput) 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 (*GetLoggingConfigurationOutput) SetArn added in v1.44.140 

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

SetArn sets the Arn field's value.

func (*GetLoggingConfigurationOutput) SetCreateTime added in v1.44.140 

func (s *GetLoggingConfigurationOutput) SetCreateTime(v time.Time) *GetLoggingConfigurationOutput

SetCreateTime sets the CreateTime field's value.

func (*GetLoggingConfigurationOutput) SetDestinationConfiguration added in v1.44.140 

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

SetDestinationConfiguration sets the DestinationConfiguration field's value.

func (*GetLoggingConfigurationOutput) SetId added in v1.44.140 

func (s *GetLoggingConfigurationOutput) SetId(v string) *GetLoggingConfigurationOutput

SetId sets the Id field's value.

func (*GetLoggingConfigurationOutput) SetName added in v1.44.140 

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

SetName sets the Name field's value.

func (*GetLoggingConfigurationOutput) SetState added in v1.44.140 

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

SetState sets the State field's value.

func (*GetLoggingConfigurationOutput) SetTags added in v1.44.140 

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

SetTags sets the Tags field's value.

func (*GetLoggingConfigurationOutput) SetUpdateTime added in v1.44.140 

func (s *GetLoggingConfigurationOutput) SetUpdateTime(v time.Time) *GetLoggingConfigurationOutput

SetUpdateTime sets the UpdateTime field's value.

func (GetLoggingConfigurationOutput) String added in v1.44.140 

func (s GetLoggingConfigurationOutput) 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 GetRoomInput 

type GetRoomInput struct {

	// Identifier of the room for which the configuration is to be retrieved. Currently
	// this must be an ARN.
	//
	// Identifier is a required field
	Identifier *string `locationName:"identifier" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetRoomInput) GoString 

func (s GetRoomInput) 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 (*GetRoomInput) SetIdentifier 

func (s *GetRoomInput) SetIdentifier(v string) *GetRoomInput

SetIdentifier sets the Identifier field's value.

func (GetRoomInput) String 

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

func (s *GetRoomInput) Validate() error

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

type GetRoomOutput 

type GetRoomOutput struct {

	// Room ARN, from the request (if identifier was an ARN).
	Arn *string `locationName:"arn" min:"1" type:"string"`

	// Time when the room was created. This is an ISO 8601 timestamp; note that
	// this is returned as a string.
	CreateTime *time.Time `locationName:"createTime" type:"timestamp" timestampFormat:"iso8601"`

	// Room ID, generated by the system. This is a relative identifier, the part
	// of the ARN that uniquely identifies the room.
	Id *string `locationName:"id" min:"12" type:"string"`

	// Array of logging configurations attached to the room.
	LoggingConfigurationIdentifiers []*string `locationName:"loggingConfigurationIdentifiers" type:"list"`

	// Maximum number of characters in a single message. Messages are expected to
	// be UTF-8 encoded and this limit applies specifically to rune/code-point count,
	// not number of bytes. Default: 500.
	MaximumMessageLength *int64 `locationName:"maximumMessageLength" min:"1" type:"integer"`

	// Maximum number of messages per second that can be sent to the room (by all
	// clients). Default: 10.
	MaximumMessageRatePerSecond *int64 `locationName:"maximumMessageRatePerSecond" min:"1" type:"integer"`

	// Configuration information for optional review of messages.
	MessageReviewHandler *MessageReviewHandler `locationName:"messageReviewHandler" type:"structure"`

	// Room name. The value does not need to be unique.
	Name *string `locationName:"name" type:"string"`

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

	// Time of the room’s last update. This is an ISO 8601 timestamp; note that
	// this is returned as a string.
	UpdateTime *time.Time `locationName:"updateTime" type:"timestamp" timestampFormat:"iso8601"`
	// contains filtered or unexported fields
}

func (GetRoomOutput) GoString 

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

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

SetArn sets the Arn field's value.

func (*GetRoomOutput) SetCreateTime 

func (s *GetRoomOutput) SetCreateTime(v time.Time) *GetRoomOutput

SetCreateTime sets the CreateTime field's value.

func (*GetRoomOutput) SetId 

func (s *GetRoomOutput) SetId(v string) *GetRoomOutput

SetId sets the Id field's value.

func (*GetRoomOutput) SetLoggingConfigurationIdentifiers added in v1.44.140 

func (s *GetRoomOutput) SetLoggingConfigurationIdentifiers(v []*string) *GetRoomOutput

SetLoggingConfigurationIdentifiers sets the LoggingConfigurationIdentifiers field's value.

func (*GetRoomOutput) SetMaximumMessageLength 

func (s *GetRoomOutput) SetMaximumMessageLength(v int64) *GetRoomOutput

SetMaximumMessageLength sets the MaximumMessageLength field's value.

func (*GetRoomOutput) SetMaximumMessageRatePerSecond 

func (s *GetRoomOutput) SetMaximumMessageRatePerSecond(v int64) *GetRoomOutput

SetMaximumMessageRatePerSecond sets the MaximumMessageRatePerSecond field's value.

func (*GetRoomOutput) SetMessageReviewHandler 

func (s *GetRoomOutput) SetMessageReviewHandler(v *MessageReviewHandler) *GetRoomOutput

SetMessageReviewHandler sets the MessageReviewHandler field's value.

func (*GetRoomOutput) SetName 

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

SetName sets the Name field's value.

func (*GetRoomOutput) SetTags 

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

SetTags sets the Tags field's value.

func (*GetRoomOutput) SetUpdateTime 

func (s *GetRoomOutput) SetUpdateTime(v time.Time) *GetRoomOutput

SetUpdateTime sets the UpdateTime field's value.

func (GetRoomOutput) String 

func (s GetRoomOutput) String() string

String returns the string representation.

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

type InternalServerException 

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

	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 Ivschat 

type Ivschat struct {
	*client.Client
}

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

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

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

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

func (*Ivschat) CreateChatToken 

func (c *Ivschat) CreateChatToken(input *CreateChatTokenInput) (*CreateChatTokenOutput, error)

CreateChatToken API operation for Amazon Interactive Video Service Chat.

Creates an encrypted token that is used by a chat participant to establish an individual WebSocket chat connection to a room. When the token is used to connect to chat, the connection is valid for the session duration specified in the request. The token becomes invalid at the token-expiration timestamp included in the response.

Use the capabilities field to permit an end user to send messages or moderate a room.

The attributes field securely attaches structured data to the chat session; the data is included within each message sent by the end user and received by other participants in the room. Common use cases for attributes include passing end-user profile data like an icon, display name, colors, badges, and other display features.

Encryption keys are owned by Amazon IVS Chat 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 Chat's API operation CreateChatToken for usage and error information.

Returned Error Types:

  • AccessDeniedException

  • ResourceNotFoundException

  • PendingVerification

  • ValidationException

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

func (*Ivschat) CreateChatTokenRequest 

func (c *Ivschat) CreateChatTokenRequest(input *CreateChatTokenInput) (req *request.Request, output *CreateChatTokenOutput)

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

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

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

func (*Ivschat) CreateChatTokenWithContext 

func (c *Ivschat) CreateChatTokenWithContext(ctx aws.Context, input *CreateChatTokenInput, opts ...request.Option) (*CreateChatTokenOutput, error)

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

See CreateChatToken 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 (*Ivschat) CreateLoggingConfiguration added in v1.44.140 

func (c *Ivschat) CreateLoggingConfiguration(input *CreateLoggingConfigurationInput) (*CreateLoggingConfigurationOutput, error)

CreateLoggingConfiguration API operation for Amazon Interactive Video Service Chat.

Creates a logging configuration that allows clients to store and record sent messages.

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

Returned Error Types:

  • ConflictException

  • AccessDeniedException

  • ResourceNotFoundException

  • ServiceQuotaExceededException

  • PendingVerification

  • ValidationException

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

func (*Ivschat) CreateLoggingConfigurationRequest added in v1.44.140 

func (c *Ivschat) CreateLoggingConfigurationRequest(input *CreateLoggingConfigurationInput) (req *request.Request, output *CreateLoggingConfigurationOutput)

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

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

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

func (*Ivschat) CreateLoggingConfigurationWithContext added in v1.44.140 

func (c *Ivschat) CreateLoggingConfigurationWithContext(ctx aws.Context, input *CreateLoggingConfigurationInput, opts ...request.Option) (*CreateLoggingConfigurationOutput, error)

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

See CreateLoggingConfiguration 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 (*Ivschat) CreateRoom 

func (c *Ivschat) CreateRoom(input *CreateRoomInput) (*CreateRoomOutput, error)

CreateRoom API operation for Amazon Interactive Video Service Chat.

Creates a room that allows clients to connect and pass messages.

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

Returned Error Types:

  • ConflictException

  • AccessDeniedException

  • ResourceNotFoundException

  • ServiceQuotaExceededException

  • PendingVerification

  • ValidationException

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

func (*Ivschat) CreateRoomRequest 

func (c *Ivschat) CreateRoomRequest(input *CreateRoomInput) (req *request.Request, output *CreateRoomOutput)

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

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

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

func (*Ivschat) CreateRoomWithContext 

func (c *Ivschat) CreateRoomWithContext(ctx aws.Context, input *CreateRoomInput, opts ...request.Option) (*CreateRoomOutput, error)

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

See CreateRoom 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 (*Ivschat) DeleteLoggingConfiguration added in v1.44.140 

func (c *Ivschat) DeleteLoggingConfiguration(input *DeleteLoggingConfigurationInput) (*DeleteLoggingConfigurationOutput, error)

DeleteLoggingConfiguration API operation for Amazon Interactive Video Service Chat.

Deletes the specified logging 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 Chat's API operation DeleteLoggingConfiguration for usage and error information.

Returned Error Types:

  • ConflictException

  • AccessDeniedException

  • ResourceNotFoundException

  • PendingVerification

  • ValidationException

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

func (*Ivschat) DeleteLoggingConfigurationRequest added in v1.44.140 

func (c *Ivschat) DeleteLoggingConfigurationRequest(input *DeleteLoggingConfigurationInput) (req *request.Request, output *DeleteLoggingConfigurationOutput)

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

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

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

func (*Ivschat) DeleteLoggingConfigurationWithContext added in v1.44.140 

func (c *Ivschat) DeleteLoggingConfigurationWithContext(ctx aws.Context, input *DeleteLoggingConfigurationInput, opts ...request.Option) (*DeleteLoggingConfigurationOutput, error)

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

See DeleteLoggingConfiguration 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 (*Ivschat) DeleteMessage 

func (c *Ivschat) DeleteMessage(input *DeleteMessageInput) (*DeleteMessageOutput, error)

DeleteMessage API operation for Amazon Interactive Video Service Chat.

Sends an event to a specific room which directs clients to delete a specific message; that is, unrender it from view and delete it from the client’s chat history. This event’s EventName is aws:DELETE_MESSAGE. This replicates the DeleteMessage (https://docs.aws.amazon.com/ivs/latest/chatmsgapireference/actions-deletemessage-publish.html) WebSocket operation in the Amazon IVS Chat Messaging API.

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

Returned Error Types:

  • ThrottlingException

  • AccessDeniedException

  • ResourceNotFoundException

  • PendingVerification

  • ValidationException

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

func (*Ivschat) DeleteMessageRequest 

func (c *Ivschat) DeleteMessageRequest(input *DeleteMessageInput) (req *request.Request, output *DeleteMessageOutput)

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

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

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

func (*Ivschat) DeleteMessageWithContext 

func (c *Ivschat) DeleteMessageWithContext(ctx aws.Context, input *DeleteMessageInput, opts ...request.Option) (*DeleteMessageOutput, error)

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

See DeleteMessage 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 (*Ivschat) DeleteRoom 

func (c *Ivschat) DeleteRoom(input *DeleteRoomInput) (*DeleteRoomOutput, error)

DeleteRoom API operation for Amazon Interactive Video Service Chat.

Deletes the specified room.

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

Returned Error Types:

  • AccessDeniedException

  • ResourceNotFoundException

  • PendingVerification

  • ValidationException

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

func (*Ivschat) DeleteRoomRequest 

func (c *Ivschat) DeleteRoomRequest(input *DeleteRoomInput) (req *request.Request, output *DeleteRoomOutput)

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

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

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

func (*Ivschat) DeleteRoomWithContext 

func (c *Ivschat) DeleteRoomWithContext(ctx aws.Context, input *DeleteRoomInput, opts ...request.Option) (*DeleteRoomOutput, error)

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

See DeleteRoom 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 (*Ivschat) DisconnectUser 

func (c *Ivschat) DisconnectUser(input *DisconnectUserInput) (*DisconnectUserOutput, error)

DisconnectUser API operation for Amazon Interactive Video Service Chat.

Disconnects all connections using a specified user ID from a room. This replicates the DisconnectUser (https://docs.aws.amazon.com/ivs/latest/chatmsgapireference/actions-disconnectuser-publish.html) WebSocket operation in the Amazon IVS Chat Messaging API.

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

Returned Error Types:

  • ThrottlingException

  • AccessDeniedException

  • ResourceNotFoundException

  • PendingVerification

  • ValidationException

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

func (*Ivschat) DisconnectUserRequest 

func (c *Ivschat) DisconnectUserRequest(input *DisconnectUserInput) (req *request.Request, output *DisconnectUserOutput)

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

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

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

func (*Ivschat) DisconnectUserWithContext 

func (c *Ivschat) DisconnectUserWithContext(ctx aws.Context, input *DisconnectUserInput, opts ...request.Option) (*DisconnectUserOutput, error)

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

See DisconnectUser 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 (*Ivschat) GetLoggingConfiguration added in v1.44.140 

func (c *Ivschat) GetLoggingConfiguration(input *GetLoggingConfigurationInput) (*GetLoggingConfigurationOutput, error)

GetLoggingConfiguration API operation for Amazon Interactive Video Service Chat.

Gets the specified logging 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 Chat's API operation GetLoggingConfiguration for usage and error information.

Returned Error Types:

  • AccessDeniedException

  • ResourceNotFoundException

  • ValidationException

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

func (*Ivschat) GetLoggingConfigurationRequest added in v1.44.140 

func (c *Ivschat) GetLoggingConfigurationRequest(input *GetLoggingConfigurationInput) (req *request.Request, output *GetLoggingConfigurationOutput)

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

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

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

func (*Ivschat) GetLoggingConfigurationWithContext added in v1.44.140 

func (c *Ivschat) GetLoggingConfigurationWithContext(ctx aws.Context, input *GetLoggingConfigurationInput, opts ...request.Option) (*GetLoggingConfigurationOutput, error)

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

See GetLoggingConfiguration 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 (*Ivschat) GetRoom 

func (c *Ivschat) GetRoom(input *GetRoomInput) (*GetRoomOutput, error)

GetRoom API operation for Amazon Interactive Video Service Chat.

Gets the specified room.

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

Returned Error Types:

  • AccessDeniedException

  • ResourceNotFoundException

  • ValidationException

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

func (*Ivschat) GetRoomRequest 

func (c *Ivschat) GetRoomRequest(input *GetRoomInput) (req *request.Request, output *GetRoomOutput)

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

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

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

func (*Ivschat) GetRoomWithContext 

func (c *Ivschat) GetRoomWithContext(ctx aws.Context, input *GetRoomInput, opts ...request.Option) (*GetRoomOutput, error)

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

See GetRoom 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 (*Ivschat) ListLoggingConfigurations added in v1.44.140 

func (c *Ivschat) ListLoggingConfigurations(input *ListLoggingConfigurationsInput) (*ListLoggingConfigurationsOutput, error)

ListLoggingConfigurations API operation for Amazon Interactive Video Service Chat.

Gets summary information about all your logging configurations 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 Chat's API operation ListLoggingConfigurations for usage and error information.

Returned Error Types:

  • AccessDeniedException

  • ValidationException

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

func (*Ivschat) ListLoggingConfigurationsPages added in v1.44.140 

func (c *Ivschat) ListLoggingConfigurationsPages(input *ListLoggingConfigurationsInput, fn func(*ListLoggingConfigurationsOutput, bool) bool) error

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

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

func (*Ivschat) ListLoggingConfigurationsPagesWithContext added in v1.44.140 

func (c *Ivschat) ListLoggingConfigurationsPagesWithContext(ctx aws.Context, input *ListLoggingConfigurationsInput, fn func(*ListLoggingConfigurationsOutput, bool) bool, opts ...request.Option) error

ListLoggingConfigurationsPagesWithContext same as ListLoggingConfigurationsPages 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 (*Ivschat) ListLoggingConfigurationsRequest added in v1.44.140 

func (c *Ivschat) ListLoggingConfigurationsRequest(input *ListLoggingConfigurationsInput) (req *request.Request, output *ListLoggingConfigurationsOutput)

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

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

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

func (*Ivschat) ListLoggingConfigurationsWithContext added in v1.44.140 

func (c *Ivschat) ListLoggingConfigurationsWithContext(ctx aws.Context, input *ListLoggingConfigurationsInput, opts ...request.Option) (*ListLoggingConfigurationsOutput, error)

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

See ListLoggingConfigurations 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 (*Ivschat) ListRooms 

func (c *Ivschat) ListRooms(input *ListRoomsInput) (*ListRoomsOutput, error)

ListRooms API operation for Amazon Interactive Video Service Chat.

Gets summary information about all your rooms in the AWS region where the API request is processed. Results are sorted in descending order of updateTime.

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

Returned Error Types:

  • AccessDeniedException

  • ResourceNotFoundException

  • ValidationException

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

func (*Ivschat) ListRoomsPages 

func (c *Ivschat) ListRoomsPages(input *ListRoomsInput, fn func(*ListRoomsOutput, bool) bool) error

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

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

func (*Ivschat) ListRoomsPagesWithContext 

func (c *Ivschat) ListRoomsPagesWithContext(ctx aws.Context, input *ListRoomsInput, fn func(*ListRoomsOutput, bool) bool, opts ...request.Option) error

ListRoomsPagesWithContext same as ListRoomsPages 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 (*Ivschat) ListRoomsRequest 

func (c *Ivschat) ListRoomsRequest(input *ListRoomsInput) (req *request.Request, output *ListRoomsOutput)

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

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

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

func (*Ivschat) ListRoomsWithContext 

func (c *Ivschat) ListRoomsWithContext(ctx aws.Context, input *ListRoomsInput, opts ...request.Option) (*ListRoomsOutput, error)

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

See ListRooms 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 (*Ivschat) ListTagsForResource 

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

ListTagsForResource API operation for Amazon Interactive Video Service Chat.

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

Returned Error Types:

  • ResourceNotFoundException

  • InternalServerException

  • ValidationException

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

func (*Ivschat) ListTagsForResourceRequest 

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

func (*Ivschat) ListTagsForResourceWithContext 

func (c *Ivschat) 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 (*Ivschat) SendEvent 

func (c *Ivschat) SendEvent(input *SendEventInput) (*SendEventOutput, error)

SendEvent API operation for Amazon Interactive Video Service Chat.

Sends an event to a room. Use this within your application’s business logic to send events to clients of a room; e.g., to notify clients to change the way the chat UI is rendered.

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

Returned Error Types:

  • ThrottlingException

  • AccessDeniedException

  • ResourceNotFoundException

  • PendingVerification

  • ValidationException

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

func (*Ivschat) SendEventRequest 

func (c *Ivschat) SendEventRequest(input *SendEventInput) (req *request.Request, output *SendEventOutput)

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

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

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

func (*Ivschat) SendEventWithContext 

func (c *Ivschat) SendEventWithContext(ctx aws.Context, input *SendEventInput, opts ...request.Option) (*SendEventOutput, error)

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

See SendEvent 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 (*Ivschat) TagResource 

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

TagResource API operation for Amazon Interactive Video Service Chat.

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

Returned Error Types:

  • ResourceNotFoundException

  • InternalServerException

  • ValidationException

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

func (*Ivschat) TagResourceRequest 

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

func (*Ivschat) TagResourceWithContext 

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

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

UntagResource API operation for Amazon Interactive Video Service Chat.

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

Returned Error Types:

  • ResourceNotFoundException

  • InternalServerException

  • ValidationException

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

func (*Ivschat) UntagResourceRequest 

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

func (*Ivschat) UntagResourceWithContext 

func (c *Ivschat) 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 (*Ivschat) UpdateLoggingConfiguration added in v1.44.140 

func (c *Ivschat) UpdateLoggingConfiguration(input *UpdateLoggingConfigurationInput) (*UpdateLoggingConfigurationOutput, error)

UpdateLoggingConfiguration API operation for Amazon Interactive Video Service Chat.

Updates a specified logging 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 Chat's API operation UpdateLoggingConfiguration for usage and error information.

Returned Error Types:

  • ConflictException

  • AccessDeniedException

  • ResourceNotFoundException

  • PendingVerification

  • ValidationException

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

func (*Ivschat) UpdateLoggingConfigurationRequest added in v1.44.140 

func (c *Ivschat) UpdateLoggingConfigurationRequest(input *UpdateLoggingConfigurationInput) (req *request.Request, output *UpdateLoggingConfigurationOutput)

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

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

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

func (*Ivschat) UpdateLoggingConfigurationWithContext added in v1.44.140 

func (c *Ivschat) UpdateLoggingConfigurationWithContext(ctx aws.Context, input *UpdateLoggingConfigurationInput, opts ...request.Option) (*UpdateLoggingConfigurationOutput, error)

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

See UpdateLoggingConfiguration 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 (*Ivschat) UpdateRoom 

func (c *Ivschat) UpdateRoom(input *UpdateRoomInput) (*UpdateRoomOutput, error)

UpdateRoom API operation for Amazon Interactive Video Service Chat.

Updates a room’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 Chat's API operation UpdateRoom for usage and error information.

Returned Error Types:

  • AccessDeniedException

  • ResourceNotFoundException

  • PendingVerification

  • ValidationException

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

func (*Ivschat) UpdateRoomRequest 

func (c *Ivschat) UpdateRoomRequest(input *UpdateRoomInput) (req *request.Request, output *UpdateRoomOutput)

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

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

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

func (*Ivschat) UpdateRoomWithContext 

func (c *Ivschat) UpdateRoomWithContext(ctx aws.Context, input *UpdateRoomInput, opts ...request.Option) (*UpdateRoomOutput, error)

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

See UpdateRoom 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 ListLoggingConfigurationsInput added in v1.44.140 

type ListLoggingConfigurationsInput struct {

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

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

func (ListLoggingConfigurationsInput) GoString added in v1.44.140 

func (s ListLoggingConfigurationsInput) 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 (*ListLoggingConfigurationsInput) SetMaxResults added in v1.44.140 

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

SetMaxResults sets the MaxResults field's value.

func (*ListLoggingConfigurationsInput) SetNextToken added in v1.44.140 

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

SetNextToken sets the NextToken field's value.

func (ListLoggingConfigurationsInput) String added in v1.44.140 

func (s ListLoggingConfigurationsInput) 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 (*ListLoggingConfigurationsInput) Validate added in v1.44.140 

func (s *ListLoggingConfigurationsInput) Validate() error

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

type ListLoggingConfigurationsOutput added in v1.44.140 

type ListLoggingConfigurationsOutput struct {

	// List of the matching logging configurations (summary information only). There
	// is only one type of destination (cloudWatchLogs, firehose, or s3) in a destinationConfiguration.
	//
	// LoggingConfigurations is a required field
	LoggingConfigurations []*LoggingConfigurationSummary `locationName:"loggingConfigurations" type:"list" required:"true"`

	// If there are more logging configurations than maxResults, use nextToken in
	// the request to get the next set.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListLoggingConfigurationsOutput) GoString added in v1.44.140 

func (s ListLoggingConfigurationsOutput) 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 (*ListLoggingConfigurationsOutput) SetLoggingConfigurations added in v1.44.140 

func (s *ListLoggingConfigurationsOutput) SetLoggingConfigurations(v []*LoggingConfigurationSummary) *ListLoggingConfigurationsOutput

SetLoggingConfigurations sets the LoggingConfigurations field's value.

func (*ListLoggingConfigurationsOutput) SetNextToken added in v1.44.140 

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

SetNextToken sets the NextToken field's value.

func (ListLoggingConfigurationsOutput) String added in v1.44.140 

func (s ListLoggingConfigurationsOutput) 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 ListRoomsInput 

type ListRoomsInput struct {

	// Logging-configuration identifier.
	LoggingConfigurationIdentifier *string `locationName:"loggingConfigurationIdentifier" min:"1" type:"string"`

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

	// Filters the list to match the specified message review handler URI.
	MessageReviewHandlerUri *string `locationName:"messageReviewHandlerUri" type:"string"`

	// Filters the list to match the specified room name.
	Name *string `locationName:"name" type:"string"`

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

func (ListRoomsInput) GoString 

func (s ListRoomsInput) 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 (*ListRoomsInput) SetLoggingConfigurationIdentifier added in v1.44.140 

func (s *ListRoomsInput) SetLoggingConfigurationIdentifier(v string) *ListRoomsInput

SetLoggingConfigurationIdentifier sets the LoggingConfigurationIdentifier field's value.

func (*ListRoomsInput) SetMaxResults 

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

SetMaxResults sets the MaxResults field's value.

func (*ListRoomsInput) SetMessageReviewHandlerUri 

func (s *ListRoomsInput) SetMessageReviewHandlerUri(v string) *ListRoomsInput

SetMessageReviewHandlerUri sets the MessageReviewHandlerUri field's value.

func (*ListRoomsInput) SetName 

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

SetName sets the Name field's value.

func (*ListRoomsInput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (ListRoomsInput) String 

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

func (s *ListRoomsInput) Validate() error

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

type ListRoomsOutput 

type ListRoomsOutput 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 rooms (summary information only).
	//
	// Rooms is a required field
	Rooms []*RoomSummary `locationName:"rooms" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (ListRoomsOutput) GoString 

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

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

SetNextToken sets the NextToken field's value.

func (*ListRoomsOutput) SetRooms 

func (s *ListRoomsOutput) SetRooms(v []*RoomSummary) *ListRoomsOutput

SetRooms sets the Rooms field's value.

func (ListRoomsOutput) String 

func (s ListRoomsOutput) 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 LoggingConfigurationSummary added in v1.44.140 

type LoggingConfigurationSummary struct {

	// Logging-configuration ARN.
	Arn *string `locationName:"arn" min:"1" type:"string"`

	// Time when the logging configuration was created. This is an ISO 8601 timestamp;
	// note that this is returned as a string.
	CreateTime *time.Time `locationName:"createTime" type:"timestamp" timestampFormat:"iso8601"`

	// A complex type that contains a destination configuration for where chat content
	// will be logged.
	DestinationConfiguration *DestinationConfiguration `locationName:"destinationConfiguration" type:"structure"`

	// Logging-configuration ID, generated by the system. This is a relative identifier,
	// the part of the ARN that uniquely identifies the room.
	Id *string `locationName:"id" min:"12" type:"string"`

	// Logging-configuration name. The value does not need to be unique.
	Name *string `locationName:"name" type:"string"`

	// The state of the logging configuration. When this is ACTIVE, the configuration
	// is ready for logging chat content.
	State *string `locationName:"state" type:"string" enum:"LoggingConfigurationState"`

	// Tags to attach 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 Chat has no constraints on tags beyond what
	// is documented there.
	Tags map[string]*string `locationName:"tags" type:"map"`

	// Time of the logging configuration’s last update. This is an ISO 8601 timestamp;
	// note that this is returned as a string.
	UpdateTime *time.Time `locationName:"updateTime" type:"timestamp" timestampFormat:"iso8601"`
	// contains filtered or unexported fields
}

Summary information about a logging configuration.

func (LoggingConfigurationSummary) GoString added in v1.44.140 

func (s LoggingConfigurationSummary) 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 (*LoggingConfigurationSummary) SetArn added in v1.44.140 

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

SetArn sets the Arn field's value.

func (*LoggingConfigurationSummary) SetCreateTime added in v1.44.140 

func (s *LoggingConfigurationSummary) SetCreateTime(v time.Time) *LoggingConfigurationSummary

SetCreateTime sets the CreateTime field's value.

func (*LoggingConfigurationSummary) SetDestinationConfiguration added in v1.44.140 

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

SetDestinationConfiguration sets the DestinationConfiguration field's value.

func (*LoggingConfigurationSummary) SetId added in v1.44.140 

func (s *LoggingConfigurationSummary) SetId(v string) *LoggingConfigurationSummary

SetId sets the Id field's value.

func (*LoggingConfigurationSummary) SetName added in v1.44.140 

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

SetName sets the Name field's value.

func (*LoggingConfigurationSummary) SetState added in v1.44.140 

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

SetState sets the State field's value.

func (*LoggingConfigurationSummary) SetTags added in v1.44.140 

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

SetTags sets the Tags field's value.

func (*LoggingConfigurationSummary) SetUpdateTime added in v1.44.140 

func (s *LoggingConfigurationSummary) SetUpdateTime(v time.Time) *LoggingConfigurationSummary

SetUpdateTime sets the UpdateTime field's value.

func (LoggingConfigurationSummary) String added in v1.44.140 

func (s LoggingConfigurationSummary) 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 MessageReviewHandler 

type MessageReviewHandler struct {

	// Specifies the fallback behavior (whether the message is allowed or denied)
	// if the handler does not return a valid response, encounters an error, or
	// times out. (For the timeout period, see Service Quotas (https://docs.aws.amazon.com/ivs/latest/userguide/service-quotas.html).)
	// If allowed, the message is delivered with returned content to all users connected
	// to the room. If denied, the message is not delivered to any user. Default:
	// ALLOW.
	FallbackResult *string `locationName:"fallbackResult" type:"string" enum:"FallbackResult"`

	// Identifier of the message review handler. Currently this must be an ARN of
	// a lambda function.
	Uri *string `locationName:"uri" type:"string"`
	// contains filtered or unexported fields
}

Configuration information for optional message review.

func (MessageReviewHandler) GoString 

func (s MessageReviewHandler) 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 (*MessageReviewHandler) SetFallbackResult 

func (s *MessageReviewHandler) SetFallbackResult(v string) *MessageReviewHandler

SetFallbackResult sets the FallbackResult field's value.

func (*MessageReviewHandler) SetUri 

func (s *MessageReviewHandler) SetUri(v string) *MessageReviewHandler

SetUri sets the Uri field's value.

func (MessageReviewHandler) String 

func (s MessageReviewHandler) String() string

String returns the string representation.

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

type PendingVerification 

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

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

	Message_ *string `locationName:"message" type:"string"`

	// ResourceId is a required field
	ResourceId *string `locationName:"resourceId" type:"string" required:"true"`

	// ResourceType is a required field
	ResourceType *string `locationName:"resourceType" type:"string" required:"true" enum:"ResourceType"`
	// 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 RoomSummary 

type RoomSummary struct {

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

	// Time when the room was created. This is an ISO 8601 timestamp; note that
	// this is returned as a string.
	CreateTime *time.Time `locationName:"createTime" type:"timestamp" timestampFormat:"iso8601"`

	// Room ID, generated by the system. This is a relative identifier, the part
	// of the ARN that uniquely identifies the room.
	Id *string `locationName:"id" min:"12" type:"string"`

	// List of logging-configuration identifiers attached to the room.
	LoggingConfigurationIdentifiers []*string `locationName:"loggingConfigurationIdentifiers" type:"list"`

	// Configuration information for optional review of messages.
	MessageReviewHandler *MessageReviewHandler `locationName:"messageReviewHandler" type:"structure"`

	// Room name. The value does not need to be unique.
	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 Chat has no constraints beyond what is documented
	// there.
	Tags map[string]*string `locationName:"tags" type:"map"`

	// Time of the room’s last update. This is an ISO 8601 timestamp; note that
	// this is returned as a string.
	UpdateTime *time.Time `locationName:"updateTime" type:"timestamp" timestampFormat:"iso8601"`
	// contains filtered or unexported fields
}

Summary information about a room.

func (RoomSummary) GoString 

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

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

SetArn sets the Arn field's value.

func (*RoomSummary) SetCreateTime 

func (s *RoomSummary) SetCreateTime(v time.Time) *RoomSummary

SetCreateTime sets the CreateTime field's value.

func (*RoomSummary) SetId 

func (s *RoomSummary) SetId(v string) *RoomSummary

SetId sets the Id field's value.

func (*RoomSummary) SetLoggingConfigurationIdentifiers added in v1.44.140 

func (s *RoomSummary) SetLoggingConfigurationIdentifiers(v []*string) *RoomSummary

SetLoggingConfigurationIdentifiers sets the LoggingConfigurationIdentifiers field's value.

func (*RoomSummary) SetMessageReviewHandler 

func (s *RoomSummary) SetMessageReviewHandler(v *MessageReviewHandler) *RoomSummary

SetMessageReviewHandler sets the MessageReviewHandler field's value.

func (*RoomSummary) SetName 

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

SetName sets the Name field's value.

func (*RoomSummary) SetTags 

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

SetTags sets the Tags field's value.

func (*RoomSummary) SetUpdateTime 

func (s *RoomSummary) SetUpdateTime(v time.Time) *RoomSummary

SetUpdateTime sets the UpdateTime field's value.

func (RoomSummary) String 

func (s RoomSummary) String() string

String returns the string representation.

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

type S3DestinationConfiguration added in v1.44.140 

type S3DestinationConfiguration struct {

	// Name of the Amazon S3 bucket where chat activity will be logged.
	//
	// BucketName is a required field
	BucketName *string `locationName:"bucketName" min:"3" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Specifies an S3 location where chat logs will be stored.

func (S3DestinationConfiguration) GoString added in v1.44.140 

func (s S3DestinationConfiguration) GoString() string

GoString returns the string representation.

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

func (*S3DestinationConfiguration) SetBucketName added in v1.44.140 

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

SetBucketName sets the BucketName field's value.

func (S3DestinationConfiguration) String added in v1.44.140 

func (s S3DestinationConfiguration) String() string

String returns the string representation.

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

func (*S3DestinationConfiguration) Validate added in v1.44.140 

func (s *S3DestinationConfiguration) Validate() error

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

type SendEventInput 

type SendEventInput struct {

	// Application-defined metadata to attach to the event sent to clients. The
	// maximum length of the metadata is 1 KB total.
	Attributes map[string]*string `locationName:"attributes" type:"map"`

	// Application-defined name of the event to send to clients.
	//
	// EventName is a required field
	EventName *string `locationName:"eventName" min:"1" type:"string" required:"true"`

	// Identifier of the room to which the event will be sent. Currently this must
	// be an ARN.
	//
	// RoomIdentifier is a required field
	RoomIdentifier *string `locationName:"roomIdentifier" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (SendEventInput) GoString 

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

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

SetAttributes sets the Attributes field's value.

func (*SendEventInput) SetEventName 

func (s *SendEventInput) SetEventName(v string) *SendEventInput

SetEventName sets the EventName field's value.

func (*SendEventInput) SetRoomIdentifier 

func (s *SendEventInput) SetRoomIdentifier(v string) *SendEventInput

SetRoomIdentifier sets the RoomIdentifier field's value.

func (SendEventInput) String 

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

func (s *SendEventInput) Validate() error

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

type SendEventOutput 

type SendEventOutput struct {

	// An identifier generated by Amazon IVS Chat. This identifier must be used
	// in subsequent operations for this message, such as DeleteMessage.
	Id *string `locationName:"id" min:"12" type:"string"`
	// contains filtered or unexported fields
}

func (SendEventOutput) GoString 

func (s SendEventOutput) 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 (*SendEventOutput) SetId 

func (s *SendEventOutput) SetId(v string) *SendEventOutput

SetId sets the Id field's value.

func (SendEventOutput) String 

func (s SendEventOutput) 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:"-"`

	// Limit is a required field
	Limit *int64 `locationName:"limit" type:"integer" required:"true"`

	Message_ *string `locationName:"message" type:"string"`

	// ResourceId is a required field
	ResourceId *string `locationName:"resourceId" type:"string" required:"true"`

	// ResourceType is a required field
	ResourceType *string `locationName:"resourceType" type:"string" required:"true" enum:"ResourceType"`
	// 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 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 Chat 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 ThrottlingException 

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

	// Limit is a required field
	Limit *int64 `locationName:"limit" type:"integer" required:"true"`

	Message_ *string `locationName:"message" type:"string"`

	// ResourceId is a required field
	ResourceId *string `locationName:"resourceId" type:"string" required:"true"`

	// ResourceType is a required field
	ResourceType *string `locationName:"resourceType" type:"string" required:"true" enum:"ResourceType"`
	// contains filtered or unexported fields
}

func (*ThrottlingException) Code 

func (s *ThrottlingException) Code() string

Code returns the exception type name.

func (*ThrottlingException) Error 

func (s *ThrottlingException) Error() string

func (ThrottlingException) GoString 

func (s ThrottlingException) GoString() string

GoString returns the string representation.

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

func (*ThrottlingException) Message 

func (s *ThrottlingException) Message() string

Message returns the exception's message.

func (*ThrottlingException) OrigErr 

func (s *ThrottlingException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ThrottlingException) RequestID 

func (s *ThrottlingException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ThrottlingException) StatusCode 

func (s *ThrottlingException) StatusCode() int

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

func (ThrottlingException) String 

func (s ThrottlingException) String() string

String returns the string representation.

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

type 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 Chat 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 UpdateLoggingConfigurationInput added in v1.44.140 

type UpdateLoggingConfigurationInput struct {

	// A complex type that contains a destination configuration for where chat content
	// will be logged. There can be only one type of destination (cloudWatchLogs,
	// firehose, or s3) in a destinationConfiguration.
	DestinationConfiguration *DestinationConfiguration `locationName:"destinationConfiguration" type:"structure"`

	// Identifier of the logging configuration to be updated.
	//
	// Identifier is a required field
	Identifier *string `locationName:"identifier" min:"1" type:"string" required:"true"`

	// Logging-configuration name. The value does not need to be unique.
	Name *string `locationName:"name" type:"string"`
	// contains filtered or unexported fields
}

func (UpdateLoggingConfigurationInput) GoString added in v1.44.140 

func (s UpdateLoggingConfigurationInput) 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 (*UpdateLoggingConfigurationInput) SetDestinationConfiguration added in v1.44.140 

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

SetDestinationConfiguration sets the DestinationConfiguration field's value.

func (*UpdateLoggingConfigurationInput) SetIdentifier added in v1.44.140 

func (s *UpdateLoggingConfigurationInput) SetIdentifier(v string) *UpdateLoggingConfigurationInput

SetIdentifier sets the Identifier field's value.

func (*UpdateLoggingConfigurationInput) SetName added in v1.44.140 

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

SetName sets the Name field's value.

func (UpdateLoggingConfigurationInput) String added in v1.44.140 

func (s UpdateLoggingConfigurationInput) 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 (*UpdateLoggingConfigurationInput) Validate added in v1.44.140 

func (s *UpdateLoggingConfigurationInput) Validate() error

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

type UpdateLoggingConfigurationOutput added in v1.44.140 

type UpdateLoggingConfigurationOutput struct {

	// Logging-configuration ARN, from the request (if identifier was an ARN).
	Arn *string `locationName:"arn" min:"1" type:"string"`

	// Time when the logging configuration was created. This is an ISO 8601 timestamp;
	// note that this is returned as a string.
	CreateTime *time.Time `locationName:"createTime" type:"timestamp" timestampFormat:"iso8601"`

	// A complex type that contains a destination configuration for where chat content
	// will be logged, from the request. There is only one type of destination (cloudWatchLogs,
	// firehose, or s3) in a destinationConfiguration.
	DestinationConfiguration *DestinationConfiguration `locationName:"destinationConfiguration" type:"structure"`

	// Logging-configuration ID, generated by the system. This is a relative identifier,
	// the part of the ARN that uniquely identifies the room.
	Id *string `locationName:"id" min:"12" type:"string"`

	// Logging-configuration name, from the request (if specified).
	Name *string `locationName:"name" type:"string"`

	// The state of the logging configuration. When the state is ACTIVE, the configuration
	// is ready to log chat content.
	State *string `locationName:"state" type:"string" enum:"UpdateLoggingConfigurationState"`

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

	// Time of the logging configuration’s last update. This is an ISO 8601 timestamp;
	// note that this is returned as a string.
	UpdateTime *time.Time `locationName:"updateTime" type:"timestamp" timestampFormat:"iso8601"`
	// contains filtered or unexported fields
}

func (UpdateLoggingConfigurationOutput) GoString added in v1.44.140 

func (s UpdateLoggingConfigurationOutput) 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 (*UpdateLoggingConfigurationOutput) SetArn added in v1.44.140 

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

SetArn sets the Arn field's value.

func (*UpdateLoggingConfigurationOutput) SetCreateTime added in v1.44.140 

func (s *UpdateLoggingConfigurationOutput) SetCreateTime(v time.Time) *UpdateLoggingConfigurationOutput

SetCreateTime sets the CreateTime field's value.

func (*UpdateLoggingConfigurationOutput) SetDestinationConfiguration added in v1.44.140 

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

SetDestinationConfiguration sets the DestinationConfiguration field's value.

func (*UpdateLoggingConfigurationOutput) SetId added in v1.44.140 

func (s *UpdateLoggingConfigurationOutput) SetId(v string) *UpdateLoggingConfigurationOutput

SetId sets the Id field's value.

func (*UpdateLoggingConfigurationOutput) SetName added in v1.44.140 

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

SetName sets the Name field's value.

func (*UpdateLoggingConfigurationOutput) SetState added in v1.44.140 

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

SetState sets the State field's value.

func (*UpdateLoggingConfigurationOutput) SetTags added in v1.44.140 

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

SetTags sets the Tags field's value.

func (*UpdateLoggingConfigurationOutput) SetUpdateTime added in v1.44.140 

func (s *UpdateLoggingConfigurationOutput) SetUpdateTime(v time.Time) *UpdateLoggingConfigurationOutput

SetUpdateTime sets the UpdateTime field's value.

func (UpdateLoggingConfigurationOutput) String added in v1.44.140 

func (s UpdateLoggingConfigurationOutput) 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 UpdateRoomInput 

type UpdateRoomInput struct {

	// Identifier of the room to be updated. Currently this must be an ARN.
	//
	// Identifier is a required field
	Identifier *string `locationName:"identifier" min:"1" type:"string" required:"true"`

	// Array of logging-configuration identifiers attached to the room.
	LoggingConfigurationIdentifiers []*string `locationName:"loggingConfigurationIdentifiers" type:"list"`

	// The maximum number of characters in a single message. Messages are expected
	// to be UTF-8 encoded and this limit applies specifically to rune/code-point
	// count, not number of bytes. Default: 500.
	MaximumMessageLength *int64 `locationName:"maximumMessageLength" min:"1" type:"integer"`

	// Maximum number of messages per second that can be sent to the room (by all
	// clients). Default: 10.
	MaximumMessageRatePerSecond *int64 `locationName:"maximumMessageRatePerSecond" min:"1" type:"integer"`

	// Configuration information for optional review of messages. Specify an empty
	// uri string to disassociate a message review handler from the specified room.
	MessageReviewHandler *MessageReviewHandler `locationName:"messageReviewHandler" type:"structure"`

	// Room name. The value does not need to be unique.
	Name *string `locationName:"name" type:"string"`
	// contains filtered or unexported fields
}

func (UpdateRoomInput) GoString 

func (s UpdateRoomInput) 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 (*UpdateRoomInput) SetIdentifier 

func (s *UpdateRoomInput) SetIdentifier(v string) *UpdateRoomInput

SetIdentifier sets the Identifier field's value.

func (*UpdateRoomInput) SetLoggingConfigurationIdentifiers added in v1.44.140 

func (s *UpdateRoomInput) SetLoggingConfigurationIdentifiers(v []*string) *UpdateRoomInput

SetLoggingConfigurationIdentifiers sets the LoggingConfigurationIdentifiers field's value.

func (*UpdateRoomInput) SetMaximumMessageLength 

func (s *UpdateRoomInput) SetMaximumMessageLength(v int64) *UpdateRoomInput

SetMaximumMessageLength sets the MaximumMessageLength field's value.

func (*UpdateRoomInput) SetMaximumMessageRatePerSecond 

func (s *UpdateRoomInput) SetMaximumMessageRatePerSecond(v int64) *UpdateRoomInput

SetMaximumMessageRatePerSecond sets the MaximumMessageRatePerSecond field's value.

func (*UpdateRoomInput) SetMessageReviewHandler 

func (s *UpdateRoomInput) SetMessageReviewHandler(v *MessageReviewHandler) *UpdateRoomInput

SetMessageReviewHandler sets the MessageReviewHandler field's value.

func (*UpdateRoomInput) SetName 

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

SetName sets the Name field's value.

func (UpdateRoomInput) String 

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

func (s *UpdateRoomInput) Validate() error

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

type UpdateRoomOutput 

type UpdateRoomOutput struct {

	// Room ARN, from the request (if identifier was an ARN).
	Arn *string `locationName:"arn" min:"1" type:"string"`

	// Time when the room was created. This is an ISO 8601 timestamp; note that
	// this is returned as a string.
	CreateTime *time.Time `locationName:"createTime" type:"timestamp" timestampFormat:"iso8601"`

	// Room ID, generated by the system. This is a relative identifier, the part
	// of the ARN that uniquely identifies the room.
	Id *string `locationName:"id" min:"12" type:"string"`

	// Array of logging configurations attached to the room, from the request (if
	// specified).
	LoggingConfigurationIdentifiers []*string `locationName:"loggingConfigurationIdentifiers" type:"list"`

	// Maximum number of characters in a single message, from the request (if specified).
	MaximumMessageLength *int64 `locationName:"maximumMessageLength" min:"1" type:"integer"`

	// Maximum number of messages per second that can be sent to the room (by all
	// clients), from the request (if specified).
	MaximumMessageRatePerSecond *int64 `locationName:"maximumMessageRatePerSecond" min:"1" type:"integer"`

	// Configuration information for optional review of messages.
	MessageReviewHandler *MessageReviewHandler `locationName:"messageReviewHandler" type:"structure"`

	// Room name, from the request (if specified).
	Name *string `locationName:"name" type:"string"`

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

	// Time of the room’s last update. This is an ISO 8601 timestamp; note that
	// this is returned as a string.
	UpdateTime *time.Time `locationName:"updateTime" type:"timestamp" timestampFormat:"iso8601"`
	// contains filtered or unexported fields
}

func (UpdateRoomOutput) GoString 

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

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

SetArn sets the Arn field's value.

func (*UpdateRoomOutput) SetCreateTime 

func (s *UpdateRoomOutput) SetCreateTime(v time.Time) *UpdateRoomOutput

SetCreateTime sets the CreateTime field's value.

func (*UpdateRoomOutput) SetId 

func (s *UpdateRoomOutput) SetId(v string) *UpdateRoomOutput

SetId sets the Id field's value.

func (*UpdateRoomOutput) SetLoggingConfigurationIdentifiers added in v1.44.140 

func (s *UpdateRoomOutput) SetLoggingConfigurationIdentifiers(v []*string) *UpdateRoomOutput

SetLoggingConfigurationIdentifiers sets the LoggingConfigurationIdentifiers field's value.

func (*UpdateRoomOutput) SetMaximumMessageLength 

func (s *UpdateRoomOutput) SetMaximumMessageLength(v int64) *UpdateRoomOutput

SetMaximumMessageLength sets the MaximumMessageLength field's value.

func (*UpdateRoomOutput) SetMaximumMessageRatePerSecond 

func (s *UpdateRoomOutput) SetMaximumMessageRatePerSecond(v int64) *UpdateRoomOutput

SetMaximumMessageRatePerSecond sets the MaximumMessageRatePerSecond field's value.

func (*UpdateRoomOutput) SetMessageReviewHandler 

func (s *UpdateRoomOutput) SetMessageReviewHandler(v *MessageReviewHandler) *UpdateRoomOutput

SetMessageReviewHandler sets the MessageReviewHandler field's value.

func (*UpdateRoomOutput) SetName 

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

SetName sets the Name field's value.

func (*UpdateRoomOutput) SetTags 

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

SetTags sets the Tags field's value.

func (*UpdateRoomOutput) SetUpdateTime 

func (s *UpdateRoomOutput) SetUpdateTime(v time.Time) *UpdateRoomOutput

SetUpdateTime sets the UpdateTime field's value.

func (UpdateRoomOutput) String 

func (s UpdateRoomOutput) 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:"-"`

	FieldList []*ValidationExceptionField `locationName:"fieldList" type:"list"`

	Message_ *string `locationName:"message" type:"string"`

	// Reason is a required field
	Reason *string `locationName:"reason" type:"string" required:"true" enum:"ValidationExceptionReason"`
	// contains filtered or unexported fields
}

func (*ValidationException) Code 

func (s *ValidationException) Code() string

Code returns the exception type name.

func (*ValidationException) Error 

func (s *ValidationException) Error() string

func (ValidationException) GoString 

func (s ValidationException) GoString() string

GoString returns the string representation.

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

func (*ValidationException) Message 

func (s *ValidationException) Message() string

Message returns the exception's message.

func (*ValidationException) OrigErr 

func (s *ValidationException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ValidationException) RequestID 

func (s *ValidationException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ValidationException) StatusCode 

func (s *ValidationException) StatusCode() int

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

func (ValidationException) String 

func (s ValidationException) String() string

String returns the string representation.

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

type ValidationExceptionField 

type ValidationExceptionField struct {

	// Explanation of the reason for the validation error.
	//
	// Message is a required field
	Message *string `locationName:"message" type:"string" required:"true"`

	// Name of the field which failed validation.
	//
	// Name is a required field
	Name *string `locationName:"name" type:"string" required:"true"`
	// contains filtered or unexported fields
}

This object is used in the ValidationException error.

func (ValidationExceptionField) GoString 

func (s ValidationExceptionField) 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 (*ValidationExceptionField) SetMessage 

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

SetMessage sets the Message field's value.

func (*ValidationExceptionField) SetName 

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

SetName sets the Name field's value.

func (ValidationExceptionField) String 

func (s ValidationExceptionField) 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 ivschatiface provides an interface to enable mocking the Amazon Interactive Video Service Chat service client for testing your code.
 Package ivschatiface provides an interface to enable mocking the Amazon Interactive Video Service Chat 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.