types

package
v1.22.6 Latest Latest
Warning

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

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AllowMessages added in v1.4.0 

type AllowMessages string
const (
	AllowMessagesAll  AllowMessages = "ALL"
	AllowMessagesNone AllowMessages = "NONE"
)

Enum values for AllowMessages

func (AllowMessages) Values added in v1.4.0 

func (AllowMessages) Values() []AllowMessages

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

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

type AppInstance 

type AppInstance struct {

	// The ARN of the messaging instance.
	AppInstanceArn *string

	// The time at which an AppInstance was created. In epoch milliseconds.
	CreatedTimestamp *time.Time

	// The time an AppInstance was last updated. In epoch milliseconds.
	LastUpdatedTimestamp *time.Time

	// The metadata of an AppInstance .
	Metadata *string

	// The name of an AppInstance .
	Name *string
	// contains filtered or unexported fields
}

The details of an AppInstance , an instance of an Amazon Chime SDK messaging application.

type AppInstanceAdmin 

type AppInstanceAdmin struct {

	// The AppInstanceAdmin data.
	Admin *Identity

	// The ARN of the AppInstance for which the user is an administrator.
	AppInstanceArn *string

	// The time at which an administrator was created.
	CreatedTimestamp *time.Time
	// contains filtered or unexported fields
}

The name and ARN of the admin for the AppInstance .

type AppInstanceAdminSummary 

type AppInstanceAdminSummary struct {

	// The details of the AppInstanceAdmin .
	Admin *Identity
	// contains filtered or unexported fields
}

Summary of the details of an AppInstanceAdmin .

type AppInstanceBot added in v1.11.0 

type AppInstanceBot struct {

	// The ARN of the AppInstanceBot.
	AppInstanceBotArn *string

	// The data processing instructions for an AppInstanceBot.
	Configuration *Configuration

	// The time at which the AppInstanceBot was created.
	CreatedTimestamp *time.Time

	// The time at which the AppInstanceBot was last updated.
	LastUpdatedTimestamp *time.Time

	// The metadata for an AppInstanceBot.
	Metadata *string

	// The name of the AppInstanceBot.
	Name *string
	// contains filtered or unexported fields
}

An Amazon Lex V2 chat bot created under an AppInstance .

type AppInstanceBotSummary added in v1.11.0 

type AppInstanceBotSummary struct {

	// The ARN of the AppInstanceBot.
	AppInstanceBotArn *string

	// The metadata of the AppInstanceBot.
	Metadata *string

	// The name of the AppInstanceBox.
	Name *string
	// contains filtered or unexported fields
}

High-level information about an AppInstanceBot.

type AppInstanceRetentionSettings 

type AppInstanceRetentionSettings struct {

	// The length of time in days to retain the messages in a channel.
	ChannelRetentionSettings *ChannelRetentionSettings
	// contains filtered or unexported fields
}

The details of the data-retention settings for an AppInstance .

type AppInstanceSummary 

type AppInstanceSummary struct {

	// The AppInstance ARN.
	AppInstanceArn *string

	// The metadata of the AppInstance .
	Metadata *string

	// The name of the AppInstance .
	Name *string
	// contains filtered or unexported fields
}

Summary of the data for an AppInstance .

type AppInstanceUser 

type AppInstanceUser struct {

	// The ARN of the AppInstanceUser .
	AppInstanceUserArn *string

	// The time at which the AppInstanceUser was created.
	CreatedTimestamp *time.Time

	// The interval after which an AppInstanceUser is automatically deleted.
	ExpirationSettings *ExpirationSettings

	// The time at which the AppInstanceUser was last updated.
	LastUpdatedTimestamp *time.Time

	// The metadata of the AppInstanceUser .
	Metadata *string

	// The name of the AppInstanceUser .
	Name *string
	// contains filtered or unexported fields
}

The details of an AppInstanceUser .

type AppInstanceUserEndpoint added in v1.4.0 

