pinpointsmsvoicev2

package
v1.42.9 Latest Latest
Warning

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

Go to latest
Published: Aug 3, 2023 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Overview

Package pinpointsmsvoicev2 provides the client and types for making API requests to Amazon Pinpoint SMS Voice V2.

Welcome to the Amazon Pinpoint SMS and Voice, version 2 API Reference. This guide provides information about Amazon Pinpoint SMS and Voice, version 2 API resources, including supported HTTP methods, parameters, and schemas.

Amazon Pinpoint is an Amazon Web Services service that you can use to engage with your recipients across multiple messaging channels. The Amazon Pinpoint SMS and Voice, version 2 API provides programmatic access to options that are unique to the SMS and voice channels and supplements the resources provided by the Amazon Pinpoint API.

If you're new to Amazon Pinpoint, it's also helpful to review the Amazon Pinpoint Developer Guide (https://docs.aws.amazon.com/pinpoint/latest/developerguide/welcome.html). The Amazon Pinpoint Developer Guide provides tutorials, code samples, and procedures that demonstrate how to use Amazon Pinpoint features programmatically and how to integrate Amazon Pinpoint functionality into mobile apps and other types of applications. The guide also provides key information, such as Amazon Pinpoint integration with other Amazon Web Services services, and the quotas that apply to use of the service.

See https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31 for more information on this service.

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

Using the Client

To contact Amazon Pinpoint SMS Voice V2 with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the Amazon Pinpoint SMS Voice V2 client PinpointSMSVoiceV2 for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/pinpointsmsvoicev2/#New

Index

Constants

View Source
const (
	// AccessDeniedExceptionReasonInsufficientAccountReputation is a AccessDeniedExceptionReason enum value
	AccessDeniedExceptionReasonInsufficientAccountReputation = "INSUFFICIENT_ACCOUNT_REPUTATION"

	// AccessDeniedExceptionReasonAccountDisabled is a AccessDeniedExceptionReason enum value
	AccessDeniedExceptionReasonAccountDisabled = "ACCOUNT_DISABLED"
)
View Source
const (
	// AccountLimitNamePhoneNumbers is a AccountLimitName enum value
	AccountLimitNamePhoneNumbers = "PHONE_NUMBERS"

	// AccountLimitNamePools is a AccountLimitName enum value
	AccountLimitNamePools = "POOLS"

	// AccountLimitNameConfigurationSets is a AccountLimitName enum value
	AccountLimitNameConfigurationSets = "CONFIGURATION_SETS"

	// AccountLimitNameOptOutLists is a AccountLimitName enum value
	AccountLimitNameOptOutLists = "OPT_OUT_LISTS"
)
View Source
const (
	// ConfigurationSetFilterNameEventDestinationName is a ConfigurationSetFilterName enum value
	ConfigurationSetFilterNameEventDestinationName = "event-destination-name"

	// ConfigurationSetFilterNameMatchingEventTypes is a ConfigurationSetFilterName enum value
	ConfigurationSetFilterNameMatchingEventTypes = "matching-event-types"

	// ConfigurationSetFilterNameDefaultMessageType is a ConfigurationSetFilterName enum value
	ConfigurationSetFilterNameDefaultMessageType = "default-message-type"

	// ConfigurationSetFilterNameDefaultSenderId is a ConfigurationSetFilterName enum value
	ConfigurationSetFilterNameDefaultSenderId = "default-sender-id"
)
View Source
const (
	// ConflictExceptionReasonDeletionProtectionEnabled is a ConflictExceptionReason enum value
	ConflictExceptionReasonDeletionProtectionEnabled = "DELETION_PROTECTION_ENABLED"

	// ConflictExceptionReasonDestinationPhoneNumberNotVerified is a ConflictExceptionReason enum value
	ConflictExceptionReasonDestinationPhoneNumberNotVerified = "DESTINATION_PHONE_NUMBER_NOT_VERIFIED"

	// ConflictExceptionReasonDestinationPhoneNumberOptedOut is a ConflictExceptionReason enum value
	ConflictExceptionReasonDestinationPhoneNumberOptedOut = "DESTINATION_PHONE_NUMBER_OPTED_OUT"

	// ConflictExceptionReasonEventDestinationMismatch is a ConflictExceptionReason enum value
	ConflictExceptionReasonEventDestinationMismatch = "EVENT_DESTINATION_MISMATCH"

	// ConflictExceptionReasonKeywordMismatch is a ConflictExceptionReason enum value
	ConflictExceptionReasonKeywordMismatch = "KEYWORD_MISMATCH"

	// ConflictExceptionReasonLastPhoneNumber is a ConflictExceptionReason enum value
	ConflictExceptionReasonLastPhoneNumber = "LAST_PHONE_NUMBER"

	// ConflictExceptionReasonSelfManagedOptOutsMismatch is a ConflictExceptionReason enum value
	ConflictExceptionReasonSelfManagedOptOutsMismatch = "SELF_MANAGED_OPT_OUTS_MISMATCH"

	// ConflictExceptionReasonMessageTypeMismatch is a ConflictExceptionReason enum value
	ConflictExceptionReasonMessageTypeMismatch = "MESSAGE_TYPE_MISMATCH"

	// ConflictExceptionReasonNoOriginationIdentitiesFound is a ConflictExceptionReason enum value
	ConflictExceptionReasonNoOriginationIdentitiesFound = "NO_ORIGINATION_IDENTITIES_FOUND"

	// ConflictExceptionReasonOptOutListMismatch is a ConflictExceptionReason enum value
	ConflictExceptionReasonOptOutListMismatch = "OPT_OUT_LIST_MISMATCH"

	// ConflictExceptionReasonPhoneNumberAssociatedToPool is a ConflictExceptionReason enum value
	ConflictExceptionReasonPhoneNumberAssociatedToPool = "PHONE_NUMBER_ASSOCIATED_TO_POOL"

	// ConflictExceptionReasonPhoneNumberNotAssociatedToPool is a ConflictExceptionReason enum value
	ConflictExceptionReasonPhoneNumberNotAssociatedToPool = "PHONE_NUMBER_NOT_ASSOCIATED_TO_POOL"

	// ConflictExceptionReasonPhoneNumberNotInRegistrationRegion is a ConflictExceptionReason enum value
	ConflictExceptionReasonPhoneNumberNotInRegistrationRegion = "PHONE_NUMBER_NOT_IN_REGISTRATION_REGION"

	// ConflictExceptionReasonResourceAlreadyExists is a ConflictExceptionReason enum value
	ConflictExceptionReasonResourceAlreadyExists = "RESOURCE_ALREADY_EXISTS"

	// ConflictExceptionReasonResourceDeletionNotAllowed is a ConflictExceptionReason enum value
	ConflictExceptionReasonResourceDeletionNotAllowed = "RESOURCE_DELETION_NOT_ALLOWED"

	// ConflictExceptionReasonResourceModificationNotAllowed is a ConflictExceptionReason enum value
	ConflictExceptionReasonResourceModificationNotAllowed = "RESOURCE_MODIFICATION_NOT_ALLOWED"

	// ConflictExceptionReasonResourceNotActive is a ConflictExceptionReason enum value
	ConflictExceptionReasonResourceNotActive = "RESOURCE_NOT_ACTIVE"

	// ConflictExceptionReasonResourceNotEmpty is a ConflictExceptionReason enum value
	ConflictExceptionReasonResourceNotEmpty = "RESOURCE_NOT_EMPTY"

	// ConflictExceptionReasonTwoWayConfigMismatch is a ConflictExceptionReason enum value
	ConflictExceptionReasonTwoWayConfigMismatch = "TWO_WAY_CONFIG_MISMATCH"
)
View Source
const (
	// DestinationCountryParameterKeyInTemplateId is a DestinationCountryParameterKey enum value
	DestinationCountryParameterKeyInTemplateId = "IN_TEMPLATE_ID"

	// DestinationCountryParameterKeyInEntityId is a DestinationCountryParameterKey enum value
	DestinationCountryParameterKeyInEntityId = "IN_ENTITY_ID"
)
View Source
const (
	// EventTypeAll is a EventType enum value
	EventTypeAll = "ALL"

	// EventTypeTextAll is a EventType enum value
	EventTypeTextAll = "TEXT_ALL"

	// EventTypeTextSent is a EventType enum value
	EventTypeTextSent = "TEXT_SENT"

	// EventTypeTextPending is a EventType enum value
	EventTypeTextPending = "TEXT_PENDING"

	// EventTypeTextQueued is a EventType enum value
	EventTypeTextQueued = "TEXT_QUEUED"

	// EventTypeTextSuccessful is a EventType enum value
	EventTypeTextSuccessful = "TEXT_SUCCESSFUL"

	// EventTypeTextDelivered is a EventType enum value
	EventTypeTextDelivered = "TEXT_DELIVERED"

	// EventTypeTextInvalid is a EventType enum value
	EventTypeTextInvalid = "TEXT_INVALID"

	// EventTypeTextInvalidMessage is a EventType enum value
	EventTypeTextInvalidMessage = "TEXT_INVALID_MESSAGE"

	// EventTypeTextUnreachable is a EventType enum value
	EventTypeTextUnreachable = "TEXT_UNREACHABLE"

	// EventTypeTextCarrierUnreachable is a EventType enum value
	EventTypeTextCarrierUnreachable = "TEXT_CARRIER_UNREACHABLE"

	// EventTypeTextBlocked is a EventType enum value
	EventTypeTextBlocked = "TEXT_BLOCKED"

	// EventTypeTextCarrierBlocked is a EventType enum value
	EventTypeTextCarrierBlocked = "TEXT_CARRIER_BLOCKED"

	// EventTypeTextSpam is a EventType enum value
	EventTypeTextSpam = "TEXT_SPAM"

	// EventTypeTextUnknown is a EventType enum value
	EventTypeTextUnknown = "TEXT_UNKNOWN"

	// EventTypeTextTtlExpired is a EventType enum value
	EventTypeTextTtlExpired = "TEXT_TTL_EXPIRED"

	// EventTypeVoiceAll is a EventType enum value
	EventTypeVoiceAll = "VOICE_ALL"

	// EventTypeVoiceInitiated is a EventType enum value
	EventTypeVoiceInitiated = "VOICE_INITIATED"

	// EventTypeVoiceRinging is a EventType enum value
	EventTypeVoiceRinging = "VOICE_RINGING"

	// EventTypeVoiceAnswered is a EventType enum value
	EventTypeVoiceAnswered = "VOICE_ANSWERED"

	// EventTypeVoiceCompleted is a EventType enum value
	EventTypeVoiceCompleted = "VOICE_COMPLETED"

	// EventTypeVoiceBusy is a EventType enum value
	EventTypeVoiceBusy = "VOICE_BUSY"

	// EventTypeVoiceNoAnswer is a EventType enum value
	EventTypeVoiceNoAnswer = "VOICE_NO_ANSWER"

	// EventTypeVoiceFailed is a EventType enum value
	EventTypeVoiceFailed = "VOICE_FAILED"

	// EventTypeVoiceTtlExpired is a EventType enum value
	EventTypeVoiceTtlExpired = "VOICE_TTL_EXPIRED"
)
View Source
const (
	// KeywordActionAutomaticResponse is a KeywordAction enum value
	KeywordActionAutomaticResponse = "AUTOMATIC_RESPONSE"

	// KeywordActionOptOut is a KeywordAction enum value
	KeywordActionOptOut = "OPT_OUT"

	// KeywordActionOptIn is a KeywordAction enum value
	KeywordActionOptIn = "OPT_IN"
)
View Source
const (
	// MessageTypeTransactional is a MessageType enum value
	MessageTypeTransactional = "TRANSACTIONAL"

	// MessageTypePromotional is a MessageType enum value
	MessageTypePromotional = "PROMOTIONAL"
)
View Source
const (
	// NumberCapabilitySms is a NumberCapability enum value
	NumberCapabilitySms = "SMS"

	// NumberCapabilityVoice is a NumberCapability enum value
	NumberCapabilityVoice = "VOICE"
)
View Source
const (
	// NumberStatusPending is a NumberStatus enum value
	NumberStatusPending = "PENDING"

	// NumberStatusActive is a NumberStatus enum value
	NumberStatusActive = "ACTIVE"

	// NumberStatusAssociating is a NumberStatus enum value
	NumberStatusAssociating = "ASSOCIATING"

	// NumberStatusDisassociating is a NumberStatus enum value
	NumberStatusDisassociating = "DISASSOCIATING"

	// NumberStatusDeleted is a NumberStatus enum value
	NumberStatusDeleted = "DELETED"
)
View Source
const (
	// NumberTypeShortCode is a NumberType enum value
	NumberTypeShortCode = "SHORT_CODE"

	// NumberTypeLongCode is a NumberType enum value
	NumberTypeLongCode = "LONG_CODE"

	// NumberTypeTollFree is a NumberType enum value
	NumberTypeTollFree = "TOLL_FREE"

	// NumberTypeTenDlc is a NumberType enum value
	NumberTypeTenDlc = "TEN_DLC"
)
View Source
const (
	// PhoneNumberFilterNameStatus is a PhoneNumberFilterName enum value
	PhoneNumberFilterNameStatus = "status"

	// PhoneNumberFilterNameIsoCountryCode is a PhoneNumberFilterName enum value
	PhoneNumberFilterNameIsoCountryCode = "iso-country-code"

	// PhoneNumberFilterNameMessageType is a PhoneNumberFilterName enum value
	PhoneNumberFilterNameMessageType = "message-type"

	// PhoneNumberFilterNameNumberCapability is a PhoneNumberFilterName enum value
	PhoneNumberFilterNameNumberCapability = "number-capability"

	// PhoneNumberFilterNameNumberType is a PhoneNumberFilterName enum value
	PhoneNumberFilterNameNumberType = "number-type"

	// PhoneNumberFilterNameTwoWayEnabled is a PhoneNumberFilterName enum value
	PhoneNumberFilterNameTwoWayEnabled = "two-way-enabled"

	// PhoneNumberFilterNameSelfManagedOptOutsEnabled is a PhoneNumberFilterName enum value
	PhoneNumberFilterNameSelfManagedOptOutsEnabled = "self-managed-opt-outs-enabled"

	// PhoneNumberFilterNameOptOutListName is a PhoneNumberFilterName enum value
	PhoneNumberFilterNameOptOutListName = "opt-out-list-name"

	// PhoneNumberFilterNameDeletionProtectionEnabled is a PhoneNumberFilterName enum value
	PhoneNumberFilterNameDeletionProtectionEnabled = "deletion-protection-enabled"
)
View Source
const (
	// PoolFilterNameStatus is a PoolFilterName enum value
	PoolFilterNameStatus = "status"

	// PoolFilterNameMessageType is a PoolFilterName enum value
	PoolFilterNameMessageType = "message-type"

	// PoolFilterNameTwoWayEnabled is a PoolFilterName enum value
	PoolFilterNameTwoWayEnabled = "two-way-enabled"

	// PoolFilterNameSelfManagedOptOutsEnabled is a PoolFilterName enum value
	PoolFilterNameSelfManagedOptOutsEnabled = "self-managed-opt-outs-enabled"

	// PoolFilterNameOptOutListName is a PoolFilterName enum value
	PoolFilterNameOptOutListName = "opt-out-list-name"

	// PoolFilterNameSharedRoutesEnabled is a PoolFilterName enum value
	PoolFilterNameSharedRoutesEnabled = "shared-routes-enabled"

	// PoolFilterNameDeletionProtectionEnabled is a PoolFilterName enum value
	PoolFilterNameDeletionProtectionEnabled = "deletion-protection-enabled"
)
View Source
const (
	// PoolOriginationIdentitiesFilterNameIsoCountryCode is a PoolOriginationIdentitiesFilterName enum value
	PoolOriginationIdentitiesFilterNameIsoCountryCode = "iso-country-code"

	// PoolOriginationIdentitiesFilterNameNumberCapability is a PoolOriginationIdentitiesFilterName enum value
	PoolOriginationIdentitiesFilterNameNumberCapability = "number-capability"
)
View Source
const (
	// PoolStatusCreating is a PoolStatus enum value
	PoolStatusCreating = "CREATING"

	// PoolStatusActive is a PoolStatus enum value
	PoolStatusActive = "ACTIVE"

	// PoolStatusDeleting is a PoolStatus enum value
	PoolStatusDeleting = "DELETING"
)
View Source
const (
	// RequestableNumberTypeLongCode is a RequestableNumberType enum value
	RequestableNumberTypeLongCode = "LONG_CODE"

	// RequestableNumberTypeTollFree is a RequestableNumberType enum value
	RequestableNumberTypeTollFree = "TOLL_FREE"

	// RequestableNumberTypeTenDlc is a RequestableNumberType enum value
	RequestableNumberTypeTenDlc = "TEN_DLC"
)
View Source
const (
	// ResourceTypeAccount is a ResourceType enum value
	ResourceTypeAccount = "account"

	// ResourceTypePhoneNumber is a ResourceType enum value
	ResourceTypePhoneNumber = "phone-number"

	// ResourceTypeSenderId is a ResourceType enum value
	ResourceTypeSenderId = "sender-id"

	// ResourceTypePool is a ResourceType enum value
	ResourceTypePool = "pool"

	// ResourceTypeConfigurationSet is a ResourceType enum value
	ResourceTypeConfigurationSet = "configuration-set"

	// ResourceTypeOptOutList is a ResourceType enum value
	ResourceTypeOptOutList = "opt-out-list"

	// ResourceTypeEventDestination is a ResourceType enum value
	ResourceTypeEventDestination = "event-destination"

	// ResourceTypeKeyword is a ResourceType enum value
	ResourceTypeKeyword = "keyword"

	// ResourceTypeOptedOutNumber is a ResourceType enum value
	ResourceTypeOptedOutNumber = "opted-out-number"

	// ResourceTypeRegistration is a ResourceType enum value
	ResourceTypeRegistration = "registration"
)
View Source
const (
	// SenderIdFilterNameSenderId is a SenderIdFilterName enum value
	SenderIdFilterNameSenderId = "sender-id"

	// SenderIdFilterNameIsoCountryCode is a SenderIdFilterName enum value
	SenderIdFilterNameIsoCountryCode = "iso-country-code"

	// SenderIdFilterNameMessageType is a SenderIdFilterName enum value
	SenderIdFilterNameMessageType = "message-type"
)
View Source
const (
	// ServiceQuotaExceededExceptionReasonConfigurationSetsPerAccount is a ServiceQuotaExceededExceptionReason enum value
	ServiceQuotaExceededExceptionReasonConfigurationSetsPerAccount = "CONFIGURATION_SETS_PER_ACCOUNT"

	// ServiceQuotaExceededExceptionReasonDailyDestinationCallLimit is a ServiceQuotaExceededExceptionReason enum value
	ServiceQuotaExceededExceptionReasonDailyDestinationCallLimit = "DAILY_DESTINATION_CALL_LIMIT"

	// ServiceQuotaExceededExceptionReasonEventDestinationsPerConfigurationSet is a ServiceQuotaExceededExceptionReason enum value
	ServiceQuotaExceededExceptionReasonEventDestinationsPerConfigurationSet = "EVENT_DESTINATIONS_PER_CONFIGURATION_SET"

	// ServiceQuotaExceededExceptionReasonKeywordsPerPhoneNumber is a ServiceQuotaExceededExceptionReason enum value
	ServiceQuotaExceededExceptionReasonKeywordsPerPhoneNumber = "KEYWORDS_PER_PHONE_NUMBER"

	// ServiceQuotaExceededExceptionReasonKeywordsPerPool is a ServiceQuotaExceededExceptionReason enum value
	ServiceQuotaExceededExceptionReasonKeywordsPerPool = "KEYWORDS_PER_POOL"

	// ServiceQuotaExceededExceptionReasonMonthlySpendLimitReachedForText is a ServiceQuotaExceededExceptionReason enum value
	ServiceQuotaExceededExceptionReasonMonthlySpendLimitReachedForText = "MONTHLY_SPEND_LIMIT_REACHED_FOR_TEXT"

	// ServiceQuotaExceededExceptionReasonMonthlySpendLimitReachedForVoice is a ServiceQuotaExceededExceptionReason enum value
	ServiceQuotaExceededExceptionReasonMonthlySpendLimitReachedForVoice = "MONTHLY_SPEND_LIMIT_REACHED_FOR_VOICE"

	// ServiceQuotaExceededExceptionReasonOptOutListsPerAccount is a ServiceQuotaExceededExceptionReason enum value
	ServiceQuotaExceededExceptionReasonOptOutListsPerAccount = "OPT_OUT_LISTS_PER_ACCOUNT"

	// ServiceQuotaExceededExceptionReasonOriginationIdentitiesPerPool is a ServiceQuotaExceededExceptionReason enum value
	ServiceQuotaExceededExceptionReasonOriginationIdentitiesPerPool = "ORIGINATION_IDENTITIES_PER_POOL"

	// ServiceQuotaExceededExceptionReasonPhoneNumbersPerAccount is a ServiceQuotaExceededExceptionReason enum value
	ServiceQuotaExceededExceptionReasonPhoneNumbersPerAccount = "PHONE_NUMBERS_PER_ACCOUNT"

	// ServiceQuotaExceededExceptionReasonPhoneNumbersPerRegistration is a ServiceQuotaExceededExceptionReason enum value
	ServiceQuotaExceededExceptionReasonPhoneNumbersPerRegistration = "PHONE_NUMBERS_PER_REGISTRATION"

	// ServiceQuotaExceededExceptionReasonPoolsPerAccount is a ServiceQuotaExceededExceptionReason enum value
	ServiceQuotaExceededExceptionReasonPoolsPerAccount = "POOLS_PER_ACCOUNT"

	// ServiceQuotaExceededExceptionReasonTagsPerResource is a ServiceQuotaExceededExceptionReason enum value
	ServiceQuotaExceededExceptionReasonTagsPerResource = "TAGS_PER_RESOURCE"
)
View Source
const (
	// SpendLimitNameTextMessageMonthlySpendLimit is a SpendLimitName enum value
	SpendLimitNameTextMessageMonthlySpendLimit = "TEXT_MESSAGE_MONTHLY_SPEND_LIMIT"

	// SpendLimitNameVoiceMessageMonthlySpendLimit is a SpendLimitName enum value
	SpendLimitNameVoiceMessageMonthlySpendLimit = "VOICE_MESSAGE_MONTHLY_SPEND_LIMIT"
)
View Source
const (
	// ValidationExceptionReasonUnknownOperation is a ValidationExceptionReason enum value
	ValidationExceptionReasonUnknownOperation = "UNKNOWN_OPERATION"

	// ValidationExceptionReasonCannotParse is a ValidationExceptionReason enum value
	ValidationExceptionReasonCannotParse = "CANNOT_PARSE"

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

	// ValidationExceptionReasonOther is a ValidationExceptionReason enum value
	ValidationExceptionReasonOther = "OTHER"

	// ValidationExceptionReasonInvalidParameter is a ValidationExceptionReason enum value
	ValidationExceptionReasonInvalidParameter = "INVALID_PARAMETER"

	// ValidationExceptionReasonInvalidArn is a ValidationExceptionReason enum value
	ValidationExceptionReasonInvalidArn = "INVALID_ARN"

	// ValidationExceptionReasonInvalidIdentityForDestinationCountry is a ValidationExceptionReason enum value
	ValidationExceptionReasonInvalidIdentityForDestinationCountry = "INVALID_IDENTITY_FOR_DESTINATION_COUNTRY"

	// ValidationExceptionReasonDestinationCountryBlocked is a ValidationExceptionReason enum value
	ValidationExceptionReasonDestinationCountryBlocked = "DESTINATION_COUNTRY_BLOCKED"

	// ValidationExceptionReasonCannotAddOptedOutNumber is a ValidationExceptionReason enum value
	ValidationExceptionReasonCannotAddOptedOutNumber = "CANNOT_ADD_OPTED_OUT_NUMBER"

	// ValidationExceptionReasonCountryCodeMismatch is a ValidationExceptionReason enum value
	ValidationExceptionReasonCountryCodeMismatch = "COUNTRY_CODE_MISMATCH"

	// ValidationExceptionReasonInvalidFilterValues is a ValidationExceptionReason enum value
	ValidationExceptionReasonInvalidFilterValues = "INVALID_FILTER_VALUES"

	// ValidationExceptionReasonInvalidNextToken is a ValidationExceptionReason enum value
	ValidationExceptionReasonInvalidNextToken = "INVALID_NEXT_TOKEN"

	// ValidationExceptionReasonMissingParameter is a ValidationExceptionReason enum value
	ValidationExceptionReasonMissingParameter = "MISSING_PARAMETER"

	// ValidationExceptionReasonParametersCannotBeUsedTogether is a ValidationExceptionReason enum value
	ValidationExceptionReasonParametersCannotBeUsedTogether = "PARAMETERS_CANNOT_BE_USED_TOGETHER"

	// ValidationExceptionReasonPhoneNumberCannotBeOptedIn is a ValidationExceptionReason enum value
	ValidationExceptionReasonPhoneNumberCannotBeOptedIn = "PHONE_NUMBER_CANNOT_BE_OPTED_IN"

	// ValidationExceptionReasonPhoneNumberCannotBeReleased is a ValidationExceptionReason enum value
	ValidationExceptionReasonPhoneNumberCannotBeReleased = "PHONE_NUMBER_CANNOT_BE_RELEASED"

	// ValidationExceptionReasonPriceOverThreshold is a ValidationExceptionReason enum value
	ValidationExceptionReasonPriceOverThreshold = "PRICE_OVER_THRESHOLD"

	// ValidationExceptionReasonRequestedSpendLimitHigherThanServiceLimit is a ValidationExceptionReason enum value
	ValidationExceptionReasonRequestedSpendLimitHigherThanServiceLimit = "REQUESTED_SPEND_LIMIT_HIGHER_THAN_SERVICE_LIMIT"

	// ValidationExceptionReasonSenderIdNotRegistered is a ValidationExceptionReason enum value
	ValidationExceptionReasonSenderIdNotRegistered = "SENDER_ID_NOT_REGISTERED"

	// ValidationExceptionReasonSenderIdNotSupported is a ValidationExceptionReason enum value
	ValidationExceptionReasonSenderIdNotSupported = "SENDER_ID_NOT_SUPPORTED"

	// ValidationExceptionReasonTwoWayNotEnabled is a ValidationExceptionReason enum value
	ValidationExceptionReasonTwoWayNotEnabled = "TWO_WAY_NOT_ENABLED"

	// ValidationExceptionReasonTwoWayNotSupportedInCountry is a ValidationExceptionReason enum value
	ValidationExceptionReasonTwoWayNotSupportedInCountry = "TWO_WAY_NOT_SUPPORTED_IN_COUNTRY"

	// ValidationExceptionReasonTwoWayNotSupportedInRegion is a ValidationExceptionReason enum value
	ValidationExceptionReasonTwoWayNotSupportedInRegion = "TWO_WAY_NOT_SUPPORTED_IN_REGION"

	// ValidationExceptionReasonTwoWayTopicNotPresent is a ValidationExceptionReason enum value
	ValidationExceptionReasonTwoWayTopicNotPresent = "TWO_WAY_TOPIC_NOT_PRESENT"
)
View Source
const (
	// VoiceIdAmy is a VoiceId enum value
	VoiceIdAmy = "AMY"

	// VoiceIdAstrid is a VoiceId enum value
	VoiceIdAstrid = "ASTRID"

	// VoiceIdBianca is a VoiceId enum value
	VoiceIdBianca = "BIANCA"

	// VoiceIdBrian is a VoiceId enum value
	VoiceIdBrian = "BRIAN"

	// VoiceIdCamila is a VoiceId enum value
	VoiceIdCamila = "CAMILA"

	// VoiceIdCarla is a VoiceId enum value
	VoiceIdCarla = "CARLA"

	// VoiceIdCarmen is a VoiceId enum value
	VoiceIdCarmen = "CARMEN"

	// VoiceIdCeline is a VoiceId enum value
	VoiceIdCeline = "CELINE"

	// VoiceIdChantal is a VoiceId enum value
	VoiceIdChantal = "CHANTAL"

	// VoiceIdConchita is a VoiceId enum value
	VoiceIdConchita = "CONCHITA"

	// VoiceIdCristiano is a VoiceId enum value
	VoiceIdCristiano = "CRISTIANO"

	// VoiceIdDora is a VoiceId enum value
	VoiceIdDora = "DORA"

	// VoiceIdEmma is a VoiceId enum value
	VoiceIdEmma = "EMMA"

	// VoiceIdEnrique is a VoiceId enum value
	VoiceIdEnrique = "ENRIQUE"

	// VoiceIdEwa is a VoiceId enum value
	VoiceIdEwa = "EWA"

	// VoiceIdFiliz is a VoiceId enum value
	VoiceIdFiliz = "FILIZ"

	// VoiceIdGeraint is a VoiceId enum value
	VoiceIdGeraint = "GERAINT"

	// VoiceIdGiorgio is a VoiceId enum value
	VoiceIdGiorgio = "GIORGIO"

	// VoiceIdGwyneth is a VoiceId enum value
	VoiceIdGwyneth = "GWYNETH"

	// VoiceIdHans is a VoiceId enum value
	VoiceIdHans = "HANS"

	// VoiceIdInes is a VoiceId enum value
	VoiceIdInes = "INES"

	// VoiceIdIvy is a VoiceId enum value
	VoiceIdIvy = "IVY"

	// VoiceIdJacek is a VoiceId enum value
	VoiceIdJacek = "JACEK"

	// VoiceIdJan is a VoiceId enum value
	VoiceIdJan = "JAN"

	// VoiceIdJoanna is a VoiceId enum value
	VoiceIdJoanna = "JOANNA"

	// VoiceIdJoey is a VoiceId enum value
	VoiceIdJoey = "JOEY"

	// VoiceIdJustin is a VoiceId enum value
	VoiceIdJustin = "JUSTIN"

	// VoiceIdKarl is a VoiceId enum value
	VoiceIdKarl = "KARL"

	// VoiceIdKendra is a VoiceId enum value
	VoiceIdKendra = "KENDRA"

	// VoiceIdKimberly is a VoiceId enum value
	VoiceIdKimberly = "KIMBERLY"

	// VoiceIdLea is a VoiceId enum value
	VoiceIdLea = "LEA"

	// VoiceIdLiv is a VoiceId enum value
	VoiceIdLiv = "LIV"

	// VoiceIdLotte is a VoiceId enum value
	VoiceIdLotte = "LOTTE"

	// VoiceIdLucia is a VoiceId enum value
	VoiceIdLucia = "LUCIA"

	// VoiceIdLupe is a VoiceId enum value
	VoiceIdLupe = "LUPE"

	// VoiceIdMads is a VoiceId enum value
	VoiceIdMads = "MADS"

	// VoiceIdMaja is a VoiceId enum value
	VoiceIdMaja = "MAJA"

	// VoiceIdMarlene is a VoiceId enum value
	VoiceIdMarlene = "MARLENE"

	// VoiceIdMathieu is a VoiceId enum value
	VoiceIdMathieu = "MATHIEU"

	// VoiceIdMatthew is a VoiceId enum value
	VoiceIdMatthew = "MATTHEW"

	// VoiceIdMaxim is a VoiceId enum value
	VoiceIdMaxim = "MAXIM"

	// VoiceIdMia is a VoiceId enum value
	VoiceIdMia = "MIA"

	// VoiceIdMiguel is a VoiceId enum value
	VoiceIdMiguel = "MIGUEL"

	// VoiceIdMizuki is a VoiceId enum value
	VoiceIdMizuki = "MIZUKI"

	// VoiceIdNaja is a VoiceId enum value
	VoiceIdNaja = "NAJA"

	// VoiceIdNicole is a VoiceId enum value
	VoiceIdNicole = "NICOLE"

	// VoiceIdPenelope is a VoiceId enum value
	VoiceIdPenelope = "PENELOPE"

	// VoiceIdRaveena is a VoiceId enum value
	VoiceIdRaveena = "RAVEENA"

	// VoiceIdRicardo is a VoiceId enum value
	VoiceIdRicardo = "RICARDO"

	// VoiceIdRuben is a VoiceId enum value
	VoiceIdRuben = "RUBEN"

	// VoiceIdRussell is a VoiceId enum value
	VoiceIdRussell = "RUSSELL"

	// VoiceIdSalli is a VoiceId enum value
	VoiceIdSalli = "SALLI"

	// VoiceIdSeoyeon is a VoiceId enum value
	VoiceIdSeoyeon = "SEOYEON"

	// VoiceIdTakumi is a VoiceId enum value
	VoiceIdTakumi = "TAKUMI"

	// VoiceIdTatyana is a VoiceId enum value
	VoiceIdTatyana = "TATYANA"

	// VoiceIdVicki is a VoiceId enum value
	VoiceIdVicki = "VICKI"

	// VoiceIdVitoria is a VoiceId enum value
	VoiceIdVitoria = "VITORIA"

	// VoiceIdZeina is a VoiceId enum value
	VoiceIdZeina = "ZEINA"

	// VoiceIdZhiyu is a VoiceId enum value
	VoiceIdZhiyu = "ZHIYU"
)
View Source
const (
	// VoiceMessageBodyTextTypeText is a VoiceMessageBodyTextType enum value
	VoiceMessageBodyTextTypeText = "TEXT"

	// VoiceMessageBodyTextTypeSsml is a VoiceMessageBodyTextType enum value
	VoiceMessageBodyTextTypeSsml = "SSML"
)
View Source
const (

	// ErrCodeAccessDeniedException for service response error code
	// "AccessDeniedException".
	//
	// The request was denied because you don't have sufficient permissions to access
	// the resource.
	ErrCodeAccessDeniedException = "AccessDeniedException"

	// ErrCodeConflictException for service response error code
	// "ConflictException".
	//
	// 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.
	ErrCodeConflictException = "ConflictException"

	// ErrCodeInternalServerException for service response error code
	// "InternalServerException".
	//
	// 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.
	ErrCodeInternalServerException = "InternalServerException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// A requested resource couldn't be found.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// ErrCodeServiceQuotaExceededException for service response error code
	// "ServiceQuotaExceededException".
	//
	// The request would cause a service quota to be exceeded.
	ErrCodeServiceQuotaExceededException = "ServiceQuotaExceededException"

	// ErrCodeThrottlingException for service response error code
	// "ThrottlingException".
	//
	// An error that occurred because too many requests were sent during a certain
	// amount of time.
	ErrCodeThrottlingException = "ThrottlingException"

	// ErrCodeValidationException for service response error code
	// "ValidationException".
	//
	// A validation exception for a field.
	ErrCodeValidationException = "ValidationException"
)
View Source
const (
	ServiceName = "Pinpoint SMS Voice V2" // Name of service.
	EndpointsID = "sms-voice"             // ID to lookup a service endpoint with.
	ServiceID   = "Pinpoint SMS Voice V2" // ServiceID is a unique identifier of a specific service.
)

Service information constants

View Source
const (
	// AccountAttributeNameAccountTier is a AccountAttributeName enum value
	AccountAttributeNameAccountTier = "ACCOUNT_TIER"
)
View Source
const (
	// KeywordFilterNameKeywordAction is a KeywordFilterName enum value
	KeywordFilterNameKeywordAction = "keyword-action"
)
View Source
const (
	// OptedOutFilterNameEndUserOptedOut is a OptedOutFilterName enum value
	OptedOutFilterNameEndUserOptedOut = "end-user-opted-out"
)

Variables

This section is empty.

Functions

func AccessDeniedExceptionReason_Values

func AccessDeniedExceptionReason_Values() []string

AccessDeniedExceptionReason_Values returns all elements of the AccessDeniedExceptionReason enum

func AccountAttributeName_Values

func AccountAttributeName_Values() []string

AccountAttributeName_Values returns all elements of the AccountAttributeName enum

func AccountLimitName_Values

func AccountLimitName_Values() []string

AccountLimitName_Values returns all elements of the AccountLimitName enum

func ConfigurationSetFilterName_Values

func ConfigurationSetFilterName_Values() []string

ConfigurationSetFilterName_Values returns all elements of the ConfigurationSetFilterName enum

func ConflictExceptionReason_Values

func ConflictExceptionReason_Values() []string

ConflictExceptionReason_Values returns all elements of the ConflictExceptionReason enum

func DestinationCountryParameterKey_Values

func DestinationCountryParameterKey_Values() []string

DestinationCountryParameterKey_Values returns all elements of the DestinationCountryParameterKey enum

func EventType_Values

func EventType_Values() []string

EventType_Values returns all elements of the EventType enum

func KeywordAction_Values

func KeywordAction_Values() []string

KeywordAction_Values returns all elements of the KeywordAction enum

func KeywordFilterName_Values

func KeywordFilterName_Values() []string

KeywordFilterName_Values returns all elements of the KeywordFilterName enum

func MessageType_Values

func MessageType_Values() []string

MessageType_Values returns all elements of the MessageType enum

func NumberCapability_Values

func NumberCapability_Values() []string

NumberCapability_Values returns all elements of the NumberCapability enum

func NumberStatus_Values

func NumberStatus_Values() []string

NumberStatus_Values returns all elements of the NumberStatus enum

func NumberType_Values

func NumberType_Values() []string

NumberType_Values returns all elements of the NumberType enum

func OptedOutFilterName_Values

func OptedOutFilterName_Values() []string

OptedOutFilterName_Values returns all elements of the OptedOutFilterName enum

func PhoneNumberFilterName_Values

func PhoneNumberFilterName_Values() []string

PhoneNumberFilterName_Values returns all elements of the PhoneNumberFilterName enum

func PoolFilterName_Values

func PoolFilterName_Values() []string

PoolFilterName_Values returns all elements of the PoolFilterName enum

func PoolOriginationIdentitiesFilterName_Values

func PoolOriginationIdentitiesFilterName_Values() []string

PoolOriginationIdentitiesFilterName_Values returns all elements of the PoolOriginationIdentitiesFilterName enum

func PoolStatus_Values

func PoolStatus_Values() []string

PoolStatus_Values returns all elements of the PoolStatus enum

func RequestableNumberType_Values

func RequestableNumberType_Values() []string

RequestableNumberType_Values returns all elements of the RequestableNumberType enum

func ResourceType_Values

func ResourceType_Values() []string

ResourceType_Values returns all elements of the ResourceType enum

func SenderIdFilterName_Values

func SenderIdFilterName_Values() []string

SenderIdFilterName_Values returns all elements of the SenderIdFilterName enum

func ServiceQuotaExceededExceptionReason_Values

func ServiceQuotaExceededExceptionReason_Values() []string

ServiceQuotaExceededExceptionReason_Values returns all elements of the ServiceQuotaExceededExceptionReason enum

func SpendLimitName_Values

func SpendLimitName_Values() []string

SpendLimitName_Values returns all elements of the SpendLimitName enum

func ValidationExceptionReason_Values

func ValidationExceptionReason_Values() []string

ValidationExceptionReason_Values returns all elements of the ValidationExceptionReason enum

func VoiceId_Values

func VoiceId_Values() []string

VoiceId_Values returns all elements of the VoiceId enum

func VoiceMessageBodyTextType_Values

func VoiceMessageBodyTextType_Values() []string

VoiceMessageBodyTextType_Values returns all elements of the VoiceMessageBodyTextType enum

Types

type AccessDeniedException

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

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

	// The reason for the exception.
	Reason *string `type:"string" enum:"AccessDeniedExceptionReason"`
	// contains filtered or unexported fields
}

