types

package
v1.16.16 Latest Latest
Warning

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

 Go to latest Published: Feb 18, 2025 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AccessDeniedException 

type AccessDeniedException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

func (*AccessDeniedException) Error 

func (e *AccessDeniedException) Error() string

func (*AccessDeniedException) ErrorCode 

func (e *AccessDeniedException) ErrorCode() string

func (*AccessDeniedException) ErrorFault 

func (e *AccessDeniedException) ErrorFault() smithy.ErrorFault

func (*AccessDeniedException) ErrorMessage 

func (e *AccessDeniedException) ErrorMessage() string

type ChatTokenCapability 

type ChatTokenCapability string
const (
	ChatTokenCapabilitySendMessage    ChatTokenCapability = "SEND_MESSAGE"
	ChatTokenCapabilityDisconnectUser ChatTokenCapability = "DISCONNECT_USER"
	ChatTokenCapabilityDeleteMessage  ChatTokenCapability = "DELETE_MESSAGE"
)

Enum values for ChatTokenCapability

func (ChatTokenCapability) Values 

func (ChatTokenCapability) Values() []ChatTokenCapability

Values returns all known values for ChatTokenCapability. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type CloudWatchLogsDestinationConfiguration added in v1.1.0 

type CloudWatchLogsDestinationConfiguration struct {

	// Name of the Amazon Cloudwatch Logs destination where chat activity will be
	// logged.
	//
	// This member is required.
	LogGroupName *string
	// contains filtered or unexported fields
}

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

type ConflictException 

type ConflictException struct {
	Message *string

	ErrorCodeOverride *string

	ResourceId   *string
	ResourceType ResourceType
	// contains filtered or unexported fields
}

func (*ConflictException) Error 

func (e *ConflictException) Error() string

func (*ConflictException) ErrorCode 

func (e *ConflictException) ErrorCode() string

func (*ConflictException) ErrorFault 

func (e *ConflictException) ErrorFault() smithy.ErrorFault

func (*ConflictException) ErrorMessage 

func (e *ConflictException) ErrorMessage() string

type CreateLoggingConfigurationState added in v1.1.0 

type CreateLoggingConfigurationState string
const (
	CreateLoggingConfigurationStateActive CreateLoggingConfigurationState = "ACTIVE"
)

Enum values for CreateLoggingConfigurationState

func (CreateLoggingConfigurationState) Values added in v1.1.0 

func (CreateLoggingConfigurationState) Values() []CreateLoggingConfigurationState

Values returns all known values for CreateLoggingConfigurationState. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type DestinationConfiguration added in v1.1.0 

type DestinationConfiguration interface {
	// contains filtered or unexported methods
}

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

The following types satisfy this interface: 

DestinationConfigurationMemberCloudWatchLogs
DestinationConfigurationMemberFirehose
DestinationConfigurationMemberS3
Example (OutputUsage) 
// Code generated by smithy-go-codegen DO NOT EDIT.

package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/ivschat/types"
)

