chimesdkmessaging

package
v1.45.14 Latest Latest
Warning

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

 Go to latest Published: Sep 20, 2023 License: Apache-2.0 Imports: 10 Imported by: 11

Documentation

Overview

Package chimesdkmessaging provides the client and types for making API requests to Amazon Chime SDK Messaging.

The Amazon Chime SDK messaging APIs in this section allow software developers to send and receive messages in custom messaging applications. These APIs depend on the frameworks provided by the Amazon Chime SDK identity APIs. For more information about the messaging APIs, see Amazon Chime SDK messaging (https://docs.aws.amazon.com/chime/latest/APIReference/API_Operations_Amazon_Chime_SDK_Messaging.html).

See https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15 for more information on this service.

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

Using the Client

To contact Amazon Chime SDK Messaging 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 Chime SDK Messaging client ChimeSDKMessaging for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/chimesdkmessaging/#New

Index

Constants

View Source 
const (
	// AllowNotificationsAll is a AllowNotifications enum value
	AllowNotificationsAll = "ALL"

	// AllowNotificationsNone is a AllowNotifications enum value
	AllowNotificationsNone = "NONE"

	// AllowNotificationsFiltered is a AllowNotifications enum value
	AllowNotificationsFiltered = "FILTERED"
)
View Source 
const (
	// ChannelMembershipTypeDefault is a ChannelMembershipType enum value
	ChannelMembershipTypeDefault = "DEFAULT"

	// ChannelMembershipTypeHidden is a ChannelMembershipType enum value
	ChannelMembershipTypeHidden = "HIDDEN"
)
View Source 
const (
	// ChannelMessagePersistenceTypePersistent is a ChannelMessagePersistenceType enum value
	ChannelMessagePersistenceTypePersistent = "PERSISTENT"

	// ChannelMessagePersistenceTypeNonPersistent is a ChannelMessagePersistenceType enum value
	ChannelMessagePersistenceTypeNonPersistent = "NON_PERSISTENT"
)
View Source 
const (
	// ChannelMessageStatusSent is a ChannelMessageStatus enum value
	ChannelMessageStatusSent = "SENT"

	// ChannelMessageStatusPending is a ChannelMessageStatus enum value
	ChannelMessageStatusPending = "PENDING"

	// ChannelMessageStatusFailed is a ChannelMessageStatus enum value
	ChannelMessageStatusFailed = "FAILED"

	// ChannelMessageStatusDenied is a ChannelMessageStatus enum value
	ChannelMessageStatusDenied = "DENIED"
)
View Source 
const (
	// ChannelMessageTypeStandard is a ChannelMessageType enum value
	ChannelMessageTypeStandard = "STANDARD"

	// ChannelMessageTypeControl is a ChannelMessageType enum value
	ChannelMessageTypeControl = "CONTROL"
)
View Source 
const (
	// ChannelModeUnrestricted is a ChannelMode enum value
	ChannelModeUnrestricted = "UNRESTRICTED"

	// ChannelModeRestricted is a ChannelMode enum value
	ChannelModeRestricted = "RESTRICTED"
)
View Source 
const (
	// ChannelPrivacyPublic is a ChannelPrivacy enum value
	ChannelPrivacyPublic = "PUBLIC"

	// ChannelPrivacyPrivate is a ChannelPrivacy enum value
	ChannelPrivacyPrivate = "PRIVATE"
)
View Source 
const (
	// ErrorCodeBadRequest is a ErrorCode enum value
	ErrorCodeBadRequest = "BadRequest"

	// ErrorCodeConflict is a ErrorCode enum value
	ErrorCodeConflict = "Conflict"

	// ErrorCodeForbidden is a ErrorCode enum value
	ErrorCodeForbidden = "Forbidden"

	// ErrorCodeNotFound is a ErrorCode enum value
	ErrorCodeNotFound = "NotFound"

	// ErrorCodePreconditionFailed is a ErrorCode enum value
	ErrorCodePreconditionFailed = "PreconditionFailed"

	// ErrorCodeResourceLimitExceeded is a ErrorCode enum value
	ErrorCodeResourceLimitExceeded = "ResourceLimitExceeded"

	// ErrorCodeServiceFailure is a ErrorCode enum value
	ErrorCodeServiceFailure = "ServiceFailure"

	// ErrorCodeAccessDenied is a ErrorCode enum value
	ErrorCodeAccessDenied = "AccessDenied"

	// ErrorCodeServiceUnavailable is a ErrorCode enum value
	ErrorCodeServiceUnavailable = "ServiceUnavailable"

	// ErrorCodeThrottled is a ErrorCode enum value
	ErrorCodeThrottled = "Throttled"

	// ErrorCodeThrottling is a ErrorCode enum value
	ErrorCodeThrottling = "Throttling"

	// ErrorCodeUnauthorized is a ErrorCode enum value
	ErrorCodeUnauthorized = "Unauthorized"

	// ErrorCodeUnprocessable is a ErrorCode enum value
	ErrorCodeUnprocessable = "Unprocessable"

	// ErrorCodeVoiceConnectorGroupAssociationsExist is a ErrorCode enum value
	ErrorCodeVoiceConnectorGroupAssociationsExist = "VoiceConnectorGroupAssociationsExist"

	// ErrorCodePhoneNumberAssociationsExist is a ErrorCode enum value
	ErrorCodePhoneNumberAssociationsExist = "PhoneNumberAssociationsExist"
)
View Source 
const (
	// ExpirationCriterionCreatedTimestamp is a ExpirationCriterion enum value
	ExpirationCriterionCreatedTimestamp = "CREATED_TIMESTAMP"

	// ExpirationCriterionLastMessageTimestamp is a ExpirationCriterion enum value
	ExpirationCriterionLastMessageTimestamp = "LAST_MESSAGE_TIMESTAMP"
)
View Source 
const (
	// FallbackActionContinue is a FallbackAction enum value
	FallbackActionContinue = "CONTINUE"

	// FallbackActionAbort is a FallbackAction enum value
	FallbackActionAbort = "ABORT"
)
View Source 
const (
	// MessagingDataTypeChannel is a MessagingDataType enum value
	MessagingDataTypeChannel = "Channel"

	// MessagingDataTypeChannelMessage is a MessagingDataType enum value
	MessagingDataTypeChannelMessage = "ChannelMessage"
)
View Source 
const (
	// PushNotificationTypeDefault is a PushNotificationType enum value
	PushNotificationTypeDefault = "DEFAULT"

	// PushNotificationTypeVoip is a PushNotificationType enum value
	PushNotificationTypeVoip = "VOIP"
)
View Source 
const (
	// SearchFieldOperatorEquals is a SearchFieldOperator enum value
	SearchFieldOperatorEquals = "EQUALS"

	// SearchFieldOperatorIncludes is a SearchFieldOperator enum value
	SearchFieldOperatorIncludes = "INCLUDES"
)
View Source 
const (
	// SortOrderAscending is a SortOrder enum value
	SortOrderAscending = "ASCENDING"

	// SortOrderDescending is a SortOrder enum value
	SortOrderDescending = "DESCENDING"
)
View Source 
const (

	// ErrCodeBadRequestException for service response error code
	// "BadRequestException".
	//
	// The input parameters don't match the service's restrictions.
	ErrCodeBadRequestException = "BadRequestException"

	// ErrCodeConflictException for service response error code
	// "ConflictException".
	//
	// The request could not be processed because of conflict in the current state
	// of the resource.
	ErrCodeConflictException = "ConflictException"

	// ErrCodeForbiddenException for service response error code
	// "ForbiddenException".
	//
	// The client is permanently forbidden from making the request.
	ErrCodeForbiddenException = "ForbiddenException"

	// ErrCodeNotFoundException for service response error code
	// "NotFoundException".
	//
	// One or more of the resources in the request does not exist in the system.
	ErrCodeNotFoundException = "NotFoundException"

	// ErrCodeResourceLimitExceededException for service response error code
	// "ResourceLimitExceededException".
	//
	// The request exceeds the resource limit.
	ErrCodeResourceLimitExceededException = "ResourceLimitExceededException"

	// ErrCodeServiceFailureException for service response error code
	// "ServiceFailureException".
	//
	// The service encountered an unexpected error.
	ErrCodeServiceFailureException = "ServiceFailureException"

	// ErrCodeServiceUnavailableException for service response error code
	// "ServiceUnavailableException".
	//
	// The service is currently unavailable.
	ErrCodeServiceUnavailableException = "ServiceUnavailableException"

	// ErrCodeThrottledClientException for service response error code
	// "ThrottledClientException".
	//
	// The client exceeded its request rate limit.
	ErrCodeThrottledClientException = "ThrottledClientException"

	// ErrCodeUnauthorizedClientException for service response error code
	// "UnauthorizedClientException".
	//
	// The client is not currently authorized to make the request.
	ErrCodeUnauthorizedClientException = "UnauthorizedClientException"
)
View Source 
const (
	ServiceName = "Chime SDK Messaging" // Name of service.
	EndpointsID = "messaging-chime"     // ID to lookup a service endpoint with.
	ServiceID   = "Chime SDK Messaging" // ServiceID is a unique identifier of a specific service.
)

Service information constants

View Source 
const (
	// InvocationTypeAsync is a InvocationType enum value
	InvocationTypeAsync = "ASYNC"
)
View Source 
const (
	// SearchFieldKeyMembers is a SearchFieldKey enum value
	SearchFieldKeyMembers = "MEMBERS"
)

Variables

This section is empty.

Functions

func AllowNotifications_Values added in v1.41.11 

func AllowNotifications_Values() []string

AllowNotifications_Values returns all elements of the AllowNotifications enum

func ChannelMembershipType_Values 

func ChannelMembershipType_Values() []string

ChannelMembershipType_Values returns all elements of the ChannelMembershipType enum

func ChannelMessagePersistenceType_Values 

func ChannelMessagePersistenceType_Values() []string

ChannelMessagePersistenceType_Values returns all elements of the ChannelMessagePersistenceType enum

func ChannelMessageStatus_Values added in v1.41.6 

func ChannelMessageStatus_Values() []string

ChannelMessageStatus_Values returns all elements of the ChannelMessageStatus enum

func ChannelMessageType_Values 

func ChannelMessageType_Values() []string

ChannelMessageType_Values returns all elements of the ChannelMessageType enum

func ChannelMode_Values 

func ChannelMode_Values() []string

ChannelMode_Values returns all elements of the ChannelMode enum

func ChannelPrivacy_Values 

func ChannelPrivacy_Values() []string

ChannelPrivacy_Values returns all elements of the ChannelPrivacy enum

func ErrorCode_Values 

func ErrorCode_Values() []string

ErrorCode_Values returns all elements of the ErrorCode enum

func ExpirationCriterion_Values added in v1.44.228 

func ExpirationCriterion_Values() []string

ExpirationCriterion_Values returns all elements of the ExpirationCriterion enum

func FallbackAction_Values added in v1.41.6 

func FallbackAction_Values() []string

FallbackAction_Values returns all elements of the FallbackAction enum

func InvocationType_Values added in v1.41.6 

func InvocationType_Values() []string

InvocationType_Values returns all elements of the InvocationType enum

func MessagingDataType_Values added in v1.44.226 

func MessagingDataType_Values() []string

MessagingDataType_Values returns all elements of the MessagingDataType enum

func PushNotificationType_Values added in v1.41.11 

func PushNotificationType_Values() []string

PushNotificationType_Values returns all elements of the PushNotificationType enum

func SearchFieldKey_Values added in v1.44.28 

func SearchFieldKey_Values() []string

SearchFieldKey_Values returns all elements of the SearchFieldKey enum

func SearchFieldOperator_Values added in v1.44.28 

func SearchFieldOperator_Values() []string

SearchFieldOperator_Values returns all elements of the SearchFieldOperator enum

func SortOrder_Values 

func SortOrder_Values() []string

SortOrder_Values returns all elements of the SortOrder enum

Types

type AppInstanceUserMembershipSummary 

type AppInstanceUserMembershipSummary struct {

	// The time at which an AppInstanceUser last marked a channel as read.
	ReadMarkerTimestamp *time.Time `type:"timestamp"`

	// The ID of the SubChannel that the AppInstanceUser is a member of.
	SubChannelId *string `min:"1" type:"string"`

	// The type of ChannelMembership.
	Type *string `type:"string" enum:"ChannelMembershipType"`
	// contains filtered or unexported fields
}

Summary of the membership details of an AppInstanceUser.

func (AppInstanceUserMembershipSummary) GoString 

func (s AppInstanceUserMembershipSummary) 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 (*AppInstanceUserMembershipSummary) SetReadMarkerTimestamp 

func (s *AppInstanceUserMembershipSummary) SetReadMarkerTimestamp(v time.Time) *AppInstanceUserMembershipSummary

SetReadMarkerTimestamp sets the ReadMarkerTimestamp field's value.

func (*AppInstanceUserMembershipSummary) SetSubChannelId added in v1.44.76 

func (s *AppInstanceUserMembershipSummary) SetSubChannelId(v string) *AppInstanceUserMembershipSummary

SetSubChannelId sets the SubChannelId field's value.

func (*AppInstanceUserMembershipSummary) SetType 

func (s *AppInstanceUserMembershipSummary) SetType(v string) *AppInstanceUserMembershipSummary

SetType sets the Type field's value.

func (AppInstanceUserMembershipSummary) String 

func (s AppInstanceUserMembershipSummary) 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 AssociateChannelFlowInput added in v1.41.6 

type AssociateChannelFlowInput struct {

	// The ARN of the channel.
	//
	// ChannelArn is a required field
	ChannelArn *string `location:"uri" locationName:"channelArn" min:"5" type:"string" required:"true"`

	// The ARN of the channel flow.
	//
	// ChannelFlowArn is a required field
	ChannelFlowArn *string `min:"5" type:"string" required:"true"`

	// The AppInstanceUserArn of the user making the API call.
	//
	// ChimeBearer is a required field
	ChimeBearer *string `location:"header" locationName:"x-amz-chime-bearer" min:"5" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (AssociateChannelFlowInput) GoString added in v1.41.6 

func (s AssociateChannelFlowInput) 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 (*AssociateChannelFlowInput) SetChannelArn added in v1.41.6 

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

SetChannelArn sets the ChannelArn field's value.

func (*AssociateChannelFlowInput) SetChannelFlowArn added in v1.41.6 

func (s *AssociateChannelFlowInput) SetChannelFlowArn(v string) *AssociateChannelFlowInput

SetChannelFlowArn sets the ChannelFlowArn field's value.

func (*AssociateChannelFlowInput) SetChimeBearer added in v1.41.6 

func (s *AssociateChannelFlowInput) SetChimeBearer(v string) *AssociateChannelFlowInput

SetChimeBearer sets the ChimeBearer field's value.

func (AssociateChannelFlowInput) String added in v1.41.6 

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

func (s *AssociateChannelFlowInput) Validate() error

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

type AssociateChannelFlowOutput added in v1.41.6 

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

func (AssociateChannelFlowOutput) GoString added in v1.41.6 

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

func (s AssociateChannelFlowOutput) 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 BadRequestException 

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

	Code_ *string `locationName:"Code" type:"string" enum:"ErrorCode"`

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

The input parameters don't match the service's restrictions.

func (*BadRequestException) Code 

func (s *BadRequestException) Code() string

Code returns the exception type name.

func (*BadRequestException) Error 

func (s *BadRequestException) Error() string

func (BadRequestException) GoString 

func (s BadRequestException) 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 (*BadRequestException) Message 

func (s *BadRequestException) Message() string

Message returns the exception's message.

func (*BadRequestException) OrigErr 

func (s *BadRequestException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*BadRequestException) RequestID 

func (s *BadRequestException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*BadRequestException) StatusCode 

func (s *BadRequestException) StatusCode() int

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

func (BadRequestException) String 

func (s BadRequestException) 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 BatchChannelMemberships 

type BatchChannelMemberships struct {

	// The ARN of the channel to which you're adding members.
	ChannelArn *string `min:"5" type:"string"`

	// The identifier of the member who invited another member.
	InvitedBy *Identity `type:"structure"`

	// The users successfully added to the request.
	Members []*Identity `type:"list"`

	// The ID of the SubChannel.
	SubChannelId *string `min:"1" type:"string"`

	// The membership types set for the channel members.
	Type *string `type:"string" enum:"ChannelMembershipType"`
	// contains filtered or unexported fields
}

The membership information, including member ARNs, the channel ARN, and membership types.

func (BatchChannelMemberships) GoString 

func (s BatchChannelMemberships) 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 (*BatchChannelMemberships) SetChannelArn 

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

SetChannelArn sets the ChannelArn field's value.

func (*BatchChannelMemberships) SetInvitedBy 

func (s *BatchChannelMemberships) SetInvitedBy(v *Identity) *BatchChannelMemberships

SetInvitedBy sets the InvitedBy field's value.

func (*BatchChannelMemberships) SetMembers 

func (s *BatchChannelMemberships) SetMembers(v []*Identity) *BatchChannelMemberships

SetMembers sets the Members field's value.

func (*BatchChannelMemberships) SetSubChannelId added in v1.44.76 

func (s *BatchChannelMemberships) SetSubChannelId(v string) *BatchChannelMemberships

SetSubChannelId sets the SubChannelId field's value.

func (*BatchChannelMemberships) SetType 

func (s *BatchChannelMemberships) SetType(v string) *BatchChannelMemberships

SetType sets the Type field's value.

func (BatchChannelMemberships) String 

func (s BatchChannelMemberships) 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 BatchCreateChannelMembershipError 

type BatchCreateChannelMembershipError struct {

	// The error code.
	ErrorCode *string `type:"string" enum:"ErrorCode"`

	// The error message.
	ErrorMessage *string `type:"string"`

	// The AppInstanceUserArn of the member that the service couldn't add.
	MemberArn *string `min:"5" type:"string"`
	// contains filtered or unexported fields
}

A list of failed member ARNs, error codes, and error messages.

func (BatchCreateChannelMembershipError) GoString 

func (s BatchCreateChannelMembershipError) 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 (*BatchCreateChannelMembershipError) SetErrorCode 

func (s *BatchCreateChannelMembershipError) SetErrorCode(v string) *BatchCreateChannelMembershipError

SetErrorCode sets the ErrorCode field's value.

func (*BatchCreateChannelMembershipError) SetErrorMessage 

func (s *BatchCreateChannelMembershipError) SetErrorMessage(v string) *BatchCreateChannelMembershipError

SetErrorMessage sets the ErrorMessage field's value.

func (*BatchCreateChannelMembershipError) SetMemberArn 

func (s *BatchCreateChannelMembershipError) SetMemberArn(v string) *BatchCreateChannelMembershipError

SetMemberArn sets the MemberArn field's value.

func (BatchCreateChannelMembershipError) String 

func (s BatchCreateChannelMembershipError) 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 BatchCreateChannelMembershipInput 

type BatchCreateChannelMembershipInput struct {

	// The ARN of the channel to which you're adding users or bots.
	//
	// ChannelArn is a required field
	ChannelArn *string `location:"uri" locationName:"channelArn" min:"5" type:"string" required:"true"`

	// The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
	//
	// ChimeBearer is a required field
	ChimeBearer *string `location:"header" locationName:"x-amz-chime-bearer" min:"5" type:"string" required:"true"`

	// The ARNs of the members you want to add to the channel. Only AppInstanceUsers
	// and AppInstanceBots can be added as a channel member.
	//
	// MemberArns is a required field
	MemberArns []*string `min:"1" type:"list" required:"true"`

	// The ID of the SubChannel in the request.
	//
	// Only required when creating membership in a SubChannel for a moderator in
	// an elastic channel.
	SubChannelId *string `min:"1" type:"string"`

	// The membership type of a user, DEFAULT or HIDDEN. Default members are always
	// returned as part of ListChannelMemberships. Hidden members are only returned
	// if the type filter in ListChannelMemberships equals HIDDEN. Otherwise hidden
	// members are not returned. This is only supported by moderators.
	Type *string `type:"string" enum:"ChannelMembershipType"`
	// contains filtered or unexported fields
}

func (BatchCreateChannelMembershipInput) GoString 

func (s BatchCreateChannelMembershipInput) 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 (*BatchCreateChannelMembershipInput) SetChannelArn 

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

SetChannelArn sets the ChannelArn field's value.

func (*BatchCreateChannelMembershipInput) SetChimeBearer 

func (s *BatchCreateChannelMembershipInput) SetChimeBearer(v string) *BatchCreateChannelMembershipInput

SetChimeBearer sets the ChimeBearer field's value.

func (*BatchCreateChannelMembershipInput) SetMemberArns 

func (s *BatchCreateChannelMembershipInput) SetMemberArns(v []*string) *BatchCreateChannelMembershipInput

SetMemberArns sets the MemberArns field's value.

func (*BatchCreateChannelMembershipInput) SetSubChannelId added in v1.44.76 

func (s *BatchCreateChannelMembershipInput) SetSubChannelId(v string) *BatchCreateChannelMembershipInput

SetSubChannelId sets the SubChannelId field's value.

func (*BatchCreateChannelMembershipInput) SetType 

func (s *BatchCreateChannelMembershipInput) SetType(v string) *BatchCreateChannelMembershipInput

SetType sets the Type field's value.

func (BatchCreateChannelMembershipInput) String 

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

func (s *BatchCreateChannelMembershipInput) Validate() error

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

type BatchCreateChannelMembershipOutput 

type BatchCreateChannelMembershipOutput struct {

	// The list of channel memberships in the response.
	BatchChannelMemberships *BatchChannelMemberships `type:"structure"`

	// If the action fails for one or more of the memberships in the request, a
	// list of the memberships is returned, along with error codes and error messages.
	Errors []*BatchCreateChannelMembershipError `type:"list"`
	// contains filtered or unexported fields
}

func (BatchCreateChannelMembershipOutput) GoString 

func (s BatchCreateChannelMembershipOutput) 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 (*BatchCreateChannelMembershipOutput) SetBatchChannelMemberships 

func (s *BatchCreateChannelMembershipOutput) SetBatchChannelMemberships(v *BatchChannelMemberships) *BatchCreateChannelMembershipOutput

SetBatchChannelMemberships sets the BatchChannelMemberships field's value.

func (*BatchCreateChannelMembershipOutput) SetErrors 

func (s *BatchCreateChannelMembershipOutput) SetErrors(v []*BatchCreateChannelMembershipError) *BatchCreateChannelMembershipOutput

SetErrors sets the Errors field's value.

func (BatchCreateChannelMembershipOutput) String 

func (s BatchCreateChannelMembershipOutput) 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 Channel 

type Channel struct {

	// The ARN of a channel.
	ChannelArn *string `min:"5" type:"string"`

	// The ARN of the channel flow.
	ChannelFlowArn *string `min:"5" type:"string"`

	// The AppInstanceUser who created the channel.
	CreatedBy *Identity `type:"structure"`

	// The time at which the AppInstanceUser created the channel.
	CreatedTimestamp *time.Time `type:"timestamp"`

	// The attributes required to configure and create an elastic channel. An elastic
	// channel can support a maximum of 1-million members.
	ElasticChannelConfiguration *ElasticChannelConfiguration `type:"structure"`

	// Settings that control when a channel expires.
	ExpirationSettings *ExpirationSettings `type:"structure"`

	// The time at which a member sent the last message in the channel.
	LastMessageTimestamp *time.Time `type:"timestamp"`

	// The time at which a channel was last updated.
	LastUpdatedTimestamp *time.Time `type:"timestamp"`

	// The channel's metadata.
	//
	// Metadata is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by Channel's
	// String and GoString methods.
	Metadata *string `type:"string" sensitive:"true"`

	// The mode of the channel.
	Mode *string `type:"string" enum:"ChannelMode"`

	// The name of a channel.
	//
	// Name is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by Channel's
	// String and GoString methods.
	Name *string `min:"1" type:"string" sensitive:"true"`

	// The channel's privacy setting.
	Privacy *string `type:"string" enum:"ChannelPrivacy"`
	// contains filtered or unexported fields
}

The details of a channel.

func (Channel) GoString 

func (s Channel) 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 (*Channel) SetChannelArn 

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

SetChannelArn sets the ChannelArn field's value.

func (*Channel) SetChannelFlowArn added in v1.41.6 

func (s *Channel) SetChannelFlowArn(v string) *Channel

SetChannelFlowArn sets the ChannelFlowArn field's value.

func (*Channel) SetCreatedBy 

func (s *Channel) SetCreatedBy(v *Identity) *Channel

SetCreatedBy sets the CreatedBy field's value.

func (*Channel) SetCreatedTimestamp 

func (s *Channel) SetCreatedTimestamp(v time.Time) *Channel

SetCreatedTimestamp sets the CreatedTimestamp field's value.

func (*Channel) SetElasticChannelConfiguration added in v1.44.76 

func (s *Channel) SetElasticChannelConfiguration(v *ElasticChannelConfiguration) *Channel

SetElasticChannelConfiguration sets the ElasticChannelConfiguration field's value.

func (*Channel) SetExpirationSettings added in v1.44.228 

func (s *Channel) SetExpirationSettings(v *ExpirationSettings) *Channel

SetExpirationSettings sets the ExpirationSettings field's value.

func (*Channel) SetLastMessageTimestamp 

func (s *Channel) SetLastMessageTimestamp(v time.Time) *Channel

SetLastMessageTimestamp sets the LastMessageTimestamp field's value.

func (*Channel) SetLastUpdatedTimestamp 

func (s *Channel) SetLastUpdatedTimestamp(v time.Time) *Channel

SetLastUpdatedTimestamp sets the LastUpdatedTimestamp field's value.

func (*Channel) SetMetadata 

func (s *Channel) SetMetadata(v string) *Channel

SetMetadata sets the Metadata field's value.

func (*Channel) SetMode 

func (s *Channel) SetMode(v string) *Channel

SetMode sets the Mode field's value.

func (*Channel) SetName 

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

SetName sets the Name field's value.

func (*Channel) SetPrivacy 

func (s *Channel) SetPrivacy(v string) *Channel

SetPrivacy sets the Privacy field's value.

func (Channel) String 

func (s Channel) 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 ChannelAssociatedWithFlowSummary added in v1.41.6 

type ChannelAssociatedWithFlowSummary struct {

	// The ARN of the channel.
	ChannelArn *string `min:"5" type:"string"`

	// The channel's metadata.
	//
	// Metadata is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ChannelAssociatedWithFlowSummary's
	// String and GoString methods.
	Metadata *string `type:"string" sensitive:"true"`

	// The mode of the channel.
	Mode *string `type:"string" enum:"ChannelMode"`

	// The name of the channel flow.
	//
	// Name is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ChannelAssociatedWithFlowSummary's
	// String and GoString methods.
	Name *string `min:"1" type:"string" sensitive:"true"`

	// The channel's privacy setting.
	Privacy *string `type:"string" enum:"ChannelPrivacy"`
	// contains filtered or unexported fields
}

Summary of details of a channel associated with channel flow.

func (ChannelAssociatedWithFlowSummary) GoString added in v1.41.6 

func (s ChannelAssociatedWithFlowSummary) 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 (*ChannelAssociatedWithFlowSummary) SetChannelArn added in v1.41.6 

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

SetChannelArn sets the ChannelArn field's value.

func (*ChannelAssociatedWithFlowSummary) SetMetadata added in v1.41.6 

func (s *ChannelAssociatedWithFlowSummary) SetMetadata(v string) *ChannelAssociatedWithFlowSummary

SetMetadata sets the Metadata field's value.

func (*ChannelAssociatedWithFlowSummary) SetMode added in v1.41.6 

func (s *ChannelAssociatedWithFlowSummary) SetMode(v string) *ChannelAssociatedWithFlowSummary

SetMode sets the Mode field's value.

func (*ChannelAssociatedWithFlowSummary) SetName added in v1.41.6 

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

SetName sets the Name field's value.

func (*ChannelAssociatedWithFlowSummary) SetPrivacy added in v1.41.6 

func (s *ChannelAssociatedWithFlowSummary) SetPrivacy(v string) *ChannelAssociatedWithFlowSummary

SetPrivacy sets the Privacy field's value.

func (ChannelAssociatedWithFlowSummary) String added in v1.41.6 

func (s ChannelAssociatedWithFlowSummary) 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 ChannelBan 

type ChannelBan struct {

	// The ARN of the channel from which a member is being banned.
	ChannelArn *string `min:"5" type:"string"`

	// The AppInstanceUser who created the ban.
	CreatedBy *Identity `type:"structure"`

	// The time at which the ban was created.
	CreatedTimestamp *time.Time `type:"timestamp"`

	// The member being banned from the channel.
	Member *Identity `type:"structure"`
	// contains filtered or unexported fields
}

The details of a channel ban.

func (ChannelBan) GoString 

func (s ChannelBan) 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 (*ChannelBan) SetChannelArn 

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

SetChannelArn sets the ChannelArn field's value.

func (*ChannelBan) SetCreatedBy 

func (s *ChannelBan) SetCreatedBy(v *Identity) *ChannelBan

SetCreatedBy sets the CreatedBy field's value.

func (*ChannelBan) SetCreatedTimestamp 

func (s *ChannelBan) SetCreatedTimestamp(v time.Time) *ChannelBan

SetCreatedTimestamp sets the CreatedTimestamp field's value.

func (*ChannelBan) SetMember 

func (s *ChannelBan) SetMember(v *Identity) *ChannelBan

SetMember sets the Member field's value.

func (ChannelBan) String 

func (s ChannelBan) 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 ChannelBanSummary 

type ChannelBanSummary struct {

	// The member being banned from a channel.
	Member *Identity `type:"structure"`
	// contains filtered or unexported fields
}

Summary of the details of a ChannelBan.

func (ChannelBanSummary) GoString 

func (s ChannelBanSummary) 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 (*ChannelBanSummary) SetMember 

func (s *ChannelBanSummary) SetMember(v *Identity) *ChannelBanSummary

SetMember sets the Member field's value.

func (ChannelBanSummary) String 

func (s ChannelBanSummary) 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 ChannelFlow added in v1.41.6 

type ChannelFlow struct {

	// The ARN of the channel flow.
	ChannelFlowArn *string `min:"5" type:"string"`

	// The time at which the channel flow was created.
	CreatedTimestamp *time.Time `type:"timestamp"`

	// The time at which a channel flow was updated.
	LastUpdatedTimestamp *time.Time `type:"timestamp"`

	// The name of the channel flow.
	//
	// Name is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ChannelFlow's
	// String and GoString methods.
	Name *string `min:"1" type:"string" sensitive:"true"`

	// Information about the processor Lambda functions.
	Processors []*Processor `min:"1" type:"list"`
	// contains filtered or unexported fields
}

The details of a channel flow.

func (ChannelFlow) GoString added in v1.41.6 

func (s ChannelFlow) 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 (*ChannelFlow) SetChannelFlowArn added in v1.41.6 

func (s *ChannelFlow) SetChannelFlowArn(v string) *ChannelFlow

SetChannelFlowArn sets the ChannelFlowArn field's value.

func (*ChannelFlow) SetCreatedTimestamp added in v1.41.6 

func (s *ChannelFlow) SetCreatedTimestamp(v time.Time) *ChannelFlow

SetCreatedTimestamp sets the CreatedTimestamp field's value.

func (*ChannelFlow) SetLastUpdatedTimestamp added in v1.41.6 

func (s *ChannelFlow) SetLastUpdatedTimestamp(v time.Time) *ChannelFlow

SetLastUpdatedTimestamp sets the LastUpdatedTimestamp field's value.

func (*ChannelFlow) SetName added in v1.41.6 

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

SetName sets the Name field's value.

func (*ChannelFlow) SetProcessors added in v1.41.6 

func (s *ChannelFlow) SetProcessors(v []*Processor) *ChannelFlow

SetProcessors sets the Processors field's value.

func (ChannelFlow) String added in v1.41.6 

func (s ChannelFlow) 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 ChannelFlowCallbackInput added in v1.41.6 

type ChannelFlowCallbackInput struct {

	// The identifier passed to the processor by the service when invoked. Use the
	// identifier to call back the service.
	CallbackId *string `min:"32" type:"string" idempotencyToken:"true"`

	// The ARN of the channel.
	//
	// ChannelArn is a required field
	ChannelArn *string `location:"uri" locationName:"channelArn" min:"5" type:"string" required:"true"`

	// Stores information about the processed message.
	//
	// ChannelMessage is a required field
	ChannelMessage *ChannelMessageCallback `type:"structure" required:"true"`

	// When a processor determines that a message needs to be DENIED, pass this
	// parameter with a value of true.
	DeleteResource *bool `type:"boolean"`
	// contains filtered or unexported fields
}

func (ChannelFlowCallbackInput) GoString added in v1.41.6 

func (s ChannelFlowCallbackInput) 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 (*ChannelFlowCallbackInput) SetCallbackId added in v1.41.6 

func (s *ChannelFlowCallbackInput) SetCallbackId(v string) *ChannelFlowCallbackInput

SetCallbackId sets the CallbackId field's value.

func (*ChannelFlowCallbackInput) SetChannelArn added in v1.41.6 

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

SetChannelArn sets the ChannelArn field's value.

func (*ChannelFlowCallbackInput) SetChannelMessage added in v1.41.6 

func (s *ChannelFlowCallbackInput) SetChannelMessage(v *ChannelMessageCallback) *ChannelFlowCallbackInput

SetChannelMessage sets the ChannelMessage field's value.

func (*ChannelFlowCallbackInput) SetDeleteResource added in v1.41.6 

func (s *ChannelFlowCallbackInput) SetDeleteResource(v bool) *ChannelFlowCallbackInput

SetDeleteResource sets the DeleteResource field's value.

func (ChannelFlowCallbackInput) String added in v1.41.6 

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

func (s *ChannelFlowCallbackInput) Validate() error

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

type ChannelFlowCallbackOutput added in v1.41.6 

type ChannelFlowCallbackOutput struct {

	// The call back ID passed in the request.
	CallbackId *string `min:"32" type:"string"`

	// The ARN of the channel.
	ChannelArn *string `min:"5" type:"string"`
	// contains filtered or unexported fields
}

func (ChannelFlowCallbackOutput) GoString added in v1.41.6 

func (s ChannelFlowCallbackOutput) 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 (*ChannelFlowCallbackOutput) SetCallbackId added in v1.41.6 

func (s *ChannelFlowCallbackOutput) SetCallbackId(v string) *ChannelFlowCallbackOutput

SetCallbackId sets the CallbackId field's value.

func (*ChannelFlowCallbackOutput) SetChannelArn added in v1.41.6 

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

SetChannelArn sets the ChannelArn field's value.

func (ChannelFlowCallbackOutput) String added in v1.41.6 

func (s ChannelFlowCallbackOutput) 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 ChannelFlowSummary added in v1.41.6 

type ChannelFlowSummary struct {

	// The ARN of the channel flow.
	ChannelFlowArn *string `min:"5" type:"string"`

	// The name of the channel flow.
	//
	// Name is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ChannelFlowSummary's
	// String and GoString methods.
	Name *string `min:"1" type:"string" sensitive:"true"`

	// Information about the processor Lambda functions.
	Processors []*Processor `min:"1" type:"list"`
	// contains filtered or unexported fields
}

Summary of details of a channel flow.

func (ChannelFlowSummary) GoString added in v1.41.6 

func (s ChannelFlowSummary) 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 (*ChannelFlowSummary) SetChannelFlowArn added in v1.41.6 

func (s *ChannelFlowSummary) SetChannelFlowArn(v string) *ChannelFlowSummary

SetChannelFlowArn sets the ChannelFlowArn field's value.

func (*ChannelFlowSummary) SetName added in v1.41.6 

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

SetName sets the Name field's value.

func (*ChannelFlowSummary) SetProcessors added in v1.41.6 

func (s *ChannelFlowSummary) SetProcessors(v []*Processor) *ChannelFlowSummary

SetProcessors sets the Processors field's value.

func (ChannelFlowSummary) String added in v1.41.6 

func (s ChannelFlowSummary) 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 ChannelMembership 

type ChannelMembership struct {

	// The ARN of the member's channel.
	ChannelArn *string `min:"5" type:"string"`

	// The time at which the channel membership was created.
	CreatedTimestamp *time.Time `type:"timestamp"`

	// The identifier of the member who invited another member.
	InvitedBy *Identity `type:"structure"`

	// The time at which a channel membership was last updated.
	LastUpdatedTimestamp *time.Time `type:"timestamp"`

	// The data of the channel member.
	Member *Identity `type:"structure"`

	// The ID of the SubChannel that a user belongs to.
	SubChannelId *string `min:"1" type:"string"`

	// The membership type set for the channel member.
	Type *string `type:"string" enum:"ChannelMembershipType"`
	// contains filtered or unexported fields
}

The details of a channel member.

func (ChannelMembership) GoString 

func (s ChannelMembership) 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 (*ChannelMembership) SetChannelArn 

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

SetChannelArn sets the ChannelArn field's value.

func (*ChannelMembership) SetCreatedTimestamp 

func (s *ChannelMembership) SetCreatedTimestamp(v time.Time) *ChannelMembership

SetCreatedTimestamp sets the CreatedTimestamp field's value.

func (*ChannelMembership) SetInvitedBy 

func (s *ChannelMembership) SetInvitedBy(v *Identity) *ChannelMembership

SetInvitedBy sets the InvitedBy field's value.

func (*ChannelMembership) SetLastUpdatedTimestamp 

func (s *ChannelMembership) SetLastUpdatedTimestamp(v time.Time) *ChannelMembership

SetLastUpdatedTimestamp sets the LastUpdatedTimestamp field's value.

func (*ChannelMembership) SetMember 

func (s *ChannelMembership) SetMember(v *Identity) *ChannelMembership

SetMember sets the Member field's value.

func (*ChannelMembership) SetSubChannelId added in v1.44.76 

func (s *ChannelMembership) SetSubChannelId(v string) *ChannelMembership

SetSubChannelId sets the SubChannelId field's value.

func (*ChannelMembership) SetType 

func (s *ChannelMembership) SetType(v string) *ChannelMembership

SetType sets the Type field's value.

func (ChannelMembership) String 

func (s ChannelMembership) 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 ChannelMembershipForAppInstanceUserSummary 

type ChannelMembershipForAppInstanceUserSummary struct {

	// Returns the channel membership data for an AppInstance.
	AppInstanceUserMembershipSummary *AppInstanceUserMembershipSummary `type:"structure"`

	// Returns the channel data for an AppInstance.
	ChannelSummary *ChannelSummary `type:"structure"`
	// contains filtered or unexported fields
}

Summary of the channel membership details of an AppInstanceUser.

func (ChannelMembershipForAppInstanceUserSummary) GoString 

func (s ChannelMembershipForAppInstanceUserSummary) 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 (*ChannelMembershipForAppInstanceUserSummary) SetAppInstanceUserMembershipSummary 

func (s *ChannelMembershipForAppInstanceUserSummary) SetAppInstanceUserMembershipSummary(v *AppInstanceUserMembershipSummary) *ChannelMembershipForAppInstanceUserSummary

SetAppInstanceUserMembershipSummary sets the AppInstanceUserMembershipSummary field's value.

func (*ChannelMembershipForAppInstanceUserSummary) SetChannelSummary 

func (s *ChannelMembershipForAppInstanceUserSummary) SetChannelSummary(v *ChannelSummary) *ChannelMembershipForAppInstanceUserSummary

SetChannelSummary sets the ChannelSummary field's value.

func (ChannelMembershipForAppInstanceUserSummary) String 

func (s ChannelMembershipForAppInstanceUserSummary) 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 ChannelMembershipPreferences added in v1.41.11 

type ChannelMembershipPreferences struct {

	// The push notification configuration of a message.
	PushNotifications *PushNotificationPreferences `type:"structure"`
	// contains filtered or unexported fields
}

The channel membership preferences for an AppInstanceUser.

func (ChannelMembershipPreferences) GoString added in v1.41.11 

func (s ChannelMembershipPreferences) 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 (*ChannelMembershipPreferences) SetPushNotifications added in v1.41.11 

func (s *ChannelMembershipPreferences) SetPushNotifications(v *PushNotificationPreferences) *ChannelMembershipPreferences

SetPushNotifications sets the PushNotifications field's value.

func (ChannelMembershipPreferences) String added in v1.41.11 

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

func (s *ChannelMembershipPreferences) Validate() error

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

type ChannelMembershipSummary 

type ChannelMembershipSummary struct {

	// A member's summary data.
	Member *Identity `type:"structure"`
	// contains filtered or unexported fields
}

Summary of the details of a ChannelMembership.

func (ChannelMembershipSummary) GoString 

func (s ChannelMembershipSummary) 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 (*ChannelMembershipSummary) SetMember 

func (s *ChannelMembershipSummary) SetMember(v *Identity) *ChannelMembershipSummary

SetMember sets the Member field's value.

func (ChannelMembershipSummary) String 

func (s ChannelMembershipSummary) 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 ChannelMessage 

type ChannelMessage struct {

	// The ARN of the channel.
	ChannelArn *string `min:"5" type:"string"`

	// The content of the channel message. For Amazon Lex V2 bot responses, this
	// field holds a list of messages originating from the bot. For more information,
	// refer to Processing responses from an AppInstanceBot (https://docs.aws.amazon.com/chime-sdk/latest/dg/appinstance-bots#process-response.html)
	// in the Amazon Chime SDK Messaging Developer Guide.
	//
	// Content is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ChannelMessage's
	// String and GoString methods.
	Content *string `type:"string" sensitive:"true"`

	// The content type of the channel message. For Amazon Lex V2 bot responses,
	// the content type is application/amz-chime-lex-msgs for success responses
	// and application/amz-chime-lex-error for failure responses. For more information,
	// refer to Processing responses from an AppInstanceBot (https://docs.aws.amazon.com/chime-sdk/latest/dg/appinstance-bots#process-response.html)
	// in the Amazon Chime SDK Messaging Developer Guide.
	//
	// ContentType is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ChannelMessage's
	// String and GoString methods.
	ContentType *string `type:"string" sensitive:"true"`

	// The time at which the message was created.
	CreatedTimestamp *time.Time `type:"timestamp"`

	// The time at which a message was edited.
	LastEditedTimestamp *time.Time `type:"timestamp"`

	// The time at which a message was updated.
	LastUpdatedTimestamp *time.Time `type:"timestamp"`

	// The attributes for the channel message. For Amazon Lex V2 bot responses,
	// the attributes are mapped to specific fields from the bot. For more information,
	// refer to Processing responses from an AppInstanceBot (https://docs.aws.amazon.com/chime-sdk/latest/dg/appinstance-bots#process-response.html)
	// in the Amazon Chime SDK Messaging Developer Guide.
	MessageAttributes map[string]*MessageAttributeValue `type:"map"`

	// The ID of a message.
	MessageId *string `min:"1" type:"string"`

	// The message metadata.
	//
	// Metadata is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ChannelMessage's
	// String and GoString methods.
	Metadata *string `type:"string" sensitive:"true"`

	// The persistence setting for a channel message.
	Persistence *string `type:"string" enum:"ChannelMessagePersistenceType"`

	// Hides the content of a message.
	Redacted *bool `type:"boolean"`

	// The message sender.
	Sender *Identity `type:"structure"`

	// The status of the channel message.
	Status *ChannelMessageStatusStructure `type:"structure"`

	// The ID of the SubChannel.
	SubChannelId *string `min:"1" type:"string"`

	// The target of a message, a sender, a user, or a bot. Only the target and
	// the sender can view targeted messages. Only users who can see targeted messages
	// can take actions on them. However, administrators can delete targeted messages
	// that they can’t see.
	Target []*Target `min:"1" type:"list"`

	// The message type.
	Type *string `type:"string" enum:"ChannelMessageType"`
	// contains filtered or unexported fields
}

The details of a message in a channel.

func (ChannelMessage) GoString 

func (s ChannelMessage) 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 (*ChannelMessage) SetChannelArn 

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

SetChannelArn sets the ChannelArn field's value.

func (*ChannelMessage) SetContent 

func (s *ChannelMessage) SetContent(v string) *ChannelMessage

SetContent sets the Content field's value.

func (*ChannelMessage) SetContentType added in v1.44.228 

func (s *ChannelMessage) SetContentType(v string) *ChannelMessage

SetContentType sets the ContentType field's value.

func (*ChannelMessage) SetCreatedTimestamp 

func (s *ChannelMessage) SetCreatedTimestamp(v time.Time) *ChannelMessage

SetCreatedTimestamp sets the CreatedTimestamp field's value.

func (*ChannelMessage) SetLastEditedTimestamp 

func (s *ChannelMessage) SetLastEditedTimestamp(v time.Time) *ChannelMessage

SetLastEditedTimestamp sets the LastEditedTimestamp field's value.

func (*ChannelMessage) SetLastUpdatedTimestamp 

func (s *ChannelMessage) SetLastUpdatedTimestamp(v time.Time) *ChannelMessage

SetLastUpdatedTimestamp sets the LastUpdatedTimestamp field's value.

func (*ChannelMessage) SetMessageAttributes added in v1.41.11 

func (s *ChannelMessage) SetMessageAttributes(v map[string]*MessageAttributeValue) *ChannelMessage

SetMessageAttributes sets the MessageAttributes field's value.

func (*ChannelMessage) SetMessageId 

func (s *ChannelMessage) SetMessageId(v string) *ChannelMessage

SetMessageId sets the MessageId field's value.

func (*ChannelMessage) SetMetadata 

func (s *ChannelMessage) SetMetadata(v string) *ChannelMessage

SetMetadata sets the Metadata field's value.

func (*ChannelMessage) SetPersistence 

func (s *ChannelMessage) SetPersistence(v string) *ChannelMessage

SetPersistence sets the Persistence field's value.

func (*ChannelMessage) SetRedacted 

func (s *ChannelMessage) SetRedacted(v bool) *ChannelMessage

SetRedacted sets the Redacted field's value.

func (*ChannelMessage) SetSender 

func (s *ChannelMessage) SetSender(v *Identity) *ChannelMessage

SetSender sets the Sender field's value.

func (*ChannelMessage) SetStatus added in v1.41.6 

func (s *ChannelMessage) SetStatus(v *ChannelMessageStatusStructure) *ChannelMessage

SetStatus sets the Status field's value.

func (*ChannelMessage) SetSubChannelId added in v1.44.76 

func (s *ChannelMessage) SetSubChannelId(v string) *ChannelMessage

SetSubChannelId sets the SubChannelId field's value.

func (*ChannelMessage) SetTarget added in v1.44.288 

func (s *ChannelMessage) SetTarget(v []*Target) *ChannelMessage

SetTarget sets the Target field's value.

func (*ChannelMessage) SetType 

func (s *ChannelMessage) SetType(v string) *ChannelMessage

SetType sets the Type field's value.

func (ChannelMessage) String 

func (s ChannelMessage) 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 ChannelMessageCallback added in v1.41.6 

type ChannelMessageCallback struct {

	// The message content. For Amazon Lex V2 bot responses, this field holds a
	// list of messages originating from the bot. For more information, refer to
	// Processing responses from an AppInstanceBot (https://docs.aws.amazon.com/chime-sdk/latest/dg/appinstance-bots#process-response.html)
	// in the Amazon Chime SDK Messaging Developer Guide.
	//
	// Content is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ChannelMessageCallback's
	// String and GoString methods.
	Content *string `min:"1" type:"string" sensitive:"true"`

	// The content type of the call-back message. For Amazon Lex V2 bot responses,
	// the content type is application/amz-chime-lex-msgs for success responses
	// and application/amz-chime-lex-error for failure responses. For more information,
	// refer to Processing responses from an AppInstanceBot (https://docs.aws.amazon.com/chime-sdk/latest/dg/appinstance-bots#process-response.html)
	// in the Amazon Chime SDK Messaging Developer Guide.
	//
	// ContentType is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ChannelMessageCallback's
	// String and GoString methods.
	ContentType *string `type:"string" sensitive:"true"`

	// The attributes for the channel message. For Amazon Lex V2 bot responses,
	// the attributes are mapped to specific fields from the bot. For more information,
	// refer to Processing responses from an AppInstanceBot (https://docs.aws.amazon.com/chime-sdk/latest/dg/appinstance-bots#process-response.html)
	// in the Amazon Chime SDK Messaging Developer Guide.
	MessageAttributes map[string]*MessageAttributeValue `type:"map"`

	// The message ID.
	//
	// MessageId is a required field
	MessageId *string `min:"1" type:"string" required:"true"`

	// The message metadata.
	//
	// Metadata is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ChannelMessageCallback's
	// String and GoString methods.
	Metadata *string `type:"string" sensitive:"true"`

	// The push notification configuration of the message.
	PushNotification *PushNotificationConfiguration `type:"structure"`

	// The ID of the SubChannel.
	SubChannelId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Stores information about a callback.

func (ChannelMessageCallback) GoString added in v1.41.6 

func (s ChannelMessageCallback) 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 (*ChannelMessageCallback) SetContent added in v1.41.6 

func (s *ChannelMessageCallback) SetContent(v string) *ChannelMessageCallback

SetContent sets the Content field's value.

func (*ChannelMessageCallback) SetContentType added in v1.44.228 

func (s *ChannelMessageCallback) SetContentType(v string) *ChannelMessageCallback

SetContentType sets the ContentType field's value.

func (*ChannelMessageCallback) SetMessageAttributes added in v1.42.25 

func (s *ChannelMessageCallback) SetMessageAttributes(v map[string]*MessageAttributeValue) *ChannelMessageCallback

SetMessageAttributes sets the MessageAttributes field's value.

func (*ChannelMessageCallback) SetMessageId added in v1.41.6 

func (s *ChannelMessageCallback) SetMessageId(v string) *ChannelMessageCallback

SetMessageId sets the MessageId field's value.

func (*ChannelMessageCallback) SetMetadata added in v1.41.6 

func (s *ChannelMessageCallback) SetMetadata(v string) *ChannelMessageCallback

SetMetadata sets the Metadata field's value.

func (*ChannelMessageCallback) SetPushNotification added in v1.42.25 

func (s *ChannelMessageCallback) SetPushNotification(v *PushNotificationConfiguration) *ChannelMessageCallback

SetPushNotification sets the PushNotification field's value.

func (*ChannelMessageCallback) SetSubChannelId added in v1.44.76 

func (s *ChannelMessageCallback) SetSubChannelId(v string) *ChannelMessageCallback

SetSubChannelId sets the SubChannelId field's value.

func (ChannelMessageCallback) String added in v1.41.6 

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

func (s *ChannelMessageCallback) Validate() error

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

type ChannelMessageStatusStructure added in v1.41.6 

type ChannelMessageStatusStructure struct {

	// Contains more details about the message status.
	Detail *string `type:"string"`

	// The message status value.
	Value *string `type:"string" enum:"ChannelMessageStatus"`
	// contains filtered or unexported fields
}

Stores information about a message status.

func (ChannelMessageStatusStructure) GoString added in v1.41.6 

func (s ChannelMessageStatusStructure) 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 (*ChannelMessageStatusStructure) SetDetail added in v1.41.6 

func (s *ChannelMessageStatusStructure) SetDetail(v string) *ChannelMessageStatusStructure

SetDetail sets the Detail field's value.

func (*ChannelMessageStatusStructure) SetValue added in v1.41.6 

func (s *ChannelMessageStatusStructure) SetValue(v string) *ChannelMessageStatusStructure

SetValue sets the Value field's value.

func (ChannelMessageStatusStructure) String added in v1.41.6 

func (s ChannelMessageStatusStructure) 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 ChannelMessageSummary 

type ChannelMessageSummary struct {

	// The content of the channel message. For Amazon Lex V2 bot responses, this
	// field holds a list of messages originating from the bot. For more information,
	// refer to Processing responses from an AppInstanceBot (https://docs.aws.amazon.com/chime-sdk/latest/dg/appinstance-bots#process-response.html)
	// in the Amazon Chime SDK Messaging Developer Guide.
	//
	// Content is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ChannelMessageSummary's
	// String and GoString methods.
	Content *string `type:"string" sensitive:"true"`

	// The content type of the channel message listed in the summary. For Amazon
	// Lex V2 bot responses, the content type is application/amz-chime-lex-msgs
	// for success responses and application/amz-chime-lex-error for failure responses.
	// For more information, refer to Processing responses from an AppInstanceBot
	// (https://docs.aws.amazon.com/chime-sdk/latest/dg/appinstance-bots#process-response.html)
	// in the Amazon Chime SDK Messaging Developer Guide.
	//
	// ContentType is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ChannelMessageSummary's
	// String and GoString methods.
	ContentType *string `type:"string" sensitive:"true"`

	// The time at which the message summary was created.
	CreatedTimestamp *time.Time `type:"timestamp"`

	// The time at which a message was last edited.
	LastEditedTimestamp *time.Time `type:"timestamp"`

	// The time at which a message was last updated.
	LastUpdatedTimestamp *time.Time `type:"timestamp"`

	// The attributes for the channel message. For Amazon Lex V2 bot responses,
	// the attributes are mapped to specific fields from the bot. For more information,
	// refer to Processing responses from an AppInstanceBot (https://docs.aws.amazon.com/chime-sdk/latest/dg/appinstance-bots#process-response.html)
	// in the Amazon Chime SDK Messaging Developer Guide.
	MessageAttributes map[string]*MessageAttributeValue `type:"map"`

	// The ID of the message.
	MessageId *string `min:"1" type:"string"`

	// The metadata of the message.
	//
	// Metadata is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ChannelMessageSummary's
	// String and GoString methods.
	Metadata *string `type:"string" sensitive:"true"`

	// Indicates whether a message was redacted.
	Redacted *bool `type:"boolean"`

	// The message sender.
	Sender *Identity `type:"structure"`

	// The message status. The status value is SENT for messages sent to a channel
	// without a channel flow. For channels associated with channel flow, the value
	// determines the processing stage.
	Status *ChannelMessageStatusStructure `type:"structure"`

	// The target of a message, a sender, a user, or a bot. Only the target and
	// the sender can view targeted messages. Only users who can see targeted messages
	// can take actions on them. However, administrators can delete targeted messages
	// that they can’t see.
	Target []*Target `min:"1" type:"list"`

	// The type of message.
	Type *string `type:"string" enum:"ChannelMessageType"`
	// contains filtered or unexported fields
}

Summary of the messages in a Channel.

func (ChannelMessageSummary) GoString 

func (s ChannelMessageSummary) 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 (*ChannelMessageSummary) SetContent 

func (s *ChannelMessageSummary) SetContent(v string) *ChannelMessageSummary

SetContent sets the Content field's value.

func (*ChannelMessageSummary) SetContentType added in v1.44.228 

func (s *ChannelMessageSummary) SetContentType(v string) *ChannelMessageSummary

SetContentType sets the ContentType field's value.

func (*ChannelMessageSummary) SetCreatedTimestamp 

func (s *ChannelMessageSummary) SetCreatedTimestamp(v time.Time) *ChannelMessageSummary

SetCreatedTimestamp sets the CreatedTimestamp field's value.

func (*ChannelMessageSummary) SetLastEditedTimestamp 

func (s *ChannelMessageSummary) SetLastEditedTimestamp(v time.Time) *ChannelMessageSummary

SetLastEditedTimestamp sets the LastEditedTimestamp field's value.

func (*ChannelMessageSummary) SetLastUpdatedTimestamp 

func (s *ChannelMessageSummary) SetLastUpdatedTimestamp(v time.Time) *ChannelMessageSummary

SetLastUpdatedTimestamp sets the LastUpdatedTimestamp field's value.

func (*ChannelMessageSummary) SetMessageAttributes added in v1.41.11 

func (s *ChannelMessageSummary) SetMessageAttributes(v map[string]*MessageAttributeValue) *ChannelMessageSummary

SetMessageAttributes sets the MessageAttributes field's value.

func (*ChannelMessageSummary) SetMessageId 

func (s *ChannelMessageSummary) SetMessageId(v string) *ChannelMessageSummary

SetMessageId sets the MessageId field's value.

func (*ChannelMessageSummary) SetMetadata 

func (s *ChannelMessageSummary) SetMetadata(v string) *ChannelMessageSummary

SetMetadata sets the Metadata field's value.

func (*ChannelMessageSummary) SetRedacted 

func (s *ChannelMessageSummary) SetRedacted(v bool) *ChannelMessageSummary

SetRedacted sets the Redacted field's value.

func (*ChannelMessageSummary) SetSender 

func (s *ChannelMessageSummary) SetSender(v *Identity) *ChannelMessageSummary

SetSender sets the Sender field's value.

func (*ChannelMessageSummary) SetStatus added in v1.41.6 

func (s *ChannelMessageSummary) SetStatus(v *ChannelMessageStatusStructure) *ChannelMessageSummary

SetStatus sets the Status field's value.

func (*ChannelMessageSummary) SetTarget added in v1.44.288 

func (s *ChannelMessageSummary) SetTarget(v []*Target) *ChannelMessageSummary

SetTarget sets the Target field's value.

func (*ChannelMessageSummary) SetType 

func (s *ChannelMessageSummary) SetType(v string) *ChannelMessageSummary

SetType sets the Type field's value.

func (ChannelMessageSummary) String 

func (s ChannelMessageSummary) 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 ChannelModeratedByAppInstanceUserSummary 

type ChannelModeratedByAppInstanceUserSummary struct {

	// Summary of the details of a Channel.
	ChannelSummary *ChannelSummary `type:"structure"`
	// contains filtered or unexported fields
}

Summary of the details of a moderated channel.

func (ChannelModeratedByAppInstanceUserSummary) GoString 

func (s ChannelModeratedByAppInstanceUserSummary) 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 (*ChannelModeratedByAppInstanceUserSummary) SetChannelSummary 

func (s *ChannelModeratedByAppInstanceUserSummary) SetChannelSummary(v *ChannelSummary) *ChannelModeratedByAppInstanceUserSummary

SetChannelSummary sets the ChannelSummary field's value.

func (ChannelModeratedByAppInstanceUserSummary) String 

func (s ChannelModeratedByAppInstanceUserSummary) 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 ChannelModerator 

type ChannelModerator struct {

	// The ARN of the moderator's channel.
	ChannelArn *string `min:"5" type:"string"`

	// The AppInstanceUser who created the moderator.
	CreatedBy *Identity `type:"structure"`

	// The time at which the moderator was created.
	CreatedTimestamp *time.Time `type:"timestamp"`

	// The moderator's data.
	Moderator *Identity `type:"structure"`
	// contains filtered or unexported fields
}

The details of a channel moderator.

func (ChannelModerator) GoString 

func (s ChannelModerator) 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 (*ChannelModerator) SetChannelArn 

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

SetChannelArn sets the ChannelArn field's value.

func (*ChannelModerator) SetCreatedBy 

func (s *ChannelModerator) SetCreatedBy(v *Identity) *ChannelModerator

SetCreatedBy sets the CreatedBy field's value.

func (*ChannelModerator) SetCreatedTimestamp 

func (s *ChannelModerator) SetCreatedTimestamp(v time.Time) *ChannelModerator

SetCreatedTimestamp sets the CreatedTimestamp field's value.

func (*ChannelModerator) SetModerator 

func (s *ChannelModerator) SetModerator(v *Identity) *ChannelModerator

SetModerator sets the Moderator field's value.

func (ChannelModerator) String 

func (s ChannelModerator) 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 ChannelModeratorSummary 

type ChannelModeratorSummary struct {

	// The data for a moderator.
	Moderator *Identity `type:"structure"`
	// contains filtered or unexported fields
}

Summary of the details of a ChannelModerator.

func (ChannelModeratorSummary) GoString 

func (s ChannelModeratorSummary) 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 (*ChannelModeratorSummary) SetModerator 

func (s *ChannelModeratorSummary) SetModerator(v *Identity) *ChannelModeratorSummary

SetModerator sets the Moderator field's value.

func (ChannelModeratorSummary) String 

func (s ChannelModeratorSummary) 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 ChannelSummary 

type ChannelSummary struct {

	// The ARN of the channel.
	ChannelArn *string `min:"5" type:"string"`

	// The time at which the last persistent message visible to the caller in a
	// channel was sent.
	LastMessageTimestamp *time.Time `type:"timestamp"`

	// The metadata of the channel.
	//
	// Metadata is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ChannelSummary's
	// String and GoString methods.
	Metadata *string `type:"string" sensitive:"true"`

	// The mode of the channel.
	Mode *string `type:"string" enum:"ChannelMode"`

	// The name of the channel.
	//
	// Name is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ChannelSummary's
	// String and GoString methods.
	Name *string `min:"1" type:"string" sensitive:"true"`

	// The privacy setting of the channel.
	Privacy *string `type:"string" enum:"ChannelPrivacy"`
	// contains filtered or unexported fields
}

Summary of the details of a Channel.

func (ChannelSummary) GoString 

func (s ChannelSummary) 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 (*ChannelSummary) SetChannelArn 

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

SetChannelArn sets the ChannelArn field's value.

func (*ChannelSummary) SetLastMessageTimestamp 

func (s *ChannelSummary) SetLastMessageTimestamp(v time.Time) *ChannelSummary

SetLastMessageTimestamp sets the LastMessageTimestamp field's value.

func (*ChannelSummary) SetMetadata 

func (s *ChannelSummary) SetMetadata(v string) *ChannelSummary

SetMetadata sets the Metadata field's value.

func (*ChannelSummary) SetMode 

func (s *ChannelSummary) SetMode(v string) *ChannelSummary

SetMode sets the Mode field's value.

func (*ChannelSummary) SetName 

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

SetName sets the Name field's value.

func (*ChannelSummary) SetPrivacy 

func (s *ChannelSummary) SetPrivacy(v string) *ChannelSummary

SetPrivacy sets the Privacy field's value.

func (ChannelSummary) String 

func (s ChannelSummary) 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 ChimeSDKMessaging 

type ChimeSDKMessaging struct {
	*client.Client
}

ChimeSDKMessaging provides the API operation methods for making requests to Amazon Chime SDK Messaging. See this package's package overview docs for details on the service.

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

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

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

func (*ChimeSDKMessaging) AssociateChannelFlow added in v1.41.6 

func (c *ChimeSDKMessaging) AssociateChannelFlow(input *AssociateChannelFlowInput) (*AssociateChannelFlowOutput, error)

AssociateChannelFlow API operation for Amazon Chime SDK Messaging.

Associates a channel flow with a channel. Once associated, all messages to that channel go through channel flow processors. To stop processing, use the DisassociateChannelFlow API.

Only administrators or channel moderators can associate a channel flow. The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

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 Chime SDK Messaging's API operation AssociateChannelFlow for usage and error information.

Returned Error Types:

  • BadRequestException The input parameters don't match the service's restrictions.

  • ForbiddenException The client is permanently forbidden from making the request.

  • NotFoundException One or more of the resources in the request does not exist in the system.

  • UnauthorizedClientException The client is not currently authorized to make the request.

  • ConflictException The request could not be processed because of conflict in the current state of the resource.

  • ThrottledClientException The client exceeded its request rate limit.

  • ServiceUnavailableException The service is currently unavailable.

  • ServiceFailureException The service encountered an unexpected error.

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/AssociateChannelFlow

func (*ChimeSDKMessaging) AssociateChannelFlowRequest added in v1.41.6 

func (c *ChimeSDKMessaging) AssociateChannelFlowRequest(input *AssociateChannelFlowInput) (req *request.Request, output *AssociateChannelFlowOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/AssociateChannelFlow

func (*ChimeSDKMessaging) AssociateChannelFlowWithContext added in v1.41.6 

func (c *ChimeSDKMessaging) AssociateChannelFlowWithContext(ctx aws.Context, input *AssociateChannelFlowInput, opts ...request.Option) (*AssociateChannelFlowOutput, error)

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

See AssociateChannelFlow 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 (*ChimeSDKMessaging) BatchCreateChannelMembership 

func (c *ChimeSDKMessaging) BatchCreateChannelMembership(input *BatchCreateChannelMembershipInput) (*BatchCreateChannelMembershipOutput, error)

BatchCreateChannelMembership API operation for Amazon Chime SDK Messaging.

Adds a specified number of users and bots to a channel.

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 Chime SDK Messaging's API operation BatchCreateChannelMembership for usage and error information.

Returned Error Types:

  • ServiceFailureException The service encountered an unexpected error.

  • ServiceUnavailableException The service is currently unavailable.

  • UnauthorizedClientException The client is not currently authorized to make the request.

  • BadRequestException The input parameters don't match the service's restrictions.

  • NotFoundException One or more of the resources in the request does not exist in the system.

  • ForbiddenException The client is permanently forbidden from making the request.

  • ThrottledClientException The client exceeded its request rate limit.

  • ResourceLimitExceededException The request exceeds the resource limit.

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/BatchCreateChannelMembership

func (*ChimeSDKMessaging) BatchCreateChannelMembershipRequest 

func (c *ChimeSDKMessaging) BatchCreateChannelMembershipRequest(input *BatchCreateChannelMembershipInput) (req *request.Request, output *BatchCreateChannelMembershipOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/BatchCreateChannelMembership

func (*ChimeSDKMessaging) BatchCreateChannelMembershipWithContext 

func (c *ChimeSDKMessaging) BatchCreateChannelMembershipWithContext(ctx aws.Context, input *BatchCreateChannelMembershipInput, opts ...request.Option) (*BatchCreateChannelMembershipOutput, error)

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

See BatchCreateChannelMembership 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 (*ChimeSDKMessaging) ChannelFlowCallback added in v1.41.6 

func (c *ChimeSDKMessaging) ChannelFlowCallback(input *ChannelFlowCallbackInput) (*ChannelFlowCallbackOutput, error)

ChannelFlowCallback API operation for Amazon Chime SDK Messaging.

Calls back Amazon Chime SDK messaging with a processing response message. This should be invoked from the processor Lambda. This is a developer API.

You can return one of the following processing responses:

  • Update message content or metadata

  • Deny a message

  • Make no changes to the message

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 Chime SDK Messaging's API operation ChannelFlowCallback for usage and error information.

Returned Error Types:

  • BadRequestException The input parameters don't match the service's restrictions.

  • ForbiddenException The client is permanently forbidden from making the request.

  • UnauthorizedClientException The client is not currently authorized to make the request.

  • ConflictException The request could not be processed because of conflict in the current state of the resource.

  • ThrottledClientException The client exceeded its request rate limit.

  • ServiceUnavailableException The service is currently unavailable.

  • ServiceFailureException The service encountered an unexpected error.

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ChannelFlowCallback

func (*ChimeSDKMessaging) ChannelFlowCallbackRequest added in v1.41.6 

func (c *ChimeSDKMessaging) ChannelFlowCallbackRequest(input *ChannelFlowCallbackInput) (req *request.Request, output *ChannelFlowCallbackOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ChannelFlowCallback

func (*ChimeSDKMessaging) ChannelFlowCallbackWithContext added in v1.41.6 

func (c *ChimeSDKMessaging) ChannelFlowCallbackWithContext(ctx aws.Context, input *ChannelFlowCallbackInput, opts ...request.Option) (*ChannelFlowCallbackOutput, error)

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

See ChannelFlowCallback 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 (*ChimeSDKMessaging) CreateChannel 

func (c *ChimeSDKMessaging) CreateChannel(input *CreateChannelInput) (*CreateChannelOutput, error)

CreateChannel API operation for Amazon Chime SDK Messaging.

Creates a channel to which you can add users and send messages.

Restriction: You can't change a channel's privacy.

The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

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 Chime SDK Messaging's API operation CreateChannel for usage and error information.

Returned Error Types:

  • BadRequestException The input parameters don't match the service's restrictions.

  • ForbiddenException The client is permanently forbidden from making the request.

  • UnauthorizedClientException The client is not currently authorized to make the request.

  • ConflictException The request could not be processed because of conflict in the current state of the resource.

  • ResourceLimitExceededException The request exceeds the resource limit.

  • ThrottledClientException The client exceeded its request rate limit.

  • ServiceUnavailableException The service is currently unavailable.

  • ServiceFailureException The service encountered an unexpected error.

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/CreateChannel

func (*ChimeSDKMessaging) CreateChannelBan 

func (c *ChimeSDKMessaging) CreateChannelBan(input *CreateChannelBanInput) (*CreateChannelBanOutput, error)

CreateChannelBan API operation for Amazon Chime SDK Messaging.

Permanently bans a member from a channel. Moderators can't add banned members to a channel. To undo a ban, you first have to DeleteChannelBan, and then CreateChannelMembership. Bans are cleaned up when you delete users or channels.

If you ban a user who is already part of a channel, that user is automatically kicked from the channel.

The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

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 Chime SDK Messaging's API operation CreateChannelBan for usage and error information.

Returned Error Types:

  • BadRequestException The input parameters don't match the service's restrictions.

  • ForbiddenException The client is permanently forbidden from making the request.

  • UnauthorizedClientException The client is not currently authorized to make the request.

  • ConflictException The request could not be processed because of conflict in the current state of the resource.

  • ResourceLimitExceededException The request exceeds the resource limit.

  • ThrottledClientException The client exceeded its request rate limit.

  • ServiceUnavailableException The service is currently unavailable.

  • ServiceFailureException The service encountered an unexpected error.

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/CreateChannelBan

func (*ChimeSDKMessaging) CreateChannelBanRequest 

func (c *ChimeSDKMessaging) CreateChannelBanRequest(input *CreateChannelBanInput) (req *request.Request, output *CreateChannelBanOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/CreateChannelBan

func (*ChimeSDKMessaging) CreateChannelBanWithContext 

func (c *ChimeSDKMessaging) CreateChannelBanWithContext(ctx aws.Context, input *CreateChannelBanInput, opts ...request.Option) (*CreateChannelBanOutput, error)

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

See CreateChannelBan 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 (*ChimeSDKMessaging) CreateChannelFlow added in v1.41.6 

func (c *ChimeSDKMessaging) CreateChannelFlow(input *CreateChannelFlowInput) (*CreateChannelFlowOutput, error)

CreateChannelFlow API operation for Amazon Chime SDK Messaging.

Creates a channel flow, a container for processors. Processors are AWS Lambda functions that perform actions on chat messages, such as stripping out profanity. You can associate channel flows with channels, and the processors in the channel flow then take action on all messages sent to that channel. This is a developer API.

Channel flows process the following items:

New and updated messages

Persistent and non-persistent messages

The Standard message type

Channel flows don't process Control or System messages. For more information about the message types provided by Chime SDK messaging, refer to Message types (https://docs.aws.amazon.com/chime/latest/dg/using-the-messaging-sdk.html#msg-types) in the Amazon Chime developer guide.

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 Chime SDK Messaging's API operation CreateChannelFlow for usage and error information.

Returned Error Types:

  • BadRequestException The input parameters don't match the service's restrictions.

  • ForbiddenException The client is permanently forbidden from making the request.

  • UnauthorizedClientException The client is not currently authorized to make the request.

  • ConflictException The request could not be processed because of conflict in the current state of the resource.

  • ResourceLimitExceededException The request exceeds the resource limit.

  • ThrottledClientException The client exceeded its request rate limit.

  • ServiceUnavailableException The service is currently unavailable.

  • ServiceFailureException The service encountered an unexpected error.

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/CreateChannelFlow

func (*ChimeSDKMessaging) CreateChannelFlowRequest added in v1.41.6 

func (c *ChimeSDKMessaging) CreateChannelFlowRequest(input *CreateChannelFlowInput) (req *request.Request, output *CreateChannelFlowOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/CreateChannelFlow

func (*ChimeSDKMessaging) CreateChannelFlowWithContext added in v1.41.6 

func (c *ChimeSDKMessaging) CreateChannelFlowWithContext(ctx aws.Context, input *CreateChannelFlowInput, opts ...request.Option) (*CreateChannelFlowOutput, error)

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

See CreateChannelFlow 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 (*ChimeSDKMessaging) CreateChannelMembership 

func (c *ChimeSDKMessaging) CreateChannelMembership(input *CreateChannelMembershipInput) (*CreateChannelMembershipOutput, error)

CreateChannelMembership API operation for Amazon Chime SDK Messaging.

Adds a member to a channel. The InvitedBy field in ChannelMembership is derived from the request header. A channel member can:

  • List messages

  • Send messages

  • Receive messages

  • Edit their own messages

  • Leave the channel

Privacy settings impact this action as follows:

  • Public Channels: You do not need to be a member to list messages, but you must be a member to send messages.

  • Private Channels: You must be a member to list or send messages.

The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUserArn or AppInstanceBot that makes the API call as the value in the header.

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 Chime SDK Messaging's API operation CreateChannelMembership for usage and error information.

Returned Error Types:

  • BadRequestException The input parameters don't match the service's restrictions.

  • NotFoundException One or more of the resources in the request does not exist in the system.

  • ForbiddenException The client is permanently forbidden from making the request.

  • UnauthorizedClientException The client is not currently authorized to make the request.

  • ConflictException The request could not be processed because of conflict in the current state of the resource.

  • ResourceLimitExceededException The request exceeds the resource limit.

  • ThrottledClientException The client exceeded its request rate limit.

  • ServiceUnavailableException The service is currently unavailable.

  • ServiceFailureException The service encountered an unexpected error.

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/CreateChannelMembership

func (*ChimeSDKMessaging) CreateChannelMembershipRequest 

func (c *ChimeSDKMessaging) CreateChannelMembershipRequest(input *CreateChannelMembershipInput) (req *request.Request, output *CreateChannelMembershipOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/CreateChannelMembership

func (*ChimeSDKMessaging) CreateChannelMembershipWithContext 

func (c *ChimeSDKMessaging) CreateChannelMembershipWithContext(ctx aws.Context, input *CreateChannelMembershipInput, opts ...request.Option) (*CreateChannelMembershipOutput, error)

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

See CreateChannelMembership 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 (*ChimeSDKMessaging) CreateChannelModerator 

func (c *ChimeSDKMessaging) CreateChannelModerator(input *CreateChannelModeratorInput) (*CreateChannelModeratorOutput, error)

CreateChannelModerator API operation for Amazon Chime SDK Messaging.

Creates a new ChannelModerator. A channel moderator can:

  • Add and remove other members of the channel.

  • Add and remove other moderators of the channel.

  • Add and remove user bans for the channel.

  • Redact messages in the channel.

  • List messages in the channel.

The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBotof the user that makes the API call as the value in the header.

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 Chime SDK Messaging's API operation CreateChannelModerator for usage and error information.

Returned Error Types:

  • BadRequestException The input parameters don't match the service's restrictions.

  • ForbiddenException The client is permanently forbidden from making the request.

  • UnauthorizedClientException The client is not currently authorized to make the request.

  • ConflictException The request could not be processed because of conflict in the current state of the resource.

  • ResourceLimitExceededException The request exceeds the resource limit.

  • ThrottledClientException The client exceeded its request rate limit.

  • ServiceUnavailableException The service is currently unavailable.

  • ServiceFailureException The service encountered an unexpected error.

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/CreateChannelModerator

func (*ChimeSDKMessaging) CreateChannelModeratorRequest 

func (c *ChimeSDKMessaging) CreateChannelModeratorRequest(input *CreateChannelModeratorInput) (req *request.Request, output *CreateChannelModeratorOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/CreateChannelModerator

func (*ChimeSDKMessaging) CreateChannelModeratorWithContext 

func (c *ChimeSDKMessaging) CreateChannelModeratorWithContext(ctx aws.Context, input *CreateChannelModeratorInput, opts ...request.Option) (*CreateChannelModeratorOutput, error)

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

See CreateChannelModerator 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 (*ChimeSDKMessaging) CreateChannelRequest 

func (c *ChimeSDKMessaging) CreateChannelRequest(input *CreateChannelInput) (req *request.Request, output *CreateChannelOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/CreateChannel

func (*ChimeSDKMessaging) CreateChannelWithContext 

func (c *ChimeSDKMessaging) CreateChannelWithContext(ctx aws.Context, input *CreateChannelInput, opts ...request.Option) (*CreateChannelOutput, error)

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

See CreateChannel 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 (*ChimeSDKMessaging) DeleteChannel 

func (c *ChimeSDKMessaging) DeleteChannel(input *DeleteChannelInput) (*DeleteChannelOutput, error)

DeleteChannel API operation for Amazon Chime SDK Messaging.

Immediately makes a channel and its memberships inaccessible and marks them for deletion. This is an irreversible process.

The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUserArn or AppInstanceBot that makes the API call as the value in the header.

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 Chime SDK Messaging's API operation DeleteChannel for usage and error information.

Returned Error Types:

  • BadRequestException The input parameters don't match the service's restrictions.

  • ForbiddenException The client is permanently forbidden from making the request.

  • ConflictException The request could not be processed because of conflict in the current state of the resource.

  • UnauthorizedClientException The client is not currently authorized to make the request.

  • ThrottledClientException The client exceeded its request rate limit.

  • ServiceUnavailableException The service is currently unavailable.

  • ServiceFailureException The service encountered an unexpected error.

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/DeleteChannel

func (*ChimeSDKMessaging) DeleteChannelBan 

func (c *ChimeSDKMessaging) DeleteChannelBan(input *DeleteChannelBanInput) (*DeleteChannelBanOutput, error)

DeleteChannelBan API operation for Amazon Chime SDK Messaging.

Removes a member from a channel's ban list.

The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

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 Chime SDK Messaging's API operation DeleteChannelBan for usage and error information.

Returned Error Types:

  • BadRequestException The input parameters don't match the service's restrictions.

  • ForbiddenException The client is permanently forbidden from making the request.

  • UnauthorizedClientException The client is not currently authorized to make the request.

  • ThrottledClientException The client exceeded its request rate limit.

  • ServiceUnavailableException The service is currently unavailable.

  • ServiceFailureException The service encountered an unexpected error.

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/DeleteChannelBan

func (*ChimeSDKMessaging) DeleteChannelBanRequest 

func (c *ChimeSDKMessaging) DeleteChannelBanRequest(input *DeleteChannelBanInput) (req *request.Request, output *DeleteChannelBanOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/DeleteChannelBan

func (*ChimeSDKMessaging) DeleteChannelBanWithContext 

func (c *ChimeSDKMessaging) DeleteChannelBanWithContext(ctx aws.Context, input *DeleteChannelBanInput, opts ...request.Option) (*DeleteChannelBanOutput, error)

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

See DeleteChannelBan 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 (*ChimeSDKMessaging) DeleteChannelFlow added in v1.41.6 

func (c *ChimeSDKMessaging) DeleteChannelFlow(input *DeleteChannelFlowInput) (*DeleteChannelFlowOutput, error)

DeleteChannelFlow API operation for Amazon Chime SDK Messaging.

Deletes a channel flow, an irreversible process. This is a developer API.

This API works only when the channel flow is not associated with any channel. To get a list of all channels that a channel flow is associated with, use the ListChannelsAssociatedWithChannelFlow API. Use the DisassociateChannelFlow API to disassociate a channel flow from all channels.

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 Chime SDK Messaging's API operation DeleteChannelFlow for usage and error information.

Returned Error Types:

  • BadRequestException The input parameters don't match the service's restrictions.

  • ForbiddenException The client is permanently forbidden from making the request.

  • UnauthorizedClientException The client is not currently authorized to make the request.

  • ThrottledClientException The client exceeded its request rate limit.

  • ConflictException The request could not be processed because of conflict in the current state of the resource.

  • ServiceUnavailableException The service is currently unavailable.

  • ServiceFailureException The service encountered an unexpected error.

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/DeleteChannelFlow

func (*ChimeSDKMessaging) DeleteChannelFlowRequest added in v1.41.6 

func (c *ChimeSDKMessaging) DeleteChannelFlowRequest(input *DeleteChannelFlowInput) (req *request.Request, output *DeleteChannelFlowOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/DeleteChannelFlow

func (*ChimeSDKMessaging) DeleteChannelFlowWithContext added in v1.41.6 

func (c *ChimeSDKMessaging) DeleteChannelFlowWithContext(ctx aws.Context, input *DeleteChannelFlowInput, opts ...request.Option) (*DeleteChannelFlowOutput, error)

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

See DeleteChannelFlow 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 (*ChimeSDKMessaging) DeleteChannelMembership 

func (c *ChimeSDKMessaging) DeleteChannelMembership(input *DeleteChannelMembershipInput) (*DeleteChannelMembershipOutput, error)

DeleteChannelMembership API operation for Amazon Chime SDK Messaging.

Removes a member from a channel.

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

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 Chime SDK Messaging's API operation DeleteChannelMembership for usage and error information.

Returned Error Types:

  • BadRequestException The input parameters don't match the service's restrictions.

  • ForbiddenException The client is permanently forbidden from making the request.

  • UnauthorizedClientException The client is not currently authorized to make the request.

  • ConflictException The request could not be processed because of conflict in the current state of the resource.

  • ThrottledClientException The client exceeded its request rate limit.

  • ServiceUnavailableException The service is currently unavailable.

  • ServiceFailureException The service encountered an unexpected error.

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/DeleteChannelMembership

func (*ChimeSDKMessaging) DeleteChannelMembershipRequest 

func (c *ChimeSDKMessaging) DeleteChannelMembershipRequest(input *DeleteChannelMembershipInput) (req *request.Request, output *DeleteChannelMembershipOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/DeleteChannelMembership

func (*ChimeSDKMessaging) DeleteChannelMembershipWithContext 

func (c *ChimeSDKMessaging) DeleteChannelMembershipWithContext(ctx aws.Context, input *DeleteChannelMembershipInput, opts ...request.Option) (*DeleteChannelMembershipOutput, error)

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

See DeleteChannelMembership 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 (*ChimeSDKMessaging) DeleteChannelMessage 

func (c *ChimeSDKMessaging) DeleteChannelMessage(input *DeleteChannelMessageInput) (*DeleteChannelMessageOutput, error)

DeleteChannelMessage API operation for Amazon Chime SDK Messaging.

Deletes a channel message. Only admins can perform this action. Deletion makes messages inaccessible immediately. A background process deletes any revisions created by UpdateChannelMessage.

The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

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 Chime SDK Messaging's API operation DeleteChannelMessage for usage and error information.

Returned Error Types:

  • BadRequestException The input parameters don't match the service's restrictions.

  • ForbiddenException The client is permanently forbidden from making the request.

  • UnauthorizedClientException The client is not currently authorized to make the request.

  • ThrottledClientException The client exceeded its request rate limit.

  • ServiceUnavailableException The service is currently unavailable.

  • ServiceFailureException The service encountered an unexpected error.

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/DeleteChannelMessage

func (*ChimeSDKMessaging) DeleteChannelMessageRequest 

func (c *ChimeSDKMessaging) DeleteChannelMessageRequest(input *DeleteChannelMessageInput) (req *request.Request, output *DeleteChannelMessageOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/DeleteChannelMessage

func (*ChimeSDKMessaging) DeleteChannelMessageWithContext 

func (c *ChimeSDKMessaging) DeleteChannelMessageWithContext(ctx aws.Context, input *DeleteChannelMessageInput, opts ...request.Option) (*DeleteChannelMessageOutput, error)

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

See DeleteChannelMessage 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 (*ChimeSDKMessaging) DeleteChannelModerator 

func (c *ChimeSDKMessaging) DeleteChannelModerator(input *DeleteChannelModeratorInput) (*DeleteChannelModeratorOutput, error)

DeleteChannelModerator API operation for Amazon Chime SDK Messaging.

Deletes a channel moderator.

The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

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 Chime SDK Messaging's API operation DeleteChannelModerator for usage and error information.

Returned Error Types:

  • BadRequestException The input parameters don't match the service's restrictions.

  • ForbiddenException The client is permanently forbidden from making the request.

  • UnauthorizedClientException The client is not currently authorized to make the request.

  • ThrottledClientException The client exceeded its request rate limit.

  • ServiceUnavailableException The service is currently unavailable.

  • ServiceFailureException The service encountered an unexpected error.

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/DeleteChannelModerator

func (*ChimeSDKMessaging) DeleteChannelModeratorRequest 

func (c *ChimeSDKMessaging) DeleteChannelModeratorRequest(input *DeleteChannelModeratorInput) (req *request.Request, output *DeleteChannelModeratorOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/DeleteChannelModerator

func (*ChimeSDKMessaging) DeleteChannelModeratorWithContext 

func (c *ChimeSDKMessaging) DeleteChannelModeratorWithContext(ctx aws.Context, input *DeleteChannelModeratorInput, opts ...request.Option) (*DeleteChannelModeratorOutput, error)

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

See DeleteChannelModerator 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 (*ChimeSDKMessaging) DeleteChannelRequest 

func (c *ChimeSDKMessaging) DeleteChannelRequest(input *DeleteChannelInput) (req *request.Request, output *DeleteChannelOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/DeleteChannel

func (*ChimeSDKMessaging) DeleteChannelWithContext 

func (c *ChimeSDKMessaging) DeleteChannelWithContext(ctx aws.Context, input *DeleteChannelInput, opts ...request.Option) (*DeleteChannelOutput, error)

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

See DeleteChannel 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 (*ChimeSDKMessaging) DeleteMessagingStreamingConfigurations added in v1.44.226 

func (c *ChimeSDKMessaging) DeleteMessagingStreamingConfigurations(input *DeleteMessagingStreamingConfigurationsInput) (*DeleteMessagingStreamingConfigurationsOutput, error)

DeleteMessagingStreamingConfigurations API operation for Amazon Chime SDK Messaging.

Deletes the streaming configurations for an AppInstance. For more information, see Streaming messaging data (https://docs.aws.amazon.com/chime-sdk/latest/dg/streaming-export.html) in the Amazon Chime SDK Developer Guide.

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 Chime SDK Messaging's API operation DeleteMessagingStreamingConfigurations for usage and error information.

Returned Error Types:

  • BadRequestException The input parameters don't match the service's restrictions.

  • ForbiddenException The client is permanently forbidden from making the request.

  • UnauthorizedClientException The client is not currently authorized to make the request.

  • ThrottledClientException The client exceeded its request rate limit.

  • ServiceUnavailableException The service is currently unavailable.

  • ServiceFailureException The service encountered an unexpected error.

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/DeleteMessagingStreamingConfigurations

func (*ChimeSDKMessaging) DeleteMessagingStreamingConfigurationsRequest added in v1.44.226 

func (c *ChimeSDKMessaging) DeleteMessagingStreamingConfigurationsRequest(input *DeleteMessagingStreamingConfigurationsInput) (req *request.Request, output *DeleteMessagingStreamingConfigurationsOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/DeleteMessagingStreamingConfigurations

func (*ChimeSDKMessaging) DeleteMessagingStreamingConfigurationsWithContext added in v1.44.226 

func (c *ChimeSDKMessaging) DeleteMessagingStreamingConfigurationsWithContext(ctx aws.Context, input *DeleteMessagingStreamingConfigurationsInput, opts ...request.Option) (*DeleteMessagingStreamingConfigurationsOutput, error)

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

See DeleteMessagingStreamingConfigurations 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 (*ChimeSDKMessaging) DescribeChannel 

func (c *ChimeSDKMessaging) DescribeChannel(input *DescribeChannelInput) (*DescribeChannelOutput, error)

DescribeChannel API operation for Amazon Chime SDK Messaging.

Returns the full details of a channel in an Amazon Chime AppInstance.

The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

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 Chime SDK Messaging's API operation DescribeChannel for usage and error information.

Returned Error Types:

  • BadRequestException The input parameters don't match the service's restrictions.

  • ForbiddenException The client is permanently forbidden from making the request.

  • UnauthorizedClientException The client is not currently authorized to make the request.

  • ThrottledClientException The client exceeded its request rate limit.

  • ServiceUnavailableException The service is currently unavailable.

  • ServiceFailureException The service encountered an unexpected error.

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/DescribeChannel

func (*ChimeSDKMessaging) DescribeChannelBan 

func (c *ChimeSDKMessaging) DescribeChannelBan(input *DescribeChannelBanInput) (*DescribeChannelBanOutput, error)

DescribeChannelBan API operation for Amazon Chime SDK Messaging.

Returns the full details of a channel ban.

The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

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 Chime SDK Messaging's API operation DescribeChannelBan for usage and error information.

Returned Error Types:

  • BadRequestException The input parameters don't match the service's restrictions.

  • ForbiddenException The client is permanently forbidden from making the request.

  • NotFoundException One or more of the resources in the request does not exist in the system.

  • UnauthorizedClientException The client is not currently authorized to make the request.

  • ThrottledClientException The client exceeded its request rate limit.

  • ServiceUnavailableException The service is currently unavailable.

  • ServiceFailureException The service encountered an unexpected error.

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/DescribeChannelBan

func (*ChimeSDKMessaging) DescribeChannelBanRequest 

func (c *ChimeSDKMessaging) DescribeChannelBanRequest(input *DescribeChannelBanInput) (req *request.Request, output *DescribeChannelBanOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/DescribeChannelBan

func (*ChimeSDKMessaging) DescribeChannelBanWithContext 

func (c *ChimeSDKMessaging) DescribeChannelBanWithContext(ctx aws.Context, input *DescribeChannelBanInput, opts ...request.Option) (*DescribeChannelBanOutput, error)

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

See DescribeChannelBan 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 (*ChimeSDKMessaging) DescribeChannelFlow added in v1.41.6 

func (c *ChimeSDKMessaging) DescribeChannelFlow(input *DescribeChannelFlowInput) (*DescribeChannelFlowOutput, error)

DescribeChannelFlow API operation for Amazon Chime SDK Messaging.

Returns the full details of a channel flow in an Amazon Chime AppInstance. This is a developer 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 Chime SDK Messaging's API operation DescribeChannelFlow for usage and error information.

Returned Error Types:

  • BadRequestException The input parameters don't match the service's restrictions.

  • ForbiddenException The client is permanently forbidden from making the request.

  • UnauthorizedClientException The client is not currently authorized to make the request.

  • ThrottledClientException The client exceeded its request rate limit.

  • ServiceUnavailableException The service is currently unavailable.

  • ServiceFailureException The service encountered an unexpected error.

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/DescribeChannelFlow

func (*ChimeSDKMessaging) DescribeChannelFlowRequest added in v1.41.6 

func (c *ChimeSDKMessaging) DescribeChannelFlowRequest(input *DescribeChannelFlowInput) (req *request.Request, output *DescribeChannelFlowOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/DescribeChannelFlow

func (*ChimeSDKMessaging) DescribeChannelFlowWithContext added in v1.41.6 

func (c *ChimeSDKMessaging) DescribeChannelFlowWithContext(ctx aws.Context, input *DescribeChannelFlowInput, opts ...request.Option) (*DescribeChannelFlowOutput, error)

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

See DescribeChannelFlow 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 (*ChimeSDKMessaging) DescribeChannelMembership 

func (c *ChimeSDKMessaging) DescribeChannelMembership(input *DescribeChannelMembershipInput) (*DescribeChannelMembershipOutput, error)

DescribeChannelMembership API operation for Amazon Chime SDK Messaging.

Returns the full details of a user's channel membership.

The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

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 Chime SDK Messaging's API operation DescribeChannelMembership for usage and error information.

Returned Error Types:

  • BadRequestException The input parameters don't match the service's restrictions.

  • ForbiddenException The client is permanently forbidden from making the request.

  • NotFoundException One or more of the resources in the request does not exist in the system.

  • UnauthorizedClientException The client is not currently authorized to make the request.

  • ThrottledClientException The client exceeded its request rate limit.

  • ServiceUnavailableException The service is currently unavailable.

  • ServiceFailureException The service encountered an unexpected error.

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/DescribeChannelMembership

func (*ChimeSDKMessaging) DescribeChannelMembershipForAppInstanceUser 

func (c *ChimeSDKMessaging) DescribeChannelMembershipForAppInstanceUser(input *DescribeChannelMembershipForAppInstanceUserInput) (*DescribeChannelMembershipForAppInstanceUserOutput, error)

DescribeChannelMembershipForAppInstanceUser API operation for Amazon Chime SDK Messaging.

Returns the details of a channel based on the membership of the specified AppInstanceUser or AppInstanceBot.

The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

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 Chime SDK Messaging's API operation DescribeChannelMembershipForAppInstanceUser for usage and error information.

Returned Error Types:

  • BadRequestException The input parameters don't match the service's restrictions.

  • ForbiddenException The client is permanently forbidden from making the request.

  • UnauthorizedClientException The client is not currently authorized to make the request.

  • ThrottledClientException The client exceeded its request rate limit.

  • ServiceUnavailableException The service is currently unavailable.

  • ServiceFailureException The service encountered an unexpected error.

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/DescribeChannelMembershipForAppInstanceUser

func (*ChimeSDKMessaging) DescribeChannelMembershipForAppInstanceUserRequest 

func (c *ChimeSDKMessaging) DescribeChannelMembershipForAppInstanceUserRequest(input *DescribeChannelMembershipForAppInstanceUserInput) (req *request.Request, output *DescribeChannelMembershipForAppInstanceUserOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/DescribeChannelMembershipForAppInstanceUser

func (*ChimeSDKMessaging) DescribeChannelMembershipForAppInstanceUserWithContext 

func (c *ChimeSDKMessaging) DescribeChannelMembershipForAppInstanceUserWithContext(ctx aws.Context, input *DescribeChannelMembershipForAppInstanceUserInput, opts ...request.Option) (*DescribeChannelMembershipForAppInstanceUserOutput, error)

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

See DescribeChannelMembershipForAppInstanceUser 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 (*ChimeSDKMessaging) DescribeChannelMembershipRequest 

func (c *ChimeSDKMessaging) DescribeChannelMembershipRequest(input *DescribeChannelMembershipInput) (req *request.Request, output *DescribeChannelMembershipOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/DescribeChannelMembership

func (*ChimeSDKMessaging) DescribeChannelMembershipWithContext 

func (c *ChimeSDKMessaging) DescribeChannelMembershipWithContext(ctx aws.Context, input *DescribeChannelMembershipInput, opts ...request.Option) (*DescribeChannelMembershipOutput, error)

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

See DescribeChannelMembership 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 (*ChimeSDKMessaging) DescribeChannelModeratedByAppInstanceUser 

func (c *ChimeSDKMessaging) DescribeChannelModeratedByAppInstanceUser(input *DescribeChannelModeratedByAppInstanceUserInput) (*DescribeChannelModeratedByAppInstanceUserOutput, error)

DescribeChannelModeratedByAppInstanceUser API operation for Amazon Chime SDK Messaging.

Returns the full details of a channel moderated by the specified AppInstanceUser or AppInstanceBot.

The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

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 Chime SDK Messaging's API operation DescribeChannelModeratedByAppInstanceUser for usage and error information.

Returned Error Types:

  • BadRequestException The input parameters don't match the service's restrictions.

  • ForbiddenException The client is permanently forbidden from making the request.

  • UnauthorizedClientException The client is not currently authorized to make the request.

  • ThrottledClientException The client exceeded its request rate limit.

  • ServiceUnavailableException The service is currently unavailable.

  • ServiceFailureException The service encountered an unexpected error.

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/DescribeChannelModeratedByAppInstanceUser

func (*ChimeSDKMessaging) DescribeChannelModeratedByAppInstanceUserRequest 

func (c *ChimeSDKMessaging) DescribeChannelModeratedByAppInstanceUserRequest(input *DescribeChannelModeratedByAppInstanceUserInput) (req *request.Request, output *DescribeChannelModeratedByAppInstanceUserOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/DescribeChannelModeratedByAppInstanceUser

func (*ChimeSDKMessaging) DescribeChannelModeratedByAppInstanceUserWithContext 

func (c *ChimeSDKMessaging) DescribeChannelModeratedByAppInstanceUserWithContext(ctx aws.Context, input *DescribeChannelModeratedByAppInstanceUserInput, opts ...request.Option) (*DescribeChannelModeratedByAppInstanceUserOutput, error)

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

See DescribeChannelModeratedByAppInstanceUser 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 (*ChimeSDKMessaging) DescribeChannelModerator 

func (c *ChimeSDKMessaging) DescribeChannelModerator(input *DescribeChannelModeratorInput) (*DescribeChannelModeratorOutput, error)

DescribeChannelModerator API operation for Amazon Chime SDK Messaging.

Returns the full details of a single ChannelModerator.

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

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 Chime SDK Messaging's API operation DescribeChannelModerator for usage and error information.

Returned Error Types:

  • BadRequestException The input parameters don't match the service's restrictions.

  • ForbiddenException The client is permanently forbidden from making the request.

  • NotFoundException One or more of the resources in the request does not exist in the system.

  • UnauthorizedClientException The client is not currently authorized to make the request.

  • ThrottledClientException The client exceeded its request rate limit.

  • ServiceUnavailableException The service is currently unavailable.

  • ServiceFailureException The service encountered an unexpected error.

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/DescribeChannelModerator

func (*ChimeSDKMessaging) DescribeChannelModeratorRequest 

func (c *ChimeSDKMessaging) DescribeChannelModeratorRequest(input *DescribeChannelModeratorInput) (req *request.Request, output *DescribeChannelModeratorOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/DescribeChannelModerator

func (*ChimeSDKMessaging) DescribeChannelModeratorWithContext 

func (c *ChimeSDKMessaging) DescribeChannelModeratorWithContext(ctx aws.Context, input *DescribeChannelModeratorInput, opts ...request.Option) (*DescribeChannelModeratorOutput, error)

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

See DescribeChannelModerator 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 (*ChimeSDKMessaging) DescribeChannelRequest 

func (c *ChimeSDKMessaging) DescribeChannelRequest(input *DescribeChannelInput) (req *request.Request, output *DescribeChannelOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/DescribeChannel

func (*ChimeSDKMessaging) DescribeChannelWithContext 

func (c *ChimeSDKMessaging) DescribeChannelWithContext(ctx aws.Context, input *DescribeChannelInput, opts ...request.Option) (*DescribeChannelOutput, error)

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

See DescribeChannel 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 (*ChimeSDKMessaging) DisassociateChannelFlow added in v1.41.6 

func (c *ChimeSDKMessaging) DisassociateChannelFlow(input *DisassociateChannelFlowInput) (*DisassociateChannelFlowOutput, error)

DisassociateChannelFlow API operation for Amazon Chime SDK Messaging.

Disassociates a channel flow from all its channels. Once disassociated, all messages to that channel stop going through the channel flow processor.

Only administrators or channel moderators can disassociate a channel flow.

The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

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 Chime SDK Messaging's API operation DisassociateChannelFlow for usage and error information.

Returned Error Types:

  • BadRequestException The input parameters don't match the service's restrictions.

  • ForbiddenException The client is permanently forbidden from making the request.

  • NotFoundException One or more of the resources in the request does not exist in the system.

  • UnauthorizedClientException The client is not currently authorized to make the request.

  • ConflictException The request could not be processed because of conflict in the current state of the resource.

  • ThrottledClientException The client exceeded its request rate limit.

  • ServiceUnavailableException The service is currently unavailable.

  • ServiceFailureException The service encountered an unexpected error.

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/DisassociateChannelFlow

func (*ChimeSDKMessaging) DisassociateChannelFlowRequest added in v1.41.6 

func (c *ChimeSDKMessaging) DisassociateChannelFlowRequest(input *DisassociateChannelFlowInput) (req *request.Request, output *DisassociateChannelFlowOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/DisassociateChannelFlow

func (*ChimeSDKMessaging) DisassociateChannelFlowWithContext added in v1.41.6 

func (c *ChimeSDKMessaging) DisassociateChannelFlowWithContext(ctx aws.Context, input *DisassociateChannelFlowInput, opts ...request.Option) (*DisassociateChannelFlowOutput, error)

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

See DisassociateChannelFlow 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 (*ChimeSDKMessaging) GetChannelMembershipPreferences added in v1.41.11 

func (c *ChimeSDKMessaging) GetChannelMembershipPreferences(input *GetChannelMembershipPreferencesInput) (*GetChannelMembershipPreferencesOutput, error)

GetChannelMembershipPreferences API operation for Amazon Chime SDK Messaging.

Gets the membership preferences of an AppInstanceUser or AppInstanceBot for the specified channel. A user or a bot must be a member of the channel and own the membership in order to retrieve membership preferences. Users or bots in the AppInstanceAdmin and channel moderator roles can't retrieve preferences for other users or bots. Banned users or bots can't retrieve membership preferences for the channel from which they are banned.

The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

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 Chime SDK Messaging's API operation GetChannelMembershipPreferences for usage and error information.

Returned Error Types:

  • BadRequestException The input parameters don't match the service's restrictions.

  • UnauthorizedClientException The client is not currently authorized to make the request.

  • ForbiddenException The client is permanently forbidden from making the request.

  • ThrottledClientException The client exceeded its request rate limit.

  • ServiceUnavailableException The service is currently unavailable.

  • ServiceFailureException The service encountered an unexpected error.

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/GetChannelMembershipPreferences

func (*ChimeSDKMessaging) GetChannelMembershipPreferencesRequest added in v1.41.11 

func (c *ChimeSDKMessaging) GetChannelMembershipPreferencesRequest(input *GetChannelMembershipPreferencesInput) (req *request.Request, output *GetChannelMembershipPreferencesOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/GetChannelMembershipPreferences

func (*ChimeSDKMessaging) GetChannelMembershipPreferencesWithContext added in v1.41.11 

func (c *ChimeSDKMessaging) GetChannelMembershipPreferencesWithContext(ctx aws.Context, input *GetChannelMembershipPreferencesInput, opts ...request.Option) (*GetChannelMembershipPreferencesOutput, error)

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

See GetChannelMembershipPreferences 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 (*ChimeSDKMessaging) GetChannelMessage 

func (c *ChimeSDKMessaging) GetChannelMessage(input *GetChannelMessageInput) (*GetChannelMessageOutput, error)

GetChannelMessage API operation for Amazon Chime SDK Messaging.

Gets the full details of a channel message.

The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

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 Chime SDK Messaging's API operation GetChannelMessage for usage and error information.

Returned Error Types:

  • BadRequestException The input parameters don't match the service's restrictions.

  • ForbiddenException The client is permanently forbidden from making the request.

  • NotFoundException One or more of the resources in the request does not exist in the system.

  • UnauthorizedClientException The client is not currently authorized to make the request.

  • ThrottledClientException The client exceeded its request rate limit.

  • ServiceUnavailableException The service is currently unavailable.

  • ServiceFailureException The service encountered an unexpected error.

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/GetChannelMessage

func (*ChimeSDKMessaging) GetChannelMessageRequest 

func (c *ChimeSDKMessaging) GetChannelMessageRequest(input *GetChannelMessageInput) (req *request.Request, output *GetChannelMessageOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/GetChannelMessage

func (*ChimeSDKMessaging) GetChannelMessageStatus added in v1.41.6 

func (c *ChimeSDKMessaging) GetChannelMessageStatus(input *GetChannelMessageStatusInput) (*GetChannelMessageStatusOutput, error)

GetChannelMessageStatus API operation for Amazon Chime SDK Messaging.

Gets message status for a specified messageId. Use this API to determine the intermediate status of messages going through channel flow processing. The API provides an alternative to retrieving message status if the event was not received because a client wasn't connected to a websocket.

Messages can have any one of these statuses.

SENT

Message processed successfully

PENDING

Ongoing processing

FAILED

Processing failed

DENIED

Message denied by the processor

  • This API does not return statuses for denied messages, because we don't store them once the processor denies them.

  • Only the message sender can invoke this API.

  • The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

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 Chime SDK Messaging's API operation GetChannelMessageStatus for usage and error information.

Returned Error Types:

  • BadRequestException The input parameters don't match the service's restrictions.

  • ForbiddenException The client is permanently forbidden from making the request.

  • UnauthorizedClientException The client is not currently authorized to make the request.

  • ThrottledClientException The client exceeded its request rate limit.

  • ServiceUnavailableException The service is currently unavailable.

  • ServiceFailureException The service encountered an unexpected error.

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/GetChannelMessageStatus

func (*ChimeSDKMessaging) GetChannelMessageStatusRequest added in v1.41.6 

func (c *ChimeSDKMessaging) GetChannelMessageStatusRequest(input *GetChannelMessageStatusInput) (req *request.Request, output *GetChannelMessageStatusOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/GetChannelMessageStatus

func (*ChimeSDKMessaging) GetChannelMessageStatusWithContext added in v1.41.6 

func (c *ChimeSDKMessaging) GetChannelMessageStatusWithContext(ctx aws.Context, input *GetChannelMessageStatusInput, opts ...request.Option) (*GetChannelMessageStatusOutput, error)

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

See GetChannelMessageStatus 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 (*ChimeSDKMessaging) GetChannelMessageWithContext 

func (c *ChimeSDKMessaging) GetChannelMessageWithContext(ctx aws.Context, input *GetChannelMessageInput, opts ...request.Option) (*GetChannelMessageOutput, error)

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

See GetChannelMessage 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 (*ChimeSDKMessaging) GetMessagingSessionEndpoint 

func (c *ChimeSDKMessaging) GetMessagingSessionEndpoint(input *GetMessagingSessionEndpointInput) (*GetMessagingSessionEndpointOutput, error)

GetMessagingSessionEndpoint API operation for Amazon Chime SDK Messaging.

The details of the endpoint for the messaging session.

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 Chime SDK Messaging's API operation GetMessagingSessionEndpoint for usage and error information.

Returned Error Types:

  • UnauthorizedClientException The client is not currently authorized to make the request.

  • ForbiddenException The client is permanently forbidden from making the request.

  • ThrottledClientException The client exceeded its request rate limit.

  • ServiceUnavailableException The service is currently unavailable.

  • ServiceFailureException The service encountered an unexpected error.

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/GetMessagingSessionEndpoint

func (*ChimeSDKMessaging) GetMessagingSessionEndpointRequest 

func (c *ChimeSDKMessaging) GetMessagingSessionEndpointRequest(input *GetMessagingSessionEndpointInput) (req *request.Request, output *GetMessagingSessionEndpointOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/GetMessagingSessionEndpoint

func (*ChimeSDKMessaging) GetMessagingSessionEndpointWithContext 

func (c *ChimeSDKMessaging) GetMessagingSessionEndpointWithContext(ctx aws.Context, input *GetMessagingSessionEndpointInput, opts ...request.Option) (*GetMessagingSessionEndpointOutput, error)

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

See GetMessagingSessionEndpoint 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 (*ChimeSDKMessaging) GetMessagingStreamingConfigurations added in v1.44.226 

func (c *ChimeSDKMessaging) GetMessagingStreamingConfigurations(input *GetMessagingStreamingConfigurationsInput) (*GetMessagingStreamingConfigurationsOutput, error)

GetMessagingStreamingConfigurations API operation for Amazon Chime SDK Messaging.

Retrieves the data streaming configuration for an AppInstance. For more information, see Streaming messaging data (https://docs.aws.amazon.com/chime-sdk/latest/dg/streaming-export.html) in the Amazon Chime SDK Developer Guide.

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 Chime SDK Messaging's API operation GetMessagingStreamingConfigurations for usage and error information.

Returned Error Types:

  • BadRequestException The input parameters don't match the service's restrictions.

  • ForbiddenException The client is permanently forbidden from making the request.

  • NotFoundException One or more of the resources in the request does not exist in the system.

  • UnauthorizedClientException The client is not currently authorized to make the request.

  • ThrottledClientException The client exceeded its request rate limit.

  • ServiceUnavailableException The service is currently unavailable.

  • ServiceFailureException The service encountered an unexpected error.

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/GetMessagingStreamingConfigurations

func (*ChimeSDKMessaging) GetMessagingStreamingConfigurationsRequest added in v1.44.226 

func (c *ChimeSDKMessaging) GetMessagingStreamingConfigurationsRequest(input *GetMessagingStreamingConfigurationsInput) (req *request.Request, output *GetMessagingStreamingConfigurationsOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/GetMessagingStreamingConfigurations

func (*ChimeSDKMessaging) GetMessagingStreamingConfigurationsWithContext added in v1.44.226 

func (c *ChimeSDKMessaging) GetMessagingStreamingConfigurationsWithContext(ctx aws.Context, input *GetMessagingStreamingConfigurationsInput, opts ...request.Option) (*GetMessagingStreamingConfigurationsOutput, error)

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

See GetMessagingStreamingConfigurations 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 (*ChimeSDKMessaging) ListChannelBans 

func (c *ChimeSDKMessaging) ListChannelBans(input *ListChannelBansInput) (*ListChannelBansOutput, error)

ListChannelBans API operation for Amazon Chime SDK Messaging.

Lists all the users and bots banned from a particular channel.

The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

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 Chime SDK Messaging's API operation ListChannelBans for usage and error information.

Returned Error Types:

  • BadRequestException The input parameters don't match the service's restrictions.

  • ForbiddenException The client is permanently forbidden from making the request.

  • UnauthorizedClientException The client is not currently authorized to make the request.

  • ThrottledClientException The client exceeded its request rate limit.

  • ServiceUnavailableException The service is currently unavailable.

  • ServiceFailureException The service encountered an unexpected error.

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ListChannelBans

func (*ChimeSDKMessaging) ListChannelBansPages 

func (c *ChimeSDKMessaging) ListChannelBansPages(input *ListChannelBansInput, fn func(*ListChannelBansOutput, bool) bool) error

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

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

func (*ChimeSDKMessaging) ListChannelBansPagesWithContext 

func (c *ChimeSDKMessaging) ListChannelBansPagesWithContext(ctx aws.Context, input *ListChannelBansInput, fn func(*ListChannelBansOutput, bool) bool, opts ...request.Option) error

ListChannelBansPagesWithContext same as ListChannelBansPages 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 (*ChimeSDKMessaging) ListChannelBansRequest 

func (c *ChimeSDKMessaging) ListChannelBansRequest(input *ListChannelBansInput) (req *request.Request, output *ListChannelBansOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ListChannelBans

func (*ChimeSDKMessaging) ListChannelBansWithContext 

func (c *ChimeSDKMessaging) ListChannelBansWithContext(ctx aws.Context, input *ListChannelBansInput, opts ...request.Option) (*ListChannelBansOutput, error)

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

See ListChannelBans 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 (*ChimeSDKMessaging) ListChannelFlows added in v1.41.6 

func (c *ChimeSDKMessaging) ListChannelFlows(input *ListChannelFlowsInput) (*ListChannelFlowsOutput, error)

ListChannelFlows API operation for Amazon Chime SDK Messaging.

Returns a paginated lists of all the channel flows created under a single Chime. This is a developer 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 Chime SDK Messaging's API operation ListChannelFlows for usage and error information.

Returned Error Types:

  • BadRequestException The input parameters don't match the service's restrictions.

  • ForbiddenException The client is permanently forbidden from making the request.

  • UnauthorizedClientException The client is not currently authorized to make the request.

  • ThrottledClientException The client exceeded its request rate limit.

  • ServiceUnavailableException The service is currently unavailable.

  • ServiceFailureException The service encountered an unexpected error.

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ListChannelFlows

func (*ChimeSDKMessaging) ListChannelFlowsPages added in v1.41.6 

func (c *ChimeSDKMessaging) ListChannelFlowsPages(input *ListChannelFlowsInput, fn func(*ListChannelFlowsOutput, bool) bool) error

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

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

func (*ChimeSDKMessaging) ListChannelFlowsPagesWithContext added in v1.41.6 

func (c *ChimeSDKMessaging) ListChannelFlowsPagesWithContext(ctx aws.Context, input *ListChannelFlowsInput, fn func(*ListChannelFlowsOutput, bool) bool, opts ...request.Option) error

ListChannelFlowsPagesWithContext same as ListChannelFlowsPages 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 (*ChimeSDKMessaging) ListChannelFlowsRequest added in v1.41.6 

func (c *ChimeSDKMessaging) ListChannelFlowsRequest(input *ListChannelFlowsInput) (req *request.Request, output *ListChannelFlowsOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ListChannelFlows

func (*ChimeSDKMessaging) ListChannelFlowsWithContext added in v1.41.6 

func (c *ChimeSDKMessaging) ListChannelFlowsWithContext(ctx aws.Context, input *ListChannelFlowsInput, opts ...request.Option) (*ListChannelFlowsOutput, error)

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

See ListChannelFlows 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 (*ChimeSDKMessaging) ListChannelMemberships 

func (c *ChimeSDKMessaging) ListChannelMemberships(input *ListChannelMembershipsInput) (*ListChannelMembershipsOutput, error)

ListChannelMemberships API operation for Amazon Chime SDK Messaging.

Lists all channel memberships in a channel.

The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

If you want to list the channels to which a specific app instance user belongs, see the ListChannelMembershipsForAppInstanceUser (https://docs.aws.amazon.com/chime/latest/APIReference/API_messaging-chime_ListChannelMembershipsForAppInstanceUser.html) 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 Chime SDK Messaging's API operation ListChannelMemberships for usage and error information.

Returned Error Types:

  • BadRequestException The input parameters don't match the service's restrictions.

  • ForbiddenException The client is permanently forbidden from making the request.

  • UnauthorizedClientException The client is not currently authorized to make the request.

  • ThrottledClientException The client exceeded its request rate limit.

  • ServiceUnavailableException The service is currently unavailable.

  • ServiceFailureException The service encountered an unexpected error.

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ListChannelMemberships

func (*ChimeSDKMessaging) ListChannelMembershipsForAppInstanceUser 

func (c *ChimeSDKMessaging) ListChannelMembershipsForAppInstanceUser(input *ListChannelMembershipsForAppInstanceUserInput) (*ListChannelMembershipsForAppInstanceUserOutput, error)

ListChannelMembershipsForAppInstanceUser API operation for Amazon Chime SDK Messaging.

Lists all channels that an AppInstanceUser or AppInstanceBot is a part of. Only an AppInstanceAdmin can call the API with a user ARN that is not their own.

The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

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 Chime SDK Messaging's API operation ListChannelMembershipsForAppInstanceUser for usage and error information.

Returned Error Types:

  • BadRequestException The input parameters don't match the service's restrictions.

  • ForbiddenException The client is permanently forbidden from making the request.

  • UnauthorizedClientException The client is not currently authorized to make the request.

  • ThrottledClientException The client exceeded its request rate limit.

  • ServiceUnavailableException The service is currently unavailable.

  • ServiceFailureException The service encountered an unexpected error.

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ListChannelMembershipsForAppInstanceUser

func (*ChimeSDKMessaging) ListChannelMembershipsForAppInstanceUserPages 

func (c *ChimeSDKMessaging) ListChannelMembershipsForAppInstanceUserPages(input *ListChannelMembershipsForAppInstanceUserInput, fn func(*ListChannelMembershipsForAppInstanceUserOutput, bool) bool) error

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

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

func (*ChimeSDKMessaging) ListChannelMembershipsForAppInstanceUserPagesWithContext 

func (c *ChimeSDKMessaging) ListChannelMembershipsForAppInstanceUserPagesWithContext(ctx aws.Context, input *ListChannelMembershipsForAppInstanceUserInput, fn func(*ListChannelMembershipsForAppInstanceUserOutput, bool) bool, opts ...request.Option) error

ListChannelMembershipsForAppInstanceUserPagesWithContext same as ListChannelMembershipsForAppInstanceUserPages 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 (*ChimeSDKMessaging) ListChannelMembershipsForAppInstanceUserRequest 

func (c *ChimeSDKMessaging) ListChannelMembershipsForAppInstanceUserRequest(input *ListChannelMembershipsForAppInstanceUserInput) (req *request.Request, output *ListChannelMembershipsForAppInstanceUserOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ListChannelMembershipsForAppInstanceUser

func (*ChimeSDKMessaging) ListChannelMembershipsForAppInstanceUserWithContext 

func (c *ChimeSDKMessaging) ListChannelMembershipsForAppInstanceUserWithContext(ctx aws.Context, input *ListChannelMembershipsForAppInstanceUserInput, opts ...request.Option) (*ListChannelMembershipsForAppInstanceUserOutput, error)

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

See ListChannelMembershipsForAppInstanceUser 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 (*ChimeSDKMessaging) ListChannelMembershipsPages 

func (c *ChimeSDKMessaging) ListChannelMembershipsPages(input *ListChannelMembershipsInput, fn func(*ListChannelMembershipsOutput, bool) bool) error

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

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

func (*ChimeSDKMessaging) ListChannelMembershipsPagesWithContext 

func (c *ChimeSDKMessaging) ListChannelMembershipsPagesWithContext(ctx aws.Context, input *ListChannelMembershipsInput, fn func(*ListChannelMembershipsOutput, bool) bool, opts ...request.Option) error

ListChannelMembershipsPagesWithContext same as ListChannelMembershipsPages 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 (*ChimeSDKMessaging) ListChannelMembershipsRequest 

func (c *ChimeSDKMessaging) ListChannelMembershipsRequest(input *ListChannelMembershipsInput) (req *request.Request, output *ListChannelMembershipsOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ListChannelMemberships

func (*ChimeSDKMessaging) ListChannelMembershipsWithContext 

func (c *ChimeSDKMessaging) ListChannelMembershipsWithContext(ctx aws.Context, input *ListChannelMembershipsInput, opts ...request.Option) (*ListChannelMembershipsOutput, error)

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

See ListChannelMemberships 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 (*ChimeSDKMessaging) ListChannelMessages 

func (c *ChimeSDKMessaging) ListChannelMessages(input *ListChannelMessagesInput) (*ListChannelMessagesOutput, error)

ListChannelMessages API operation for Amazon Chime SDK Messaging.

List all the messages in a channel. Returns a paginated list of ChannelMessages. By default, sorted by creation timestamp in descending order.

Redacted messages appear in the results as empty, since they are only redacted, not deleted. Deleted messages do not appear in the results. This action always returns the latest version of an edited message.

Also, the x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

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 Chime SDK Messaging's API operation ListChannelMessages for usage and error information.

Returned Error Types:

  • BadRequestException The input parameters don't match the service's restrictions.

  • ForbiddenException The client is permanently forbidden from making the request.

  • UnauthorizedClientException The client is not currently authorized to make the request.

  • ThrottledClientException The client exceeded its request rate limit.

  • ServiceUnavailableException The service is currently unavailable.

  • ServiceFailureException The service encountered an unexpected error.

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ListChannelMessages

func (*ChimeSDKMessaging) ListChannelMessagesPages 

func (c *ChimeSDKMessaging) ListChannelMessagesPages(input *ListChannelMessagesInput, fn func(*ListChannelMessagesOutput, bool) bool) error

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

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

func (*ChimeSDKMessaging) ListChannelMessagesPagesWithContext 

func (c *ChimeSDKMessaging) ListChannelMessagesPagesWithContext(ctx aws.Context, input *ListChannelMessagesInput, fn func(*ListChannelMessagesOutput, bool) bool, opts ...request.Option) error

ListChannelMessagesPagesWithContext same as ListChannelMessagesPages 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 (*ChimeSDKMessaging) ListChannelMessagesRequest 

func (c *ChimeSDKMessaging) ListChannelMessagesRequest(input *ListChannelMessagesInput) (req *request.Request, output *ListChannelMessagesOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ListChannelMessages

func (*ChimeSDKMessaging) ListChannelMessagesWithContext 

func (c *ChimeSDKMessaging) ListChannelMessagesWithContext(ctx aws.Context, input *ListChannelMessagesInput, opts ...request.Option) (*ListChannelMessagesOutput, error)

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

See ListChannelMessages 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 (*ChimeSDKMessaging) ListChannelModerators 

func (c *ChimeSDKMessaging) ListChannelModerators(input *ListChannelModeratorsInput) (*ListChannelModeratorsOutput, error)

ListChannelModerators API operation for Amazon Chime SDK Messaging.

Lists all the moderators for a channel.

The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

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 Chime SDK Messaging's API operation ListChannelModerators for usage and error information.

Returned Error Types:

  • BadRequestException The input parameters don't match the service's restrictions.

  • ForbiddenException The client is permanently forbidden from making the request.

  • UnauthorizedClientException The client is not currently authorized to make the request.

  • ThrottledClientException The client exceeded its request rate limit.

  • ServiceUnavailableException The service is currently unavailable.

  • ServiceFailureException The service encountered an unexpected error.

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ListChannelModerators

func (*ChimeSDKMessaging) ListChannelModeratorsPages 

func (c *ChimeSDKMessaging) ListChannelModeratorsPages(input *ListChannelModeratorsInput, fn func(*ListChannelModeratorsOutput, bool) bool) error

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

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

func (*ChimeSDKMessaging) ListChannelModeratorsPagesWithContext 

func (c *ChimeSDKMessaging) ListChannelModeratorsPagesWithContext(ctx aws.Context, input *ListChannelModeratorsInput, fn func(*ListChannelModeratorsOutput, bool) bool, opts ...request.Option) error

ListChannelModeratorsPagesWithContext same as ListChannelModeratorsPages 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 (*ChimeSDKMessaging) ListChannelModeratorsRequest 

func (c *ChimeSDKMessaging) ListChannelModeratorsRequest(input *ListChannelModeratorsInput) (req *request.Request, output *ListChannelModeratorsOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ListChannelModerators

func (*ChimeSDKMessaging) ListChannelModeratorsWithContext 

func (c *ChimeSDKMessaging) ListChannelModeratorsWithContext(ctx aws.Context, input *ListChannelModeratorsInput, opts ...request.Option) (*ListChannelModeratorsOutput, error)

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

See ListChannelModerators 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 (*ChimeSDKMessaging) ListChannels 

func (c *ChimeSDKMessaging) ListChannels(input *ListChannelsInput) (*ListChannelsOutput, error)

ListChannels API operation for Amazon Chime SDK Messaging.

Lists all Channels created under a single Chime App as a paginated list. You can specify filters to narrow results.

Functionality & restrictions

  • Use privacy = PUBLIC to retrieve all public channels in the account.

  • Only an AppInstanceAdmin can set privacy = PRIVATE to list the private channels in an account.

The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

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 Chime SDK Messaging's API operation ListChannels for usage and error information.

Returned Error Types:

  • BadRequestException The input parameters don't match the service's restrictions.

  • ForbiddenException The client is permanently forbidden from making the request.

  • UnauthorizedClientException The client is not currently authorized to make the request.

  • ThrottledClientException The client exceeded its request rate limit.

  • ServiceUnavailableException The service is currently unavailable.

  • ServiceFailureException The service encountered an unexpected error.

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ListChannels

func (*ChimeSDKMessaging) ListChannelsAssociatedWithChannelFlow added in v1.41.6 

func (c *ChimeSDKMessaging) ListChannelsAssociatedWithChannelFlow(input *ListChannelsAssociatedWithChannelFlowInput) (*ListChannelsAssociatedWithChannelFlowOutput, error)

ListChannelsAssociatedWithChannelFlow API operation for Amazon Chime SDK Messaging.

Lists all channels associated with a specified channel flow. You can associate a channel flow with multiple channels, but you can only associate a channel with one channel flow. This is a developer 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 Chime SDK Messaging's API operation ListChannelsAssociatedWithChannelFlow for usage and error information.

Returned Error Types:

  • BadRequestException The input parameters don't match the service's restrictions.

  • ForbiddenException The client is permanently forbidden from making the request.

  • UnauthorizedClientException The client is not currently authorized to make the request.

  • ThrottledClientException The client exceeded its request rate limit.

  • ServiceUnavailableException The service is currently unavailable.

  • ServiceFailureException The service encountered an unexpected error.

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ListChannelsAssociatedWithChannelFlow

func (*ChimeSDKMessaging) ListChannelsAssociatedWithChannelFlowPages added in v1.41.6 

func (c *ChimeSDKMessaging) ListChannelsAssociatedWithChannelFlowPages(input *ListChannelsAssociatedWithChannelFlowInput, fn func(*ListChannelsAssociatedWithChannelFlowOutput, bool) bool) error

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

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

func (*ChimeSDKMessaging) ListChannelsAssociatedWithChannelFlowPagesWithContext added in v1.41.6 

func (c *ChimeSDKMessaging) ListChannelsAssociatedWithChannelFlowPagesWithContext(ctx aws.Context, input *ListChannelsAssociatedWithChannelFlowInput, fn func(*ListChannelsAssociatedWithChannelFlowOutput, bool) bool, opts ...request.Option) error

ListChannelsAssociatedWithChannelFlowPagesWithContext same as ListChannelsAssociatedWithChannelFlowPages 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 (*ChimeSDKMessaging) ListChannelsAssociatedWithChannelFlowRequest added in v1.41.6 

func (c *ChimeSDKMessaging) ListChannelsAssociatedWithChannelFlowRequest(input *ListChannelsAssociatedWithChannelFlowInput) (req *request.Request, output *ListChannelsAssociatedWithChannelFlowOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ListChannelsAssociatedWithChannelFlow

func (*ChimeSDKMessaging) ListChannelsAssociatedWithChannelFlowWithContext added in v1.41.6 

func (c *ChimeSDKMessaging) ListChannelsAssociatedWithChannelFlowWithContext(ctx aws.Context, input *ListChannelsAssociatedWithChannelFlowInput, opts ...request.Option) (*ListChannelsAssociatedWithChannelFlowOutput, error)

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

See ListChannelsAssociatedWithChannelFlow 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 (*ChimeSDKMessaging) ListChannelsModeratedByAppInstanceUser 

func (c *ChimeSDKMessaging) ListChannelsModeratedByAppInstanceUser(input *ListChannelsModeratedByAppInstanceUserInput) (*ListChannelsModeratedByAppInstanceUserOutput, error)

ListChannelsModeratedByAppInstanceUser API operation for Amazon Chime SDK Messaging.

A list of the channels moderated by an AppInstanceUser.

The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

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 Chime SDK Messaging's API operation ListChannelsModeratedByAppInstanceUser for usage and error information.

Returned Error Types:

  • BadRequestException The input parameters don't match the service's restrictions.

  • ForbiddenException The client is permanently forbidden from making the request.

  • UnauthorizedClientException The client is not currently authorized to make the request.

  • ThrottledClientException The client exceeded its request rate limit.

  • ServiceUnavailableException The service is currently unavailable.

  • ServiceFailureException The service encountered an unexpected error.

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ListChannelsModeratedByAppInstanceUser

func (*ChimeSDKMessaging) ListChannelsModeratedByAppInstanceUserPages 

func (c *ChimeSDKMessaging) ListChannelsModeratedByAppInstanceUserPages(input *ListChannelsModeratedByAppInstanceUserInput, fn func(*ListChannelsModeratedByAppInstanceUserOutput, bool) bool) error

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

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

func (*ChimeSDKMessaging) ListChannelsModeratedByAppInstanceUserPagesWithContext 

func (c *ChimeSDKMessaging) ListChannelsModeratedByAppInstanceUserPagesWithContext(ctx aws.Context, input *ListChannelsModeratedByAppInstanceUserInput, fn func(*ListChannelsModeratedByAppInstanceUserOutput, bool) bool, opts ...request.Option) error

ListChannelsModeratedByAppInstanceUserPagesWithContext same as ListChannelsModeratedByAppInstanceUserPages 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 (*ChimeSDKMessaging) ListChannelsModeratedByAppInstanceUserRequest 

func (c *ChimeSDKMessaging) ListChannelsModeratedByAppInstanceUserRequest(input *ListChannelsModeratedByAppInstanceUserInput) (req *request.Request, output *ListChannelsModeratedByAppInstanceUserOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ListChannelsModeratedByAppInstanceUser

func (*ChimeSDKMessaging) ListChannelsModeratedByAppInstanceUserWithContext 

func (c *ChimeSDKMessaging) ListChannelsModeratedByAppInstanceUserWithContext(ctx aws.Context, input *ListChannelsModeratedByAppInstanceUserInput, opts ...request.Option) (*ListChannelsModeratedByAppInstanceUserOutput, error)

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

See ListChannelsModeratedByAppInstanceUser 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 (*ChimeSDKMessaging) ListChannelsPages 

func (c *ChimeSDKMessaging) ListChannelsPages(input *ListChannelsInput, fn func(*ListChannelsOutput, bool) bool) error

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

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

func (*ChimeSDKMessaging) ListChannelsPagesWithContext 

func (c *ChimeSDKMessaging) ListChannelsPagesWithContext(ctx aws.Context, input *ListChannelsInput, fn func(*ListChannelsOutput, bool) bool, opts ...request.Option) error

ListChannelsPagesWithContext same as ListChannelsPages 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 (*ChimeSDKMessaging) ListChannelsRequest 

func (c *ChimeSDKMessaging) ListChannelsRequest(input *ListChannelsInput) (req *request.Request, output *ListChannelsOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ListChannels

func (*ChimeSDKMessaging) ListChannelsWithContext 

func (c *ChimeSDKMessaging) ListChannelsWithContext(ctx aws.Context, input *ListChannelsInput, opts ...request.Option) (*ListChannelsOutput, error)

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

See ListChannels 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 (*ChimeSDKMessaging) ListSubChannels added in v1.44.76 

func (c *ChimeSDKMessaging) ListSubChannels(input *ListSubChannelsInput) (*ListSubChannelsOutput, error)

ListSubChannels API operation for Amazon Chime SDK Messaging.

Lists all the SubChannels in an elastic channel when given a channel ID. Available only to the app instance admins and channel moderators of elastic channels.

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 Chime SDK Messaging's API operation ListSubChannels for usage and error information.

Returned Error Types:

  • BadRequestException The input parameters don't match the service's restrictions.

  • ForbiddenException The client is permanently forbidden from making the request.

  • UnauthorizedClientException The client is not currently authorized to make the request.

  • ThrottledClientException The client exceeded its request rate limit.

  • ServiceUnavailableException The service is currently unavailable.

  • ServiceFailureException The service encountered an unexpected error.

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ListSubChannels

func (*ChimeSDKMessaging) ListSubChannelsPages added in v1.44.76 

func (c *ChimeSDKMessaging) ListSubChannelsPages(input *ListSubChannelsInput, fn func(*ListSubChannelsOutput, bool) bool) error

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

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

func (*ChimeSDKMessaging) ListSubChannelsPagesWithContext added in v1.44.76 

func (c *ChimeSDKMessaging) ListSubChannelsPagesWithContext(ctx aws.Context, input *ListSubChannelsInput, fn func(*ListSubChannelsOutput, bool) bool, opts ...request.Option) error

ListSubChannelsPagesWithContext same as ListSubChannelsPages 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 (*ChimeSDKMessaging) ListSubChannelsRequest added in v1.44.76 

func (c *ChimeSDKMessaging) ListSubChannelsRequest(input *ListSubChannelsInput) (req *request.Request, output *ListSubChannelsOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ListSubChannels

func (*ChimeSDKMessaging) ListSubChannelsWithContext added in v1.44.76 

func (c *ChimeSDKMessaging) ListSubChannelsWithContext(ctx aws.Context, input *ListSubChannelsInput, opts ...request.Option) (*ListSubChannelsOutput, error)

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

See ListSubChannels 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 (*ChimeSDKMessaging) ListTagsForResource added in v1.41.6 

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

ListTagsForResource API operation for Amazon Chime SDK Messaging.

Lists the tags applied to an Amazon Chime SDK messaging resource.

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

Returned Error Types:

  • BadRequestException The input parameters don't match the service's restrictions.

  • ForbiddenException The client is permanently forbidden from making the request.

  • UnauthorizedClientException The client is not currently authorized to make the request.

  • ThrottledClientException The client exceeded its request rate limit.

  • ServiceUnavailableException The service is currently unavailable.

  • ServiceFailureException The service encountered an unexpected error.

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ListTagsForResource

func (*ChimeSDKMessaging) ListTagsForResourceRequest added in v1.41.6 

func (c *ChimeSDKMessaging) 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/chime-sdk-messaging-2021-05-15/ListTagsForResource

func (*ChimeSDKMessaging) ListTagsForResourceWithContext added in v1.41.6 

func (c *ChimeSDKMessaging) 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 (*ChimeSDKMessaging) PutChannelExpirationSettings added in v1.44.228 

func (c *ChimeSDKMessaging) PutChannelExpirationSettings(input *PutChannelExpirationSettingsInput) (*PutChannelExpirationSettingsOutput, error)

PutChannelExpirationSettings API operation for Amazon Chime SDK Messaging.

Sets the number of days before the channel is automatically deleted.

  • A background process deletes expired channels within 6 hours of expiration. Actual deletion times may vary.

  • Expired channels that have not yet been deleted appear as active, and you can update their expiration settings. The system honors the new settings.

  • The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

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 Chime SDK Messaging's API operation PutChannelExpirationSettings for usage and error information.

Returned Error Types:

  • BadRequestException The input parameters don't match the service's restrictions.

  • ForbiddenException The client is permanently forbidden from making the request.

  • ConflictException The request could not be processed because of conflict in the current state of the resource.

  • UnauthorizedClientException The client is not currently authorized to make the request.

  • ThrottledClientException The client exceeded its request rate limit.

  • ServiceUnavailableException The service is currently unavailable.

  • ServiceFailureException The service encountered an unexpected error.

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/PutChannelExpirationSettings

func (*ChimeSDKMessaging) PutChannelExpirationSettingsRequest added in v1.44.228 

func (c *ChimeSDKMessaging) PutChannelExpirationSettingsRequest(input *PutChannelExpirationSettingsInput) (req *request.Request, output *PutChannelExpirationSettingsOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/PutChannelExpirationSettings

func (*ChimeSDKMessaging) PutChannelExpirationSettingsWithContext added in v1.44.228 

func (c *ChimeSDKMessaging) PutChannelExpirationSettingsWithContext(ctx aws.Context, input *PutChannelExpirationSettingsInput, opts ...request.Option) (*PutChannelExpirationSettingsOutput, error)

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

See PutChannelExpirationSettings 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 (*ChimeSDKMessaging) PutChannelMembershipPreferences added in v1.41.11 

func (c *ChimeSDKMessaging) PutChannelMembershipPreferences(input *PutChannelMembershipPreferencesInput) (*PutChannelMembershipPreferencesOutput, error)

PutChannelMembershipPreferences API operation for Amazon Chime SDK Messaging.

Sets the membership preferences of an AppInstanceUser or AppInstanceBot for the specified channel. The user or bot must be a member of the channel. Only the user or bot who owns the membership can set preferences. Users or bots in the AppInstanceAdmin and channel moderator roles can't set preferences for other users. Banned users or bots can't set membership preferences for the channel from which they are banned.

The x-amz-chime-bearer request header is mandatory. Use the ARN of an AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

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 Chime SDK Messaging's API operation PutChannelMembershipPreferences for usage and error information.

Returned Error Types:

  • BadRequestException The input parameters don't match the service's restrictions.

  • ConflictException The request could not be processed because of conflict in the current state of the resource.

  • UnauthorizedClientException The client is not currently authorized to make the request.

  • ForbiddenException The client is permanently forbidden from making the request.

  • ThrottledClientException The client exceeded its request rate limit.

  • ServiceUnavailableException The service is currently unavailable.

  • ServiceFailureException The service encountered an unexpected error.

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/PutChannelMembershipPreferences

func (*ChimeSDKMessaging) PutChannelMembershipPreferencesRequest added in v1.41.11 

func (c *ChimeSDKMessaging) PutChannelMembershipPreferencesRequest(input *PutChannelMembershipPreferencesInput) (req *request.Request, output *PutChannelMembershipPreferencesOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/PutChannelMembershipPreferences

func (*ChimeSDKMessaging) PutChannelMembershipPreferencesWithContext added in v1.41.11 

func (c *ChimeSDKMessaging) PutChannelMembershipPreferencesWithContext(ctx aws.Context, input *PutChannelMembershipPreferencesInput, opts ...request.Option) (*PutChannelMembershipPreferencesOutput, error)

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

See PutChannelMembershipPreferences 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 (*ChimeSDKMessaging) PutMessagingStreamingConfigurations added in v1.44.226 

func (c *ChimeSDKMessaging) PutMessagingStreamingConfigurations(input *PutMessagingStreamingConfigurationsInput) (*PutMessagingStreamingConfigurationsOutput, error)

PutMessagingStreamingConfigurations API operation for Amazon Chime SDK Messaging.

Sets the data streaming configuration for an AppInstance. For more information, see Streaming messaging data (https://docs.aws.amazon.com/chime-sdk/latest/dg/streaming-export.html) in the Amazon Chime SDK Developer Guide.

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 Chime SDK Messaging's API operation PutMessagingStreamingConfigurations for usage and error information.

Returned Error Types:

  • NotFoundException One or more of the resources in the request does not exist in the system.

  • BadRequestException The input parameters don't match the service's restrictions.

  • ForbiddenException The client is permanently forbidden from making the request.

  • UnauthorizedClientException The client is not currently authorized to make the request.

  • ThrottledClientException The client exceeded its request rate limit.

  • ConflictException The request could not be processed because of conflict in the current state of the resource.

  • ServiceUnavailableException The service is currently unavailable.

  • ServiceFailureException The service encountered an unexpected error.

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/PutMessagingStreamingConfigurations

func (*ChimeSDKMessaging) PutMessagingStreamingConfigurationsRequest added in v1.44.226 

func (c *ChimeSDKMessaging) PutMessagingStreamingConfigurationsRequest(input *PutMessagingStreamingConfigurationsInput) (req *request.Request, output *PutMessagingStreamingConfigurationsOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/PutMessagingStreamingConfigurations

func (*ChimeSDKMessaging) PutMessagingStreamingConfigurationsWithContext added in v1.44.226 

func (c *ChimeSDKMessaging) PutMessagingStreamingConfigurationsWithContext(ctx aws.Context, input *PutMessagingStreamingConfigurationsInput, opts ...request.Option) (*PutMessagingStreamingConfigurationsOutput, error)

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

See PutMessagingStreamingConfigurations 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 (*ChimeSDKMessaging) RedactChannelMessage 

func (c *ChimeSDKMessaging) RedactChannelMessage(input *RedactChannelMessageInput) (*RedactChannelMessageOutput, error)

RedactChannelMessage API operation for Amazon Chime SDK Messaging.

Redacts message content, but not metadata. The message exists in the back end, but the action returns null content, and the state shows as redacted.

The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

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 Chime SDK Messaging's API operation RedactChannelMessage for usage and error information.

Returned Error Types:

  • BadRequestException The input parameters don't match the service's restrictions.

  • ForbiddenException The client is permanently forbidden from making the request.

  • ConflictException The request could not be processed because of conflict in the current state of the resource.

  • UnauthorizedClientException The client is not currently authorized to make the request.

  • ThrottledClientException The client exceeded its request rate limit.

  • ServiceUnavailableException The service is currently unavailable.

  • ServiceFailureException The service encountered an unexpected error.

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/RedactChannelMessage

func (*ChimeSDKMessaging) RedactChannelMessageRequest 

func (c *ChimeSDKMessaging) RedactChannelMessageRequest(input *RedactChannelMessageInput) (req *request.Request, output *RedactChannelMessageOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/RedactChannelMessage

func (*ChimeSDKMessaging) RedactChannelMessageWithContext 

func (c *ChimeSDKMessaging) RedactChannelMessageWithContext(ctx aws.Context, input *RedactChannelMessageInput, opts ...request.Option) (*RedactChannelMessageOutput, error)

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

See RedactChannelMessage 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 (*ChimeSDKMessaging) SearchChannels added in v1.44.28 

func (c *ChimeSDKMessaging) SearchChannels(input *SearchChannelsInput) (*SearchChannelsOutput, error)

SearchChannels API operation for Amazon Chime SDK Messaging.

Allows the ChimeBearer to search channels by channel members. Users or bots can search across the channels that they belong to. Users in the AppInstanceAdmin role can search across all channels.

The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

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 Chime SDK Messaging's API operation SearchChannels for usage and error information.

Returned Error Types:

  • BadRequestException The input parameters don't match the service's restrictions.

  • ForbiddenException The client is permanently forbidden from making the request.

  • UnauthorizedClientException The client is not currently authorized to make the request.

  • ThrottledClientException The client exceeded its request rate limit.

  • ServiceUnavailableException The service is currently unavailable.

  • ServiceFailureException The service encountered an unexpected error.

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/SearchChannels

func (*ChimeSDKMessaging) SearchChannelsPages added in v1.44.28 

func (c *ChimeSDKMessaging) SearchChannelsPages(input *SearchChannelsInput, fn func(*SearchChannelsOutput, bool) bool) error

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

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

func (*ChimeSDKMessaging) SearchChannelsPagesWithContext added in v1.44.28 

func (c *ChimeSDKMessaging) SearchChannelsPagesWithContext(ctx aws.Context, input *SearchChannelsInput, fn func(*SearchChannelsOutput, bool) bool, opts ...request.Option) error

SearchChannelsPagesWithContext same as SearchChannelsPages 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 (*ChimeSDKMessaging) SearchChannelsRequest added in v1.44.28 

func (c *ChimeSDKMessaging) SearchChannelsRequest(input *SearchChannelsInput) (req *request.Request, output *SearchChannelsOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/SearchChannels

func (*ChimeSDKMessaging) SearchChannelsWithContext added in v1.44.28 

func (c *ChimeSDKMessaging) SearchChannelsWithContext(ctx aws.Context, input *SearchChannelsInput, opts ...request.Option) (*SearchChannelsOutput, error)

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

See SearchChannels 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 (*ChimeSDKMessaging) SendChannelMessage 

func (c *ChimeSDKMessaging) SendChannelMessage(input *SendChannelMessageInput) (*SendChannelMessageOutput, error)

SendChannelMessage API operation for Amazon Chime SDK Messaging.

Sends a message to a particular channel that the member is a part of.

The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

Also, STANDARD messages can be up to 4KB in size and contain metadata. Metadata is arbitrary, and you can use it in a variety of ways, such as containing a link to an attachment.

CONTROL messages are limited to 30 bytes and do not contain metadata.

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 Chime SDK Messaging's API operation SendChannelMessage for usage and error information.

Returned Error Types:

  • BadRequestException The input parameters don't match the service's restrictions.

  • ConflictException The request could not be processed because of conflict in the current state of the resource.

  • ForbiddenException The client is permanently forbidden from making the request.

  • UnauthorizedClientException The client is not currently authorized to make the request.

  • ThrottledClientException The client exceeded its request rate limit.

  • ServiceUnavailableException The service is currently unavailable.

  • ServiceFailureException The service encountered an unexpected error.

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/SendChannelMessage

func (*ChimeSDKMessaging) SendChannelMessageRequest 

func (c *ChimeSDKMessaging) SendChannelMessageRequest(input *SendChannelMessageInput) (req *request.Request, output *SendChannelMessageOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/SendChannelMessage

func (*ChimeSDKMessaging) SendChannelMessageWithContext 

func (c *ChimeSDKMessaging) SendChannelMessageWithContext(ctx aws.Context, input *SendChannelMessageInput, opts ...request.Option) (*SendChannelMessageOutput, error)

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

See SendChannelMessage 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 (*ChimeSDKMessaging) TagResource added in v1.41.6 

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

TagResource API operation for Amazon Chime SDK Messaging.

Applies the specified tags to the specified Amazon Chime SDK messaging resource.

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

Returned Error Types:

  • BadRequestException The input parameters don't match the service's restrictions.

  • ForbiddenException The client is permanently forbidden from making the request.

  • UnauthorizedClientException The client is not currently authorized to make the request.

  • ResourceLimitExceededException The request exceeds the resource limit.

  • ThrottledClientException The client exceeded its request rate limit.

  • ServiceUnavailableException The service is currently unavailable.

  • ServiceFailureException The service encountered an unexpected error.

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/TagResource

func (*ChimeSDKMessaging) TagResourceRequest added in v1.41.6 

func (c *ChimeSDKMessaging) 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/chime-sdk-messaging-2021-05-15/TagResource

func (*ChimeSDKMessaging) TagResourceWithContext added in v1.41.6 

func (c *ChimeSDKMessaging) 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 (*ChimeSDKMessaging) UntagResource added in v1.41.6 

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

UntagResource API operation for Amazon Chime SDK Messaging.

Removes the specified tags from the specified Amazon Chime SDK messaging resource.

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

Returned Error Types:

  • BadRequestException The input parameters don't match the service's restrictions.

  • ForbiddenException The client is permanently forbidden from making the request.

  • UnauthorizedClientException The client is not currently authorized to make the request.

  • ThrottledClientException The client exceeded its request rate limit.

  • ServiceUnavailableException The service is currently unavailable.

  • ServiceFailureException The service encountered an unexpected error.

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/UntagResource

func (*ChimeSDKMessaging) UntagResourceRequest added in v1.41.6 

func (c *ChimeSDKMessaging) 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/chime-sdk-messaging-2021-05-15/UntagResource

func (*ChimeSDKMessaging) UntagResourceWithContext added in v1.41.6 

func (c *ChimeSDKMessaging) 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 (*ChimeSDKMessaging) UpdateChannel 

func (c *ChimeSDKMessaging) UpdateChannel(input *UpdateChannelInput) (*UpdateChannelOutput, error)

UpdateChannel API operation for Amazon Chime SDK Messaging.

Update a channel's attributes.

Restriction: You can't change a channel's privacy.

The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

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 Chime SDK Messaging's API operation UpdateChannel for usage and error information.

Returned Error Types:

  • BadRequestException The input parameters don't match the service's restrictions.

  • ForbiddenException The client is permanently forbidden from making the request.

  • ConflictException The request could not be processed because of conflict in the current state of the resource.

  • UnauthorizedClientException The client is not currently authorized to make the request.

  • ThrottledClientException The client exceeded its request rate limit.

  • ServiceUnavailableException The service is currently unavailable.

  • ServiceFailureException The service encountered an unexpected error.

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/UpdateChannel

func (*ChimeSDKMessaging) UpdateChannelFlow added in v1.41.6 

func (c *ChimeSDKMessaging) UpdateChannelFlow(input *UpdateChannelFlowInput) (*UpdateChannelFlowOutput, error)

UpdateChannelFlow API operation for Amazon Chime SDK Messaging.

Updates channel flow attributes. This is a developer 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 Chime SDK Messaging's API operation UpdateChannelFlow for usage and error information.

Returned Error Types:

  • BadRequestException The input parameters don't match the service's restrictions.

  • ForbiddenException The client is permanently forbidden from making the request.

  • UnauthorizedClientException The client is not currently authorized to make the request.

  • ConflictException The request could not be processed because of conflict in the current state of the resource.

  • ThrottledClientException The client exceeded its request rate limit.

  • ServiceUnavailableException The service is currently unavailable.

  • ServiceFailureException The service encountered an unexpected error.

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/UpdateChannelFlow

func (*ChimeSDKMessaging) UpdateChannelFlowRequest added in v1.41.6 

func (c *ChimeSDKMessaging) UpdateChannelFlowRequest(input *UpdateChannelFlowInput) (req *request.Request, output *UpdateChannelFlowOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/UpdateChannelFlow

func (*ChimeSDKMessaging) UpdateChannelFlowWithContext added in v1.41.6 

func (c *ChimeSDKMessaging) UpdateChannelFlowWithContext(ctx aws.Context, input *UpdateChannelFlowInput, opts ...request.Option) (*UpdateChannelFlowOutput, error)

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

See UpdateChannelFlow 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 (*ChimeSDKMessaging) UpdateChannelMessage 

func (c *ChimeSDKMessaging) UpdateChannelMessage(input *UpdateChannelMessageInput) (*UpdateChannelMessageOutput, error)

UpdateChannelMessage API operation for Amazon Chime SDK Messaging.

Updates the content of a message.

The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

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 Chime SDK Messaging's API operation UpdateChannelMessage for usage and error information.

Returned Error Types:

  • BadRequestException The input parameters don't match the service's restrictions.

  • ConflictException The request could not be processed because of conflict in the current state of the resource.

  • ForbiddenException The client is permanently forbidden from making the request.

  • UnauthorizedClientException The client is not currently authorized to make the request.

  • ThrottledClientException The client exceeded its request rate limit.

  • ServiceUnavailableException The service is currently unavailable.

  • ServiceFailureException The service encountered an unexpected error.

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/UpdateChannelMessage

func (*ChimeSDKMessaging) UpdateChannelMessageRequest 

func (c *ChimeSDKMessaging) UpdateChannelMessageRequest(input *UpdateChannelMessageInput) (req *request.Request, output *UpdateChannelMessageOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/UpdateChannelMessage

func (*ChimeSDKMessaging) UpdateChannelMessageWithContext 

func (c *ChimeSDKMessaging) UpdateChannelMessageWithContext(ctx aws.Context, input *UpdateChannelMessageInput, opts ...request.Option) (*UpdateChannelMessageOutput, error)

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

See UpdateChannelMessage 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 (*ChimeSDKMessaging) UpdateChannelReadMarker 

func (c *ChimeSDKMessaging) UpdateChannelReadMarker(input *UpdateChannelReadMarkerInput) (*UpdateChannelReadMarkerOutput, error)

UpdateChannelReadMarker API operation for Amazon Chime SDK Messaging.

The details of the time when a user last read messages in a channel.

The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

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 Chime SDK Messaging's API operation UpdateChannelReadMarker for usage and error information.

Returned Error Types:

  • BadRequestException The input parameters don't match the service's restrictions.

  • ForbiddenException The client is permanently forbidden from making the request.

  • ConflictException The request could not be processed because of conflict in the current state of the resource.

  • UnauthorizedClientException The client is not currently authorized to make the request.

  • ThrottledClientException The client exceeded its request rate limit.

  • ServiceUnavailableException The service is currently unavailable.

  • ServiceFailureException The service encountered an unexpected error.

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/UpdateChannelReadMarker

func (*ChimeSDKMessaging) UpdateChannelReadMarkerRequest 

func (c *ChimeSDKMessaging) UpdateChannelReadMarkerRequest(input *UpdateChannelReadMarkerInput) (req *request.Request, output *UpdateChannelReadMarkerOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/UpdateChannelReadMarker

func (*ChimeSDKMessaging) UpdateChannelReadMarkerWithContext 

func (c *ChimeSDKMessaging) UpdateChannelReadMarkerWithContext(ctx aws.Context, input *UpdateChannelReadMarkerInput, opts ...request.Option) (*UpdateChannelReadMarkerOutput, error)

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

See UpdateChannelReadMarker 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 (*ChimeSDKMessaging) UpdateChannelRequest 

func (c *ChimeSDKMessaging) UpdateChannelRequest(input *UpdateChannelInput) (req *request.Request, output *UpdateChannelOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/UpdateChannel

func (*ChimeSDKMessaging) UpdateChannelWithContext 

func (c *ChimeSDKMessaging) UpdateChannelWithContext(ctx aws.Context, input *UpdateChannelInput, opts ...request.Option) (*UpdateChannelOutput, error)

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

See UpdateChannel 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 ConflictException 

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

	Code_ *string `locationName:"Code" type:"string" enum:"ErrorCode"`

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

The request could not be processed because of conflict in the current state of the resource.

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 CreateChannelBanInput 

type CreateChannelBanInput struct {

	// The ARN of the ban request.
	//
	// ChannelArn is a required field
	ChannelArn *string `location:"uri" locationName:"channelArn" min:"5" type:"string" required:"true"`

	// The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
	//
	// ChimeBearer is a required field
	ChimeBearer *string `location:"header" locationName:"x-amz-chime-bearer" min:"5" type:"string" required:"true"`

	// The AppInstanceUserArn of the member being banned.
	//
	// MemberArn is a required field
	MemberArn *string `min:"5" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateChannelBanInput) GoString 

func (s CreateChannelBanInput) 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 (*CreateChannelBanInput) SetChannelArn 

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

SetChannelArn sets the ChannelArn field's value.

func (*CreateChannelBanInput) SetChimeBearer 

func (s *CreateChannelBanInput) SetChimeBearer(v string) *CreateChannelBanInput

SetChimeBearer sets the ChimeBearer field's value.

func (*CreateChannelBanInput) SetMemberArn 

func (s *CreateChannelBanInput) SetMemberArn(v string) *CreateChannelBanInput

SetMemberArn sets the MemberArn field's value.

func (CreateChannelBanInput) String 

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

func (s *CreateChannelBanInput) Validate() error

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

type CreateChannelBanOutput 

type CreateChannelBanOutput struct {

	// The ARN of the response to the ban request.
	ChannelArn *string `min:"5" type:"string"`

	// The ChannelArn and BannedIdentity of the member in the ban response.
	Member *Identity `type:"structure"`
	// contains filtered or unexported fields
}

func (CreateChannelBanOutput) GoString 

func (s CreateChannelBanOutput) 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 (*CreateChannelBanOutput) SetChannelArn 

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

SetChannelArn sets the ChannelArn field's value.

func (*CreateChannelBanOutput) SetMember 

func (s *CreateChannelBanOutput) SetMember(v *Identity) *CreateChannelBanOutput

SetMember sets the Member field's value.

func (CreateChannelBanOutput) String 

func (s CreateChannelBanOutput) 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 CreateChannelFlowInput added in v1.41.6 

type CreateChannelFlowInput struct {

	// The ARN of the channel flow request.
	//
	// AppInstanceArn is a required field
	AppInstanceArn *string `min:"5" type:"string" required:"true"`

	// The client token for the request. An Idempotency token.
	//
	// ClientRequestToken is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by CreateChannelFlowInput's
	// String and GoString methods.
	ClientRequestToken *string `min:"2" type:"string" idempotencyToken:"true" sensitive:"true"`

	// The name of the channel flow.
	//
	// Name is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by CreateChannelFlowInput's
	// String and GoString methods.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true" sensitive:"true"`

	// Information about the processor Lambda functions.
	//
	// Processors is a required field
	Processors []*Processor `min:"1" type:"list" required:"true"`

	// The tags for the creation request.
	Tags []*Tag `min:"1" type:"list"`
	// contains filtered or unexported fields
}

func (CreateChannelFlowInput) GoString added in v1.41.6 

func (s CreateChannelFlowInput) 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 (*CreateChannelFlowInput) SetAppInstanceArn added in v1.41.6 

func (s *CreateChannelFlowInput) SetAppInstanceArn(v string) *CreateChannelFlowInput

SetAppInstanceArn sets the AppInstanceArn field's value.

func (*CreateChannelFlowInput) SetClientRequestToken added in v1.41.6 

func (s *CreateChannelFlowInput) SetClientRequestToken(v string) *CreateChannelFlowInput

SetClientRequestToken sets the ClientRequestToken field's value.

func (*CreateChannelFlowInput) SetName added in v1.41.6 

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

SetName sets the Name field's value.

func (*CreateChannelFlowInput) SetProcessors added in v1.41.6 

func (s *CreateChannelFlowInput) SetProcessors(v []*Processor) *CreateChannelFlowInput

SetProcessors sets the Processors field's value.

func (*CreateChannelFlowInput) SetTags added in v1.41.6 

func (s *CreateChannelFlowInput) SetTags(v []*Tag) *CreateChannelFlowInput

SetTags sets the Tags field's value.

func (CreateChannelFlowInput) String added in v1.41.6 

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

func (s *CreateChannelFlowInput) Validate() error

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

type CreateChannelFlowOutput added in v1.41.6 

type CreateChannelFlowOutput struct {

	// The ARN of the channel flow.
	ChannelFlowArn *string `min:"5" type:"string"`
	// contains filtered or unexported fields
}

func (CreateChannelFlowOutput) GoString added in v1.41.6 

func (s CreateChannelFlowOutput) 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 (*CreateChannelFlowOutput) SetChannelFlowArn added in v1.41.6 

func (s *CreateChannelFlowOutput) SetChannelFlowArn(v string) *CreateChannelFlowOutput

SetChannelFlowArn sets the ChannelFlowArn field's value.

func (CreateChannelFlowOutput) String added in v1.41.6 

func (s CreateChannelFlowOutput) 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 CreateChannelInput 

type CreateChannelInput struct {

	// The ARN of the channel request.
	//
	// AppInstanceArn is a required field
	AppInstanceArn *string `min:"5" type:"string" required:"true"`

	// The ID of the channel in the request.
	//
	// ChannelId is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by CreateChannelInput's
	// String and GoString methods.
	ChannelId *string `min:"1" type:"string" sensitive:"true"`

	// The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
	//
	// ChimeBearer is a required field
	ChimeBearer *string `location:"header" locationName:"x-amz-chime-bearer" min:"5" type:"string" required:"true"`

	// The client token for the request. An Idempotency token.
	//
	// ClientRequestToken is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by CreateChannelInput's
	// String and GoString methods.
	ClientRequestToken *string `min:"2" type:"string" idempotencyToken:"true" sensitive:"true"`

	// The attributes required to configure and create an elastic channel. An elastic
	// channel can support a maximum of 1-million users, excluding moderators.
	ElasticChannelConfiguration *ElasticChannelConfiguration `type:"structure"`

	// Settings that control the interval after which the channel is automatically
	// deleted.
	ExpirationSettings *ExpirationSettings `type:"structure"`

	// The ARNs of the channel members in the request.
	MemberArns []*string `min:"1" type:"list"`

	// The metadata of the creation request. Limited to 1KB and UTF-8.
	//
	// Metadata is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by CreateChannelInput's
	// String and GoString methods.
	Metadata *string `type:"string" sensitive:"true"`

	// The channel mode: UNRESTRICTED or RESTRICTED. Administrators, moderators,
	// and channel members can add themselves and other members to unrestricted
	// channels. Only administrators and moderators can add members to restricted
	// channels.
	Mode *string `type:"string" enum:"ChannelMode"`

	// The ARNs of the channel moderators in the request.
	ModeratorArns []*string `min:"1" type:"list"`

	// The name of the channel.
	//
	// Name is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by CreateChannelInput's
	// String and GoString methods.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true" sensitive:"true"`

	// The channel's privacy level: PUBLIC or PRIVATE. Private channels aren't discoverable
	// by users outside the channel. Public channels are discoverable by anyone
	// in the AppInstance.
	Privacy *string `type:"string" enum:"ChannelPrivacy"`

	// The tags for the creation request.
	Tags []*Tag `min:"1" type:"list"`
	// contains filtered or unexported fields
}

func (CreateChannelInput) GoString 

func (s CreateChannelInput) 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 (*CreateChannelInput) SetAppInstanceArn 

func (s *CreateChannelInput) SetAppInstanceArn(v string) *CreateChannelInput

SetAppInstanceArn sets the AppInstanceArn field's value.

func (*CreateChannelInput) SetChannelId added in v1.44.28 

func (s *CreateChannelInput) SetChannelId(v string) *CreateChannelInput

SetChannelId sets the ChannelId field's value.

func (*CreateChannelInput) SetChimeBearer 

func (s *CreateChannelInput) SetChimeBearer(v string) *CreateChannelInput

SetChimeBearer sets the ChimeBearer field's value.

func (*CreateChannelInput) SetClientRequestToken 

func (s *CreateChannelInput) SetClientRequestToken(v string) *CreateChannelInput

SetClientRequestToken sets the ClientRequestToken field's value.

func (*CreateChannelInput) SetElasticChannelConfiguration added in v1.44.76 

func (s *CreateChannelInput) SetElasticChannelConfiguration(v *ElasticChannelConfiguration) *CreateChannelInput

SetElasticChannelConfiguration sets the ElasticChannelConfiguration field's value.

func (*CreateChannelInput) SetExpirationSettings added in v1.44.228 

func (s *CreateChannelInput) SetExpirationSettings(v *ExpirationSettings) *CreateChannelInput

SetExpirationSettings sets the ExpirationSettings field's value.

func (*CreateChannelInput) SetMemberArns added in v1.44.28 

func (s *CreateChannelInput) SetMemberArns(v []*string) *CreateChannelInput

SetMemberArns sets the MemberArns field's value.

func (*CreateChannelInput) SetMetadata 

func (s *CreateChannelInput) SetMetadata(v string) *CreateChannelInput

SetMetadata sets the Metadata field's value.

func (*CreateChannelInput) SetMode 

func (s *CreateChannelInput) SetMode(v string) *CreateChannelInput

SetMode sets the Mode field's value.

func (*CreateChannelInput) SetModeratorArns added in v1.44.28 

func (s *CreateChannelInput) SetModeratorArns(v []*string) *CreateChannelInput

SetModeratorArns sets the ModeratorArns field's value.

func (*CreateChannelInput) SetName 

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

SetName sets the Name field's value.

func (*CreateChannelInput) SetPrivacy 

func (s *CreateChannelInput) SetPrivacy(v string) *CreateChannelInput

SetPrivacy sets the Privacy field's value.

func (*CreateChannelInput) SetTags 

func (s *CreateChannelInput) SetTags(v []*Tag) *CreateChannelInput

SetTags sets the Tags field's value.

func (CreateChannelInput) String 

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

func (s *CreateChannelInput) Validate() error

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

type CreateChannelMembershipInput 

type CreateChannelMembershipInput struct {

	// The ARN of the channel to which you're adding users.
	//
	// ChannelArn is a required field
	ChannelArn *string `location:"uri" locationName:"channelArn" min:"5" type:"string" required:"true"`

	// The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
	//
	// ChimeBearer is a required field
	ChimeBearer *string `location:"header" locationName:"x-amz-chime-bearer" min:"5" type:"string" required:"true"`

	// The AppInstanceUserArn of the member you want to add to the channel.
	//
	// MemberArn is a required field
	MemberArn *string `min:"5" type:"string" required:"true"`

	// The ID of the SubChannel in the request.
	//
	// Only required when creating membership in a SubChannel for a moderator in
	// an elastic channel.
	SubChannelId *string `min:"1" type:"string"`

	// The membership type of a user, DEFAULT or HIDDEN. Default members are always
	// returned as part of ListChannelMemberships. Hidden members are only returned
	// if the type filter in ListChannelMemberships equals HIDDEN. Otherwise hidden
	// members are not returned. This is only supported by moderators.
	//
	// Type is a required field
	Type *string `type:"string" required:"true" enum:"ChannelMembershipType"`
	// contains filtered or unexported fields
}

func (CreateChannelMembershipInput) GoString 

func (s CreateChannelMembershipInput) 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 (*CreateChannelMembershipInput) SetChannelArn 

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

SetChannelArn sets the ChannelArn field's value.

func (*CreateChannelMembershipInput) SetChimeBearer 

func (s *CreateChannelMembershipInput) SetChimeBearer(v string) *CreateChannelMembershipInput

SetChimeBearer sets the ChimeBearer field's value.

func (*CreateChannelMembershipInput) SetMemberArn 

func (s *CreateChannelMembershipInput) SetMemberArn(v string) *CreateChannelMembershipInput

SetMemberArn sets the MemberArn field's value.

func (*CreateChannelMembershipInput) SetSubChannelId added in v1.44.76 

func (s *CreateChannelMembershipInput) SetSubChannelId(v string) *CreateChannelMembershipInput

SetSubChannelId sets the SubChannelId field's value.

func (*CreateChannelMembershipInput) SetType 

func (s *CreateChannelMembershipInput) SetType(v string) *CreateChannelMembershipInput

SetType sets the Type field's value.

func (CreateChannelMembershipInput) String 

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

func (s *CreateChannelMembershipInput) Validate() error

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

type CreateChannelMembershipOutput 

type CreateChannelMembershipOutput struct {

	// The ARN of the channel.
	ChannelArn *string `min:"5" type:"string"`

	// The ARN and metadata of the member being added.
	Member *Identity `type:"structure"`

	// The ID of the SubChannel in the response.
	SubChannelId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (CreateChannelMembershipOutput) GoString 

func (s CreateChannelMembershipOutput) 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 (*CreateChannelMembershipOutput) SetChannelArn 

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

SetChannelArn sets the ChannelArn field's value.

func (*CreateChannelMembershipOutput) SetMember 

func (s *CreateChannelMembershipOutput) SetMember(v *Identity) *CreateChannelMembershipOutput

SetMember sets the Member field's value.

func (*CreateChannelMembershipOutput) SetSubChannelId added in v1.44.76 

func (s *CreateChannelMembershipOutput) SetSubChannelId(v string) *CreateChannelMembershipOutput

SetSubChannelId sets the SubChannelId field's value.

func (CreateChannelMembershipOutput) String 

func (s CreateChannelMembershipOutput) 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 CreateChannelModeratorInput 

type CreateChannelModeratorInput struct {

	// The ARN of the channel.
	//
	// ChannelArn is a required field
	ChannelArn *string `location:"uri" locationName:"channelArn" min:"5" type:"string" required:"true"`

	// The AppInstanceUserArn of the moderator.
	//
	// ChannelModeratorArn is a required field
	ChannelModeratorArn *string `min:"5" type:"string" required:"true"`

	// The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
	//
	// ChimeBearer is a required field
	ChimeBearer *string `location:"header" locationName:"x-amz-chime-bearer" min:"5" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateChannelModeratorInput) GoString 

func (s CreateChannelModeratorInput) 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 (*CreateChannelModeratorInput) SetChannelArn 

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

SetChannelArn sets the ChannelArn field's value.

func (*CreateChannelModeratorInput) SetChannelModeratorArn 

func (s *CreateChannelModeratorInput) SetChannelModeratorArn(v string) *CreateChannelModeratorInput

SetChannelModeratorArn sets the ChannelModeratorArn field's value.

func (*CreateChannelModeratorInput) SetChimeBearer 

func (s *CreateChannelModeratorInput) SetChimeBearer(v string) *CreateChannelModeratorInput

SetChimeBearer sets the ChimeBearer field's value.

func (CreateChannelModeratorInput) String 

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

func (s *CreateChannelModeratorInput) Validate() error

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

type CreateChannelModeratorOutput 

type CreateChannelModeratorOutput struct {

	// The ARN of the channel.
	ChannelArn *string `min:"5" type:"string"`

	// The ARNs of the channel and the moderator.
	ChannelModerator *Identity `type:"structure"`
	// contains filtered or unexported fields
}

func (CreateChannelModeratorOutput) GoString 

func (s CreateChannelModeratorOutput) 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 (*CreateChannelModeratorOutput) SetChannelArn 

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

SetChannelArn sets the ChannelArn field's value.

func (*CreateChannelModeratorOutput) SetChannelModerator 

func (s *CreateChannelModeratorOutput) SetChannelModerator(v *Identity) *CreateChannelModeratorOutput

SetChannelModerator sets the ChannelModerator field's value.

func (CreateChannelModeratorOutput) String 

func (s CreateChannelModeratorOutput) 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 CreateChannelOutput 

type CreateChannelOutput struct {

	// The ARN of the channel.
	ChannelArn *string `min:"5" type:"string"`
	// contains filtered or unexported fields
}

func (CreateChannelOutput) GoString 

func (s CreateChannelOutput) 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 (*CreateChannelOutput) SetChannelArn 

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

SetChannelArn sets the ChannelArn field's value.

func (CreateChannelOutput) String 

func (s CreateChannelOutput) 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 DeleteChannelBanInput 

type DeleteChannelBanInput struct {

	// The ARN of the channel from which the AppInstanceUser was banned.
	//
	// ChannelArn is a required field
	ChannelArn *string `location:"uri" locationName:"channelArn" min:"5" type:"string" required:"true"`

	// The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
	//
	// ChimeBearer is a required field
	ChimeBearer *string `location:"header" locationName:"x-amz-chime-bearer" min:"5" type:"string" required:"true"`

	// The ARN of the AppInstanceUser that you want to reinstate.
	//
	// MemberArn is a required field
	MemberArn *string `location:"uri" locationName:"memberArn" min:"5" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteChannelBanInput) GoString 

func (s DeleteChannelBanInput) 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 (*DeleteChannelBanInput) SetChannelArn 

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

SetChannelArn sets the ChannelArn field's value.

func (*DeleteChannelBanInput) SetChimeBearer 

func (s *DeleteChannelBanInput) SetChimeBearer(v string) *DeleteChannelBanInput

SetChimeBearer sets the ChimeBearer field's value.

func (*DeleteChannelBanInput) SetMemberArn 

func (s *DeleteChannelBanInput) SetMemberArn(v string) *DeleteChannelBanInput

SetMemberArn sets the MemberArn field's value.

func (DeleteChannelBanInput) String 

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

func (s *DeleteChannelBanInput) Validate() error

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

type DeleteChannelBanOutput 

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

func (DeleteChannelBanOutput) GoString 

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

func (s DeleteChannelBanOutput) 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 DeleteChannelFlowInput added in v1.41.6 

type DeleteChannelFlowInput struct {

	// The ARN of the channel flow.
	//
	// ChannelFlowArn is a required field
	ChannelFlowArn *string `location:"uri" locationName:"channelFlowArn" min:"5" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteChannelFlowInput) GoString added in v1.41.6 

func (s DeleteChannelFlowInput) 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 (*DeleteChannelFlowInput) SetChannelFlowArn added in v1.41.6 

func (s *DeleteChannelFlowInput) SetChannelFlowArn(v string) *DeleteChannelFlowInput

SetChannelFlowArn sets the ChannelFlowArn field's value.

func (DeleteChannelFlowInput) String added in v1.41.6 

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

func (s *DeleteChannelFlowInput) Validate() error

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

type DeleteChannelFlowOutput added in v1.41.6 

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

func (DeleteChannelFlowOutput) GoString added in v1.41.6 

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

func (s DeleteChannelFlowOutput) 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 DeleteChannelInput 

type DeleteChannelInput struct {

	// The ARN of the channel being deleted.
	//
	// ChannelArn is a required field
	ChannelArn *string `location:"uri" locationName:"channelArn" min:"5" type:"string" required:"true"`

	// The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
	//
	// ChimeBearer is a required field
	ChimeBearer *string `location:"header" locationName:"x-amz-chime-bearer" min:"5" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteChannelInput) GoString 

func (s DeleteChannelInput) 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 (*DeleteChannelInput) SetChannelArn 

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

SetChannelArn sets the ChannelArn field's value.

func (*DeleteChannelInput) SetChimeBearer 

func (s *DeleteChannelInput) SetChimeBearer(v string) *DeleteChannelInput

SetChimeBearer sets the ChimeBearer field's value.

func (DeleteChannelInput) String 

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

func (s *DeleteChannelInput) Validate() error

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

type DeleteChannelMembershipInput 

type DeleteChannelMembershipInput struct {

	// The ARN of the channel from which you want to remove the user.
	//
	// ChannelArn is a required field
	ChannelArn *string `location:"uri" locationName:"channelArn" min:"5" type:"string" required:"true"`

	// The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
	//
	// ChimeBearer is a required field
	ChimeBearer *string `location:"header" locationName:"x-amz-chime-bearer" min:"5" type:"string" required:"true"`

	// The AppInstanceUserArn of the member that you're removing from the channel.
	//
	// MemberArn is a required field
	MemberArn *string `location:"uri" locationName:"memberArn" min:"5" type:"string" required:"true"`

	// The ID of the SubChannel in the request.
	//
	// Only for use by moderators.
	SubChannelId *string `location:"querystring" locationName:"sub-channel-id" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DeleteChannelMembershipInput) GoString 

func (s DeleteChannelMembershipInput) 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 (*DeleteChannelMembershipInput) SetChannelArn 

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

SetChannelArn sets the ChannelArn field's value.

func (*DeleteChannelMembershipInput) SetChimeBearer 

func (s *DeleteChannelMembershipInput) SetChimeBearer(v string) *DeleteChannelMembershipInput

SetChimeBearer sets the ChimeBearer field's value.

func (*DeleteChannelMembershipInput) SetMemberArn 

func (s *DeleteChannelMembershipInput) SetMemberArn(v string) *DeleteChannelMembershipInput

SetMemberArn sets the MemberArn field's value.

func (*DeleteChannelMembershipInput) SetSubChannelId added in v1.44.76 

func (s *DeleteChannelMembershipInput) SetSubChannelId(v string) *DeleteChannelMembershipInput

SetSubChannelId sets the SubChannelId field's value.

func (DeleteChannelMembershipInput) String 

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

func (s *DeleteChannelMembershipInput) Validate() error

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

type DeleteChannelMembershipOutput 

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

func (DeleteChannelMembershipOutput) GoString 

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

func (s DeleteChannelMembershipOutput) 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 DeleteChannelMessageInput 

type DeleteChannelMessageInput struct {

	// The ARN of the channel.
	//
	// ChannelArn is a required field
	ChannelArn *string `location:"uri" locationName:"channelArn" min:"5" type:"string" required:"true"`

	// The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
	//
	// ChimeBearer is a required field
	ChimeBearer *string `location:"header" locationName:"x-amz-chime-bearer" min:"5" type:"string" required:"true"`

	// The ID of the message being deleted.
	//
	// MessageId is a required field
	MessageId *string `location:"uri" locationName:"messageId" min:"1" type:"string" required:"true"`

	// The ID of the SubChannel in the request.
	//
	// Only required when deleting messages in a SubChannel that the user belongs
	// to.
	SubChannelId *string `location:"querystring" locationName:"sub-channel-id" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DeleteChannelMessageInput) GoString 

func (s DeleteChannelMessageInput) 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 (*DeleteChannelMessageInput) SetChannelArn 

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

SetChannelArn sets the ChannelArn field's value.

func (*DeleteChannelMessageInput) SetChimeBearer 

func (s *DeleteChannelMessageInput) SetChimeBearer(v string) *DeleteChannelMessageInput

SetChimeBearer sets the ChimeBearer field's value.

func (*DeleteChannelMessageInput) SetMessageId 

func (s *DeleteChannelMessageInput) SetMessageId(v string) *DeleteChannelMessageInput

SetMessageId sets the MessageId field's value.

func (*DeleteChannelMessageInput) SetSubChannelId added in v1.44.76 

func (s *DeleteChannelMessageInput) SetSubChannelId(v string) *DeleteChannelMessageInput

SetSubChannelId sets the SubChannelId field's value.

func (DeleteChannelMessageInput) String 

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

func (s *DeleteChannelMessageInput) Validate() error

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

type DeleteChannelMessageOutput 

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

func (DeleteChannelMessageOutput) GoString 

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

func (s DeleteChannelMessageOutput) 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 DeleteChannelModeratorInput 

type DeleteChannelModeratorInput struct {

	// The ARN of the channel.
	//
	// ChannelArn is a required field
	ChannelArn *string `location:"uri" locationName:"channelArn" min:"5" type:"string" required:"true"`

	// The AppInstanceUserArn of the moderator being deleted.
	//
	// ChannelModeratorArn is a required field
	ChannelModeratorArn *string `location:"uri" locationName:"channelModeratorArn" min:"5" type:"string" required:"true"`

	// The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
	//
	// ChimeBearer is a required field
	ChimeBearer *string `location:"header" locationName:"x-amz-chime-bearer" min:"5" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteChannelModeratorInput) GoString 

func (s DeleteChannelModeratorInput) 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 (*DeleteChannelModeratorInput) SetChannelArn 

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

SetChannelArn sets the ChannelArn field's value.

func (*DeleteChannelModeratorInput) SetChannelModeratorArn 

func (s *DeleteChannelModeratorInput) SetChannelModeratorArn(v string) *DeleteChannelModeratorInput

SetChannelModeratorArn sets the ChannelModeratorArn field's value.

func (*DeleteChannelModeratorInput) SetChimeBearer 

func (s *DeleteChannelModeratorInput) SetChimeBearer(v string) *DeleteChannelModeratorInput

SetChimeBearer sets the ChimeBearer field's value.

func (DeleteChannelModeratorInput) String 

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

func (s *DeleteChannelModeratorInput) Validate() error

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

type DeleteChannelModeratorOutput 

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

func (DeleteChannelModeratorOutput) GoString 

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

func (s DeleteChannelModeratorOutput) 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 DeleteChannelOutput 

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

func (DeleteChannelOutput) GoString 

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

func (s DeleteChannelOutput) 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 DeleteMessagingStreamingConfigurationsInput added in v1.44.226 

type DeleteMessagingStreamingConfigurationsInput struct {

	// The ARN of the streaming configurations being deleted.
	//
	// AppInstanceArn is a required field
	AppInstanceArn *string `location:"uri" locationName:"appInstanceArn" min:"5" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteMessagingStreamingConfigurationsInput) GoString added in v1.44.226 

func (s DeleteMessagingStreamingConfigurationsInput) 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 (*DeleteMessagingStreamingConfigurationsInput) SetAppInstanceArn added in v1.44.226 

func (s *DeleteMessagingStreamingConfigurationsInput) SetAppInstanceArn(v string) *DeleteMessagingStreamingConfigurationsInput

SetAppInstanceArn sets the AppInstanceArn field's value.

func (DeleteMessagingStreamingConfigurationsInput) String added in v1.44.226 

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

func (s *DeleteMessagingStreamingConfigurationsInput) Validate() error

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

type DeleteMessagingStreamingConfigurationsOutput added in v1.44.226 

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

func (DeleteMessagingStreamingConfigurationsOutput) GoString added in v1.44.226 

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

func (s DeleteMessagingStreamingConfigurationsOutput) 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 DescribeChannelBanInput 

type DescribeChannelBanInput struct {

	// The ARN of the channel from which the user is banned.
	//
	// ChannelArn is a required field
	ChannelArn *string `location:"uri" locationName:"channelArn" min:"5" type:"string" required:"true"`

	// The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
	//
	// ChimeBearer is a required field
	ChimeBearer *string `location:"header" locationName:"x-amz-chime-bearer" min:"5" type:"string" required:"true"`

	// The AppInstanceUserArn of the member being banned.
	//
	// MemberArn is a required field
	MemberArn *string `location:"uri" locationName:"memberArn" min:"5" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeChannelBanInput) GoString 

func (s DescribeChannelBanInput) 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 (*DescribeChannelBanInput) SetChannelArn 

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

SetChannelArn sets the ChannelArn field's value.

func (*DescribeChannelBanInput) SetChimeBearer 

func (s *DescribeChannelBanInput) SetChimeBearer(v string) *DescribeChannelBanInput

SetChimeBearer sets the ChimeBearer field's value.

func (*DescribeChannelBanInput) SetMemberArn 

func (s *DescribeChannelBanInput) SetMemberArn(v string) *DescribeChannelBanInput

SetMemberArn sets the MemberArn field's value.

func (DescribeChannelBanInput) String 

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

func (s *DescribeChannelBanInput) Validate() error

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

type DescribeChannelBanOutput 

type DescribeChannelBanOutput struct {

	// The details of the ban.
	ChannelBan *ChannelBan `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeChannelBanOutput) GoString 

func (s DescribeChannelBanOutput) 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 (*DescribeChannelBanOutput) SetChannelBan 

func (s *DescribeChannelBanOutput) SetChannelBan(v *ChannelBan) *DescribeChannelBanOutput

SetChannelBan sets the ChannelBan field's value.

func (DescribeChannelBanOutput) String 

func (s DescribeChannelBanOutput) 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 DescribeChannelFlowInput added in v1.41.6 

type DescribeChannelFlowInput struct {

	// The ARN of the channel flow.
	//
	// ChannelFlowArn is a required field
	ChannelFlowArn *string `location:"uri" locationName:"channelFlowArn" min:"5" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeChannelFlowInput) GoString added in v1.41.6 

func (s DescribeChannelFlowInput) 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 (*DescribeChannelFlowInput) SetChannelFlowArn added in v1.41.6 

func (s *DescribeChannelFlowInput) SetChannelFlowArn(v string) *DescribeChannelFlowInput

SetChannelFlowArn sets the ChannelFlowArn field's value.

func (DescribeChannelFlowInput) String added in v1.41.6 

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

func (s *DescribeChannelFlowInput) Validate() error

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

type DescribeChannelFlowOutput added in v1.41.6 

type DescribeChannelFlowOutput struct {

	// The channel flow details.
	ChannelFlow *ChannelFlow `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeChannelFlowOutput) GoString added in v1.41.6 

func (s DescribeChannelFlowOutput) 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 (*DescribeChannelFlowOutput) SetChannelFlow added in v1.41.6 

func (s *DescribeChannelFlowOutput) SetChannelFlow(v *ChannelFlow) *DescribeChannelFlowOutput

SetChannelFlow sets the ChannelFlow field's value.

func (DescribeChannelFlowOutput) String added in v1.41.6 

func (s DescribeChannelFlowOutput) 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 DescribeChannelInput 

type DescribeChannelInput struct {

	// The ARN of the channel.
	//
	// ChannelArn is a required field
	ChannelArn *string `location:"uri" locationName:"channelArn" min:"5" type:"string" required:"true"`

	// The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
	//
	// ChimeBearer is a required field
	ChimeBearer *string `location:"header" locationName:"x-amz-chime-bearer" min:"5" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeChannelInput) GoString 

func (s DescribeChannelInput) 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 (*DescribeChannelInput) SetChannelArn 

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

SetChannelArn sets the ChannelArn field's value.

func (*DescribeChannelInput) SetChimeBearer 

func (s *DescribeChannelInput) SetChimeBearer(v string) *DescribeChannelInput

SetChimeBearer sets the ChimeBearer field's value.

func (DescribeChannelInput) String 

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

func (s *DescribeChannelInput) Validate() error

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

type DescribeChannelMembershipForAppInstanceUserInput 

type DescribeChannelMembershipForAppInstanceUserInput struct {

	// The ARN of the user or bot in a channel.
	//
	// AppInstanceUserArn is a required field
	AppInstanceUserArn *string `location:"querystring" locationName:"app-instance-user-arn" min:"5" type:"string" required:"true"`

	// The ARN of the channel to which the user belongs.
	//
	// ChannelArn is a required field
	ChannelArn *string `location:"uri" locationName:"channelArn" min:"5" type:"string" required:"true"`

	// The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
	//
	// ChimeBearer is a required field
	ChimeBearer *string `location:"header" locationName:"x-amz-chime-bearer" min:"5" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeChannelMembershipForAppInstanceUserInput) GoString 

func (s DescribeChannelMembershipForAppInstanceUserInput) 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 (*DescribeChannelMembershipForAppInstanceUserInput) SetAppInstanceUserArn 

func (s *DescribeChannelMembershipForAppInstanceUserInput) SetAppInstanceUserArn(v string) *DescribeChannelMembershipForAppInstanceUserInput

SetAppInstanceUserArn sets the AppInstanceUserArn field's value.

func (*DescribeChannelMembershipForAppInstanceUserInput) SetChannelArn 

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

SetChannelArn sets the ChannelArn field's value.

func (*DescribeChannelMembershipForAppInstanceUserInput) SetChimeBearer 

func (s *DescribeChannelMembershipForAppInstanceUserInput) SetChimeBearer(v string) *DescribeChannelMembershipForAppInstanceUserInput

SetChimeBearer sets the ChimeBearer field's value.

func (DescribeChannelMembershipForAppInstanceUserInput) String 

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

func (s *DescribeChannelMembershipForAppInstanceUserInput) Validate() error

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

type DescribeChannelMembershipForAppInstanceUserOutput 

type DescribeChannelMembershipForAppInstanceUserOutput struct {

	// The channel to which a user belongs.
	ChannelMembership *ChannelMembershipForAppInstanceUserSummary `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeChannelMembershipForAppInstanceUserOutput) GoString 

func (s DescribeChannelMembershipForAppInstanceUserOutput) 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 (*DescribeChannelMembershipForAppInstanceUserOutput) SetChannelMembership 

func (s *DescribeChannelMembershipForAppInstanceUserOutput) SetChannelMembership(v *ChannelMembershipForAppInstanceUserSummary) *DescribeChannelMembershipForAppInstanceUserOutput

SetChannelMembership sets the ChannelMembership field's value.

func (DescribeChannelMembershipForAppInstanceUserOutput) String 

func (s DescribeChannelMembershipForAppInstanceUserOutput) 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 DescribeChannelMembershipInput 

type DescribeChannelMembershipInput struct {

	// The ARN of the channel.
	//
	// ChannelArn is a required field
	ChannelArn *string `location:"uri" locationName:"channelArn" min:"5" type:"string" required:"true"`

	// The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
	//
	// ChimeBearer is a required field
	ChimeBearer *string `location:"header" locationName:"x-amz-chime-bearer" min:"5" type:"string" required:"true"`

	// The AppInstanceUserArn of the member.
	//
	// MemberArn is a required field
	MemberArn *string `location:"uri" locationName:"memberArn" min:"5" type:"string" required:"true"`

	// The ID of the SubChannel in the request. The response contains an ElasticChannelConfiguration
	// object.
	//
	// Only required to get a user’s SubChannel membership details.
	SubChannelId *string `location:"querystring" locationName:"sub-channel-id" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeChannelMembershipInput) GoString 

func (s DescribeChannelMembershipInput) 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 (*DescribeChannelMembershipInput) SetChannelArn 

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

SetChannelArn sets the ChannelArn field's value.

func (*DescribeChannelMembershipInput) SetChimeBearer 

func (s *DescribeChannelMembershipInput) SetChimeBearer(v string) *DescribeChannelMembershipInput

SetChimeBearer sets the ChimeBearer field's value.

func (*DescribeChannelMembershipInput) SetMemberArn 

func (s *DescribeChannelMembershipInput) SetMemberArn(v string) *DescribeChannelMembershipInput

SetMemberArn sets the MemberArn field's value.

func (*DescribeChannelMembershipInput) SetSubChannelId added in v1.44.76 

func (s *DescribeChannelMembershipInput) SetSubChannelId(v string) *DescribeChannelMembershipInput

SetSubChannelId sets the SubChannelId field's value.

func (DescribeChannelMembershipInput) String 

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

func (s *DescribeChannelMembershipInput) Validate() error

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

type DescribeChannelMembershipOutput 

type DescribeChannelMembershipOutput struct {

	// The details of the membership.
	ChannelMembership *ChannelMembership `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeChannelMembershipOutput) GoString 

func (s DescribeChannelMembershipOutput) 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 (*DescribeChannelMembershipOutput) SetChannelMembership 

func (s *DescribeChannelMembershipOutput) SetChannelMembership(v *ChannelMembership) *DescribeChannelMembershipOutput

SetChannelMembership sets the ChannelMembership field's value.

func (DescribeChannelMembershipOutput) String 

func (s DescribeChannelMembershipOutput) 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 DescribeChannelModeratedByAppInstanceUserInput 

type DescribeChannelModeratedByAppInstanceUserInput struct {

	// The ARN of the user or bot in the moderated channel.
	//
	// AppInstanceUserArn is a required field
	AppInstanceUserArn *string `location:"querystring" locationName:"app-instance-user-arn" min:"5" type:"string" required:"true"`

	// The ARN of the moderated channel.
	//
	// ChannelArn is a required field
	ChannelArn *string `location:"uri" locationName:"channelArn" min:"5" type:"string" required:"true"`

	// The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
	//
	// ChimeBearer is a required field
	ChimeBearer *string `location:"header" locationName:"x-amz-chime-bearer" min:"5" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeChannelModeratedByAppInstanceUserInput) GoString 

func (s DescribeChannelModeratedByAppInstanceUserInput) 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 (*DescribeChannelModeratedByAppInstanceUserInput) SetAppInstanceUserArn 

func (s *DescribeChannelModeratedByAppInstanceUserInput) SetAppInstanceUserArn(v string) *DescribeChannelModeratedByAppInstanceUserInput

SetAppInstanceUserArn sets the AppInstanceUserArn field's value.

func (*DescribeChannelModeratedByAppInstanceUserInput) SetChannelArn 

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

SetChannelArn sets the ChannelArn field's value.

func (*DescribeChannelModeratedByAppInstanceUserInput) SetChimeBearer 

func (s *DescribeChannelModeratedByAppInstanceUserInput) SetChimeBearer(v string) *DescribeChannelModeratedByAppInstanceUserInput

SetChimeBearer sets the ChimeBearer field's value.

func (DescribeChannelModeratedByAppInstanceUserInput) String 

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

func (s *DescribeChannelModeratedByAppInstanceUserInput) Validate() error

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

type DescribeChannelModeratedByAppInstanceUserOutput 

type DescribeChannelModeratedByAppInstanceUserOutput struct {

	// The moderated channel.
	Channel *ChannelModeratedByAppInstanceUserSummary `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeChannelModeratedByAppInstanceUserOutput) GoString 

func (s DescribeChannelModeratedByAppInstanceUserOutput) 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 (*DescribeChannelModeratedByAppInstanceUserOutput) SetChannel 

func (s *DescribeChannelModeratedByAppInstanceUserOutput) SetChannel(v *ChannelModeratedByAppInstanceUserSummary) *DescribeChannelModeratedByAppInstanceUserOutput

SetChannel sets the Channel field's value.

func (DescribeChannelModeratedByAppInstanceUserOutput) String 

func (s DescribeChannelModeratedByAppInstanceUserOutput) 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 DescribeChannelModeratorInput 

type DescribeChannelModeratorInput struct {

	// The ARN of the channel.
	//
	// ChannelArn is a required field
	ChannelArn *string `location:"uri" locationName:"channelArn" min:"5" type:"string" required:"true"`

	// The AppInstanceUserArn of the channel moderator.
	//
	// ChannelModeratorArn is a required field
	ChannelModeratorArn *string `location:"uri" locationName:"channelModeratorArn" min:"5" type:"string" required:"true"`

	// The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
	//
	// ChimeBearer is a required field
	ChimeBearer *string `location:"header" locationName:"x-amz-chime-bearer" min:"5" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeChannelModeratorInput) GoString 

func (s DescribeChannelModeratorInput) 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 (*DescribeChannelModeratorInput) SetChannelArn 

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

SetChannelArn sets the ChannelArn field's value.

func (*DescribeChannelModeratorInput) SetChannelModeratorArn 

func (s *DescribeChannelModeratorInput) SetChannelModeratorArn(v string) *DescribeChannelModeratorInput

SetChannelModeratorArn sets the ChannelModeratorArn field's value.

func (*DescribeChannelModeratorInput) SetChimeBearer 

func (s *DescribeChannelModeratorInput) SetChimeBearer(v string) *DescribeChannelModeratorInput

SetChimeBearer sets the ChimeBearer field's value.

func (DescribeChannelModeratorInput) String 

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

func (s *DescribeChannelModeratorInput) Validate() error

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

type DescribeChannelModeratorOutput 

type DescribeChannelModeratorOutput struct {

	// The details of the channel moderator.
	ChannelModerator *ChannelModerator `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeChannelModeratorOutput) GoString 

func (s DescribeChannelModeratorOutput) 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 (*DescribeChannelModeratorOutput) SetChannelModerator 

func (s *DescribeChannelModeratorOutput) SetChannelModerator(v *ChannelModerator) *DescribeChannelModeratorOutput

SetChannelModerator sets the ChannelModerator field's value.

func (DescribeChannelModeratorOutput) String 

func (s DescribeChannelModeratorOutput) 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 DescribeChannelOutput 

type DescribeChannelOutput struct {

	// The channel details.
	Channel *Channel `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeChannelOutput) GoString 

func (s DescribeChannelOutput) 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 (*DescribeChannelOutput) SetChannel 

func (s *DescribeChannelOutput) SetChannel(v *Channel) *DescribeChannelOutput

SetChannel sets the Channel field's value.

func (DescribeChannelOutput) String 

func (s DescribeChannelOutput) 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 DisassociateChannelFlowInput added in v1.41.6 

type DisassociateChannelFlowInput struct {

	// The ARN of the channel.
	//
	// ChannelArn is a required field
	ChannelArn *string `location:"uri" locationName:"channelArn" min:"5" type:"string" required:"true"`

	// The ARN of the channel flow.
	//
	// ChannelFlowArn is a required field
	ChannelFlowArn *string `location:"uri" locationName:"channelFlowArn" min:"5" type:"string" required:"true"`

	// The AppInstanceUserArn of the user making the API call.
	//
	// ChimeBearer is a required field
	ChimeBearer *string `location:"header" locationName:"x-amz-chime-bearer" min:"5" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DisassociateChannelFlowInput) GoString added in v1.41.6 

func (s DisassociateChannelFlowInput) 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 (*DisassociateChannelFlowInput) SetChannelArn added in v1.41.6 

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

SetChannelArn sets the ChannelArn field's value.

func (*DisassociateChannelFlowInput) SetChannelFlowArn added in v1.41.6 

func (s *DisassociateChannelFlowInput) SetChannelFlowArn(v string) *DisassociateChannelFlowInput

SetChannelFlowArn sets the ChannelFlowArn field's value.

func (*DisassociateChannelFlowInput) SetChimeBearer added in v1.41.6 

func (s *DisassociateChannelFlowInput) SetChimeBearer(v string) *DisassociateChannelFlowInput

SetChimeBearer sets the ChimeBearer field's value.

func (DisassociateChannelFlowInput) String added in v1.41.6 

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

func (s *DisassociateChannelFlowInput) Validate() error

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

type DisassociateChannelFlowOutput added in v1.41.6 

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

func (DisassociateChannelFlowOutput) GoString added in v1.41.6 

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

func (s DisassociateChannelFlowOutput) 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 ElasticChannelConfiguration added in v1.44.76 

type ElasticChannelConfiguration struct {

	// The maximum number of SubChannels that you want to allow in the elastic channel.
	//
	// MaximumSubChannels is a required field
	MaximumSubChannels *int64 `min:"2" type:"integer" required:"true"`

	// The minimum allowed percentage of TargetMembershipsPerSubChannel users. Ceil
	// of the calculated value is used in balancing members among SubChannels of
	// the elastic channel.
	//
	// MinimumMembershipPercentage is a required field
	MinimumMembershipPercentage *int64 `min:"1" type:"integer" required:"true"`

	// The maximum number of members allowed in a SubChannel.
	//
	// TargetMembershipsPerSubChannel is a required field
	TargetMembershipsPerSubChannel *int64 `min:"2" type:"integer" required:"true"`
	// contains filtered or unexported fields
}

The attributes required to configure and create an elastic channel. An elastic channel can support a maximum of 1-million members.

func (ElasticChannelConfiguration) GoString added in v1.44.76 

func (s ElasticChannelConfiguration) 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 (*ElasticChannelConfiguration) SetMaximumSubChannels added in v1.44.76 

func (s *ElasticChannelConfiguration) SetMaximumSubChannels(v int64) *ElasticChannelConfiguration

SetMaximumSubChannels sets the MaximumSubChannels field's value.

func (*ElasticChannelConfiguration) SetMinimumMembershipPercentage added in v1.44.76 

func (s *ElasticChannelConfiguration) SetMinimumMembershipPercentage(v int64) *ElasticChannelConfiguration

SetMinimumMembershipPercentage sets the MinimumMembershipPercentage field's value.

func (*ElasticChannelConfiguration) SetTargetMembershipsPerSubChannel added in v1.44.76 

func (s *ElasticChannelConfiguration) SetTargetMembershipsPerSubChannel(v int64) *ElasticChannelConfiguration

SetTargetMembershipsPerSubChannel sets the TargetMembershipsPerSubChannel field's value.

func (ElasticChannelConfiguration) String added in v1.44.76 

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

func (s *ElasticChannelConfiguration) Validate() error

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

type ExpirationSettings added in v1.44.228 

type ExpirationSettings struct {

	// The conditions that must be met for a channel to expire.
	//
	// ExpirationCriterion is a required field
	ExpirationCriterion *string `type:"string" required:"true" enum:"ExpirationCriterion"`

	// The period in days after which the system automatically deletes a channel.
	//
	// ExpirationDays is a required field
	ExpirationDays *int64 `min:"1" type:"integer" required:"true"`
	// contains filtered or unexported fields
}

Settings that control the interval after which a channel is deleted.

func (ExpirationSettings) GoString added in v1.44.228 

func (s ExpirationSettings) 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 (*ExpirationSettings) SetExpirationCriterion added in v1.44.228 

func (s *ExpirationSettings) SetExpirationCriterion(v string) *ExpirationSettings

SetExpirationCriterion sets the ExpirationCriterion field's value.

func (*ExpirationSettings) SetExpirationDays added in v1.44.228 

func (s *ExpirationSettings) SetExpirationDays(v int64) *ExpirationSettings

SetExpirationDays sets the ExpirationDays field's value.

func (ExpirationSettings) String added in v1.44.228 

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

func (s *ExpirationSettings) Validate() error

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

type ForbiddenException 

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

	Code_ *string `locationName:"Code" type:"string" enum:"ErrorCode"`

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

The client is permanently forbidden from making the request.

func (*ForbiddenException) Code 

func (s *ForbiddenException) Code() string

Code returns the exception type name.

func (*ForbiddenException) Error 

func (s *ForbiddenException) Error() string

func (ForbiddenException) GoString 

func (s ForbiddenException) 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 (*ForbiddenException) Message 

func (s *ForbiddenException) Message() string

Message returns the exception's message.

func (*ForbiddenException) OrigErr 

func (s *ForbiddenException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ForbiddenException) RequestID 

func (s *ForbiddenException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ForbiddenException) StatusCode 

func (s *ForbiddenException) StatusCode() int

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

func (ForbiddenException) String 

func (s ForbiddenException) 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 GetChannelMembershipPreferencesInput added in v1.41.11 

type GetChannelMembershipPreferencesInput struct {

	// The ARN of the channel.
	//
	// ChannelArn is a required field
	ChannelArn *string `location:"uri" locationName:"channelArn" min:"5" type:"string" required:"true"`

	// The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
	//
	// ChimeBearer is a required field
	ChimeBearer *string `location:"header" locationName:"x-amz-chime-bearer" min:"5" type:"string" required:"true"`

	// The AppInstanceUserArn of the member retrieving the preferences.
	//
	// MemberArn is a required field
	MemberArn *string `location:"uri" locationName:"memberArn" min:"5" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetChannelMembershipPreferencesInput) GoString added in v1.41.11 

func (s GetChannelMembershipPreferencesInput) 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 (*GetChannelMembershipPreferencesInput) SetChannelArn added in v1.41.11 

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

SetChannelArn sets the ChannelArn field's value.

func (*GetChannelMembershipPreferencesInput) SetChimeBearer added in v1.41.11 

func (s *GetChannelMembershipPreferencesInput) SetChimeBearer(v string) *GetChannelMembershipPreferencesInput

SetChimeBearer sets the ChimeBearer field's value.

func (*GetChannelMembershipPreferencesInput) SetMemberArn added in v1.41.11 

func (s *GetChannelMembershipPreferencesInput) SetMemberArn(v string) *GetChannelMembershipPreferencesInput

SetMemberArn sets the MemberArn field's value.

func (GetChannelMembershipPreferencesInput) String added in v1.41.11 

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

func (s *GetChannelMembershipPreferencesInput) Validate() error

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

type GetChannelMembershipPreferencesOutput added in v1.41.11 

type GetChannelMembershipPreferencesOutput struct {

	// The ARN of the channel.
	ChannelArn *string `min:"5" type:"string"`

	// The details of a user.
	Member *Identity `type:"structure"`

	// The channel membership preferences for an AppInstanceUser .
	Preferences *ChannelMembershipPreferences `type:"structure"`
	// contains filtered or unexported fields
}

func (GetChannelMembershipPreferencesOutput) GoString added in v1.41.11 

func (s GetChannelMembershipPreferencesOutput) 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 (*GetChannelMembershipPreferencesOutput) SetChannelArn added in v1.41.11 

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

SetChannelArn sets the ChannelArn field's value.

func (*GetChannelMembershipPreferencesOutput) SetMember added in v1.41.11 

func (s *GetChannelMembershipPreferencesOutput) SetMember(v *Identity) *GetChannelMembershipPreferencesOutput

SetMember sets the Member field's value.

func (*GetChannelMembershipPreferencesOutput) SetPreferences added in v1.41.11 

func (s *GetChannelMembershipPreferencesOutput) SetPreferences(v *ChannelMembershipPreferences) *GetChannelMembershipPreferencesOutput

SetPreferences sets the Preferences field's value.

func (GetChannelMembershipPreferencesOutput) String added in v1.41.11 

func (s GetChannelMembershipPreferencesOutput) 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 GetChannelMessageInput 

type GetChannelMessageInput struct {

	// The ARN of the channel.
	//
	// ChannelArn is a required field
	ChannelArn *string `location:"uri" locationName:"channelArn" min:"5" type:"string" required:"true"`

	// The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
	//
	// ChimeBearer is a required field
	ChimeBearer *string `location:"header" locationName:"x-amz-chime-bearer" min:"5" type:"string" required:"true"`

	// The ID of the message.
	//
	// MessageId is a required field
	MessageId *string `location:"uri" locationName:"messageId" min:"1" type:"string" required:"true"`

	// The ID of the SubChannel in the request.
	//
	// Only required when getting messages in a SubChannel that the user belongs
	// to.
	SubChannelId *string `location:"querystring" locationName:"sub-channel-id" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (GetChannelMessageInput) GoString 

func (s GetChannelMessageInput) 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 (*GetChannelMessageInput) SetChannelArn 

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

SetChannelArn sets the ChannelArn field's value.

func (*GetChannelMessageInput) SetChimeBearer 

func (s *GetChannelMessageInput) SetChimeBearer(v string) *GetChannelMessageInput

SetChimeBearer sets the ChimeBearer field's value.

func (*GetChannelMessageInput) SetMessageId 

func (s *GetChannelMessageInput) SetMessageId(v string) *GetChannelMessageInput

SetMessageId sets the MessageId field's value.

func (*GetChannelMessageInput) SetSubChannelId added in v1.44.76 

func (s *GetChannelMessageInput) SetSubChannelId(v string) *GetChannelMessageInput

SetSubChannelId sets the SubChannelId field's value.

func (GetChannelMessageInput) String 

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

func (s *GetChannelMessageInput) Validate() error

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

type GetChannelMessageOutput 

type GetChannelMessageOutput struct {

	// The details of and content in the message.
	ChannelMessage *ChannelMessage `type:"structure"`
	// contains filtered or unexported fields
}

func (GetChannelMessageOutput) GoString 

func (s GetChannelMessageOutput) 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 (*GetChannelMessageOutput) SetChannelMessage 

func (s *GetChannelMessageOutput) SetChannelMessage(v *ChannelMessage) *GetChannelMessageOutput

SetChannelMessage sets the ChannelMessage field's value.

func (GetChannelMessageOutput) String 

func (s GetChannelMessageOutput) 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 GetChannelMessageStatusInput added in v1.41.6 

type GetChannelMessageStatusInput struct {

	// The ARN of the channel
	//
	// ChannelArn is a required field
	ChannelArn *string `location:"uri" locationName:"channelArn" min:"5" type:"string" required:"true"`

	// The AppInstanceUserArn of the user making the API call.
	//
	// ChimeBearer is a required field
	ChimeBearer *string `location:"header" locationName:"x-amz-chime-bearer" min:"5" type:"string" required:"true"`

	// The ID of the message.
	//
	// MessageId is a required field
	MessageId *string `location:"uri" locationName:"messageId" min:"1" type:"string" required:"true"`

	// The ID of the SubChannel in the request.
	//
	// Only required when getting message status in a SubChannel that the user belongs
	// to.
	SubChannelId *string `location:"querystring" locationName:"sub-channel-id" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (GetChannelMessageStatusInput) GoString added in v1.41.6 

func (s GetChannelMessageStatusInput) 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 (*GetChannelMessageStatusInput) SetChannelArn added in v1.41.6 

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

SetChannelArn sets the ChannelArn field's value.

func (*GetChannelMessageStatusInput) SetChimeBearer added in v1.41.6 

func (s *GetChannelMessageStatusInput) SetChimeBearer(v string) *GetChannelMessageStatusInput

SetChimeBearer sets the ChimeBearer field's value.

func (*GetChannelMessageStatusInput) SetMessageId added in v1.41.6 

func (s *GetChannelMessageStatusInput) SetMessageId(v string) *GetChannelMessageStatusInput

SetMessageId sets the MessageId field's value.

func (*GetChannelMessageStatusInput) SetSubChannelId added in v1.44.76 

func (s *GetChannelMessageStatusInput) SetSubChannelId(v string) *GetChannelMessageStatusInput

SetSubChannelId sets the SubChannelId field's value.

func (GetChannelMessageStatusInput) String added in v1.41.6 

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

func (s *GetChannelMessageStatusInput) Validate() error

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

type GetChannelMessageStatusOutput added in v1.41.6 

type GetChannelMessageStatusOutput struct {

	// The message status and details.
	Status *ChannelMessageStatusStructure `type:"structure"`
	// contains filtered or unexported fields
}

func (GetChannelMessageStatusOutput) GoString added in v1.41.6 

func (s GetChannelMessageStatusOutput) 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 (*GetChannelMessageStatusOutput) SetStatus added in v1.41.6 

func (s *GetChannelMessageStatusOutput) SetStatus(v *ChannelMessageStatusStructure) *GetChannelMessageStatusOutput

SetStatus sets the Status field's value.

func (GetChannelMessageStatusOutput) String added in v1.41.6 

func (s GetChannelMessageStatusOutput) 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 GetMessagingSessionEndpointInput 

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

func (GetMessagingSessionEndpointInput) GoString 

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

func (s GetMessagingSessionEndpointInput) 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 GetMessagingSessionEndpointOutput 

type GetMessagingSessionEndpointOutput struct {

	// The endpoint returned in the response.
	Endpoint *MessagingSessionEndpoint `type:"structure"`
	// contains filtered or unexported fields
}

func (GetMessagingSessionEndpointOutput) GoString 

func (s GetMessagingSessionEndpointOutput) 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 (*GetMessagingSessionEndpointOutput) SetEndpoint 

func (s *GetMessagingSessionEndpointOutput) SetEndpoint(v *MessagingSessionEndpoint) *GetMessagingSessionEndpointOutput

SetEndpoint sets the Endpoint field's value.

func (GetMessagingSessionEndpointOutput) String 

func (s GetMessagingSessionEndpointOutput) 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 GetMessagingStreamingConfigurationsInput added in v1.44.226 

type GetMessagingStreamingConfigurationsInput struct {

	// The ARN of the streaming configurations.
	//
	// AppInstanceArn is a required field
	AppInstanceArn *string `location:"uri" locationName:"appInstanceArn" min:"5" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetMessagingStreamingConfigurationsInput) GoString added in v1.44.226 

func (s GetMessagingStreamingConfigurationsInput) 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 (*GetMessagingStreamingConfigurationsInput) SetAppInstanceArn added in v1.44.226 

func (s *GetMessagingStreamingConfigurationsInput) SetAppInstanceArn(v string) *GetMessagingStreamingConfigurationsInput

SetAppInstanceArn sets the AppInstanceArn field's value.

func (GetMessagingStreamingConfigurationsInput) String added in v1.44.226 

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

func (s *GetMessagingStreamingConfigurationsInput) Validate() error

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

type GetMessagingStreamingConfigurationsOutput added in v1.44.226 

type GetMessagingStreamingConfigurationsOutput struct {

	// The streaming settings.
	StreamingConfigurations []*StreamingConfiguration `min:"1" type:"list"`
	// contains filtered or unexported fields
}

func (GetMessagingStreamingConfigurationsOutput) GoString added in v1.44.226 

func (s GetMessagingStreamingConfigurationsOutput) 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 (*GetMessagingStreamingConfigurationsOutput) SetStreamingConfigurations added in v1.44.226 

func (s *GetMessagingStreamingConfigurationsOutput) SetStreamingConfigurations(v []*StreamingConfiguration) *GetMessagingStreamingConfigurationsOutput

SetStreamingConfigurations sets the StreamingConfigurations field's value.

func (GetMessagingStreamingConfigurationsOutput) String added in v1.44.226 

func (s GetMessagingStreamingConfigurationsOutput) 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 Identity 

type Identity struct {

	// The ARN in an Identity.
	Arn *string `min:"5" type:"string"`

	// The name in an Identity.
	//
	// Name is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by Identity's
	// String and GoString methods.
	Name *string `type:"string" sensitive:"true"`
	// contains filtered or unexported fields
}

The details of a user or bot.

func (Identity) GoString 

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

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

SetArn sets the Arn field's value.

func (*Identity) SetName 

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

SetName sets the Name field's value.

func (Identity) String 

func (s Identity) 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 LambdaConfiguration added in v1.41.6 

type LambdaConfiguration struct {

	// Controls how the Lambda function is invoked.
	//
	// InvocationType is a required field
	InvocationType *string `type:"string" required:"true" enum:"InvocationType"`

	// The ARN of the Lambda message processing function.
	//
	// ResourceArn is a required field
	ResourceArn *string `min:"15" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Stores metadata about a Lambda processor.

func (LambdaConfiguration) GoString added in v1.41.6 

func (s LambdaConfiguration) 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 (*LambdaConfiguration) SetInvocationType added in v1.41.6 

func (s *LambdaConfiguration) SetInvocationType(v string) *LambdaConfiguration

SetInvocationType sets the InvocationType field's value.

func (*LambdaConfiguration) SetResourceArn added in v1.41.6 

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

SetResourceArn sets the ResourceArn field's value.

func (LambdaConfiguration) String added in v1.41.6 

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

func (s *LambdaConfiguration) Validate() error

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

type ListChannelBansInput 

type ListChannelBansInput struct {

	// The ARN of the channel.
	//
	// ChannelArn is a required field
	ChannelArn *string `location:"uri" locationName:"channelArn" min:"5" type:"string" required:"true"`

	// The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
	//
	// ChimeBearer is a required field
	ChimeBearer *string `location:"header" locationName:"x-amz-chime-bearer" min:"5" type:"string" required:"true"`

	// The maximum number of bans that you want returned.
	MaxResults *int64 `location:"querystring" locationName:"max-results" min:"1" type:"integer"`

	// The token passed by previous API calls until all requested bans are returned.
	//
	// NextToken is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ListChannelBansInput's
	// String and GoString methods.
	NextToken *string `location:"querystring" locationName:"next-token" type:"string" sensitive:"true"`
	// contains filtered or unexported fields
}

func (ListChannelBansInput) GoString 

func (s ListChannelBansInput) 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 (*ListChannelBansInput) SetChannelArn 

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

SetChannelArn sets the ChannelArn field's value.

func (*ListChannelBansInput) SetChimeBearer 

func (s *ListChannelBansInput) SetChimeBearer(v string) *ListChannelBansInput

SetChimeBearer sets the ChimeBearer field's value.

func (*ListChannelBansInput) SetMaxResults 

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

SetMaxResults sets the MaxResults field's value.

func (*ListChannelBansInput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (ListChannelBansInput) String 

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

func (s *ListChannelBansInput) Validate() error

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

type ListChannelBansOutput 

type ListChannelBansOutput struct {

	// The ARN of the channel.
	ChannelArn *string `min:"5" type:"string"`

	// The information for each requested ban.
	ChannelBans []*ChannelBanSummary `type:"list"`

	// The token passed by previous API calls until all requested bans are returned.
	//
	// NextToken is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ListChannelBansOutput's
	// String and GoString methods.
	NextToken *string `type:"string" sensitive:"true"`
	// contains filtered or unexported fields
}

func (ListChannelBansOutput) GoString 

func (s ListChannelBansOutput) 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 (*ListChannelBansOutput) SetChannelArn 

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

SetChannelArn sets the ChannelArn field's value.

func (*ListChannelBansOutput) SetChannelBans 

func (s *ListChannelBansOutput) SetChannelBans(v []*ChannelBanSummary) *ListChannelBansOutput

SetChannelBans sets the ChannelBans field's value.

func (*ListChannelBansOutput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (ListChannelBansOutput) String 

func (s ListChannelBansOutput) 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 ListChannelFlowsInput added in v1.41.6 

type ListChannelFlowsInput struct {

	// The ARN of the app instance.
	//
	// AppInstanceArn is a required field
	AppInstanceArn *string `location:"querystring" locationName:"app-instance-arn" min:"5" type:"string" required:"true"`

	// The maximum number of channel flows that you want to return.
	MaxResults *int64 `location:"querystring" locationName:"max-results" min:"1" type:"integer"`

	// The token passed by previous API calls until all requested channel flows
	// are returned.
	//
	// NextToken is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ListChannelFlowsInput's
	// String and GoString methods.
	NextToken *string `location:"querystring" locationName:"next-token" type:"string" sensitive:"true"`
	// contains filtered or unexported fields
}

func (ListChannelFlowsInput) GoString added in v1.41.6 

func (s ListChannelFlowsInput) 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 (*ListChannelFlowsInput) SetAppInstanceArn added in v1.41.6 

func (s *ListChannelFlowsInput) SetAppInstanceArn(v string) *ListChannelFlowsInput

SetAppInstanceArn sets the AppInstanceArn field's value.

func (*ListChannelFlowsInput) SetMaxResults added in v1.41.6 

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

SetMaxResults sets the MaxResults field's value.

func (*ListChannelFlowsInput) SetNextToken added in v1.41.6 

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

SetNextToken sets the NextToken field's value.

func (ListChannelFlowsInput) String added in v1.41.6 

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

func (s *ListChannelFlowsInput) Validate() error

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

type ListChannelFlowsOutput added in v1.41.6 

type ListChannelFlowsOutput struct {

	// The information about each channel flow.
	ChannelFlows []*ChannelFlowSummary `type:"list"`

	// The token passed by previous API calls until all requested channels are returned.
	//
	// NextToken is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ListChannelFlowsOutput's
	// String and GoString methods.
	NextToken *string `type:"string" sensitive:"true"`
	// contains filtered or unexported fields
}

func (ListChannelFlowsOutput) GoString added in v1.41.6 

func (s ListChannelFlowsOutput) 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 (*ListChannelFlowsOutput) SetChannelFlows added in v1.41.6 

func (s *ListChannelFlowsOutput) SetChannelFlows(v []*ChannelFlowSummary) *ListChannelFlowsOutput

SetChannelFlows sets the ChannelFlows field's value.

func (*ListChannelFlowsOutput) SetNextToken added in v1.41.6 

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

SetNextToken sets the NextToken field's value.

func (ListChannelFlowsOutput) String added in v1.41.6 

func (s ListChannelFlowsOutput) 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 ListChannelMembershipsForAppInstanceUserInput 

type ListChannelMembershipsForAppInstanceUserInput struct {

	// The ARN of the user or bot.
	AppInstanceUserArn *string `location:"querystring" locationName:"app-instance-user-arn" min:"5" type:"string"`

	// The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
	//
	// ChimeBearer is a required field
	ChimeBearer *string `location:"header" locationName:"x-amz-chime-bearer" min:"5" type:"string" required:"true"`

	// The maximum number of users that you want returned.
	MaxResults *int64 `location:"querystring" locationName:"max-results" min:"1" type:"integer"`

	// The token returned from previous API requests until the number of channel
	// memberships is reached.
	//
	// NextToken is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ListChannelMembershipsForAppInstanceUserInput's
	// String and GoString methods.
	NextToken *string `location:"querystring" locationName:"next-token" type:"string" sensitive:"true"`
	// contains filtered or unexported fields
}

func (ListChannelMembershipsForAppInstanceUserInput) GoString 

func (s ListChannelMembershipsForAppInstanceUserInput) 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 (*ListChannelMembershipsForAppInstanceUserInput) SetAppInstanceUserArn 

func (s *ListChannelMembershipsForAppInstanceUserInput) SetAppInstanceUserArn(v string) *ListChannelMembershipsForAppInstanceUserInput

SetAppInstanceUserArn sets the AppInstanceUserArn field's value.

func (*ListChannelMembershipsForAppInstanceUserInput) SetChimeBearer 

func (s *ListChannelMembershipsForAppInstanceUserInput) SetChimeBearer(v string) *ListChannelMembershipsForAppInstanceUserInput

SetChimeBearer sets the ChimeBearer field's value.

func (*ListChannelMembershipsForAppInstanceUserInput) SetMaxResults 

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

SetMaxResults sets the MaxResults field's value.

func (*ListChannelMembershipsForAppInstanceUserInput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (ListChannelMembershipsForAppInstanceUserInput) String 

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

func (s *ListChannelMembershipsForAppInstanceUserInput) Validate() error

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

type ListChannelMembershipsForAppInstanceUserOutput 

type ListChannelMembershipsForAppInstanceUserOutput struct {

	// The information for the requested channel memberships.
	ChannelMemberships []*ChannelMembershipForAppInstanceUserSummary `type:"list"`

	// The token passed by previous API calls until all requested users are returned.
	//
	// NextToken is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ListChannelMembershipsForAppInstanceUserOutput's
	// String and GoString methods.
	NextToken *string `type:"string" sensitive:"true"`
	// contains filtered or unexported fields
}

func (ListChannelMembershipsForAppInstanceUserOutput) GoString 

func (s ListChannelMembershipsForAppInstanceUserOutput) 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 (*ListChannelMembershipsForAppInstanceUserOutput) SetChannelMemberships 

func (s *ListChannelMembershipsForAppInstanceUserOutput) SetChannelMemberships(v []*ChannelMembershipForAppInstanceUserSummary) *ListChannelMembershipsForAppInstanceUserOutput

SetChannelMemberships sets the ChannelMemberships field's value.

func (*ListChannelMembershipsForAppInstanceUserOutput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (ListChannelMembershipsForAppInstanceUserOutput) String 

func (s ListChannelMembershipsForAppInstanceUserOutput) 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 ListChannelMembershipsInput 

type ListChannelMembershipsInput struct {

	// The maximum number of channel memberships that you want returned.
	//
	// ChannelArn is a required field
	ChannelArn *string `location:"uri" locationName:"channelArn" min:"5" type:"string" required:"true"`

	// The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
	//
	// ChimeBearer is a required field
	ChimeBearer *string `location:"header" locationName:"x-amz-chime-bearer" min:"5" type:"string" required:"true"`

	// The maximum number of channel memberships that you want returned.
	MaxResults *int64 `location:"querystring" locationName:"max-results" min:"1" type:"integer"`

	// The token passed by previous API calls until all requested channel memberships
	// are returned.
	//
	// NextToken is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ListChannelMembershipsInput's
	// String and GoString methods.
	NextToken *string `location:"querystring" locationName:"next-token" type:"string" sensitive:"true"`

	// The ID of the SubChannel in the request.
	//
	// Only required when listing a user's memberships in a particular sub-channel
	// of an elastic channel.
	SubChannelId *string `location:"querystring" locationName:"sub-channel-id" min:"1" type:"string"`

	// The membership type of a user, DEFAULT or HIDDEN. Default members are returned
	// as part of ListChannelMemberships if no type is specified. Hidden members
	// are only returned if the type filter in ListChannelMemberships equals HIDDEN.
	Type *string `location:"querystring" locationName:"type" type:"string" enum:"ChannelMembershipType"`
	// contains filtered or unexported fields
}

func (ListChannelMembershipsInput) GoString 

func (s ListChannelMembershipsInput) 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 (*ListChannelMembershipsInput) SetChannelArn 

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

SetChannelArn sets the ChannelArn field's value.

func (*ListChannelMembershipsInput) SetChimeBearer 

func (s *ListChannelMembershipsInput) SetChimeBearer(v string) *ListChannelMembershipsInput

SetChimeBearer sets the ChimeBearer field's value.

func (*ListChannelMembershipsInput) SetMaxResults 

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

SetMaxResults sets the MaxResults field's value.

func (*ListChannelMembershipsInput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (*ListChannelMembershipsInput) SetSubChannelId added in v1.44.76 

func (s *ListChannelMembershipsInput) SetSubChannelId(v string) *ListChannelMembershipsInput

SetSubChannelId sets the SubChannelId field's value.

func (*ListChannelMembershipsInput) SetType 

func (s *ListChannelMembershipsInput) SetType(v string) *ListChannelMembershipsInput

SetType sets the Type field's value.

func (ListChannelMembershipsInput) String 

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

func (s *ListChannelMembershipsInput) Validate() error

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

type ListChannelMembershipsOutput 

type ListChannelMembershipsOutput struct {

	// The ARN of the channel.
	ChannelArn *string `min:"5" type:"string"`

	// The information for the requested channel memberships.
	ChannelMemberships []*ChannelMembershipSummary `type:"list"`

	// The token passed by previous API calls until all requested channel memberships
	// are returned.
	//
	// NextToken is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ListChannelMembershipsOutput's
	// String and GoString methods.
	NextToken *string `type:"string" sensitive:"true"`
	// contains filtered or unexported fields
}

func (ListChannelMembershipsOutput) GoString 

func (s ListChannelMembershipsOutput) 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 (*ListChannelMembershipsOutput) SetChannelArn 

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

SetChannelArn sets the ChannelArn field's value.

func (*ListChannelMembershipsOutput) SetChannelMemberships 

func (s *ListChannelMembershipsOutput) SetChannelMemberships(v []*ChannelMembershipSummary) *ListChannelMembershipsOutput

SetChannelMemberships sets the ChannelMemberships field's value.

func (*ListChannelMembershipsOutput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (ListChannelMembershipsOutput) String 

func (s ListChannelMembershipsOutput) 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 ListChannelMessagesInput 

type ListChannelMessagesInput struct {

	// The ARN of the channel.
	//
	// ChannelArn is a required field
	ChannelArn *string `location:"uri" locationName:"channelArn" min:"5" type:"string" required:"true"`

	// The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
	//
	// ChimeBearer is a required field
	ChimeBearer *string `location:"header" locationName:"x-amz-chime-bearer" min:"5" type:"string" required:"true"`

	// The maximum number of messages that you want returned.
	MaxResults *int64 `location:"querystring" locationName:"max-results" min:"1" type:"integer"`

	// The token passed by previous API calls until all requested messages are returned.
	//
	// NextToken is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ListChannelMessagesInput's
	// String and GoString methods.
	NextToken *string `location:"querystring" locationName:"next-token" type:"string" sensitive:"true"`

	// The final or ending time stamp for your requested messages.
	NotAfter *time.Time `location:"querystring" locationName:"not-after" type:"timestamp"`

	// The initial or starting time stamp for your requested messages.
	NotBefore *time.Time `location:"querystring" locationName:"not-before" type:"timestamp"`

	// The order in which you want messages sorted. Default is Descending, based
	// on time created.
	SortOrder *string `location:"querystring" locationName:"sort-order" type:"string" enum:"SortOrder"`

	// The ID of the SubChannel in the request.
	//
	// Only required when listing the messages in a SubChannel that the user belongs
	// to.
	SubChannelId *string `location:"querystring" locationName:"sub-channel-id" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListChannelMessagesInput) GoString 

func (s ListChannelMessagesInput) 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 (*ListChannelMessagesInput) SetChannelArn 

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

SetChannelArn sets the ChannelArn field's value.

func (*ListChannelMessagesInput) SetChimeBearer 

func (s *ListChannelMessagesInput) SetChimeBearer(v string) *ListChannelMessagesInput

SetChimeBearer sets the ChimeBearer field's value.

func (*ListChannelMessagesInput) SetMaxResults 

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

SetMaxResults sets the MaxResults field's value.

func (*ListChannelMessagesInput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (*ListChannelMessagesInput) SetNotAfter 

func (s *ListChannelMessagesInput) SetNotAfter(v time.Time) *ListChannelMessagesInput

SetNotAfter sets the NotAfter field's value.

func (*ListChannelMessagesInput) SetNotBefore 

func (s *ListChannelMessagesInput) SetNotBefore(v time.Time) *ListChannelMessagesInput

SetNotBefore sets the NotBefore field's value.

func (*ListChannelMessagesInput) SetSortOrder 

func (s *ListChannelMessagesInput) SetSortOrder(v string) *ListChannelMessagesInput

SetSortOrder sets the SortOrder field's value.

func (*ListChannelMessagesInput) SetSubChannelId added in v1.44.76 

func (s *ListChannelMessagesInput) SetSubChannelId(v string) *ListChannelMessagesInput

SetSubChannelId sets the SubChannelId field's value.

func (ListChannelMessagesInput) String 

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

func (s *ListChannelMessagesInput) Validate() error

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

type ListChannelMessagesOutput 

type ListChannelMessagesOutput struct {

	// The ARN of the channel containing the requested messages.
	ChannelArn *string `min:"5" type:"string"`

	// The information about, and content of, each requested message.
	ChannelMessages []*ChannelMessageSummary `type:"list"`

	// The token passed by previous API calls until all requested messages are returned.
	//
	// NextToken is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ListChannelMessagesOutput's
	// String and GoString methods.
	NextToken *string `type:"string" sensitive:"true"`

	// The ID of the SubChannel in the response.
	SubChannelId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListChannelMessagesOutput) GoString 

func (s ListChannelMessagesOutput) 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 (*ListChannelMessagesOutput) SetChannelArn 

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

SetChannelArn sets the ChannelArn field's value.

func (*ListChannelMessagesOutput) SetChannelMessages 

func (s *ListChannelMessagesOutput) SetChannelMessages(v []*ChannelMessageSummary) *ListChannelMessagesOutput

SetChannelMessages sets the ChannelMessages field's value.

func (*ListChannelMessagesOutput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (*ListChannelMessagesOutput) SetSubChannelId added in v1.44.76 

func (s *ListChannelMessagesOutput) SetSubChannelId(v string) *ListChannelMessagesOutput

SetSubChannelId sets the SubChannelId field's value.

func (ListChannelMessagesOutput) String 

func (s ListChannelMessagesOutput) 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 ListChannelModeratorsInput 

type ListChannelModeratorsInput struct {

	// The ARN of the channel.
	//
	// ChannelArn is a required field
	ChannelArn *string `location:"uri" locationName:"channelArn" min:"5" type:"string" required:"true"`

	// The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
	//
	// ChimeBearer is a required field
	ChimeBearer *string `location:"header" locationName:"x-amz-chime-bearer" min:"5" type:"string" required:"true"`

	// The maximum number of moderators that you want returned.
	MaxResults *int64 `location:"querystring" locationName:"max-results" min:"1" type:"integer"`

	// The token passed by previous API calls until all requested moderators are
	// returned.
	//
	// NextToken is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ListChannelModeratorsInput's
	// String and GoString methods.
	NextToken *string `location:"querystring" locationName:"next-token" type:"string" sensitive:"true"`
	// contains filtered or unexported fields
}

func (ListChannelModeratorsInput) GoString 

func (s ListChannelModeratorsInput) 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 (*ListChannelModeratorsInput) SetChannelArn 

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

SetChannelArn sets the ChannelArn field's value.

func (*ListChannelModeratorsInput) SetChimeBearer 

func (s *ListChannelModeratorsInput) SetChimeBearer(v string) *ListChannelModeratorsInput

SetChimeBearer sets the ChimeBearer field's value.

func (*ListChannelModeratorsInput) SetMaxResults 

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

SetMaxResults sets the MaxResults field's value.

func (*ListChannelModeratorsInput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (ListChannelModeratorsInput) String 

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

func (s *ListChannelModeratorsInput) Validate() error

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

type ListChannelModeratorsOutput 

type ListChannelModeratorsOutput struct {

	// The ARN of the channel.
	ChannelArn *string `min:"5" type:"string"`

	// The information about and names of each moderator.
	ChannelModerators []*ChannelModeratorSummary `type:"list"`

	// The token passed by previous API calls until all requested moderators are
	// returned.
	//
	// NextToken is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ListChannelModeratorsOutput's
	// String and GoString methods.
	NextToken *string `type:"string" sensitive:"true"`
	// contains filtered or unexported fields
}

func (ListChannelModeratorsOutput) GoString 

func (s ListChannelModeratorsOutput) 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 (*ListChannelModeratorsOutput) SetChannelArn 

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

SetChannelArn sets the ChannelArn field's value.

func (*ListChannelModeratorsOutput) SetChannelModerators 

func (s *ListChannelModeratorsOutput) SetChannelModerators(v []*ChannelModeratorSummary) *ListChannelModeratorsOutput

SetChannelModerators sets the ChannelModerators field's value.

func (*ListChannelModeratorsOutput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (ListChannelModeratorsOutput) String 

func (s ListChannelModeratorsOutput) 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 ListChannelsAssociatedWithChannelFlowInput added in v1.41.6 

type ListChannelsAssociatedWithChannelFlowInput struct {

	// The ARN of the channel flow.
	//
	// ChannelFlowArn is a required field
	ChannelFlowArn *string `location:"querystring" locationName:"channel-flow-arn" min:"5" type:"string" required:"true"`

	// The maximum number of channels that you want to return.
	MaxResults *int64 `location:"querystring" locationName:"max-results" min:"1" type:"integer"`

	// The token passed by previous API calls until all requested channels are returned.
	//
	// NextToken is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ListChannelsAssociatedWithChannelFlowInput's
	// String and GoString methods.
	NextToken *string `location:"querystring" locationName:"next-token" type:"string" sensitive:"true"`
	// contains filtered or unexported fields
}

func (ListChannelsAssociatedWithChannelFlowInput) GoString added in v1.41.6 

func (s ListChannelsAssociatedWithChannelFlowInput) 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 (*ListChannelsAssociatedWithChannelFlowInput) SetChannelFlowArn added in v1.41.6 

func (s *ListChannelsAssociatedWithChannelFlowInput) SetChannelFlowArn(v string) *ListChannelsAssociatedWithChannelFlowInput

SetChannelFlowArn sets the ChannelFlowArn field's value.

func (*ListChannelsAssociatedWithChannelFlowInput) SetMaxResults added in v1.41.6 

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

SetMaxResults sets the MaxResults field's value.

func (*ListChannelsAssociatedWithChannelFlowInput) SetNextToken added in v1.41.6 

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

SetNextToken sets the NextToken field's value.

func (ListChannelsAssociatedWithChannelFlowInput) String added in v1.41.6 

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

func (s *ListChannelsAssociatedWithChannelFlowInput) Validate() error

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

type ListChannelsAssociatedWithChannelFlowOutput added in v1.41.6 

type ListChannelsAssociatedWithChannelFlowOutput struct {

	// The information about each channel.
	Channels []*ChannelAssociatedWithFlowSummary `type:"list"`

	// The token passed by previous API calls until all requested channels are returned.
	//
	// NextToken is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ListChannelsAssociatedWithChannelFlowOutput's
	// String and GoString methods.
	NextToken *string `type:"string" sensitive:"true"`
	// contains filtered or unexported fields
}

func (ListChannelsAssociatedWithChannelFlowOutput) GoString added in v1.41.6 

func (s ListChannelsAssociatedWithChannelFlowOutput) 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 (*ListChannelsAssociatedWithChannelFlowOutput) SetChannels added in v1.41.6 

func (s *ListChannelsAssociatedWithChannelFlowOutput) SetChannels(v []*ChannelAssociatedWithFlowSummary) *ListChannelsAssociatedWithChannelFlowOutput

SetChannels sets the Channels field's value.

func (*ListChannelsAssociatedWithChannelFlowOutput) SetNextToken added in v1.41.6 

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

SetNextToken sets the NextToken field's value.

func (ListChannelsAssociatedWithChannelFlowOutput) String added in v1.41.6 

func (s ListChannelsAssociatedWithChannelFlowOutput) 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 ListChannelsInput 

type ListChannelsInput struct {

	// The ARN of the AppInstance.
	//
	// AppInstanceArn is a required field
	AppInstanceArn *string `location:"querystring" locationName:"app-instance-arn" min:"5" type:"string" required:"true"`

	// The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
	//
	// ChimeBearer is a required field
	ChimeBearer *string `location:"header" locationName:"x-amz-chime-bearer" min:"5" type:"string" required:"true"`

	// The maximum number of channels that you want to return.
	MaxResults *int64 `location:"querystring" locationName:"max-results" min:"1" type:"integer"`

	// The token passed by previous API calls until all requested channels are returned.
	//
	// NextToken is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ListChannelsInput's
	// String and GoString methods.
	NextToken *string `location:"querystring" locationName:"next-token" type:"string" sensitive:"true"`

	// The privacy setting. PUBLIC retrieves all the public channels. PRIVATE retrieves
	// private channels. Only an AppInstanceAdmin can retrieve private channels.
	Privacy *string `location:"querystring" locationName:"privacy" type:"string" enum:"ChannelPrivacy"`
	// contains filtered or unexported fields
}

func (ListChannelsInput) GoString 

func (s ListChannelsInput) 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 (*ListChannelsInput) SetAppInstanceArn 

func (s *ListChannelsInput) SetAppInstanceArn(v string) *ListChannelsInput

SetAppInstanceArn sets the AppInstanceArn field's value.

func (*ListChannelsInput) SetChimeBearer 

func (s *ListChannelsInput) SetChimeBearer(v string) *ListChannelsInput

SetChimeBearer sets the ChimeBearer field's value.

func (*ListChannelsInput) SetMaxResults 

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

SetMaxResults sets the MaxResults field's value.

func (*ListChannelsInput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (*ListChannelsInput) SetPrivacy 

func (s *ListChannelsInput) SetPrivacy(v string) *ListChannelsInput

SetPrivacy sets the Privacy field's value.

func (ListChannelsInput) String 

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

func (s *ListChannelsInput) Validate() error

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

type ListChannelsModeratedByAppInstanceUserInput 

type ListChannelsModeratedByAppInstanceUserInput struct {

	// The ARN of the user or bot in the moderated channel.
	AppInstanceUserArn *string `location:"querystring" locationName:"app-instance-user-arn" min:"5" type:"string"`

	// The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
	//
	// ChimeBearer is a required field
	ChimeBearer *string `location:"header" locationName:"x-amz-chime-bearer" min:"5" type:"string" required:"true"`

	// The maximum number of channels in the request.
	MaxResults *int64 `location:"querystring" locationName:"max-results" min:"1" type:"integer"`

	// The token returned from previous API requests until the number of channels
	// moderated by the user is reached.
	//
	// NextToken is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ListChannelsModeratedByAppInstanceUserInput's
	// String and GoString methods.
	NextToken *string `location:"querystring" locationName:"next-token" type:"string" sensitive:"true"`
	// contains filtered or unexported fields
}

func (ListChannelsModeratedByAppInstanceUserInput) GoString 

func (s ListChannelsModeratedByAppInstanceUserInput) 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 (*ListChannelsModeratedByAppInstanceUserInput) SetAppInstanceUserArn 

func (s *ListChannelsModeratedByAppInstanceUserInput) SetAppInstanceUserArn(v string) *ListChannelsModeratedByAppInstanceUserInput

SetAppInstanceUserArn sets the AppInstanceUserArn field's value.

func (*ListChannelsModeratedByAppInstanceUserInput) SetChimeBearer 

func (s *ListChannelsModeratedByAppInstanceUserInput) SetChimeBearer(v string) *ListChannelsModeratedByAppInstanceUserInput

SetChimeBearer sets the ChimeBearer field's value.

func (*ListChannelsModeratedByAppInstanceUserInput) SetMaxResults 

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

SetMaxResults sets the MaxResults field's value.

func (*ListChannelsModeratedByAppInstanceUserInput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (ListChannelsModeratedByAppInstanceUserInput) String 

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

func (s *ListChannelsModeratedByAppInstanceUserInput) Validate() error

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

type ListChannelsModeratedByAppInstanceUserOutput 

type ListChannelsModeratedByAppInstanceUserOutput struct {

	// The moderated channels in the request.
	Channels []*ChannelModeratedByAppInstanceUserSummary `type:"list"`

	// The token returned from previous API requests until the number of channels
	// moderated by the user is reached.
	//
	// NextToken is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ListChannelsModeratedByAppInstanceUserOutput's
	// String and GoString methods.
	NextToken *string `type:"string" sensitive:"true"`
	// contains filtered or unexported fields
}

func (ListChannelsModeratedByAppInstanceUserOutput) GoString 

func (s ListChannelsModeratedByAppInstanceUserOutput) 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 (*ListChannelsModeratedByAppInstanceUserOutput) SetChannels 

func (s *ListChannelsModeratedByAppInstanceUserOutput) SetChannels(v []*ChannelModeratedByAppInstanceUserSummary) *ListChannelsModeratedByAppInstanceUserOutput

SetChannels sets the Channels field's value.

func (*ListChannelsModeratedByAppInstanceUserOutput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (ListChannelsModeratedByAppInstanceUserOutput) String 

func (s ListChannelsModeratedByAppInstanceUserOutput) 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 ListChannelsOutput 

type ListChannelsOutput struct {

	// The information about each channel.
	Channels []*ChannelSummary `type:"list"`

	// The token returned from previous API requests until the number of channels
	// is reached.
	//
	// NextToken is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ListChannelsOutput's
	// String and GoString methods.
	NextToken *string `type:"string" sensitive:"true"`
	// contains filtered or unexported fields
}

func (ListChannelsOutput) GoString 

func (s ListChannelsOutput) 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 (*ListChannelsOutput) SetChannels 

func (s *ListChannelsOutput) SetChannels(v []*ChannelSummary) *ListChannelsOutput

SetChannels sets the Channels field's value.

func (*ListChannelsOutput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (ListChannelsOutput) String 

func (s ListChannelsOutput) 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 ListSubChannelsInput added in v1.44.76 

type ListSubChannelsInput struct {

	// The ARN of elastic channel.
	//
	// ChannelArn is a required field
	ChannelArn *string `location:"uri" locationName:"channelArn" min:"5" type:"string" required:"true"`

	// The AppInstanceUserArn of the user making the API call.
	//
	// ChimeBearer is a required field
	ChimeBearer *string `location:"header" locationName:"x-amz-chime-bearer" min:"5" type:"string" required:"true"`

	// The maximum number of sub-channels that you want to return.
	MaxResults *int64 `location:"querystring" locationName:"max-results" min:"1" type:"integer"`

	// The token passed by previous API calls until all requested sub-channels are
	// returned.
	//
	// NextToken is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ListSubChannelsInput's
	// String and GoString methods.
	NextToken *string `location:"querystring" locationName:"next-token" type:"string" sensitive:"true"`
	// contains filtered or unexported fields
}

func (ListSubChannelsInput) GoString added in v1.44.76 

func (s ListSubChannelsInput) 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 (*ListSubChannelsInput) SetChannelArn added in v1.44.76 

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

SetChannelArn sets the ChannelArn field's value.

func (*ListSubChannelsInput) SetChimeBearer added in v1.44.76 

func (s *ListSubChannelsInput) SetChimeBearer(v string) *ListSubChannelsInput

SetChimeBearer sets the ChimeBearer field's value.

func (*ListSubChannelsInput) SetMaxResults added in v1.44.76 

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

SetMaxResults sets the MaxResults field's value.

func (*ListSubChannelsInput) SetNextToken added in v1.44.76 

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

SetNextToken sets the NextToken field's value.

func (ListSubChannelsInput) String added in v1.44.76 

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

func (s *ListSubChannelsInput) Validate() error

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

type ListSubChannelsOutput added in v1.44.76 

type ListSubChannelsOutput struct {

	// The ARN of elastic channel.
	ChannelArn *string `min:"5" type:"string"`

	// The token passed by previous API calls until all requested sub-channels are
	// returned.
	//
	// NextToken is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ListSubChannelsOutput's
	// String and GoString methods.
	NextToken *string `type:"string" sensitive:"true"`

	// The information about each sub-channel.
	SubChannels []*SubChannelSummary `type:"list"`
	// contains filtered or unexported fields
}

func (ListSubChannelsOutput) GoString added in v1.44.76 

func (s ListSubChannelsOutput) 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 (*ListSubChannelsOutput) SetChannelArn added in v1.44.76 

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

SetChannelArn sets the ChannelArn field's value.

func (*ListSubChannelsOutput) SetNextToken added in v1.44.76 

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

SetNextToken sets the NextToken field's value.

func (*ListSubChannelsOutput) SetSubChannels added in v1.44.76 

func (s *ListSubChannelsOutput) SetSubChannels(v []*SubChannelSummary) *ListSubChannelsOutput

SetSubChannels sets the SubChannels field's value.

func (ListSubChannelsOutput) String added in v1.44.76 

func (s ListSubChannelsOutput) 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 added in v1.41.6 

type ListTagsForResourceInput struct {

	// The ARN of the resource.
	//
	// ResourceARN is a required field
	ResourceARN *string `location:"querystring" locationName:"arn" min:"5" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceInput) GoString added in v1.41.6 

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

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

SetResourceARN sets the ResourceARN field's value.

func (ListTagsForResourceInput) String added in v1.41.6 

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

func (s *ListTagsForResourceInput) Validate() error

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

type ListTagsForResourceOutput added in v1.41.6 

type ListTagsForResourceOutput struct {

	// The tag key-value pairs.
	Tags []*Tag `min:"1" type:"list"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceOutput) GoString added in v1.41.6 

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

func (s *ListTagsForResourceOutput) SetTags(v []*Tag) *ListTagsForResourceOutput

SetTags sets the Tags field's value.

func (ListTagsForResourceOutput) String added in v1.41.6 

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 MessageAttributeValue added in v1.41.11 

type MessageAttributeValue struct {

	// The strings in a message attribute value.
	StringValues []*string `type:"list"`
	// contains filtered or unexported fields
}

A list of message attribute values.

func (MessageAttributeValue) GoString added in v1.41.11 

func (s MessageAttributeValue) 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 (*MessageAttributeValue) SetStringValues added in v1.41.11 

func (s *MessageAttributeValue) SetStringValues(v []*string) *MessageAttributeValue

SetStringValues sets the StringValues field's value.

func (MessageAttributeValue) String added in v1.41.11 

func (s MessageAttributeValue) 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 MessagingSessionEndpoint 

type MessagingSessionEndpoint struct {

	// The endpoint to which you establish a websocket connection.
	Url *string `type:"string"`
	// contains filtered or unexported fields
}

The websocket endpoint used to connect to Amazon Chime SDK messaging.

func (MessagingSessionEndpoint) GoString 

func (s MessagingSessionEndpoint) 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 (*MessagingSessionEndpoint) SetUrl 

func (s *MessagingSessionEndpoint) SetUrl(v string) *MessagingSessionEndpoint

SetUrl sets the Url field's value.

func (MessagingSessionEndpoint) String 

func (s MessagingSessionEndpoint) 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 NotFoundException 

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

	Code_ *string `locationName:"Code" type:"string" enum:"ErrorCode"`

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

One or more of the resources in the request does not exist in the system.

func (*NotFoundException) Code 

func (s *NotFoundException) Code() string

Code returns the exception type name.

func (*NotFoundException) Error 

func (s *NotFoundException) Error() string

func (NotFoundException) GoString 

func (s NotFoundException) 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 (*NotFoundException) Message 

func (s *NotFoundException) Message() string

Message returns the exception's message.

func (*NotFoundException) OrigErr 

func (s *NotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*NotFoundException) RequestID 

func (s *NotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*NotFoundException) StatusCode 

func (s *NotFoundException) StatusCode() int

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

func (NotFoundException) String 

func (s NotFoundException) 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 Processor added in v1.41.6 

type Processor struct {

	// The information about the type of processor and its identifier.
	//
	// Configuration is a required field
	Configuration *ProcessorConfiguration `type:"structure" required:"true"`

	// The sequence in which processors run. If you have multiple processors in
	// a channel flow, message processing goes through each processor in the sequence.
	// The value determines the sequence. At this point, we support only 1 processor
	// within a flow.
	//
	// ExecutionOrder is a required field
	ExecutionOrder *int64 `min:"1" type:"integer" required:"true"`

	// Determines whether to continue with message processing or stop it in cases
	// where communication with a processor fails. If a processor has a fallback
	// action of ABORT and communication with it fails, the processor sets the message
	// status to FAILED and does not send the message to any recipients. Note that
	// if the last processor in the channel flow sequence has a fallback action
	// of CONTINUE and communication with the processor fails, then the message
	// is considered processed and sent to recipients of the channel.
	//
	// FallbackAction is a required field
	FallbackAction *string `type:"string" required:"true" enum:"FallbackAction"`

	// The name of the channel flow.
	//
	// Name is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by Processor's
	// String and GoString methods.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true" sensitive:"true"`
	// contains filtered or unexported fields
}

The information about a processor in a channel flow.

func (Processor) GoString added in v1.41.6 

func (s Processor) 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 (*Processor) SetConfiguration added in v1.41.6 

func (s *Processor) SetConfiguration(v *ProcessorConfiguration) *Processor

SetConfiguration sets the Configuration field's value.

func (*Processor) SetExecutionOrder added in v1.41.6 

func (s *Processor) SetExecutionOrder(v int64) *Processor

SetExecutionOrder sets the ExecutionOrder field's value.

func (*Processor) SetFallbackAction added in v1.41.6 

func (s *Processor) SetFallbackAction(v string) *Processor

SetFallbackAction sets the FallbackAction field's value.

func (*Processor) SetName added in v1.41.6 

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

SetName sets the Name field's value.

func (Processor) String added in v1.41.6 

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

func (s *Processor) Validate() error

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

type ProcessorConfiguration added in v1.41.6 

type ProcessorConfiguration struct {

	// Indicates that the processor is of type Lambda.
	//
	// Lambda is a required field
	Lambda *LambdaConfiguration `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

A processor's metadata.

func (ProcessorConfiguration) GoString added in v1.41.6 

func (s ProcessorConfiguration) 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 (*ProcessorConfiguration) SetLambda added in v1.41.6 

func (s *ProcessorConfiguration) SetLambda(v *LambdaConfiguration) *ProcessorConfiguration

SetLambda sets the Lambda field's value.

func (ProcessorConfiguration) String added in v1.41.6 

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

func (s *ProcessorConfiguration) Validate() error

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

type PushNotificationConfiguration added in v1.41.11 

type PushNotificationConfiguration struct {

	// The body of the push notification.
	//
	// Body is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by PushNotificationConfiguration's
	// String and GoString methods.
	Body *string `min:"1" type:"string" sensitive:"true"`

	// The title of the push notification.
	//
	// Title is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by PushNotificationConfiguration's
	// String and GoString methods.
	Title *string `min:"1" type:"string" sensitive:"true"`

	// Enum value that indicates the type of the push notification for a message.
	// DEFAULT: Normal mobile push notification. VOIP: VOIP mobile push notification.
	Type *string `type:"string" enum:"PushNotificationType"`
	// contains filtered or unexported fields
}

The push notification configuration of the message.

func (PushNotificationConfiguration) GoString added in v1.41.11 

func (s PushNotificationConfiguration) 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 (*PushNotificationConfiguration) SetBody added in v1.41.11 

func (s *PushNotificationConfiguration) SetBody(v string) *PushNotificationConfiguration

SetBody sets the Body field's value.

func (*PushNotificationConfiguration) SetTitle added in v1.41.11 

func (s *PushNotificationConfiguration) SetTitle(v string) *PushNotificationConfiguration

SetTitle sets the Title field's value.

func (*PushNotificationConfiguration) SetType added in v1.41.11 

func (s *PushNotificationConfiguration) SetType(v string) *PushNotificationConfiguration

SetType sets the Type field's value.

func (PushNotificationConfiguration) String added in v1.41.11 

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

func (s *PushNotificationConfiguration) Validate() error

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

type PushNotificationPreferences added in v1.41.11 

type PushNotificationPreferences struct {

	// Enum value that indicates which push notifications to send to the requested
	// member of a channel. ALL sends all push notifications, NONE sends no push
	// notifications, FILTERED sends only filtered push notifications.
	//
	// AllowNotifications is a required field
	AllowNotifications *string `type:"string" required:"true" enum:"AllowNotifications"`

	// The simple JSON object used to send a subset of a push notification to the
	// requested member.
	//
	// FilterRule is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by PushNotificationPreferences's
	// String and GoString methods.
	FilterRule *string `min:"1" type:"string" sensitive:"true"`
	// contains filtered or unexported fields
}

The channel membership preferences for push notification.

func (PushNotificationPreferences) GoString added in v1.41.11 

func (s PushNotificationPreferences) 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 (*PushNotificationPreferences) SetAllowNotifications added in v1.41.11 

func (s *PushNotificationPreferences) SetAllowNotifications(v string) *PushNotificationPreferences

SetAllowNotifications sets the AllowNotifications field's value.

func (*PushNotificationPreferences) SetFilterRule added in v1.41.11 

func (s *PushNotificationPreferences) SetFilterRule(v string) *PushNotificationPreferences

SetFilterRule sets the FilterRule field's value.

func (PushNotificationPreferences) String added in v1.41.11 

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

func (s *PushNotificationPreferences) Validate() error

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

type PutChannelExpirationSettingsInput added in v1.44.228 

type PutChannelExpirationSettingsInput struct {

	// The ARN of the channel.
	//
	// ChannelArn is a required field
	ChannelArn *string `location:"uri" locationName:"channelArn" min:"5" type:"string" required:"true"`

	// The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
	ChimeBearer *string `location:"header" locationName:"x-amz-chime-bearer" min:"5" type:"string"`

	// Settings that control the interval after which a channel is deleted.
	ExpirationSettings *ExpirationSettings `type:"structure"`
	// contains filtered or unexported fields
}

func (PutChannelExpirationSettingsInput) GoString added in v1.44.228 

func (s PutChannelExpirationSettingsInput) 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 (*PutChannelExpirationSettingsInput) SetChannelArn added in v1.44.228 

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

SetChannelArn sets the ChannelArn field's value.

func (*PutChannelExpirationSettingsInput) SetChimeBearer added in v1.44.228 

func (s *PutChannelExpirationSettingsInput) SetChimeBearer(v string) *PutChannelExpirationSettingsInput

SetChimeBearer sets the ChimeBearer field's value.

func (*PutChannelExpirationSettingsInput) SetExpirationSettings added in v1.44.228 

func (s *PutChannelExpirationSettingsInput) SetExpirationSettings(v *ExpirationSettings) *PutChannelExpirationSettingsInput

SetExpirationSettings sets the ExpirationSettings field's value.

func (PutChannelExpirationSettingsInput) String added in v1.44.228 

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

func (s *PutChannelExpirationSettingsInput) Validate() error

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

type PutChannelExpirationSettingsOutput added in v1.44.228 

type PutChannelExpirationSettingsOutput struct {

	// The channel ARN.
	ChannelArn *string `min:"5" type:"string"`

	// Settings that control the interval after which a channel is deleted.
	ExpirationSettings *ExpirationSettings `type:"structure"`
	// contains filtered or unexported fields
}

func (PutChannelExpirationSettingsOutput) GoString added in v1.44.228 

func (s PutChannelExpirationSettingsOutput) 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 (*PutChannelExpirationSettingsOutput) SetChannelArn added in v1.44.228 

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

SetChannelArn sets the ChannelArn field's value.

func (*PutChannelExpirationSettingsOutput) SetExpirationSettings added in v1.44.228 

func (s *PutChannelExpirationSettingsOutput) SetExpirationSettings(v *ExpirationSettings) *PutChannelExpirationSettingsOutput

SetExpirationSettings sets the ExpirationSettings field's value.

func (PutChannelExpirationSettingsOutput) String added in v1.44.228 

func (s PutChannelExpirationSettingsOutput) 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 PutChannelMembershipPreferencesInput added in v1.41.11 

type PutChannelMembershipPreferencesInput struct {

	// The ARN of the channel.
	//
	// ChannelArn is a required field
	ChannelArn *string `location:"uri" locationName:"channelArn" min:"5" type:"string" required:"true"`

	// The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
	//
	// ChimeBearer is a required field
	ChimeBearer *string `location:"header" locationName:"x-amz-chime-bearer" min:"5" type:"string" required:"true"`

	// The ARN of the member setting the preferences.
	//
	// MemberArn is a required field
	MemberArn *string `location:"uri" locationName:"memberArn" min:"5" type:"string" required:"true"`

	// The channel membership preferences of an AppInstanceUser .
	//
	// Preferences is a required field
	Preferences *ChannelMembershipPreferences `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (PutChannelMembershipPreferencesInput) GoString added in v1.41.11 

func (s PutChannelMembershipPreferencesInput) 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 (*PutChannelMembershipPreferencesInput) SetChannelArn added in v1.41.11 

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

SetChannelArn sets the ChannelArn field's value.

func (*PutChannelMembershipPreferencesInput) SetChimeBearer added in v1.41.11 

func (s *PutChannelMembershipPreferencesInput) SetChimeBearer(v string) *PutChannelMembershipPreferencesInput

SetChimeBearer sets the ChimeBearer field's value.

func (*PutChannelMembershipPreferencesInput) SetMemberArn added in v1.41.11 

func (s *PutChannelMembershipPreferencesInput) SetMemberArn(v string) *PutChannelMembershipPreferencesInput

SetMemberArn sets the MemberArn field's value.

func (*PutChannelMembershipPreferencesInput) SetPreferences added in v1.41.11 

func (s *PutChannelMembershipPreferencesInput) SetPreferences(v *ChannelMembershipPreferences) *PutChannelMembershipPreferencesInput

SetPreferences sets the Preferences field's value.

func (PutChannelMembershipPreferencesInput) String added in v1.41.11 

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

func (s *PutChannelMembershipPreferencesInput) Validate() error

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

type PutChannelMembershipPreferencesOutput added in v1.41.11 

type PutChannelMembershipPreferencesOutput struct {

	// The ARN of the channel.
	ChannelArn *string `min:"5" type:"string"`

	// The details of a user.
	Member *Identity `type:"structure"`

	// The ARN and metadata of the member being added.
	Preferences *ChannelMembershipPreferences `type:"structure"`
	// contains filtered or unexported fields
}

func (PutChannelMembershipPreferencesOutput) GoString added in v1.41.11 

func (s PutChannelMembershipPreferencesOutput) 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 (*PutChannelMembershipPreferencesOutput) SetChannelArn added in v1.41.11 

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

SetChannelArn sets the ChannelArn field's value.

func (*PutChannelMembershipPreferencesOutput) SetMember added in v1.41.11 

func (s *PutChannelMembershipPreferencesOutput) SetMember(v *Identity) *PutChannelMembershipPreferencesOutput

SetMember sets the Member field's value.

func (*PutChannelMembershipPreferencesOutput) SetPreferences added in v1.41.11 

func (s *PutChannelMembershipPreferencesOutput) SetPreferences(v *ChannelMembershipPreferences) *PutChannelMembershipPreferencesOutput

SetPreferences sets the Preferences field's value.

func (PutChannelMembershipPreferencesOutput) String added in v1.41.11 

func (s PutChannelMembershipPreferencesOutput) 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 PutMessagingStreamingConfigurationsInput added in v1.44.226 

type PutMessagingStreamingConfigurationsInput struct {

	// The ARN of the streaming configuration.
	//
	// AppInstanceArn is a required field
	AppInstanceArn *string `location:"uri" locationName:"appInstanceArn" min:"5" type:"string" required:"true"`

	// The streaming configurations.
	//
	// StreamingConfigurations is a required field
	StreamingConfigurations []*StreamingConfiguration `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (PutMessagingStreamingConfigurationsInput) GoString added in v1.44.226 

func (s PutMessagingStreamingConfigurationsInput) 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 (*PutMessagingStreamingConfigurationsInput) SetAppInstanceArn added in v1.44.226 

func (s *PutMessagingStreamingConfigurationsInput) SetAppInstanceArn(v string) *PutMessagingStreamingConfigurationsInput

SetAppInstanceArn sets the AppInstanceArn field's value.

func (*PutMessagingStreamingConfigurationsInput) SetStreamingConfigurations added in v1.44.226 

func (s *PutMessagingStreamingConfigurationsInput) SetStreamingConfigurations(v []*StreamingConfiguration) *PutMessagingStreamingConfigurationsInput

SetStreamingConfigurations sets the StreamingConfigurations field's value.

func (PutMessagingStreamingConfigurationsInput) String added in v1.44.226 

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

func (s *PutMessagingStreamingConfigurationsInput) Validate() error

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

type PutMessagingStreamingConfigurationsOutput added in v1.44.226 

type PutMessagingStreamingConfigurationsOutput struct {

	// The requested streaming configurations.
	StreamingConfigurations []*StreamingConfiguration `min:"1" type:"list"`
	// contains filtered or unexported fields
}

func (PutMessagingStreamingConfigurationsOutput) GoString added in v1.44.226 

func (s PutMessagingStreamingConfigurationsOutput) 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 (*PutMessagingStreamingConfigurationsOutput) SetStreamingConfigurations added in v1.44.226 

func (s *PutMessagingStreamingConfigurationsOutput) SetStreamingConfigurations(v []*StreamingConfiguration) *PutMessagingStreamingConfigurationsOutput

SetStreamingConfigurations sets the StreamingConfigurations field's value.

func (PutMessagingStreamingConfigurationsOutput) String added in v1.44.226 

func (s PutMessagingStreamingConfigurationsOutput) 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 RedactChannelMessageInput 

type RedactChannelMessageInput struct {

	// The ARN of the channel containing the messages that you want to redact.
	//
	// ChannelArn is a required field
	ChannelArn *string `location:"uri" locationName:"channelArn" min:"5" type:"string" required:"true"`

	// The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
	//
	// ChimeBearer is a required field
	ChimeBearer *string `location:"header" locationName:"x-amz-chime-bearer" min:"5" type:"string" required:"true"`

	// The ID of the message being redacted.
	//
	// MessageId is a required field
	MessageId *string `location:"uri" locationName:"messageId" min:"1" type:"string" required:"true"`

	// The ID of the SubChannel in the request.
	SubChannelId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (RedactChannelMessageInput) GoString 

func (s RedactChannelMessageInput) 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 (*RedactChannelMessageInput) SetChannelArn 

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

SetChannelArn sets the ChannelArn field's value.

func (*RedactChannelMessageInput) SetChimeBearer 

func (s *RedactChannelMessageInput) SetChimeBearer(v string) *RedactChannelMessageInput

SetChimeBearer sets the ChimeBearer field's value.

func (*RedactChannelMessageInput) SetMessageId 

func (s *RedactChannelMessageInput) SetMessageId(v string) *RedactChannelMessageInput

SetMessageId sets the MessageId field's value.

func (*RedactChannelMessageInput) SetSubChannelId added in v1.44.76 

func (s *RedactChannelMessageInput) SetSubChannelId(v string) *RedactChannelMessageInput

SetSubChannelId sets the SubChannelId field's value.

func (RedactChannelMessageInput) String 

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

func (s *RedactChannelMessageInput) Validate() error

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

type RedactChannelMessageOutput 

type RedactChannelMessageOutput struct {

	// The ARN of the channel containing the messages that you want to redact.
	ChannelArn *string `min:"5" type:"string"`

	// The ID of the message being redacted.
	MessageId *string `min:"1" type:"string"`

	// The ID of the SubChannel in the response.
	//
	// Only required when redacting messages in a SubChannel that the user belongs
	// to.
	SubChannelId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (RedactChannelMessageOutput) GoString 

func (s RedactChannelMessageOutput) 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 (*RedactChannelMessageOutput) SetChannelArn 

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

SetChannelArn sets the ChannelArn field's value.

func (*RedactChannelMessageOutput) SetMessageId 

func (s *RedactChannelMessageOutput) SetMessageId(v string) *RedactChannelMessageOutput

SetMessageId sets the MessageId field's value.

func (*RedactChannelMessageOutput) SetSubChannelId added in v1.44.76 

func (s *RedactChannelMessageOutput) SetSubChannelId(v string) *RedactChannelMessageOutput

SetSubChannelId sets the SubChannelId field's value.

func (RedactChannelMessageOutput) String 

func (s RedactChannelMessageOutput) 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 ResourceLimitExceededException 

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

	Code_ *string `locationName:"Code" type:"string" enum:"ErrorCode"`

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

The request exceeds the resource limit.

func (*ResourceLimitExceededException) Code 

func (s *ResourceLimitExceededException) Code() string

Code returns the exception type name.

func (*ResourceLimitExceededException) Error 

func (s *ResourceLimitExceededException) Error() string

func (ResourceLimitExceededException) GoString 

func (s ResourceLimitExceededException) 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 (*ResourceLimitExceededException) Message 

func (s *ResourceLimitExceededException) Message() string

Message returns the exception's message.

func (*ResourceLimitExceededException) OrigErr 

func (s *ResourceLimitExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceLimitExceededException) RequestID 

func (s *ResourceLimitExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceLimitExceededException) StatusCode 

func (s *ResourceLimitExceededException) StatusCode() int

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

func (ResourceLimitExceededException) String 

func (s ResourceLimitExceededException) 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 SearchChannelsInput added in v1.44.28 

type SearchChannelsInput struct {

	// The AppInstanceUserArn of the user making the API call.
	ChimeBearer *string `location:"header" locationName:"x-amz-chime-bearer" min:"5" type:"string"`

	// A list of the Field objects in the channel being searched.
	//
	// Fields is a required field
	Fields []*SearchField `min:"1" type:"list" required:"true"`

	// The maximum number of channels that you want returned.
	MaxResults *int64 `location:"querystring" locationName:"max-results" min:"1" type:"integer"`

	// The token returned from previous API requests until the number of channels
	// is reached.
	//
	// NextToken is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by SearchChannelsInput's
	// String and GoString methods.
	NextToken *string `location:"querystring" locationName:"next-token" type:"string" sensitive:"true"`
	// contains filtered or unexported fields
}

func (SearchChannelsInput) GoString added in v1.44.28 

func (s SearchChannelsInput) 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 (*SearchChannelsInput) SetChimeBearer added in v1.44.28 

func (s *SearchChannelsInput) SetChimeBearer(v string) *SearchChannelsInput

SetChimeBearer sets the ChimeBearer field's value.

func (*SearchChannelsInput) SetFields added in v1.44.28 

func (s *SearchChannelsInput) SetFields(v []*SearchField) *SearchChannelsInput

SetFields sets the Fields field's value.

func (*SearchChannelsInput) SetMaxResults added in v1.44.28 

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

SetMaxResults sets the MaxResults field's value.

func (*SearchChannelsInput) SetNextToken added in v1.44.28 

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

SetNextToken sets the NextToken field's value.

func (SearchChannelsInput) String added in v1.44.28 

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

func (s *SearchChannelsInput) Validate() error

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

type SearchChannelsOutput added in v1.44.28 

type SearchChannelsOutput struct {

	// A list of the channels in the request.
	Channels []*ChannelSummary `type:"list"`

	// The token returned from previous API responses until the number of channels
	// is reached.
	//
	// NextToken is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by SearchChannelsOutput's
	// String and GoString methods.
	NextToken *string `type:"string" sensitive:"true"`
	// contains filtered or unexported fields
}

func (SearchChannelsOutput) GoString added in v1.44.28 

func (s SearchChannelsOutput) 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 (*SearchChannelsOutput) SetChannels added in v1.44.28 

func (s *SearchChannelsOutput) SetChannels(v []*ChannelSummary) *SearchChannelsOutput

SetChannels sets the Channels field's value.

func (*SearchChannelsOutput) SetNextToken added in v1.44.28 

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

SetNextToken sets the NextToken field's value.

func (SearchChannelsOutput) String added in v1.44.28 

func (s SearchChannelsOutput) 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 SearchField added in v1.44.28 

type SearchField struct {

	// An enum value that indicates the key to search the channel on. MEMBERS allows
	// you to search channels based on memberships. You can use it with the EQUALS
	// operator to get channels whose memberships are equal to the specified values,
	// and with the INCLUDES operator to get channels whose memberships include
	// the specified values.
	//
	// Key is a required field
	Key *string `type:"string" required:"true" enum:"SearchFieldKey"`

	// The operator used to compare field values, currently EQUALS or INCLUDES.
	// Use the EQUALS operator to find channels whose memberships equal the specified
	// values. Use the INCLUDES operator to find channels whose memberships include
	// the specified values.
	//
	// Operator is a required field
	Operator *string `type:"string" required:"true" enum:"SearchFieldOperator"`

	// The values that you want to search for, a list of strings. The values must
	// be AppInstanceUserArns specified as a list of strings.
	//
	// This operation isn't supported for AppInstanceUsers with large number of
	// memberships.
	//
	// Values is a required field
	Values []*string `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

A Field of the channel that you want to search.

func (SearchField) GoString added in v1.44.28 

func (s SearchField) 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 (*SearchField) SetKey added in v1.44.28 

func (s *SearchField) SetKey(v string) *SearchField

SetKey sets the Key field's value.

func (*SearchField) SetOperator added in v1.44.28 

func (s *SearchField) SetOperator(v string) *SearchField

SetOperator sets the Operator field's value.

func (*SearchField) SetValues added in v1.44.28 

func (s *SearchField) SetValues(v []*string) *SearchField

SetValues sets the Values field's value.

func (SearchField) String added in v1.44.28 

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

func (s *SearchField) Validate() error

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

type SendChannelMessageInput 

type SendChannelMessageInput struct {

	// The ARN of the channel.
	//
	// ChannelArn is a required field
	ChannelArn *string `location:"uri" locationName:"channelArn" min:"5" type:"string" required:"true"`

	// The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
	//
	// ChimeBearer is a required field
	ChimeBearer *string `location:"header" locationName:"x-amz-chime-bearer" min:"5" type:"string" required:"true"`

	// The Idempotency token for each client request.
	//
	// ClientRequestToken is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by SendChannelMessageInput's
	// String and GoString methods.
	ClientRequestToken *string `min:"2" type:"string" idempotencyToken:"true" sensitive:"true"`

	// The content of the channel message.
	//
	// Content is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by SendChannelMessageInput's
	// String and GoString methods.
	//
	// Content is a required field
	Content *string `min:"1" type:"string" required:"true" sensitive:"true"`

	// The content type of the channel message.
	//
	// ContentType is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by SendChannelMessageInput's
	// String and GoString methods.
	ContentType *string `type:"string" sensitive:"true"`

	// The attributes for the message, used for message filtering along with a FilterRule
	// defined in the PushNotificationPreferences.
	MessageAttributes map[string]*MessageAttributeValue `type:"map"`

	// The optional metadata for each message.
	//
	// Metadata is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by SendChannelMessageInput's
	// String and GoString methods.
	Metadata *string `type:"string" sensitive:"true"`

	// Boolean that controls whether the message is persisted on the back end. Required.
	//
	// Persistence is a required field
	Persistence *string `type:"string" required:"true" enum:"ChannelMessagePersistenceType"`

	// The push notification configuration of the message.
	PushNotification *PushNotificationConfiguration `type:"structure"`

	// The ID of the SubChannel in the request.
	SubChannelId *string `min:"1" type:"string"`

	// The target of a message. Must be a member of the channel, such as another
	// user, a bot, or the sender. Only the target and the sender can view targeted
	// messages. Only users who can see targeted messages can take actions on them.
	// However, administrators can delete targeted messages that they can’t see.
	Target []*Target `min:"1" type:"list"`

	// The type of message, STANDARD or CONTROL.
	//
	// STANDARD messages can be up to 4KB in size and contain metadata. Metadata
	// is arbitrary, and you can use it in a variety of ways, such as containing
	// a link to an attachment.
	//
	// CONTROL messages are limited to 30 bytes and do not contain metadata.
	//
	// Type is a required field
	Type *string `type:"string" required:"true" enum:"ChannelMessageType"`
	// contains filtered or unexported fields
}

func (SendChannelMessageInput) GoString 

func (s SendChannelMessageInput) 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 (*SendChannelMessageInput) SetChannelArn 

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

SetChannelArn sets the ChannelArn field's value.

func (*SendChannelMessageInput) SetChimeBearer 

func (s *SendChannelMessageInput) SetChimeBearer(v string) *SendChannelMessageInput

SetChimeBearer sets the ChimeBearer field's value.

func (*SendChannelMessageInput) SetClientRequestToken 

func (s *SendChannelMessageInput) SetClientRequestToken(v string) *SendChannelMessageInput

SetClientRequestToken sets the ClientRequestToken field's value.

func (*SendChannelMessageInput) SetContent 

func (s *SendChannelMessageInput) SetContent(v string) *SendChannelMessageInput

SetContent sets the Content field's value.

func (*SendChannelMessageInput) SetContentType added in v1.44.228 

func (s *SendChannelMessageInput) SetContentType(v string) *SendChannelMessageInput

SetContentType sets the ContentType field's value.

func (*SendChannelMessageInput) SetMessageAttributes added in v1.41.11 

func (s *SendChannelMessageInput) SetMessageAttributes(v map[string]*MessageAttributeValue) *SendChannelMessageInput

SetMessageAttributes sets the MessageAttributes field's value.

func (*SendChannelMessageInput) SetMetadata 

func (s *SendChannelMessageInput) SetMetadata(v string) *SendChannelMessageInput

SetMetadata sets the Metadata field's value.

func (*SendChannelMessageInput) SetPersistence 

func (s *SendChannelMessageInput) SetPersistence(v string) *SendChannelMessageInput

SetPersistence sets the Persistence field's value.

func (*SendChannelMessageInput) SetPushNotification added in v1.41.11 

func (s *SendChannelMessageInput) SetPushNotification(v *PushNotificationConfiguration) *SendChannelMessageInput

SetPushNotification sets the PushNotification field's value.

func (*SendChannelMessageInput) SetSubChannelId added in v1.44.76 

func (s *SendChannelMessageInput) SetSubChannelId(v string) *SendChannelMessageInput

SetSubChannelId sets the SubChannelId field's value.

func (*SendChannelMessageInput) SetTarget added in v1.44.288 

func (s *SendChannelMessageInput) SetTarget(v []*Target) *SendChannelMessageInput

SetTarget sets the Target field's value.

func (*SendChannelMessageInput) SetType 

func (s *SendChannelMessageInput) SetType(v string) *SendChannelMessageInput

SetType sets the Type field's value.

func (SendChannelMessageInput) String 

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

func (s *SendChannelMessageInput) Validate() error

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

type SendChannelMessageOutput 

type SendChannelMessageOutput struct {

	// The ARN of the channel.
	ChannelArn *string `min:"5" type:"string"`

	// The ID string assigned to each message.
	MessageId *string `min:"1" type:"string"`

	// The status of the channel message.
	Status *ChannelMessageStatusStructure `type:"structure"`

	// The ID of the SubChannel in the response.
	SubChannelId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (SendChannelMessageOutput) GoString 

func (s SendChannelMessageOutput) 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 (*SendChannelMessageOutput) SetChannelArn 

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

SetChannelArn sets the ChannelArn field's value.

func (*SendChannelMessageOutput) SetMessageId 

func (s *SendChannelMessageOutput) SetMessageId(v string) *SendChannelMessageOutput

SetMessageId sets the MessageId field's value.

func (*SendChannelMessageOutput) SetStatus added in v1.41.6 

func (s *SendChannelMessageOutput) SetStatus(v *ChannelMessageStatusStructure) *SendChannelMessageOutput

SetStatus sets the Status field's value.

func (*SendChannelMessageOutput) SetSubChannelId added in v1.44.76 

func (s *SendChannelMessageOutput) SetSubChannelId(v string) *SendChannelMessageOutput

SetSubChannelId sets the SubChannelId field's value.

func (SendChannelMessageOutput) String 

func (s SendChannelMessageOutput) 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 ServiceFailureException 

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

	Code_ *string `locationName:"Code" type:"string" enum:"ErrorCode"`

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

The service encountered an unexpected error.

func (*ServiceFailureException) Code 

func (s *ServiceFailureException) Code() string

Code returns the exception type name.

func (*ServiceFailureException) Error 

func (s *ServiceFailureException) Error() string

func (ServiceFailureException) GoString 

func (s ServiceFailureException) 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 (*ServiceFailureException) Message 

func (s *ServiceFailureException) Message() string

Message returns the exception's message.

func (*ServiceFailureException) OrigErr 

func (s *ServiceFailureException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ServiceFailureException) RequestID 

func (s *ServiceFailureException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ServiceFailureException) StatusCode 

func (s *ServiceFailureException) StatusCode() int

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

func (ServiceFailureException) String 

func (s ServiceFailureException) 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 ServiceUnavailableException 

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

	Code_ *string `locationName:"Code" type:"string" enum:"ErrorCode"`

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

The service is currently unavailable.

func (*ServiceUnavailableException) Code 

func (s *ServiceUnavailableException) Code() string

Code returns the exception type name.

func (*ServiceUnavailableException) Error 

func (s *ServiceUnavailableException) Error() string

func (ServiceUnavailableException) GoString 

func (s ServiceUnavailableException) 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 (*ServiceUnavailableException) Message 

func (s *ServiceUnavailableException) Message() string

Message returns the exception's message.

func (*ServiceUnavailableException) OrigErr 

func (s *ServiceUnavailableException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ServiceUnavailableException) RequestID 

func (s *ServiceUnavailableException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ServiceUnavailableException) StatusCode 

func (s *ServiceUnavailableException) StatusCode() int

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

func (ServiceUnavailableException) String 

func (s ServiceUnavailableException) 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 StreamingConfiguration added in v1.44.226 

type StreamingConfiguration struct {

	// The data type of the configuration.
	//
	// DataType is a required field
	DataType *string `type:"string" required:"true" enum:"MessagingDataType"`

	// The ARN of the resource in the configuration.
	//
	// ResourceArn is a required field
	ResourceArn *string `min:"5" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The configuration for connecting a messaging stream to Amazon Kinesis.

func (StreamingConfiguration) GoString added in v1.44.226 

func (s StreamingConfiguration) 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 (*StreamingConfiguration) SetDataType added in v1.44.226 

func (s *StreamingConfiguration) SetDataType(v string) *StreamingConfiguration

SetDataType sets the DataType field's value.

func (*StreamingConfiguration) SetResourceArn added in v1.44.226 

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

SetResourceArn sets the ResourceArn field's value.

func (StreamingConfiguration) String added in v1.44.226 

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

func (s *StreamingConfiguration) Validate() error

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

type SubChannelSummary added in v1.44.76 

type SubChannelSummary struct {

	// The number of members in a SubChannel.
	MembershipCount *int64 `type:"integer"`

	// The unique ID of a SubChannel.
	SubChannelId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Summary of the sub-channels associated with the elastic channel.

func (SubChannelSummary) GoString added in v1.44.76 

func (s SubChannelSummary) 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 (*SubChannelSummary) SetMembershipCount added in v1.44.76 

func (s *SubChannelSummary) SetMembershipCount(v int64) *SubChannelSummary

SetMembershipCount sets the MembershipCount field's value.

func (*SubChannelSummary) SetSubChannelId added in v1.44.76 

func (s *SubChannelSummary) SetSubChannelId(v string) *SubChannelSummary

SetSubChannelId sets the SubChannelId field's value.

func (SubChannelSummary) String added in v1.44.76 

func (s SubChannelSummary) 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 Tag 

type Tag struct {

	// The key in a tag.
	//
	// Key is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by Tag's
	// String and GoString methods.
	//
	// Key is a required field
	Key *string `min:"1" type:"string" required:"true" sensitive:"true"`

	// The value in a tag.
	//
	// Value is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by Tag's
	// String and GoString methods.
	//
	// Value is a required field
	Value *string `min:"1" type:"string" required:"true" sensitive:"true"`
	// contains filtered or unexported fields
}

A tag object containing a key-value pair.

func (Tag) GoString 

func (s Tag) 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 (*Tag) SetKey 

func (s *Tag) SetKey(v string) *Tag

SetKey sets the Key field's value.

func (*Tag) SetValue 

func (s *Tag) SetValue(v string) *Tag

SetValue sets the Value field's value.

func (Tag) String 

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

func (s *Tag) Validate() error

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

type TagResourceInput added in v1.41.6 

type TagResourceInput struct {

	// The resource ARN.
	//
	// ResourceARN is a required field
	ResourceARN *string `min:"5" type:"string" required:"true"`

	// The tag key-value pairs.
	//
	// Tags is a required field
	Tags []*Tag `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (TagResourceInput) GoString added in v1.41.6 

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

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

SetResourceARN sets the ResourceARN field's value.

func (*TagResourceInput) SetTags added in v1.41.6 

func (s *TagResourceInput) SetTags(v []*Tag) *TagResourceInput

SetTags sets the Tags field's value.

func (TagResourceInput) String added in v1.41.6 

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

func (s *TagResourceInput) Validate() error

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

type TagResourceOutput added in v1.41.6 

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

func (TagResourceOutput) GoString added in v1.41.6 

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

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 Target added in v1.44.288 

type Target struct {

	// The ARN of the target channel member.
	MemberArn *string `min:"5" type:"string"`
	// contains filtered or unexported fields
}

The target of a message, a sender, a user, or a bot. Only the target and the sender can view targeted messages. Only users who can see targeted messages can take actions on them. However, administrators can delete targeted messages that they can’t see.

func (Target) GoString added in v1.44.288 

func (s Target) 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 (*Target) SetMemberArn added in v1.44.288 

func (s *Target) SetMemberArn(v string) *Target

SetMemberArn sets the MemberArn field's value.

func (Target) String added in v1.44.288 

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

func (s *Target) Validate() error

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

type ThrottledClientException 

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

	Code_ *string `locationName:"Code" type:"string" enum:"ErrorCode"`

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

The client exceeded its request rate limit.

func (*ThrottledClientException) Code 

func (s *ThrottledClientException) Code() string

Code returns the exception type name.

func (*ThrottledClientException) Error 

func (s *ThrottledClientException) Error() string

func (ThrottledClientException) GoString 

func (s ThrottledClientException) 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 (*ThrottledClientException) Message 

func (s *ThrottledClientException) Message() string

Message returns the exception's message.

func (*ThrottledClientException) OrigErr 

func (s *ThrottledClientException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ThrottledClientException) RequestID 

func (s *ThrottledClientException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ThrottledClientException) StatusCode 

func (s *ThrottledClientException) StatusCode() int

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

func (ThrottledClientException) String 

func (s ThrottledClientException) 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 UnauthorizedClientException 

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

	Code_ *string `locationName:"Code" type:"string" enum:"ErrorCode"`

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

The client is not currently authorized to make the request.

func (*UnauthorizedClientException) Code 

func (s *UnauthorizedClientException) Code() string

Code returns the exception type name.

func (*UnauthorizedClientException) Error 

func (s *UnauthorizedClientException) Error() string

func (UnauthorizedClientException) GoString 

func (s UnauthorizedClientException) 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 (*UnauthorizedClientException) Message 

func (s *UnauthorizedClientException) Message() string

Message returns the exception's message.

func (*UnauthorizedClientException) OrigErr 

func (s *UnauthorizedClientException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*UnauthorizedClientException) RequestID 

func (s *UnauthorizedClientException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*UnauthorizedClientException) StatusCode 

func (s *UnauthorizedClientException) StatusCode() int

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

func (UnauthorizedClientException) String 

func (s UnauthorizedClientException) 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 added in v1.41.6 

type UntagResourceInput struct {

	// The resource ARN.
	//
	// ResourceARN is a required field
	ResourceARN *string `min:"5" type:"string" required:"true"`

	// The tag keys.
	//
	// TagKeys is a required field
	TagKeys []*string `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (UntagResourceInput) GoString added in v1.41.6 

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

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

SetResourceARN sets the ResourceARN field's value.

func (*UntagResourceInput) SetTagKeys added in v1.41.6 

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

SetTagKeys sets the TagKeys field's value.

func (UntagResourceInput) String added in v1.41.6 

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

func (s *UntagResourceInput) Validate() error

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

type UntagResourceOutput added in v1.41.6 

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

func (UntagResourceOutput) GoString added in v1.41.6 

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

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 UpdateChannelFlowInput added in v1.41.6 

type UpdateChannelFlowInput struct {

	// The ARN of the channel flow.
	//
	// ChannelFlowArn is a required field
	ChannelFlowArn *string `location:"uri" locationName:"channelFlowArn" min:"5" type:"string" required:"true"`

	// The name of the channel flow.
	//
	// Name is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by UpdateChannelFlowInput's
	// String and GoString methods.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true" sensitive:"true"`

	// Information about the processor Lambda functions
	//
	// Processors is a required field
	Processors []*Processor `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateChannelFlowInput) GoString added in v1.41.6 

func (s UpdateChannelFlowInput) 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 (*UpdateChannelFlowInput) SetChannelFlowArn added in v1.41.6 

func (s *UpdateChannelFlowInput) SetChannelFlowArn(v string) *UpdateChannelFlowInput

SetChannelFlowArn sets the ChannelFlowArn field's value.

func (*UpdateChannelFlowInput) SetName added in v1.41.6 

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

SetName sets the Name field's value.

func (*UpdateChannelFlowInput) SetProcessors added in v1.41.6 

func (s *UpdateChannelFlowInput) SetProcessors(v []*Processor) *UpdateChannelFlowInput

SetProcessors sets the Processors field's value.

func (UpdateChannelFlowInput) String added in v1.41.6 

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

func (s *UpdateChannelFlowInput) Validate() error

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

type UpdateChannelFlowOutput added in v1.41.6 

type UpdateChannelFlowOutput struct {

	// The ARN of the channel flow.
	ChannelFlowArn *string `min:"5" type:"string"`
	// contains filtered or unexported fields
}

func (UpdateChannelFlowOutput) GoString added in v1.41.6 

func (s UpdateChannelFlowOutput) 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 (*UpdateChannelFlowOutput) SetChannelFlowArn added in v1.41.6 

func (s *UpdateChannelFlowOutput) SetChannelFlowArn(v string) *UpdateChannelFlowOutput

SetChannelFlowArn sets the ChannelFlowArn field's value.

func (UpdateChannelFlowOutput) String added in v1.41.6 

func (s UpdateChannelFlowOutput) 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 UpdateChannelInput 

type UpdateChannelInput struct {

	// The ARN of the channel.
	//
	// ChannelArn is a required field
	ChannelArn *string `location:"uri" locationName:"channelArn" min:"5" type:"string" required:"true"`

	// The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
	//
	// ChimeBearer is a required field
	ChimeBearer *string `location:"header" locationName:"x-amz-chime-bearer" min:"5" type:"string" required:"true"`

	// The metadata for the update request.
	//
	// Metadata is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by UpdateChannelInput's
	// String and GoString methods.
	Metadata *string `type:"string" sensitive:"true"`

	// The mode of the update request.
	Mode *string `type:"string" enum:"ChannelMode"`

	// The name of the channel.
	//
	// Name is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by UpdateChannelInput's
	// String and GoString methods.
	Name *string `min:"1" type:"string" sensitive:"true"`
	// contains filtered or unexported fields
}

func (UpdateChannelInput) GoString 

func (s UpdateChannelInput) 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 (*UpdateChannelInput) SetChannelArn 

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

SetChannelArn sets the ChannelArn field's value.

func (*UpdateChannelInput) SetChimeBearer 

func (s *UpdateChannelInput) SetChimeBearer(v string) *UpdateChannelInput

SetChimeBearer sets the ChimeBearer field's value.

func (*UpdateChannelInput) SetMetadata 

func (s *UpdateChannelInput) SetMetadata(v string) *UpdateChannelInput

SetMetadata sets the Metadata field's value.

func (*UpdateChannelInput) SetMode 

func (s *UpdateChannelInput) SetMode(v string) *UpdateChannelInput

SetMode sets the Mode field's value.

func (*UpdateChannelInput) SetName 

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

SetName sets the Name field's value.

func (UpdateChannelInput) String 

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

func (s *UpdateChannelInput) Validate() error

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

type UpdateChannelMessageInput 

type UpdateChannelMessageInput struct {

	// The ARN of the channel.
	//
	// ChannelArn is a required field
	ChannelArn *string `location:"uri" locationName:"channelArn" min:"5" type:"string" required:"true"`

	// The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
	//
	// ChimeBearer is a required field
	ChimeBearer *string `location:"header" locationName:"x-amz-chime-bearer" min:"5" type:"string" required:"true"`

	// The content of the channel message.
	//
	// Content is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by UpdateChannelMessageInput's
	// String and GoString methods.
	//
	// Content is a required field
	Content *string `min:"1" type:"string" required:"true" sensitive:"true"`

	// The content type of the channel message.
	//
	// ContentType is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by UpdateChannelMessageInput's
	// String and GoString methods.
	ContentType *string `type:"string" sensitive:"true"`

	// The ID string of the message being updated.
	//
	// MessageId is a required field
	MessageId *string `location:"uri" locationName:"messageId" min:"1" type:"string" required:"true"`

	// The metadata of the message being updated.
	//
	// Metadata is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by UpdateChannelMessageInput's
	// String and GoString methods.
	Metadata *string `type:"string" sensitive:"true"`

	// The ID of the SubChannel in the request.
	//
	// Only required when updating messages in a SubChannel that the user belongs
	// to.
	SubChannelId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (UpdateChannelMessageInput) GoString 

func (s UpdateChannelMessageInput) 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 (*UpdateChannelMessageInput) SetChannelArn 

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

SetChannelArn sets the ChannelArn field's value.

func (*UpdateChannelMessageInput) SetChimeBearer 

func (s *UpdateChannelMessageInput) SetChimeBearer(v string) *UpdateChannelMessageInput

SetChimeBearer sets the ChimeBearer field's value.

func (*UpdateChannelMessageInput) SetContent 

func (s *UpdateChannelMessageInput) SetContent(v string) *UpdateChannelMessageInput

SetContent sets the Content field's value.

func (*UpdateChannelMessageInput) SetContentType added in v1.44.228 

func (s *UpdateChannelMessageInput) SetContentType(v string) *UpdateChannelMessageInput

SetContentType sets the ContentType field's value.

func (*UpdateChannelMessageInput) SetMessageId 

func (s *UpdateChannelMessageInput) SetMessageId(v string) *UpdateChannelMessageInput

SetMessageId sets the MessageId field's value.

func (*UpdateChannelMessageInput) SetMetadata 

func (s *UpdateChannelMessageInput) SetMetadata(v string) *UpdateChannelMessageInput

SetMetadata sets the Metadata field's value.

func (*UpdateChannelMessageInput) SetSubChannelId added in v1.44.76 

func (s *UpdateChannelMessageInput) SetSubChannelId(v string) *UpdateChannelMessageInput

SetSubChannelId sets the SubChannelId field's value.

func (UpdateChannelMessageInput) String 

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

func (s *UpdateChannelMessageInput) Validate() error

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

type UpdateChannelMessageOutput 

type UpdateChannelMessageOutput struct {

	// The ARN of the channel.
	ChannelArn *string `min:"5" type:"string"`

	// The ID string of the message being updated.
	MessageId *string `min:"1" type:"string"`

	// The status of the message update.
	Status *ChannelMessageStatusStructure `type:"structure"`

	// The ID of the SubChannel in the response.
	SubChannelId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (UpdateChannelMessageOutput) GoString 

func (s UpdateChannelMessageOutput) 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 (*UpdateChannelMessageOutput) SetChannelArn 

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

SetChannelArn sets the ChannelArn field's value.

func (*UpdateChannelMessageOutput) SetMessageId 

func (s *UpdateChannelMessageOutput) SetMessageId(v string) *UpdateChannelMessageOutput

SetMessageId sets the MessageId field's value.

func (*UpdateChannelMessageOutput) SetStatus added in v1.41.6 

func (s *UpdateChannelMessageOutput) SetStatus(v *ChannelMessageStatusStructure) *UpdateChannelMessageOutput

SetStatus sets the Status field's value.

func (*UpdateChannelMessageOutput) SetSubChannelId added in v1.44.76 

func (s *UpdateChannelMessageOutput) SetSubChannelId(v string) *UpdateChannelMessageOutput

SetSubChannelId sets the SubChannelId field's value.

func (UpdateChannelMessageOutput) String 

func (s UpdateChannelMessageOutput) 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 UpdateChannelOutput 

type UpdateChannelOutput struct {

	// The ARN of the channel.
	ChannelArn *string `min:"5" type:"string"`
	// contains filtered or unexported fields
}

func (UpdateChannelOutput) GoString 

func (s UpdateChannelOutput) 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 (*UpdateChannelOutput) SetChannelArn 

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

SetChannelArn sets the ChannelArn field's value.

func (UpdateChannelOutput) String 

func (s UpdateChannelOutput) 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 UpdateChannelReadMarkerInput 

type UpdateChannelReadMarkerInput struct {

	// The ARN of the channel.
	//
	// ChannelArn is a required field
	ChannelArn *string `location:"uri" locationName:"channelArn" min:"5" type:"string" required:"true"`

	// The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
	//
	// ChimeBearer is a required field
	ChimeBearer *string `location:"header" locationName:"x-amz-chime-bearer" min:"5" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateChannelReadMarkerInput) GoString 

func (s UpdateChannelReadMarkerInput) 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 (*UpdateChannelReadMarkerInput) SetChannelArn 

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

SetChannelArn sets the ChannelArn field's value.

func (*UpdateChannelReadMarkerInput) SetChimeBearer 

func (s *UpdateChannelReadMarkerInput) SetChimeBearer(v string) *UpdateChannelReadMarkerInput

SetChimeBearer sets the ChimeBearer field's value.

func (UpdateChannelReadMarkerInput) String 

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

func (s *UpdateChannelReadMarkerInput) Validate() error

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

type UpdateChannelReadMarkerOutput 

type UpdateChannelReadMarkerOutput struct {

	// The ARN of the channel.
	ChannelArn *string `min:"5" type:"string"`
	// contains filtered or unexported fields
}

func (UpdateChannelReadMarkerOutput) GoString 

func (s UpdateChannelReadMarkerOutput) 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 (*UpdateChannelReadMarkerOutput) SetChannelArn 

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

SetChannelArn sets the ChannelArn field's value.

func (UpdateChannelReadMarkerOutput) String 

func (s UpdateChannelReadMarkerOutput) 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 chimesdkmessagingiface provides an interface to enable mocking the Amazon Chime SDK Messaging service client for testing your code.
 Package chimesdkmessagingiface provides an interface to enable mocking the Amazon Chime SDK Messaging 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.