The request was denied because you don't have sufficient permissions to access the resource.

func (*AccessDeniedException) Code

func (s *AccessDeniedException) Code() string

Code returns the exception type name.

func (*AccessDeniedException) Error

func (s *AccessDeniedException) Error() string

func (AccessDeniedException) GoString

func (s AccessDeniedException) GoString() string

GoString returns the string representation.

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

func (*AccessDeniedException) Message

func (s *AccessDeniedException) Message() string

Message returns the exception's message.

func (*AccessDeniedException) OrigErr

func (s *AccessDeniedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*AccessDeniedException) RequestID

func (s *AccessDeniedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*AccessDeniedException) StatusCode

func (s *AccessDeniedException) StatusCode() int

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

func (AccessDeniedException) String

func (s AccessDeniedException) String() string

String returns the string representation.

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

type AccountAttribute

type AccountAttribute struct {

	// The name of the account attribute.
	//
	// Name is a required field
	Name *string `type:"string" required:"true" enum:"AccountAttributeName"`

	// The value associated with the account attribute name.
	//
	// Value is a required field
	Value *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Displays the attributes associated with a single Amazon Web Services account.

func (AccountAttribute) GoString

func (s AccountAttribute) GoString() string

GoString returns the string representation.

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

func (*AccountAttribute) SetName

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

SetName sets the Name field's value.

func (*AccountAttribute) SetValue

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

SetValue sets the Value field's value.

func (AccountAttribute) String

func (s AccountAttribute) String() string

String returns the string representation.

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

type AccountLimit

type AccountLimit struct {

	// The Amazon Web Services set limit for that resource type, in US dollars.
	//
	// Max is a required field
	Max *int64 `type:"long" required:"true"`

	// The name of the attribute to apply the account limit to.
	//
	// Name is a required field
	Name *string `type:"string" required:"true" enum:"AccountLimitName"`

	// The current amount that has been spent, in US dollars.
	//
	// Used is a required field
	Used *int64 `type:"long" required:"true"`
	// contains filtered or unexported fields
}

The current resource quotas associated with an Amazon Web Services account.

func (AccountLimit) GoString

func (s AccountLimit) GoString() string

GoString returns the string representation.

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

func (*AccountLimit) SetMax

func (s *AccountLimit) SetMax(v int64) *AccountLimit

SetMax sets the Max field's value.

func (*AccountLimit) SetName

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

SetName sets the Name field's value.

func (*AccountLimit) SetUsed

func (s *AccountLimit) SetUsed(v int64) *AccountLimit

SetUsed sets the Used field's value.

func (AccountLimit) String

func (s AccountLimit) String() string

String returns the string representation.

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

type AssociateOriginationIdentityInput

type AssociateOriginationIdentityInput struct {

	// Unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request. If you don't specify a client token, a randomly generated
	// token is used for the request to ensure idempotency.
	ClientToken *string `min:"1" type:"string" idempotencyToken:"true"`

	// The new two-character code, in ISO 3166-1 alpha-2 format, for the country
	// or region of the origination identity.
	//
	// IsoCountryCode is a required field
	IsoCountryCode *string `min:"2" type:"string" required:"true"`

	// The origination identity to use, such as PhoneNumberId, PhoneNumberArn, SenderId,
	// or SenderIdArn. You can use DescribePhoneNumbers to find the values for PhoneNumberId
	// and PhoneNumberArn, while DescribeSenderIds can be used to get the values
	// for SenderId and SenderIdArn.
	//
	// OriginationIdentity is a required field
	OriginationIdentity *string `min:"1" type:"string" required:"true"`

	// The pool to update with the new Identity. This value can be either the PoolId
	// or PoolArn, and you can find these values using DescribePools.
	//
	// PoolId is a required field
	PoolId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (AssociateOriginationIdentityInput) GoString

GoString returns the string representation.

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

func (*AssociateOriginationIdentityInput) SetClientToken

SetClientToken sets the ClientToken field's value.

func (*AssociateOriginationIdentityInput) SetIsoCountryCode

SetIsoCountryCode sets the IsoCountryCode field's value.

func (*AssociateOriginationIdentityInput) SetOriginationIdentity

SetOriginationIdentity sets the OriginationIdentity field's value.

func (*AssociateOriginationIdentityInput) SetPoolId

SetPoolId sets the PoolId field's value.

func (AssociateOriginationIdentityInput) String

String returns the string representation.

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

func (*AssociateOriginationIdentityInput) Validate

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

type AssociateOriginationIdentityOutput

type AssociateOriginationIdentityOutput struct {

	// The two-character code, in ISO 3166-1 alpha-2 format, for the country or
	// region.
	IsoCountryCode *string `min:"2" type:"string"`

	// The PhoneNumberId or SenderId of the origination identity.
	OriginationIdentity *string `type:"string"`

	// The PhoneNumberArn or SenderIdArn of the origination identity.
	OriginationIdentityArn *string `type:"string"`

	// The Amazon Resource Name (ARN) of the pool that is now associated with the
	// origination identity.
	PoolArn *string `type:"string"`

	// The PoolId of the pool that is now associated with the origination identity.
	PoolId *string `type:"string"`
	// contains filtered or unexported fields
}

func (AssociateOriginationIdentityOutput) GoString

GoString returns the string representation.

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

func (*AssociateOriginationIdentityOutput) SetIsoCountryCode

SetIsoCountryCode sets the IsoCountryCode field's value.

func (*AssociateOriginationIdentityOutput) SetOriginationIdentity

SetOriginationIdentity sets the OriginationIdentity field's value.

func (*AssociateOriginationIdentityOutput) SetOriginationIdentityArn

SetOriginationIdentityArn sets the OriginationIdentityArn field's value.

func (*AssociateOriginationIdentityOutput) SetPoolArn

SetPoolArn sets the PoolArn field's value.

func (*AssociateOriginationIdentityOutput) SetPoolId

SetPoolId sets the PoolId field's value.

func (AssociateOriginationIdentityOutput) String

String returns the string representation.

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

type CloudWatchLogsDestination

type CloudWatchLogsDestination struct {

	// The Amazon Resource Name (ARN) of an Amazon Identity and Access Management
	// (IAM) role that is able to write event data to an Amazon CloudWatch destination.
	//
	// IamRoleArn is a required field
	IamRoleArn *string `min:"20" type:"string" required:"true"`

	// The name of the Amazon CloudWatch log group that you want to record events
	// in.
	//
	// LogGroupArn is a required field
	LogGroupArn *string `min:"20" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains the destination configuration to use when publishing message sending events.

func (CloudWatchLogsDestination) GoString

func (s CloudWatchLogsDestination) GoString() string

GoString returns the string representation.

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

func (*CloudWatchLogsDestination) SetIamRoleArn

SetIamRoleArn sets the IamRoleArn field's value.

func (*CloudWatchLogsDestination) SetLogGroupArn

SetLogGroupArn sets the LogGroupArn field's value.

func (CloudWatchLogsDestination) String

func (s CloudWatchLogsDestination) String() string

String returns the string representation.

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

func (*CloudWatchLogsDestination) Validate

func (s *CloudWatchLogsDestination) Validate() error

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

type ConfigurationSetFilter

type ConfigurationSetFilter struct {

	// The name of the attribute to filter on.
	//
	// Name is a required field
	Name *string `type:"string" required:"true" enum:"ConfigurationSetFilterName"`

	// An array values to filter for.
	//
	// Values is a required field
	Values []*string `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

The information for configuration sets that meet a specified criteria.

func (ConfigurationSetFilter) GoString

func (s ConfigurationSetFilter) GoString() string

GoString returns the string representation.

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

func (*ConfigurationSetFilter) SetName

SetName sets the Name field's value.

func (*ConfigurationSetFilter) SetValues

SetValues sets the Values field's value.

func (ConfigurationSetFilter) String

func (s ConfigurationSetFilter) String() string

String returns the string representation.

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

func (*ConfigurationSetFilter) Validate

func (s *ConfigurationSetFilter) Validate() error

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

type ConfigurationSetInformation

type ConfigurationSetInformation struct {

	// The Resource Name (ARN) of the ConfigurationSet.
	//
	// ConfigurationSetArn is a required field
	ConfigurationSetArn *string `type:"string" required:"true"`

	// The name of the ConfigurationSet.
	//
	// ConfigurationSetName is a required field
	ConfigurationSetName *string `min:"1" type:"string" required:"true"`

	// The time when the ConfigurationSet was created, in UNIX epoch time (https://www.epochconverter.com/)
	// format.
	//
	// CreatedTimestamp is a required field
	CreatedTimestamp *time.Time `type:"timestamp" required:"true"`

	// 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 *string `type:"string" enum:"MessageType"`

	// The default sender ID used by the ConfigurationSet.
	DefaultSenderId *string `min:"1" type:"string"`

	// An array of EventDestination objects that describe any events to log and
	// where to log them.
	//
	// EventDestinations is a required field
	EventDestinations []*EventDestination `type:"list" required:"true"`
	// contains filtered or unexported fields
}

Information related to a given configuration set in your Amazon Web Services account.

func (ConfigurationSetInformation) GoString

func (s ConfigurationSetInformation) GoString() string

GoString returns the string representation.

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

func (*ConfigurationSetInformation) SetConfigurationSetArn

func (s *ConfigurationSetInformation) SetConfigurationSetArn(v string) *ConfigurationSetInformation

SetConfigurationSetArn sets the ConfigurationSetArn field's value.

func (*ConfigurationSetInformation) SetConfigurationSetName

func (s *ConfigurationSetInformation) SetConfigurationSetName(v string) *ConfigurationSetInformation

SetConfigurationSetName sets the ConfigurationSetName field's value.

func (*ConfigurationSetInformation) SetCreatedTimestamp

SetCreatedTimestamp sets the CreatedTimestamp field's value.

func (*ConfigurationSetInformation) SetDefaultMessageType

func (s *ConfigurationSetInformation) SetDefaultMessageType(v string) *ConfigurationSetInformation

SetDefaultMessageType sets the DefaultMessageType field's value.

func (*ConfigurationSetInformation) SetDefaultSenderId

SetDefaultSenderId sets the DefaultSenderId field's value.

func (*ConfigurationSetInformation) SetEventDestinations

SetEventDestinations sets the EventDestinations field's value.

func (ConfigurationSetInformation) String

String returns the string representation.

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

type ConflictException

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

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

	// The reason for the exception.
	Reason *string `type:"string" enum:"ConflictExceptionReason"`

	// The unique identifier of the request.
	ResourceId *string `type:"string"`

	// The type of resource that caused the exception.
	ResourceType *string `type:"string" enum:"ResourceType"`
	// 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) Code

func (s *ConflictException) Code() string

Code returns the exception type name.

func (*ConflictException) Error

func (s *ConflictException) Error() string

func (ConflictException) GoString

func (s ConflictException) GoString() string

GoString returns the string representation.

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

func (*ConflictException) Message

func (s *ConflictException) Message() string

Message returns the exception's message.

func (*ConflictException) OrigErr

func (s *ConflictException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ConflictException) RequestID

func (s *ConflictException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ConflictException) StatusCode

func (s *ConflictException) StatusCode() int

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

func (ConflictException) String

func (s ConflictException) String() string

String returns the string representation.

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

type CreateConfigurationSetInput

type CreateConfigurationSetInput struct {

	// Unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request. If you don't specify a client token, a randomly generated
	// token is used for the request to ensure idempotency.
	ClientToken *string `min:"1" type:"string" idempotencyToken:"true"`

	// The name to use for the new configuration set.
	//
	// ConfigurationSetName is a required field
	ConfigurationSetName *string `min:"1" type:"string" required:"true"`

	// An array of key and value pair tags that's associated with the new configuration
	// set.
	Tags []*Tag `type:"list"`
	// contains filtered or unexported fields
}

func (CreateConfigurationSetInput) GoString

func (s CreateConfigurationSetInput) GoString() string

GoString returns the string representation.

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

func (*CreateConfigurationSetInput) SetClientToken

SetClientToken sets the ClientToken field's value.

func (*CreateConfigurationSetInput) SetConfigurationSetName

func (s *CreateConfigurationSetInput) SetConfigurationSetName(v string) *CreateConfigurationSetInput

SetConfigurationSetName sets the ConfigurationSetName field's value.

func (*CreateConfigurationSetInput) SetTags

SetTags sets the Tags field's value.

func (CreateConfigurationSetInput) String

String returns the string representation.

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

func (*CreateConfigurationSetInput) Validate

func (s *CreateConfigurationSetInput) Validate() error

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

type CreateConfigurationSetOutput

type CreateConfigurationSetOutput struct {

	// The Amazon Resource Name (ARN) of the newly created configuration set.
	ConfigurationSetArn *string `type:"string"`

	// The name of the new configuration set.
	ConfigurationSetName *string `min:"1" type:"string"`

	// The time when the configuration set was created, in UNIX epoch time (https://www.epochconverter.com/)
	// format.
	CreatedTimestamp *time.Time `type:"timestamp"`

	// An array of key and value pair tags that's associated with the configuration
	// set.
	Tags []*Tag `type:"list"`
	// contains filtered or unexported fields
}

func (CreateConfigurationSetOutput) GoString

func (s CreateConfigurationSetOutput) GoString() string

GoString returns the string representation.

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

func (*CreateConfigurationSetOutput) SetConfigurationSetArn

SetConfigurationSetArn sets the ConfigurationSetArn field's value.

func (*CreateConfigurationSetOutput) SetConfigurationSetName

func (s *CreateConfigurationSetOutput) SetConfigurationSetName(v string) *CreateConfigurationSetOutput

SetConfigurationSetName sets the ConfigurationSetName field's value.

func (*CreateConfigurationSetOutput) SetCreatedTimestamp

SetCreatedTimestamp sets the CreatedTimestamp field's value.

func (*CreateConfigurationSetOutput) SetTags

SetTags sets the Tags field's value.

func (CreateConfigurationSetOutput) String

String returns the string representation.

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

type CreateEventDestinationInput

type CreateEventDestinationInput struct {

	// Unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request. If you don't specify a client token, a randomly generated
	// token is used for the request to ensure idempotency.
	ClientToken *string `min:"1" type:"string" idempotencyToken:"true"`

	// An object that contains information about an event destination for logging
	// to Amazon CloudWatch logs.
	CloudWatchLogsDestination *CloudWatchLogsDestination `type:"structure"`

	// Either the name of the configuration set or the configuration set ARN to
	// apply event logging to. The ConfigurateSetName and ConfigurationSetArn can
	// be found using the DescribeConfigurationSets action.
	//
	// ConfigurationSetName is a required field
	ConfigurationSetName *string `min:"1" type:"string" required:"true"`

	// The name that identifies the event destination.
	//
	// EventDestinationName is a required field
	EventDestinationName *string `min:"1" type:"string" required:"true"`

	// An object that contains information about an event destination for logging
	// to Amazon Kinesis Data Firehose.
	KinesisFirehoseDestination *KinesisFirehoseDestination `type:"structure"`

	// An array of event types that determine which events to log. If "ALL" is used,
	// then Amazon Pinpoint logs every event type.
	//
	// MatchingEventTypes is a required field
	MatchingEventTypes []*string `min:"1" type:"list" required:"true" enum:"EventType"`

	// An object that contains information about an event destination for logging
	// to Amazon SNS.
	SnsDestination *SnsDestination `type:"structure"`
	// contains filtered or unexported fields
}

func (CreateEventDestinationInput) GoString

func (s CreateEventDestinationInput) GoString() string

GoString returns the string representation.

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

func (*CreateEventDestinationInput) SetClientToken

SetClientToken sets the ClientToken field's value.

func (*CreateEventDestinationInput) SetCloudWatchLogsDestination

SetCloudWatchLogsDestination sets the CloudWatchLogsDestination field's value.

func (*CreateEventDestinationInput) SetConfigurationSetName

func (s *CreateEventDestinationInput) SetConfigurationSetName(v string) *CreateEventDestinationInput

SetConfigurationSetName sets the ConfigurationSetName field's value.

func (*CreateEventDestinationInput) SetEventDestinationName

func (s *CreateEventDestinationInput) SetEventDestinationName(v string) *CreateEventDestinationInput

SetEventDestinationName sets the EventDestinationName field's value.

func (*CreateEventDestinationInput) SetKinesisFirehoseDestination

SetKinesisFirehoseDestination sets the KinesisFirehoseDestination field's value.

func (*CreateEventDestinationInput) SetMatchingEventTypes

func (s *CreateEventDestinationInput) SetMatchingEventTypes(v []*string) *CreateEventDestinationInput

SetMatchingEventTypes sets the MatchingEventTypes field's value.

func (*CreateEventDestinationInput) SetSnsDestination

SetSnsDestination sets the SnsDestination field's value.

func (CreateEventDestinationInput) String

String returns the string representation.

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

func (*CreateEventDestinationInput) Validate

func (s *CreateEventDestinationInput) Validate() error

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

type CreateEventDestinationOutput

type CreateEventDestinationOutput struct {

	// The ARN of the configuration set.
	ConfigurationSetArn *string `type:"string"`

	// The name of the configuration set.
	ConfigurationSetName *string `min:"1" type:"string"`

	// The details of the destination where events are logged.
	EventDestination *EventDestination `type:"structure"`
	// contains filtered or unexported fields
}

func (CreateEventDestinationOutput) GoString

func (s CreateEventDestinationOutput) GoString() string

GoString returns the string representation.

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

func (*CreateEventDestinationOutput) SetConfigurationSetArn

SetConfigurationSetArn sets the ConfigurationSetArn field's value.

func (*CreateEventDestinationOutput) SetConfigurationSetName

func (s *CreateEventDestinationOutput) SetConfigurationSetName(v string) *CreateEventDestinationOutput

SetConfigurationSetName sets the ConfigurationSetName field's value.

func (*CreateEventDestinationOutput) SetEventDestination

SetEventDestination sets the EventDestination field's value.

func (CreateEventDestinationOutput) String

String returns the string representation.

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

type CreateOptOutListInput

type CreateOptOutListInput struct {

	// Unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request. If you don't specify a client token, a randomly generated
	// token is used for the request to ensure idempotency.
	ClientToken *string `min:"1" type:"string" idempotencyToken:"true"`

	// The name of the new OptOutList.
	//
	// OptOutListName is a required field
	OptOutListName *string `min:"1" type:"string" required:"true"`

	// An array of tags (key and value pairs) to associate with the new OptOutList.
	Tags []*Tag `type:"list"`
	// contains filtered or unexported fields
}

func (CreateOptOutListInput) GoString

func (s CreateOptOutListInput) GoString() string

GoString returns the string representation.

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

func (*CreateOptOutListInput) SetClientToken

func (s *CreateOptOutListInput) SetClientToken(v string) *CreateOptOutListInput

SetClientToken sets the ClientToken field's value.

func (*CreateOptOutListInput) SetOptOutListName

func (s *CreateOptOutListInput) SetOptOutListName(v string) *CreateOptOutListInput

SetOptOutListName sets the OptOutListName field's value.

func (*CreateOptOutListInput) SetTags

SetTags sets the Tags field's value.

func (CreateOptOutListInput) String

func (s CreateOptOutListInput) String() string

String returns the string representation.

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

func (*CreateOptOutListInput) Validate

func (s *CreateOptOutListInput) Validate() error

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

type CreateOptOutListOutput

type CreateOptOutListOutput struct {

	// The time when the pool was created, in UNIX epoch time (https://www.epochconverter.com/)
	// format.
	CreatedTimestamp *time.Time `type:"timestamp"`

	// The Amazon Resource Name (ARN) for the OptOutList.
	OptOutListArn *string `type:"string"`

	// The name of the new OptOutList.
	OptOutListName *string `min:"1" type:"string"`

	// An array of tags (key and value pairs) associated with the new OptOutList.
	Tags []*Tag `type:"list"`
	// contains filtered or unexported fields
}

func (CreateOptOutListOutput) GoString

func (s CreateOptOutListOutput) GoString() string

GoString returns the string representation.

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

func (*CreateOptOutListOutput) SetCreatedTimestamp

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

SetCreatedTimestamp sets the CreatedTimestamp field's value.

func (*CreateOptOutListOutput) SetOptOutListArn

func (s *CreateOptOutListOutput) SetOptOutListArn(v string) *CreateOptOutListOutput

SetOptOutListArn sets the OptOutListArn field's value.

func (*CreateOptOutListOutput) SetOptOutListName

func (s *CreateOptOutListOutput) SetOptOutListName(v string) *CreateOptOutListOutput

SetOptOutListName sets the OptOutListName field's value.

func (*CreateOptOutListOutput) SetTags

SetTags sets the Tags field's value.

func (CreateOptOutListOutput) String

func (s CreateOptOutListOutput) String() string

String returns the string representation.

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

type CreatePoolInput

type CreatePoolInput struct {

	// Unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request. If you don't specify a client token, a randomly generated
	// token is used for the request to ensure idempotency.
	ClientToken *string `min:"1" type:"string" idempotencyToken:"true"`

	// By default this is set to false. When set to true the pool can't be deleted.
	// You can change this value using the UpdatePool action.
	DeletionProtectionEnabled *bool `type:"boolean"`

	// The new two-character code, in ISO 3166-1 alpha-2 format, for the country
	// or region of the new pool.
	//
	// IsoCountryCode is a required field
	IsoCountryCode *string `min:"2" type:"string" required:"true"`

	// 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.
	//
	// MessageType is a required field
	MessageType *string `type:"string" required:"true" enum:"MessageType"`

	// The origination identity to use such as a PhoneNumberId, PhoneNumberArn,
	// SenderId or SenderIdArn. You can use DescribePhoneNumbers to find the values
	// for PhoneNumberId and PhoneNumberArn while DescribeSenderIds can be used
	// to get the values for SenderId and SenderIdArn.
	//
	// OriginationIdentity is a required field
	OriginationIdentity *string `min:"1" type:"string" required:"true"`

	// An array of tags (key and value pairs) associated with the pool.
	Tags []*Tag `type:"list"`
	// contains filtered or unexported fields
}

func (CreatePoolInput) GoString

func (s CreatePoolInput) GoString() string

GoString returns the string representation.

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

func (*CreatePoolInput) SetClientToken

func (s *CreatePoolInput) SetClientToken(v string) *CreatePoolInput

SetClientToken sets the ClientToken field's value.

func (*CreatePoolInput) SetDeletionProtectionEnabled

func (s *CreatePoolInput) SetDeletionProtectionEnabled(v bool) *CreatePoolInput

SetDeletionProtectionEnabled sets the DeletionProtectionEnabled field's value.

func (*CreatePoolInput) SetIsoCountryCode

func (s *CreatePoolInput) SetIsoCountryCode(v string) *CreatePoolInput

SetIsoCountryCode sets the IsoCountryCode field's value.

func (*CreatePoolInput) SetMessageType

func (s *CreatePoolInput) SetMessageType(v string) *CreatePoolInput

SetMessageType sets the MessageType field's value.

func (*CreatePoolInput) SetOriginationIdentity

func (s *CreatePoolInput) SetOriginationIdentity(v string) *CreatePoolInput

SetOriginationIdentity sets the OriginationIdentity field's value.

func (*CreatePoolInput) SetTags

func (s *CreatePoolInput) SetTags(v []*Tag) *CreatePoolInput

SetTags sets the Tags field's value.

func (CreatePoolInput) String

func (s CreatePoolInput) String() string

String returns the string representation.

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

func (*CreatePoolInput) Validate

func (s *CreatePoolInput) Validate() error

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

type CreatePoolOutput

type CreatePoolOutput struct {

	// The time when the pool was created, in UNIX epoch time (https://www.epochconverter.com/)
	// format.
	CreatedTimestamp *time.Time `type:"timestamp"`

	// When set to true deletion protection is enabled. By default this is set to
	// false.
	DeletionProtectionEnabled *bool `type:"boolean"`

	// The type of message for the pool to use.
	MessageType *string `type:"string" enum:"MessageType"`

	// The name of the OptOutList associated with the pool.
	OptOutListName *string `min:"1" type:"string"`

	// The Amazon Resource Name (ARN) for the pool.
	PoolArn *string `type:"string"`

	// The unique identifier for the pool.
	PoolId *string `type:"string"`

	// By default this is set to false. When 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.
	SelfManagedOptOutsEnabled *bool `type:"boolean"`

	// Indicates whether shared routes are enabled for the pool.
	SharedRoutesEnabled *bool `type:"boolean"`

	// The current status of the pool.
	//
	//    * CREATING: The pool is currently being created and isn't yet available
	//    for use.
	//
	//    * ACTIVE: The pool is active and available for use.
	//
	//    * DELETING: The pool is being deleted.
	Status *string `type:"string" enum:"PoolStatus"`

	// An array of tags (key and value pairs) associated with the pool.
	Tags []*Tag `type:"list"`

	// The Amazon Resource Name (ARN) of the two way channel.
	TwoWayChannelArn *string `min:"20" type:"string"`

	// By default this is set to false. When set to true you can receive incoming
	// text messages from your end recipients.
	TwoWayEnabled *bool `type:"boolean"`
	// contains filtered or unexported fields
}

func (CreatePoolOutput) GoString

func (s CreatePoolOutput) GoString() string

GoString returns the string representation.

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

func (*CreatePoolOutput) SetCreatedTimestamp

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

SetCreatedTimestamp sets the CreatedTimestamp field's value.

func (*CreatePoolOutput) SetDeletionProtectionEnabled

func (s *CreatePoolOutput) SetDeletionProtectionEnabled(v bool) *CreatePoolOutput

SetDeletionProtectionEnabled sets the DeletionProtectionEnabled field's value.

func (*CreatePoolOutput) SetMessageType

func (s *CreatePoolOutput) SetMessageType(v string) *CreatePoolOutput

SetMessageType sets the MessageType field's value.

func (*CreatePoolOutput) SetOptOutListName

func (s *CreatePoolOutput) SetOptOutListName(v string) *CreatePoolOutput

SetOptOutListName sets the OptOutListName field's value.

func (*CreatePoolOutput) SetPoolArn

func (s *CreatePoolOutput) SetPoolArn(v string) *CreatePoolOutput

SetPoolArn sets the PoolArn field's value.

func (*CreatePoolOutput) SetPoolId

func (s *CreatePoolOutput) SetPoolId(v string) *CreatePoolOutput

SetPoolId sets the PoolId field's value.

func (*CreatePoolOutput) SetSelfManagedOptOutsEnabled

func (s *CreatePoolOutput) SetSelfManagedOptOutsEnabled(v bool) *CreatePoolOutput

SetSelfManagedOptOutsEnabled sets the SelfManagedOptOutsEnabled field's value.

func (*CreatePoolOutput) SetSharedRoutesEnabled

func (s *CreatePoolOutput) SetSharedRoutesEnabled(v bool) *CreatePoolOutput

SetSharedRoutesEnabled sets the SharedRoutesEnabled field's value.

func (*CreatePoolOutput) SetStatus

func (s *CreatePoolOutput) SetStatus(v string) *CreatePoolOutput

SetStatus sets the Status field's value.

func (*CreatePoolOutput) SetTags

func (s *CreatePoolOutput) SetTags(v []*Tag) *CreatePoolOutput

SetTags sets the Tags field's value.

func (*CreatePoolOutput) SetTwoWayChannelArn

func (s *CreatePoolOutput) SetTwoWayChannelArn(v string) *CreatePoolOutput

SetTwoWayChannelArn sets the TwoWayChannelArn field's value.

func (*CreatePoolOutput) SetTwoWayEnabled

func (s *CreatePoolOutput) SetTwoWayEnabled(v bool) *CreatePoolOutput

SetTwoWayEnabled sets the TwoWayEnabled field's value.

func (CreatePoolOutput) String

func (s CreatePoolOutput) String() string

String returns the string representation.

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

type DeleteConfigurationSetInput

type DeleteConfigurationSetInput struct {

	// The name of the configuration set or the configuration set ARN that you want
	// to delete. The ConfigurationSetName and ConfigurationSetArn can be found
	// using the DescribeConfigurationSets action.
	//
	// ConfigurationSetName is a required field
	ConfigurationSetName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteConfigurationSetInput) GoString

func (s DeleteConfigurationSetInput) GoString() string

GoString returns the string representation.

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

func (*DeleteConfigurationSetInput) SetConfigurationSetName

func (s *DeleteConfigurationSetInput) SetConfigurationSetName(v string) *DeleteConfigurationSetInput

SetConfigurationSetName sets the ConfigurationSetName field's value.

func (DeleteConfigurationSetInput) String

String returns the string representation.

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

func (*DeleteConfigurationSetInput) Validate

func (s *DeleteConfigurationSetInput) Validate() error

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

type DeleteConfigurationSetOutput

type DeleteConfigurationSetOutput struct {

	// The Amazon Resource Name (ARN) of the deleted configuration set.
	ConfigurationSetArn *string `type:"string"`

	// The name of the deleted configuration set.
	ConfigurationSetName *string `min:"1" type:"string"`

	// The time that the deleted configuration set was created in UNIX epoch time
	// (https://www.epochconverter.com/) format.
	CreatedTimestamp *time.Time `type:"timestamp"`

	// The default message type of the configuration set that was deleted.
	DefaultMessageType *string `type:"string" enum:"MessageType"`

	// The default Sender ID of the configuration set that was deleted.
	DefaultSenderId *string `min:"1" type:"string"`

	// An array of any EventDestination objects that were associated with the deleted
	// configuration set.
	EventDestinations []*EventDestination `type:"list"`
	// contains filtered or unexported fields
}

func (DeleteConfigurationSetOutput) GoString

func (s DeleteConfigurationSetOutput) GoString() string

GoString returns the string representation.

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

func (*DeleteConfigurationSetOutput) SetConfigurationSetArn

SetConfigurationSetArn sets the ConfigurationSetArn field's value.

func (*DeleteConfigurationSetOutput) SetConfigurationSetName

func (s *DeleteConfigurationSetOutput) SetConfigurationSetName(v string) *DeleteConfigurationSetOutput

SetConfigurationSetName sets the ConfigurationSetName field's value.

func (*DeleteConfigurationSetOutput) SetCreatedTimestamp

SetCreatedTimestamp sets the CreatedTimestamp field's value.

func (*DeleteConfigurationSetOutput) SetDefaultMessageType

SetDefaultMessageType sets the DefaultMessageType field's value.

func (*DeleteConfigurationSetOutput) SetDefaultSenderId

SetDefaultSenderId sets the DefaultSenderId field's value.

func (*DeleteConfigurationSetOutput) SetEventDestinations

SetEventDestinations sets the EventDestinations field's value.

func (DeleteConfigurationSetOutput) String

String returns the string representation.

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

type DeleteDefaultMessageTypeInput

type DeleteDefaultMessageTypeInput struct {

	// The name of the configuration set or the configuration set Amazon Resource
	// Name (ARN) to delete the default message type from. The ConfigurationSetName
	// and ConfigurationSetArn can be found using the DescribeConfigurationSets
	// action.
	//
	// ConfigurationSetName is a required field
	ConfigurationSetName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteDefaultMessageTypeInput) GoString

GoString returns the string representation.

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

func (*DeleteDefaultMessageTypeInput) SetConfigurationSetName

SetConfigurationSetName sets the ConfigurationSetName field's value.

func (DeleteDefaultMessageTypeInput) String

String returns the string representation.

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

func (*DeleteDefaultMessageTypeInput) Validate

func (s *DeleteDefaultMessageTypeInput) Validate() error

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

type DeleteDefaultMessageTypeOutput

type DeleteDefaultMessageTypeOutput struct {

	// The Amazon Resource Name (ARN) of the configuration set.
	ConfigurationSetArn *string `type:"string"`

	// The name of the configuration set.
	ConfigurationSetName *string `min:"1" type:"string"`

	// The current message type for the configuration set.
	MessageType *string `type:"string" enum:"MessageType"`
	// contains filtered or unexported fields
}

func (DeleteDefaultMessageTypeOutput) GoString

GoString returns the string representation.

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

func (*DeleteDefaultMessageTypeOutput) SetConfigurationSetArn

SetConfigurationSetArn sets the ConfigurationSetArn field's value.

func (*DeleteDefaultMessageTypeOutput) SetConfigurationSetName

SetConfigurationSetName sets the ConfigurationSetName field's value.

func (*DeleteDefaultMessageTypeOutput) SetMessageType

SetMessageType sets the MessageType field's value.

func (DeleteDefaultMessageTypeOutput) String

String returns the string representation.

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

type DeleteDefaultSenderIdInput

type DeleteDefaultSenderIdInput struct {

	// The name of the configuration set or the configuration set Amazon Resource
	// Name (ARN) to delete the default sender ID from. The ConfigurationSetName
	// and ConfigurationSetArn can be found using the DescribeConfigurationSets
	// action.
	//
	// ConfigurationSetName is a required field
	ConfigurationSetName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteDefaultSenderIdInput) GoString

func (s DeleteDefaultSenderIdInput) GoString() string

GoString returns the string representation.

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

func (*DeleteDefaultSenderIdInput) SetConfigurationSetName

func (s *DeleteDefaultSenderIdInput) SetConfigurationSetName(v string) *DeleteDefaultSenderIdInput

SetConfigurationSetName sets the ConfigurationSetName field's value.

func (DeleteDefaultSenderIdInput) String

String returns the string representation.

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

func (*DeleteDefaultSenderIdInput) Validate

func (s *DeleteDefaultSenderIdInput) Validate() error

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

type DeleteDefaultSenderIdOutput

type DeleteDefaultSenderIdOutput struct {

	// The Amazon Resource Name (ARN) of the configuration set.
	ConfigurationSetArn *string `type:"string"`

	// The name of the configuration set.
	ConfigurationSetName *string `min:"1" type:"string"`

	// The current sender ID for the configuration set.
	SenderId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DeleteDefaultSenderIdOutput) GoString

func (s DeleteDefaultSenderIdOutput) GoString() string

GoString returns the string representation.

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

func (*DeleteDefaultSenderIdOutput) SetConfigurationSetArn

func (s *DeleteDefaultSenderIdOutput) SetConfigurationSetArn(v string) *DeleteDefaultSenderIdOutput

SetConfigurationSetArn sets the ConfigurationSetArn field's value.

func (*DeleteDefaultSenderIdOutput) SetConfigurationSetName

func (s *DeleteDefaultSenderIdOutput) SetConfigurationSetName(v string) *DeleteDefaultSenderIdOutput

SetConfigurationSetName sets the ConfigurationSetName field's value.

func (*DeleteDefaultSenderIdOutput) SetSenderId

SetSenderId sets the SenderId field's value.

func (DeleteDefaultSenderIdOutput) String

String returns the string representation.

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

type DeleteEventDestinationInput

type DeleteEventDestinationInput struct {

	// The name of the configuration set or the configuration set's Amazon Resource
	// Name (ARN) to remove the event destination from. The ConfigurateSetName and
	// ConfigurationSetArn can be found using the DescribeConfigurationSets action.
	//
	// ConfigurationSetName is a required field
	ConfigurationSetName *string `min:"1" type:"string" required:"true"`

	// The name of the event destination to delete.
	//
	// EventDestinationName is a required field
	EventDestinationName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteEventDestinationInput) GoString

func (s DeleteEventDestinationInput) GoString() string

GoString returns the string representation.

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

func (*DeleteEventDestinationInput) SetConfigurationSetName

func (s *DeleteEventDestinationInput) SetConfigurationSetName(v string) *DeleteEventDestinationInput

SetConfigurationSetName sets the ConfigurationSetName field's value.

func (*DeleteEventDestinationInput) SetEventDestinationName

func (s *DeleteEventDestinationInput) SetEventDestinationName(v string) *DeleteEventDestinationInput

SetEventDestinationName sets the EventDestinationName field's value.

func (DeleteEventDestinationInput) String

String returns the string representation.

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

func (*DeleteEventDestinationInput) Validate

func (s *DeleteEventDestinationInput) Validate() error

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

type DeleteEventDestinationOutput

type DeleteEventDestinationOutput struct {

	// The Amazon Resource Name (ARN) of the configuration set.
	ConfigurationSetArn *string `type:"string"`

	// The name of the configuration set the event destination was deleted from.
	ConfigurationSetName *string `min:"1" type:"string"`

	// The event destination object that was deleted.
	EventDestination *EventDestination `type:"structure"`
	// contains filtered or unexported fields
}

func (DeleteEventDestinationOutput) GoString

func (s DeleteEventDestinationOutput) GoString() string

GoString returns the string representation.

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

func (*DeleteEventDestinationOutput) SetConfigurationSetArn

SetConfigurationSetArn sets the ConfigurationSetArn field's value.

func (*DeleteEventDestinationOutput) SetConfigurationSetName

func (s *DeleteEventDestinationOutput) SetConfigurationSetName(v string) *DeleteEventDestinationOutput

SetConfigurationSetName sets the ConfigurationSetName field's value.

func (*DeleteEventDestinationOutput) SetEventDestination

SetEventDestination sets the EventDestination field's value.

func (DeleteEventDestinationOutput) String

String returns the string representation.

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

type DeleteKeywordInput

type DeleteKeywordInput struct {

	// The keyword to delete.
	//
	// Keyword is a required field
	Keyword *string `min:"1" type:"string" required:"true"`

	// The origination identity to use such as a PhoneNumberId, PhoneNumberArn,
	// PoolId or PoolArn. You can use DescribePhoneNumbers to find the values for
	// PhoneNumberId and PhoneNumberArn and DescribePools to find the values of
	// PoolId and PoolArn.
	//
	// OriginationIdentity is a required field
	OriginationIdentity *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteKeywordInput) GoString

func (s DeleteKeywordInput) GoString() string

GoString returns the string representation.

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

func (*DeleteKeywordInput) SetKeyword

func (s *DeleteKeywordInput) SetKeyword(v string) *DeleteKeywordInput

SetKeyword sets the Keyword field's value.

func (*DeleteKeywordInput) SetOriginationIdentity

func (s *DeleteKeywordInput) SetOriginationIdentity(v string) *DeleteKeywordInput

SetOriginationIdentity sets the OriginationIdentity field's value.

func (DeleteKeywordInput) String

func (s DeleteKeywordInput) String() string

String returns the string representation.

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

func (*DeleteKeywordInput) Validate

func (s *DeleteKeywordInput) Validate() error

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

type DeleteKeywordOutput

type DeleteKeywordOutput struct {

	// The keyword that was deleted.
	Keyword *string `min:"1" type:"string"`

	// The action that was associated with the deleted keyword.
	KeywordAction *string `type:"string" enum:"KeywordAction"`

	// The message that was associated with the deleted keyword.
	KeywordMessage *string `min:"1" type:"string"`

	// The PhoneNumberId or PoolId that the keyword was associated with.
	OriginationIdentity *string `type:"string"`

	// The PhoneNumberArn or PoolArn that the keyword was associated with.
	OriginationIdentityArn *string `type:"string"`
	// contains filtered or unexported fields
}

func (DeleteKeywordOutput) GoString

func (s DeleteKeywordOutput) GoString() string

GoString returns the string representation.

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

func (*DeleteKeywordOutput) SetKeyword

SetKeyword sets the Keyword field's value.

func (*DeleteKeywordOutput) SetKeywordAction

func (s *DeleteKeywordOutput) SetKeywordAction(v string) *DeleteKeywordOutput

SetKeywordAction sets the KeywordAction field's value.

func (*DeleteKeywordOutput) SetKeywordMessage

func (s *DeleteKeywordOutput) SetKeywordMessage(v string) *DeleteKeywordOutput

SetKeywordMessage sets the KeywordMessage field's value.

func (*DeleteKeywordOutput) SetOriginationIdentity

func (s *DeleteKeywordOutput) SetOriginationIdentity(v string) *DeleteKeywordOutput

SetOriginationIdentity sets the OriginationIdentity field's value.

func (*DeleteKeywordOutput) SetOriginationIdentityArn

func (s *DeleteKeywordOutput) SetOriginationIdentityArn(v string) *DeleteKeywordOutput

SetOriginationIdentityArn sets the OriginationIdentityArn field's value.

func (DeleteKeywordOutput) String

func (s DeleteKeywordOutput) String() string

String returns the string representation.

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

type DeleteOptOutListInput

type DeleteOptOutListInput struct {

	// The OptOutListName or OptOutListArn of the OptOutList to delete. You can
	// use DescribeOptOutLists to find the values for OptOutListName and OptOutListArn.
	//
	// OptOutListName is a required field
	OptOutListName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteOptOutListInput) GoString

func (s DeleteOptOutListInput) GoString() string

GoString returns the string representation.

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

func (*DeleteOptOutListInput) SetOptOutListName

func (s *DeleteOptOutListInput) SetOptOutListName(v string) *DeleteOptOutListInput

SetOptOutListName sets the OptOutListName field's value.

func (DeleteOptOutListInput) String

func (s DeleteOptOutListInput) String() string

String returns the string representation.

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

func (*DeleteOptOutListInput) Validate

func (s *DeleteOptOutListInput) Validate() error

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

type DeleteOptOutListOutput

type DeleteOptOutListOutput struct {

	// The time when the OptOutList was created, in UNIX epoch time (https://www.epochconverter.com/)
	// format.
	CreatedTimestamp *time.Time `type:"timestamp"`

	// The Amazon Resource Name (ARN) of the OptOutList that was removed.
	OptOutListArn *string `type:"string"`

	// The name of the OptOutList that was removed.
	OptOutListName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DeleteOptOutListOutput) GoString

func (s DeleteOptOutListOutput) GoString() string

GoString returns the string representation.

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

func (*DeleteOptOutListOutput) SetCreatedTimestamp

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

SetCreatedTimestamp sets the CreatedTimestamp field's value.

func (*DeleteOptOutListOutput) SetOptOutListArn

func (s *DeleteOptOutListOutput) SetOptOutListArn(v string) *DeleteOptOutListOutput

SetOptOutListArn sets the OptOutListArn field's value.

func (*DeleteOptOutListOutput) SetOptOutListName

func (s *DeleteOptOutListOutput) SetOptOutListName(v string) *DeleteOptOutListOutput

SetOptOutListName sets the OptOutListName field's value.

func (DeleteOptOutListOutput) String

func (s DeleteOptOutListOutput) String() string

String returns the string representation.

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

type DeleteOptedOutNumberInput

type DeleteOptedOutNumberInput struct {

	// The OptOutListName or OptOutListArn to remove the phone number from.
	//
	// OptOutListName is a required field
	OptOutListName *string `min:"1" type:"string" required:"true"`

	// The phone number, in E.164 format, to remove from the OptOutList.
	//
	// OptedOutNumber is a required field
	OptedOutNumber *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteOptedOutNumberInput) GoString

func (s DeleteOptedOutNumberInput) GoString() string

GoString returns the string representation.

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

func (*DeleteOptedOutNumberInput) SetOptOutListName

SetOptOutListName sets the OptOutListName field's value.

func (*DeleteOptedOutNumberInput) SetOptedOutNumber

SetOptedOutNumber sets the OptedOutNumber field's value.

func (DeleteOptedOutNumberInput) String

func (s DeleteOptedOutNumberInput) String() string

String returns the string representation.

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

func (*DeleteOptedOutNumberInput) Validate

func (s *DeleteOptedOutNumberInput) Validate() error

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

type DeleteOptedOutNumberOutput

type DeleteOptedOutNumberOutput struct {

	// This is true if it was the end user who requested their phone number be removed.
	EndUserOptedOut *bool `type:"boolean"`

	// The OptOutListArn that the phone number was removed from.
	OptOutListArn *string `type:"string"`

	// The OptOutListName that the phone number was removed from.
	OptOutListName *string `min:"1" type:"string"`

	// The phone number that was removed from the OptOutList.
	OptedOutNumber *string `min:"1" type:"string"`

	// The time that the number was removed at, in UNIX epoch time (https://www.epochconverter.com/)
	// format.
	OptedOutTimestamp *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

func (DeleteOptedOutNumberOutput) GoString

func (s DeleteOptedOutNumberOutput) GoString() string

GoString returns the string representation.

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

func (*DeleteOptedOutNumberOutput) SetEndUserOptedOut

SetEndUserOptedOut sets the EndUserOptedOut field's value.

func (*DeleteOptedOutNumberOutput) SetOptOutListArn

SetOptOutListArn sets the OptOutListArn field's value.

func (*DeleteOptedOutNumberOutput) SetOptOutListName

SetOptOutListName sets the OptOutListName field's value.

func (*DeleteOptedOutNumberOutput) SetOptedOutNumber

SetOptedOutNumber sets the OptedOutNumber field's value.

func (*DeleteOptedOutNumberOutput) SetOptedOutTimestamp

func (s *DeleteOptedOutNumberOutput) SetOptedOutTimestamp(v time.Time) *DeleteOptedOutNumberOutput

SetOptedOutTimestamp sets the OptedOutTimestamp field's value.

func (DeleteOptedOutNumberOutput) String

String returns the string representation.

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

type DeletePoolInput

type DeletePoolInput struct {

	// The PoolId or PoolArn of the pool to delete. You can use DescribePools to
	// find the values for PoolId and PoolArn .
	//
	// PoolId is a required field
	PoolId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeletePoolInput) GoString

func (s DeletePoolInput) GoString() string

GoString returns the string representation.

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

func (*DeletePoolInput) SetPoolId

func (s *DeletePoolInput) SetPoolId(v string) *DeletePoolInput

SetPoolId sets the PoolId field's value.

func (DeletePoolInput) String

func (s DeletePoolInput) String() string

String returns the string representation.

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

func (*DeletePoolInput) Validate

func (s *DeletePoolInput) Validate() error

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

type DeletePoolOutput

type DeletePoolOutput struct {

	// The time when the pool was created, in UNIX epoch time (https://www.epochconverter.com/)
	// format.
	CreatedTimestamp *time.Time `type:"timestamp"`

	// The message type that was associated with the deleted pool.
	MessageType *string `type:"string" enum:"MessageType"`

	// The name of the OptOutList that was associated with the deleted pool.
	OptOutListName *string `min:"1" type:"string"`

	// The Amazon Resource Name (ARN) of the pool that was deleted.
	PoolArn *string `type:"string"`

	// The PoolId of the pool that was deleted.
	PoolId *string `type:"string"`

	// By default this is set to false. When 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.
	SelfManagedOptOutsEnabled *bool `type:"boolean"`

	// Indicates whether shared routes are enabled for the pool.
	SharedRoutesEnabled *bool `type:"boolean"`

	// The current status of the pool.
	//
	//    * CREATING: The pool is currently being created and isn't yet available
	//    for use.
	//
	//    * ACTIVE: The pool is active and available for use.
	//
	//    * DELETING: The pool is being deleted.
	Status *string `type:"string" enum:"PoolStatus"`

	// The Amazon Resource Name (ARN) of the TwoWayChannel.
	TwoWayChannelArn *string `min:"20" type:"string"`

	// By default this is set to false. When set to true you can receive incoming
	// text messages from your end recipients.
	TwoWayEnabled *bool `type:"boolean"`
	// contains filtered or unexported fields
}

func (DeletePoolOutput) GoString

func (s DeletePoolOutput) GoString() string

GoString returns the string representation.

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

func (*DeletePoolOutput) SetCreatedTimestamp

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

SetCreatedTimestamp sets the CreatedTimestamp field's value.

func (*DeletePoolOutput) SetMessageType

func (s *DeletePoolOutput) SetMessageType(v string) *DeletePoolOutput

SetMessageType sets the MessageType field's value.

func (*DeletePoolOutput) SetOptOutListName

func (s *DeletePoolOutput) SetOptOutListName(v string) *DeletePoolOutput

SetOptOutListName sets the OptOutListName field's value.

func (*DeletePoolOutput) SetPoolArn

func (s *DeletePoolOutput) SetPoolArn(v string) *DeletePoolOutput

SetPoolArn sets the PoolArn field's value.

func (*DeletePoolOutput) SetPoolId

func (s *DeletePoolOutput) SetPoolId(v string) *DeletePoolOutput

SetPoolId sets the PoolId field's value.

func (*DeletePoolOutput) SetSelfManagedOptOutsEnabled

func (s *DeletePoolOutput) SetSelfManagedOptOutsEnabled(v bool) *DeletePoolOutput

SetSelfManagedOptOutsEnabled sets the SelfManagedOptOutsEnabled field's value.

func (*DeletePoolOutput) SetSharedRoutesEnabled

func (s *DeletePoolOutput) SetSharedRoutesEnabled(v bool) *DeletePoolOutput

SetSharedRoutesEnabled sets the SharedRoutesEnabled field's value.

func (*DeletePoolOutput) SetStatus

func (s *DeletePoolOutput) SetStatus(v string) *DeletePoolOutput

SetStatus sets the Status field's value.

func (*DeletePoolOutput) SetTwoWayChannelArn

func (s *DeletePoolOutput) SetTwoWayChannelArn(v string) *DeletePoolOutput

SetTwoWayChannelArn sets the TwoWayChannelArn field's value.

func (*DeletePoolOutput) SetTwoWayEnabled

func (s *DeletePoolOutput) SetTwoWayEnabled(v bool) *DeletePoolOutput

SetTwoWayEnabled sets the TwoWayEnabled field's value.

func (DeletePoolOutput) String

func (s DeletePoolOutput) String() string

String returns the string representation.

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

type DeleteTextMessageSpendLimitOverrideInput

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

func (DeleteTextMessageSpendLimitOverrideInput) GoString

GoString returns the string representation.

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

func (DeleteTextMessageSpendLimitOverrideInput) String

String returns the string representation.

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

type DeleteTextMessageSpendLimitOverrideOutput

type DeleteTextMessageSpendLimitOverrideOutput struct {

	// The current monthly limit, in US dollars.
	MonthlyLimit *int64 `type:"long"`
	// contains filtered or unexported fields
}

func (DeleteTextMessageSpendLimitOverrideOutput) GoString

GoString returns the string representation.

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

func (*DeleteTextMessageSpendLimitOverrideOutput) SetMonthlyLimit

SetMonthlyLimit sets the MonthlyLimit field's value.

func (DeleteTextMessageSpendLimitOverrideOutput) String

String returns the string representation.

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

type DeleteVoiceMessageSpendLimitOverrideInput

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

func (DeleteVoiceMessageSpendLimitOverrideInput) GoString

GoString returns the string representation.

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

func (DeleteVoiceMessageSpendLimitOverrideInput) String

String returns the string representation.

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

type DeleteVoiceMessageSpendLimitOverrideOutput

type DeleteVoiceMessageSpendLimitOverrideOutput struct {

	// The current monthly limit, in US dollars.
	MonthlyLimit *int64 `type:"long"`
	// contains filtered or unexported fields
}

func (DeleteVoiceMessageSpendLimitOverrideOutput) GoString

GoString returns the string representation.

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

func (*DeleteVoiceMessageSpendLimitOverrideOutput) SetMonthlyLimit

SetMonthlyLimit sets the MonthlyLimit field's value.

func (DeleteVoiceMessageSpendLimitOverrideOutput) String

String returns the string representation.

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

type DescribeAccountAttributesInput

type DescribeAccountAttributesInput struct {

	// The maximum number of results to return per each request.
	MaxResults *int64 `min:"1" type:"integer"`

	// The token to be used for the next set of paginated results. You don't need
	// to supply a value for this field in the initial request.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeAccountAttributesInput) GoString

GoString returns the string representation.

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

func (*DescribeAccountAttributesInput) SetMaxResults

SetMaxResults sets the MaxResults field's value.

func (*DescribeAccountAttributesInput) SetNextToken

SetNextToken sets the NextToken field's value.

func (DescribeAccountAttributesInput) String

String returns the string representation.

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

func (*DescribeAccountAttributesInput) Validate

func (s *DescribeAccountAttributesInput) Validate() error

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

type DescribeAccountAttributesOutput

type DescribeAccountAttributesOutput struct {

	// An array of AccountAttributes objects.
	AccountAttributes []*AccountAttribute `type:"list"`

	// The token to be used for the next set of paginated results. If this field
	// is empty then there are no more results.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeAccountAttributesOutput) GoString

GoString returns the string representation.

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

func (*DescribeAccountAttributesOutput) SetAccountAttributes

SetAccountAttributes sets the AccountAttributes field's value.

func (*DescribeAccountAttributesOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (DescribeAccountAttributesOutput) String

String returns the string representation.

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

type DescribeAccountLimitsInput

type DescribeAccountLimitsInput struct {

	// The maximum number of results to return per each request.
	MaxResults *int64 `min:"1" type:"integer"`

	// The token to be used for the next set of paginated results. You don't need
	// to supply a value for this field in the initial request.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeAccountLimitsInput) GoString

func (s DescribeAccountLimitsInput) GoString() string

GoString returns the string representation.

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

func (*DescribeAccountLimitsInput) SetMaxResults

SetMaxResults sets the MaxResults field's value.

func (*DescribeAccountLimitsInput) SetNextToken

SetNextToken sets the NextToken field's value.

func (DescribeAccountLimitsInput) String

String returns the string representation.

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

func (*DescribeAccountLimitsInput) Validate

func (s *DescribeAccountLimitsInput) Validate() error

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

type DescribeAccountLimitsOutput

type DescribeAccountLimitsOutput struct {

	// An array of AccountLimit objects that show the current spend limits.
	AccountLimits []*AccountLimit `type:"list"`

	// The token to be used for the next set of paginated results. If this field
	// is empty then there are no more results.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeAccountLimitsOutput) GoString

func (s DescribeAccountLimitsOutput) GoString() string

GoString returns the string representation.

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

func (*DescribeAccountLimitsOutput) SetAccountLimits

SetAccountLimits sets the AccountLimits field's value.

func (*DescribeAccountLimitsOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (DescribeAccountLimitsOutput) String

String returns the string representation.

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

type DescribeConfigurationSetsInput

type DescribeConfigurationSetsInput struct {

	// An array of strings. Each element can be either a ConfigurationSetName or
	// ConfigurationSetArn.
	ConfigurationSetNames []*string `type:"list"`

	// An array of filters to apply to the results that are returned.
	Filters []*ConfigurationSetFilter `type:"list"`

	// The maximum number of results to return per each request.
	MaxResults *int64 `min:"1" type:"integer"`

	// The token to be used for the next set of paginated results. You don't need
	// to supply a value for this field in the initial request.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeConfigurationSetsInput) GoString

GoString returns the string representation.

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

func (*DescribeConfigurationSetsInput) SetConfigurationSetNames

func (s *DescribeConfigurationSetsInput) SetConfigurationSetNames(v []*string) *DescribeConfigurationSetsInput

SetConfigurationSetNames sets the ConfigurationSetNames field's value.

func (*DescribeConfigurationSetsInput) SetFilters

SetFilters sets the Filters field's value.

func (*DescribeConfigurationSetsInput) SetMaxResults

SetMaxResults sets the MaxResults field's value.

func (*DescribeConfigurationSetsInput) SetNextToken

SetNextToken sets the NextToken field's value.

func (DescribeConfigurationSetsInput) String

String returns the string representation.

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

func (*DescribeConfigurationSetsInput) Validate

func (s *DescribeConfigurationSetsInput) Validate() error

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

type DescribeConfigurationSetsOutput

type DescribeConfigurationSetsOutput struct {

	// An array of ConfigurationSets objects.
	ConfigurationSets []*ConfigurationSetInformation `type:"list"`

	// The token to be used for the next set of paginated results. If this field
	// is empty then there are no more results.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeConfigurationSetsOutput) GoString

GoString returns the string representation.

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

func (*DescribeConfigurationSetsOutput) SetConfigurationSets

SetConfigurationSets sets the ConfigurationSets field's value.

func (*DescribeConfigurationSetsOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (DescribeConfigurationSetsOutput) String

String returns the string representation.

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

type DescribeKeywordsInput

type DescribeKeywordsInput struct {

	// An array of keyword filters to filter the results.
	Filters []*KeywordFilter `type:"list"`

	// An array of keywords to search for.
	Keywords []*string `type:"list"`

	// The maximum number of results to return per each request.
	MaxResults *int64 `min:"1" type:"integer"`

	// The token to be used for the next set of paginated results. You don't need
	// to supply a value for this field in the initial request.
	NextToken *string `min:"1" type:"string"`

	// The origination identity to use such as a PhoneNumberId, PhoneNumberArn,
	// SenderId or SenderIdArn. You can use DescribePhoneNumbers to find the values
	// for PhoneNumberId and PhoneNumberArn while DescribeSenderIds can be used
	// to get the values for SenderId and SenderIdArn.
	//
	// OriginationIdentity is a required field
	OriginationIdentity *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeKeywordsInput) GoString

func (s DescribeKeywordsInput) GoString() string

GoString returns the string representation.

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

func (*DescribeKeywordsInput) SetFilters

SetFilters sets the Filters field's value.

func (*DescribeKeywordsInput) SetKeywords

func (s *DescribeKeywordsInput) SetKeywords(v []*string) *DescribeKeywordsInput

SetKeywords sets the Keywords field's value.

func (*DescribeKeywordsInput) SetMaxResults

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

SetMaxResults sets the MaxResults field's value.

func (*DescribeKeywordsInput) SetNextToken

SetNextToken sets the NextToken field's value.

func (*DescribeKeywordsInput) SetOriginationIdentity

func (s *DescribeKeywordsInput) SetOriginationIdentity(v string) *DescribeKeywordsInput

SetOriginationIdentity sets the OriginationIdentity field's value.

func (DescribeKeywordsInput) String

func (s DescribeKeywordsInput) String() string

String returns the string representation.

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

func (*DescribeKeywordsInput) Validate

func (s *DescribeKeywordsInput) Validate() error

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

type DescribeKeywordsOutput

type DescribeKeywordsOutput struct {

	// An array of KeywordInformation objects that contain the results.
	Keywords []*KeywordInformation `type:"list"`

	// The token to be used for the next set of paginated results. If this field
	// is empty then there are no more results.
	NextToken *string `min:"1" type:"string"`

	// The PhoneNumberId or PoolId that is associated with the OriginationIdentity.
	OriginationIdentity *string `type:"string"`

	// The PhoneNumberArn or PoolArn that is associated with the OriginationIdentity.
	OriginationIdentityArn *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeKeywordsOutput) GoString

func (s DescribeKeywordsOutput) GoString() string

GoString returns the string representation.

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

func (*DescribeKeywordsOutput) SetKeywords

SetKeywords sets the Keywords field's value.

func (*DescribeKeywordsOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (*DescribeKeywordsOutput) SetOriginationIdentity

func (s *DescribeKeywordsOutput) SetOriginationIdentity(v string) *DescribeKeywordsOutput

SetOriginationIdentity sets the OriginationIdentity field's value.

func (*DescribeKeywordsOutput) SetOriginationIdentityArn

func (s *DescribeKeywordsOutput) SetOriginationIdentityArn(v string) *DescribeKeywordsOutput

SetOriginationIdentityArn sets the OriginationIdentityArn field's value.

func (DescribeKeywordsOutput) String

func (s DescribeKeywordsOutput) String() string

String returns the string representation.

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

type DescribeOptOutListsInput

type DescribeOptOutListsInput struct {

	// The maximum number of results to return per each request.
	MaxResults *int64 `min:"1" type:"integer"`

	// The token to be used for the next set of paginated results. You don't need
	// to supply a value for this field in the initial request.
	NextToken *string `min:"1" type:"string"`

	// The OptOutLists to show the details of. This is an array of strings that
	// can be either the OptOutListName or OptOutListArn.
	OptOutListNames []*string `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeOptOutListsInput) GoString

func (s DescribeOptOutListsInput) GoString() string

GoString returns the string representation.

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

func (*DescribeOptOutListsInput) SetMaxResults

SetMaxResults sets the MaxResults field's value.

func (*DescribeOptOutListsInput) SetNextToken

SetNextToken sets the NextToken field's value.

func (*DescribeOptOutListsInput) SetOptOutListNames

func (s *DescribeOptOutListsInput) SetOptOutListNames(v []*string) *DescribeOptOutListsInput

SetOptOutListNames sets the OptOutListNames field's value.

func (DescribeOptOutListsInput) String

func (s DescribeOptOutListsInput) String() string

String returns the string representation.

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

func (*DescribeOptOutListsInput) Validate

func (s *DescribeOptOutListsInput) Validate() error

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

type DescribeOptOutListsOutput

type DescribeOptOutListsOutput struct {

	// The token to be used for the next set of paginated results. If this field
	// is empty then there are no more results.
	NextToken *string `min:"1" type:"string"`

	// An array of OptOutListInformation objects that contain the details for the
	// requested OptOutLists.
	OptOutLists []*OptOutListInformation `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeOptOutListsOutput) GoString

func (s DescribeOptOutListsOutput) GoString() string

GoString returns the string representation.

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

func (*DescribeOptOutListsOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (*DescribeOptOutListsOutput) SetOptOutLists

SetOptOutLists sets the OptOutLists field's value.

func (DescribeOptOutListsOutput) String

func (s DescribeOptOutListsOutput) String() string

String returns the string representation.

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

type DescribeOptedOutNumbersInput

type DescribeOptedOutNumbersInput struct {

	// An array of OptedOutFilter objects to filter the results on.
	Filters []*OptedOutFilter `type:"list"`

	// The maximum number of results to return per each request.
	MaxResults *int64 `min:"1" type:"integer"`

	// The token to be used for the next set of paginated results. You don't need
	// to supply a value for this field in the initial request.
	NextToken *string `min:"1" type:"string"`

	// The OptOutListName or OptOutListArn of the OptOutList. You can use DescribeOptOutLists
	// to find the values for OptOutListName and OptOutListArn.
	//
	// OptOutListName is a required field
	OptOutListName *string `min:"1" type:"string" required:"true"`

	// An array of phone numbers to search for in the OptOutList.
	OptedOutNumbers []*string `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeOptedOutNumbersInput) GoString

func (s DescribeOptedOutNumbersInput) GoString() string

GoString returns the string representation.

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

func (*DescribeOptedOutNumbersInput) SetFilters

SetFilters sets the Filters field's value.

func (*DescribeOptedOutNumbersInput) SetMaxResults

SetMaxResults sets the MaxResults field's value.

func (*DescribeOptedOutNumbersInput) SetNextToken

SetNextToken sets the NextToken field's value.

func (*DescribeOptedOutNumbersInput) SetOptOutListName

SetOptOutListName sets the OptOutListName field's value.

func (*DescribeOptedOutNumbersInput) SetOptedOutNumbers

SetOptedOutNumbers sets the OptedOutNumbers field's value.

func (DescribeOptedOutNumbersInput) String

String returns the string representation.

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

func (*DescribeOptedOutNumbersInput) Validate

func (s *DescribeOptedOutNumbersInput) Validate() error

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

type DescribeOptedOutNumbersOutput

type DescribeOptedOutNumbersOutput struct {

	// The token to be used for the next set of paginated results. If this field
	// is empty then there are no more results.
	NextToken *string `min:"1" type:"string"`

	// The Amazon Resource Name (ARN) of the OptOutList.
	OptOutListArn *string `type:"string"`

	// The name of the OptOutList.
	OptOutListName *string `min:"1" type:"string"`

	// An array of OptedOutNumbersInformation objects that provide information about
	// the requested OptedOutNumbers.
	OptedOutNumbers []*OptedOutNumberInformation `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeOptedOutNumbersOutput) GoString

GoString returns the string representation.

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

func (*DescribeOptedOutNumbersOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (*DescribeOptedOutNumbersOutput) SetOptOutListArn

SetOptOutListArn sets the OptOutListArn field's value.

func (*DescribeOptedOutNumbersOutput) SetOptOutListName

SetOptOutListName sets the OptOutListName field's value.

func (*DescribeOptedOutNumbersOutput) SetOptedOutNumbers

SetOptedOutNumbers sets the OptedOutNumbers field's value.

func (DescribeOptedOutNumbersOutput) String

String returns the string representation.

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

type DescribePhoneNumbersInput

type DescribePhoneNumbersInput struct {

	// An array of PhoneNumberFilter objects to filter the results.
	Filters []*PhoneNumberFilter `type:"list"`

	// The maximum number of results to return per each request.
	MaxResults *int64 `min:"1" type:"integer"`

	// The token to be used for the next set of paginated results. You don't need
	// to supply a value for this field in the initial request.
	NextToken *string `min:"1" type:"string"`

	// The unique identifier of phone numbers to find information about. This is
	// an array of strings that can be either the PhoneNumberId or PhoneNumberArn.
	PhoneNumberIds []*string `type:"list"`
	// contains filtered or unexported fields
}

func (DescribePhoneNumbersInput) GoString

func (s DescribePhoneNumbersInput) GoString() string

GoString returns the string representation.

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

func (*DescribePhoneNumbersInput) SetFilters

SetFilters sets the Filters field's value.

func (*DescribePhoneNumbersInput) SetMaxResults

SetMaxResults sets the MaxResults field's value.

func (*DescribePhoneNumbersInput) SetNextToken

SetNextToken sets the NextToken field's value.

func (*DescribePhoneNumbersInput) SetPhoneNumberIds

func (s *DescribePhoneNumbersInput) SetPhoneNumberIds(v []*string) *DescribePhoneNumbersInput

SetPhoneNumberIds sets the PhoneNumberIds field's value.

func (DescribePhoneNumbersInput) String

func (s DescribePhoneNumbersInput) String() string

String returns the string representation.

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

func (*DescribePhoneNumbersInput) Validate

func (s *DescribePhoneNumbersInput) Validate() error

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

type DescribePhoneNumbersOutput

type DescribePhoneNumbersOutput struct {

	// The token to be used for the next set of paginated results. If this field
	// is empty then there are no more results.
	NextToken *string `min:"1" type:"string"`

	// An array of PhoneNumberInformation objects that contain the details for the
	// requested phone numbers.
	PhoneNumbers []*PhoneNumberInformation `type:"list"`
	// contains filtered or unexported fields
}

func (DescribePhoneNumbersOutput) GoString

func (s DescribePhoneNumbersOutput) GoString() string

GoString returns the string representation.

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

func (*DescribePhoneNumbersOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (*DescribePhoneNumbersOutput) SetPhoneNumbers

SetPhoneNumbers sets the PhoneNumbers field's value.

func (DescribePhoneNumbersOutput) String

String returns the string representation.

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

type DescribePoolsInput

type DescribePoolsInput struct {

	// An array of PoolFilter objects to filter the results.
	Filters []*PoolFilter `type:"list"`

	// The maximum number of results to return per each request.
	MaxResults *int64 `min:"1" type:"integer"`

	// The token to be used for the next set of paginated results. You don't need
	// to supply a value for this field in the initial request.
	NextToken *string `min:"1" type:"string"`

	// The unique identifier of pools to find. This is an array of strings that
	// can be either the PoolId or PoolArn.
	PoolIds []*string `type:"list"`
	// contains filtered or unexported fields
}

func (DescribePoolsInput) GoString

func (s DescribePoolsInput) GoString() string

GoString returns the string representation.

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

func (*DescribePoolsInput) SetFilters

func (s *DescribePoolsInput) SetFilters(v []*PoolFilter) *DescribePoolsInput

SetFilters sets the Filters field's value.

func (*DescribePoolsInput) SetMaxResults

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

SetMaxResults sets the MaxResults field's value.

func (*DescribePoolsInput) SetNextToken

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

SetNextToken sets the NextToken field's value.

func (*DescribePoolsInput) SetPoolIds

func (s *DescribePoolsInput) SetPoolIds(v []*string) *DescribePoolsInput

SetPoolIds sets the PoolIds field's value.

func (DescribePoolsInput) String

func (s DescribePoolsInput) String() string

String returns the string representation.

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

func (*DescribePoolsInput) Validate

func (s *DescribePoolsInput) Validate() error

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

type DescribePoolsOutput

type DescribePoolsOutput struct {

	// The token to be used for the next set of paginated results. If this field
	// is empty then there are no more results.
	NextToken *string `min:"1" type:"string"`

	// An array of PoolInformation objects that contain the details for the requested
	// pools.
	Pools []*PoolInformation `type:"list"`
	// contains filtered or unexported fields
}

func (DescribePoolsOutput) GoString

func (s DescribePoolsOutput) GoString() string

GoString returns the string representation.

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

func (*DescribePoolsOutput) SetNextToken

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

SetNextToken sets the NextToken field's value.

func (*DescribePoolsOutput) SetPools

SetPools sets the Pools field's value.

func (DescribePoolsOutput) String

func (s DescribePoolsOutput) String() string

String returns the string representation.

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

type DescribeSenderIdsInput

type DescribeSenderIdsInput struct {

	// An array of SenderIdFilter objects to filter the results.
	Filters []*SenderIdFilter `type:"list"`

	// The maximum number of results to return per each request.
	MaxResults *int64 `min:"1" type:"integer"`

	// The token to be used for the next set of paginated results. You don't need
	// to supply a value for this field in the initial request.
	NextToken *string `min:"1" type:"string"`

	// An array of SenderIdAndCountry objects to search for.
	SenderIds []*SenderIdAndCountry `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeSenderIdsInput) GoString

func (s DescribeSenderIdsInput) GoString() string

GoString returns the string representation.

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

func (*DescribeSenderIdsInput) SetFilters

SetFilters sets the Filters field's value.

func (*DescribeSenderIdsInput) SetMaxResults

SetMaxResults sets the MaxResults field's value.

func (*DescribeSenderIdsInput) SetNextToken

SetNextToken sets the NextToken field's value.

func (*DescribeSenderIdsInput) SetSenderIds

SetSenderIds sets the SenderIds field's value.

func (DescribeSenderIdsInput) String

func (s DescribeSenderIdsInput) String() string

String returns the string representation.

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

func (*DescribeSenderIdsInput) Validate

func (s *DescribeSenderIdsInput) Validate() error

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

type DescribeSenderIdsOutput

type DescribeSenderIdsOutput struct {

	// The token to be used for the next set of paginated results. If this field
	// is empty then there are no more results.
	NextToken *string `min:"1" type:"string"`

	// An array of SernderIdInformation objects that contain the details for the
	// requested SenderIds.
	SenderIds []*SenderIdInformation `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeSenderIdsOutput) GoString

func (s DescribeSenderIdsOutput) GoString() string

GoString returns the string representation.

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

func (*DescribeSenderIdsOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (*DescribeSenderIdsOutput) SetSenderIds

SetSenderIds sets the SenderIds field's value.

func (DescribeSenderIdsOutput) String

func (s DescribeSenderIdsOutput) String() string

String returns the string representation.

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

type DescribeSpendLimitsInput

type DescribeSpendLimitsInput struct {

	// The maximum number of results to return per each request.
	MaxResults *int64 `min:"1" type:"integer"`

	// The token to be used for the next set of paginated results. You don't need
	// to supply a value for this field in the initial request.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeSpendLimitsInput) GoString

func (s DescribeSpendLimitsInput) GoString() string

GoString returns the string representation.

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

func (*DescribeSpendLimitsInput) SetMaxResults

SetMaxResults sets the MaxResults field's value.

func (*DescribeSpendLimitsInput) SetNextToken

SetNextToken sets the NextToken field's value.

func (DescribeSpendLimitsInput) String

func (s DescribeSpendLimitsInput) String() string

String returns the string representation.

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

func (*DescribeSpendLimitsInput) Validate

func (s *DescribeSpendLimitsInput) Validate() error

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

type DescribeSpendLimitsOutput

type DescribeSpendLimitsOutput struct {

	// The token to be used for the next set of paginated results. If this field
	// is empty then there are no more results.
	NextToken *string `min:"1" type:"string"`

	// An array of SpendLimit objects that contain the details for the requested
	// spend limits.
	SpendLimits []*SpendLimit `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeSpendLimitsOutput) GoString

func (s DescribeSpendLimitsOutput) GoString() string

GoString returns the string representation.

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

func (*DescribeSpendLimitsOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (*DescribeSpendLimitsOutput) SetSpendLimits

SetSpendLimits sets the SpendLimits field's value.

func (DescribeSpendLimitsOutput) String

func (s DescribeSpendLimitsOutput) String() string

String returns the string representation.

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

type DisassociateOriginationIdentityInput

type DisassociateOriginationIdentityInput struct {

	// Unique, case-sensitive identifier you provide to ensure the idempotency of
	// the request. If you don't specify a client token, a randomly generated token
	// is used for the request to ensure idempotency.
	ClientToken *string `min:"1" type:"string" idempotencyToken:"true"`

	// The two-character code, in ISO 3166-1 alpha-2 format, for the country or
	// region.
	//
	// IsoCountryCode is a required field
	IsoCountryCode *string `min:"2" type:"string" required:"true"`

	// The origination identity to use such as a PhoneNumberId, PhoneNumberArn,
	// SenderId or SenderIdArn. You can use DescribePhoneNumbers find the values
	// for PhoneNumberId and PhoneNumberArn, or use DescribeSenderIds to get the
	// values for SenderId and SenderIdArn.
	//
	// OriginationIdentity is a required field
	OriginationIdentity *string `min:"1" type:"string" required:"true"`

	// The unique identifier for the pool to disassociate with the origination identity.
	// This value can be either the PoolId or PoolArn.
	//
	// PoolId is a required field
	PoolId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DisassociateOriginationIdentityInput) GoString

GoString returns the string representation.

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

func (*DisassociateOriginationIdentityInput) SetClientToken

SetClientToken sets the ClientToken field's value.

func (*DisassociateOriginationIdentityInput) SetIsoCountryCode

SetIsoCountryCode sets the IsoCountryCode field's value.

func (*DisassociateOriginationIdentityInput) SetOriginationIdentity

SetOriginationIdentity sets the OriginationIdentity field's value.

func (*DisassociateOriginationIdentityInput) SetPoolId

SetPoolId sets the PoolId field's value.

func (DisassociateOriginationIdentityInput) String

String returns the string representation.

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

func (*DisassociateOriginationIdentityInput) Validate

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

type DisassociateOriginationIdentityOutput

type DisassociateOriginationIdentityOutput struct {

	// The two-character code, in ISO 3166-1 alpha-2 format, for the country or
	// region.
	IsoCountryCode *string `min:"2" type:"string"`

	// The PhoneNumberId or SenderId of the origination identity.
	OriginationIdentity *string `type:"string"`

	// The PhoneNumberArn or SenderIdArn of the origination identity.
	OriginationIdentityArn *string `type:"string"`

	// The Amazon Resource Name (ARN) of the pool.
	PoolArn *string `type:"string"`

	// The PoolId of the pool no longer associated with the origination identity.
	PoolId *string `type:"string"`
	// contains filtered or unexported fields
}

func (DisassociateOriginationIdentityOutput) GoString

GoString returns the string representation.

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

func (*DisassociateOriginationIdentityOutput) SetIsoCountryCode

SetIsoCountryCode sets the IsoCountryCode field's value.

func (*DisassociateOriginationIdentityOutput) SetOriginationIdentity

SetOriginationIdentity sets the OriginationIdentity field's value.

func (*DisassociateOriginationIdentityOutput) SetOriginationIdentityArn

SetOriginationIdentityArn sets the OriginationIdentityArn field's value.

func (*DisassociateOriginationIdentityOutput) SetPoolArn

SetPoolArn sets the PoolArn field's value.

func (*DisassociateOriginationIdentityOutput) SetPoolId

SetPoolId sets the PoolId field's value.

func (DisassociateOriginationIdentityOutput) String

String returns the string representation.

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

type EventDestination

type EventDestination struct {

	// An object that contains information about an event destination that sends
	// logging events to Amazon CloudWatch logs.
	CloudWatchLogsDestination *CloudWatchLogsDestination `type:"structure"`

	// When set to true events will be logged.
	//
	// Enabled is a required field
	Enabled *bool `type:"boolean" required:"true"`

	// The name of the EventDestination.
	//
	// EventDestinationName is a required field
	EventDestinationName *string `min:"1" type:"string" required:"true"`

	// An object that contains information about an event destination for logging
	// to Amazon Kinesis Data Firehose.
	KinesisFirehoseDestination *KinesisFirehoseDestination `type:"structure"`

	// An array of event types that determine which events to log.
	//
	// MatchingEventTypes is a required field
	MatchingEventTypes []*string `min:"1" type:"list" required:"true" enum:"EventType"`

	// An object that contains information about an event destination that sends
	// logging events to Amazon SNS.
	SnsDestination *SnsDestination `type:"structure"`
	// 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 Amazon CloudWatch, Amazon Kinesis Data Firehose, or Amazon SNS.

func (EventDestination) GoString

func (s EventDestination) GoString() string

GoString returns the string representation.

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

func (*EventDestination) SetCloudWatchLogsDestination

func (s *EventDestination) SetCloudWatchLogsDestination(v *CloudWatchLogsDestination) *EventDestination

SetCloudWatchLogsDestination sets the CloudWatchLogsDestination field's value.

func (*EventDestination) SetEnabled

func (s *EventDestination) SetEnabled(v bool) *EventDestination

SetEnabled sets the Enabled field's value.

func (*EventDestination) SetEventDestinationName

func (s *EventDestination) SetEventDestinationName(v string) *EventDestination

SetEventDestinationName sets the EventDestinationName field's value.

func (*EventDestination) SetKinesisFirehoseDestination

func (s *EventDestination) SetKinesisFirehoseDestination(v *KinesisFirehoseDestination) *EventDestination

SetKinesisFirehoseDestination sets the KinesisFirehoseDestination field's value.

func (*EventDestination) SetMatchingEventTypes

func (s *EventDestination) SetMatchingEventTypes(v []*string) *EventDestination

SetMatchingEventTypes sets the MatchingEventTypes field's value.

func (*EventDestination) SetSnsDestination

func (s *EventDestination) SetSnsDestination(v *SnsDestination) *EventDestination

SetSnsDestination sets the SnsDestination field's value.

func (EventDestination) String

func (s EventDestination) String() string

String returns the string representation.

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

type InternalServerException

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

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

	// The unique identifier of the request.
	RequestId *string `type:"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) Code

func (s *InternalServerException) Code() string

Code returns the exception type name.

func (*InternalServerException) Error

func (s *InternalServerException) Error() string

func (InternalServerException) GoString

func (s InternalServerException) GoString() string

GoString returns the string representation.

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

func (*InternalServerException) Message

func (s *InternalServerException) Message() string

Message returns the exception's message.

func (*InternalServerException) OrigErr

func (s *InternalServerException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalServerException) RequestID

func (s *InternalServerException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalServerException) StatusCode

func (s *InternalServerException) StatusCode() int

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

func (InternalServerException) String

func (s InternalServerException) String() string

String returns the string representation.

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

type KeywordFilter

type KeywordFilter struct {

	// The name of the attribute to filter on.
	//
	// Name is a required field
	Name *string `type:"string" required:"true" enum:"KeywordFilterName"`

	// An array values to filter for.
	//
	// Values is a required field
	Values []*string `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

The information for keywords that meet a specified criteria.

func (KeywordFilter) GoString

func (s KeywordFilter) GoString() string

GoString returns the string representation.

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

func (*KeywordFilter) SetName

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

SetName sets the Name field's value.

func (*KeywordFilter) SetValues

func (s *KeywordFilter) SetValues(v []*string) *KeywordFilter

SetValues sets the Values field's value.

func (KeywordFilter) String

func (s KeywordFilter) String() string

String returns the string representation.

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

func (*KeywordFilter) Validate

func (s *KeywordFilter) Validate() error

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

type KeywordInformation

type KeywordInformation struct {

	// The keyword as a string.
	//
	// Keyword is a required field
	Keyword *string `min:"1" type:"string" required:"true"`

	// The action to perform for the keyword.
	//
	// KeywordAction is a required field
	KeywordAction *string `type:"string" required:"true" enum:"KeywordAction"`

	// A custom message that can be used with the keyword.
	//
	// KeywordMessage is a required field
	KeywordMessage *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The information for all keywords in a pool.

func (KeywordInformation) GoString

func (s KeywordInformation) GoString() string

GoString returns the string representation.

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

func (*KeywordInformation) SetKeyword

func (s *KeywordInformation) SetKeyword(v string) *KeywordInformation

SetKeyword sets the Keyword field's value.

func (*KeywordInformation) SetKeywordAction

func (s *KeywordInformation) SetKeywordAction(v string) *KeywordInformation

SetKeywordAction sets the KeywordAction field's value.

func (*KeywordInformation) SetKeywordMessage

func (s *KeywordInformation) SetKeywordMessage(v string) *KeywordInformation

SetKeywordMessage sets the KeywordMessage field's value.

func (KeywordInformation) String

func (s KeywordInformation) String() string

String returns the string representation.

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

type KinesisFirehoseDestination

type KinesisFirehoseDestination struct {

	// The Amazon Resource Name (ARN) of the delivery stream.
	//
	// DeliveryStreamArn is a required field
	DeliveryStreamArn *string `min:"20" type:"string" required:"true"`

	// The ARN of an Amazon Identity and Access Management (IAM) role that is able
	// to write event data to an Amazon Firehose destination.
	//
	// IamRoleArn is a required field
	IamRoleArn *string `min:"20" type:"string" required:"true"`
	// 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 an 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.

func (KinesisFirehoseDestination) GoString

func (s KinesisFirehoseDestination) GoString() string

GoString returns the string representation.

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

func (*KinesisFirehoseDestination) SetDeliveryStreamArn

func (s *KinesisFirehoseDestination) SetDeliveryStreamArn(v string) *KinesisFirehoseDestination

SetDeliveryStreamArn sets the DeliveryStreamArn field's value.

func (*KinesisFirehoseDestination) SetIamRoleArn

SetIamRoleArn sets the IamRoleArn field's value.

func (KinesisFirehoseDestination) String

String returns the string representation.

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

func (*KinesisFirehoseDestination) Validate

func (s *KinesisFirehoseDestination) Validate() error

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

type ListPoolOriginationIdentitiesInput

type ListPoolOriginationIdentitiesInput struct {

	// An array of PoolOriginationIdentitiesFilter objects to filter the results..
	Filters []*PoolOriginationIdentitiesFilter `type:"list"`

	// The maximum number of results to return per each request.
	MaxResults *int64 `min:"1" type:"integer"`

	// The token to be used for the next set of paginated results. You don't need
	// to supply a value for this field in the initial request.
	NextToken *string `min:"1" type:"string"`

	// The unique identifier for the pool. This value can be either the PoolId or
	// PoolArn.
	//
	// PoolId is a required field
	PoolId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListPoolOriginationIdentitiesInput) GoString

GoString returns the string representation.

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

func (*ListPoolOriginationIdentitiesInput) SetFilters

SetFilters sets the Filters field's value.

func (*ListPoolOriginationIdentitiesInput) SetMaxResults

SetMaxResults sets the MaxResults field's value.

func (*ListPoolOriginationIdentitiesInput) SetNextToken

SetNextToken sets the NextToken field's value.

func (*ListPoolOriginationIdentitiesInput) SetPoolId

SetPoolId sets the PoolId field's value.

func (ListPoolOriginationIdentitiesInput) String

String returns the string representation.

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

func (*ListPoolOriginationIdentitiesInput) Validate

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

type ListPoolOriginationIdentitiesOutput

type ListPoolOriginationIdentitiesOutput struct {

	// The token to be used for the next set of paginated results. If this field
	// is empty then there are no more results.
	NextToken *string `min:"1" type:"string"`

	// An array of any OriginationIdentityMetadata objects.
	OriginationIdentities []*OriginationIdentityMetadata `type:"list"`

	// The Amazon Resource Name (ARN) for the pool.
	PoolArn *string `type:"string"`

	// The unique PoolId of the pool.
	PoolId *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListPoolOriginationIdentitiesOutput) GoString

GoString returns the string representation.

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

func (*ListPoolOriginationIdentitiesOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (*ListPoolOriginationIdentitiesOutput) SetOriginationIdentities

SetOriginationIdentities sets the OriginationIdentities field's value.

func (*ListPoolOriginationIdentitiesOutput) SetPoolArn

SetPoolArn sets the PoolArn field's value.

func (*ListPoolOriginationIdentitiesOutput) SetPoolId

SetPoolId sets the PoolId field's value.

func (ListPoolOriginationIdentitiesOutput) String

String returns the string representation.

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

type ListTagsForResourceInput

type ListTagsForResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource to query for.
	//
	// ResourceArn is a required field
	ResourceArn *string `min:"20" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceInput) GoString

func (s ListTagsForResourceInput) GoString() string

GoString returns the string representation.

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

func (*ListTagsForResourceInput) SetResourceArn

SetResourceArn sets the ResourceArn field's value.

func (ListTagsForResourceInput) String

func (s ListTagsForResourceInput) String() string

String returns the string representation.

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

func (*ListTagsForResourceInput) Validate

func (s *ListTagsForResourceInput) Validate() error

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

type ListTagsForResourceOutput

type ListTagsForResourceOutput struct {

	// The ARN of the resource.
	ResourceArn *string `min:"20" type:"string"`

	// An array of key and value pair tags that are associated with the resource.
	Tags []*Tag `type:"list"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceOutput) GoString

func (s ListTagsForResourceOutput) GoString() string

GoString returns the string representation.

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

func (*ListTagsForResourceOutput) SetResourceArn

SetResourceArn sets the ResourceArn field's value.

func (*ListTagsForResourceOutput) SetTags

SetTags sets the Tags field's value.

func (ListTagsForResourceOutput) String

func (s ListTagsForResourceOutput) String() string

String returns the string representation.

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

type OptOutListInformation

type OptOutListInformation struct {

	// The time when the OutOutList was created, in UNIX epoch time (https://www.epochconverter.com/)
	// format.
	//
	// CreatedTimestamp is a required field
	CreatedTimestamp *time.Time `type:"timestamp" required:"true"`

	// The Amazon Resource Name (ARN) of the OptOutList.
	//
	// OptOutListArn is a required field
	OptOutListArn *string `type:"string" required:"true"`

	// The name of the OptOutList.
	//
	// OptOutListName is a required field
	OptOutListName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The information for all OptOutList in an Amazon Web Services account.

func (OptOutListInformation) GoString

func (s OptOutListInformation) GoString() string

GoString returns the string representation.

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

func (*OptOutListInformation) SetCreatedTimestamp

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

SetCreatedTimestamp sets the CreatedTimestamp field's value.

func (*OptOutListInformation) SetOptOutListArn

func (s *OptOutListInformation) SetOptOutListArn(v string) *OptOutListInformation

SetOptOutListArn sets the OptOutListArn field's value.

func (*OptOutListInformation) SetOptOutListName

func (s *OptOutListInformation) SetOptOutListName(v string) *OptOutListInformation

SetOptOutListName sets the OptOutListName field's value.

func (OptOutListInformation) String

func (s OptOutListInformation) String() string

String returns the string representation.

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

type OptedOutFilter

type OptedOutFilter struct {

	// The name of the attribute to filter on.
	//
	// Name is a required field
	Name *string `type:"string" required:"true" enum:"OptedOutFilterName"`

	// An array of values to filter for.
	//
	// Values is a required field
	Values []*string `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

The information for opted out numbers that meet a specified criteria.

func (OptedOutFilter) GoString

func (s OptedOutFilter) GoString() string

GoString returns the string representation.

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

func (*OptedOutFilter) SetName

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

SetName sets the Name field's value.

func (*OptedOutFilter) SetValues

func (s *OptedOutFilter) SetValues(v []*string) *OptedOutFilter

SetValues sets the Values field's value.

func (OptedOutFilter) String

func (s OptedOutFilter) String() string

String returns the string representation.

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

func (*OptedOutFilter) Validate

func (s *OptedOutFilter) Validate() error

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

type OptedOutNumberInformation

type OptedOutNumberInformation struct {

	// This is set to true if it was the end recipient that opted out.
	//
	// EndUserOptedOut is a required field
	EndUserOptedOut *bool `type:"boolean" required:"true"`

	// The phone number that is opted out.
	//
	// OptedOutNumber is a required field
	OptedOutNumber *string `min:"1" type:"string" required:"true"`

	// The time that the op tout occurred, in UNIX epoch time (https://www.epochconverter.com/)
	// format.
	//
	// OptedOutTimestamp is a required field
	OptedOutTimestamp *time.Time `type:"timestamp" required:"true"`
	// contains filtered or unexported fields
}

The information for an opted out number in an Amazon Web Services account.

func (OptedOutNumberInformation) GoString

func (s OptedOutNumberInformation) GoString() string

GoString returns the string representation.

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

func (*OptedOutNumberInformation) SetEndUserOptedOut

func (s *OptedOutNumberInformation) SetEndUserOptedOut(v bool) *OptedOutNumberInformation

SetEndUserOptedOut sets the EndUserOptedOut field's value.

func (*OptedOutNumberInformation) SetOptedOutNumber

SetOptedOutNumber sets the OptedOutNumber field's value.

func (*OptedOutNumberInformation) SetOptedOutTimestamp

func (s *OptedOutNumberInformation) SetOptedOutTimestamp(v time.Time) *OptedOutNumberInformation

SetOptedOutTimestamp sets the OptedOutTimestamp field's value.

func (OptedOutNumberInformation) String

func (s OptedOutNumberInformation) String() string

String returns the string representation.

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

type OriginationIdentityMetadata

type OriginationIdentityMetadata struct {

	// The two-character code, in ISO 3166-1 alpha-2 format, for the country or
	// region.
	//
	// IsoCountryCode is a required field
	IsoCountryCode *string `min:"2" type:"string" required:"true"`

	// Describes if the origination identity can be used for text messages, voice
	// calls or both.
	//
	// NumberCapabilities is a required field
	NumberCapabilities []*string `min:"1" type:"list" required:"true" enum:"NumberCapability"`

	// The unique identifier of the origination identity.
	//
	// OriginationIdentity is a required field
	OriginationIdentity *string `type:"string" required:"true"`

	// The Amazon Resource Name (ARN) associated with the origination identity.
	//
	// OriginationIdentityArn is a required field
	OriginationIdentityArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

The metadata for an origination identity associated with a pool.

func (OriginationIdentityMetadata) GoString

func (s OriginationIdentityMetadata) GoString() string

GoString returns the string representation.

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

func (*OriginationIdentityMetadata) SetIsoCountryCode

SetIsoCountryCode sets the IsoCountryCode field's value.

func (*OriginationIdentityMetadata) SetNumberCapabilities

func (s *OriginationIdentityMetadata) SetNumberCapabilities(v []*string) *OriginationIdentityMetadata

SetNumberCapabilities sets the NumberCapabilities field's value.

func (*OriginationIdentityMetadata) SetOriginationIdentity

func (s *OriginationIdentityMetadata) SetOriginationIdentity(v string) *OriginationIdentityMetadata

SetOriginationIdentity sets the OriginationIdentity field's value.

func (*OriginationIdentityMetadata) SetOriginationIdentityArn

func (s *OriginationIdentityMetadata) SetOriginationIdentityArn(v string) *OriginationIdentityMetadata

SetOriginationIdentityArn sets the OriginationIdentityArn field's value.

func (OriginationIdentityMetadata) String

String returns the string representation.

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

type PhoneNumberFilter

type PhoneNumberFilter struct {

	// The name of the attribute to filter on.
	//
	// Name is a required field
	Name *string `type:"string" required:"true" enum:"PhoneNumberFilterName"`

	// An array values to filter for.
	//
	// Values is a required field
	Values []*string `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

The information for a phone number that meets a specified criteria.

func (PhoneNumberFilter) GoString

func (s PhoneNumberFilter) GoString() string

GoString returns the string representation.

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

func (*PhoneNumberFilter) SetName

SetName sets the Name field's value.

func (*PhoneNumberFilter) SetValues

func (s *PhoneNumberFilter) SetValues(v []*string) *PhoneNumberFilter

SetValues sets the Values field's value.

func (PhoneNumberFilter) String

func (s PhoneNumberFilter) String() string

String returns the string representation.

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

func (*PhoneNumberFilter) Validate

func (s *PhoneNumberFilter) Validate() error

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

type PhoneNumberInformation

type PhoneNumberInformation struct {

	// The time when the phone number was created, in UNIX epoch time (https://www.epochconverter.com/)
	// format.
	//
	// CreatedTimestamp is a required field
	CreatedTimestamp *time.Time `type:"timestamp" required:"true"`

	// When set to true the phone number can't be deleted.
	//
	// DeletionProtectionEnabled is a required field
	DeletionProtectionEnabled *bool `type:"boolean" required:"true"`

	// The two-character code, in ISO 3166-1 alpha-2 format, for the country or
	// region.
	//
	// IsoCountryCode is a required field
	IsoCountryCode *string `min:"2" type:"string" required:"true"`

	// 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.
	//
	// MessageType is a required field
	MessageType *string `type:"string" required:"true" enum:"MessageType"`

	// The price, in US dollars, to lease the phone number.
	//
	// MonthlyLeasingPrice is a required field
	MonthlyLeasingPrice *string `type:"string" required:"true"`

	// Describes if the origination identity can be used for text messages, voice
	// calls or both.
	//
	// NumberCapabilities is a required field
	NumberCapabilities []*string `min:"1" type:"list" required:"true" enum:"NumberCapability"`

	// The type of phone number.
	//
	// NumberType is a required field
	NumberType *string `type:"string" required:"true" enum:"NumberType"`

	// The name of the OptOutList associated with the phone number.
	//
	// OptOutListName is a required field
	OptOutListName *string `min:"1" type:"string" required:"true"`

	// The phone number in E.164 format.
	//
	// PhoneNumber is a required field
	PhoneNumber *string `min:"1" type:"string" required:"true"`

	// The Amazon Resource Name (ARN) associated with the phone number.
	//
	// PhoneNumberArn is a required field
	PhoneNumberArn *string `type:"string" required:"true"`

	// The unique identifier for the phone number.
	PhoneNumberId *string `type:"string"`

	// The unique identifier of the pool associated with the phone number.
	PoolId *string `type:"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 (https://docs.aws.amazon.com/pinpoint/latest/userguide/settings-sms-managing.html#settings-account-sms-self-managed-opt-out)
	//
	// SelfManagedOptOutsEnabled is a required field
	SelfManagedOptOutsEnabled *bool `type:"boolean" required:"true"`

	// The current status of the phone number.
	//
	// Status is a required field
	Status *string `type:"string" required:"true" enum:"NumberStatus"`

	// The Amazon Resource Name (ARN) of the two way channel.
	TwoWayChannelArn *string `min:"20" type:"string"`

	// By default this is set to false. When set to true you can receive incoming
	// text messages from your end recipients using the TwoWayChannelArn.
	//
	// TwoWayEnabled is a required field
	TwoWayEnabled *bool `type:"boolean" required:"true"`
	// contains filtered or unexported fields
}

The information for a phone number in an Amazon Web Services account.

func (PhoneNumberInformation) GoString

func (s PhoneNumberInformation) GoString() string

GoString returns the string representation.

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

func (*PhoneNumberInformation) SetCreatedTimestamp

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

SetCreatedTimestamp sets the CreatedTimestamp field's value.

func (*PhoneNumberInformation) SetDeletionProtectionEnabled

func (s *PhoneNumberInformation) SetDeletionProtectionEnabled(v bool) *PhoneNumberInformation

SetDeletionProtectionEnabled sets the DeletionProtectionEnabled field's value.

func (*PhoneNumberInformation) SetIsoCountryCode

func (s *PhoneNumberInformation) SetIsoCountryCode(v string) *PhoneNumberInformation

SetIsoCountryCode sets the IsoCountryCode field's value.

func (*PhoneNumberInformation) SetMessageType

SetMessageType sets the MessageType field's value.

func (*PhoneNumberInformation) SetMonthlyLeasingPrice

func (s *PhoneNumberInformation) SetMonthlyLeasingPrice(v string) *PhoneNumberInformation

SetMonthlyLeasingPrice sets the MonthlyLeasingPrice field's value.

func (*PhoneNumberInformation) SetNumberCapabilities

func (s *PhoneNumberInformation) SetNumberCapabilities(v []*string) *PhoneNumberInformation

SetNumberCapabilities sets the NumberCapabilities field's value.

func (*PhoneNumberInformation) SetNumberType

SetNumberType sets the NumberType field's value.

func (*PhoneNumberInformation) SetOptOutListName

func (s *PhoneNumberInformation) SetOptOutListName(v string) *PhoneNumberInformation

SetOptOutListName sets the OptOutListName field's value.

func (*PhoneNumberInformation) SetPhoneNumber

SetPhoneNumber sets the PhoneNumber field's value.

func (*PhoneNumberInformation) SetPhoneNumberArn

func (s *PhoneNumberInformation) SetPhoneNumberArn(v string) *PhoneNumberInformation

SetPhoneNumberArn sets the PhoneNumberArn field's value.

func (*PhoneNumberInformation) SetPhoneNumberId

func (s *PhoneNumberInformation) SetPhoneNumberId(v string) *PhoneNumberInformation

SetPhoneNumberId sets the PhoneNumberId field's value.

func (*PhoneNumberInformation) SetPoolId

SetPoolId sets the PoolId field's value.

func (*PhoneNumberInformation) SetSelfManagedOptOutsEnabled

func (s *PhoneNumberInformation) SetSelfManagedOptOutsEnabled(v bool) *PhoneNumberInformation

SetSelfManagedOptOutsEnabled sets the SelfManagedOptOutsEnabled field's value.

func (*PhoneNumberInformation) SetStatus

SetStatus sets the Status field's value.

func (*PhoneNumberInformation) SetTwoWayChannelArn

func (s *PhoneNumberInformation) SetTwoWayChannelArn(v string) *PhoneNumberInformation

SetTwoWayChannelArn sets the TwoWayChannelArn field's value.

func (*PhoneNumberInformation) SetTwoWayEnabled

func (s *PhoneNumberInformation) SetTwoWayEnabled(v bool) *PhoneNumberInformation

SetTwoWayEnabled sets the TwoWayEnabled field's value.

func (PhoneNumberInformation) String

func (s PhoneNumberInformation) String() string

String returns the string representation.

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

type PinpointSMSVoiceV2

type PinpointSMSVoiceV2 struct {
	*client.Client
}

PinpointSMSVoiceV2 provides the API operation methods for making requests to Amazon Pinpoint SMS Voice V2. See this package's package overview docs for details on the service.

PinpointSMSVoiceV2 methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New

New creates a new instance of the PinpointSMSVoiceV2 client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example:

mySession := session.Must(session.NewSession())

// Create a PinpointSMSVoiceV2 client from just a session.
svc := pinpointsmsvoicev2.New(mySession)

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

func (*PinpointSMSVoiceV2) AssociateOriginationIdentity

AssociateOriginationIdentity API operation for Amazon Pinpoint SMS Voice V2.

Associates the specified origination identity with a pool.

If the origination identity is a phone number and is already associated with another pool, an Error is returned. A sender ID can be associated with multiple pools.

If the origination identity configuration doesn't match the pool's configuration, an Error is returned.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint SMS Voice V2's API operation AssociateOriginationIdentity for usage and error information.

Returned Error Types:

  • ServiceQuotaExceededException The request would cause a service quota to be exceeded.

  • ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.

  • AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.

  • ResourceNotFoundException A requested resource couldn't be found.

  • ValidationException A validation exception for a field.

  • ConflictException 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.

  • InternalServerException 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/AssociateOriginationIdentity

func (*PinpointSMSVoiceV2) AssociateOriginationIdentityRequest

func (c *PinpointSMSVoiceV2) AssociateOriginationIdentityRequest(input *AssociateOriginationIdentityInput) (req *request.Request, output *AssociateOriginationIdentityOutput)

AssociateOriginationIdentityRequest generates a "aws/request.Request" representing the client's request for the AssociateOriginationIdentity operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See AssociateOriginationIdentity for more information on using the AssociateOriginationIdentity API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the AssociateOriginationIdentityRequest method.
req, resp := client.AssociateOriginationIdentityRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/AssociateOriginationIdentity

func (*PinpointSMSVoiceV2) AssociateOriginationIdentityWithContext

func (c *PinpointSMSVoiceV2) AssociateOriginationIdentityWithContext(ctx aws.Context, input *AssociateOriginationIdentityInput, opts ...request.Option) (*AssociateOriginationIdentityOutput, error)

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

See AssociateOriginationIdentity for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PinpointSMSVoiceV2) CreateConfigurationSet

CreateConfigurationSet API operation for Amazon Pinpoint SMS Voice V2.

Creates a new configuration set. After you create the configuration set, you can add one or more event destinations to it.

A configuration set is a set of rules that you apply to the SMS and voice messages that you send.

When you send a message, you can optionally specify a single configuration set.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint SMS Voice V2's API operation CreateConfigurationSet for usage and error information.

Returned Error Types:

  • ServiceQuotaExceededException The request would cause a service quota to be exceeded.

  • ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.

  • AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.

  • ValidationException A validation exception for a field.

  • ConflictException 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.

  • InternalServerException 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/CreateConfigurationSet

func (*PinpointSMSVoiceV2) CreateConfigurationSetRequest

func (c *PinpointSMSVoiceV2) CreateConfigurationSetRequest(input *CreateConfigurationSetInput) (req *request.Request, output *CreateConfigurationSetOutput)

CreateConfigurationSetRequest generates a "aws/request.Request" representing the client's request for the CreateConfigurationSet operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateConfigurationSet for more information on using the CreateConfigurationSet API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateConfigurationSetRequest method.
req, resp := client.CreateConfigurationSetRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/CreateConfigurationSet

func (*PinpointSMSVoiceV2) CreateConfigurationSetWithContext

func (c *PinpointSMSVoiceV2) CreateConfigurationSetWithContext(ctx aws.Context, input *CreateConfigurationSetInput, opts ...request.Option) (*CreateConfigurationSetOutput, error)

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

See CreateConfigurationSet for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PinpointSMSVoiceV2) CreateEventDestination

CreateEventDestination API operation for Amazon Pinpoint SMS Voice V2.

Creates a new event destination in a configuration set.

An event destination is a location where you send message events. The event options are Amazon CloudWatch, Amazon Kinesis Data Firehose, or Amazon SNS. For example, when a message is delivered successfully, you can send information about that event to an event destination, or send notifications to endpoints that are subscribed to an Amazon SNS topic.

Each configuration set can contain between 0 and 5 event destinations. Each event destination can contain a reference to a single destination, such as a CloudWatch or Kinesis Data Firehose destination.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint SMS Voice V2's API operation CreateEventDestination for usage and error information.

Returned Error Types:

  • ServiceQuotaExceededException The request would cause a service quota to be exceeded.

  • ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.

  • AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.

  • ResourceNotFoundException A requested resource couldn't be found.

  • ValidationException A validation exception for a field.

  • ConflictException 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.

  • InternalServerException 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/CreateEventDestination

func (*PinpointSMSVoiceV2) CreateEventDestinationRequest

func (c *PinpointSMSVoiceV2) CreateEventDestinationRequest(input *CreateEventDestinationInput) (req *request.Request, output *CreateEventDestinationOutput)

CreateEventDestinationRequest generates a "aws/request.Request" representing the client's request for the CreateEventDestination operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateEventDestination for more information on using the CreateEventDestination API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateEventDestinationRequest method.
req, resp := client.CreateEventDestinationRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/CreateEventDestination

func (*PinpointSMSVoiceV2) CreateEventDestinationWithContext

func (c *PinpointSMSVoiceV2) CreateEventDestinationWithContext(ctx aws.Context, input *CreateEventDestinationInput, opts ...request.Option) (*CreateEventDestinationOutput, error)

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

See CreateEventDestination for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PinpointSMSVoiceV2) CreateOptOutList

func (c *PinpointSMSVoiceV2) CreateOptOutList(input *CreateOptOutListInput) (*CreateOptOutListOutput, error)

CreateOptOutList API operation for Amazon Pinpoint SMS Voice V2.

Creates a new opt-out list.

If the opt-out list name already exists, an Error is returned.

An opt-out list is a list of phone numbers that are opted out, meaning you can't send SMS or voice messages to them. If end user replies with the keyword "STOP," an entry for the phone number is added to the opt-out list. In addition to STOP, your recipients can use any supported opt-out keyword, such as CANCEL or OPTOUT. For a list of supported opt-out keywords, see SMS opt out (https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-sms-manage.html#channels-sms-manage-optout) in the Amazon Pinpoint User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint SMS Voice V2's API operation CreateOptOutList for usage and error information.

Returned Error Types:

  • ServiceQuotaExceededException The request would cause a service quota to be exceeded.

  • ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.

  • AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.

  • ValidationException A validation exception for a field.

  • ConflictException 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.

  • InternalServerException 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/CreateOptOutList

func (*PinpointSMSVoiceV2) CreateOptOutListRequest

func (c *PinpointSMSVoiceV2) CreateOptOutListRequest(input *CreateOptOutListInput) (req *request.Request, output *CreateOptOutListOutput)

CreateOptOutListRequest generates a "aws/request.Request" representing the client's request for the CreateOptOutList operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateOptOutList for more information on using the CreateOptOutList API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateOptOutListRequest method.
req, resp := client.CreateOptOutListRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/CreateOptOutList

func (*PinpointSMSVoiceV2) CreateOptOutListWithContext

func (c *PinpointSMSVoiceV2) CreateOptOutListWithContext(ctx aws.Context, input *CreateOptOutListInput, opts ...request.Option) (*CreateOptOutListOutput, error)

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

See CreateOptOutList for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PinpointSMSVoiceV2) CreatePool

func (c *PinpointSMSVoiceV2) CreatePool(input *CreatePoolInput) (*CreatePoolOutput, error)

CreatePool API operation for Amazon Pinpoint SMS Voice V2.

Creates a new pool and associates the specified origination identity to the pool. A pool can include one or more phone numbers and SenderIds that are associated with your Amazon Web Services account.

The new pool inherits its configuration from the specified origination identity. This includes keywords, message type, opt-out list, two-way configuration, and self-managed opt-out configuration. Deletion protection isn't inherited from the origination identity and defaults to false.

If the origination identity is a phone number and is already associated with another pool, an Error is returned. A sender ID can be associated with multiple pools.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint SMS Voice V2's API operation CreatePool for usage and error information.

Returned Error Types:

  • ServiceQuotaExceededException The request would cause a service quota to be exceeded.

  • ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.

  • AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.

  • ResourceNotFoundException A requested resource couldn't be found.

  • ValidationException A validation exception for a field.

  • ConflictException 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.

  • InternalServerException 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/CreatePool

func (*PinpointSMSVoiceV2) CreatePoolRequest

func (c *PinpointSMSVoiceV2) CreatePoolRequest(input *CreatePoolInput) (req *request.Request, output *CreatePoolOutput)

CreatePoolRequest generates a "aws/request.Request" representing the client's request for the CreatePool operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreatePool for more information on using the CreatePool API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreatePoolRequest method.
req, resp := client.CreatePoolRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/CreatePool

func (*PinpointSMSVoiceV2) CreatePoolWithContext

func (c *PinpointSMSVoiceV2) CreatePoolWithContext(ctx aws.Context, input *CreatePoolInput, opts ...request.Option) (*CreatePoolOutput, error)

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

See CreatePool for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PinpointSMSVoiceV2) DeleteConfigurationSet

DeleteConfigurationSet API operation for Amazon Pinpoint SMS Voice V2.

Deletes an existing configuration set.

A configuration set is a set of rules that you apply to voice and SMS messages that you send. In a configuration set, you can specify a destination for specific types of events related to voice and SMS messages.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint SMS Voice V2's API operation DeleteConfigurationSet for usage and error information.

Returned Error Types:

  • ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.

  • AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.

  • ResourceNotFoundException A requested resource couldn't be found.

  • ValidationException A validation exception for a field.

  • InternalServerException 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DeleteConfigurationSet

func (*PinpointSMSVoiceV2) DeleteConfigurationSetRequest

func (c *PinpointSMSVoiceV2) DeleteConfigurationSetRequest(input *DeleteConfigurationSetInput) (req *request.Request, output *DeleteConfigurationSetOutput)

DeleteConfigurationSetRequest generates a "aws/request.Request" representing the client's request for the DeleteConfigurationSet operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteConfigurationSet for more information on using the DeleteConfigurationSet API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteConfigurationSetRequest method.
req, resp := client.DeleteConfigurationSetRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DeleteConfigurationSet

func (*PinpointSMSVoiceV2) DeleteConfigurationSetWithContext

func (c *PinpointSMSVoiceV2) DeleteConfigurationSetWithContext(ctx aws.Context, input *DeleteConfigurationSetInput, opts ...request.Option) (*DeleteConfigurationSetOutput, error)

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

See DeleteConfigurationSet for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PinpointSMSVoiceV2) DeleteDefaultMessageType

DeleteDefaultMessageType API operation for Amazon Pinpoint SMS Voice V2.

Deletes an existing default message type on a configuration set.

A message type is a type of messages that you plan to send. If you send account-related messages or time-sensitive messages such as one-time passcodes, choose Transactional. If you plan to send messages that contain marketing material or other promotional content, choose Promotional. This setting applies to your entire Amazon Web Services account.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint SMS Voice V2's API operation DeleteDefaultMessageType for usage and error information.

Returned Error Types:

  • ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.

  • AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.

  • ResourceNotFoundException A requested resource couldn't be found.

  • ValidationException A validation exception for a field.

  • InternalServerException 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DeleteDefaultMessageType

func (*PinpointSMSVoiceV2) DeleteDefaultMessageTypeRequest

func (c *PinpointSMSVoiceV2) DeleteDefaultMessageTypeRequest(input *DeleteDefaultMessageTypeInput) (req *request.Request, output *DeleteDefaultMessageTypeOutput)

DeleteDefaultMessageTypeRequest generates a "aws/request.Request" representing the client's request for the DeleteDefaultMessageType operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteDefaultMessageType for more information on using the DeleteDefaultMessageType API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteDefaultMessageTypeRequest method.
req, resp := client.DeleteDefaultMessageTypeRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DeleteDefaultMessageType

func (*PinpointSMSVoiceV2) DeleteDefaultMessageTypeWithContext

func (c *PinpointSMSVoiceV2) DeleteDefaultMessageTypeWithContext(ctx aws.Context, input *DeleteDefaultMessageTypeInput, opts ...request.Option) (*DeleteDefaultMessageTypeOutput, error)

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

See DeleteDefaultMessageType for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PinpointSMSVoiceV2) DeleteDefaultSenderId

DeleteDefaultSenderId API operation for Amazon Pinpoint SMS Voice V2.

Deletes an existing default sender ID on a configuration set.

A default sender ID is the identity that appears on recipients' devices when they receive SMS messages. Support for sender ID capabilities varies by country or region.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint SMS Voice V2's API operation DeleteDefaultSenderId for usage and error information.

Returned Error Types:

  • ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.

  • AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.

  • ResourceNotFoundException A requested resource couldn't be found.

  • ValidationException A validation exception for a field.

  • InternalServerException 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DeleteDefaultSenderId

func (*PinpointSMSVoiceV2) DeleteDefaultSenderIdRequest

func (c *PinpointSMSVoiceV2) DeleteDefaultSenderIdRequest(input *DeleteDefaultSenderIdInput) (req *request.Request, output *DeleteDefaultSenderIdOutput)

DeleteDefaultSenderIdRequest generates a "aws/request.Request" representing the client's request for the DeleteDefaultSenderId operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteDefaultSenderId for more information on using the DeleteDefaultSenderId API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteDefaultSenderIdRequest method.
req, resp := client.DeleteDefaultSenderIdRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DeleteDefaultSenderId

func (*PinpointSMSVoiceV2) DeleteDefaultSenderIdWithContext

func (c *PinpointSMSVoiceV2) DeleteDefaultSenderIdWithContext(ctx aws.Context, input *DeleteDefaultSenderIdInput, opts ...request.Option) (*DeleteDefaultSenderIdOutput, error)

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

See DeleteDefaultSenderId for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PinpointSMSVoiceV2) DeleteEventDestination

DeleteEventDestination API operation for Amazon Pinpoint SMS Voice V2.

Deletes an existing event destination.

An event destination is a location where you send response information about the messages that you send. For example, when a message is delivered successfully, you can send information about that event to an Amazon CloudWatch destination, or send notifications to endpoints that are subscribed to an Amazon SNS topic.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint SMS Voice V2's API operation DeleteEventDestination for usage and error information.

Returned Error Types:

  • ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.

  • AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.

  • ResourceNotFoundException A requested resource couldn't be found.

  • ValidationException A validation exception for a field.

  • InternalServerException 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DeleteEventDestination

func (*PinpointSMSVoiceV2) DeleteEventDestinationRequest

func (c *PinpointSMSVoiceV2) DeleteEventDestinationRequest(input *DeleteEventDestinationInput) (req *request.Request, output *DeleteEventDestinationOutput)

DeleteEventDestinationRequest generates a "aws/request.Request" representing the client's request for the DeleteEventDestination operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteEventDestination for more information on using the DeleteEventDestination API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteEventDestinationRequest method.
req, resp := client.DeleteEventDestinationRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DeleteEventDestination

func (*PinpointSMSVoiceV2) DeleteEventDestinationWithContext

func (c *PinpointSMSVoiceV2) DeleteEventDestinationWithContext(ctx aws.Context, input *DeleteEventDestinationInput, opts ...request.Option) (*DeleteEventDestinationOutput, error)

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

See DeleteEventDestination for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PinpointSMSVoiceV2) DeleteKeyword

func (c *PinpointSMSVoiceV2) DeleteKeyword(input *DeleteKeywordInput) (*DeleteKeywordOutput, error)

DeleteKeyword API operation for Amazon Pinpoint SMS Voice V2.

Deletes an existing keyword from an origination phone number or pool.

A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, Amazon Pinpoint responds with a customizable message.

Keywords "HELP" and "STOP" can't be deleted or modified.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint SMS Voice V2's API operation DeleteKeyword for usage and error information.

Returned Error Types:

  • ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.

  • AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.

  • ResourceNotFoundException A requested resource couldn't be found.

  • ValidationException A validation exception for a field.

  • ConflictException 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.

  • InternalServerException 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DeleteKeyword

func (*PinpointSMSVoiceV2) DeleteKeywordRequest

func (c *PinpointSMSVoiceV2) DeleteKeywordRequest(input *DeleteKeywordInput) (req *request.Request, output *DeleteKeywordOutput)

DeleteKeywordRequest generates a "aws/request.Request" representing the client's request for the DeleteKeyword operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteKeyword for more information on using the DeleteKeyword API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteKeywordRequest method.
req, resp := client.DeleteKeywordRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DeleteKeyword

func (*PinpointSMSVoiceV2) DeleteKeywordWithContext

func (c *PinpointSMSVoiceV2) DeleteKeywordWithContext(ctx aws.Context, input *DeleteKeywordInput, opts ...request.Option) (*DeleteKeywordOutput, error)

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

See DeleteKeyword for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PinpointSMSVoiceV2) DeleteOptOutList

func (c *PinpointSMSVoiceV2) DeleteOptOutList(input *DeleteOptOutListInput) (*DeleteOptOutListOutput, error)

DeleteOptOutList API operation for Amazon Pinpoint SMS Voice V2.

Deletes an existing opt-out list. All opted out phone numbers in the opt-out list are deleted.

If the specified opt-out list name doesn't exist or is in-use by an origination phone number or pool, an Error is returned.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint SMS Voice V2's API operation DeleteOptOutList for usage and error information.

Returned Error Types:

  • ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.

  • AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.

  • ResourceNotFoundException A requested resource couldn't be found.

  • ValidationException A validation exception for a field.

  • ConflictException 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.

  • InternalServerException 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DeleteOptOutList

func (*PinpointSMSVoiceV2) DeleteOptOutListRequest

func (c *PinpointSMSVoiceV2) DeleteOptOutListRequest(input *DeleteOptOutListInput) (req *request.Request, output *DeleteOptOutListOutput)

DeleteOptOutListRequest generates a "aws/request.Request" representing the client's request for the DeleteOptOutList operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteOptOutList for more information on using the DeleteOptOutList API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteOptOutListRequest method.
req, resp := client.DeleteOptOutListRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DeleteOptOutList

func (*PinpointSMSVoiceV2) DeleteOptOutListWithContext

func (c *PinpointSMSVoiceV2) DeleteOptOutListWithContext(ctx aws.Context, input *DeleteOptOutListInput, opts ...request.Option) (*DeleteOptOutListOutput, error)

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

See DeleteOptOutList for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PinpointSMSVoiceV2) DeleteOptedOutNumber

DeleteOptedOutNumber API operation for Amazon Pinpoint SMS Voice V2.

Deletes an existing opted out destination phone number from the specified opt-out list.

Each destination phone number can only be deleted once every 30 days.

If the specified destination phone number doesn't exist or if the opt-out list doesn't exist, an Error is returned.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint SMS Voice V2's API operation DeleteOptedOutNumber for usage and error information.

Returned Error Types:

  • ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.

  • AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.

  • ResourceNotFoundException A requested resource couldn't be found.

  • ValidationException A validation exception for a field.

  • ConflictException 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.

  • InternalServerException 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DeleteOptedOutNumber

func (*PinpointSMSVoiceV2) DeleteOptedOutNumberRequest

func (c *PinpointSMSVoiceV2) DeleteOptedOutNumberRequest(input *DeleteOptedOutNumberInput) (req *request.Request, output *DeleteOptedOutNumberOutput)

DeleteOptedOutNumberRequest generates a "aws/request.Request" representing the client's request for the DeleteOptedOutNumber operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteOptedOutNumber for more information on using the DeleteOptedOutNumber API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteOptedOutNumberRequest method.
req, resp := client.DeleteOptedOutNumberRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DeleteOptedOutNumber

func (*PinpointSMSVoiceV2) DeleteOptedOutNumberWithContext

func (c *PinpointSMSVoiceV2) DeleteOptedOutNumberWithContext(ctx aws.Context, input *DeleteOptedOutNumberInput, opts ...request.Option) (*DeleteOptedOutNumberOutput, error)

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

See DeleteOptedOutNumber for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PinpointSMSVoiceV2) DeletePool

func (c *PinpointSMSVoiceV2) DeletePool(input *DeletePoolInput) (*DeletePoolOutput, error)

DeletePool API operation for Amazon Pinpoint SMS Voice V2.

Deletes an existing pool. Deleting a pool disassociates all origination identities from that pool.

If the pool status isn't active or if deletion protection is enabled, an Error is returned.

A pool is a collection of phone numbers and SenderIds. A pool can include one or more phone numbers and SenderIds that are associated with your Amazon Web Services account.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint SMS Voice V2's API operation DeletePool for usage and error information.

Returned Error Types:

  • ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.

  • AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.

  • ResourceNotFoundException A requested resource couldn't be found.

  • ValidationException A validation exception for a field.

  • ConflictException 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.

  • InternalServerException 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DeletePool

func (*PinpointSMSVoiceV2) DeletePoolRequest

func (c *PinpointSMSVoiceV2) DeletePoolRequest(input *DeletePoolInput) (req *request.Request, output *DeletePoolOutput)

DeletePoolRequest generates a "aws/request.Request" representing the client's request for the DeletePool operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeletePool for more information on using the DeletePool API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeletePoolRequest method.
req, resp := client.DeletePoolRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DeletePool

func (*PinpointSMSVoiceV2) DeletePoolWithContext

func (c *PinpointSMSVoiceV2) DeletePoolWithContext(ctx aws.Context, input *DeletePoolInput, opts ...request.Option) (*DeletePoolOutput, error)

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

See DeletePool for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PinpointSMSVoiceV2) DeleteTextMessageSpendLimitOverride

DeleteTextMessageSpendLimitOverride API operation for Amazon Pinpoint SMS Voice V2.

Deletes an account-level monthly spending limit override for sending text messages. Deleting a spend limit override will set the EnforcedLimit to equal the MaxLimit, which is controlled by Amazon Web Services. For more information on spend limits (quotas) see Amazon Pinpoint quotas (https://docs.aws.amazon.com/pinpoint/latest/developerguide/quotas.html) in the Amazon Pinpoint Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint SMS Voice V2's API operation DeleteTextMessageSpendLimitOverride for usage and error information.

Returned Error Types:

  • ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.

  • AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.

  • ValidationException A validation exception for a field.

  • InternalServerException 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DeleteTextMessageSpendLimitOverride

func (*PinpointSMSVoiceV2) DeleteTextMessageSpendLimitOverrideRequest

func (c *PinpointSMSVoiceV2) DeleteTextMessageSpendLimitOverrideRequest(input *DeleteTextMessageSpendLimitOverrideInput) (req *request.Request, output *DeleteTextMessageSpendLimitOverrideOutput)

DeleteTextMessageSpendLimitOverrideRequest generates a "aws/request.Request" representing the client's request for the DeleteTextMessageSpendLimitOverride operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteTextMessageSpendLimitOverride for more information on using the DeleteTextMessageSpendLimitOverride API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteTextMessageSpendLimitOverrideRequest method.
req, resp := client.DeleteTextMessageSpendLimitOverrideRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DeleteTextMessageSpendLimitOverride

func (*PinpointSMSVoiceV2) DeleteTextMessageSpendLimitOverrideWithContext

func (c *PinpointSMSVoiceV2) DeleteTextMessageSpendLimitOverrideWithContext(ctx aws.Context, input *DeleteTextMessageSpendLimitOverrideInput, opts ...request.Option) (*DeleteTextMessageSpendLimitOverrideOutput, error)

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

See DeleteTextMessageSpendLimitOverride for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PinpointSMSVoiceV2) DeleteVoiceMessageSpendLimitOverride

DeleteVoiceMessageSpendLimitOverride API operation for Amazon Pinpoint SMS Voice V2.

Deletes an account level monthly spend limit override for sending voice messages. Deleting a spend limit override sets the EnforcedLimit equal to the MaxLimit, which is controlled by Amazon Web Services. For more information on spending limits (quotas) see Amazon Pinpoint quotas (https://docs.aws.amazon.com/pinpoint/latest/developerguide/quotas.html) in the Amazon Pinpoint Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint SMS Voice V2's API operation DeleteVoiceMessageSpendLimitOverride for usage and error information.

Returned Error Types:

  • ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.

  • AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.

  • ValidationException A validation exception for a field.

  • InternalServerException 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DeleteVoiceMessageSpendLimitOverride

func (*PinpointSMSVoiceV2) DeleteVoiceMessageSpendLimitOverrideRequest

func (c *PinpointSMSVoiceV2) DeleteVoiceMessageSpendLimitOverrideRequest(input *DeleteVoiceMessageSpendLimitOverrideInput) (req *request.Request, output *DeleteVoiceMessageSpendLimitOverrideOutput)

DeleteVoiceMessageSpendLimitOverrideRequest generates a "aws/request.Request" representing the client's request for the DeleteVoiceMessageSpendLimitOverride operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteVoiceMessageSpendLimitOverride for more information on using the DeleteVoiceMessageSpendLimitOverride API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteVoiceMessageSpendLimitOverrideRequest method.
req, resp := client.DeleteVoiceMessageSpendLimitOverrideRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DeleteVoiceMessageSpendLimitOverride

func (*PinpointSMSVoiceV2) DeleteVoiceMessageSpendLimitOverrideWithContext

func (c *PinpointSMSVoiceV2) DeleteVoiceMessageSpendLimitOverrideWithContext(ctx aws.Context, input *DeleteVoiceMessageSpendLimitOverrideInput, opts ...request.Option) (*DeleteVoiceMessageSpendLimitOverrideOutput, error)

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

See DeleteVoiceMessageSpendLimitOverride for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PinpointSMSVoiceV2) DescribeAccountAttributes

DescribeAccountAttributes API operation for Amazon Pinpoint SMS Voice V2.

Describes attributes of your Amazon Web Services account. The supported account attributes include account tier, which indicates whether your account is in the sandbox or production environment. When you're ready to move your account out of the sandbox, create an Amazon Web Services Support case for a service limit increase request.

New Amazon Pinpoint accounts are placed into an SMS or voice sandbox. The sandbox protects both Amazon Web Services end recipients and SMS or voice recipients from fraud and abuse.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint SMS Voice V2's API operation DescribeAccountAttributes for usage and error information.

Returned Error Types:

  • ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.

  • AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.

  • ValidationException A validation exception for a field.

  • InternalServerException 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DescribeAccountAttributes

func (*PinpointSMSVoiceV2) DescribeAccountAttributesPages

func (c *PinpointSMSVoiceV2) DescribeAccountAttributesPages(input *DescribeAccountAttributesInput, fn func(*DescribeAccountAttributesOutput, bool) bool) error

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

See DescribeAccountAttributes method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a DescribeAccountAttributes operation.
pageNum := 0
err := client.DescribeAccountAttributesPages(params,
    func(page *pinpointsmsvoicev2.DescribeAccountAttributesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*PinpointSMSVoiceV2) DescribeAccountAttributesPagesWithContext

func (c *PinpointSMSVoiceV2) DescribeAccountAttributesPagesWithContext(ctx aws.Context, input *DescribeAccountAttributesInput, fn func(*DescribeAccountAttributesOutput, bool) bool, opts ...request.Option) error

DescribeAccountAttributesPagesWithContext same as DescribeAccountAttributesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PinpointSMSVoiceV2) DescribeAccountAttributesRequest

func (c *PinpointSMSVoiceV2) DescribeAccountAttributesRequest(input *DescribeAccountAttributesInput) (req *request.Request, output *DescribeAccountAttributesOutput)

DescribeAccountAttributesRequest generates a "aws/request.Request" representing the client's request for the DescribeAccountAttributes operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeAccountAttributes for more information on using the DescribeAccountAttributes API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeAccountAttributesRequest method.
req, resp := client.DescribeAccountAttributesRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DescribeAccountAttributes

func (*PinpointSMSVoiceV2) DescribeAccountAttributesWithContext

func (c *PinpointSMSVoiceV2) DescribeAccountAttributesWithContext(ctx aws.Context, input *DescribeAccountAttributesInput, opts ...request.Option) (*DescribeAccountAttributesOutput, error)

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

See DescribeAccountAttributes for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PinpointSMSVoiceV2) DescribeAccountLimits

DescribeAccountLimits API operation for Amazon Pinpoint SMS Voice V2.

Describes the current Amazon Pinpoint SMS Voice V2 resource quotas for your account. The description for a quota includes the quota name, current usage toward that quota, and the quota's maximum value.

When you establish an Amazon Web Services account, the account has initial quotas on the maximum number of configuration sets, opt-out lists, phone numbers, and pools that you can create in a given Region. For more information see Amazon Pinpoint quotas (https://docs.aws.amazon.com/pinpoint/latest/developerguide/quotas.html) in the Amazon Pinpoint Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint SMS Voice V2's API operation DescribeAccountLimits for usage and error information.

Returned Error Types:

  • ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.

  • AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.

  • ValidationException A validation exception for a field.

  • InternalServerException 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DescribeAccountLimits

func (*PinpointSMSVoiceV2) DescribeAccountLimitsPages

func (c *PinpointSMSVoiceV2) DescribeAccountLimitsPages(input *DescribeAccountLimitsInput, fn func(*DescribeAccountLimitsOutput, bool) bool) error

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

See DescribeAccountLimits method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a DescribeAccountLimits operation.
pageNum := 0
err := client.DescribeAccountLimitsPages(params,
    func(page *pinpointsmsvoicev2.DescribeAccountLimitsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*PinpointSMSVoiceV2) DescribeAccountLimitsPagesWithContext

func (c *PinpointSMSVoiceV2) DescribeAccountLimitsPagesWithContext(ctx aws.Context, input *DescribeAccountLimitsInput, fn func(*DescribeAccountLimitsOutput, bool) bool, opts ...request.Option) error

DescribeAccountLimitsPagesWithContext same as DescribeAccountLimitsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PinpointSMSVoiceV2) DescribeAccountLimitsRequest

func (c *PinpointSMSVoiceV2) DescribeAccountLimitsRequest(input *DescribeAccountLimitsInput) (req *request.Request, output *DescribeAccountLimitsOutput)

DescribeAccountLimitsRequest generates a "aws/request.Request" representing the client's request for the DescribeAccountLimits operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeAccountLimits for more information on using the DescribeAccountLimits API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeAccountLimitsRequest method.
req, resp := client.DescribeAccountLimitsRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DescribeAccountLimits

func (*PinpointSMSVoiceV2) DescribeAccountLimitsWithContext

func (c *PinpointSMSVoiceV2) DescribeAccountLimitsWithContext(ctx aws.Context, input *DescribeAccountLimitsInput, opts ...request.Option) (*DescribeAccountLimitsOutput, error)

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

See DescribeAccountLimits for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PinpointSMSVoiceV2) DescribeConfigurationSets

DescribeConfigurationSets API operation for Amazon Pinpoint SMS Voice V2.

Describes the specified configuration sets or all in your account.

If you specify configuration set names, the output includes information for only the specified configuration sets. If you specify filters, the output includes information for only those configuration sets that meet the filter criteria. If you don't specify configuration set names or filters, the output includes information for all configuration sets.

If you specify a configuration set name that isn't valid, an error is returned.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint SMS Voice V2's API operation DescribeConfigurationSets for usage and error information.

Returned Error Types:

  • ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.

  • AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.

  • ResourceNotFoundException A requested resource couldn't be found.

  • ValidationException A validation exception for a field.

  • InternalServerException 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DescribeConfigurationSets

func (*PinpointSMSVoiceV2) DescribeConfigurationSetsPages

func (c *PinpointSMSVoiceV2) DescribeConfigurationSetsPages(input *DescribeConfigurationSetsInput, fn func(*DescribeConfigurationSetsOutput, bool) bool) error

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

See DescribeConfigurationSets method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a DescribeConfigurationSets operation.
pageNum := 0
err := client.DescribeConfigurationSetsPages(params,
    func(page *pinpointsmsvoicev2.DescribeConfigurationSetsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*PinpointSMSVoiceV2) DescribeConfigurationSetsPagesWithContext

func (c *PinpointSMSVoiceV2) DescribeConfigurationSetsPagesWithContext(ctx aws.Context, input *DescribeConfigurationSetsInput, fn func(*DescribeConfigurationSetsOutput, bool) bool, opts ...request.Option) error

DescribeConfigurationSetsPagesWithContext same as DescribeConfigurationSetsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PinpointSMSVoiceV2) DescribeConfigurationSetsRequest

func (c *PinpointSMSVoiceV2) DescribeConfigurationSetsRequest(input *DescribeConfigurationSetsInput) (req *request.Request, output *DescribeConfigurationSetsOutput)

DescribeConfigurationSetsRequest generates a "aws/request.Request" representing the client's request for the DescribeConfigurationSets operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeConfigurationSets for more information on using the DescribeConfigurationSets API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeConfigurationSetsRequest method.
req, resp := client.DescribeConfigurationSetsRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DescribeConfigurationSets

func (*PinpointSMSVoiceV2) DescribeConfigurationSetsWithContext

func (c *PinpointSMSVoiceV2) DescribeConfigurationSetsWithContext(ctx aws.Context, input *DescribeConfigurationSetsInput, opts ...request.Option) (*DescribeConfigurationSetsOutput, error)

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

See DescribeConfigurationSets for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PinpointSMSVoiceV2) DescribeKeywords

func (c *PinpointSMSVoiceV2) DescribeKeywords(input *DescribeKeywordsInput) (*DescribeKeywordsOutput, error)

DescribeKeywords API operation for Amazon Pinpoint SMS Voice V2.

Describes the specified keywords or all keywords on your origination phone number or pool.

A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, Amazon Pinpoint responds with a customizable message.

If you specify a keyword that isn't valid, an Error is returned.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint SMS Voice V2's API operation DescribeKeywords for usage and error information.

Returned Error Types:

  • ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.

  • AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.

  • ResourceNotFoundException A requested resource couldn't be found.

  • ValidationException A validation exception for a field.

  • InternalServerException 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DescribeKeywords

func (*PinpointSMSVoiceV2) DescribeKeywordsPages

func (c *PinpointSMSVoiceV2) DescribeKeywordsPages(input *DescribeKeywordsInput, fn func(*DescribeKeywordsOutput, bool) bool) error

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

See DescribeKeywords method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a DescribeKeywords operation.
pageNum := 0
err := client.DescribeKeywordsPages(params,
    func(page *pinpointsmsvoicev2.DescribeKeywordsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*PinpointSMSVoiceV2) DescribeKeywordsPagesWithContext

func (c *PinpointSMSVoiceV2) DescribeKeywordsPagesWithContext(ctx aws.Context, input *DescribeKeywordsInput, fn func(*DescribeKeywordsOutput, bool) bool, opts ...request.Option) error

DescribeKeywordsPagesWithContext same as DescribeKeywordsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PinpointSMSVoiceV2) DescribeKeywordsRequest

func (c *PinpointSMSVoiceV2) DescribeKeywordsRequest(input *DescribeKeywordsInput) (req *request.Request, output *DescribeKeywordsOutput)

DescribeKeywordsRequest generates a "aws/request.Request" representing the client's request for the DescribeKeywords operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeKeywords for more information on using the DescribeKeywords API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeKeywordsRequest method.
req, resp := client.DescribeKeywordsRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DescribeKeywords

func (*PinpointSMSVoiceV2) DescribeKeywordsWithContext

func (c *PinpointSMSVoiceV2) DescribeKeywordsWithContext(ctx aws.Context, input *DescribeKeywordsInput, opts ...request.Option) (*DescribeKeywordsOutput, error)

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

See DescribeKeywords for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PinpointSMSVoiceV2) DescribeOptOutLists

DescribeOptOutLists API operation for Amazon Pinpoint SMS Voice V2.

Describes the specified opt-out list or all opt-out lists in your account.

If you specify opt-out list names, the output includes information for only the specified opt-out lists. Opt-out lists include only those that meet the filter criteria. If you don't specify opt-out list names or filters, the output includes information for all opt-out lists.

If you specify an opt-out list name that isn't valid, an Error is returned.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint SMS Voice V2's API operation DescribeOptOutLists for usage and error information.

Returned Error Types:

  • ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.

  • AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.

  • ResourceNotFoundException A requested resource couldn't be found.

  • ValidationException A validation exception for a field.

  • InternalServerException 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DescribeOptOutLists

func (*PinpointSMSVoiceV2) DescribeOptOutListsPages

func (c *PinpointSMSVoiceV2) DescribeOptOutListsPages(input *DescribeOptOutListsInput, fn func(*DescribeOptOutListsOutput, bool) bool) error

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

See DescribeOptOutLists method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a DescribeOptOutLists operation.
pageNum := 0
err := client.DescribeOptOutListsPages(params,
    func(page *pinpointsmsvoicev2.DescribeOptOutListsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*PinpointSMSVoiceV2) DescribeOptOutListsPagesWithContext

func (c *PinpointSMSVoiceV2) DescribeOptOutListsPagesWithContext(ctx aws.Context, input *DescribeOptOutListsInput, fn func(*DescribeOptOutListsOutput, bool) bool, opts ...request.Option) error

DescribeOptOutListsPagesWithContext same as DescribeOptOutListsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PinpointSMSVoiceV2) DescribeOptOutListsRequest

func (c *PinpointSMSVoiceV2) DescribeOptOutListsRequest(input *DescribeOptOutListsInput) (req *request.Request, output *DescribeOptOutListsOutput)

DescribeOptOutListsRequest generates a "aws/request.Request" representing the client's request for the DescribeOptOutLists operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeOptOutLists for more information on using the DescribeOptOutLists API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeOptOutListsRequest method.
req, resp := client.DescribeOptOutListsRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DescribeOptOutLists

func (*PinpointSMSVoiceV2) DescribeOptOutListsWithContext

func (c *PinpointSMSVoiceV2) DescribeOptOutListsWithContext(ctx aws.Context, input *DescribeOptOutListsInput, opts ...request.Option) (*DescribeOptOutListsOutput, error)

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

See DescribeOptOutLists for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PinpointSMSVoiceV2) DescribeOptedOutNumbers

DescribeOptedOutNumbers API operation for Amazon Pinpoint SMS Voice V2.

Describes the specified opted out destination numbers or all opted out destination numbers in an opt-out list.

If you specify opted out numbers, the output includes information for only the specified opted out numbers. If you specify filters, the output includes information for only those opted out numbers that meet the filter criteria. If you don't specify opted out numbers or filters, the output includes information for all opted out destination numbers in your opt-out list.

If you specify an opted out number that isn't valid, an Error is returned.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint SMS Voice V2's API operation DescribeOptedOutNumbers for usage and error information.

Returned Error Types:

  • ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.

  • AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.

  • ResourceNotFoundException A requested resource couldn't be found.

  • ValidationException A validation exception for a field.

  • InternalServerException 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DescribeOptedOutNumbers

func (*PinpointSMSVoiceV2) DescribeOptedOutNumbersPages

func (c *PinpointSMSVoiceV2) DescribeOptedOutNumbersPages(input *DescribeOptedOutNumbersInput, fn func(*DescribeOptedOutNumbersOutput, bool) bool) error

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

See DescribeOptedOutNumbers method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a DescribeOptedOutNumbers operation.
pageNum := 0
err := client.DescribeOptedOutNumbersPages(params,
    func(page *pinpointsmsvoicev2.DescribeOptedOutNumbersOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*PinpointSMSVoiceV2) DescribeOptedOutNumbersPagesWithContext

func (c *PinpointSMSVoiceV2) DescribeOptedOutNumbersPagesWithContext(ctx aws.Context, input *DescribeOptedOutNumbersInput, fn func(*DescribeOptedOutNumbersOutput, bool) bool, opts ...request.Option) error

DescribeOptedOutNumbersPagesWithContext same as DescribeOptedOutNumbersPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PinpointSMSVoiceV2) DescribeOptedOutNumbersRequest

func (c *PinpointSMSVoiceV2) DescribeOptedOutNumbersRequest(input *DescribeOptedOutNumbersInput) (req *request.Request, output *DescribeOptedOutNumbersOutput)

DescribeOptedOutNumbersRequest generates a "aws/request.Request" representing the client's request for the DescribeOptedOutNumbers operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeOptedOutNumbers for more information on using the DescribeOptedOutNumbers API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeOptedOutNumbersRequest method.
req, resp := client.DescribeOptedOutNumbersRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DescribeOptedOutNumbers

func (*PinpointSMSVoiceV2) DescribeOptedOutNumbersWithContext

func (c *PinpointSMSVoiceV2) DescribeOptedOutNumbersWithContext(ctx aws.Context, input *DescribeOptedOutNumbersInput, opts ...request.Option) (*DescribeOptedOutNumbersOutput, error)

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

See DescribeOptedOutNumbers for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PinpointSMSVoiceV2) DescribePhoneNumbers

DescribePhoneNumbers API operation for Amazon Pinpoint SMS Voice V2.

Describes the specified origination phone number, or all the phone numbers in your account.

If you specify phone number IDs, the output includes information for only the specified phone numbers. If you specify filters, the output includes information for only those phone numbers that meet the filter criteria. If you don't specify phone number IDs or filters, the output includes information for all phone numbers.

If you specify a phone number ID that isn't valid, an Error is returned.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint SMS Voice V2's API operation DescribePhoneNumbers for usage and error information.

Returned Error Types:

  • ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.

  • AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.

  • ResourceNotFoundException A requested resource couldn't be found.

  • ValidationException A validation exception for a field.

  • InternalServerException 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DescribePhoneNumbers

func (*PinpointSMSVoiceV2) DescribePhoneNumbersPages

func (c *PinpointSMSVoiceV2) DescribePhoneNumbersPages(input *DescribePhoneNumbersInput, fn func(*DescribePhoneNumbersOutput, bool) bool) error

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

See DescribePhoneNumbers method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a DescribePhoneNumbers operation.
pageNum := 0
err := client.DescribePhoneNumbersPages(params,
    func(page *pinpointsmsvoicev2.DescribePhoneNumbersOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*PinpointSMSVoiceV2) DescribePhoneNumbersPagesWithContext

func (c *PinpointSMSVoiceV2) DescribePhoneNumbersPagesWithContext(ctx aws.Context, input *DescribePhoneNumbersInput, fn func(*DescribePhoneNumbersOutput, bool) bool, opts ...request.Option) error

DescribePhoneNumbersPagesWithContext same as DescribePhoneNumbersPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PinpointSMSVoiceV2) DescribePhoneNumbersRequest

func (c *PinpointSMSVoiceV2) DescribePhoneNumbersRequest(input *DescribePhoneNumbersInput) (req *request.Request, output *DescribePhoneNumbersOutput)

DescribePhoneNumbersRequest generates a "aws/request.Request" representing the client's request for the DescribePhoneNumbers operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribePhoneNumbers for more information on using the DescribePhoneNumbers API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribePhoneNumbersRequest method.
req, resp := client.DescribePhoneNumbersRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DescribePhoneNumbers

func (*PinpointSMSVoiceV2) DescribePhoneNumbersWithContext

func (c *PinpointSMSVoiceV2) DescribePhoneNumbersWithContext(ctx aws.Context, input *DescribePhoneNumbersInput, opts ...request.Option) (*DescribePhoneNumbersOutput, error)

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

See DescribePhoneNumbers for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PinpointSMSVoiceV2) DescribePools

func (c *PinpointSMSVoiceV2) DescribePools(input *DescribePoolsInput) (*DescribePoolsOutput, error)

DescribePools API operation for Amazon Pinpoint SMS Voice V2.

Retrieves the specified pools or all pools associated with your Amazon Web Services account.

If you specify pool IDs, the output includes information for only the specified pools. If you specify filters, the output includes information for only those pools that meet the filter criteria. If you don't specify pool IDs or filters, the output includes information for all pools.

If you specify a pool ID that isn't valid, an Error is returned.

A pool is a collection of phone numbers and SenderIds. A pool can include one or more phone numbers and SenderIds that are associated with your Amazon Web Services account.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint SMS Voice V2's API operation DescribePools for usage and error information.

Returned Error Types:

  • ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.

  • AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.

  • ResourceNotFoundException A requested resource couldn't be found.

  • ValidationException A validation exception for a field.

  • InternalServerException 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DescribePools

func (*PinpointSMSVoiceV2) DescribePoolsPages

func (c *PinpointSMSVoiceV2) DescribePoolsPages(input *DescribePoolsInput, fn func(*DescribePoolsOutput, bool) bool) error

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

See DescribePools method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a DescribePools operation.
pageNum := 0
err := client.DescribePoolsPages(params,
    func(page *pinpointsmsvoicev2.DescribePoolsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*PinpointSMSVoiceV2) DescribePoolsPagesWithContext

func (c *PinpointSMSVoiceV2) DescribePoolsPagesWithContext(ctx aws.Context, input *DescribePoolsInput, fn func(*DescribePoolsOutput, bool) bool, opts ...request.Option) error

DescribePoolsPagesWithContext same as DescribePoolsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PinpointSMSVoiceV2) DescribePoolsRequest

func (c *PinpointSMSVoiceV2) DescribePoolsRequest(input *DescribePoolsInput) (req *request.Request, output *DescribePoolsOutput)

DescribePoolsRequest generates a "aws/request.Request" representing the client's request for the DescribePools operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribePools for more information on using the DescribePools API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribePoolsRequest method.
req, resp := client.DescribePoolsRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DescribePools

func (*PinpointSMSVoiceV2) DescribePoolsWithContext

func (c *PinpointSMSVoiceV2) DescribePoolsWithContext(ctx aws.Context, input *DescribePoolsInput, opts ...request.Option) (*DescribePoolsOutput, error)

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

See DescribePools for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PinpointSMSVoiceV2) DescribeSenderIds

DescribeSenderIds API operation for Amazon Pinpoint SMS Voice V2.

Describes the specified SenderIds or all SenderIds associated with your Amazon Web Services account.

If you specify SenderIds, the output includes information for only the specified SenderIds. If you specify filters, the output includes information for only those SenderIds that meet the filter criteria. If you don't specify SenderIds or filters, the output includes information for all SenderIds.

f you specify a sender ID that isn't valid, an Error is returned.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint SMS Voice V2's API operation DescribeSenderIds for usage and error information.

Returned Error Types:

  • ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.

  • AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.

  • ResourceNotFoundException A requested resource couldn't be found.

  • ValidationException A validation exception for a field.

  • InternalServerException 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DescribeSenderIds

func (*PinpointSMSVoiceV2) DescribeSenderIdsPages

func (c *PinpointSMSVoiceV2) DescribeSenderIdsPages(input *DescribeSenderIdsInput, fn func(*DescribeSenderIdsOutput, bool) bool) error

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

See DescribeSenderIds method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a DescribeSenderIds operation.
pageNum := 0
err := client.DescribeSenderIdsPages(params,
    func(page *pinpointsmsvoicev2.DescribeSenderIdsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*PinpointSMSVoiceV2) DescribeSenderIdsPagesWithContext

func (c *PinpointSMSVoiceV2) DescribeSenderIdsPagesWithContext(ctx aws.Context, input *DescribeSenderIdsInput, fn func(*DescribeSenderIdsOutput, bool) bool, opts ...request.Option) error

DescribeSenderIdsPagesWithContext same as DescribeSenderIdsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PinpointSMSVoiceV2) DescribeSenderIdsRequest

func (c *PinpointSMSVoiceV2) DescribeSenderIdsRequest(input *DescribeSenderIdsInput) (req *request.Request, output *DescribeSenderIdsOutput)

DescribeSenderIdsRequest generates a "aws/request.Request" representing the client's request for the DescribeSenderIds operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeSenderIds for more information on using the DescribeSenderIds API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeSenderIdsRequest method.
req, resp := client.DescribeSenderIdsRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DescribeSenderIds

func (*PinpointSMSVoiceV2) DescribeSenderIdsWithContext

func (c *PinpointSMSVoiceV2) DescribeSenderIdsWithContext(ctx aws.Context, input *DescribeSenderIdsInput, opts ...request.Option) (*DescribeSenderIdsOutput, error)

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

See DescribeSenderIds for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PinpointSMSVoiceV2) DescribeSpendLimits

DescribeSpendLimits API operation for Amazon Pinpoint SMS Voice V2.

Describes the current Amazon Pinpoint monthly spend limits for sending voice and text messages.

When you establish an Amazon Web Services account, the account has initial monthly spend limit in a given Region. For more information on increasing your monthly spend limit, see Requesting increases to your monthly SMS spending quota for Amazon Pinpoint (https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-sms-awssupport-spend-threshold.html) in the Amazon Pinpoint User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint SMS Voice V2's API operation DescribeSpendLimits for usage and error information.

Returned Error Types:

  • ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.

  • AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.

  • ValidationException A validation exception for a field.

  • InternalServerException 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DescribeSpendLimits

func (*PinpointSMSVoiceV2) DescribeSpendLimitsPages

func (c *PinpointSMSVoiceV2) DescribeSpendLimitsPages(input *DescribeSpendLimitsInput, fn func(*DescribeSpendLimitsOutput, bool) bool) error

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

See DescribeSpendLimits method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a DescribeSpendLimits operation.
pageNum := 0
err := client.DescribeSpendLimitsPages(params,
    func(page *pinpointsmsvoicev2.DescribeSpendLimitsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*PinpointSMSVoiceV2) DescribeSpendLimitsPagesWithContext

func (c *PinpointSMSVoiceV2) DescribeSpendLimitsPagesWithContext(ctx aws.Context, input *DescribeSpendLimitsInput, fn func(*DescribeSpendLimitsOutput, bool) bool, opts ...request.Option) error

DescribeSpendLimitsPagesWithContext same as DescribeSpendLimitsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PinpointSMSVoiceV2) DescribeSpendLimitsRequest

func (c *PinpointSMSVoiceV2) DescribeSpendLimitsRequest(input *DescribeSpendLimitsInput) (req *request.Request, output *DescribeSpendLimitsOutput)

DescribeSpendLimitsRequest generates a "aws/request.Request" representing the client's request for the DescribeSpendLimits operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeSpendLimits for more information on using the DescribeSpendLimits API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeSpendLimitsRequest method.
req, resp := client.DescribeSpendLimitsRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DescribeSpendLimits

func (*PinpointSMSVoiceV2) DescribeSpendLimitsWithContext

func (c *PinpointSMSVoiceV2) DescribeSpendLimitsWithContext(ctx aws.Context, input *DescribeSpendLimitsInput, opts ...request.Option) (*DescribeSpendLimitsOutput, error)

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

See DescribeSpendLimits for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PinpointSMSVoiceV2) DisassociateOriginationIdentity