type AppInstanceUserEndpoint struct {

	// Boolean that controls whether the AppInstanceUserEndpoint is opted in to
	// receive messages. ALL indicates the endpoint will receive all messages. NONE
	// indicates the endpoint will receive no messages.
	AllowMessages AllowMessages

	// The ARN of the AppInstanceUser .
	AppInstanceUserArn *string

	// The time at which an AppInstanceUserEndpoint was created.
	CreatedTimestamp *time.Time

	// The attributes of an Endpoint .
	EndpointAttributes *EndpointAttributes

	// The unique identifier of the AppInstanceUserEndpoint .
	EndpointId *string

	// A read-only field that represents the state of an AppInstanceUserEndpoint .
	// Supported values:
	//
	//   - ACTIVE : The AppInstanceUserEndpoint is active and able to receive messages.
	//   When ACTIVE , the EndpointStatusReason remains empty.
	//
	//   - INACTIVE : The AppInstanceUserEndpoint is inactive and can't receive
	//   message. When INACTIVE , the corresponding reason will be conveyed through
	//   EndpointStatusReason .
	//
	//   - INVALID_DEVICE_TOKEN indicates that an AppInstanceUserEndpoint is INACTIVE
	//   due to invalid device token
	//
	//   - INVALID_PINPOINT_ARN indicates that an AppInstanceUserEndpoint is INACTIVE
	//   due to an invalid pinpoint ARN that was input through the ResourceArn field.
	EndpointState *EndpointState

	// The time at which an AppInstanceUserEndpoint was last updated.
	LastUpdatedTimestamp *time.Time

	// The name of the AppInstanceUserEndpoint .
	Name *string

	// The ARN of the resource to which the endpoint belongs.
	ResourceArn *string

	// The type of the AppInstanceUserEndpoint .
	Type AppInstanceUserEndpointType
	// contains filtered or unexported fields
}

An endpoint under an Amazon Chime AppInstanceUser that receives messages for a user. For push notifications, the endpoint is a mobile device used to receive mobile push notifications for a user.

type AppInstanceUserEndpointSummary added in v1.4.0 

type AppInstanceUserEndpointSummary struct {

	// BBoolean that controls whether the AppInstanceUserEndpoint is opted in to
	// receive messages. ALL indicates the endpoint will receive all messages. NONE
	// indicates the endpoint will receive no messages.
	AllowMessages AllowMessages

	// The ARN of the AppInstanceUser .
	AppInstanceUserArn *string

	// The unique identifier of the AppInstanceUserEndpoint .
	EndpointId *string

	// A read-only field that represent the state of an AppInstanceUserEndpoint .
	EndpointState *EndpointState

	// The name of the AppInstanceUserEndpoint .
	Name *string

	// The type of the AppInstanceUserEndpoint .
	Type AppInstanceUserEndpointType
	// contains filtered or unexported fields
}

Summary of the details of an AppInstanceUserEndpoint .

type AppInstanceUserEndpointType added in v1.4.0 

type AppInstanceUserEndpointType string
const (
	AppInstanceUserEndpointTypeApns        AppInstanceUserEndpointType = "APNS"
	AppInstanceUserEndpointTypeApnsSandbox AppInstanceUserEndpointType = "APNS_SANDBOX"
	AppInstanceUserEndpointTypeGcm         AppInstanceUserEndpointType = "GCM"
)

Enum values for AppInstanceUserEndpointType

func (AppInstanceUserEndpointType) Values added in v1.4.0 

func (AppInstanceUserEndpointType) Values() []AppInstanceUserEndpointType

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

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

type AppInstanceUserSummary 

type AppInstanceUserSummary struct {

	// The ARN of the AppInstanceUser .
	AppInstanceUserArn *string

	// The metadata of the AppInstanceUser .
	Metadata *string

	// The name of an AppInstanceUser .
	Name *string
	// contains filtered or unexported fields
}

Summary of the details of an AppInstanceUser .

type BadRequestException 

type BadRequestException struct {
	Message *string

	ErrorCodeOverride *string

	Code ErrorCode
	// contains filtered or unexported fields
}

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

func (*BadRequestException) Error 

func (e *BadRequestException) Error() string

func (*BadRequestException) ErrorCode 

func (e *BadRequestException) ErrorCode() string

func (*BadRequestException) ErrorFault 

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

func (*BadRequestException) ErrorMessage 

func (e *BadRequestException) ErrorMessage() string

type ChannelRetentionSettings 

type ChannelRetentionSettings struct {

	// The time in days to retain the messages in a channel.
	RetentionDays *int32
	// contains filtered or unexported fields
}

The details of the retention settings for a channel.

type Configuration added in v1.11.0 

type Configuration struct {

	// The configuration for an Amazon Lex V2 bot.
	//
	// This member is required.
	Lex *LexConfiguration
	// contains filtered or unexported fields
}