func main() {
	var union types.DestinationConfiguration
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.DestinationConfigurationMemberCloudWatchLogs:
		_ = v.Value // Value is types.CloudWatchLogsDestinationConfiguration

	case *types.DestinationConfigurationMemberFirehose:
		_ = v.Value // Value is types.FirehoseDestinationConfiguration

	case *types.DestinationConfigurationMemberS3:
		_ = v.Value // Value is types.S3DestinationConfiguration

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

var _ *types.FirehoseDestinationConfiguration
var _ *types.CloudWatchLogsDestinationConfiguration
var _ *types.S3DestinationConfiguration

Output:

type DestinationConfigurationMemberCloudWatchLogs added in v1.1.0 

type DestinationConfigurationMemberCloudWatchLogs struct {
	Value CloudWatchLogsDestinationConfiguration
	// contains filtered or unexported fields
}

An Amazon CloudWatch Logs destination configuration where chat activity will be logged.

type DestinationConfigurationMemberFirehose added in v1.1.0 

type DestinationConfigurationMemberFirehose struct {
	Value FirehoseDestinationConfiguration
	// contains filtered or unexported fields
}

An Amazon Kinesis Data Firehose destination configuration where chat activity will be logged.

type DestinationConfigurationMemberS3 added in v1.1.0 

type DestinationConfigurationMemberS3 struct {
	Value S3DestinationConfiguration
	// contains filtered or unexported fields
}

An Amazon S3 destination configuration where chat activity will be logged.

type FallbackResult 

type FallbackResult string
const (
	FallbackResultAllow FallbackResult = "ALLOW"
	FallbackResultDeny  FallbackResult = "DENY"
)

Enum values for FallbackResult

func (FallbackResult) Values 

func (FallbackResult) Values() []FallbackResult

Values returns all known values for FallbackResult. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type FirehoseDestinationConfiguration added in v1.1.0 

type FirehoseDestinationConfiguration struct {

	// Name of the Amazon Kinesis Firehose delivery stream where chat activity will be
	// logged.
	//
	// This member is required.
	DeliveryStreamName *string
	// contains filtered or unexported fields
}

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

type InternalServerException 

type InternalServerException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

func (*InternalServerException) Error 

func (e *InternalServerException) Error() string

func (*InternalServerException) ErrorCode 

func (e *InternalServerException) ErrorCode() string

func (*InternalServerException) ErrorFault 

func (e *InternalServerException) ErrorFault() smithy.ErrorFault

func (*InternalServerException) ErrorMessage 

func (e *InternalServerException) ErrorMessage() string

type LoggingConfigurationState added in v1.1.0 

type LoggingConfigurationState string
const (
	LoggingConfigurationStateCreating     LoggingConfigurationState = "CREATING"
	LoggingConfigurationStateCreateFailed LoggingConfigurationState = "CREATE_FAILED"
	LoggingConfigurationStateDeleting     LoggingConfigurationState = "DELETING"
	LoggingConfigurationStateDeleteFailed LoggingConfigurationState = "DELETE_FAILED"
	LoggingConfigurationStateUpdating     LoggingConfigurationState = "UPDATING"
	LoggingConfigurationStateUpdateFailed LoggingConfigurationState = "UPDATE_FAILED"
	LoggingConfigurationStateActive       LoggingConfigurationState = "ACTIVE"
)

Enum values for LoggingConfigurationState

func (LoggingConfigurationState) Values added in v1.1.0 

func (LoggingConfigurationState) Values() []LoggingConfigurationState

Values returns all known values for LoggingConfigurationState. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type LoggingConfigurationSummary added in v1.1.0 

type LoggingConfigurationSummary struct {

	// Logging-configuration ARN.
	Arn *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

	// A complex type that contains a destination configuration for where chat content
	// will be logged.
	DestinationConfiguration DestinationConfiguration

	// Logging-configuration ID, generated by the system. This is a relative
	// identifier, the part of the ARN that uniquely identifies the room.
	Id *string

	// Logging-configuration name. The value does not need to be unique.
	Name *string

	// The state of the logging configuration. When this is ACTIVE , the configuration
	// is ready for logging chat content.
	State LoggingConfigurationState

	// Tags to attach to the resource. Array of maps, each of the form string:string
	// (key:value) . See [Best practices and strategies] in Tagging Amazon Web Services Resources and Tag Editor 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.
	//
	// [Best practices and strategies]: https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html
	Tags map[string]string

	// 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
	// contains filtered or unexported fields
}

Summary information about a logging configuration.

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].) 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 .
	//
	// [Service Quotas]: https://docs.aws.amazon.com/ivs/latest/userguide/service-quotas.html
	FallbackResult FallbackResult

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

Configuration information for optional message review.

type PendingVerification 

type PendingVerification struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

func (*PendingVerification) Error 

func (e *PendingVerification) Error() string

func (*PendingVerification) ErrorCode 

func (e *PendingVerification) ErrorCode() string

func (*PendingVerification) ErrorFault 

func (e *PendingVerification) ErrorFault() smithy.ErrorFault

func (*PendingVerification) ErrorMessage 

func (e *PendingVerification) ErrorMessage() string

type ResourceNotFoundException 

type ResourceNotFoundException struct {
	Message *string

	ErrorCodeOverride *string

	ResourceId   *string
	ResourceType ResourceType
	// contains filtered or unexported fields
}

func (*ResourceNotFoundException) Error 

func (e *ResourceNotFoundException) Error() string

func (*ResourceNotFoundException) ErrorCode 

func (e *ResourceNotFoundException) ErrorCode() string

func (*ResourceNotFoundException) ErrorFault 

func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault

func (*ResourceNotFoundException) ErrorMessage 

func (e *ResourceNotFoundException) ErrorMessage() string

type ResourceType 

type ResourceType string
const (
	ResourceTypeRoom ResourceType = "ROOM"
)

Enum values for ResourceType

func (ResourceType) Values 

func (ResourceType) Values() []ResourceType

Values returns all known values for ResourceType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type RoomSummary 

