View on GitHub
PinpointSMSVoice Structure Reference
PinpointSMSVoice
public struct PinpointSMSVoiceClient object for interacting with AWS PinpointSMSVoice service.
Pinpoint SMS and Voice Messaging public facing APIs
-
Undocumented
Declaration
Swift
public let client: AWSClient
-
Initialize the PinpointSMSVoice client
Declaration
Swift
public init(accessKeyId: String? = nil, secretAccessKey: String? = nil, sessionToken: String? = nil, region: AWSSDKSwiftCore.Region? = nil, endpoint: String? = nil, middlewares: [AWSServiceMiddleware] = [], eventLoopGroupProvider: AWSClient.EventLoopGroupProvider = .useAWSClientShared)Parameters
accessKeyIdPublic access key provided by AWS
secretAccessKeyPrivate access key provided by AWS
sessionTokenToken provided by STS.AssumeRole() which allows access to another AWS account
regionRegion of server you want to communicate with
endpointCustom endpoint URL to use instead of standard AWS servers
middlewaresArray of middlewares to apply to requests and responses
eventLoopGroupProviderEventLoopGroup to use. Use
useAWSClientSharedif the client shall manage its own EventLoopGroup.
-
Create a new configuration set. After you create the configuration set, you can add one or more event destinations to it.
Declaration
Swift
public func createConfigurationSet(_ input: CreateConfigurationSetRequest) -> EventLoopFuture<CreateConfigurationSetResponse> -
Create a new event destination in a configuration set.
Declaration
Swift
public func createConfigurationSetEventDestination(_ input: CreateConfigurationSetEventDestinationRequest) -> EventLoopFuture<CreateConfigurationSetEventDestinationResponse> -
Deletes an existing configuration set.
Declaration
Swift
public func deleteConfigurationSet(_ input: DeleteConfigurationSetRequest) -> EventLoopFuture<DeleteConfigurationSetResponse> -
Deletes an event destination in a configuration set.
Declaration
Swift
public func deleteConfigurationSetEventDestination(_ input: DeleteConfigurationSetEventDestinationRequest) -> EventLoopFuture<DeleteConfigurationSetEventDestinationResponse> -
Obtain information about an event destination, including the types of events it reports, the Amazon Resource Name (ARN) of the destination, and the name of the event destination.
Declaration
Swift
public func getConfigurationSetEventDestinations(_ input: GetConfigurationSetEventDestinationsRequest) -> EventLoopFuture<GetConfigurationSetEventDestinationsResponse> -
List all of the configuration sets associated with your Amazon Pinpoint account in the current region.
Declaration
Swift
public func listConfigurationSets(_ input: ListConfigurationSetsRequest) -> EventLoopFuture<ListConfigurationSetsResponse> -
Create a new voice message and send it to a recipient’s phone number.
Declaration
Swift
public func sendVoiceMessage(_ input: SendVoiceMessageRequest) -> EventLoopFuture<SendVoiceMessageResponse> -
Update an event destination in a configuration set. An event destination is a location that you publish information about your voice calls to. For example, you can log an event to an Amazon CloudWatch destination when a call fails.
Declaration
Swift
public func updateConfigurationSetEventDestination(_ input: UpdateConfigurationSetEventDestinationRequest) -> EventLoopFuture<UpdateConfigurationSetEventDestinationResponse>
-
Undocumented
See moreDeclaration
Swift
public enum EventType : String, CustomStringConvertible, Codable