Documentation ¶
Index ¶
- type AccessDeniedException
- type AccessDeniedExceptionReason
- type AccountAttribute
- type AccountAttributeName
- type AccountLimit
- type AccountLimitName
- type AttachmentStatus
- type AttachmentUploadErrorReason
- type CloudWatchLogsDestination
- type ConfigurationSetFilter
- type ConfigurationSetFilterName
- type ConfigurationSetInformation
- type ConflictException
- type ConflictExceptionReason
- type DestinationCountryParameterKey
- type EventDestination
- type EventType
- type FieldRequirement
- type FieldType
- type InternalServerException
- type KeywordAction
- type KeywordFilter
- type KeywordFilterName
- type KeywordInformation
- type KinesisFirehoseDestination
- type LanguageCode
- type MessageType
- type NumberCapability
- type NumberStatus
- type NumberType
- type OptOutListInformation
- type OptedOutFilter
- type OptedOutFilterName
- type OptedOutNumberInformation
- type OriginationIdentityMetadata
- type PhoneNumberFilter
- type PhoneNumberFilterName
- type PhoneNumberInformation
- type PoolFilter
- type PoolFilterName
- type PoolInformation
- type PoolOriginationIdentitiesFilter
- type PoolOriginationIdentitiesFilterName
- type PoolStatus
- type ProtectConfigurationCountryRuleSetInformation
- type ProtectConfigurationFilter
- type ProtectConfigurationFilterName
- type ProtectConfigurationInformation
- type ProtectStatus
- type RegistrationAssociationBehavior
- type RegistrationAssociationFilter
- type RegistrationAssociationFilterName
- type RegistrationAssociationMetadata
- type RegistrationAttachmentFilter
- type RegistrationAttachmentFilterName
- type RegistrationAttachmentsInformation
- type RegistrationDeniedReasonInformation
- type RegistrationDisassociationBehavior
- type RegistrationFieldDefinition
- type RegistrationFieldDisplayHints
- type RegistrationFieldValueInformation
- type RegistrationFilter
- type RegistrationFilterName
- type RegistrationInformation
- type RegistrationSectionDefinition
- type RegistrationSectionDisplayHints
- type RegistrationStatus
- type RegistrationTypeDefinition
- type RegistrationTypeDisplayHints
- type RegistrationTypeFilter
- type RegistrationTypeFilterName
- type RegistrationVersionFilter
- type RegistrationVersionFilterName
- type RegistrationVersionInformation
- type RegistrationVersionStatus
- type RegistrationVersionStatusHistory
- type RequestableNumberType
- type ResourceNotFoundException
- type ResourceType
- type SelectOptionDescription
- type SelectValidation
- type SenderIdAndCountry
- type SenderIdFilter
- type SenderIdFilterName
- type SenderIdInformation
- type ServiceQuotaExceededException
- type ServiceQuotaExceededExceptionReason
- type SnsDestination
- type SpendLimit
- type SpendLimitName
- type SupportedAssociation
- type Tag
- type TextValidation
- type ThrottlingException
- type ValidationException
- type ValidationExceptionField
- type ValidationExceptionReason
- type VerificationChannel
- type VerificationStatus
- type VerifiedDestinationNumberFilter
- type VerifiedDestinationNumberFilterName
- type VerifiedDestinationNumberInformation
- type VoiceId
- type VoiceMessageBodyTextType
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AccessDeniedException ¶
type AccessDeniedException struct { Message *string ErrorCodeOverride *string Reason AccessDeniedExceptionReason // contains filtered or unexported fields }
The request was denied because you don't have sufficient permissions to access the resource.
func (*AccessDeniedException) Error ¶
func (e *AccessDeniedException) Error() string
func (*AccessDeniedException) ErrorCode ¶
func (e *AccessDeniedException) ErrorCode() string
func (*AccessDeniedException) ErrorFault ¶
func (e *AccessDeniedException) ErrorFault() smithy.ErrorFault
func (*AccessDeniedException) ErrorMessage ¶
func (e *AccessDeniedException) ErrorMessage() string
type AccessDeniedExceptionReason ¶
type AccessDeniedExceptionReason string
const ( AccessDeniedExceptionReasonInsufficientAccountReputation AccessDeniedExceptionReason = "INSUFFICIENT_ACCOUNT_REPUTATION" AccessDeniedExceptionReasonAccountDisabled AccessDeniedExceptionReason = "ACCOUNT_DISABLED" )
Enum values for AccessDeniedExceptionReason
func (AccessDeniedExceptionReason) Values ¶
func (AccessDeniedExceptionReason) Values() []AccessDeniedExceptionReason
Values returns all known values for AccessDeniedExceptionReason. 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 AccountAttribute ¶
type AccountAttribute struct { // The name of the account attribute. // // This member is required. Name AccountAttributeName // The value associated with the account attribute name. // // This member is required. Value *string // contains filtered or unexported fields }
Displays the attributes associated with a single Amazon Web Services account.
type AccountAttributeName ¶
type AccountAttributeName string
const ( AccountAttributeNameAccountTier AccountAttributeName = "ACCOUNT_TIER" AccountAttributeNameDefaultProtectConfigurationId AccountAttributeName = "DEFAULT_PROTECT_CONFIGURATION_ID" )
Enum values for AccountAttributeName
func (AccountAttributeName) Values ¶
func (AccountAttributeName) Values() []AccountAttributeName
Values returns all known values for AccountAttributeName. 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 AccountLimit ¶
type AccountLimit struct { // The Amazon Web Services set limit for that resource type, in US dollars. // // This member is required. Max int64 // The name of the attribute to apply the account limit to. // // This member is required. Name AccountLimitName // The current amount that has been spent, in US dollars. // // This member is required. Used int64 // contains filtered or unexported fields }
The current resource quotas associated with an Amazon Web Services account.
type AccountLimitName ¶
type AccountLimitName string
const ( AccountLimitNamePhoneNumbers AccountLimitName = "PHONE_NUMBERS" AccountLimitNamePools AccountLimitName = "POOLS" AccountLimitNameConfigurationSets AccountLimitName = "CONFIGURATION_SETS" AccountLimitNameOptOutLists AccountLimitName = "OPT_OUT_LISTS" AccountLimitNameSenderIds AccountLimitName = "SENDER_IDS" AccountLimitNameRegistrations AccountLimitName = "REGISTRATIONS" AccountLimitNameRegistrationAttachments AccountLimitName = "REGISTRATION_ATTACHMENTS" AccountLimitNameVerifiedDestinationNumbers AccountLimitName = "VERIFIED_DESTINATION_NUMBERS" )
Enum values for AccountLimitName
func (AccountLimitName) Values ¶
func (AccountLimitName) Values() []AccountLimitName
Values returns all known values for AccountLimitName. 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 AttachmentStatus ¶
type AttachmentStatus string
const ( AttachmentStatusUploadInProgress AttachmentStatus = "UPLOAD_IN_PROGRESS" AttachmentStatusUploadComplete AttachmentStatus = "UPLOAD_COMPLETE" AttachmentStatusUploadFailed AttachmentStatus = "UPLOAD_FAILED" AttachmentStatusDeleted AttachmentStatus = "DELETED" )
Enum values for AttachmentStatus
func (AttachmentStatus) Values ¶
func (AttachmentStatus) Values() []AttachmentStatus
Values returns all known values for AttachmentStatus. 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 AttachmentUploadErrorReason ¶
type AttachmentUploadErrorReason string
const (
AttachmentUploadErrorReasonInternalError AttachmentUploadErrorReason = "INTERNAL_ERROR"
)
Enum values for AttachmentUploadErrorReason
func (AttachmentUploadErrorReason) Values ¶
func (AttachmentUploadErrorReason) Values() []AttachmentUploadErrorReason
Values returns all known values for AttachmentUploadErrorReason. 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 CloudWatchLogsDestination ¶
type CloudWatchLogsDestination struct { // The Amazon Resource Name (ARN) of an Identity and Access Management role that // is able to write event data to an Amazon CloudWatch destination. // // This member is required. IamRoleArn *string // The name of the Amazon CloudWatch log group that you want to record events in. // // This member is required. LogGroupArn *string // contains filtered or unexported fields }
Contains the destination configuration to use when publishing message sending events.
type ConfigurationSetFilter ¶
type ConfigurationSetFilter struct { // The name of the attribute to filter on. // // This member is required. Name ConfigurationSetFilterName // An array values to filter for. // // This member is required. Values []string // contains filtered or unexported fields }
The information for configuration sets that meet a specified criteria.
type ConfigurationSetFilterName ¶
type ConfigurationSetFilterName string
const ( ConfigurationSetFilterNameEventDestinationName ConfigurationSetFilterName = "event-destination-name" ConfigurationSetFilterNameMatchingEventTypes ConfigurationSetFilterName = "matching-event-types" ConfigurationSetFilterNameDefaultMessageType ConfigurationSetFilterName = "default-message-type" ConfigurationSetFilterNameDefaultSenderId ConfigurationSetFilterName = "default-sender-id" ConfigurationSetFilterNameProtectConfigurationId ConfigurationSetFilterName = "protect-configuration-id" )
Enum values for ConfigurationSetFilterName
func (ConfigurationSetFilterName) Values ¶
func (ConfigurationSetFilterName) Values() []ConfigurationSetFilterName
Values returns all known values for ConfigurationSetFilterName. 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 ConfigurationSetInformation ¶
type ConfigurationSetInformation struct { // The Resource Name (ARN) of the ConfigurationSet. // // This member is required. ConfigurationSetArn *string // The name of the ConfigurationSet. // // This member is required. ConfigurationSetName *string // The time when the ConfigurationSet was created, in [UNIX epoch time] format. // // [UNIX epoch time]: https://www.epochconverter.com/ // // This member is required. CreatedTimestamp *time.Time // An array of EventDestination objects that describe any events to log and where // to log them. // // This member is required. EventDestinations []EventDestination // The type of message. Valid values are TRANSACTIONAL for messages that are // critical or time-sensitive and PROMOTIONAL for messages that aren't critical or // time-sensitive. DefaultMessageType MessageType // The default sender ID used by the ConfigurationSet. DefaultSenderId *string // The unique identifier for the protect configuration. ProtectConfigurationId *string // contains filtered or unexported fields }
Information related to a given configuration set in your Amazon Web Services account.
type ConflictException ¶
type ConflictException struct { Message *string ErrorCodeOverride *string Reason ConflictExceptionReason ResourceType ResourceType ResourceId *string // contains filtered or unexported fields }
Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration 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 ConflictExceptionReason ¶
type ConflictExceptionReason string
const ( ConflictExceptionReasonCreateRegistrationVersionNotAllowed ConflictExceptionReason = "CREATE_REGISTRATION_VERSION_NOT_ALLOWED" ConflictExceptionReasonDeletionProtectionEnabled ConflictExceptionReason = "DELETION_PROTECTION_ENABLED" ConflictExceptionReasonDestinationPhoneNumberNotVerified ConflictExceptionReason = "DESTINATION_PHONE_NUMBER_NOT_VERIFIED" ConflictExceptionReasonDestinationPhoneNumberOptedOut ConflictExceptionReason = "DESTINATION_PHONE_NUMBER_OPTED_OUT" ConflictExceptionReasonDisassociateRegistrationNotAllowed ConflictExceptionReason = "DISASSOCIATE_REGISTRATION_NOT_ALLOWED" ConflictExceptionReasonDiscardRegistrationVersionNotAllowed ConflictExceptionReason = "DISCARD_REGISTRATION_VERSION_NOT_ALLOWED" ConflictExceptionReasonEditRegistrationFieldValuesNotAllowed ConflictExceptionReason = "EDIT_REGISTRATION_FIELD_VALUES_NOT_ALLOWED" ConflictExceptionReasonEventDestinationMismatch ConflictExceptionReason = "EVENT_DESTINATION_MISMATCH" ConflictExceptionReasonKeywordMismatch ConflictExceptionReason = "KEYWORD_MISMATCH" ConflictExceptionReasonLastPhoneNumber ConflictExceptionReason = "LAST_PHONE_NUMBER" ConflictExceptionReasonNumberCapabilitiesMismatch ConflictExceptionReason = "NUMBER_CAPABILITIES_MISMATCH" ConflictExceptionReasonMessageTypeMismatch ConflictExceptionReason = "MESSAGE_TYPE_MISMATCH" ConflictExceptionReasonNoOriginationIdentitiesFound ConflictExceptionReason = "NO_ORIGINATION_IDENTITIES_FOUND" ConflictExceptionReasonOptOutListMismatch ConflictExceptionReason = "OPT_OUT_LIST_MISMATCH" ConflictExceptionReasonPhoneNumberAssociatedToPool ConflictExceptionReason = "PHONE_NUMBER_ASSOCIATED_TO_POOL" ConflictExceptionReasonPhoneNumberAssociatedToRegistration ConflictExceptionReason = "PHONE_NUMBER_ASSOCIATED_TO_REGISTRATION" ConflictExceptionReasonPhoneNumberNotAssociatedToPool ConflictExceptionReason = "PHONE_NUMBER_NOT_ASSOCIATED_TO_POOL" ConflictExceptionReasonPhoneNumberNotInRegistrationRegion ConflictExceptionReason = "PHONE_NUMBER_NOT_IN_REGISTRATION_REGION" ConflictExceptionReasonRegistrationAlreadySubmitted ConflictExceptionReason = "REGISTRATION_ALREADY_SUBMITTED" ConflictExceptionReasonRegistrationNotComplete ConflictExceptionReason = "REGISTRATION_NOT_COMPLETE" ConflictExceptionReasonSenderIdAssociatedToPool ConflictExceptionReason = "SENDER_ID_ASSOCIATED_TO_POOL" ConflictExceptionReasonResourceAlreadyExists ConflictExceptionReason = "RESOURCE_ALREADY_EXISTS" ConflictExceptionReasonResourceDeletionNotAllowed ConflictExceptionReason = "RESOURCE_DELETION_NOT_ALLOWED" ConflictExceptionReasonResourceModificationNotAllowed ConflictExceptionReason = "RESOURCE_MODIFICATION_NOT_ALLOWED" ConflictExceptionReasonResourceNotActive ConflictExceptionReason = "RESOURCE_NOT_ACTIVE" ConflictExceptionReasonResourceNotEmpty ConflictExceptionReason = "RESOURCE_NOT_EMPTY" ConflictExceptionReasonSelfManagedOptOutsMismatch ConflictExceptionReason = "SELF_MANAGED_OPT_OUTS_MISMATCH" ConflictExceptionReasonSubmitRegistrationVersionNotAllowed ConflictExceptionReason = "SUBMIT_REGISTRATION_VERSION_NOT_ALLOWED" ConflictExceptionReasonTwoWayConfigMismatch ConflictExceptionReason = "TWO_WAY_CONFIG_MISMATCH" ConflictExceptionReasonVerificationCodeExpired ConflictExceptionReason = "VERIFICATION_CODE_EXPIRED" ConflictExceptionReasonVerificationAlreadyComplete ConflictExceptionReason = "VERIFICATION_ALREADY_COMPLETE" ConflictExceptionReasonProtectConfigurationIsAccountDefault ConflictExceptionReason = "PROTECT_CONFIGURATION_IS_ACCOUNT_DEFAULT" ConflictExceptionReasonProtectConfigurationAssociatedWithConfigurationSet ConflictExceptionReason = "PROTECT_CONFIGURATION_ASSOCIATED_WITH_CONFIGURATION_SET" ConflictExceptionReasonProtectConfigurationNotAssociatedWithConfigurationSet ConflictExceptionReason = "PROTECT_CONFIGURATION_NOT_ASSOCIATED_WITH_CONFIGURATION_SET" ConflictExceptionReasonDestinationCountryBlockedByProtectConfiguration ConflictExceptionReason = "DESTINATION_COUNTRY_BLOCKED_BY_PROTECT_CONFIGURATION" )
Enum values for ConflictExceptionReason
func (ConflictExceptionReason) Values ¶
func (ConflictExceptionReason) Values() []ConflictExceptionReason
Values returns all known values for ConflictExceptionReason. 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 DestinationCountryParameterKey ¶
type DestinationCountryParameterKey string
const ( DestinationCountryParameterKeyInTemplateId DestinationCountryParameterKey = "IN_TEMPLATE_ID" DestinationCountryParameterKeyInEntityId DestinationCountryParameterKey = "IN_ENTITY_ID" )
Enum values for DestinationCountryParameterKey
func (DestinationCountryParameterKey) Values ¶
func (DestinationCountryParameterKey) Values() []DestinationCountryParameterKey
Values returns all known values for DestinationCountryParameterKey. 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 EventDestination ¶
type EventDestination struct { // When set to true events will be logged. // // This member is required. Enabled *bool // The name of the EventDestination. // // This member is required. EventDestinationName *string // An array of event types that determine which events to log. // // The TEXT_SENT event type is not supported. // // This member is required. MatchingEventTypes []EventType // An object that contains information about an event destination that sends // logging events to Amazon CloudWatch logs. CloudWatchLogsDestination *CloudWatchLogsDestination // An object that contains information about an event destination for logging to // Amazon Kinesis Data Firehose. KinesisFirehoseDestination *KinesisFirehoseDestination // An object that contains information about an event destination that sends // logging events to Amazon SNS. SnsDestination *SnsDestination // contains filtered or unexported fields }
Contains information about an event destination.
Event destinations are associated with configuration sets, which enable you to publish message sending events to CloudWatch, Kinesis Data Firehose, or Amazon SNS.
type EventType ¶
type EventType string
const ( EventTypeAll EventType = "ALL" EventTypeTextAll EventType = "TEXT_ALL" EventTypeTextSent EventType = "TEXT_SENT" EventTypeTextPending EventType = "TEXT_PENDING" EventTypeTextQueued EventType = "TEXT_QUEUED" EventTypeTextSuccessful EventType = "TEXT_SUCCESSFUL" EventTypeTextDelivered EventType = "TEXT_DELIVERED" EventTypeTextInvalid EventType = "TEXT_INVALID" EventTypeTextInvalidMessage EventType = "TEXT_INVALID_MESSAGE" EventTypeTextUnreachable EventType = "TEXT_UNREACHABLE" EventTypeTextCarrierUnreachable EventType = "TEXT_CARRIER_UNREACHABLE" EventTypeTextBlocked EventType = "TEXT_BLOCKED" EventTypeTextCarrierBlocked EventType = "TEXT_CARRIER_BLOCKED" EventTypeTextSpam EventType = "TEXT_SPAM" EventTypeTextUnknown EventType = "TEXT_UNKNOWN" EventTypeTextTtlExpired EventType = "TEXT_TTL_EXPIRED" EventTypeVoiceAll EventType = "VOICE_ALL" EventTypeVoiceInitiated EventType = "VOICE_INITIATED" EventTypeVoiceRinging EventType = "VOICE_RINGING" EventTypeVoiceAnswered EventType = "VOICE_ANSWERED" EventTypeVoiceCompleted EventType = "VOICE_COMPLETED" EventTypeVoiceBusy EventType = "VOICE_BUSY" EventTypeVoiceNoAnswer EventType = "VOICE_NO_ANSWER" EventTypeVoiceFailed EventType = "VOICE_FAILED" EventTypeVoiceTtlExpired EventType = "VOICE_TTL_EXPIRED" EventTypeMediaAll EventType = "MEDIA_ALL" EventTypeMediaPending EventType = "MEDIA_PENDING" EventTypeMediaQueued EventType = "MEDIA_QUEUED" EventTypeMediaSuccessful EventType = "MEDIA_SUCCESSFUL" EventTypeMediaDelivered EventType = "MEDIA_DELIVERED" EventTypeMediaInvalid EventType = "MEDIA_INVALID" EventTypeMediaInvalidMessage EventType = "MEDIA_INVALID_MESSAGE" EventTypeMediaUnreachable EventType = "MEDIA_UNREACHABLE" EventTypeMediaCarrierUnreachable EventType = "MEDIA_CARRIER_UNREACHABLE" EventTypeMediaBlocked EventType = "MEDIA_BLOCKED" EventTypeMediaCarrierBlocked EventType = "MEDIA_CARRIER_BLOCKED" EventTypeMediaSpam EventType = "MEDIA_SPAM" EventTypeMediaUnknown EventType = "MEDIA_UNKNOWN" EventTypeMediaTtlExpired EventType = "MEDIA_TTL_EXPIRED" EventTypeMediaFileInaccessible EventType = "MEDIA_FILE_INACCESSIBLE" EventTypeMediaFileTypeUnsupported EventType = "MEDIA_FILE_TYPE_UNSUPPORTED" EventTypeMediaFileSizeExceeded EventType = "MEDIA_FILE_SIZE_EXCEEDED" )
Enum values for EventType
type FieldRequirement ¶
type FieldRequirement string
const ( FieldRequirementRequired FieldRequirement = "REQUIRED" FieldRequirementConditional FieldRequirement = "CONDITIONAL" FieldRequirementOptional FieldRequirement = "OPTIONAL" )
Enum values for FieldRequirement
func (FieldRequirement) Values ¶
func (FieldRequirement) Values() []FieldRequirement
Values returns all known values for FieldRequirement. 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 FieldType ¶
type FieldType string
type InternalServerException ¶
type InternalServerException struct { Message *string ErrorCodeOverride *string RequestId *string // contains filtered or unexported fields }
The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
func (*InternalServerException) Error ¶
func (e *InternalServerException) Error() string
func (*InternalServerException) ErrorCode ¶
func (e *InternalServerException) ErrorCode() string
func (*InternalServerException) ErrorFault ¶
func (e *InternalServerException) ErrorFault() smithy.ErrorFault
func (*InternalServerException) ErrorMessage ¶
func (e *InternalServerException) ErrorMessage() string
type KeywordAction ¶
type KeywordAction string
const ( KeywordActionAutomaticResponse KeywordAction = "AUTOMATIC_RESPONSE" KeywordActionOptOut KeywordAction = "OPT_OUT" KeywordActionOptIn KeywordAction = "OPT_IN" )
Enum values for KeywordAction
func (KeywordAction) Values ¶
func (KeywordAction) Values() []KeywordAction
Values returns all known values for KeywordAction. 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 KeywordFilter ¶
type KeywordFilter struct { // The name of the attribute to filter on. // // This member is required. Name KeywordFilterName // An array values to filter for. // // This member is required. Values []string // contains filtered or unexported fields }
The information for keywords that meet a specified criteria.
type KeywordFilterName ¶
type KeywordFilterName string
const (
KeywordFilterNameKeywordAction KeywordFilterName = "keyword-action"
)
Enum values for KeywordFilterName
func (KeywordFilterName) Values ¶
func (KeywordFilterName) Values() []KeywordFilterName
Values returns all known values for KeywordFilterName. 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 KeywordInformation ¶
type KeywordInformation struct { // The keyword as a string. // // This member is required. Keyword *string // The action to perform for the keyword. // // This member is required. KeywordAction KeywordAction // A custom message that can be used with the keyword. // // This member is required. KeywordMessage *string // contains filtered or unexported fields }
The information for all keywords in a pool.
type KinesisFirehoseDestination ¶
type KinesisFirehoseDestination struct { // The Amazon Resource Name (ARN) of the delivery stream. // // This member is required. DeliveryStreamArn *string // The ARN of an Identity and Access Management role that is able to write event // data to an Amazon Kinesis Data Firehose destination. // // This member is required. IamRoleArn *string // contains filtered or unexported fields }
Contains the delivery stream Amazon Resource Name (ARN), and the ARN of the Identity and Access Management (IAM) role associated with a Kinesis Data Firehose event destination.
Event destinations, such as Kinesis Data Firehose, are associated with configuration sets, which enable you to publish message sending events.
type LanguageCode ¶
type LanguageCode string
const ( LanguageCodeDeDe LanguageCode = "DE_DE" LanguageCodeEnGb LanguageCode = "EN_GB" LanguageCodeEnUs LanguageCode = "EN_US" LanguageCodeEs419 LanguageCode = "ES_419" LanguageCodeEsEs LanguageCode = "ES_ES" LanguageCodeFrCa LanguageCode = "FR_CA" LanguageCodeFrFr LanguageCode = "FR_FR" LanguageCodeItIt LanguageCode = "IT_IT" LanguageCodeJaJp LanguageCode = "JA_JP" LanguageCodeKoKr LanguageCode = "KO_KR" LanguageCodePtBr LanguageCode = "PT_BR" LanguageCodeZhCn LanguageCode = "ZH_CN" LanguageCodeZhTw LanguageCode = "ZH_TW" )
Enum values for LanguageCode
func (LanguageCode) Values ¶
func (LanguageCode) Values() []LanguageCode
Values returns all known values for LanguageCode. 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 MessageType ¶
type MessageType string
const ( MessageTypeTransactional MessageType = "TRANSACTIONAL" MessageTypePromotional MessageType = "PROMOTIONAL" )
Enum values for MessageType
func (MessageType) Values ¶
func (MessageType) Values() []MessageType
Values returns all known values for MessageType. 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 NumberCapability ¶
type NumberCapability string
const ( NumberCapabilitySms NumberCapability = "SMS" NumberCapabilityVoice NumberCapability = "VOICE" NumberCapabilityMms NumberCapability = "MMS" )
Enum values for NumberCapability
func (NumberCapability) Values ¶
func (NumberCapability) Values() []NumberCapability
Values returns all known values for NumberCapability. 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 NumberStatus ¶
type NumberStatus string
const ( NumberStatusPending NumberStatus = "PENDING" NumberStatusActive NumberStatus = "ACTIVE" NumberStatusAssociating NumberStatus = "ASSOCIATING" NumberStatusDisassociating NumberStatus = "DISASSOCIATING" NumberStatusDeleted NumberStatus = "DELETED" )
Enum values for NumberStatus
func (NumberStatus) Values ¶
func (NumberStatus) Values() []NumberStatus
Values returns all known values for NumberStatus. 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 NumberType ¶
type NumberType string
const ( NumberTypeShortCode NumberType = "SHORT_CODE" NumberTypeLongCode NumberType = "LONG_CODE" NumberTypeTollFree NumberType = "TOLL_FREE" NumberTypeTenDlc NumberType = "TEN_DLC" NumberTypeSimulator NumberType = "SIMULATOR" )
Enum values for NumberType
func (NumberType) Values ¶
func (NumberType) Values() []NumberType
Values returns all known values for NumberType. 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 OptOutListInformation ¶
type OptOutListInformation struct { // The time when the OutOutList was created, in [UNIX epoch time] format. // // [UNIX epoch time]: https://www.epochconverter.com/ // // This member is required. CreatedTimestamp *time.Time // The Amazon Resource Name (ARN) of the OptOutList. // // This member is required. OptOutListArn *string // The name of the OptOutList. // // This member is required. OptOutListName *string // contains filtered or unexported fields }
The information for all OptOutList in an Amazon Web Services account.
type OptedOutFilter ¶
type OptedOutFilter struct { // The name of the attribute to filter on. // // This member is required. Name OptedOutFilterName // An array of values to filter for. // // This member is required. Values []string // contains filtered or unexported fields }
The information for opted out numbers that meet a specified criteria.
type OptedOutFilterName ¶
type OptedOutFilterName string
const (
OptedOutFilterNameEndUserOptedOut OptedOutFilterName = "end-user-opted-out"
)
Enum values for OptedOutFilterName
func (OptedOutFilterName) Values ¶
func (OptedOutFilterName) Values() []OptedOutFilterName
Values returns all known values for OptedOutFilterName. 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 OptedOutNumberInformation ¶
type OptedOutNumberInformation struct { // This is set to true if it was the end recipient that opted out. // // This member is required. EndUserOptedOut bool // The phone number that is opted out. // // This member is required. OptedOutNumber *string // The time that the op tout occurred, in [UNIX epoch time] format. // // [UNIX epoch time]: https://www.epochconverter.com/ // // This member is required. OptedOutTimestamp *time.Time // contains filtered or unexported fields }
The information for an opted out number in an Amazon Web Services account.
type OriginationIdentityMetadata ¶
type OriginationIdentityMetadata struct { // The two-character code, in ISO 3166-1 alpha-2 format, for the country or // region. // // This member is required. IsoCountryCode *string // Describes if the origination identity can be used for text messages, voice // calls or both. // // This member is required. NumberCapabilities []NumberCapability // The unique identifier of the origination identity. // // This member is required. OriginationIdentity *string // The Amazon Resource Name (ARN) associated with the origination identity. // // This member is required. OriginationIdentityArn *string // The phone number in E.164 format. PhoneNumber *string // contains filtered or unexported fields }
The metadata for an origination identity associated with a pool.
type PhoneNumberFilter ¶
type PhoneNumberFilter struct { // The name of the attribute to filter on. // // This member is required. Name PhoneNumberFilterName // An array values to filter for. // // This member is required. Values []string // contains filtered or unexported fields }
The information for a phone number that meets a specified criteria.
type PhoneNumberFilterName ¶
type PhoneNumberFilterName string
const ( PhoneNumberFilterNameStatus PhoneNumberFilterName = "status" PhoneNumberFilterNameIsoCountryCode PhoneNumberFilterName = "iso-country-code" PhoneNumberFilterNameMessageType PhoneNumberFilterName = "message-type" PhoneNumberFilterNameNumberCapability PhoneNumberFilterName = "number-capability" PhoneNumberFilterNameNumberType PhoneNumberFilterName = "number-type" PhoneNumberFilterNameTwoWayEnabled PhoneNumberFilterName = "two-way-enabled" PhoneNumberFilterNameSelfManagedOptOutsEnabled PhoneNumberFilterName = "self-managed-opt-outs-enabled" PhoneNumberFilterNameOptOutListName PhoneNumberFilterName = "opt-out-list-name" PhoneNumberFilterNameDeletionProtectionEnabled PhoneNumberFilterName = "deletion-protection-enabled" PhoneNumberFilterNameTwoWayChannelArn PhoneNumberFilterName = "two-way-channel-arn" )
Enum values for PhoneNumberFilterName
func (PhoneNumberFilterName) Values ¶
func (PhoneNumberFilterName) Values() []PhoneNumberFilterName
Values returns all known values for PhoneNumberFilterName. 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 PhoneNumberInformation ¶
type PhoneNumberInformation struct { // The time when the phone number was created, in [UNIX epoch time] format. // // [UNIX epoch time]: https://www.epochconverter.com/ // // This member is required. CreatedTimestamp *time.Time // When set to true the phone number can't be deleted. // // This member is required. DeletionProtectionEnabled bool // The two-character code, in ISO 3166-1 alpha-2 format, for the country or // region. // // This member is required. IsoCountryCode *string // The type of message. Valid values are TRANSACTIONAL for messages that are // critical or time-sensitive and PROMOTIONAL for messages that aren't critical or // time-sensitive. // // This member is required. MessageType MessageType // The price, in US dollars, to lease the phone number. // // This member is required. MonthlyLeasingPrice *string // Describes if the origination identity can be used for text messages, voice // calls or both. // // This member is required. NumberCapabilities []NumberCapability // The type of phone number. // // This member is required. NumberType NumberType // The name of the OptOutList associated with the phone number. // // This member is required. OptOutListName *string // The phone number in E.164 format. // // This member is required. PhoneNumber *string // The Amazon Resource Name (ARN) associated with the phone number. // // This member is required. PhoneNumberArn *string // When set to false an end recipient sends a message that begins with HELP or // STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies // with a customizable message and adds the end recipient to the OptOutList. When // set to true you're responsible for responding to HELP and STOP requests. You're // also responsible for tracking and honoring opt-out request. For more information // see [Self-managed opt-outs] // // [Self-managed opt-outs]: https://docs.aws.amazon.com/pinpoint/latest/userguide/settings-sms-managing.html#settings-account-sms-self-managed-opt-out // // This member is required. SelfManagedOptOutsEnabled bool // The current status of the phone number. // // This member is required. Status NumberStatus // By default this is set to false. When set to true you can receive incoming text // messages from your end recipients using the TwoWayChannelArn. // // This member is required. TwoWayEnabled bool // The unique identifier for the phone number. PhoneNumberId *string // The unique identifier of the pool associated with the phone number. PoolId *string // The unique identifier for the registration. RegistrationId *string // The Amazon Resource Name (ARN) of the two way channel. TwoWayChannelArn *string // An optional IAM Role Arn for a service to assume, to be able to post inbound // SMS messages. TwoWayChannelRole *string // contains filtered or unexported fields }
The information for a phone number, in E.164 format, in an Amazon Web Services account.
type PoolFilter ¶
type PoolFilter struct { // The name of the attribute to filter on. // // This member is required. Name PoolFilterName // An array values to filter for. // // This member is required. Values []string // contains filtered or unexported fields }
The information for a pool that meets a specified criteria.
type PoolFilterName ¶
type PoolFilterName string
const ( PoolFilterNameStatus PoolFilterName = "status" PoolFilterNameMessageType PoolFilterName = "message-type" PoolFilterNameTwoWayEnabled PoolFilterName = "two-way-enabled" PoolFilterNameSelfManagedOptOutsEnabled PoolFilterName = "self-managed-opt-outs-enabled" PoolFilterNameOptOutListName PoolFilterName = "opt-out-list-name" PoolFilterNameDeletionProtectionEnabled PoolFilterName = "deletion-protection-enabled" PoolFilterNameTwoWayChannelArn PoolFilterName = "two-way-channel-arn" )
Enum values for PoolFilterName
func (PoolFilterName) Values ¶
func (PoolFilterName) Values() []PoolFilterName
Values returns all known values for PoolFilterName. 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 PoolInformation ¶
type PoolInformation struct { // The time when the pool was created, in [UNIX epoch time] format. // // [UNIX epoch time]: https://www.epochconverter.com/ // // This member is required. CreatedTimestamp *time.Time // When set to true the pool can't be deleted. // // This member is required. DeletionProtectionEnabled bool // The type of message. Valid values are TRANSACTIONAL for messages that are // critical or time-sensitive and PROMOTIONAL for messages that aren't critical or // time-sensitive. // // This member is required. MessageType MessageType // The name of the OptOutList associated with the pool. // // This member is required. OptOutListName *string // The Amazon Resource Name (ARN) for the pool. // // This member is required. PoolArn *string // The unique identifier for the pool. // // This member is required. PoolId *string // When set to false, an end recipient sends a message that begins with HELP or // STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies // with a customizable message and adds the end recipient to the OptOutList. When // set to true you're responsible for responding to HELP and STOP requests. You're // also responsible for tracking and honoring opt-out requests. For more // information see [Self-managed opt-outs] // // [Self-managed opt-outs]: https://docs.aws.amazon.com/pinpoint/latest/userguide/settings-sms-managing.html#settings-account-sms-self-managed-opt-out // // This member is required. SelfManagedOptOutsEnabled bool // // By default, this is set to False . If you set this value to True , your messages // are sent using phone numbers or sender IDs (depending on the country) that are // shared with other Amazon Pinpoint users. In some countries, such as the United // States, senders aren't allowed to use shared routes and must use a dedicated // phone number or short code. // // This member is required. SharedRoutesEnabled bool // The current status of the pool. // // This member is required. Status PoolStatus // When set to true you can receive incoming text messages from your end // recipients using the TwoWayChannelArn. // // This member is required. TwoWayEnabled bool // The Amazon Resource Name (ARN) of the two way channel. TwoWayChannelArn *string // An optional IAM Role Arn for a service to assume, to be able to post inbound // SMS messages. TwoWayChannelRole *string // contains filtered or unexported fields }
The information for a pool in an Amazon Web Services account.
type PoolOriginationIdentitiesFilter ¶
type PoolOriginationIdentitiesFilter struct { // The name of the attribute to filter on. // // This member is required. Name PoolOriginationIdentitiesFilterName // An array values to filter for. // // This member is required. Values []string // contains filtered or unexported fields }
Information about origination identities associated with a pool that meets a specified criteria.
type PoolOriginationIdentitiesFilterName ¶
type PoolOriginationIdentitiesFilterName string
const ( PoolOriginationIdentitiesFilterNameIsoCountryCode PoolOriginationIdentitiesFilterName = "iso-country-code" PoolOriginationIdentitiesFilterNameNumberCapability PoolOriginationIdentitiesFilterName = "number-capability" )
Enum values for PoolOriginationIdentitiesFilterName
func (PoolOriginationIdentitiesFilterName) Values ¶
func (PoolOriginationIdentitiesFilterName) Values() []PoolOriginationIdentitiesFilterName
Values returns all known values for PoolOriginationIdentitiesFilterName. 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 PoolStatus ¶
type PoolStatus string
const ( PoolStatusCreating PoolStatus = "CREATING" PoolStatusActive PoolStatus = "ACTIVE" PoolStatusDeleting PoolStatus = "DELETING" )
Enum values for PoolStatus
func (PoolStatus) Values ¶
func (PoolStatus) Values() []PoolStatus
Values returns all known values for PoolStatus. 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 ProtectConfigurationCountryRuleSetInformation ¶
type ProtectConfigurationCountryRuleSetInformation struct { // The types of protection that can be used. // // This member is required. ProtectStatus ProtectStatus // contains filtered or unexported fields }
The types of statuses that can be used.
type ProtectConfigurationFilter ¶
type ProtectConfigurationFilter struct { // The name of the attribute to filter on. // // This member is required. Name ProtectConfigurationFilterName // An array of values to filter for. // // This member is required. Values []string // contains filtered or unexported fields }
The filter definition for filtering protect configurations that meet a specified criteria.
type ProtectConfigurationFilterName ¶
type ProtectConfigurationFilterName string
const ( ProtectConfigurationFilterNameAccountDefault ProtectConfigurationFilterName = "account-default" ProtectConfigurationFilterNameDeletionProtectionEnabled ProtectConfigurationFilterName = "deletion-protection-enabled" )
Enum values for ProtectConfigurationFilterName
func (ProtectConfigurationFilterName) Values ¶
func (ProtectConfigurationFilterName) Values() []ProtectConfigurationFilterName
Values returns all known values for ProtectConfigurationFilterName. 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 ProtectConfigurationInformation ¶
type ProtectConfigurationInformation struct { // This is true if the protect configuration is set as your account default // protect configuration. // // This member is required. AccountDefault bool // The time when the protect configuration was created, in [UNIX epoch time] format. // // [UNIX epoch time]: https://www.epochconverter.com/ // // This member is required. CreatedTimestamp *time.Time // The status of deletion protection for the protect configuration. When set to // true deletion protection is enabled. By default this is set to false. // // This member is required. DeletionProtectionEnabled bool // The Amazon Resource Name (ARN) of the protect configuration. // // This member is required. ProtectConfigurationArn *string // The unique identifier for the protect configuration. // // This member is required. ProtectConfigurationId *string // contains filtered or unexported fields }
Provides information on the specified protect configuration.
type ProtectStatus ¶
type ProtectStatus string
const ( ProtectStatusAllow ProtectStatus = "ALLOW" ProtectStatusBlock ProtectStatus = "BLOCK" )
Enum values for ProtectStatus
func (ProtectStatus) Values ¶
func (ProtectStatus) Values() []ProtectStatus
Values returns all known values for ProtectStatus. 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 RegistrationAssociationBehavior ¶
type RegistrationAssociationBehavior string
const ( RegistrationAssociationBehaviorAssociateBeforeSubmit RegistrationAssociationBehavior = "ASSOCIATE_BEFORE_SUBMIT" RegistrationAssociationBehaviorAssociateOnApproval RegistrationAssociationBehavior = "ASSOCIATE_ON_APPROVAL" RegistrationAssociationBehaviorAssociateAfterComplete RegistrationAssociationBehavior = "ASSOCIATE_AFTER_COMPLETE" )
Enum values for RegistrationAssociationBehavior
func (RegistrationAssociationBehavior) Values ¶
func (RegistrationAssociationBehavior) Values() []RegistrationAssociationBehavior
Values returns all known values for RegistrationAssociationBehavior. 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 RegistrationAssociationFilter ¶
type RegistrationAssociationFilter struct { // The name of the attribute to filter on. // // This member is required. Name RegistrationAssociationFilterName // An array of values to filter for. // // This member is required. Values []string // contains filtered or unexported fields }
The filter definition for filtering registrations that meets a specified criteria.
type RegistrationAssociationFilterName ¶
type RegistrationAssociationFilterName string
const ( RegistrationAssociationFilterNameResourceType RegistrationAssociationFilterName = "resource-type" RegistrationAssociationFilterNameIsoCountryCode RegistrationAssociationFilterName = "iso-country-code" )
Enum values for RegistrationAssociationFilterName
func (RegistrationAssociationFilterName) Values ¶
func (RegistrationAssociationFilterName) Values() []RegistrationAssociationFilterName
Values returns all known values for RegistrationAssociationFilterName. 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 RegistrationAssociationMetadata ¶
type RegistrationAssociationMetadata struct { // The Amazon Resource Name (ARN) of the origination identity that is associated // with the registration. // // This member is required. ResourceArn *string // The unique identifier for the origination identity. For example this could be a // PhoneNumberId or SenderId. // // This member is required. ResourceId *string // The origination identity type. // // This member is required. ResourceType *string // The two-character code, in ISO 3166-1 alpha-2 format, for the country or region. IsoCountryCode *string // The phone number associated with the registration in E.164 format. PhoneNumber *string // contains filtered or unexported fields }
Metadata for the origination identity that is associated with the registration.
type RegistrationAttachmentFilter ¶
type RegistrationAttachmentFilter struct { // The name of the attribute to filter on. // // This member is required. Name RegistrationAttachmentFilterName // An array of values to filter on. // // This member is required. Values []string // contains filtered or unexported fields }
The filter definition for filtering registration attachments that meets a specified criteria.
type RegistrationAttachmentFilterName ¶
type RegistrationAttachmentFilterName string
const (
RegistrationAttachmentFilterNameAttachmentStatus RegistrationAttachmentFilterName = "attachment-status"
)
Enum values for RegistrationAttachmentFilterName
func (RegistrationAttachmentFilterName) Values ¶
func (RegistrationAttachmentFilterName) Values() []RegistrationAttachmentFilterName
Values returns all known values for RegistrationAttachmentFilterName. 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 RegistrationAttachmentsInformation ¶
type RegistrationAttachmentsInformation struct { // The status of the registration attachment. // // - UPLOAD_IN_PROGRESS The attachment is being uploaded. // // - UPLOAD_COMPLETE The attachment has been uploaded. // // - UPLOAD_FAILED The attachment failed to uploaded. // // - DELETED The attachment has been deleted.. // // This member is required. AttachmentStatus AttachmentStatus // The time when the registration attachment was created, in [UNIX epoch time] format. // // [UNIX epoch time]: https://www.epochconverter.com/ // // This member is required. CreatedTimestamp *time.Time // The Amazon Resource Name (ARN) for the registration attachment. // // This member is required. RegistrationAttachmentArn *string // The unique identifier for the registration attachment. // // This member is required. RegistrationAttachmentId *string // A description of why the upload didn't successfully complete. AttachmentUploadErrorReason AttachmentUploadErrorReason // contains filtered or unexported fields }
Provides information on the specified registration attachments.
type RegistrationDeniedReasonInformation ¶
type RegistrationDeniedReasonInformation struct { // The reason a registration was rejected. // // This member is required. Reason *string // A short description of the rejection reason. // // This member is required. ShortDescription *string // The link to the document. DocumentationLink *string // The title of the document. DocumentationTitle *string // A long description of the rejection reason. LongDescription *string // contains filtered or unexported fields }
Provides the reason a registration was rejected.
type RegistrationDisassociationBehavior ¶
type RegistrationDisassociationBehavior string
const ( RegistrationDisassociationBehaviorDisassociateAllClosesRegistration RegistrationDisassociationBehavior = "DISASSOCIATE_ALL_CLOSES_REGISTRATION" RegistrationDisassociationBehaviorDisassociateAllAllowsDeleteRegistration RegistrationDisassociationBehavior = "DISASSOCIATE_ALL_ALLOWS_DELETE_REGISTRATION" RegistrationDisassociationBehaviorDeleteRegistrationDisassociates RegistrationDisassociationBehavior = "DELETE_REGISTRATION_DISASSOCIATES" )
Enum values for RegistrationDisassociationBehavior
func (RegistrationDisassociationBehavior) Values ¶
func (RegistrationDisassociationBehavior) Values() []RegistrationDisassociationBehavior
Values returns all known values for RegistrationDisassociationBehavior. 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 RegistrationFieldDefinition ¶
type RegistrationFieldDefinition struct { // An array of RegistrationFieldDisplayHints objects for the field. // // This member is required. DisplayHints *RegistrationFieldDisplayHints // The path to the registration form field. You can use DescribeRegistrationFieldDefinitions for a list of FieldPaths. // // This member is required. FieldPath *string // Specifies if the field for the registration form is required, conditional or // optional. // // This member is required. FieldRequirement FieldRequirement // The type of field. // // This member is required. FieldType FieldType // The section path of the field. // // This member is required. SectionPath *string // The validation rules for a select field. SelectValidation *SelectValidation // The validation rules for a text field. TextValidation *TextValidation // contains filtered or unexported fields }
Provides a description of the specified field.
type RegistrationFieldDisplayHints ¶
type RegistrationFieldDisplayHints struct { // A short description of the display hint. // // This member is required. ShortDescription *string // The title of the display hint. // // This member is required. Title *string // The link to the document the display hint is associated with. DocumentationLink *string // The title of the document the display hint is associated with. DocumentationTitle *string // Example text of what the value of a field should contain. ExampleTextValue *string // A full description of the display hint. LongDescription *string // An array of SelectOptionDescription objects. SelectOptionDescriptions []SelectOptionDescription // The validation rules for the text field. TextValidationDescription *string // contains filtered or unexported fields }
Provides help information on the registration field.
type RegistrationFieldValueInformation ¶
type RegistrationFieldValueInformation struct { // The path to the registration form field. You can use DescribeRegistrationFieldDefinitions for a list of FieldPaths. // // This member is required. FieldPath *string // A description of why the registration was denied. DeniedReason *string // The unique identifier for the registration attachment. RegistrationAttachmentId *string // An array of values for the form field. SelectChoices []string // The text data for a free form field. TextValue *string // contains filtered or unexported fields }
Provides the values of the specified field.
type RegistrationFilter ¶
type RegistrationFilter struct { // The name of the attribute to filter on. // // This member is required. Name RegistrationFilterName // An array of values to filter on. // // This member is required. Values []string // contains filtered or unexported fields }
The filter definition for filtering registrations that meets a specified criteria.
type RegistrationFilterName ¶
type RegistrationFilterName string
const ( RegistrationFilterNameRegistrationType RegistrationFilterName = "registration-type" RegistrationFilterNameRegistrationStatus RegistrationFilterName = "registration-status" )
Enum values for RegistrationFilterName
func (RegistrationFilterName) Values ¶
func (RegistrationFilterName) Values() []RegistrationFilterName
Values returns all known values for RegistrationFilterName. 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 RegistrationInformation ¶
type RegistrationInformation struct { // The time when the registration was created, in [UNIX epoch time] format. // // [UNIX epoch time]: https://www.epochconverter.com/ // // This member is required. CreatedTimestamp *time.Time // The current version number of the registration. // // This member is required. CurrentVersionNumber *int64 // The Amazon Resource Name (ARN) for the registration. // // This member is required. RegistrationArn *string // The unique identifier for the registration. // // This member is required. RegistrationId *string // The status of the registration. // // - CREATED : Your registration is created but not submitted. // // - SUBMITTED : Your registration has been submitted and is awaiting review. // // - REVIEWING : Your registration has been accepted and is being reviewed. // // - PROVISIONING : Your registration has been approved and your origination // identity is being created. // // - COMPLETE : Your registration has been approved and and your origination // identity has been created. // // - REQUIRES_UPDATES : You must fix your registration and resubmit it. // // - CLOSED : The phone number or sender ID has been deleted and you must also // delete the registration for the number. // // - DELETED : The registration has been deleted. // // This member is required. RegistrationStatus RegistrationStatus // The type of registration form. The list of RegistrationTypes can be found using // the DescribeRegistrationTypeDefinitionsaction. // // This member is required. RegistrationType *string // Metadata about a given registration which is specific to that registration type. AdditionalAttributes map[string]string // The version number of the registration that was approved. ApprovedVersionNumber *int64 // The latest version number of the registration that was denied. LatestDeniedVersionNumber *int64 // contains filtered or unexported fields }
Provides information about the requested registration.
type RegistrationSectionDefinition ¶
type RegistrationSectionDefinition struct { // The path to the section of the registration. // // This member is required. DisplayHints *RegistrationSectionDisplayHints // The path to the section of the registration. // // This member is required. SectionPath *string // contains filtered or unexported fields }
Provides information on the specified section definition.
type RegistrationSectionDisplayHints ¶
type RegistrationSectionDisplayHints struct { // A short description of the display hint. // // This member is required. ShortDescription *string // The title of the display hint. // // This member is required. Title *string // The link to the document the display hint is associated with. DocumentationLink *string // The title of the document the display hint is associated with. DocumentationTitle *string // A full description of the display hint. LongDescription *string // contains filtered or unexported fields }
Provides help information on the registration section.
type RegistrationStatus ¶
type RegistrationStatus string
const ( RegistrationStatusCreated RegistrationStatus = "CREATED" RegistrationStatusSubmitted RegistrationStatus = "SUBMITTED" RegistrationStatusReviewing RegistrationStatus = "REVIEWING" RegistrationStatusProvisioning RegistrationStatus = "PROVISIONING" RegistrationStatusComplete RegistrationStatus = "COMPLETE" RegistrationStatusRequiresUpdates RegistrationStatus = "REQUIRES_UPDATES" RegistrationStatusClosed RegistrationStatus = "CLOSED" RegistrationStatusDeleted RegistrationStatus = "DELETED" )
Enum values for RegistrationStatus
func (RegistrationStatus) Values ¶
func (RegistrationStatus) Values() []RegistrationStatus
Values returns all known values for RegistrationStatus. 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 RegistrationTypeDefinition ¶
type RegistrationTypeDefinition struct { // Provides help information on the registration. // // This member is required. DisplayHints *RegistrationTypeDisplayHints // The type of registration form. The list of RegistrationTypes can be found using // the DescribeRegistrationTypeDefinitionsaction. // // This member is required. RegistrationType *string // The supported association behavior for the registration type. SupportedAssociations []SupportedAssociation // contains filtered or unexported fields }
Provides information on the supported registration type.
type RegistrationTypeDisplayHints ¶
type RegistrationTypeDisplayHints struct { // The title of the display hint. // // This member is required. Title *string // The link to the document the display hint is associated with. DocumentationLink *string // The title of the document the display hint is associated with. DocumentationTitle *string // A full description of the display hint. LongDescription *string // A short description of the display hint. ShortDescription *string // contains filtered or unexported fields }
Provides help information on the registration type.
type RegistrationTypeFilter ¶
type RegistrationTypeFilter struct { // The name of the attribute to filter on. // // This member is required. Name RegistrationTypeFilterName // An array of values to filter on. // // This member is required. Values []string // contains filtered or unexported fields }
The filter definition for filtering registration types that meets a specified criteria.
type RegistrationTypeFilterName ¶
type RegistrationTypeFilterName string
const ( RegistrationTypeFilterNameSupportedAssociationResourceType RegistrationTypeFilterName = "supported-association-resource-type" RegistrationTypeFilterNameSupportedAssociationIsoCountryCode RegistrationTypeFilterName = "supported-association-iso-country-code" )
Enum values for RegistrationTypeFilterName
func (RegistrationTypeFilterName) Values ¶
func (RegistrationTypeFilterName) Values() []RegistrationTypeFilterName
Values returns all known values for RegistrationTypeFilterName. 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 RegistrationVersionFilter ¶
type RegistrationVersionFilter struct { // The name of the attribute to filter on. // // This member is required. Name RegistrationVersionFilterName // An array of values to filter on. // // This member is required. Values []string // contains filtered or unexported fields }
The filter definition for filtering registration versions that meets a specified criteria.
type RegistrationVersionFilterName ¶
type RegistrationVersionFilterName string
const (
RegistrationVersionFilterNameRegistrationVersionStatus RegistrationVersionFilterName = "registration-version-status"
)
Enum values for RegistrationVersionFilterName
func (RegistrationVersionFilterName) Values ¶
func (RegistrationVersionFilterName) Values() []RegistrationVersionFilterName
Values returns all known values for RegistrationVersionFilterName. 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 RegistrationVersionInformation ¶
type RegistrationVersionInformation struct { // The status of the registration. // // - DRAFT : The initial status of a registration version after it’s created. // // - SUBMITTED : Your registration has been submitted. // // - REVIEWING : Your registration has been accepted and is being reviewed. // // - APPROVED : Your registration has been approved. // // - DISCARDED : You've abandon this version of their registration to start over // with a new version. // // - DENIED : You must fix your registration and resubmit it. // // - REVOKED : Your previously approved registration has been revoked. // // - ARCHIVED : Your previously approved registration version moves into this // status when a more recently submitted version is approved. // // This member is required. RegistrationVersionStatus RegistrationVersionStatus // The RegistrationVersionStatusHistory object contains the time stamps for when // the reservations status changes. // // This member is required. RegistrationVersionStatusHistory *RegistrationVersionStatusHistory // The version number of the registration. // // This member is required. VersionNumber *int64 // An array of RegistrationDeniedReasonInformation objects. DeniedReasons []RegistrationDeniedReasonInformation // contains filtered or unexported fields }
Provides information about the specified version of the registration.
type RegistrationVersionStatus ¶
type RegistrationVersionStatus string
const ( RegistrationVersionStatusDraft RegistrationVersionStatus = "DRAFT" RegistrationVersionStatusSubmitted RegistrationVersionStatus = "SUBMITTED" RegistrationVersionStatusReviewing RegistrationVersionStatus = "REVIEWING" RegistrationVersionStatusApproved RegistrationVersionStatus = "APPROVED" RegistrationVersionStatusDiscarded RegistrationVersionStatus = "DISCARDED" RegistrationVersionStatusDenied RegistrationVersionStatus = "DENIED" RegistrationVersionStatusRevoked RegistrationVersionStatus = "REVOKED" RegistrationVersionStatusArchived RegistrationVersionStatus = "ARCHIVED" )
Enum values for RegistrationVersionStatus
func (RegistrationVersionStatus) Values ¶
func (RegistrationVersionStatus) Values() []RegistrationVersionStatus
Values returns all known values for RegistrationVersionStatus. 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 RegistrationVersionStatusHistory ¶
type RegistrationVersionStatusHistory struct { // The time when the registration was in the draft state, in [UNIX epoch time] format. // // [UNIX epoch time]: https://www.epochconverter.com/ // // This member is required. DraftTimestamp *time.Time // The time when the registration was in the approved state, in [UNIX epoch time] format. // // [UNIX epoch time]: https://www.epochconverter.com/ ApprovedTimestamp *time.Time // The time when the registration was in the archived state, in [UNIX epoch time] format. // // [UNIX epoch time]: https://www.epochconverter.com/ ArchivedTimestamp *time.Time // The time when the registration was in the denied state, in [UNIX epoch time] format. // // [UNIX epoch time]: https://www.epochconverter.com/ DeniedTimestamp *time.Time // The time when the registration was in the discarded state, in [UNIX epoch time] format. // // [UNIX epoch time]: https://www.epochconverter.com/ DiscardedTimestamp *time.Time // The time when the registration was in the reviewing state, in [UNIX epoch time] format. // // [UNIX epoch time]: https://www.epochconverter.com/ ReviewingTimestamp *time.Time // The time when the registration was in the revoked state, in [UNIX epoch time] format. // // [UNIX epoch time]: https://www.epochconverter.com/ RevokedTimestamp *time.Time // The time when the registration was in the submitted state, in [UNIX epoch time] format. // // [UNIX epoch time]: https://www.epochconverter.com/ SubmittedTimestamp *time.Time // contains filtered or unexported fields }
The RegistrationVersionStatusHistory object contains the time stamps for when the reservations status changes.
type RequestableNumberType ¶
type RequestableNumberType string
const ( RequestableNumberTypeLongCode RequestableNumberType = "LONG_CODE" RequestableNumberTypeTollFree RequestableNumberType = "TOLL_FREE" RequestableNumberTypeTenDlc RequestableNumberType = "TEN_DLC" RequestableNumberTypeSimulator RequestableNumberType = "SIMULATOR" )
Enum values for RequestableNumberType
func (RequestableNumberType) Values ¶
func (RequestableNumberType) Values() []RequestableNumberType
Values returns all known values for RequestableNumberType. 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 ResourceNotFoundException ¶
type ResourceNotFoundException struct { Message *string ErrorCodeOverride *string ResourceType ResourceType ResourceId *string // contains filtered or unexported fields }
A requested resource couldn't be found.
func (*ResourceNotFoundException) Error ¶
func (e *ResourceNotFoundException) Error() string
func (*ResourceNotFoundException) ErrorCode ¶
func (e *ResourceNotFoundException) ErrorCode() string
func (*ResourceNotFoundException) ErrorFault ¶
func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault
func (*ResourceNotFoundException) ErrorMessage ¶
func (e *ResourceNotFoundException) ErrorMessage() string
type ResourceType ¶
type ResourceType string
const ( ResourceTypeAccount ResourceType = "account" ResourceTypePhoneNumber ResourceType = "phone-number" ResourceTypeSenderId ResourceType = "sender-id" ResourceTypePool ResourceType = "pool" ResourceTypeConfigurationSet ResourceType = "configuration-set" ResourceTypeOptOutList ResourceType = "opt-out-list" ResourceTypeEventDestination ResourceType = "event-destination" ResourceTypeKeyword ResourceType = "keyword" ResourceTypeOptedOutNumber ResourceType = "opted-out-number" ResourceTypeRegistration ResourceType = "registration" ResourceTypeRegistrationAttachment ResourceType = "registration-attachment" ResourceTypeVerifiedDestinationNumber ResourceType = "verified-destination-number" ResourceTypeProtectConfiguration ResourceType = "protect-configuration" )
Enum values for ResourceType
func (ResourceType) Values ¶
func (ResourceType) Values() []ResourceType
Values returns all known values for ResourceType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type SelectOptionDescription ¶
type SelectOptionDescription struct { // The value of the option. // // This member is required. Option *string // A description of the option meaning. Description *string // The title of the select option. Title *string // contains filtered or unexported fields }
A description of each select option.
type SelectValidation ¶
type SelectValidation struct { // The maximum number of choices for the select. // // This member is required. MaxChoices *int32 // The minimum number of choices for the select. // // This member is required. MinChoices *int32 // An array of strings for the possible selection options. // // This member is required. Options []string // contains filtered or unexported fields }
Validation rules for a select field.
type SenderIdAndCountry ¶
type SenderIdAndCountry struct { // The two-character code, in ISO 3166-1 alpha-2 format, for the country or // region. // // This member is required. IsoCountryCode *string // The unique identifier of the sender. // // This member is required. SenderId *string // contains filtered or unexported fields }
The alphanumeric sender ID in a specific country that you want to describe.
For more information on sender IDs see Requesting sender IDs for SMS messaging with Amazon Pinpointin the Amazon Pinpoint User Guide.
type SenderIdFilter ¶
type SenderIdFilter struct { // The name of the attribute to filter on. // // This member is required. Name SenderIdFilterName // An array of values to filter for. // // This member is required. Values []string // contains filtered or unexported fields }
The information for a sender ID that meets a specified criteria.
type SenderIdFilterName ¶
type SenderIdFilterName string
const ( SenderIdFilterNameSenderId SenderIdFilterName = "sender-id" SenderIdFilterNameIsoCountryCode SenderIdFilterName = "iso-country-code" SenderIdFilterNameMessageType SenderIdFilterName = "message-type" SenderIdFilterNameDeletionProtectionEnabled SenderIdFilterName = "deletion-protection-enabled" SenderIdFilterNameRegistered SenderIdFilterName = "registered" )
Enum values for SenderIdFilterName
func (SenderIdFilterName) Values ¶
func (SenderIdFilterName) Values() []SenderIdFilterName
Values returns all known values for SenderIdFilterName. 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 SenderIdInformation ¶
type SenderIdInformation struct { // By default this is set to false. When set to true the sender ID can't be // deleted. // // This member is required. DeletionProtectionEnabled bool // The two-character code, in ISO 3166-1 alpha-2 format, for the country or // region. // // This member is required. IsoCountryCode *string // The type of message. Valid values are TRANSACTIONAL for messages that are // critical or time-sensitive and PROMOTIONAL for messages that aren't critical or // time-sensitive. // // This member is required. MessageTypes []MessageType // The monthly leasing price, in US dollars. // // This member is required. MonthlyLeasingPrice *string // True if the sender ID is registered. // // This member is required. Registered bool // The alphanumeric sender ID in a specific country that you'd like to describe. // // This member is required. SenderId *string // The Amazon Resource Name (ARN) associated with the SenderId. // // This member is required. SenderIdArn *string // The unique identifier for the registration. RegistrationId *string // contains filtered or unexported fields }
The information for all SenderIds in an Amazon Web Services account.
type ServiceQuotaExceededException ¶
type ServiceQuotaExceededException struct { Message *string ErrorCodeOverride *string Reason ServiceQuotaExceededExceptionReason // contains filtered or unexported fields }
The request would cause a service quota to be exceeded.
func (*ServiceQuotaExceededException) Error ¶
func (e *ServiceQuotaExceededException) Error() string
func (*ServiceQuotaExceededException) ErrorCode ¶
func (e *ServiceQuotaExceededException) ErrorCode() string
func (*ServiceQuotaExceededException) ErrorFault ¶
func (e *ServiceQuotaExceededException) ErrorFault() smithy.ErrorFault
func (*ServiceQuotaExceededException) ErrorMessage ¶
func (e *ServiceQuotaExceededException) ErrorMessage() string
type ServiceQuotaExceededExceptionReason ¶
type ServiceQuotaExceededExceptionReason string
const ( ServiceQuotaExceededExceptionReasonAssociationsPerRegistration ServiceQuotaExceededExceptionReason = "ASSOCIATIONS_PER_REGISTRATION" ServiceQuotaExceededExceptionReasonConfigurationSetsPerAccount ServiceQuotaExceededExceptionReason = "CONFIGURATION_SETS_PER_ACCOUNT" ServiceQuotaExceededExceptionReasonDailyDestinationCallLimit ServiceQuotaExceededExceptionReason = "DAILY_DESTINATION_CALL_LIMIT" ServiceQuotaExceededExceptionReasonEventDestinationsPerConfigurationSet ServiceQuotaExceededExceptionReason = "EVENT_DESTINATIONS_PER_CONFIGURATION_SET" ServiceQuotaExceededExceptionReasonKeywordsPerPhoneNumber ServiceQuotaExceededExceptionReason = "KEYWORDS_PER_PHONE_NUMBER" ServiceQuotaExceededExceptionReasonKeywordsPerPool ServiceQuotaExceededExceptionReason = "KEYWORDS_PER_POOL" ServiceQuotaExceededExceptionReasonMonthlySpendLimitReachedForMedia ServiceQuotaExceededExceptionReason = "MONTHLY_SPEND_LIMIT_REACHED_FOR_MEDIA" ServiceQuotaExceededExceptionReasonMonthlySpendLimitReachedForText ServiceQuotaExceededExceptionReason = "MONTHLY_SPEND_LIMIT_REACHED_FOR_TEXT" ServiceQuotaExceededExceptionReasonMonthlySpendLimitReachedForVoice ServiceQuotaExceededExceptionReason = "MONTHLY_SPEND_LIMIT_REACHED_FOR_VOICE" ServiceQuotaExceededExceptionReasonOptOutListsPerAccount ServiceQuotaExceededExceptionReason = "OPT_OUT_LISTS_PER_ACCOUNT" ServiceQuotaExceededExceptionReasonOriginationIdentitiesPerPool ServiceQuotaExceededExceptionReason = "ORIGINATION_IDENTITIES_PER_POOL" ServiceQuotaExceededExceptionReasonPhoneNumbersPerAccount ServiceQuotaExceededExceptionReason = "PHONE_NUMBERS_PER_ACCOUNT" ServiceQuotaExceededExceptionReasonPhoneNumbersPerRegistration ServiceQuotaExceededExceptionReason = "PHONE_NUMBERS_PER_REGISTRATION" ServiceQuotaExceededExceptionReasonPoolsPerAccount ServiceQuotaExceededExceptionReason = "POOLS_PER_ACCOUNT" ServiceQuotaExceededExceptionReasonRegistrationAttachmentsCreatedPerDay ServiceQuotaExceededExceptionReason = "REGISTRATION_ATTACHMENTS_CREATED_PER_DAY" ServiceQuotaExceededExceptionReasonRegistrationAttachmentsPerAccount ServiceQuotaExceededExceptionReason = "REGISTRATION_ATTACHMENTS_PER_ACCOUNT" ServiceQuotaExceededExceptionReasonRegistrationVersionsCreatedPerDay ServiceQuotaExceededExceptionReason = "REGISTRATION_VERSIONS_CREATED_PER_DAY" ServiceQuotaExceededExceptionReasonRegistrationsPerAccount ServiceQuotaExceededExceptionReason = "REGISTRATIONS_PER_ACCOUNT" ServiceQuotaExceededExceptionReasonSenderIdsPerAccount ServiceQuotaExceededExceptionReason = "SENDER_IDS_PER_ACCOUNT" ServiceQuotaExceededExceptionReasonTagsPerResource ServiceQuotaExceededExceptionReason = "TAGS_PER_RESOURCE" ServiceQuotaExceededExceptionReasonVerifiedDestinationNumbersPerAccount ServiceQuotaExceededExceptionReason = "VERIFIED_DESTINATION_NUMBERS_PER_ACCOUNT" ServiceQuotaExceededExceptionReasonVerificationAttemptsPerDay ServiceQuotaExceededExceptionReason = "VERIFICATION_ATTEMPTS_PER_DAY" ServiceQuotaExceededExceptionReasonProtectConfigurationsPerAccount ServiceQuotaExceededExceptionReason = "PROTECT_CONFIGURATIONS_PER_ACCOUNT" )
Enum values for ServiceQuotaExceededExceptionReason
func (ServiceQuotaExceededExceptionReason) Values ¶
func (ServiceQuotaExceededExceptionReason) Values() []ServiceQuotaExceededExceptionReason
Values returns all known values for ServiceQuotaExceededExceptionReason. 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 SnsDestination ¶
type SnsDestination struct { // The Amazon Resource Name (ARN) of the Amazon SNS topic that you want to publish // events to. // // This member is required. TopicArn *string // contains filtered or unexported fields }
An object that defines an Amazon SNS destination for events. You can use Amazon SNS to send notification when certain events occur.
type SpendLimit ¶
type SpendLimit struct { // The maximum amount of money, in US dollars, that you want to be able to spend // sending messages each month. This value has to be less than or equal to the // amount in MaxLimit . To use this custom limit, Overridden must be set to true. // // This member is required. EnforcedLimit int64 // The maximum amount of money that you are able to spend to send messages each // month, in US dollars. // // This member is required. MaxLimit int64 // The name for the SpendLimit. // // This member is required. Name SpendLimitName // When set to True , the value that has been specified in the EnforcedLimit is // used to determine the maximum amount in US dollars that can be spent to send // messages each month, in US dollars. // // This member is required. Overridden bool // contains filtered or unexported fields }
Describes the current Amazon Pinpoint monthly spend limits for sending voice and text messages. For more information on increasing your monthly spend limit, see Requesting increases to your monthly SMS spending quota for Amazon Pinpointin the Amazon Pinpoint User Guide.
type SpendLimitName ¶
type SpendLimitName string
const ( SpendLimitNameTextMessageMonthlySpendLimit SpendLimitName = "TEXT_MESSAGE_MONTHLY_SPEND_LIMIT" SpendLimitNameVoiceMessageMonthlySpendLimit SpendLimitName = "VOICE_MESSAGE_MONTHLY_SPEND_LIMIT" SpendLimitNameMediaMessageMonthlySpendLimit SpendLimitName = "MEDIA_MESSAGE_MONTHLY_SPEND_LIMIT" )
Enum values for SpendLimitName
func (SpendLimitName) Values ¶
func (SpendLimitName) Values() []SpendLimitName
Values returns all known values for SpendLimitName. 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 SupportedAssociation ¶
type SupportedAssociation struct { // The association behavior. // // - ASSOCIATE_BEFORE_SUBMIT The origination identity has to be supplied when // creating a registration. // // - ASSOCIATE_ON_APPROVAL This applies to all short code registrations. The // short code will be automatically provisioned once the registration is approved. // // - ASSOCIATE_AFTER_COMPLETE This applies to phone number registrations when you // must complete a registration first, then associate one or more phone numbers // later. For example 10DLC campaigns and long codes. // // This member is required. AssociationBehavior RegistrationAssociationBehavior // The disassociation behavior. // // - DISASSOCIATE_ALL_CLOSES_REGISTRATION All origination identities must be // disassociated from the registration before the registration can be closed. // // - DISASSOCIATE_ALL_ALLOWS_DELETE_REGISTRATION All origination identities must // be disassociated from the registration before the registration can be deleted. // // - DELETE_REGISTRATION_DISASSOCIATES The registration can be deleted and all // origination identities will be disasscoiated. // // This member is required. DisassociationBehavior RegistrationDisassociationBehavior // Defines the behavior of when an origination identity and registration can be // associated with each other. // // This member is required. ResourceType *string // The two-character code, in ISO 3166-1 alpha-2 format, for the country or region. IsoCountryCode *string // contains filtered or unexported fields }
The processing rules for when a registration can be associated with an origination identity and disassociated from an origination identity.
type Tag ¶
type Tag struct { // The key identifier, or name, of the tag. // // This member is required. Key *string // The string value associated with the key of the tag. // // This member is required. Value *string // contains filtered or unexported fields }
The list of tags to be added to the specified topic.
type TextValidation ¶
type TextValidation struct { // The maximum number of characters for the text field. // // This member is required. MaxLength *int32 // The minimum number of characters for the text field. // // This member is required. MinLength *int32 // The regular expression used to validate the text field. // // This member is required. Pattern *string // contains filtered or unexported fields }
Validation rules for a text field.
type ThrottlingException ¶
type ThrottlingException struct { Message *string ErrorCodeOverride *string // contains filtered or unexported fields }
An error that occurred because too many requests were sent during a certain amount of time.
func (*ThrottlingException) Error ¶
func (e *ThrottlingException) Error() string
func (*ThrottlingException) ErrorCode ¶
func (e *ThrottlingException) ErrorCode() string
func (*ThrottlingException) ErrorFault ¶
func (e *ThrottlingException) ErrorFault() smithy.ErrorFault
func (*ThrottlingException) ErrorMessage ¶
func (e *ThrottlingException) ErrorMessage() string
type ValidationException ¶
type ValidationException struct { Message *string ErrorCodeOverride *string Reason ValidationExceptionReason Fields []ValidationExceptionField // contains filtered or unexported fields }
A validation exception for a field.
func (*ValidationException) Error ¶
func (e *ValidationException) Error() string
func (*ValidationException) ErrorCode ¶
func (e *ValidationException) ErrorCode() string
func (*ValidationException) ErrorFault ¶
func (e *ValidationException) ErrorFault() smithy.ErrorFault
func (*ValidationException) ErrorMessage ¶
func (e *ValidationException) ErrorMessage() string
type ValidationExceptionField ¶
type ValidationExceptionField struct { // The message associated with the validation exception with information to help // determine its cause. // // This member is required. Message *string // The name of the field. // // This member is required. Name *string // contains filtered or unexported fields }
The field associated with the validation exception.
type ValidationExceptionReason ¶
type ValidationExceptionReason string
const ( ValidationExceptionReasonCannotAddOptedOutNumber ValidationExceptionReason = "CANNOT_ADD_OPTED_OUT_NUMBER" ValidationExceptionReasonCannotParse ValidationExceptionReason = "CANNOT_PARSE" ValidationExceptionReasonCountryCodeMismatch ValidationExceptionReason = "COUNTRY_CODE_MISMATCH" ValidationExceptionReasonDestinationCountryBlocked ValidationExceptionReason = "DESTINATION_COUNTRY_BLOCKED" ValidationExceptionReasonFieldValidationFailed ValidationExceptionReason = "FIELD_VALIDATION_FAILED" ValidationExceptionReasonAttachmentTypeNotSupported ValidationExceptionReason = "ATTACHMENT_TYPE_NOT_SUPPORTED" ValidationExceptionReasonInvalidArn ValidationExceptionReason = "INVALID_ARN" ValidationExceptionReasonInvalidFilterValues ValidationExceptionReason = "INVALID_FILTER_VALUES" ValidationExceptionReasonInvalidIdentityForDestinationCountry ValidationExceptionReason = "INVALID_IDENTITY_FOR_DESTINATION_COUNTRY" ValidationExceptionReasonInvalidNextToken ValidationExceptionReason = "INVALID_NEXT_TOKEN" ValidationExceptionReasonInvalidParameter ValidationExceptionReason = "INVALID_PARAMETER" ValidationExceptionReasonInvalidRequest ValidationExceptionReason = "INVALID_REQUEST" ValidationExceptionReasonInvalidRegistrationAssociation ValidationExceptionReason = "INVALID_REGISTRATION_ASSOCIATION" ValidationExceptionReasonMaximumSizeExceeded ValidationExceptionReason = "MAXIMUM_SIZE_EXCEEDED" ValidationExceptionReasonMediaTypeNotSupported ValidationExceptionReason = "MEDIA_TYPE_NOT_SUPPORTED" ValidationExceptionReasonMissingParameter ValidationExceptionReason = "MISSING_PARAMETER" ValidationExceptionReasonParametersCannotBeUsedTogether ValidationExceptionReason = "PARAMETERS_CANNOT_BE_USED_TOGETHER" ValidationExceptionReasonPhoneNumberCannotBeOptedIn ValidationExceptionReason = "PHONE_NUMBER_CANNOT_BE_OPTED_IN" ValidationExceptionReasonPhoneNumberCannotBeReleased ValidationExceptionReason = "PHONE_NUMBER_CANNOT_BE_RELEASED" ValidationExceptionReasonPriceOverThreshold ValidationExceptionReason = "PRICE_OVER_THRESHOLD" ValidationExceptionReasonResourceNotAccessible ValidationExceptionReason = "RESOURCE_NOT_ACCESSIBLE" ValidationExceptionReasonRequestedSpendLimitHigherThanServiceLimit ValidationExceptionReason = "REQUESTED_SPEND_LIMIT_HIGHER_THAN_SERVICE_LIMIT" ValidationExceptionReasonSenderIdNotRegistered ValidationExceptionReason = "SENDER_ID_NOT_REGISTERED" ValidationExceptionReasonSenderIdNotSupported ValidationExceptionReason = "SENDER_ID_NOT_SUPPORTED" ValidationExceptionReasonSenderIdRequiresRegistration ValidationExceptionReason = "SENDER_ID_REQUIRES_REGISTRATION" ValidationExceptionReasonTwoWayTopicNotPresent ValidationExceptionReason = "TWO_WAY_TOPIC_NOT_PRESENT" ValidationExceptionReasonTwoWayNotEnabled ValidationExceptionReason = "TWO_WAY_NOT_ENABLED" ValidationExceptionReasonTwoWayNotSupportedInCountry ValidationExceptionReason = "TWO_WAY_NOT_SUPPORTED_IN_COUNTRY" ValidationExceptionReasonTwoWayNotSupportedInRegion ValidationExceptionReason = "TWO_WAY_NOT_SUPPORTED_IN_REGION" ValidationExceptionReasonTwoWayChannelNotPresent ValidationExceptionReason = "TWO_WAY_CHANNEL_NOT_PRESENT" ValidationExceptionReasonUnknownRegistrationField ValidationExceptionReason = "UNKNOWN_REGISTRATION_FIELD" ValidationExceptionReasonUnknownRegistrationSection ValidationExceptionReason = "UNKNOWN_REGISTRATION_SECTION" ValidationExceptionReasonUnknownRegistrationType ValidationExceptionReason = "UNKNOWN_REGISTRATION_TYPE" ValidationExceptionReasonUnknownRegistrationVersion ValidationExceptionReason = "UNKNOWN_REGISTRATION_VERSION" ValidationExceptionReasonUnknownOperation ValidationExceptionReason = "UNKNOWN_OPERATION" ValidationExceptionReasonRegistrationFieldCannotBeDeleted ValidationExceptionReason = "REGISTRATION_FIELD_CANNOT_BE_DELETED" ValidationExceptionReasonVerificationCodeMismatch ValidationExceptionReason = "VERIFICATION_CODE_MISMATCH" ValidationExceptionReasonVoiceCapabilityNotAvailable ValidationExceptionReason = "VOICE_CAPABILITY_NOT_AVAILABLE" ValidationExceptionReasonOther ValidationExceptionReason = "OTHER" )
Enum values for ValidationExceptionReason
func (ValidationExceptionReason) Values ¶
func (ValidationExceptionReason) Values() []ValidationExceptionReason
Values returns all known values for ValidationExceptionReason. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type VerificationChannel ¶
type VerificationChannel string
const ( VerificationChannelText VerificationChannel = "TEXT" VerificationChannelVoice VerificationChannel = "VOICE" )
Enum values for VerificationChannel
func (VerificationChannel) Values ¶
func (VerificationChannel) Values() []VerificationChannel
Values returns all known values for VerificationChannel. 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 VerificationStatus ¶
type VerificationStatus string
const ( VerificationStatusPending VerificationStatus = "PENDING" VerificationStatusVerified VerificationStatus = "VERIFIED" )
Enum values for VerificationStatus
func (VerificationStatus) Values ¶
func (VerificationStatus) Values() []VerificationStatus
Values returns all known values for VerificationStatus. 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 VerifiedDestinationNumberFilter ¶
type VerifiedDestinationNumberFilter struct { // The name of the attribute to filter on. // // This member is required. Name VerifiedDestinationNumberFilterName // An array of values to filter on. // // This member is required. Values []string // contains filtered or unexported fields }
The filter definition for filtering verified destination phone numbers that meets a specified criteria.
type VerifiedDestinationNumberFilterName ¶
type VerifiedDestinationNumberFilterName string
const (
VerifiedDestinationNumberFilterNameStatus VerifiedDestinationNumberFilterName = "status"
)
Enum values for VerifiedDestinationNumberFilterName
func (VerifiedDestinationNumberFilterName) Values ¶
func (VerifiedDestinationNumberFilterName) Values() []VerifiedDestinationNumberFilterName
Values returns all known values for VerifiedDestinationNumberFilterName. 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 VerifiedDestinationNumberInformation ¶
type VerifiedDestinationNumberInformation struct { // The time when the destination phone number was created, in [UNIX epoch time] format. // // [UNIX epoch time]: https://www.epochconverter.com/ // // This member is required. CreatedTimestamp *time.Time // The verified destination phone number, in E.164 format. // // This member is required. DestinationPhoneNumber *string // The status of the verified destination phone number. // // - PENDING : The phone number hasn't been verified yet. // // - VERIFIED : The phone number is verified and can receive messages. // // This member is required. Status VerificationStatus // The Amazon Resource Name (ARN) for the verified destination phone number. // // This member is required. VerifiedDestinationNumberArn *string // The unique identifier for the verified destination phone number. // // This member is required. VerifiedDestinationNumberId *string // contains filtered or unexported fields }
Provides information about the requested verified destintion phone number.
type VoiceId ¶
type VoiceId string
const ( VoiceIdAmy VoiceId = "AMY" VoiceIdAstrid VoiceId = "ASTRID" VoiceIdBianca VoiceId = "BIANCA" VoiceIdBrian VoiceId = "BRIAN" VoiceIdCamila VoiceId = "CAMILA" VoiceIdCarla VoiceId = "CARLA" VoiceIdCarmen VoiceId = "CARMEN" VoiceIdCeline VoiceId = "CELINE" VoiceIdChantal VoiceId = "CHANTAL" VoiceIdConchita VoiceId = "CONCHITA" VoiceIdCristiano VoiceId = "CRISTIANO" VoiceIdDora VoiceId = "DORA" VoiceIdEmma VoiceId = "EMMA" VoiceIdEnrique VoiceId = "ENRIQUE" VoiceIdEwa VoiceId = "EWA" VoiceIdFiliz VoiceId = "FILIZ" VoiceIdGeraint VoiceId = "GERAINT" VoiceIdGiorgio VoiceId = "GIORGIO" VoiceIdGwyneth VoiceId = "GWYNETH" VoiceIdHans VoiceId = "HANS" VoiceIdInes VoiceId = "INES" VoiceIdIvy VoiceId = "IVY" VoiceIdJacek VoiceId = "JACEK" VoiceIdJan VoiceId = "JAN" VoiceIdJoanna VoiceId = "JOANNA" VoiceIdJoey VoiceId = "JOEY" VoiceIdJustin VoiceId = "JUSTIN" VoiceIdKarl VoiceId = "KARL" VoiceIdKendra VoiceId = "KENDRA" VoiceIdKimberly VoiceId = "KIMBERLY" VoiceIdLea VoiceId = "LEA" VoiceIdLiv VoiceId = "LIV" VoiceIdLotte VoiceId = "LOTTE" VoiceIdLucia VoiceId = "LUCIA" VoiceIdLupe VoiceId = "LUPE" VoiceIdMads VoiceId = "MADS" VoiceIdMaja VoiceId = "MAJA" VoiceIdMarlene VoiceId = "MARLENE" VoiceIdMathieu VoiceId = "MATHIEU" VoiceIdMatthew VoiceId = "MATTHEW" VoiceIdMaxim VoiceId = "MAXIM" VoiceIdMia VoiceId = "MIA" VoiceIdMiguel VoiceId = "MIGUEL" VoiceIdMizuki VoiceId = "MIZUKI" VoiceIdNaja VoiceId = "NAJA" VoiceIdNicole VoiceId = "NICOLE" VoiceIdPenelope VoiceId = "PENELOPE" VoiceIdRaveena VoiceId = "RAVEENA" VoiceIdRicardo VoiceId = "RICARDO" VoiceIdRuben VoiceId = "RUBEN" VoiceIdRussell VoiceId = "RUSSELL" VoiceIdSalli VoiceId = "SALLI" VoiceIdSeoyeon VoiceId = "SEOYEON" VoiceIdTakumi VoiceId = "TAKUMI" VoiceIdTatyana VoiceId = "TATYANA" VoiceIdVicki VoiceId = "VICKI" VoiceIdVitoria VoiceId = "VITORIA" VoiceIdZeina VoiceId = "ZEINA" VoiceIdZhiyu VoiceId = "ZHIYU" )
Enum values for VoiceId
type VoiceMessageBodyTextType ¶
type VoiceMessageBodyTextType string
const ( VoiceMessageBodyTextTypeText VoiceMessageBodyTextType = "TEXT" VoiceMessageBodyTextTypeSsml VoiceMessageBodyTextType = "SSML" )
Enum values for VoiceMessageBodyTextType
func (VoiceMessageBodyTextType) Values ¶
func (VoiceMessageBodyTextType) Values() []VoiceMessageBodyTextType
Values returns all known values for VoiceMessageBodyTextType. 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.