type RoomSummary struct {

	// Room ARN.
	Arn *string

	// Time when the room was created. This is an ISO 8601 timestamp; note that this
	// is returned as a string.
	CreateTime *time.Time

	// Room ID, generated by the system. This is a relative identifier, the part of
	// the ARN that uniquely identifies the room.
	Id *string

	// List of logging-configuration identifiers attached to the room.
	LoggingConfigurationIdentifiers []string

	// Configuration information for optional review of messages.
	MessageReviewHandler *MessageReviewHandler

	// Room name. The value does not need to be unique.
	Name *string

	// Tags attached to the resource. Array of maps, each of the form string:string
	// (key:value) . See [Best practices and strategies] in Tagging Amazon Web Services Resources and Tag Editor 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.
	//
	// [Best practices and strategies]: https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html
	Tags map[string]string

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

Summary information about a room.

type S3DestinationConfiguration added in v1.1.0 

type S3DestinationConfiguration struct {

	// Name of the Amazon S3 bucket where chat activity will be logged.
	//
	// This member is required.
	BucketName *string
	// contains filtered or unexported fields
}

Specifies an S3 location where chat logs will be stored.

type ServiceQuotaExceededException 

type ServiceQuotaExceededException struct {
	Message *string

	ErrorCodeOverride *string

	ResourceId   *string
	ResourceType ResourceType
	Limit        int32
	// contains filtered or unexported fields
}

func (*ServiceQuotaExceededException) Error 

func (e *ServiceQuotaExceededException) Error() string

func (*ServiceQuotaExceededException) ErrorCode 

func (e *ServiceQuotaExceededException) ErrorCode() string

func (*ServiceQuotaExceededException) ErrorFault 

func (e *ServiceQuotaExceededException) ErrorFault() smithy.ErrorFault

func (*ServiceQuotaExceededException) ErrorMessage 

func (e *ServiceQuotaExceededException) ErrorMessage() string

type ThrottlingException 

type ThrottlingException struct {
	Message *string

	ErrorCodeOverride *string

	ResourceId   *string
	ResourceType ResourceType
	Limit        int32
	// contains filtered or unexported fields
}

func (*ThrottlingException) Error 

func (e *ThrottlingException) Error() string

func (*ThrottlingException) ErrorCode 

func (e *ThrottlingException) ErrorCode() string

func (*ThrottlingException) ErrorFault 

func (e *ThrottlingException) ErrorFault() smithy.ErrorFault

func (*ThrottlingException) ErrorMessage 

func (e *ThrottlingException) ErrorMessage() string

type UnknownUnionMember added in v1.1.0 

type UnknownUnionMember struct {
	Tag   string
	Value []byte
	// contains filtered or unexported fields
}

UnknownUnionMember is returned when a union member is returned over the wire, but has an unknown tag.

type UpdateLoggingConfigurationState added in v1.1.0 

type UpdateLoggingConfigurationState string
const (
	UpdateLoggingConfigurationStateActive UpdateLoggingConfigurationState = "ACTIVE"
)

Enum values for UpdateLoggingConfigurationState

func (UpdateLoggingConfigurationState) Values added in v1.1.0 

func (UpdateLoggingConfigurationState) Values() []UpdateLoggingConfigurationState

Values returns all known values for UpdateLoggingConfigurationState. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ValidationException 

type ValidationException struct {
	Message *string

	ErrorCodeOverride *string

	Reason    ValidationExceptionReason
	FieldList []ValidationExceptionField
	// contains filtered or unexported fields
}

func (*ValidationException) Error 

func (e *ValidationException) Error() string

func (*ValidationException) ErrorCode 

func (e *ValidationException) ErrorCode() string

func (*ValidationException) ErrorFault 

func (e *ValidationException) ErrorFault() smithy.ErrorFault

func (*ValidationException) ErrorMessage 

func (e *ValidationException) ErrorMessage() string

type ValidationExceptionField 

type ValidationExceptionField struct {

	// Explanation of the reason for the validation error.
	//
	// This member is required.
	Message *string

	// Name of the field which failed validation.
	//
	// This member is required.
	Name *string
	// contains filtered or unexported fields
}

This object is used in the ValidationException error.

type ValidationExceptionReason 

type ValidationExceptionReason string
const (
	ValidationExceptionReasonUnknownOperation      ValidationExceptionReason = "UNKNOWN_OPERATION"
	ValidationExceptionReasonFieldValidationFailed ValidationExceptionReason = "FIELD_VALIDATION_FAILED"
	ValidationExceptionReasonOther                 ValidationExceptionReason = "OTHER"
)

Enum values for ValidationExceptionReason

func (ValidationExceptionReason) Values 

func (ValidationExceptionReason) Values() []ValidationExceptionReason

Values returns all known values for ValidationExceptionReason. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

Source Files

View all Source files

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.