DisassociateOriginationIdentity API operation for Amazon Pinpoint SMS Voice V2.

Removes the specified origination identity from an existing pool.

If the origination identity isn't associated with the specified pool, an Error is returned.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint SMS Voice V2's API operation DisassociateOriginationIdentity for usage and error information.

Returned Error Types:

  • ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.

  • AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.

  • ResourceNotFoundException A requested resource couldn't be found.

  • ValidationException A validation exception for a field.

  • ConflictException 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.

  • InternalServerException 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DisassociateOriginationIdentity

func (*PinpointSMSVoiceV2) DisassociateOriginationIdentityRequest

func (c *PinpointSMSVoiceV2) DisassociateOriginationIdentityRequest(input *DisassociateOriginationIdentityInput) (req *request.Request, output *DisassociateOriginationIdentityOutput)

DisassociateOriginationIdentityRequest generates a "aws/request.Request" representing the client's request for the DisassociateOriginationIdentity operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DisassociateOriginationIdentity for more information on using the DisassociateOriginationIdentity API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DisassociateOriginationIdentityRequest method.
req, resp := client.DisassociateOriginationIdentityRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DisassociateOriginationIdentity

func (*PinpointSMSVoiceV2) DisassociateOriginationIdentityWithContext

func (c *PinpointSMSVoiceV2) DisassociateOriginationIdentityWithContext(ctx aws.Context, input *DisassociateOriginationIdentityInput, opts ...request.Option) (*DisassociateOriginationIdentityOutput, error)

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