A structure that contains configuration data.

type ConflictException 

type ConflictException struct {
	Message *string

	ErrorCodeOverride *string

	Code ErrorCode
	// contains filtered or unexported fields
}

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

func (*ConflictException) Error 

func (e *ConflictException) Error() string

func (*ConflictException) ErrorCode 

func (e *ConflictException) ErrorCode() string

func (*ConflictException) ErrorFault 

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

func (*ConflictException) ErrorMessage 

func (e *ConflictException) ErrorMessage() string

type EndpointAttributes added in v1.4.0 

type EndpointAttributes struct {

	// The device token for the GCM, APNS, and APNS_SANDBOX endpoint types.
	//
	// This member is required.
	DeviceToken *string

	// The VOIP device token for the APNS and APNS_SANDBOX endpoint types.
	VoipDeviceToken *string
	// contains filtered or unexported fields
}

The attributes of an Endpoint .

type EndpointState added in v1.4.0 

type EndpointState struct {

	// Enum that indicates the Status of an AppInstanceUserEndpoint .
	//
	// This member is required.
	Status EndpointStatus

	// The reason for the EndpointStatus .
	StatusReason EndpointStatusReason
	// contains filtered or unexported fields
}

A read-only field that represents the state of an AppInstanceUserEndpoint . Supported values:

  • ACTIVE : The AppInstanceUserEndpoint is active and able to receive messages. When ACTIVE , the EndpointStatusReason remains empty.

  • INACTIVE : The AppInstanceUserEndpoint is inactive and can't receive message. When INACTIVE, the corresponding reason will be conveyed through EndpointStatusReason.

  • INVALID_DEVICE_TOKEN indicates that an AppInstanceUserEndpoint is INACTIVE due to invalid device token

  • INVALID_PINPOINT_ARN indicates that an AppInstanceUserEndpoint is INACTIVE due to an invalid pinpoint ARN that was input through the ResourceArn field.

type EndpointStatus added in v1.4.0 

type EndpointStatus string
const (
	EndpointStatusActive   EndpointStatus = "ACTIVE"
	EndpointStatusInactive EndpointStatus = "INACTIVE"
)

Enum values for EndpointStatus

func (EndpointStatus) Values added in v1.4.0 

func (EndpointStatus) Values() []EndpointStatus

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

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

type EndpointStatusReason added in v1.4.0 

type EndpointStatusReason string
const (
	EndpointStatusReasonInvalidDeviceToken EndpointStatusReason = "INVALID_DEVICE_TOKEN"
	EndpointStatusReasonInvalidPinpointArn EndpointStatusReason = "INVALID_PINPOINT_ARN"
)

Enum values for EndpointStatusReason

func (EndpointStatusReason) Values added in v1.4.0 

func (EndpointStatusReason) Values() []EndpointStatusReason

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

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

type ErrorCode 

type ErrorCode string
const (
	ErrorCodeBadRequest                           ErrorCode = "BadRequest"
	ErrorCodeConflict                             ErrorCode = "Conflict"
	ErrorCodeForbidden                            ErrorCode = "Forbidden"
	ErrorCodeNotFound                             ErrorCode = "NotFound"
	ErrorCodePreconditionFailed                   ErrorCode = "PreconditionFailed"
	ErrorCodeResourceLimitExceeded                ErrorCode = "ResourceLimitExceeded"
	ErrorCodeServiceFailure                       ErrorCode = "ServiceFailure"
	ErrorCodeAccessDenied                         ErrorCode = "AccessDenied"
	ErrorCodeServiceUnavailable                   ErrorCode = "ServiceUnavailable"
	ErrorCodeThrottled                            ErrorCode = "Throttled"
	ErrorCodeThrottling                           ErrorCode = "Throttling"
	ErrorCodeUnauthorized                         ErrorCode = "Unauthorized"
	ErrorCodeUnprocessable                        ErrorCode = "Unprocessable"
	ErrorCodeVoiceConnectorGroupAssociationsExist ErrorCode = "VoiceConnectorGroupAssociationsExist"
	ErrorCodePhoneNumberAssociationsExist         ErrorCode = "PhoneNumberAssociationsExist"
)

Enum values for ErrorCode

func (ErrorCode) Values 

func (ErrorCode) Values() []ErrorCode

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

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

type ExpirationCriterion added in v1.11.0 