See DisassociateOriginationIdentity for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PinpointSMSVoiceV2) ListPoolOriginationIdentities

ListPoolOriginationIdentities API operation for Amazon Pinpoint SMS Voice V2.

Lists all associated origination identities in your pool.

If you specify filters, the output includes information for only those origination identities that meet the filter criteria.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint SMS Voice V2's API operation ListPoolOriginationIdentities for usage and error information.

Returned Error Types:

  • ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.

  • AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.

  • ResourceNotFoundException A requested resource couldn't be found.

  • ValidationException A validation exception for a field.

  • InternalServerException 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/ListPoolOriginationIdentities

func (*PinpointSMSVoiceV2) ListPoolOriginationIdentitiesPages

func (c *PinpointSMSVoiceV2) ListPoolOriginationIdentitiesPages(input *ListPoolOriginationIdentitiesInput, fn func(*ListPoolOriginationIdentitiesOutput, bool) bool) error

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

See ListPoolOriginationIdentities method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListPoolOriginationIdentities operation.
pageNum := 0
err := client.ListPoolOriginationIdentitiesPages(params,
    func(page *pinpointsmsvoicev2.ListPoolOriginationIdentitiesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*PinpointSMSVoiceV2) ListPoolOriginationIdentitiesPagesWithContext

func (c *PinpointSMSVoiceV2) ListPoolOriginationIdentitiesPagesWithContext(ctx aws.Context, input *ListPoolOriginationIdentitiesInput, fn func(*ListPoolOriginationIdentitiesOutput, bool) bool, opts ...request.Option) error

ListPoolOriginationIdentitiesPagesWithContext same as ListPoolOriginationIdentitiesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PinpointSMSVoiceV2) ListPoolOriginationIdentitiesRequest

func (c *PinpointSMSVoiceV2) ListPoolOriginationIdentitiesRequest(input *ListPoolOriginationIdentitiesInput) (req *request.Request, output *ListPoolOriginationIdentitiesOutput)

ListPoolOriginationIdentitiesRequest generates a "aws/request.Request" representing the client's request for the ListPoolOriginationIdentities operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListPoolOriginationIdentities for more information on using the ListPoolOriginationIdentities API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListPoolOriginationIdentitiesRequest method.
req, resp := client.ListPoolOriginationIdentitiesRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/ListPoolOriginationIdentities

func (*PinpointSMSVoiceV2) ListPoolOriginationIdentitiesWithContext

func (c *PinpointSMSVoiceV2) ListPoolOriginationIdentitiesWithContext(ctx aws.Context, input *ListPoolOriginationIdentitiesInput, opts ...request.Option) (*ListPoolOriginationIdentitiesOutput, error)

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

See ListPoolOriginationIdentities for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PinpointSMSVoiceV2) ListTagsForResource

ListTagsForResource API operation for Amazon Pinpoint SMS Voice V2.

List all tags associated with a resource.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint SMS Voice V2's API operation ListTagsForResource for usage and error information.

Returned Error Types:

  • ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.

  • AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.

  • ResourceNotFoundException A requested resource couldn't be found.

  • ValidationException A validation exception for a field.

  • InternalServerException 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/ListTagsForResource