type ExpirationCriterion string
const (
	ExpirationCriterionCreatedTimestamp ExpirationCriterion = "CREATED_TIMESTAMP"
)

Enum values for ExpirationCriterion

func (ExpirationCriterion) Values added in v1.11.0 

func (ExpirationCriterion) Values() []ExpirationCriterion

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

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

type ExpirationSettings added in v1.11.0 

type ExpirationSettings struct {

	// Specifies the conditions under which an AppInstanceUser will expire.
	//
	// This member is required.
	ExpirationCriterion ExpirationCriterion

	// The period in days after which an AppInstanceUser will be automatically deleted.
	//
	// This member is required.
	ExpirationDays *int32
	// contains filtered or unexported fields
}

Determines the interval after which an AppInstanceUser is automatically deleted.

type ForbiddenException 

type ForbiddenException struct {
	Message *string

	ErrorCodeOverride *string

	Code ErrorCode
	// contains filtered or unexported fields
}

The client is permanently forbidden from making the request.

func (*ForbiddenException) Error 

func (e *ForbiddenException) Error() string

func (*ForbiddenException) ErrorCode 

func (e *ForbiddenException) ErrorCode() string

func (*ForbiddenException) ErrorFault 

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

func (*ForbiddenException) ErrorMessage 

func (e *ForbiddenException) ErrorMessage() string

type Identity 

type Identity struct {

	// The ARN in an Identity.
	Arn *string

	// The name in an Identity.
	Name *string
	// contains filtered or unexported fields
}

The details of a user or bot.

type InvokedBy added in v1.12.0 

type InvokedBy struct {

	// Sets standard messages as the bot trigger. For standard messages:
	//
	//   - ALL : The bot processes all standard messages.
	//
	//   - AUTO : The bot responds to ALL messages when the channel has one other
	//   non-hidden member, and responds to MENTIONS when the channel has more than one
	//   other non-hidden member.
	//
	//   - MENTIONS : The bot processes all standard messages that have a message
	//   attribute with CHIME.mentions and a value of the bot ARN.
	//
	//   - NONE : The bot processes no standard messages.
	//
	// This member is required.
	StandardMessages StandardMessages

	// Sets targeted messages as the bot trigger. For targeted messages:
	//
	//   - ALL : The bot processes all TargetedMessages sent to it. The bot then
	//   responds with a targeted message back to the sender.
	//
	//   - NONE : The bot processes no targeted messages.
	//
	// This member is required.
	TargetedMessages TargetedMessages
	// contains filtered or unexported fields
}

Specifies the type of message that triggers a bot.

type LexConfiguration added in v1.11.0 

type LexConfiguration struct {

	// The ARN of the Amazon Lex V2 bot's alias. The ARN uses this format:
	// arn:aws:lex:REGION:ACCOUNT:bot-alias/MYBOTID/MYBOTALIAS
	//
	// This member is required.
	LexBotAliasArn *string

	// Identifies the Amazon Lex V2 bot's language and locale. The string must match
	// one of the supported locales in Amazon Lex V2. All of the intents, slot types,
	// and slots used in the bot must have the same locale. For more information, see [Supported languages]
	// in the Amazon Lex V2 Developer Guide.
	//
	// [Supported languages]: https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html
	//
	// This member is required.
	LocaleId *string

	// Specifies the type of message that triggers a bot.
	InvokedBy *InvokedBy

	//  Deprecated. Use InvokedBy instead.
	//
	// Determines whether the Amazon Lex V2 bot responds to all standard messages.
	// Control messages are not supported.
	RespondsTo RespondsTo

	// The name of the welcome intent configured in the Amazon Lex V2 bot.
	WelcomeIntent *string
	// contains filtered or unexported fields
}

The configuration for an Amazon Lex V2 bot.

type NotFoundException added in v1.11.0 

type NotFoundException struct {
	Message *string

	ErrorCodeOverride *string

	Code ErrorCode
	// contains filtered or unexported fields
}

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

func (*NotFoundException) Error added in v1.11.0 

func (e *NotFoundException) Error() string

func (*NotFoundException) ErrorCode added in v1.11.0 

func (e *NotFoundException) ErrorCode() string

func (*NotFoundException) ErrorFault added in v1.11.0 

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

func (*NotFoundException) ErrorMessage added in v1.11.0 

func (e *NotFoundException) ErrorMessage() string