func (*PinpointSMSVoiceV2) ListTagsForResourceRequest

func (c *PinpointSMSVoiceV2) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput)

ListTagsForResourceRequest generates a "aws/request.Request" representing the client's request for the ListTagsForResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListTagsForResource for more information on using the ListTagsForResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListTagsForResourceRequest method.
req, resp := client.ListTagsForResourceRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/ListTagsForResource

func (*PinpointSMSVoiceV2) ListTagsForResourceWithContext

func (c *PinpointSMSVoiceV2) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error)

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

See ListTagsForResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PinpointSMSVoiceV2) PutKeyword

func (c *PinpointSMSVoiceV2) PutKeyword(input *PutKeywordInput) (*PutKeywordOutput, error)

PutKeyword API operation for Amazon Pinpoint SMS Voice V2.

Creates or updates a keyword configuration on an origination phone number or pool.

A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, Amazon Pinpoint responds with a customizable message.

If you specify a keyword that isn't valid, an Error is returned.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint SMS Voice V2's API operation PutKeyword for usage and error information.

Returned Error Types:

  • ServiceQuotaExceededException The request would cause a service quota to be exceeded.

  • ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.

  • AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.

  • ResourceNotFoundException A requested resource couldn't be found.

  • ValidationException A validation exception for a field.

  • ConflictException 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.

  • InternalServerException 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/PutKeyword

func (*PinpointSMSVoiceV2) PutKeywordRequest

func (c *PinpointSMSVoiceV2) PutKeywordRequest(input *PutKeywordInput) (req *request.Request, output *PutKeywordOutput)

PutKeywordRequest generates a "aws/request.Request" representing the client's request for the PutKeyword operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PutKeyword for more information on using the PutKeyword API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the PutKeywordRequest method.
req, resp := client.PutKeywordRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/PutKeyword

func (*PinpointSMSVoiceV2) PutKeywordWithContext

func (c *PinpointSMSVoiceV2) PutKeywordWithContext(ctx aws.Context, input *PutKeywordInput, opts ...request.Option) (*PutKeywordOutput, error)

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

See PutKeyword for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PinpointSMSVoiceV2) PutOptedOutNumber

PutOptedOutNumber API operation for Amazon Pinpoint SMS Voice V2.

Creates an opted out destination phone number in the opt-out list.

If the destination phone number isn't valid or if the specified opt-out list doesn't exist, an Error is returned.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint SMS Voice V2's API operation PutOptedOutNumber for usage and error information.

Returned Error Types:

  • ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.

  • AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.

  • ResourceNotFoundException A requested resource couldn't be found.

  • ValidationException A validation exception for a field.

  • InternalServerException 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/PutOptedOutNumber

func (*PinpointSMSVoiceV2) PutOptedOutNumberRequest

func (c *PinpointSMSVoiceV2) PutOptedOutNumberRequest(input *PutOptedOutNumberInput) (req *request.Request, output *PutOptedOutNumberOutput)

PutOptedOutNumberRequest generates a "aws/request.Request" representing the client's request for the PutOptedOutNumber operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PutOptedOutNumber for more information on using the PutOptedOutNumber API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the PutOptedOutNumberRequest method.
req, resp := client.PutOptedOutNumberRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/PutOptedOutNumber

func (*PinpointSMSVoiceV2) PutOptedOutNumberWithContext

func (c *PinpointSMSVoiceV2) PutOptedOutNumberWithContext(ctx aws.Context, input *PutOptedOutNumberInput, opts ...request.Option) (*PutOptedOutNumberOutput, error)

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

See PutOptedOutNumber for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PinpointSMSVoiceV2) ReleasePhoneNumber

ReleasePhoneNumber API operation for Amazon Pinpoint SMS Voice V2.

Releases an existing origination phone number in your account. Once released, a phone number is no longer available for sending messages.

If the origination phone number has deletion protection enabled or is associated with a pool, an Error is returned.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint SMS Voice V2's API operation ReleasePhoneNumber for usage and error information.

Returned Error Types:

  • ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.

  • AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.

  • ResourceNotFoundException A requested resource couldn't be found.

  • ValidationException A validation exception for a field.

  • ConflictException 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.

  • InternalServerException 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/ReleasePhoneNumber

func (*PinpointSMSVoiceV2) ReleasePhoneNumberRequest

func (c *PinpointSMSVoiceV2) ReleasePhoneNumberRequest(input *ReleasePhoneNumberInput) (req *request.Request, output *ReleasePhoneNumberOutput)

ReleasePhoneNumberRequest generates a "aws/request.Request" representing the client's request for the ReleasePhoneNumber operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ReleasePhoneNumber for more information on using the ReleasePhoneNumber API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ReleasePhoneNumberRequest method.
req, resp := client.ReleasePhoneNumberRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/ReleasePhoneNumber

func (*PinpointSMSVoiceV2) ReleasePhoneNumberWithContext

func (c *PinpointSMSVoiceV2) ReleasePhoneNumberWithContext(ctx aws.Context, input *ReleasePhoneNumberInput, opts ...request.Option) (*ReleasePhoneNumberOutput, error)

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

See ReleasePhoneNumber for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PinpointSMSVoiceV2) RequestPhoneNumber

RequestPhoneNumber API operation for Amazon Pinpoint SMS Voice V2.

Request an origination phone number for use in your account. For more information on phone number request see Requesting a number (https://docs.aws.amazon.com/pinpoint/latest/userguide/settings-sms-request-number.html) in the Amazon Pinpoint User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint SMS Voice V2's API operation RequestPhoneNumber for usage and error information.

Returned Error Types:

  • ServiceQuotaExceededException The request would cause a service quota to be exceeded.

  • ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.

  • AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.

  • ResourceNotFoundException A requested resource couldn't be found.

  • ValidationException A validation exception for a field.

  • ConflictException 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.

  • InternalServerException 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/RequestPhoneNumber

func (*PinpointSMSVoiceV2) RequestPhoneNumberRequest

func (c *PinpointSMSVoiceV2) RequestPhoneNumberRequest(input *RequestPhoneNumberInput) (req *request.Request, output *RequestPhoneNumberOutput)

RequestPhoneNumberRequest generates a "aws/request.Request" representing the client's request for the RequestPhoneNumber operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RequestPhoneNumber for more information on using the RequestPhoneNumber API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the RequestPhoneNumberRequest method.
req, resp := client.RequestPhoneNumberRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/RequestPhoneNumber

func (*PinpointSMSVoiceV2) RequestPhoneNumberWithContext

func (c *PinpointSMSVoiceV2) RequestPhoneNumberWithContext(ctx aws.Context, input *RequestPhoneNumberInput, opts ...request.Option) (*RequestPhoneNumberOutput, error)

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

See RequestPhoneNumber for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PinpointSMSVoiceV2) SendTextMessage

func (c *PinpointSMSVoiceV2) SendTextMessage(input *SendTextMessageInput) (*SendTextMessageOutput, error)

SendTextMessage API operation for Amazon Pinpoint SMS Voice V2.

Creates a new text message and sends it to a recipient's phone number.

SMS throughput limits are measured in Message Parts per Second (MPS). Your MPS limit depends on the destination country of your messages, as well as the type of phone number (origination number) that you use to send the message. For more information, see Message Parts per Second (MPS) limits (https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-sms-limitations-mps.html) in the Amazon Pinpoint User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint SMS Voice V2's API operation SendTextMessage for usage and error information.

Returned Error Types:

  • ServiceQuotaExceededException The request would cause a service quota to be exceeded.

  • ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.

  • AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.

  • ResourceNotFoundException A requested resource couldn't be found.

  • ValidationException A validation exception for a field.

  • ConflictException 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.

  • InternalServerException 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/SendTextMessage

func (*PinpointSMSVoiceV2) SendTextMessageRequest

func (c *PinpointSMSVoiceV2) SendTextMessageRequest(input *SendTextMessageInput) (req *request.Request, output *SendTextMessageOutput)

SendTextMessageRequest generates a "aws/request.Request" representing the client's request for the SendTextMessage operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See SendTextMessage for more information on using the SendTextMessage API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the SendTextMessageRequest method.
req, resp := client.SendTextMessageRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/SendTextMessage

func (*PinpointSMSVoiceV2) SendTextMessageWithContext

func (c *PinpointSMSVoiceV2) SendTextMessageWithContext(ctx aws.Context, input *SendTextMessageInput, opts ...request.Option) (*SendTextMessageOutput, error)

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

See SendTextMessage for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PinpointSMSVoiceV2) SendVoiceMessage

func (c *PinpointSMSVoiceV2) SendVoiceMessage(input *SendVoiceMessageInput) (*SendVoiceMessageOutput, error)

SendVoiceMessage API operation for Amazon Pinpoint SMS Voice V2.

Allows you to send a request that sends a text message through Amazon Pinpoint. This operation uses Amazon Polly (http://aws.amazon.com/polly/) to convert a text script into a voice message.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint SMS Voice V2's API operation SendVoiceMessage for usage and error information.

Returned Error Types:

  • ServiceQuotaExceededException The request would cause a service quota to be exceeded.

  • ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.

  • AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.

  • ResourceNotFoundException A requested resource couldn't be found.

  • ValidationException A validation exception for a field.

  • ConflictException 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.

  • InternalServerException 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/SendVoiceMessage

func (*PinpointSMSVoiceV2) SendVoiceMessageRequest

func (c *PinpointSMSVoiceV2) SendVoiceMessageRequest(input *SendVoiceMessageInput) (req *request.Request, output *SendVoiceMessageOutput)

SendVoiceMessageRequest generates a "aws/request.Request" representing the client's request for the SendVoiceMessage operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See SendVoiceMessage for more information on using the SendVoiceMessage API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the SendVoiceMessageRequest method.
req, resp := client.SendVoiceMessageRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/SendVoiceMessage

func (*PinpointSMSVoiceV2) SendVoiceMessageWithContext

func (c *PinpointSMSVoiceV2) SendVoiceMessageWithContext(ctx aws.Context, input *SendVoiceMessageInput, opts ...request.Option) (*SendVoiceMessageOutput, error)

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

See SendVoiceMessage for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PinpointSMSVoiceV2) SetDefaultMessageType

SetDefaultMessageType API operation for Amazon Pinpoint SMS Voice V2.

Sets the default message type on a configuration set.

Choose the category of SMS messages that you plan to send from this account. If you send account-related messages or time-sensitive messages such as one-time passcodes, choose Transactional. If you plan to send messages that contain marketing material or other promotional content, choose Promotional. This setting applies to your entire Amazon Web Services account.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint SMS Voice V2's API operation SetDefaultMessageType for usage and error information.

Returned Error Types:

  • ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.

  • AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.

  • ResourceNotFoundException A requested resource couldn't be found.

  • ValidationException A validation exception for a field.

  • InternalServerException 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/SetDefaultMessageType

func (*PinpointSMSVoiceV2) SetDefaultMessageTypeRequest

func (c *PinpointSMSVoiceV2) SetDefaultMessageTypeRequest(input *SetDefaultMessageTypeInput) (req *request.Request, output *SetDefaultMessageTypeOutput)

SetDefaultMessageTypeRequest generates a "aws/request.Request" representing the client's request for the SetDefaultMessageType operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See SetDefaultMessageType for more information on using the SetDefaultMessageType API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the SetDefaultMessageTypeRequest method.
req, resp := client.SetDefaultMessageTypeRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/SetDefaultMessageType

func (*PinpointSMSVoiceV2) SetDefaultMessageTypeWithContext

func (c *PinpointSMSVoiceV2) SetDefaultMessageTypeWithContext(ctx aws.Context, input *SetDefaultMessageTypeInput, opts ...request.Option) (*SetDefaultMessageTypeOutput, error)

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

See SetDefaultMessageType for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PinpointSMSVoiceV2) SetDefaultSenderId

SetDefaultSenderId API operation for Amazon Pinpoint SMS Voice V2.

Sets default sender ID on a configuration set.

When sending a text message to a destination country that supports sender IDs, the default sender ID on the configuration set specified will be used if no dedicated origination phone numbers or registered sender IDs are available in your account.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint SMS Voice V2's API operation SetDefaultSenderId for usage and error information.

Returned Error Types:

  • ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.

  • AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.

  • ResourceNotFoundException A requested resource couldn't be found.

  • ValidationException A validation exception for a field.

  • InternalServerException 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/SetDefaultSenderId

func (*PinpointSMSVoiceV2) SetDefaultSenderIdRequest

func (c *PinpointSMSVoiceV2) SetDefaultSenderIdRequest(input *SetDefaultSenderIdInput) (req *request.Request, output *SetDefaultSenderIdOutput)

SetDefaultSenderIdRequest generates a "aws/request.Request" representing the client's request for the SetDefaultSenderId operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See SetDefaultSenderId for more information on using the SetDefaultSenderId API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the SetDefaultSenderIdRequest method.
req, resp := client.SetDefaultSenderIdRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/SetDefaultSenderId

func (*PinpointSMSVoiceV2) SetDefaultSenderIdWithContext

func (c *PinpointSMSVoiceV2) SetDefaultSenderIdWithContext(ctx aws.Context, input *SetDefaultSenderIdInput, opts ...request.Option) (*SetDefaultSenderIdOutput, error)

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

See SetDefaultSenderId for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PinpointSMSVoiceV2) SetTextMessageSpendLimitOverride

SetTextMessageSpendLimitOverride API operation for Amazon Pinpoint SMS Voice V2.

Sets an account level monthly spend limit override for sending text messages. The requested spend limit must be less than or equal to the MaxLimit, which is set by Amazon Web Services.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint SMS Voice V2's API operation SetTextMessageSpendLimitOverride for usage and error information.

Returned Error Types:

  • ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.

  • AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.

  • ValidationException A validation exception for a field.

  • InternalServerException 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/SetTextMessageSpendLimitOverride

func (*PinpointSMSVoiceV2) SetTextMessageSpendLimitOverrideRequest

func (c *PinpointSMSVoiceV2) SetTextMessageSpendLimitOverrideRequest(input *SetTextMessageSpendLimitOverrideInput) (req *request.Request, output *SetTextMessageSpendLimitOverrideOutput)

SetTextMessageSpendLimitOverrideRequest generates a "aws/request.Request" representing the client's request for the SetTextMessageSpendLimitOverride operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See SetTextMessageSpendLimitOverride for more information on using the SetTextMessageSpendLimitOverride API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the SetTextMessageSpendLimitOverrideRequest method.
req, resp := client.SetTextMessageSpendLimitOverrideRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/SetTextMessageSpendLimitOverride

func (*PinpointSMSVoiceV2) SetTextMessageSpendLimitOverrideWithContext

func (c *PinpointSMSVoiceV2) SetTextMessageSpendLimitOverrideWithContext(ctx aws.Context, input *SetTextMessageSpendLimitOverrideInput, opts ...request.Option) (*SetTextMessageSpendLimitOverrideOutput, error)

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

See SetTextMessageSpendLimitOverride for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PinpointSMSVoiceV2) SetVoiceMessageSpendLimitOverride

SetVoiceMessageSpendLimitOverride API operation for Amazon Pinpoint SMS Voice V2.

Sets an account level monthly spend limit override for sending voice messages. The requested spend limit must be less than or equal to the MaxLimit, which is set by Amazon Web Services.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint SMS Voice V2's API operation SetVoiceMessageSpendLimitOverride for usage and error information.

Returned Error Types:

  • ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.

  • AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.

  • ValidationException A validation exception for a field.

  • InternalServerException 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/SetVoiceMessageSpendLimitOverride

func (*PinpointSMSVoiceV2) SetVoiceMessageSpendLimitOverrideRequest

func (c *PinpointSMSVoiceV2) SetVoiceMessageSpendLimitOverrideRequest(input *SetVoiceMessageSpendLimitOverrideInput) (req *request.Request, output *SetVoiceMessageSpendLimitOverrideOutput)

SetVoiceMessageSpendLimitOverrideRequest generates a "aws/request.Request" representing the client's request for the SetVoiceMessageSpendLimitOverride operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See SetVoiceMessageSpendLimitOverride for more information on using the SetVoiceMessageSpendLimitOverride API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the SetVoiceMessageSpendLimitOverrideRequest method.
req, resp := client.SetVoiceMessageSpendLimitOverrideRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/SetVoiceMessageSpendLimitOverride

func (*PinpointSMSVoiceV2) SetVoiceMessageSpendLimitOverrideWithContext

func (c *PinpointSMSVoiceV2) SetVoiceMessageSpendLimitOverrideWithContext(ctx aws.Context, input *SetVoiceMessageSpendLimitOverrideInput, opts ...request.Option) (*SetVoiceMessageSpendLimitOverrideOutput, error)

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

See SetVoiceMessageSpendLimitOverride for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PinpointSMSVoiceV2) TagResource

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

TagResource API operation for Amazon Pinpoint SMS Voice V2.

Adds or overwrites only the specified tags for the specified Amazon Pinpoint SMS Voice, version 2 resource. When you specify an existing tag key, the value is overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and an optional value. Tag keys must be unique per resource. For more information about tags, see Tagging Amazon Pinpoint resources (https://docs.aws.amazon.com/pinpoint/latest/developerguide/tagging-resources.html) in the Amazon Pinpoint Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint SMS Voice V2's API operation TagResource for usage and error information.

Returned Error Types:

  • ServiceQuotaExceededException The request would cause a service quota to be exceeded.

  • ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.

  • AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.

  • ResourceNotFoundException A requested resource couldn't be found.

  • ValidationException A validation exception for a field.

  • InternalServerException 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/TagResource

func (*PinpointSMSVoiceV2) TagResourceRequest

func (c *PinpointSMSVoiceV2) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput)

TagResourceRequest generates a "aws/request.Request" representing the client's request for the TagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See TagResource for more information on using the TagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the TagResourceRequest method.
req, resp := client.TagResourceRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/TagResource

func (*PinpointSMSVoiceV2) TagResourceWithContext

func (c *PinpointSMSVoiceV2) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error)

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

See TagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PinpointSMSVoiceV2) UntagResource

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

UntagResource API operation for Amazon Pinpoint SMS Voice V2.

Removes the association of the specified tags from an Amazon Pinpoint SMS Voice V2 resource. For more information on tags see Tagging Amazon Pinpoint resources (https://docs.aws.amazon.com/pinpoint/latest/developerguide/tagging-resources.html) in the Amazon Pinpoint Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint SMS Voice V2's API operation UntagResource for usage and error information.

Returned Error Types:

  • ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.

  • AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.

  • ResourceNotFoundException A requested resource couldn't be found.

  • ValidationException A validation exception for a field.

  • InternalServerException 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/UntagResource

func (*PinpointSMSVoiceV2) UntagResourceRequest

func (c *PinpointSMSVoiceV2) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput)

UntagResourceRequest generates a "aws/request.Request" representing the client's request for the UntagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UntagResource for more information on using the UntagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UntagResourceRequest method.
req, resp := client.UntagResourceRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/UntagResource

func (*PinpointSMSVoiceV2) UntagResourceWithContext

func (c *PinpointSMSVoiceV2) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error)

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

See UntagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PinpointSMSVoiceV2) UpdateEventDestination

UpdateEventDestination API operation for Amazon Pinpoint SMS Voice V2.

Updates an existing event destination in a configuration set. You can update the IAM role ARN for CloudWatch Logs and Kinesis Data Firehose. You can also enable or disable the event destination.

You may want to update an event destination to change its matching event types or updating the destination resource ARN. You can't change an event destination's type between CloudWatch Logs, Kinesis Data Firehose, and Amazon SNS.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint SMS Voice V2's API operation UpdateEventDestination for usage and error information.

Returned Error Types:

  • ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.

  • AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.

  • ResourceNotFoundException A requested resource couldn't be found.

  • ValidationException A validation exception for a field.

  • ConflictException 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.

  • InternalServerException 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/UpdateEventDestination

func (*PinpointSMSVoiceV2) UpdateEventDestinationRequest

func (c *PinpointSMSVoiceV2) UpdateEventDestinationRequest(input *UpdateEventDestinationInput) (req *request.Request, output *UpdateEventDestinationOutput)

UpdateEventDestinationRequest generates a "aws/request.Request" representing the client's request for the UpdateEventDestination operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateEventDestination for more information on using the UpdateEventDestination API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateEventDestinationRequest method.
req, resp := client.UpdateEventDestinationRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/UpdateEventDestination

func (*PinpointSMSVoiceV2) UpdateEventDestinationWithContext

func (c *PinpointSMSVoiceV2) UpdateEventDestinationWithContext(ctx aws.Context, input *UpdateEventDestinationInput, opts ...request.Option) (*UpdateEventDestinationOutput, error)

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

See UpdateEventDestination for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PinpointSMSVoiceV2) UpdatePhoneNumber

UpdatePhoneNumber API operation for Amazon Pinpoint SMS Voice V2.

Updates the configuration of an existing origination phone number. You can update the opt-out list, enable or disable two-way messaging, change the TwoWayChannelArn, enable or disable self-managed opt-outs, and enable or disable deletion protection.

If the origination phone number is associated with a pool, an Error is returned.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint SMS Voice V2's API operation UpdatePhoneNumber for usage and error information.

Returned Error Types:

  • ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.

  • AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.

  • ResourceNotFoundException A requested resource couldn't be found.

  • ValidationException A validation exception for a field.

  • ConflictException 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.

  • InternalServerException 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/UpdatePhoneNumber

func (*PinpointSMSVoiceV2) UpdatePhoneNumberRequest

func (c *PinpointSMSVoiceV2) UpdatePhoneNumberRequest(input *UpdatePhoneNumberInput) (req *request.Request, output *UpdatePhoneNumberOutput)

UpdatePhoneNumberRequest generates a "aws/request.Request" representing the client's request for the UpdatePhoneNumber operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdatePhoneNumber for more information on using the UpdatePhoneNumber API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdatePhoneNumberRequest method.
req, resp := client.UpdatePhoneNumberRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/UpdatePhoneNumber

func (*PinpointSMSVoiceV2) UpdatePhoneNumberWithContext

func (c *PinpointSMSVoiceV2) UpdatePhoneNumberWithContext(ctx aws.Context, input *UpdatePhoneNumberInput, opts ...request.Option) (*UpdatePhoneNumberOutput, error)

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

See UpdatePhoneNumber for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PinpointSMSVoiceV2) UpdatePool

func (c *PinpointSMSVoiceV2) UpdatePool(input *UpdatePoolInput) (*UpdatePoolOutput, error)

UpdatePool API operation for Amazon Pinpoint SMS Voice V2.

Updates the configuration of an existing pool. You can update the opt-out list, enable or disable two-way messaging, change the TwoWayChannelArn, enable or disable self-managed opt-outs, enable or disable deletion protection, and enable or disable shared routes.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint SMS Voice V2's API operation UpdatePool for usage and error information.

Returned Error Types:

  • ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.

  • AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.

  • ResourceNotFoundException A requested resource couldn't be found.

  • ValidationException A validation exception for a field.

  • ConflictException 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.

  • InternalServerException 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/UpdatePool

func (*PinpointSMSVoiceV2) UpdatePoolRequest

func (c *PinpointSMSVoiceV2) UpdatePoolRequest(input *UpdatePoolInput) (req *request.Request, output *UpdatePoolOutput)

UpdatePoolRequest generates a "aws/request.Request" representing the client's request for the UpdatePool operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdatePool for more information on using the UpdatePool API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdatePoolRequest method.
req, resp := client.UpdatePoolRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/UpdatePool

func (*PinpointSMSVoiceV2) UpdatePoolWithContext

func (c *PinpointSMSVoiceV2) UpdatePoolWithContext(ctx aws.Context, input *UpdatePoolInput, opts ...request.Option) (*UpdatePoolOutput, error)

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

See UpdatePool for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type PoolFilter