type ResourceLimitExceededException 

type ResourceLimitExceededException struct {
	Message *string

	ErrorCodeOverride *string

	Code ErrorCode
	// contains filtered or unexported fields
}

The request exceeds the resource limit.

func (*ResourceLimitExceededException) Error 

func (e *ResourceLimitExceededException) Error() string

func (*ResourceLimitExceededException) ErrorCode 

func (e *ResourceLimitExceededException) ErrorCode() string

func (*ResourceLimitExceededException) ErrorFault 

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

func (*ResourceLimitExceededException) ErrorMessage 

func (e *ResourceLimitExceededException) ErrorMessage() string

type RespondsTo added in v1.11.0 

type RespondsTo string
const (
	RespondsToStandardMessages RespondsTo = "STANDARD_MESSAGES"
)

Enum values for RespondsTo

func (RespondsTo) Values added in v1.11.0 

func (RespondsTo) Values() []RespondsTo

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

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

type ServiceFailureException 

type ServiceFailureException struct {
	Message *string

	ErrorCodeOverride *string

	Code ErrorCode
	// contains filtered or unexported fields
}

The service encountered an unexpected error.

func (*ServiceFailureException) Error 

func (e *ServiceFailureException) Error() string

func (*ServiceFailureException) ErrorCode 

func (e *ServiceFailureException) ErrorCode() string

func (*ServiceFailureException) ErrorFault 

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

func (*ServiceFailureException) ErrorMessage 

func (e *ServiceFailureException) ErrorMessage() string

type ServiceUnavailableException 

type ServiceUnavailableException struct {
	Message *string

	ErrorCodeOverride *string

	Code ErrorCode
	// contains filtered or unexported fields
}

The service is currently unavailable.

func (*ServiceUnavailableException) Error 

func (e *ServiceUnavailableException) Error() string

func (*ServiceUnavailableException) ErrorCode 

func (e *ServiceUnavailableException) ErrorCode() string

func (*ServiceUnavailableException) ErrorFault 

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

func (*ServiceUnavailableException) ErrorMessage 

func (e *ServiceUnavailableException) ErrorMessage() string

type StandardMessages added in v1.12.0 

type StandardMessages string
const (
	StandardMessagesAuto     StandardMessages = "AUTO"
	StandardMessagesAll      StandardMessages = "ALL"
	StandardMessagesMentions StandardMessages = "MENTIONS"
	StandardMessagesNone     StandardMessages = "NONE"
)

Enum values for StandardMessages

func (StandardMessages) Values added in v1.12.0 

func (StandardMessages) Values() []StandardMessages

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

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

type Tag 

type Tag struct {

	// The key in a tag.
	//
	// This member is required.
	Key *string

	// The value in a tag.
	//
	// This member is required.
	Value *string
	// contains filtered or unexported fields
}

A tag object containing a key-value pair.

type TargetedMessages added in v1.12.0 

type TargetedMessages string
const (
	TargetedMessagesAll  TargetedMessages = "ALL"
	TargetedMessagesNone TargetedMessages = "NONE"
)

Enum values for TargetedMessages

func (TargetedMessages) Values added in v1.12.0 

func (TargetedMessages) Values() []TargetedMessages

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

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

type ThrottledClientException 

type ThrottledClientException struct {
	Message *string

	ErrorCodeOverride *string

	Code ErrorCode
	// contains filtered or unexported fields
}

The client exceeded its request rate limit.

func (*ThrottledClientException) Error 

func (e *ThrottledClientException) Error() string

func (*ThrottledClientException) ErrorCode 

func (e *ThrottledClientException) ErrorCode() string

func (*ThrottledClientException) ErrorFault 

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

func (*ThrottledClientException) ErrorMessage 

func (e *ThrottledClientException) ErrorMessage() string

type UnauthorizedClientException 

type UnauthorizedClientException struct {
	Message *string

	ErrorCodeOverride *string

	Code ErrorCode
	// contains filtered or unexported fields
}

The client is not currently authorized to make the request.

func (*UnauthorizedClientException) Error 

func (e *UnauthorizedClientException) Error() string

func (*UnauthorizedClientException) ErrorCode 

func (e *UnauthorizedClientException) ErrorCode() string

func (*UnauthorizedClientException) ErrorFault 

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

func (*UnauthorizedClientException) ErrorMessage 

func (e *UnauthorizedClientException) ErrorMessage() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.