type PoolFilter struct {

	// The name of the attribute to filter on.
	//
	// Name is a required field
	Name *string `type:"string" required:"true" enum:"PoolFilterName"`

	// An array values to filter for.
	//
	// Values is a required field
	Values []*string `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

The information for a pool that meets a specified criteria.

func (PoolFilter) GoString

func (s PoolFilter) GoString() string

GoString returns the string representation.

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

func (*PoolFilter) SetName

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

SetName sets the Name field's value.

func (*PoolFilter) SetValues

func (s *PoolFilter) SetValues(v []*string) *PoolFilter

SetValues sets the Values field's value.

func (PoolFilter) String

func (s PoolFilter) String() string

String returns the string representation.

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

func (*PoolFilter) Validate

func (s *PoolFilter) Validate() error

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

type PoolInformation

type PoolInformation struct {

	// The time when the pool was created, in UNIX epoch time (https://www.epochconverter.com/)
	// format.
	//
	// CreatedTimestamp is a required field
	CreatedTimestamp *time.Time `type:"timestamp" required:"true"`

	// When set to true the pool can't be deleted.
	//
	// DeletionProtectionEnabled is a required field
	DeletionProtectionEnabled *bool `type:"boolean" required:"true"`

	// 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.
	//
	// MessageType is a required field
	MessageType *string `type:"string" required:"true" enum:"MessageType"`

	// The name of the OptOutList associated with the pool.
	//
	// OptOutListName is a required field
	OptOutListName *string `min:"1" type:"string" required:"true"`

	// The Amazon Resource Name (ARN) for the pool.
	//
	// PoolArn is a required field
	PoolArn *string `type:"string" required:"true"`

	// The unique identifier for the pool.
	//
	// PoolId is a required field
	PoolId *string `type:"string" required:"true"`

	// 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 (https://docs.aws.amazon.com/pinpoint/latest/userguide/settings-sms-managing.html#settings-account-sms-self-managed-opt-out)
	//
	// SelfManagedOptOutsEnabled is a required field
	SelfManagedOptOutsEnabled *bool `type:"boolean" required:"true"`

	// Allows you to enable shared routes on your pool.
	//
	// 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.
	//
	// SharedRoutesEnabled is a required field
	SharedRoutesEnabled *bool `type:"boolean" required:"true"`

	// The current status of the pool.
	//
	// Status is a required field
	Status *string `type:"string" required:"true" enum:"PoolStatus"`

	// The Amazon Resource Name (ARN) of the two way channel.
	TwoWayChannelArn *string `min:"20" type:"string"`

	// When set to true you can receive incoming text messages from your end recipients
	// using the TwoWayChannelArn.
	//
	// TwoWayEnabled is a required field
	TwoWayEnabled *bool `type:"boolean" required:"true"`
	// contains filtered or unexported fields
}

The information for a pool in an Amazon Web Services account.

func (PoolInformation) GoString

func (s PoolInformation) GoString() string

GoString returns the string representation.

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

func (*PoolInformation) SetCreatedTimestamp

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

SetCreatedTimestamp sets the CreatedTimestamp field's value.

func (*PoolInformation) SetDeletionProtectionEnabled

func (s *PoolInformation) SetDeletionProtectionEnabled(v bool) *PoolInformation

SetDeletionProtectionEnabled sets the DeletionProtectionEnabled field's value.

func (*PoolInformation) SetMessageType

func (s *PoolInformation) SetMessageType(v string) *PoolInformation

SetMessageType sets the MessageType field's value.

func (*PoolInformation) SetOptOutListName

func (s *PoolInformation) SetOptOutListName(v string) *PoolInformation

SetOptOutListName sets the OptOutListName field's value.

func (*PoolInformation) SetPoolArn

func (s *PoolInformation) SetPoolArn(v string) *PoolInformation

SetPoolArn sets the PoolArn field's value.

func (*PoolInformation) SetPoolId

func (s *PoolInformation) SetPoolId(v string) *PoolInformation

SetPoolId sets the PoolId field's value.

func (*PoolInformation) SetSelfManagedOptOutsEnabled

func (s *PoolInformation) SetSelfManagedOptOutsEnabled(v bool) *PoolInformation

SetSelfManagedOptOutsEnabled sets the SelfManagedOptOutsEnabled field's value.

func (*PoolInformation) SetSharedRoutesEnabled

func (s *PoolInformation) SetSharedRoutesEnabled(v bool) *PoolInformation

SetSharedRoutesEnabled sets the SharedRoutesEnabled field's value.

func (*PoolInformation) SetStatus

func (s *PoolInformation) SetStatus(v string) *PoolInformation

SetStatus sets the Status field's value.

func (*PoolInformation) SetTwoWayChannelArn

func (s *PoolInformation) SetTwoWayChannelArn(v string) *PoolInformation

SetTwoWayChannelArn sets the TwoWayChannelArn field's value.

func (*PoolInformation) SetTwoWayEnabled

func (s *PoolInformation) SetTwoWayEnabled(v bool) *PoolInformation

SetTwoWayEnabled sets the TwoWayEnabled field's value.

func (PoolInformation) String

func (s PoolInformation) String() string

String returns the string representation.

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

type PoolOriginationIdentitiesFilter

type PoolOriginationIdentitiesFilter struct {

	// The name of the attribute to filter on.
	//
	// Name is a required field
	Name *string `type:"string" required:"true" enum:"PoolOriginationIdentitiesFilterName"`

	// An array values to filter for.
	//
	// Values is a required field
	Values []*string `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

Information about origination identities associated with a pool that meets a specified criteria.

func (PoolOriginationIdentitiesFilter) GoString

GoString returns the string representation.

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

func (*PoolOriginationIdentitiesFilter) SetName

SetName sets the Name field's value.

func (*PoolOriginationIdentitiesFilter) SetValues

SetValues sets the Values field's value.

func (PoolOriginationIdentitiesFilter) String

String returns the string representation.

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

func (*PoolOriginationIdentitiesFilter) Validate

func (s *PoolOriginationIdentitiesFilter) Validate() error

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

type PutKeywordInput

type PutKeywordInput struct {

	// The new keyword to add.
	//
	// Keyword is a required field
	Keyword *string `min:"1" type:"string" required:"true"`

	// The action to perform for the new keyword when it is received.
	KeywordAction *string `type:"string" enum:"KeywordAction"`

	// The message associated with the keyword.
	//
	//    * AUTOMATIC_RESPONSE: A message is sent to the recipient.
	//
	//    * OPT_OUT: Keeps the recipient from receiving future messages.
	//
	//    * OPT_IN: The recipient wants to receive future messages.
	//
	// KeywordMessage is a required field
	KeywordMessage *string `min:"1" type:"string" required:"true"`

	// The origination identity to use such as a PhoneNumberId, PhoneNumberArn,
	// SenderId or SenderIdArn. You can use DescribePhoneNumbers get the values
	// for PhoneNumberId and PhoneNumberArn while DescribeSenderIds can be used
	// to get the values for SenderId and SenderIdArn.
	//
	// OriginationIdentity is a required field
	OriginationIdentity *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (PutKeywordInput) GoString

func (s PutKeywordInput) GoString() string

GoString returns the string representation.

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

func (*PutKeywordInput) SetKeyword

func (s *PutKeywordInput) SetKeyword(v string) *PutKeywordInput

SetKeyword sets the Keyword field's value.

func (*PutKeywordInput) SetKeywordAction

func (s *PutKeywordInput) SetKeywordAction(v string) *PutKeywordInput

SetKeywordAction sets the KeywordAction field's value.

func (*PutKeywordInput) SetKeywordMessage

func (s *PutKeywordInput) SetKeywordMessage(v string) *PutKeywordInput

SetKeywordMessage sets the KeywordMessage field's value.

func (*PutKeywordInput) SetOriginationIdentity

func (s *PutKeywordInput) SetOriginationIdentity(v string) *PutKeywordInput

SetOriginationIdentity sets the OriginationIdentity field's value.

func (PutKeywordInput) String

func (s PutKeywordInput) String() string

String returns the string representation.

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

func (*PutKeywordInput) Validate

func (s *PutKeywordInput) Validate() error

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

type PutKeywordOutput

type PutKeywordOutput struct {

	// The keyword that was added.
	Keyword *string `min:"1" type:"string"`

	// The action to perform when the keyword is used.
	KeywordAction *string `type:"string" enum:"KeywordAction"`

	// The message associated with the keyword.
	KeywordMessage *string `min:"1" type:"string"`

	// The PhoneNumberId or PoolId that the keyword was associated with.
	OriginationIdentity *string `type:"string"`

	// The PhoneNumberArn or PoolArn that the keyword was associated with.
	OriginationIdentityArn *string `type:"string"`
	// contains filtered or unexported fields
}

func (PutKeywordOutput) GoString

func (s PutKeywordOutput) GoString() string

GoString returns the string representation.

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

func (*PutKeywordOutput) SetKeyword

func (s *PutKeywordOutput) SetKeyword(v string) *PutKeywordOutput

SetKeyword sets the Keyword field's value.

func (*PutKeywordOutput) SetKeywordAction

func (s *PutKeywordOutput) SetKeywordAction(v string) *PutKeywordOutput

SetKeywordAction sets the KeywordAction field's value.

func (*PutKeywordOutput) SetKeywordMessage

func (s *PutKeywordOutput) SetKeywordMessage(v string) *PutKeywordOutput

SetKeywordMessage sets the KeywordMessage field's value.

func (*PutKeywordOutput) SetOriginationIdentity

func (s *PutKeywordOutput) SetOriginationIdentity(v string) *PutKeywordOutput

SetOriginationIdentity sets the OriginationIdentity field's value.

func (*PutKeywordOutput) SetOriginationIdentityArn

func (s *PutKeywordOutput) SetOriginationIdentityArn(v string) *PutKeywordOutput

SetOriginationIdentityArn sets the OriginationIdentityArn field's value.

func (PutKeywordOutput) String

func (s PutKeywordOutput) String() string

String returns the string representation.

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

type PutOptedOutNumberInput

type PutOptedOutNumberInput struct {

	// The OptOutListName or OptOutListArn to add the phone number to.
	//
	// OptOutListName is a required field
	OptOutListName *string `min:"1" type:"string" required:"true"`

	// The phone number to add to the OptOutList in E.164 format.
	//
	// OptedOutNumber is a required field
	OptedOutNumber *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (PutOptedOutNumberInput) GoString

func (s PutOptedOutNumberInput) GoString() string

GoString returns the string representation.

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

func (*PutOptedOutNumberInput) SetOptOutListName

func (s *PutOptedOutNumberInput) SetOptOutListName(v string) *PutOptedOutNumberInput

SetOptOutListName sets the OptOutListName field's value.

func (*PutOptedOutNumberInput) SetOptedOutNumber

func (s *PutOptedOutNumberInput) SetOptedOutNumber(v string) *PutOptedOutNumberInput

SetOptedOutNumber sets the OptedOutNumber field's value.

func (PutOptedOutNumberInput) String

func (s PutOptedOutNumberInput) String() string

String returns the string representation.

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

func (*PutOptedOutNumberInput) Validate

func (s *PutOptedOutNumberInput) Validate() error

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

type PutOptedOutNumberOutput

type PutOptedOutNumberOutput struct {

	// This is true if it was the end user who requested their phone number be removed.
	EndUserOptedOut *bool `type:"boolean"`

	// The OptOutListArn that the phone number was removed from.
	OptOutListArn *string `type:"string"`

	// The OptOutListName that the phone number was removed from.
	OptOutListName *string `min:"1" type:"string"`

	// The phone number that was added to the OptOutList.
	OptedOutNumber *string `min:"1" type:"string"`

	// The time that the phone number was added to the OptOutList, in UNIX epoch
	// time (https://www.epochconverter.com/) format.
	OptedOutTimestamp *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

func (PutOptedOutNumberOutput) GoString

func (s PutOptedOutNumberOutput) GoString() string

GoString returns the string representation.

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

func (*PutOptedOutNumberOutput) SetEndUserOptedOut

func (s *PutOptedOutNumberOutput) SetEndUserOptedOut(v bool) *PutOptedOutNumberOutput

SetEndUserOptedOut sets the EndUserOptedOut field's value.

func (*PutOptedOutNumberOutput) SetOptOutListArn

func (s *PutOptedOutNumberOutput) SetOptOutListArn(v string) *PutOptedOutNumberOutput

SetOptOutListArn sets the OptOutListArn field's value.

func (*PutOptedOutNumberOutput) SetOptOutListName

func (s *PutOptedOutNumberOutput) SetOptOutListName(v string) *PutOptedOutNumberOutput

SetOptOutListName sets the OptOutListName field's value.

func (*PutOptedOutNumberOutput) SetOptedOutNumber

func (s *PutOptedOutNumberOutput) SetOptedOutNumber(v string) *PutOptedOutNumberOutput

SetOptedOutNumber sets the OptedOutNumber field's value.

func (*PutOptedOutNumberOutput) SetOptedOutTimestamp

func (s *PutOptedOutNumberOutput) SetOptedOutTimestamp(v time.Time) *PutOptedOutNumberOutput

SetOptedOutTimestamp sets the OptedOutTimestamp field's value.

func (PutOptedOutNumberOutput) String

func (s PutOptedOutNumberOutput) String() string

String returns the string representation.

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

type ReleasePhoneNumberInput

type ReleasePhoneNumberInput struct {

	// The PhoneNumberId or PhoneNumberArn of the phone number to release. You can
	// use DescribePhoneNumbers to get the values for PhoneNumberId and PhoneNumberArn.
	//
	// PhoneNumberId is a required field
	PhoneNumberId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ReleasePhoneNumberInput) GoString

func (s ReleasePhoneNumberInput) GoString() string

GoString returns the string representation.

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

func (*ReleasePhoneNumberInput) SetPhoneNumberId

func (s *ReleasePhoneNumberInput) SetPhoneNumberId(v string) *ReleasePhoneNumberInput

SetPhoneNumberId sets the PhoneNumberId field's value.

func (ReleasePhoneNumberInput) String

func (s ReleasePhoneNumberInput) String() string

String returns the string representation.

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

func (*ReleasePhoneNumberInput) Validate

func (s *ReleasePhoneNumberInput) Validate() error

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

type ReleasePhoneNumberOutput

type ReleasePhoneNumberOutput struct {

	// The time when the phone number was created, in UNIX epoch time (https://www.epochconverter.com/)
	// format.
	CreatedTimestamp *time.Time `type:"timestamp"`

	// The two-character code, in ISO 3166-1 alpha-2 format, for the country or
	// region.
	IsoCountryCode *string `min:"2" type:"string"`

	// The message type that was associated with the phone number.
	MessageType *string `type:"string" enum:"MessageType"`

	// The monthly price of the phone number, in US dollars.
	MonthlyLeasingPrice *string `type:"string"`

	// Specifies if the number could be used for text messages, voice, or both.
	NumberCapabilities []*string `min:"1" type:"list" enum:"NumberCapability"`

	// The type of number that was released.
	NumberType *string `type:"string" enum:"NumberType"`

	// The name of the OptOutList that was associated with the phone number.
	OptOutListName *string `min:"1" type:"string"`

	// The phone number that was released.
	PhoneNumber *string `min:"1" type:"string"`

	// The PhoneNumberArn of the phone number that was released.
	PhoneNumberArn *string `type:"string"`

	// The PhoneNumberId of the phone number that was released.
	PhoneNumberId *string `type:"string"`

	// By default this is set to false. When 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.
	SelfManagedOptOutsEnabled *bool `type:"boolean"`

	// The current status of the request.
	Status *string `type:"string" enum:"NumberStatus"`

	// The Amazon Resource Name (ARN) of the TwoWayChannel.
	TwoWayChannelArn *string `min:"20" type:"string"`

	// By default this is set to false. When set to true you can receive incoming
	// text messages from your end recipients.
	TwoWayEnabled *bool `type:"boolean"`
	// contains filtered or unexported fields
}

func (ReleasePhoneNumberOutput) GoString

func (s ReleasePhoneNumberOutput) GoString() string

GoString returns the string representation.

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

func (*ReleasePhoneNumberOutput) SetCreatedTimestamp

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

SetCreatedTimestamp sets the CreatedTimestamp field's value.

func (*ReleasePhoneNumberOutput) SetIsoCountryCode

func (s *ReleasePhoneNumberOutput) SetIsoCountryCode(v string) *ReleasePhoneNumberOutput

SetIsoCountryCode sets the IsoCountryCode field's value.

func (*ReleasePhoneNumberOutput) SetMessageType

SetMessageType sets the MessageType field's value.

func (*ReleasePhoneNumberOutput) SetMonthlyLeasingPrice

func (s *ReleasePhoneNumberOutput) SetMonthlyLeasingPrice(v string) *ReleasePhoneNumberOutput

SetMonthlyLeasingPrice sets the MonthlyLeasingPrice field's value.

func (*ReleasePhoneNumberOutput) SetNumberCapabilities

func (s *ReleasePhoneNumberOutput) SetNumberCapabilities(v []*string) *ReleasePhoneNumberOutput

SetNumberCapabilities sets the NumberCapabilities field's value.

func (*ReleasePhoneNumberOutput) SetNumberType

SetNumberType sets the NumberType field's value.

func (*ReleasePhoneNumberOutput) SetOptOutListName

func (s *ReleasePhoneNumberOutput) SetOptOutListName(v string) *ReleasePhoneNumberOutput

SetOptOutListName sets the OptOutListName field's value.

func (*ReleasePhoneNumberOutput) SetPhoneNumber

SetPhoneNumber sets the PhoneNumber field's value.

func (*ReleasePhoneNumberOutput) SetPhoneNumberArn

func (s *ReleasePhoneNumberOutput) SetPhoneNumberArn(v string) *ReleasePhoneNumberOutput

SetPhoneNumberArn sets the PhoneNumberArn field's value.

func (*ReleasePhoneNumberOutput) SetPhoneNumberId

SetPhoneNumberId sets the PhoneNumberId field's value.

func (*ReleasePhoneNumberOutput) SetSelfManagedOptOutsEnabled

func (s *ReleasePhoneNumberOutput) SetSelfManagedOptOutsEnabled(v bool) *ReleasePhoneNumberOutput

SetSelfManagedOptOutsEnabled sets the SelfManagedOptOutsEnabled field's value.

func (*ReleasePhoneNumberOutput) SetStatus

SetStatus sets the Status field's value.

func (*ReleasePhoneNumberOutput) SetTwoWayChannelArn

func (s *ReleasePhoneNumberOutput) SetTwoWayChannelArn(v string) *ReleasePhoneNumberOutput

SetTwoWayChannelArn sets the TwoWayChannelArn field's value.

func (*ReleasePhoneNumberOutput) SetTwoWayEnabled

func (s *ReleasePhoneNumberOutput) SetTwoWayEnabled(v bool) *ReleasePhoneNumberOutput

SetTwoWayEnabled sets the TwoWayEnabled field's value.

func (ReleasePhoneNumberOutput) String

func (s ReleasePhoneNumberOutput) String() string

String returns the string representation.

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

type RequestPhoneNumberInput

type RequestPhoneNumberInput struct {

	// Unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request. If you don't specify a client token, a randomly generated
	// token is used for the request to ensure idempotency.
	ClientToken *string `min:"1" type:"string" idempotencyToken:"true"`

	// By default this is set to false. When set to true the phone number can't
	// be deleted.
	DeletionProtectionEnabled *bool `type:"boolean"`

	// The two-character code, in ISO 3166-1 alpha-2 format, for the country or
	// region.
	//
	// IsoCountryCode is a required field
	IsoCountryCode *string `min:"2" type:"string" required:"true"`

	// 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.
	//
	// MessageType is a required field
	MessageType *string `type:"string" required:"true" enum:"MessageType"`

	// Indicates if the phone number will be used for text messages, voice messages,
	// or both.
	//
	// NumberCapabilities is a required field
	NumberCapabilities []*string `min:"1" type:"list" required:"true" enum:"NumberCapability"`

	// The type of phone number to request.
	//
	// NumberType is a required field
	NumberType *string `type:"string" required:"true" enum:"RequestableNumberType"`

	// The name of the OptOutList to associate with the phone number. You can use
	// the OutOutListName or OptPutListArn.
	OptOutListName *string `min:"1" type:"string"`

	// The pool to associated with the phone number. You can use the PoolId or PoolArn.
	PoolId *string `min:"1" type:"string"`

	// Use this field to attach your phone number for an external registration process.
	RegistrationId *string `min:"1" type:"string"`

	// An array of tags (key and value pairs) associate with the requested phone
	// number.
	Tags []*Tag `type:"list"`
	// contains filtered or unexported fields
}

func (RequestPhoneNumberInput) GoString

func (s RequestPhoneNumberInput) GoString() string

GoString returns the string representation.

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

func (*RequestPhoneNumberInput) SetClientToken

SetClientToken sets the ClientToken field's value.

func (*RequestPhoneNumberInput) SetDeletionProtectionEnabled

func (s *RequestPhoneNumberInput) SetDeletionProtectionEnabled(v bool) *RequestPhoneNumberInput

SetDeletionProtectionEnabled sets the DeletionProtectionEnabled field's value.

func (*RequestPhoneNumberInput) SetIsoCountryCode

func (s *RequestPhoneNumberInput) SetIsoCountryCode(v string) *RequestPhoneNumberInput

SetIsoCountryCode sets the IsoCountryCode field's value.

func (*RequestPhoneNumberInput) SetMessageType

SetMessageType sets the MessageType field's value.

func (*RequestPhoneNumberInput) SetNumberCapabilities

func (s *RequestPhoneNumberInput) SetNumberCapabilities(v []*string) *RequestPhoneNumberInput

SetNumberCapabilities sets the NumberCapabilities field's value.

func (*RequestPhoneNumberInput) SetNumberType

SetNumberType sets the NumberType field's value.

func (*RequestPhoneNumberInput) SetOptOutListName

func (s *RequestPhoneNumberInput) SetOptOutListName(v string) *RequestPhoneNumberInput

SetOptOutListName sets the OptOutListName field's value.

func (*RequestPhoneNumberInput) SetPoolId

SetPoolId sets the PoolId field's value.

func (*RequestPhoneNumberInput) SetRegistrationId

func (s *RequestPhoneNumberInput) SetRegistrationId(v string) *RequestPhoneNumberInput

SetRegistrationId sets the RegistrationId field's value.

func (*RequestPhoneNumberInput) SetTags

SetTags sets the Tags field's value.

func (RequestPhoneNumberInput) String

func (s RequestPhoneNumberInput) String() string

String returns the string representation.

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

func (*RequestPhoneNumberInput) Validate

func (s *RequestPhoneNumberInput) Validate() error

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

type RequestPhoneNumberOutput

type RequestPhoneNumberOutput struct {

	// The time when the phone number was created, in UNIX epoch time (https://www.epochconverter.com/)
	// format.
	CreatedTimestamp *time.Time `type:"timestamp"`

	// By default this is set to false. When set to true the phone number can't
	// be deleted.
	DeletionProtectionEnabled *bool `type:"boolean"`

	// The two-character code, in ISO 3166-1 alpha-2 format, for the country or
	// region.
	IsoCountryCode *string `min:"2" type:"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.
	MessageType *string `type:"string" enum:"MessageType"`

	// The monthly price, in US dollars, to lease the phone number.
	MonthlyLeasingPrice *string `type:"string"`

	// Indicates if the phone number will be used for text messages, voice messages
	// or both.
	NumberCapabilities []*string `min:"1" type:"list" enum:"NumberCapability"`

	// The type of number that was released.
	NumberType *string `type:"string" enum:"RequestableNumberType"`

	// The name of the OptOutList that is associated with the requested phone number.
	OptOutListName *string `min:"1" type:"string"`

	// The new phone number that was requested.
	PhoneNumber *string `min:"1" type:"string"`

	// The Amazon Resource Name (ARN) of the requested phone number.
	PhoneNumberArn *string `type:"string"`

	// The unique identifier of the new phone number.
	PhoneNumberId *string `type:"string"`

	// The unique identifier of the pool associated with the phone number
	PoolId *string `type:"string"`

	// By default this is set to false. When 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.
	SelfManagedOptOutsEnabled *bool `type:"boolean"`

	// The current status of the request.
	Status *string `type:"string" enum:"NumberStatus"`

	// An array of key and value pair tags that are associated with the phone number.
	Tags []*Tag `type:"list"`

	// The ARN used to identify the two way channel.
	TwoWayChannelArn *string `min:"20" type:"string"`

	// By default this is set to false. When set to true you can receive incoming
	// text messages from your end recipients.
	TwoWayEnabled *bool `type:"boolean"`
	// contains filtered or unexported fields
}

func (RequestPhoneNumberOutput) GoString

func (s RequestPhoneNumberOutput) GoString() string

GoString returns the string representation.

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

func (*RequestPhoneNumberOutput) SetCreatedTimestamp

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

SetCreatedTimestamp sets the CreatedTimestamp field's value.

func (*RequestPhoneNumberOutput) SetDeletionProtectionEnabled

func (s *RequestPhoneNumberOutput) SetDeletionProtectionEnabled(v bool) *RequestPhoneNumberOutput

SetDeletionProtectionEnabled sets the DeletionProtectionEnabled field's value.

func (*RequestPhoneNumberOutput) SetIsoCountryCode

func (s *RequestPhoneNumberOutput) SetIsoCountryCode(v string) *RequestPhoneNumberOutput

SetIsoCountryCode sets the IsoCountryCode field's value.

func (*RequestPhoneNumberOutput) SetMessageType

SetMessageType sets the MessageType field's value.

func (*RequestPhoneNumberOutput) SetMonthlyLeasingPrice

func (s *RequestPhoneNumberOutput) SetMonthlyLeasingPrice(v string) *RequestPhoneNumberOutput

SetMonthlyLeasingPrice sets the MonthlyLeasingPrice field's value.

func (*RequestPhoneNumberOutput) SetNumberCapabilities

func (s *RequestPhoneNumberOutput) SetNumberCapabilities(v []*string) *RequestPhoneNumberOutput

SetNumberCapabilities sets the NumberCapabilities field's value.

func (*RequestPhoneNumberOutput) SetNumberType

SetNumberType sets the NumberType field's value.

func (*RequestPhoneNumberOutput) SetOptOutListName

func (s *RequestPhoneNumberOutput) SetOptOutListName(v string) *RequestPhoneNumberOutput

SetOptOutListName sets the OptOutListName field's value.

func (*RequestPhoneNumberOutput) SetPhoneNumber

SetPhoneNumber sets the PhoneNumber field's value.

func (*RequestPhoneNumberOutput) SetPhoneNumberArn

func (s *RequestPhoneNumberOutput) SetPhoneNumberArn(v string) *RequestPhoneNumberOutput

SetPhoneNumberArn sets the PhoneNumberArn field's value.

func (*RequestPhoneNumberOutput) SetPhoneNumberId

SetPhoneNumberId sets the PhoneNumberId field's value.

func (*RequestPhoneNumberOutput) SetPoolId

SetPoolId sets the PoolId field's value.

func (*RequestPhoneNumberOutput) SetSelfManagedOptOutsEnabled

func (s *RequestPhoneNumberOutput) SetSelfManagedOptOutsEnabled(v bool) *RequestPhoneNumberOutput

SetSelfManagedOptOutsEnabled sets the SelfManagedOptOutsEnabled field's value.

func (*RequestPhoneNumberOutput) SetStatus

SetStatus sets the Status field's value.

func (*RequestPhoneNumberOutput) SetTags

SetTags sets the Tags field's value.

func (*RequestPhoneNumberOutput) SetTwoWayChannelArn

func (s *RequestPhoneNumberOutput) SetTwoWayChannelArn(v string) *RequestPhoneNumberOutput

SetTwoWayChannelArn sets the TwoWayChannelArn field's value.

func (*RequestPhoneNumberOutput) SetTwoWayEnabled

func (s *RequestPhoneNumberOutput) SetTwoWayEnabled(v bool) *RequestPhoneNumberOutput

SetTwoWayEnabled sets the TwoWayEnabled field's value.

func (RequestPhoneNumberOutput) String

func (s RequestPhoneNumberOutput) String() string

String returns the string representation.

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

type ResourceNotFoundException

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

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

	// The unique identifier of the resource.
	ResourceId *string `type:"string"`

	// The type of resource that caused the exception.
	ResourceType *string `type:"string" enum:"ResourceType"`
	// contains filtered or unexported fields
}

A requested resource couldn't be found.

func (*ResourceNotFoundException) Code

Code returns the exception type name.

func (*ResourceNotFoundException) Error

func (s *ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString

func (s ResourceNotFoundException) GoString() string

GoString returns the string representation.

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

func (*ResourceNotFoundException) Message

func (s *ResourceNotFoundException) Message() string

Message returns the exception's message.

func (*ResourceNotFoundException) OrigErr

func (s *ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFoundException) RequestID

func (s *ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFoundException) StatusCode

func (s *ResourceNotFoundException) StatusCode() int

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

func (ResourceNotFoundException) String

func (s ResourceNotFoundException) String() string

String returns the string representation.

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

type SendTextMessageInput

type SendTextMessageInput struct {

	// The name of the configuration set to use. This can be either the ConfigurationSetName
	// or ConfigurationSetArn.
	ConfigurationSetName *string `min:"1" type:"string"`

	// You can specify custom data in this field. If you do, that data is logged
	// to the event destination.
	Context map[string]*string `type:"map"`

	// This field is used for any country-specific registration requirements. Currently,
	// this setting is only used when you send messages to recipients in India using
	// a sender ID. For more information see Special requirements for sending SMS
	// messages to recipients in India (https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-sms-senderid-india.html).
	DestinationCountryParameters map[string]*string `type:"map"`

	// The destination phone number in E.164 format.
	//
	// DestinationPhoneNumber is a required field
	DestinationPhoneNumber *string `min:"1" type:"string" required:"true"`

	// When set to true, the message is checked and validated, but isn't sent to
	// the end recipient.
	DryRun *bool `type:"boolean"`

	// When you register a short code in the US, you must specify a program name.
	// If you don’t have a US short code, omit this attribute.
	Keyword *string `min:"1" type:"string"`

	// The maximum amount that you want to spend, in US dollars, per each text message
	// part. A text message can contain multiple parts.
	MaxPrice *string `min:"2" type:"string"`

	// The body of the text message.
	MessageBody *string `min:"1" type:"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.
	MessageType *string `type:"string" enum:"MessageType"`

	// The origination identity of the message. This can be either the PhoneNumber,
	// PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn.
	OriginationIdentity *string `min:"1" type:"string"`

	// How long the text message is valid for. By default this is 72 hours.
	TimeToLive *int64 `min:"5" type:"integer"`
	// contains filtered or unexported fields
}

func (SendTextMessageInput) GoString

func (s SendTextMessageInput) GoString() string

GoString returns the string representation.

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

func (*SendTextMessageInput) SetConfigurationSetName

func (s *SendTextMessageInput) SetConfigurationSetName(v string) *SendTextMessageInput

SetConfigurationSetName sets the ConfigurationSetName field's value.

func (*SendTextMessageInput) SetContext

func (s *SendTextMessageInput) SetContext(v map[string]*string) *SendTextMessageInput

SetContext sets the Context field's value.

func (*SendTextMessageInput) SetDestinationCountryParameters

func (s *SendTextMessageInput) SetDestinationCountryParameters(v map[string]*string) *SendTextMessageInput

SetDestinationCountryParameters sets the DestinationCountryParameters field's value.

func (*SendTextMessageInput) SetDestinationPhoneNumber

func (s *SendTextMessageInput) SetDestinationPhoneNumber(v string) *SendTextMessageInput

SetDestinationPhoneNumber sets the DestinationPhoneNumber field's value.

func (*SendTextMessageInput) SetDryRun

SetDryRun sets the DryRun field's value.

func (*SendTextMessageInput) SetKeyword

SetKeyword sets the Keyword field's value.

func (*SendTextMessageInput) SetMaxPrice

SetMaxPrice sets the MaxPrice field's value.

func (*SendTextMessageInput) SetMessageBody

func (s *SendTextMessageInput) SetMessageBody(v string) *SendTextMessageInput

SetMessageBody sets the MessageBody field's value.

func (*SendTextMessageInput) SetMessageType

func (s *SendTextMessageInput) SetMessageType(v string) *SendTextMessageInput

SetMessageType sets the MessageType field's value.

func (*SendTextMessageInput) SetOriginationIdentity

func (s *SendTextMessageInput) SetOriginationIdentity(v string) *SendTextMessageInput

SetOriginationIdentity sets the OriginationIdentity field's value.

func (*SendTextMessageInput) SetTimeToLive

func (s *SendTextMessageInput) SetTimeToLive(v int64) *SendTextMessageInput

SetTimeToLive sets the TimeToLive field's value.

func (SendTextMessageInput) String

func (s SendTextMessageInput) String() string

String returns the string representation.

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

func (*SendTextMessageInput) Validate

func (s *SendTextMessageInput) Validate() error

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

type SendTextMessageOutput

type SendTextMessageOutput struct {

	// The unique identifier for the message.
	MessageId *string `type:"string"`
	// contains filtered or unexported fields
}

func (SendTextMessageOutput) GoString

func (s SendTextMessageOutput) GoString() string

GoString returns the string representation.

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

func (*SendTextMessageOutput) SetMessageId

SetMessageId sets the MessageId field's value.

func (SendTextMessageOutput) String

func (s SendTextMessageOutput) String() string

String returns the string representation.

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

type SendVoiceMessageInput

type SendVoiceMessageInput struct {

	// The name of the configuration set to use. This can be either the ConfigurationSetName
	// or ConfigurationSetArn.
	ConfigurationSetName *string `min:"1" type:"string"`

	// You can specify custom data in this field. If you do, that data is logged
	// to the event destination.
	Context map[string]*string `type:"map"`

	// The destination phone number in E.164 format.
	//
	// DestinationPhoneNumber is a required field
	DestinationPhoneNumber *string `min:"1" type:"string" required:"true"`

	// When set to true, the message is checked and validated, but isn't sent to
	// the end recipient.
	DryRun *bool `type:"boolean"`

	// The maximum amount to spend per voice message, in US dollars.
	MaxPricePerMinute *string `min:"2" type:"string"`

	// The text to convert to a voice message.
	MessageBody *string `min:"1" type:"string"`

	// Specifies if the MessageBody field contains text or speech synthesis markup
	// language (SSML) (https://docs.aws.amazon.com/polly/latest/dg/what-is.html).
	//
	//    * TEXT: This is the default value. When used the maximum character limit
	//    is 3000.
	//
	//    * SSML: When used the maximum character limit is 6000 including SSML tagging.
	MessageBodyTextType *string `type:"string" enum:"VoiceMessageBodyTextType"`

	// The origination identity to use for the voice call. This can be the PhoneNumber,
	// PhoneNumberId, PhoneNumberArn, PoolId, or PoolArn.
	//
	// OriginationIdentity is a required field
	OriginationIdentity *string `min:"1" type:"string" required:"true"`

	// How long the voice message is valid for. By default this is 72 hours.
	TimeToLive *int64 `min:"5" type:"integer"`

	// The voice for the Amazon Polly (https://docs.aws.amazon.com/polly/latest/dg/what-is.html)
	// service to use. By default this is set to "MATTHEW".
	VoiceId *string `type:"string" enum:"VoiceId"`
	// contains filtered or unexported fields
}

func (SendVoiceMessageInput) GoString

func (s SendVoiceMessageInput) GoString() string

GoString returns the string representation.

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

func (*SendVoiceMessageInput) SetConfigurationSetName

func (s *SendVoiceMessageInput) SetConfigurationSetName(v string) *SendVoiceMessageInput

SetConfigurationSetName sets the ConfigurationSetName field's value.

func (*SendVoiceMessageInput) SetContext

SetContext sets the Context field's value.

func (*SendVoiceMessageInput) SetDestinationPhoneNumber

func (s *SendVoiceMessageInput) SetDestinationPhoneNumber(v string) *SendVoiceMessageInput

SetDestinationPhoneNumber sets the DestinationPhoneNumber field's value.

func (*SendVoiceMessageInput) SetDryRun

SetDryRun sets the DryRun field's value.

func (*SendVoiceMessageInput) SetMaxPricePerMinute

func (s *SendVoiceMessageInput) SetMaxPricePerMinute(v string) *SendVoiceMessageInput

SetMaxPricePerMinute sets the MaxPricePerMinute field's value.

func (*SendVoiceMessageInput) SetMessageBody

func (s *SendVoiceMessageInput) SetMessageBody(v string) *SendVoiceMessageInput

SetMessageBody sets the MessageBody field's value.

func (*SendVoiceMessageInput) SetMessageBodyTextType

func (s *SendVoiceMessageInput) SetMessageBodyTextType(v string) *SendVoiceMessageInput

SetMessageBodyTextType sets the MessageBodyTextType field's value.

func (*SendVoiceMessageInput) SetOriginationIdentity

func (s *SendVoiceMessageInput) SetOriginationIdentity(v string) *SendVoiceMessageInput

SetOriginationIdentity sets the OriginationIdentity field's value.

func (*SendVoiceMessageInput) SetTimeToLive

func (s *SendVoiceMessageInput) SetTimeToLive(v int64) *SendVoiceMessageInput

SetTimeToLive sets the TimeToLive field's value.

func (*SendVoiceMessageInput) SetVoiceId

SetVoiceId sets the VoiceId field's value.

func (SendVoiceMessageInput) String

func (s SendVoiceMessageInput) String() string

String returns the string representation.

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

func (*SendVoiceMessageInput) Validate

func (s *SendVoiceMessageInput) Validate() error

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

type SendVoiceMessageOutput

type SendVoiceMessageOutput struct {

	// The unique identifier for the message.
	MessageId *string `type:"string"`
	// contains filtered or unexported fields
}

func (SendVoiceMessageOutput) GoString

func (s SendVoiceMessageOutput) GoString() string

GoString returns the string representation.

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

func (*SendVoiceMessageOutput) SetMessageId

SetMessageId sets the MessageId field's value.

func (SendVoiceMessageOutput) String

func (s SendVoiceMessageOutput) String() string

String returns the string representation.

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

type SenderIdAndCountry

type SenderIdAndCountry struct {

	// The two-character code, in ISO 3166-1 alpha-2 format, for the country or
	// region.
	//
	// IsoCountryCode is a required field
	IsoCountryCode *string `min:"2" type:"string" required:"true"`

	// The unique identifier of the sender.
	//
	// SenderId is a required field
	SenderId *string `min:"1" type:"string" required:"true"`
	// 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 Pinpoint (https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-sms-awssupport-sender-id.html) in the Amazon Pinpoint User Guide.

func (SenderIdAndCountry) GoString

func (s SenderIdAndCountry) GoString() string

GoString returns the string representation.

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

func (*SenderIdAndCountry) SetIsoCountryCode

func (s *SenderIdAndCountry) SetIsoCountryCode(v string) *SenderIdAndCountry

SetIsoCountryCode sets the IsoCountryCode field's value.

func (*SenderIdAndCountry) SetSenderId

func (s *SenderIdAndCountry) SetSenderId(v string) *SenderIdAndCountry

SetSenderId sets the SenderId field's value.

func (SenderIdAndCountry) String

func (s SenderIdAndCountry) String() string

String returns the string representation.

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

func (*SenderIdAndCountry) Validate

func (s *SenderIdAndCountry) Validate() error

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

type SenderIdFilter

type SenderIdFilter struct {

	// The name of the attribute to filter on.
	//
	// Name is a required field
	Name *string `type:"string" required:"true" enum:"SenderIdFilterName"`

	// An array of values to filter for.
	//
	// Values is a required field
	Values []*string `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

The information for a sender ID that meets a specified criteria.

func (SenderIdFilter) GoString

func (s SenderIdFilter) GoString() string

GoString returns the string representation.

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

func (*SenderIdFilter) SetName

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

SetName sets the Name field's value.

func (*SenderIdFilter) SetValues

func (s *SenderIdFilter) SetValues(v []*string) *SenderIdFilter

SetValues sets the Values field's value.

func (SenderIdFilter) String

func (s SenderIdFilter) String() string

String returns the string representation.

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

func (*SenderIdFilter) Validate

func (s *SenderIdFilter) Validate() error

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

type SenderIdInformation

type SenderIdInformation struct {

	// The two-character code, in ISO 3166-1 alpha-2 format, for the country or
	// region.
	//
	// IsoCountryCode is a required field
	IsoCountryCode *string `min:"2" type:"string" required:"true"`

	// 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.
	//
	// MessageTypes is a required field
	MessageTypes []*string `type:"list" required:"true" enum:"MessageType"`

	// The monthly leasing price, in US dollars.
	//
	// MonthlyLeasingPrice is a required field
	MonthlyLeasingPrice *string `type:"string" required:"true"`

	// The alphanumeric sender ID in a specific country that you'd like to describe.
	//
	// SenderId is a required field
	SenderId *string `min:"1" type:"string" required:"true"`

	// The Amazon Resource Name (ARN) associated with the SenderId.
	//
	// SenderIdArn is a required field
	SenderIdArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

The information for all SenderIds in an Amazon Web Services account.

func (SenderIdInformation) GoString

func (s SenderIdInformation) GoString() string

GoString returns the string representation.

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

func (*SenderIdInformation) SetIsoCountryCode

func (s *SenderIdInformation) SetIsoCountryCode(v string) *SenderIdInformation

SetIsoCountryCode sets the IsoCountryCode field's value.

func (*SenderIdInformation) SetMessageTypes

func (s *SenderIdInformation) SetMessageTypes(v []*string) *SenderIdInformation

SetMessageTypes sets the MessageTypes field's value.

func (*SenderIdInformation) SetMonthlyLeasingPrice

func (s *SenderIdInformation) SetMonthlyLeasingPrice(v string) *SenderIdInformation

SetMonthlyLeasingPrice sets the MonthlyLeasingPrice field's value.

func (*SenderIdInformation) SetSenderId

func (s *SenderIdInformation) SetSenderId(v string) *SenderIdInformation

SetSenderId sets the SenderId field's value.

func (*SenderIdInformation) SetSenderIdArn

func (s *SenderIdInformation) SetSenderIdArn(v string) *SenderIdInformation

SetSenderIdArn sets the SenderIdArn field's value.

func (SenderIdInformation) String

func (s SenderIdInformation) String() string

String returns the string representation.

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

type ServiceQuotaExceededException

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

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

	// The reason for the exception.
	Reason *string `type:"string" enum:"ServiceQuotaExceededExceptionReason"`
	// contains filtered or unexported fields
}

The request would cause a service quota to be exceeded.

func (*ServiceQuotaExceededException) Code

Code returns the exception type name.

func (*ServiceQuotaExceededException) Error

func (ServiceQuotaExceededException) GoString

GoString returns the string representation.

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

func (*ServiceQuotaExceededException) Message

Message returns the exception's message.

func (*ServiceQuotaExceededException) OrigErr

func (s *ServiceQuotaExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ServiceQuotaExceededException) RequestID

func (s *ServiceQuotaExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ServiceQuotaExceededException) StatusCode

func (s *ServiceQuotaExceededException) StatusCode() int

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

func (ServiceQuotaExceededException) String

String returns the string representation.

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

type SetDefaultMessageTypeInput

type SetDefaultMessageTypeInput struct {

	// The configuration set to update with a new default message type. This field
	// can be the ConsigurationSetName or ConfigurationSetArn.
	//
	// ConfigurationSetName is a required field
	ConfigurationSetName *string `min:"1" type:"string" required:"true"`

	// 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.
	//
	// MessageType is a required field
	MessageType *string `type:"string" required:"true" enum:"MessageType"`
	// contains filtered or unexported fields
}

func (SetDefaultMessageTypeInput) GoString

func (s SetDefaultMessageTypeInput) GoString() string

GoString returns the string representation.

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

func (*SetDefaultMessageTypeInput) SetConfigurationSetName

func (s *SetDefaultMessageTypeInput) SetConfigurationSetName(v string) *SetDefaultMessageTypeInput

SetConfigurationSetName sets the ConfigurationSetName field's value.

func (*SetDefaultMessageTypeInput) SetMessageType

SetMessageType sets the MessageType field's value.

func (SetDefaultMessageTypeInput) String

String returns the string representation.

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

func (*SetDefaultMessageTypeInput) Validate

func (s *SetDefaultMessageTypeInput) Validate() error

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

type SetDefaultMessageTypeOutput

type SetDefaultMessageTypeOutput struct {

	// The Amazon Resource Name (ARN) of the updated configuration set.
	ConfigurationSetArn *string `type:"string"`

	// The name of the configuration set that was updated.
	ConfigurationSetName *string `min:"1" type:"string"`

	// The new default message type of the configuration set.
	MessageType *string `type:"string" enum:"MessageType"`
	// contains filtered or unexported fields
}

func (SetDefaultMessageTypeOutput) GoString

func (s SetDefaultMessageTypeOutput) GoString() string

GoString returns the string representation.

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

func (*SetDefaultMessageTypeOutput) SetConfigurationSetArn

func (s *SetDefaultMessageTypeOutput) SetConfigurationSetArn(v string) *SetDefaultMessageTypeOutput

SetConfigurationSetArn sets the ConfigurationSetArn field's value.

func (*SetDefaultMessageTypeOutput) SetConfigurationSetName

func (s *SetDefaultMessageTypeOutput) SetConfigurationSetName(v string) *SetDefaultMessageTypeOutput

SetConfigurationSetName sets the ConfigurationSetName field's value.

func (*SetDefaultMessageTypeOutput) SetMessageType

SetMessageType sets the MessageType field's value.

func (SetDefaultMessageTypeOutput) String

String returns the string representation.

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

type SetDefaultSenderIdInput

type SetDefaultSenderIdInput struct {

	// The configuration set to updated with a new default SenderId. This field
	// can be the ConsigurationSetName or ConfigurationSetArn.
	//
	// ConfigurationSetName is a required field
	ConfigurationSetName *string `min:"1" type:"string" required:"true"`

	// The current sender ID for the configuration set. When sending a text message
	// to a destination country which supports SenderIds, the default sender ID
	// on the configuration set specified on SendTextMessage will be used if no
	// dedicated origination phone numbers or registered SenderIds are available
	// in your account, instead of a generic sender ID, such as 'NOTICE'.
	//
	// SenderId is a required field
	SenderId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (SetDefaultSenderIdInput) GoString

func (s SetDefaultSenderIdInput) GoString() string

GoString returns the string representation.

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

func (*SetDefaultSenderIdInput) SetConfigurationSetName

func (s *SetDefaultSenderIdInput) SetConfigurationSetName(v string) *SetDefaultSenderIdInput

SetConfigurationSetName sets the ConfigurationSetName field's value.

func (*SetDefaultSenderIdInput) SetSenderId

SetSenderId sets the SenderId field's value.

func (SetDefaultSenderIdInput) String

func (s SetDefaultSenderIdInput) String() string

String returns the string representation.

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

func (*SetDefaultSenderIdInput) Validate

func (s *SetDefaultSenderIdInput) Validate() error

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

type SetDefaultSenderIdOutput

type SetDefaultSenderIdOutput struct {

	// The Amazon Resource Name (ARN) of the updated configuration set.
	ConfigurationSetArn *string `type:"string"`

	// The name of the configuration set that was updated.
	ConfigurationSetName *string `min:"1" type:"string"`

	// The default sender ID to set for the ConfigurationSet.
	SenderId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (SetDefaultSenderIdOutput) GoString

func (s SetDefaultSenderIdOutput) GoString() string

GoString returns the string representation.

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

func (*SetDefaultSenderIdOutput) SetConfigurationSetArn

func (s *SetDefaultSenderIdOutput) SetConfigurationSetArn(v string) *SetDefaultSenderIdOutput

SetConfigurationSetArn sets the ConfigurationSetArn field's value.

func (*SetDefaultSenderIdOutput) SetConfigurationSetName

func (s *SetDefaultSenderIdOutput) SetConfigurationSetName(v string) *SetDefaultSenderIdOutput

SetConfigurationSetName sets the ConfigurationSetName field's value.

func (*SetDefaultSenderIdOutput) SetSenderId

SetSenderId sets the SenderId field's value.

func (SetDefaultSenderIdOutput) String

func (s SetDefaultSenderIdOutput) String() string

String returns the string representation.

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

type SetTextMessageSpendLimitOverrideInput

type SetTextMessageSpendLimitOverrideInput struct {

	// The new monthly limit to enforce on text messages.
	//
	// MonthlyLimit is a required field
	MonthlyLimit *int64 `type:"long" required:"true"`
	// contains filtered or unexported fields
}

func (SetTextMessageSpendLimitOverrideInput) GoString

GoString returns the string representation.

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

func (*SetTextMessageSpendLimitOverrideInput) SetMonthlyLimit

SetMonthlyLimit sets the MonthlyLimit field's value.

func (SetTextMessageSpendLimitOverrideInput) String

String returns the string representation.

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

func (*SetTextMessageSpendLimitOverrideInput) Validate

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

type SetTextMessageSpendLimitOverrideOutput

type SetTextMessageSpendLimitOverrideOutput struct {

	// The current monthly limit to enforce on sending text messages.
	MonthlyLimit *int64 `type:"long"`
	// contains filtered or unexported fields
}

func (SetTextMessageSpendLimitOverrideOutput) GoString

GoString returns the string representation.

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

func (*SetTextMessageSpendLimitOverrideOutput) SetMonthlyLimit

SetMonthlyLimit sets the MonthlyLimit field's value.

func (SetTextMessageSpendLimitOverrideOutput) String

String returns the string representation.

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

type SetVoiceMessageSpendLimitOverrideInput

type SetVoiceMessageSpendLimitOverrideInput struct {

	// The new monthly limit to enforce on voice messages.
	//
	// MonthlyLimit is a required field
	MonthlyLimit *int64 `type:"long" required:"true"`
	// contains filtered or unexported fields
}

func (SetVoiceMessageSpendLimitOverrideInput) GoString

GoString returns the string representation.

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

func (*SetVoiceMessageSpendLimitOverrideInput) SetMonthlyLimit

SetMonthlyLimit sets the MonthlyLimit field's value.

func (SetVoiceMessageSpendLimitOverrideInput) String

String returns the string representation.

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

func (*SetVoiceMessageSpendLimitOverrideInput) Validate

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

type SetVoiceMessageSpendLimitOverrideOutput

type SetVoiceMessageSpendLimitOverrideOutput struct {

	// The current monthly limit to enforce on sending voice messages.
	MonthlyLimit *int64 `type:"long"`
	// contains filtered or unexported fields
}

func (SetVoiceMessageSpendLimitOverrideOutput) GoString

GoString returns the string representation.

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

func (*SetVoiceMessageSpendLimitOverrideOutput) SetMonthlyLimit

SetMonthlyLimit sets the MonthlyLimit field's value.

func (SetVoiceMessageSpendLimitOverrideOutput) String

String returns the string representation.

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

type SnsDestination

type SnsDestination struct {

	// The Amazon Resource Name (ARN) of the Amazon SNS topic that you want to publish
	// events to.
	//
	// TopicArn is a required field
	TopicArn *string `min:"20" type:"string" required:"true"`
	// 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.

func (SnsDestination) GoString

func (s SnsDestination) GoString() string

GoString returns the string representation.

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

func (*SnsDestination) SetTopicArn

func (s *SnsDestination) SetTopicArn(v string) *SnsDestination

SetTopicArn sets the TopicArn field's value.

func (SnsDestination) String

func (s SnsDestination) String() string

String returns the string representation.

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

func (*SnsDestination) Validate

func (s *SnsDestination) Validate() error

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

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.
	//
	// EnforcedLimit is a required field
	EnforcedLimit *int64 `type:"long" required:"true"`

	// The maximum amount of money that you are able to spend to send messages each
	// month, in US dollars.
	//
	// MaxLimit is a required field
	MaxLimit *int64 `type:"long" required:"true"`

	// The name for the SpendLimit.
	//
	// Name is a required field
	Name *string `type:"string" required:"true" enum:"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.
	//
	// Overridden is a required field
	Overridden *bool `type:"boolean" required:"true"`
	// 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 Pinpoint (https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-sms-awssupport-spend-threshold.html) in the Amazon Pinpoint User Guide.

func (SpendLimit) GoString

func (s SpendLimit) GoString() string

GoString returns the string representation.

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

func (*SpendLimit) SetEnforcedLimit

func (s *SpendLimit) SetEnforcedLimit(v int64) *SpendLimit

SetEnforcedLimit sets the EnforcedLimit field's value.

func (*SpendLimit) SetMaxLimit

func (s *SpendLimit) SetMaxLimit(v int64) *SpendLimit

SetMaxLimit sets the MaxLimit field's value.

func (*SpendLimit) SetName

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

SetName sets the Name field's value.

func (*SpendLimit) SetOverridden

func (s *SpendLimit) SetOverridden(v bool) *SpendLimit

SetOverridden sets the Overridden field's value.

func (SpendLimit) String

func (s SpendLimit) String() string

String returns the string representation.

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

type Tag

type Tag struct {

	// The key identifier, or name, of the tag.
	//
	// Key is a required field
	Key *string `min:"1" type:"string" required:"true"`

	// The string value associated with the key of the tag.
	//
	// Value is a required field
	Value *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

The list of tags to be added to the specified topic.

func (Tag) GoString

func (s Tag) GoString() string

GoString returns the string representation.

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

func (*Tag) SetKey

func (s *Tag) SetKey(v string) *Tag

SetKey sets the Key field's value.

func (*Tag) SetValue

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

SetValue sets the Value field's value.

func (Tag) String

func (s Tag) String() string

String returns the string representation.

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

func (*Tag) Validate

func (s *Tag) Validate() error

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

type TagResourceInput

type TagResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource.
	//
	// ResourceArn is a required field
	ResourceArn *string `min:"20" type:"string" required:"true"`

	// An array of key and value pair tags that are associated with the resource.
	//
	// Tags is a required field
	Tags []*Tag `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (TagResourceInput) GoString

func (s TagResourceInput) GoString() string

GoString returns the string representation.

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

func (*TagResourceInput) SetResourceArn

func (s *TagResourceInput) SetResourceArn(v string) *TagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*TagResourceInput) SetTags

func (s *TagResourceInput) SetTags(v []*Tag) *TagResourceInput

SetTags sets the Tags field's value.

func (TagResourceInput) String

func (s TagResourceInput) String() string

String returns the string representation.

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

func (*TagResourceInput) Validate

func (s *TagResourceInput) Validate() error

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

type TagResourceOutput

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

func (TagResourceOutput) GoString

func (s TagResourceOutput) GoString() string

GoString returns the string representation.

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

func (TagResourceOutput) String

func (s TagResourceOutput) String() string

String returns the string representation.

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

type ThrottlingException

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

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

An error that occurred because too many requests were sent during a certain amount of time.

func (*ThrottlingException) Code

func (s *ThrottlingException) Code() string

Code returns the exception type name.

func (*ThrottlingException) Error

func (s *ThrottlingException) Error() string

func (ThrottlingException) GoString

func (s ThrottlingException) GoString() string

GoString returns the string representation.

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

func (*ThrottlingException) Message

func (s *ThrottlingException) Message() string

Message returns the exception's message.

func (*ThrottlingException) OrigErr

func (s *ThrottlingException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ThrottlingException) RequestID

func (s *ThrottlingException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ThrottlingException) StatusCode

func (s *ThrottlingException) StatusCode() int

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

func (ThrottlingException) String

func (s ThrottlingException) String() string

String returns the string representation.

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

type UntagResourceInput

type UntagResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource.
	//
	// ResourceArn is a required field
	ResourceArn *string `min:"20" type:"string" required:"true"`

	// An array of tag key values to unassociate with the resource.
	//
	// TagKeys is a required field
	TagKeys []*string `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (UntagResourceInput) GoString

func (s UntagResourceInput) GoString() string

GoString returns the string representation.

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

func (*UntagResourceInput) SetResourceArn

func (s *UntagResourceInput) SetResourceArn(v string) *UntagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*UntagResourceInput) SetTagKeys

func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput

SetTagKeys sets the TagKeys field's value.

func (UntagResourceInput) String

func (s UntagResourceInput) String() string

String returns the string representation.

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

func (*UntagResourceInput) Validate

func (s *UntagResourceInput) Validate() error

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

type UntagResourceOutput

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

func (UntagResourceOutput) GoString

func (s UntagResourceOutput) GoString() string

GoString returns the string representation.

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

func (UntagResourceOutput) String

func (s UntagResourceOutput) String() string

String returns the string representation.

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

type UpdateEventDestinationInput

type UpdateEventDestinationInput struct {

	// An object that contains information about an event destination that sends
	// data to CloudWatch Logs.
	CloudWatchLogsDestination *CloudWatchLogsDestination `type:"structure"`

	// The configuration set to update with the new event destination. Valid values
	// for this can be the ConfigurationSetName or ConfigurationSetArn.
	//
	// ConfigurationSetName is a required field
	ConfigurationSetName *string `min:"1" type:"string" required:"true"`

	// When set to true logging is enabled.
	Enabled *bool `type:"boolean"`

	// The name to use for the event destination.
	//
	// EventDestinationName is a required field
	EventDestinationName *string `min:"1" type:"string" required:"true"`

	// An object that contains information about an event destination for logging
	// to Kinesis Data Firehose.
	KinesisFirehoseDestination *KinesisFirehoseDestination `type:"structure"`

	// An array of event types that determine which events to log.
	MatchingEventTypes []*string `min:"1" type:"list" enum:"EventType"`

	// An object that contains information about an event destination that sends
	// data to Amazon SNS.
	SnsDestination *SnsDestination `type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateEventDestinationInput) GoString

func (s UpdateEventDestinationInput) GoString() string

GoString returns the string representation.

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

func (*UpdateEventDestinationInput) SetCloudWatchLogsDestination

SetCloudWatchLogsDestination sets the CloudWatchLogsDestination field's value.

func (*UpdateEventDestinationInput) SetConfigurationSetName

func (s *UpdateEventDestinationInput) SetConfigurationSetName(v string) *UpdateEventDestinationInput

SetConfigurationSetName sets the ConfigurationSetName field's value.

func (*UpdateEventDestinationInput) SetEnabled

SetEnabled sets the Enabled field's value.

func (*UpdateEventDestinationInput) SetEventDestinationName

func (s *UpdateEventDestinationInput) SetEventDestinationName(v string) *UpdateEventDestinationInput

SetEventDestinationName sets the EventDestinationName field's value.

func (*UpdateEventDestinationInput) SetKinesisFirehoseDestination

SetKinesisFirehoseDestination sets the KinesisFirehoseDestination field's value.

func (*UpdateEventDestinationInput) SetMatchingEventTypes

func (s *UpdateEventDestinationInput) SetMatchingEventTypes(v []*string) *UpdateEventDestinationInput

SetMatchingEventTypes sets the MatchingEventTypes field's value.

func (*UpdateEventDestinationInput) SetSnsDestination

SetSnsDestination sets the SnsDestination field's value.

func (UpdateEventDestinationInput) String

String returns the string representation.

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

func (*UpdateEventDestinationInput) Validate

func (s *UpdateEventDestinationInput) Validate() error

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

type UpdateEventDestinationOutput

type UpdateEventDestinationOutput struct {

	// The Amazon Resource Name (ARN) for the ConfigurationSet that was updated.
	ConfigurationSetArn *string `type:"string"`

	// The name of the configuration set.
	ConfigurationSetName *string `min:"1" type:"string"`

	// An EventDestination object containing the details of where events will be
	// logged.
	EventDestination *EventDestination `type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateEventDestinationOutput) GoString

func (s UpdateEventDestinationOutput) GoString() string

GoString returns the string representation.

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

func (*UpdateEventDestinationOutput) SetConfigurationSetArn

SetConfigurationSetArn sets the ConfigurationSetArn field's value.

func (*UpdateEventDestinationOutput) SetConfigurationSetName

func (s *UpdateEventDestinationOutput) SetConfigurationSetName(v string) *UpdateEventDestinationOutput

SetConfigurationSetName sets the ConfigurationSetName field's value.

func (*UpdateEventDestinationOutput) SetEventDestination

SetEventDestination sets the EventDestination field's value.

func (UpdateEventDestinationOutput) String

String returns the string representation.

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

type UpdatePhoneNumberInput

type UpdatePhoneNumberInput struct {

	// By default this is set to false. When set to true the phone number can't
	// be deleted.
	DeletionProtectionEnabled *bool `type:"boolean"`

	// The OptOutList to add the phone number to. Valid values for this field can
	// be either the OutOutListName or OutOutListArn.
	OptOutListName *string `min:"1" type:"string"`

	// The unique identifier of the phone number. Valid values for this field can
	// be either the PhoneNumberId or PhoneNumberArn.
	//
	// PhoneNumberId is a required field
	PhoneNumberId *string `min:"1" type:"string" required:"true"`

	// By default this is set to false. When 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.
	SelfManagedOptOutsEnabled *bool `type:"boolean"`

	// The Amazon Resource Name (ARN) of the two way channel.
	TwoWayChannelArn *string `min:"20" type:"string"`

	// By default this is set to false. When set to true you can receive incoming
	// text messages from your end recipients.
	TwoWayEnabled *bool `type:"boolean"`
	// contains filtered or unexported fields
}

func (UpdatePhoneNumberInput) GoString

func (s UpdatePhoneNumberInput) GoString() string

GoString returns the string representation.

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

func (*UpdatePhoneNumberInput) SetDeletionProtectionEnabled

func (s *UpdatePhoneNumberInput) SetDeletionProtectionEnabled(v bool) *UpdatePhoneNumberInput

SetDeletionProtectionEnabled sets the DeletionProtectionEnabled field's value.

func (*UpdatePhoneNumberInput) SetOptOutListName

func (s *UpdatePhoneNumberInput) SetOptOutListName(v string) *UpdatePhoneNumberInput

SetOptOutListName sets the OptOutListName field's value.

func (*UpdatePhoneNumberInput) SetPhoneNumberId

func (s *UpdatePhoneNumberInput) SetPhoneNumberId(v string) *UpdatePhoneNumberInput

SetPhoneNumberId sets the PhoneNumberId field's value.

func (*UpdatePhoneNumberInput) SetSelfManagedOptOutsEnabled

func (s *UpdatePhoneNumberInput) SetSelfManagedOptOutsEnabled(v bool) *UpdatePhoneNumberInput

SetSelfManagedOptOutsEnabled sets the SelfManagedOptOutsEnabled field's value.

func (*UpdatePhoneNumberInput) SetTwoWayChannelArn

func (s *UpdatePhoneNumberInput) SetTwoWayChannelArn(v string) *UpdatePhoneNumberInput

SetTwoWayChannelArn sets the TwoWayChannelArn field's value.

func (*UpdatePhoneNumberInput) SetTwoWayEnabled

func (s *UpdatePhoneNumberInput) SetTwoWayEnabled(v bool) *UpdatePhoneNumberInput

SetTwoWayEnabled sets the TwoWayEnabled field's value.

func (UpdatePhoneNumberInput) String

func (s UpdatePhoneNumberInput) String() string

String returns the string representation.

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

func (*UpdatePhoneNumberInput) Validate

func (s *UpdatePhoneNumberInput) Validate() error

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

type UpdatePhoneNumberOutput

type UpdatePhoneNumberOutput struct {

	// The time when the phone number was created, in UNIX epoch time (https://www.epochconverter.com/)
	// format.
	CreatedTimestamp *time.Time `type:"timestamp"`

	// When set to true the phone number can't be deleted.
	DeletionProtectionEnabled *bool `type:"boolean"`

	// The two-character code, in ISO 3166-1 alpha-2 format, for the country or
	// region.
	IsoCountryCode *string `min:"2" type:"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.
	MessageType *string `type:"string" enum:"MessageType"`

	// The monthly leasing price of the phone number, in US dollars.
	MonthlyLeasingPrice *string `type:"string"`

	// Specifies if the number could be used for text messages, voice or both.
	NumberCapabilities []*string `min:"1" type:"list" enum:"NumberCapability"`

	// The type of number that was requested.
	NumberType *string `type:"string" enum:"NumberType"`

	// The name of the OptOutList associated with the phone number.
	OptOutListName *string `min:"1" type:"string"`

	// The phone number that was updated.
	PhoneNumber *string `min:"1" type:"string"`

	// The Amazon Resource Name (ARN) of the updated phone number.
	PhoneNumberArn *string `type:"string"`

	// The unique identifier of the phone number.
	PhoneNumberId *string `type:"string"`

	// This is true if self managed opt-out are enabled.
	SelfManagedOptOutsEnabled *bool `type:"boolean"`

	// The current status of the request.
	Status *string `type:"string" enum:"NumberStatus"`

	// The Amazon Resource Name (ARN) of the two way channel.
	TwoWayChannelArn *string `min:"20" type:"string"`

	// By default this is set to false. When set to true you can receive incoming
	// text messages from your end recipients.
	TwoWayEnabled *bool `type:"boolean"`
	// contains filtered or unexported fields
}

func (UpdatePhoneNumberOutput) GoString

func (s UpdatePhoneNumberOutput) GoString() string

GoString returns the string representation.

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

func (*UpdatePhoneNumberOutput) SetCreatedTimestamp

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

SetCreatedTimestamp sets the CreatedTimestamp field's value.

func (*UpdatePhoneNumberOutput) SetDeletionProtectionEnabled

func (s *UpdatePhoneNumberOutput) SetDeletionProtectionEnabled(v bool) *UpdatePhoneNumberOutput

SetDeletionProtectionEnabled sets the DeletionProtectionEnabled field's value.

func (*UpdatePhoneNumberOutput) SetIsoCountryCode

func (s *UpdatePhoneNumberOutput) SetIsoCountryCode(v string) *UpdatePhoneNumberOutput

SetIsoCountryCode sets the IsoCountryCode field's value.

func (*UpdatePhoneNumberOutput) SetMessageType

SetMessageType sets the MessageType field's value.

func (*UpdatePhoneNumberOutput) SetMonthlyLeasingPrice

func (s *UpdatePhoneNumberOutput) SetMonthlyLeasingPrice(v string) *UpdatePhoneNumberOutput

SetMonthlyLeasingPrice sets the MonthlyLeasingPrice field's value.

func (*UpdatePhoneNumberOutput) SetNumberCapabilities

func (s *UpdatePhoneNumberOutput) SetNumberCapabilities(v []*string) *UpdatePhoneNumberOutput

SetNumberCapabilities sets the NumberCapabilities field's value.

func (*UpdatePhoneNumberOutput) SetNumberType

SetNumberType sets the NumberType field's value.

func (*UpdatePhoneNumberOutput) SetOptOutListName

func (s *UpdatePhoneNumberOutput) SetOptOutListName(v string) *UpdatePhoneNumberOutput

SetOptOutListName sets the OptOutListName field's value.

func (*UpdatePhoneNumberOutput) SetPhoneNumber

SetPhoneNumber sets the PhoneNumber field's value.

func (*UpdatePhoneNumberOutput) SetPhoneNumberArn

func (s *UpdatePhoneNumberOutput) SetPhoneNumberArn(v string) *UpdatePhoneNumberOutput

SetPhoneNumberArn sets the PhoneNumberArn field's value.

func (*UpdatePhoneNumberOutput) SetPhoneNumberId

func (s *UpdatePhoneNumberOutput) SetPhoneNumberId(v string) *UpdatePhoneNumberOutput

SetPhoneNumberId sets the PhoneNumberId field's value.

func (*UpdatePhoneNumberOutput) SetSelfManagedOptOutsEnabled

func (s *UpdatePhoneNumberOutput) SetSelfManagedOptOutsEnabled(v bool) *UpdatePhoneNumberOutput

SetSelfManagedOptOutsEnabled sets the SelfManagedOptOutsEnabled field's value.

func (*UpdatePhoneNumberOutput) SetStatus

SetStatus sets the Status field's value.

func (*UpdatePhoneNumberOutput) SetTwoWayChannelArn

func (s *UpdatePhoneNumberOutput) SetTwoWayChannelArn(v string) *UpdatePhoneNumberOutput

SetTwoWayChannelArn sets the TwoWayChannelArn field's value.

func (*UpdatePhoneNumberOutput) SetTwoWayEnabled

func (s *UpdatePhoneNumberOutput) SetTwoWayEnabled(v bool) *UpdatePhoneNumberOutput

SetTwoWayEnabled sets the TwoWayEnabled field's value.

func (UpdatePhoneNumberOutput) String

func (s UpdatePhoneNumberOutput) String() string

String returns the string representation.

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

type UpdatePoolInput

type UpdatePoolInput struct {

	// When set to true the pool can't be deleted.
	DeletionProtectionEnabled *bool `type:"boolean"`

	// The OptOutList to associate with the pool. Valid values are either OptOutListName
	// or OptOutListArn.
	OptOutListName *string `min:"1" type:"string"`

	// The unique identifier of the pool to update. Valid values are either the
	// PoolId or PoolArn.
	//
	// PoolId is a required field
	PoolId *string `min:"1" type:"string" required:"true"`

	// By default this is set to false. When 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.
	SelfManagedOptOutsEnabled *bool `type:"boolean"`

	// Indicates whether shared routes are enabled for the pool.
	SharedRoutesEnabled *bool `type:"boolean"`

	// The Amazon Resource Name (ARN) of the two way channel.
	TwoWayChannelArn *string `min:"20" type:"string"`

	// By default this is set to false. When set to true you can receive incoming
	// text messages from your end recipients.
	TwoWayEnabled *bool `type:"boolean"`
	// contains filtered or unexported fields
}

func (UpdatePoolInput) GoString

func (s UpdatePoolInput) GoString() string

GoString returns the string representation.

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

func (*UpdatePoolInput) SetDeletionProtectionEnabled

func (s *UpdatePoolInput) SetDeletionProtectionEnabled(v bool) *UpdatePoolInput

SetDeletionProtectionEnabled sets the DeletionProtectionEnabled field's value.

func (*UpdatePoolInput) SetOptOutListName

func (s *UpdatePoolInput) SetOptOutListName(v string) *UpdatePoolInput

SetOptOutListName sets the OptOutListName field's value.

func (*UpdatePoolInput) SetPoolId

func (s *UpdatePoolInput) SetPoolId(v string) *UpdatePoolInput

SetPoolId sets the PoolId field's value.

func (*UpdatePoolInput) SetSelfManagedOptOutsEnabled

func (s *UpdatePoolInput) SetSelfManagedOptOutsEnabled(v bool) *UpdatePoolInput

SetSelfManagedOptOutsEnabled sets the SelfManagedOptOutsEnabled field's value.

func (*UpdatePoolInput) SetSharedRoutesEnabled

func (s *UpdatePoolInput) SetSharedRoutesEnabled(v bool) *UpdatePoolInput

SetSharedRoutesEnabled sets the SharedRoutesEnabled field's value.

func (*UpdatePoolInput) SetTwoWayChannelArn

func (s *UpdatePoolInput) SetTwoWayChannelArn(v string) *UpdatePoolInput

SetTwoWayChannelArn sets the TwoWayChannelArn field's value.

func (*UpdatePoolInput) SetTwoWayEnabled

func (s *UpdatePoolInput) SetTwoWayEnabled(v bool) *UpdatePoolInput

SetTwoWayEnabled sets the TwoWayEnabled field's value.

func (UpdatePoolInput) String

func (s UpdatePoolInput) String() string

String returns the string representation.

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

func (*UpdatePoolInput) Validate

func (s *UpdatePoolInput) Validate() error

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

type UpdatePoolOutput

type UpdatePoolOutput struct {

	// The time when the pool was created, in UNIX epoch time (https://www.epochconverter.com/)
	// format.
	CreatedTimestamp *time.Time `type:"timestamp"`

	// When set to true the pool can't be deleted.
	DeletionProtectionEnabled *bool `type:"boolean"`

	// The type of message for the pool to use.
	MessageType *string `type:"string" enum:"MessageType"`

	// The name of the OptOutList associated with the pool.
	OptOutListName *string `min:"1" type:"string"`

	// The ARN of the pool.
	PoolArn *string `type:"string"`

	// The unique identifier of the pool.
	PoolId *string `type:"string"`

	// When 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.
	SelfManagedOptOutsEnabled *bool `type:"boolean"`

	// Indicates whether shared routes are enabled for the pool.
	SharedRoutesEnabled *bool `type:"boolean"`

	// The current status of the pool update request.
	Status *string `type:"string" enum:"PoolStatus"`

	// The Amazon Resource Name (ARN) of the two way channel.
	TwoWayChannelArn *string `min:"20" type:"string"`

	// By default this is set to false. When set to true you can receive incoming
	// text messages from your end recipients.
	TwoWayEnabled *bool `type:"boolean"`
	// contains filtered or unexported fields
}

func (UpdatePoolOutput) GoString

func (s UpdatePoolOutput) GoString() string

GoString returns the string representation.

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

func (*UpdatePoolOutput) SetCreatedTimestamp

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

SetCreatedTimestamp sets the CreatedTimestamp field's value.

func (*UpdatePoolOutput) SetDeletionProtectionEnabled

func (s *UpdatePoolOutput) SetDeletionProtectionEnabled(v bool) *UpdatePoolOutput

SetDeletionProtectionEnabled sets the DeletionProtectionEnabled field's value.

func (*UpdatePoolOutput) SetMessageType

func (s *UpdatePoolOutput) SetMessageType(v string) *UpdatePoolOutput

SetMessageType sets the MessageType field's value.

func (*UpdatePoolOutput) SetOptOutListName

func (s *UpdatePoolOutput) SetOptOutListName(v string) *UpdatePoolOutput

SetOptOutListName sets the OptOutListName field's value.

func (*UpdatePoolOutput) SetPoolArn

func (s *UpdatePoolOutput) SetPoolArn(v string) *UpdatePoolOutput

SetPoolArn sets the PoolArn field's value.

func (*UpdatePoolOutput) SetPoolId

func (s *UpdatePoolOutput) SetPoolId(v string) *UpdatePoolOutput

SetPoolId sets the PoolId field's value.

func (*UpdatePoolOutput) SetSelfManagedOptOutsEnabled

func (s *UpdatePoolOutput) SetSelfManagedOptOutsEnabled(v bool) *UpdatePoolOutput

SetSelfManagedOptOutsEnabled sets the SelfManagedOptOutsEnabled field's value.

func (*UpdatePoolOutput) SetSharedRoutesEnabled

func (s *UpdatePoolOutput) SetSharedRoutesEnabled(v bool) *UpdatePoolOutput

SetSharedRoutesEnabled sets the SharedRoutesEnabled field's value.

func (*UpdatePoolOutput) SetStatus

func (s *UpdatePoolOutput) SetStatus(v string) *UpdatePoolOutput

SetStatus sets the Status field's value.

func (*UpdatePoolOutput) SetTwoWayChannelArn

func (s *UpdatePoolOutput) SetTwoWayChannelArn(v string) *UpdatePoolOutput

SetTwoWayChannelArn sets the TwoWayChannelArn field's value.

func (*UpdatePoolOutput) SetTwoWayEnabled

func (s *UpdatePoolOutput) SetTwoWayEnabled(v bool) *UpdatePoolOutput

SetTwoWayEnabled sets the TwoWayEnabled field's value.

func (UpdatePoolOutput) String

func (s UpdatePoolOutput) String() string

String returns the string representation.

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

type ValidationException

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

	// The field that failed validation.
	Fields []*ValidationExceptionField `type:"list"`

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

	// The reason for the exception.
	Reason *string `type:"string" enum:"ValidationExceptionReason"`
	// contains filtered or unexported fields
}

A validation exception for a field.

func (*ValidationException) Code

func (s *ValidationException) Code() string

Code returns the exception type name.

func (*ValidationException) Error

func (s *ValidationException) Error() string

func (ValidationException) GoString

func (s ValidationException) GoString() string

GoString returns the string representation.

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

func (*ValidationException) Message

func (s *ValidationException) Message() string

Message returns the exception's message.

func (*ValidationException) OrigErr

func (s *ValidationException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ValidationException) RequestID

func (s *ValidationException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ValidationException) StatusCode

func (s *ValidationException) StatusCode() int

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

func (ValidationException) String

func (s ValidationException) String() string

String returns the string representation.

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

type ValidationExceptionField

type ValidationExceptionField struct {

	// The message associated with the validation exception with information to
	// help determine its cause.
	//
	// Message is a required field
	Message *string `type:"string" required:"true"`

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

The field associated with the validation exception.

func (ValidationExceptionField) GoString

func (s ValidationExceptionField) GoString() string

GoString returns the string representation.

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

func (*ValidationExceptionField) SetMessage

SetMessage sets the Message field's value.

func (*ValidationExceptionField) SetName

SetName sets the Name field's value.

func (ValidationExceptionField) String

func (s ValidationExceptionField) String() string

String returns the string representation.

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

Directories

Path Synopsis
Package pinpointsmsvoicev2iface provides an interface to enable mocking the Amazon Pinpoint SMS Voice V2 service client for testing your code.
Package pinpointsmsvoicev2iface provides an interface to enable mocking the Amazon Pinpoint SMS Voice V2 service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL