Documentation ¶
Overview ¶
Package sns provides a client for Amazon Simple Notification Service.
Index ¶
- Constants
- type AddPermissionInput
- type AddPermissionOutput
- type ConfirmSubscriptionInput
- type ConfirmSubscriptionOutput
- type CreatePlatformApplicationInput
- type CreatePlatformApplicationOutput
- type CreatePlatformEndpointInput
- type CreatePlatformEndpointOutput
- type CreateTopicInput
- type CreateTopicOutput
- type DeleteEndpointInput
- type DeleteEndpointOutput
- type DeletePlatformApplicationInput
- type DeletePlatformApplicationOutput
- type DeleteTopicInput
- type DeleteTopicOutput
- type Endpoint
- type GetEndpointAttributesInput
- type GetEndpointAttributesOutput
- type GetPlatformApplicationAttributesInput
- type GetPlatformApplicationAttributesOutput
- type GetSubscriptionAttributesInput
- type GetSubscriptionAttributesOutput
- type GetTopicAttributesInput
- type GetTopicAttributesOutput
- type ListEndpointsByPlatformApplicationInput
- type ListEndpointsByPlatformApplicationOutput
- type ListPlatformApplicationsInput
- type ListPlatformApplicationsOutput
- type ListSubscriptionsByTopicInput
- type ListSubscriptionsByTopicOutput
- type ListSubscriptionsInput
- type ListSubscriptionsOutput
- type ListTopicsInput
- type ListTopicsOutput
- type MessageAttributeValue
- type PlatformApplication
- type PublishInput
- type PublishOutput
- type RemovePermissionInput
- type RemovePermissionOutput
- type SNS
- func (c *SNS) AddPermission(input *AddPermissionInput) (*AddPermissionOutput, error)
- func (c *SNS) AddPermissionRequest(input *AddPermissionInput) (req *request.Request, output *AddPermissionOutput)
- func (c *SNS) ConfirmSubscription(input *ConfirmSubscriptionInput) (*ConfirmSubscriptionOutput, error)
- func (c *SNS) ConfirmSubscriptionRequest(input *ConfirmSubscriptionInput) (req *request.Request, output *ConfirmSubscriptionOutput)
- func (c *SNS) CreatePlatformApplication(input *CreatePlatformApplicationInput) (*CreatePlatformApplicationOutput, error)
- func (c *SNS) CreatePlatformApplicationRequest(input *CreatePlatformApplicationInput) (req *request.Request, output *CreatePlatformApplicationOutput)
- func (c *SNS) CreatePlatformEndpoint(input *CreatePlatformEndpointInput) (*CreatePlatformEndpointOutput, error)
- func (c *SNS) CreatePlatformEndpointRequest(input *CreatePlatformEndpointInput) (req *request.Request, output *CreatePlatformEndpointOutput)
- func (c *SNS) CreateTopic(input *CreateTopicInput) (*CreateTopicOutput, error)
- func (c *SNS) CreateTopicRequest(input *CreateTopicInput) (req *request.Request, output *CreateTopicOutput)
- func (c *SNS) DeleteEndpoint(input *DeleteEndpointInput) (*DeleteEndpointOutput, error)
- func (c *SNS) DeleteEndpointRequest(input *DeleteEndpointInput) (req *request.Request, output *DeleteEndpointOutput)
- func (c *SNS) DeletePlatformApplication(input *DeletePlatformApplicationInput) (*DeletePlatformApplicationOutput, error)
- func (c *SNS) DeletePlatformApplicationRequest(input *DeletePlatformApplicationInput) (req *request.Request, output *DeletePlatformApplicationOutput)
- func (c *SNS) DeleteTopic(input *DeleteTopicInput) (*DeleteTopicOutput, error)
- func (c *SNS) DeleteTopicRequest(input *DeleteTopicInput) (req *request.Request, output *DeleteTopicOutput)
- func (c *SNS) GetEndpointAttributes(input *GetEndpointAttributesInput) (*GetEndpointAttributesOutput, error)
- func (c *SNS) GetEndpointAttributesRequest(input *GetEndpointAttributesInput) (req *request.Request, output *GetEndpointAttributesOutput)
- func (c *SNS) GetPlatformApplicationAttributes(input *GetPlatformApplicationAttributesInput) (*GetPlatformApplicationAttributesOutput, error)
- func (c *SNS) GetPlatformApplicationAttributesRequest(input *GetPlatformApplicationAttributesInput) (req *request.Request, output *GetPlatformApplicationAttributesOutput)
- func (c *SNS) GetSubscriptionAttributes(input *GetSubscriptionAttributesInput) (*GetSubscriptionAttributesOutput, error)
- func (c *SNS) GetSubscriptionAttributesRequest(input *GetSubscriptionAttributesInput) (req *request.Request, output *GetSubscriptionAttributesOutput)
- func (c *SNS) GetTopicAttributes(input *GetTopicAttributesInput) (*GetTopicAttributesOutput, error)
- func (c *SNS) GetTopicAttributesRequest(input *GetTopicAttributesInput) (req *request.Request, output *GetTopicAttributesOutput)
- func (c *SNS) ListEndpointsByPlatformApplication(input *ListEndpointsByPlatformApplicationInput) (*ListEndpointsByPlatformApplicationOutput, error)
- func (c *SNS) ListEndpointsByPlatformApplicationPages(input *ListEndpointsByPlatformApplicationInput, ...) error
- func (c *SNS) ListEndpointsByPlatformApplicationRequest(input *ListEndpointsByPlatformApplicationInput) (req *request.Request, output *ListEndpointsByPlatformApplicationOutput)
- func (c *SNS) ListPlatformApplications(input *ListPlatformApplicationsInput) (*ListPlatformApplicationsOutput, error)
- func (c *SNS) ListPlatformApplicationsPages(input *ListPlatformApplicationsInput, ...) error
- func (c *SNS) ListPlatformApplicationsRequest(input *ListPlatformApplicationsInput) (req *request.Request, output *ListPlatformApplicationsOutput)
- func (c *SNS) ListSubscriptions(input *ListSubscriptionsInput) (*ListSubscriptionsOutput, error)
- func (c *SNS) ListSubscriptionsByTopic(input *ListSubscriptionsByTopicInput) (*ListSubscriptionsByTopicOutput, error)
- func (c *SNS) ListSubscriptionsByTopicPages(input *ListSubscriptionsByTopicInput, ...) error
- func (c *SNS) ListSubscriptionsByTopicRequest(input *ListSubscriptionsByTopicInput) (req *request.Request, output *ListSubscriptionsByTopicOutput)
- func (c *SNS) ListSubscriptionsPages(input *ListSubscriptionsInput, ...) error
- func (c *SNS) ListSubscriptionsRequest(input *ListSubscriptionsInput) (req *request.Request, output *ListSubscriptionsOutput)
- func (c *SNS) ListTopics(input *ListTopicsInput) (*ListTopicsOutput, error)
- func (c *SNS) ListTopicsPages(input *ListTopicsInput, ...) error
- func (c *SNS) ListTopicsRequest(input *ListTopicsInput) (req *request.Request, output *ListTopicsOutput)
- func (c *SNS) Publish(input *PublishInput) (*PublishOutput, error)
- func (c *SNS) PublishRequest(input *PublishInput) (req *request.Request, output *PublishOutput)
- func (c *SNS) RemovePermission(input *RemovePermissionInput) (*RemovePermissionOutput, error)
- func (c *SNS) RemovePermissionRequest(input *RemovePermissionInput) (req *request.Request, output *RemovePermissionOutput)
- func (c *SNS) SetEndpointAttributes(input *SetEndpointAttributesInput) (*SetEndpointAttributesOutput, error)
- func (c *SNS) SetEndpointAttributesRequest(input *SetEndpointAttributesInput) (req *request.Request, output *SetEndpointAttributesOutput)
- func (c *SNS) SetPlatformApplicationAttributes(input *SetPlatformApplicationAttributesInput) (*SetPlatformApplicationAttributesOutput, error)
- func (c *SNS) SetPlatformApplicationAttributesRequest(input *SetPlatformApplicationAttributesInput) (req *request.Request, output *SetPlatformApplicationAttributesOutput)
- func (c *SNS) SetSubscriptionAttributes(input *SetSubscriptionAttributesInput) (*SetSubscriptionAttributesOutput, error)
- func (c *SNS) SetSubscriptionAttributesRequest(input *SetSubscriptionAttributesInput) (req *request.Request, output *SetSubscriptionAttributesOutput)
- func (c *SNS) SetTopicAttributes(input *SetTopicAttributesInput) (*SetTopicAttributesOutput, error)
- func (c *SNS) SetTopicAttributesRequest(input *SetTopicAttributesInput) (req *request.Request, output *SetTopicAttributesOutput)
- func (c *SNS) Subscribe(input *SubscribeInput) (*SubscribeOutput, error)
- func (c *SNS) SubscribeRequest(input *SubscribeInput) (req *request.Request, output *SubscribeOutput)
- func (c *SNS) Unsubscribe(input *UnsubscribeInput) (*UnsubscribeOutput, error)
- func (c *SNS) UnsubscribeRequest(input *UnsubscribeInput) (req *request.Request, output *UnsubscribeOutput)
- type SetEndpointAttributesInput
- type SetEndpointAttributesOutput
- type SetPlatformApplicationAttributesInput
- type SetPlatformApplicationAttributesOutput
- type SetSubscriptionAttributesInput
- type SetSubscriptionAttributesOutput
- type SetTopicAttributesInput
- type SetTopicAttributesOutput
- type SubscribeInput
- type SubscribeOutput
- type Subscription
- type Topic
- type UnsubscribeInput
- type UnsubscribeOutput
Examples ¶
- SNS.AddPermission
- SNS.ConfirmSubscription
- SNS.CreatePlatformApplication
- SNS.CreatePlatformEndpoint
- SNS.CreateTopic
- SNS.DeleteEndpoint
- SNS.DeletePlatformApplication
- SNS.DeleteTopic
- SNS.GetEndpointAttributes
- SNS.GetPlatformApplicationAttributes
- SNS.GetSubscriptionAttributes
- SNS.GetTopicAttributes
- SNS.ListEndpointsByPlatformApplication
- SNS.ListPlatformApplications
- SNS.ListSubscriptions
- SNS.ListSubscriptionsByTopic
- SNS.ListTopics
- SNS.Publish
- SNS.RemovePermission
- SNS.SetEndpointAttributes
- SNS.SetPlatformApplicationAttributes
- SNS.SetSubscriptionAttributes
- SNS.SetTopicAttributes
- SNS.Subscribe
- SNS.Unsubscribe
Constants ¶
const ServiceName = "sns"
A ServiceName is the name of the service the client will make API calls to.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AddPermissionInput ¶
type AddPermissionInput struct { // The AWS account IDs of the users (principals) who will be given access to // the specified actions. The users must have AWS accounts, but do not need // to be signed up for this service. AWSAccountId []*string `type:"list" required:"true"` // The action you want to allow for the specified principal(s). // // Valid values: any Amazon SNS action name. ActionName []*string `type:"list" required:"true"` // A unique identifier for the new policy statement. Label *string `type:"string" required:"true"` // The ARN of the topic whose access control policy you wish to modify. TopicArn *string `type:"string" required:"true"` // contains filtered or unexported fields }
func (AddPermissionInput) GoString ¶ added in v0.6.5
func (s AddPermissionInput) GoString() string
GoString returns the string representation
func (AddPermissionInput) String ¶ added in v0.6.5
func (s AddPermissionInput) String() string
String returns the string representation
type AddPermissionOutput ¶
type AddPermissionOutput struct {
// contains filtered or unexported fields
}
func (AddPermissionOutput) GoString ¶ added in v0.6.5
func (s AddPermissionOutput) GoString() string
GoString returns the string representation
func (AddPermissionOutput) String ¶ added in v0.6.5
func (s AddPermissionOutput) String() string
String returns the string representation
type ConfirmSubscriptionInput ¶
type ConfirmSubscriptionInput struct { // Disallows unauthenticated unsubscribes of the subscription. If the value // of this parameter is true and the request has an AWS signature, then only // the topic owner and the subscription owner can unsubscribe the endpoint. // The unsubscribe action requires AWS authentication. AuthenticateOnUnsubscribe *string `type:"string"` // Short-lived token sent to an endpoint during the Subscribe action. Token *string `type:"string" required:"true"` // The ARN of the topic for which you wish to confirm a subscription. TopicArn *string `type:"string" required:"true"` // contains filtered or unexported fields }
Input for ConfirmSubscription action.
func (ConfirmSubscriptionInput) GoString ¶ added in v0.6.5
func (s ConfirmSubscriptionInput) GoString() string
GoString returns the string representation
func (ConfirmSubscriptionInput) String ¶ added in v0.6.5
func (s ConfirmSubscriptionInput) String() string
String returns the string representation
type ConfirmSubscriptionOutput ¶
type ConfirmSubscriptionOutput struct { // The ARN of the created subscription. SubscriptionArn *string `type:"string"` // contains filtered or unexported fields }
Response for ConfirmSubscriptions action.
func (ConfirmSubscriptionOutput) GoString ¶ added in v0.6.5
func (s ConfirmSubscriptionOutput) GoString() string
GoString returns the string representation
func (ConfirmSubscriptionOutput) String ¶ added in v0.6.5
func (s ConfirmSubscriptionOutput) String() string
String returns the string representation
type CreatePlatformApplicationInput ¶
type CreatePlatformApplicationInput struct { // For a list of attributes, see SetPlatformApplicationAttributes (http://docs.aws.amazon.com/sns/latest/api/API_SetPlatformApplicationAttributes.html) Attributes map[string]*string `type:"map" required:"true"` // Application names must be made up of only uppercase and lowercase ASCII letters, // numbers, underscores, hyphens, and periods, and must be between 1 and 256 // characters long. Name *string `type:"string" required:"true"` // The following platforms are supported: ADM (Amazon Device Messaging), APNS // (Apple Push Notification Service), APNS_SANDBOX, and GCM (Google Cloud Messaging). Platform *string `type:"string" required:"true"` // contains filtered or unexported fields }
Input for CreatePlatformApplication action.
func (CreatePlatformApplicationInput) GoString ¶ added in v0.6.5
func (s CreatePlatformApplicationInput) GoString() string
GoString returns the string representation
func (CreatePlatformApplicationInput) String ¶ added in v0.6.5
func (s CreatePlatformApplicationInput) String() string
String returns the string representation
type CreatePlatformApplicationOutput ¶
type CreatePlatformApplicationOutput struct { // PlatformApplicationArn is returned. PlatformApplicationArn *string `type:"string"` // contains filtered or unexported fields }
Response from CreatePlatformApplication action.
func (CreatePlatformApplicationOutput) GoString ¶ added in v0.6.5
func (s CreatePlatformApplicationOutput) GoString() string
GoString returns the string representation
func (CreatePlatformApplicationOutput) String ¶ added in v0.6.5
func (s CreatePlatformApplicationOutput) String() string
String returns the string representation
type CreatePlatformEndpointInput ¶
type CreatePlatformEndpointInput struct { // For a list of attributes, see SetEndpointAttributes (http://docs.aws.amazon.com/sns/latest/api/API_SetEndpointAttributes.html). Attributes map[string]*string `type:"map"` // Arbitrary user data to associate with the endpoint. Amazon SNS does not use // this data. The data must be in UTF-8 format and less than 2KB. CustomUserData *string `type:"string"` // PlatformApplicationArn returned from CreatePlatformApplication is used to // create a an endpoint. PlatformApplicationArn *string `type:"string" required:"true"` // Unique identifier created by the notification service for an app on a device. // The specific name for Token will vary, depending on which notification service // is being used. For example, when using APNS as the notification service, // you need the device token. Alternatively, when using GCM or ADM, the device // token equivalent is called the registration ID. Token *string `type:"string" required:"true"` // contains filtered or unexported fields }
Input for CreatePlatformEndpoint action.
func (CreatePlatformEndpointInput) GoString ¶ added in v0.6.5
func (s CreatePlatformEndpointInput) GoString() string
GoString returns the string representation
func (CreatePlatformEndpointInput) String ¶ added in v0.6.5
func (s CreatePlatformEndpointInput) String() string
String returns the string representation
type CreatePlatformEndpointOutput ¶
type CreatePlatformEndpointOutput struct { // EndpointArn returned from CreateEndpoint action. EndpointArn *string `type:"string"` // contains filtered or unexported fields }
Response from CreateEndpoint action.
func (CreatePlatformEndpointOutput) GoString ¶ added in v0.6.5
func (s CreatePlatformEndpointOutput) GoString() string
GoString returns the string representation
func (CreatePlatformEndpointOutput) String ¶ added in v0.6.5
func (s CreatePlatformEndpointOutput) String() string
String returns the string representation
type CreateTopicInput ¶
type CreateTopicInput struct { // The name of the topic you want to create. // // Constraints: Topic names must be made up of only uppercase and lowercase // ASCII letters, numbers, underscores, and hyphens, and must be between 1 and // 256 characters long. Name *string `type:"string" required:"true"` // contains filtered or unexported fields }
Input for CreateTopic action.
func (CreateTopicInput) GoString ¶ added in v0.6.5
func (s CreateTopicInput) GoString() string
GoString returns the string representation
func (CreateTopicInput) String ¶ added in v0.6.5
func (s CreateTopicInput) String() string
String returns the string representation
type CreateTopicOutput ¶
type CreateTopicOutput struct { // The Amazon Resource Name (ARN) assigned to the created topic. TopicArn *string `type:"string"` // contains filtered or unexported fields }
Response from CreateTopic action.
func (CreateTopicOutput) GoString ¶ added in v0.6.5
func (s CreateTopicOutput) GoString() string
GoString returns the string representation
func (CreateTopicOutput) String ¶ added in v0.6.5
func (s CreateTopicOutput) String() string
String returns the string representation
type DeleteEndpointInput ¶
type DeleteEndpointInput struct { // EndpointArn of endpoint to delete. EndpointArn *string `type:"string" required:"true"` // contains filtered or unexported fields }
Input for DeleteEndpoint action.
func (DeleteEndpointInput) GoString ¶ added in v0.6.5
func (s DeleteEndpointInput) GoString() string
GoString returns the string representation
func (DeleteEndpointInput) String ¶ added in v0.6.5
func (s DeleteEndpointInput) String() string
String returns the string representation
type DeleteEndpointOutput ¶
type DeleteEndpointOutput struct {
// contains filtered or unexported fields
}
func (DeleteEndpointOutput) GoString ¶ added in v0.6.5
func (s DeleteEndpointOutput) GoString() string
GoString returns the string representation
func (DeleteEndpointOutput) String ¶ added in v0.6.5
func (s DeleteEndpointOutput) String() string
String returns the string representation
type DeletePlatformApplicationInput ¶
type DeletePlatformApplicationInput struct { // PlatformApplicationArn of platform application object to delete. PlatformApplicationArn *string `type:"string" required:"true"` // contains filtered or unexported fields }
Input for DeletePlatformApplication action.
func (DeletePlatformApplicationInput) GoString ¶ added in v0.6.5
func (s DeletePlatformApplicationInput) GoString() string
GoString returns the string representation
func (DeletePlatformApplicationInput) String ¶ added in v0.6.5
func (s DeletePlatformApplicationInput) String() string
String returns the string representation
type DeletePlatformApplicationOutput ¶
type DeletePlatformApplicationOutput struct {
// contains filtered or unexported fields
}
func (DeletePlatformApplicationOutput) GoString ¶ added in v0.6.5
func (s DeletePlatformApplicationOutput) GoString() string
GoString returns the string representation
func (DeletePlatformApplicationOutput) String ¶ added in v0.6.5
func (s DeletePlatformApplicationOutput) String() string
String returns the string representation
type DeleteTopicInput ¶
type DeleteTopicInput struct { // The ARN of the topic you want to delete. TopicArn *string `type:"string" required:"true"` // contains filtered or unexported fields }
func (DeleteTopicInput) GoString ¶ added in v0.6.5
func (s DeleteTopicInput) GoString() string
GoString returns the string representation
func (DeleteTopicInput) String ¶ added in v0.6.5
func (s DeleteTopicInput) String() string
String returns the string representation
type DeleteTopicOutput ¶
type DeleteTopicOutput struct {
// contains filtered or unexported fields
}
func (DeleteTopicOutput) GoString ¶ added in v0.6.5
func (s DeleteTopicOutput) GoString() string
GoString returns the string representation
func (DeleteTopicOutput) String ¶ added in v0.6.5
func (s DeleteTopicOutput) String() string
String returns the string representation
type Endpoint ¶
type Endpoint struct { // Attributes for endpoint. Attributes map[string]*string `type:"map"` // EndpointArn for mobile app and device. EndpointArn *string `type:"string"` // contains filtered or unexported fields }
Endpoint for mobile app and device.
type GetEndpointAttributesInput ¶
type GetEndpointAttributesInput struct { // EndpointArn for GetEndpointAttributes input. EndpointArn *string `type:"string" required:"true"` // contains filtered or unexported fields }
Input for GetEndpointAttributes action.
func (GetEndpointAttributesInput) GoString ¶ added in v0.6.5
func (s GetEndpointAttributesInput) GoString() string
GoString returns the string representation
func (GetEndpointAttributesInput) String ¶ added in v0.6.5
func (s GetEndpointAttributesInput) String() string
String returns the string representation
type GetEndpointAttributesOutput ¶
type GetEndpointAttributesOutput struct { // Attributes include the following: // // CustomUserData -- arbitrary user data to associate with the endpoint. // Amazon SNS does not use this data. The data must be in UTF-8 format and less // than 2KB. Enabled -- flag that enables/disables delivery to the endpoint. // Amazon SNS will set this to false when a notification service indicates to // Amazon SNS that the endpoint is invalid. Users can set it back to true, typically // after updating Token. Token -- device token, also referred to as a registration // id, for an app and mobile device. This is returned from the notification // service when an app and mobile device are registered with the notification // service. Attributes map[string]*string `type:"map"` // contains filtered or unexported fields }
Response from GetEndpointAttributes of the EndpointArn.
func (GetEndpointAttributesOutput) GoString ¶ added in v0.6.5
func (s GetEndpointAttributesOutput) GoString() string
GoString returns the string representation
func (GetEndpointAttributesOutput) String ¶ added in v0.6.5
func (s GetEndpointAttributesOutput) String() string
String returns the string representation
type GetPlatformApplicationAttributesInput ¶
type GetPlatformApplicationAttributesInput struct { // PlatformApplicationArn for GetPlatformApplicationAttributesInput. PlatformApplicationArn *string `type:"string" required:"true"` // contains filtered or unexported fields }
Input for GetPlatformApplicationAttributes action.
func (GetPlatformApplicationAttributesInput) GoString ¶ added in v0.6.5
func (s GetPlatformApplicationAttributesInput) GoString() string
GoString returns the string representation
func (GetPlatformApplicationAttributesInput) String ¶ added in v0.6.5
func (s GetPlatformApplicationAttributesInput) String() string
String returns the string representation
type GetPlatformApplicationAttributesOutput ¶
type GetPlatformApplicationAttributesOutput struct { // Attributes include the following: // // EventEndpointCreated -- Topic ARN to which EndpointCreated event notifications // should be sent. EventEndpointDeleted -- Topic ARN to which EndpointDeleted // event notifications should be sent. EventEndpointUpdated -- Topic ARN to // which EndpointUpdate event notifications should be sent. EventDeliveryFailure // -- Topic ARN to which DeliveryFailure event notifications should be sent // upon Direct Publish delivery failure (permanent) to one of the application's // endpoints. Attributes map[string]*string `type:"map"` // contains filtered or unexported fields }
Response for GetPlatformApplicationAttributes action.
func (GetPlatformApplicationAttributesOutput) GoString ¶ added in v0.6.5
func (s GetPlatformApplicationAttributesOutput) GoString() string
GoString returns the string representation
func (GetPlatformApplicationAttributesOutput) String ¶ added in v0.6.5
func (s GetPlatformApplicationAttributesOutput) String() string
String returns the string representation
type GetSubscriptionAttributesInput ¶
type GetSubscriptionAttributesInput struct { // The ARN of the subscription whose properties you want to get. SubscriptionArn *string `type:"string" required:"true"` // contains filtered or unexported fields }
Input for GetSubscriptionAttributes.
func (GetSubscriptionAttributesInput) GoString ¶ added in v0.6.5
func (s GetSubscriptionAttributesInput) GoString() string
GoString returns the string representation
func (GetSubscriptionAttributesInput) String ¶ added in v0.6.5
func (s GetSubscriptionAttributesInput) String() string
String returns the string representation
type GetSubscriptionAttributesOutput ¶
type GetSubscriptionAttributesOutput struct { // A map of the subscription's attributes. Attributes in this map include the // following: // // SubscriptionArn -- the subscription's ARN TopicArn -- the topic ARN that // the subscription is associated with Owner -- the AWS account ID of the subscription's // owner ConfirmationWasAuthenticated -- true if the subscription confirmation // request was authenticated DeliveryPolicy -- the JSON serialization of the // subscription's delivery policy EffectiveDeliveryPolicy -- the JSON serialization // of the effective delivery policy that takes into account the topic delivery // policy and account system defaults Attributes map[string]*string `type:"map"` // contains filtered or unexported fields }
Response for GetSubscriptionAttributes action.
func (GetSubscriptionAttributesOutput) GoString ¶ added in v0.6.5
func (s GetSubscriptionAttributesOutput) GoString() string
GoString returns the string representation
func (GetSubscriptionAttributesOutput) String ¶ added in v0.6.5
func (s GetSubscriptionAttributesOutput) String() string
String returns the string representation
type GetTopicAttributesInput ¶
type GetTopicAttributesInput struct { // The ARN of the topic whose properties you want to get. TopicArn *string `type:"string" required:"true"` // contains filtered or unexported fields }
Input for GetTopicAttributes action.
func (GetTopicAttributesInput) GoString ¶ added in v0.6.5
func (s GetTopicAttributesInput) GoString() string
GoString returns the string representation
func (GetTopicAttributesInput) String ¶ added in v0.6.5
func (s GetTopicAttributesInput) String() string
String returns the string representation
type GetTopicAttributesOutput ¶
type GetTopicAttributesOutput struct { // A map of the topic's attributes. Attributes in this map include the following: // // TopicArn -- the topic's ARN Owner -- the AWS account ID of the topic's // owner Policy -- the JSON serialization of the topic's access control policy // DisplayName -- the human-readable name used in the "From" field for notifications // to email and email-json endpoints SubscriptionsPending -- the number of // subscriptions pending confirmation on this topic SubscriptionsConfirmed // -- the number of confirmed subscriptions on this topic SubscriptionsDeleted // -- the number of deleted subscriptions on this topic DeliveryPolicy -- the // JSON serialization of the topic's delivery policy EffectiveDeliveryPolicy // -- the JSON serialization of the effective delivery policy that takes into // account system defaults Attributes map[string]*string `type:"map"` // contains filtered or unexported fields }
Response for GetTopicAttributes action.
func (GetTopicAttributesOutput) GoString ¶ added in v0.6.5
func (s GetTopicAttributesOutput) GoString() string
GoString returns the string representation
func (GetTopicAttributesOutput) String ¶ added in v0.6.5
func (s GetTopicAttributesOutput) String() string
String returns the string representation
type ListEndpointsByPlatformApplicationInput ¶
type ListEndpointsByPlatformApplicationInput struct { // NextToken string is used when calling ListEndpointsByPlatformApplication // action to retrieve additional records that are available after the first // page results. NextToken *string `type:"string"` // PlatformApplicationArn for ListEndpointsByPlatformApplicationInput action. PlatformApplicationArn *string `type:"string" required:"true"` // contains filtered or unexported fields }
Input for ListEndpointsByPlatformApplication action.
func (ListEndpointsByPlatformApplicationInput) GoString ¶ added in v0.6.5
func (s ListEndpointsByPlatformApplicationInput) GoString() string
GoString returns the string representation
func (ListEndpointsByPlatformApplicationInput) String ¶ added in v0.6.5
func (s ListEndpointsByPlatformApplicationInput) String() string
String returns the string representation
type ListEndpointsByPlatformApplicationOutput ¶
type ListEndpointsByPlatformApplicationOutput struct { // Endpoints returned for ListEndpointsByPlatformApplication action. Endpoints []*Endpoint `type:"list"` // NextToken string is returned when calling ListEndpointsByPlatformApplication // action if additional records are available after the first page results. NextToken *string `type:"string"` // contains filtered or unexported fields }
Response for ListEndpointsByPlatformApplication action.
func (ListEndpointsByPlatformApplicationOutput) GoString ¶ added in v0.6.5
func (s ListEndpointsByPlatformApplicationOutput) GoString() string
GoString returns the string representation
func (ListEndpointsByPlatformApplicationOutput) String ¶ added in v0.6.5
func (s ListEndpointsByPlatformApplicationOutput) String() string
String returns the string representation
type ListPlatformApplicationsInput ¶
type ListPlatformApplicationsInput struct { // NextToken string is used when calling ListPlatformApplications action to // retrieve additional records that are available after the first page results. NextToken *string `type:"string"` // contains filtered or unexported fields }
Input for ListPlatformApplications action.
func (ListPlatformApplicationsInput) GoString ¶ added in v0.6.5
func (s ListPlatformApplicationsInput) GoString() string
GoString returns the string representation
func (ListPlatformApplicationsInput) String ¶ added in v0.6.5
func (s ListPlatformApplicationsInput) String() string
String returns the string representation
type ListPlatformApplicationsOutput ¶
type ListPlatformApplicationsOutput struct { // NextToken string is returned when calling ListPlatformApplications action // if additional records are available after the first page results. NextToken *string `type:"string"` // Platform applications returned when calling ListPlatformApplications action. PlatformApplications []*PlatformApplication `type:"list"` // contains filtered or unexported fields }
Response for ListPlatformApplications action.
func (ListPlatformApplicationsOutput) GoString ¶ added in v0.6.5
func (s ListPlatformApplicationsOutput) GoString() string
GoString returns the string representation
func (ListPlatformApplicationsOutput) String ¶ added in v0.6.5
func (s ListPlatformApplicationsOutput) String() string
String returns the string representation
type ListSubscriptionsByTopicInput ¶
type ListSubscriptionsByTopicInput struct { // Token returned by the previous ListSubscriptionsByTopic request. NextToken *string `type:"string"` // The ARN of the topic for which you wish to find subscriptions. TopicArn *string `type:"string" required:"true"` // contains filtered or unexported fields }
Input for ListSubscriptionsByTopic action.
func (ListSubscriptionsByTopicInput) GoString ¶ added in v0.6.5
func (s ListSubscriptionsByTopicInput) GoString() string
GoString returns the string representation
func (ListSubscriptionsByTopicInput) String ¶ added in v0.6.5
func (s ListSubscriptionsByTopicInput) String() string
String returns the string representation
type ListSubscriptionsByTopicOutput ¶
type ListSubscriptionsByTopicOutput struct { // Token to pass along to the next ListSubscriptionsByTopic request. This element // is returned if there are more subscriptions to retrieve. NextToken *string `type:"string"` // A list of subscriptions. Subscriptions []*Subscription `type:"list"` // contains filtered or unexported fields }
Response for ListSubscriptionsByTopic action.
func (ListSubscriptionsByTopicOutput) GoString ¶ added in v0.6.5
func (s ListSubscriptionsByTopicOutput) GoString() string
GoString returns the string representation
func (ListSubscriptionsByTopicOutput) String ¶ added in v0.6.5
func (s ListSubscriptionsByTopicOutput) String() string
String returns the string representation
type ListSubscriptionsInput ¶
type ListSubscriptionsInput struct { // Token returned by the previous ListSubscriptions request. NextToken *string `type:"string"` // contains filtered or unexported fields }
Input for ListSubscriptions action.
func (ListSubscriptionsInput) GoString ¶ added in v0.6.5
func (s ListSubscriptionsInput) GoString() string
GoString returns the string representation
func (ListSubscriptionsInput) String ¶ added in v0.6.5
func (s ListSubscriptionsInput) String() string
String returns the string representation
type ListSubscriptionsOutput ¶
type ListSubscriptionsOutput struct { // Token to pass along to the next ListSubscriptions request. This element is // returned if there are more subscriptions to retrieve. NextToken *string `type:"string"` // A list of subscriptions. Subscriptions []*Subscription `type:"list"` // contains filtered or unexported fields }
Response for ListSubscriptions action
func (ListSubscriptionsOutput) GoString ¶ added in v0.6.5
func (s ListSubscriptionsOutput) GoString() string
GoString returns the string representation
func (ListSubscriptionsOutput) String ¶ added in v0.6.5
func (s ListSubscriptionsOutput) String() string
String returns the string representation
type ListTopicsInput ¶
type ListTopicsInput struct { // Token returned by the previous ListTopics request. NextToken *string `type:"string"` // contains filtered or unexported fields }
func (ListTopicsInput) GoString ¶ added in v0.6.5
func (s ListTopicsInput) GoString() string
GoString returns the string representation
func (ListTopicsInput) String ¶ added in v0.6.5
func (s ListTopicsInput) String() string
String returns the string representation
type ListTopicsOutput ¶
type ListTopicsOutput struct { // Token to pass along to the next ListTopics request. This element is returned // if there are additional topics to retrieve. NextToken *string `type:"string"` // A list of topic ARNs. Topics []*Topic `type:"list"` // contains filtered or unexported fields }
Response for ListTopics action.
func (ListTopicsOutput) GoString ¶ added in v0.6.5
func (s ListTopicsOutput) GoString() string
GoString returns the string representation
func (ListTopicsOutput) String ¶ added in v0.6.5
func (s ListTopicsOutput) String() string
String returns the string representation
type MessageAttributeValue ¶
type MessageAttributeValue struct { // Binary type attributes can store any binary data, for example, compressed // data, encrypted data, or images. // // BinaryValue is automatically base64 encoded/decoded by the SDK. BinaryValue []byte `type:"blob"` // Amazon SNS supports the following logical data types: String, Number, and // Binary. For more information, see Message Attribute Data Types (http://docs.aws.amazon.com/sns/latest/dg/SNSMessageAttributes.html#SNSMessageAttributes.DataTypes). DataType *string `type:"string" required:"true"` // Strings are Unicode with UTF8 binary encoding. For a list of code values, // see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters (http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters). StringValue *string `type:"string"` // contains filtered or unexported fields }
The user-specified message attribute value. For string data types, the value attribute has the same restrictions on the content as the message body. For more information, see Publish (http://docs.aws.amazon.com/sns/latest/api/API_Publish.html).
Name, type, and value must not be empty or null. In addition, the message body should not be empty or null. All parts of the message attribute, including name, type, and value, are included in the message size restriction, which is currently 256 KB (262,144 bytes). For more information, see Using Amazon SNS Message Attributes (http://docs.aws.amazon.com/sns/latest/dg/SNSMessageAttributes.html).
func (MessageAttributeValue) GoString ¶ added in v0.6.5
func (s MessageAttributeValue) GoString() string
GoString returns the string representation
func (MessageAttributeValue) String ¶ added in v0.6.5
func (s MessageAttributeValue) String() string
String returns the string representation
type PlatformApplication ¶
type PlatformApplication struct { // Attributes for platform application object. Attributes map[string]*string `type:"map"` // PlatformApplicationArn for platform application object. PlatformApplicationArn *string `type:"string"` // contains filtered or unexported fields }
Platform application object.
func (PlatformApplication) GoString ¶ added in v0.6.5
func (s PlatformApplication) GoString() string
GoString returns the string representation
func (PlatformApplication) String ¶ added in v0.6.5
func (s PlatformApplication) String() string
String returns the string representation
type PublishInput ¶
type PublishInput struct { // The message you want to send to the topic. // // If you want to send the same message to all transport protocols, include // the text of the message as a String value. // // If you want to send different messages for each transport protocol, set // the value of the MessageStructure parameter to json and use a JSON object // for the Message parameter. See the Examples section for the format of the // JSON object. // // Constraints: Messages must be UTF-8 encoded strings at most 256 KB in size // (262144 bytes, not 262144 characters). // // JSON-specific constraints: Keys in the JSON object that correspond to supported // transport protocols must have simple JSON string values. The values will // be parsed (unescaped) before they are used in outgoing messages. Outbound // notifications are JSON encoded (meaning that the characters will be reescaped // for sending). Values have a minimum length of 0 (the empty string, "", is // allowed). Values have a maximum length bounded by the overall message size // (so, including multiple protocols may limit message sizes). Non-string values // will cause the key to be ignored. Keys that do not correspond to supported // transport protocols are ignored. Duplicate keys are not allowed. Failure // to parse or validate any key or value in the message will cause the Publish // call to return an error (no partial delivery). Message *string `type:"string" required:"true"` // Message attributes for Publish action. MessageAttributes map[string]*MessageAttributeValue `locationNameKey:"Name" locationNameValue:"Value" type:"map"` // Set MessageStructure to json if you want to send a different message for // each protocol. For example, using one publish action, you can send a short // message to your SMS subscribers and a longer message to your email subscribers. // If you set MessageStructure to json, the value of the Message parameter must: // // be a syntactically valid JSON object; and contain at least a top-level // JSON key of "default" with a value that is a string. You can define other // top-level keys that define the message you want to send to a specific transport // protocol (e.g., "http"). // // For information about sending different messages for each protocol using // the AWS Management Console, go to Create Different Messages for Each Protocol // (http://docs.aws.amazon.com/sns/latest/gsg/Publish.html#sns-message-formatting-by-protocol) // in the Amazon Simple Notification Service Getting Started Guide. // // Valid value: json MessageStructure *string `type:"string"` // Optional parameter to be used as the "Subject" line when the message is delivered // to email endpoints. This field will also be included, if present, in the // standard JSON messages delivered to other endpoints. // // Constraints: Subjects must be ASCII text that begins with a letter, number, // or punctuation mark; must not include line breaks or control characters; // and must be less than 100 characters long. Subject *string `type:"string"` // Either TopicArn or EndpointArn, but not both. TargetArn *string `type:"string"` // The topic you want to publish to. TopicArn *string `type:"string"` // contains filtered or unexported fields }
Input for Publish action.
func (PublishInput) GoString ¶ added in v0.6.5
func (s PublishInput) GoString() string
GoString returns the string representation
func (PublishInput) String ¶ added in v0.6.5
func (s PublishInput) String() string
String returns the string representation
type PublishOutput ¶
type PublishOutput struct { // Unique identifier assigned to the published message. // // Length Constraint: Maximum 100 characters MessageId *string `type:"string"` // contains filtered or unexported fields }
Response for Publish action.
func (PublishOutput) GoString ¶ added in v0.6.5
func (s PublishOutput) GoString() string
GoString returns the string representation
func (PublishOutput) String ¶ added in v0.6.5
func (s PublishOutput) String() string
String returns the string representation
type RemovePermissionInput ¶
type RemovePermissionInput struct { // The unique label of the statement you want to remove. Label *string `type:"string" required:"true"` // The ARN of the topic whose access control policy you wish to modify. TopicArn *string `type:"string" required:"true"` // contains filtered or unexported fields }
Input for RemovePermission action.
func (RemovePermissionInput) GoString ¶ added in v0.6.5
func (s RemovePermissionInput) GoString() string
GoString returns the string representation
func (RemovePermissionInput) String ¶ added in v0.6.5
func (s RemovePermissionInput) String() string
String returns the string representation
type RemovePermissionOutput ¶
type RemovePermissionOutput struct {
// contains filtered or unexported fields
}
func (RemovePermissionOutput) GoString ¶ added in v0.6.5
func (s RemovePermissionOutput) GoString() string
GoString returns the string representation
func (RemovePermissionOutput) String ¶ added in v0.6.5
func (s RemovePermissionOutput) String() string
String returns the string representation
type SNS ¶
Amazon Simple Notification Service (Amazon SNS) is a web service that enables you to build distributed web-enabled applications. Applications can use Amazon SNS to easily push real-time notification messages to interested subscribers over multiple delivery protocols. For more information about this product see http://aws.amazon.com/sns (http://aws.amazon.com/sns/). For detailed information about Amazon SNS features and their associated API calls, see the Amazon SNS Developer Guide (http://docs.aws.amazon.com/sns/latest/dg/).
We also provide SDKs that enable you to access Amazon SNS from your preferred programming language. The SDKs contain functionality that automatically takes care of tasks such as: cryptographically signing your service requests, retrying requests, and handling error responses. For a list of available SDKs, go to Tools for Amazon Web Services (http://aws.amazon.com/tools/). The service client's operations are safe to be used concurrently. It is not safe to mutate any of the client's properties though.
func New ¶
func New(p client.ConfigProvider, cfgs ...*aws.Config) *SNS
New creates a new instance of the SNS 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:
// Create a SNS client from just a session. svc := sns.New(mySession) // Create a SNS client with additional configuration svc := sns.New(mySession, aws.NewConfig().WithRegion("us-west-2"))
func (*SNS) AddPermission ¶
func (c *SNS) AddPermission(input *AddPermissionInput) (*AddPermissionOutput, error)
Adds a statement to a topic's access control policy, granting access for the specified AWS accounts to the specified actions.
func (*SNS) AddPermissionRequest ¶
func (c *SNS) AddPermissionRequest(input *AddPermissionInput) (req *request.Request, output *AddPermissionOutput)
AddPermissionRequest generates a request for the AddPermission operation.
func (*SNS) ConfirmSubscription ¶
func (c *SNS) ConfirmSubscription(input *ConfirmSubscriptionInput) (*ConfirmSubscriptionOutput, error)
Verifies an endpoint owner's intent to receive messages by validating the token sent to the endpoint by an earlier Subscribe action. If the token is valid, the action creates a new subscription and returns its Amazon Resource Name (ARN). This call requires an AWS signature only when the AuthenticateOnUnsubscribe flag is set to "true".
func (*SNS) ConfirmSubscriptionRequest ¶
func (c *SNS) ConfirmSubscriptionRequest(input *ConfirmSubscriptionInput) (req *request.Request, output *ConfirmSubscriptionOutput)
ConfirmSubscriptionRequest generates a request for the ConfirmSubscription operation.
func (*SNS) CreatePlatformApplication ¶
func (c *SNS) CreatePlatformApplication(input *CreatePlatformApplicationInput) (*CreatePlatformApplicationOutput, error)
Creates a platform application object for one of the supported push notification services, such as APNS and GCM, to which devices and mobile apps may register. You must specify PlatformPrincipal and PlatformCredential attributes when using the CreatePlatformApplication action. The PlatformPrincipal is received from the notification service. For APNS/APNS_SANDBOX, PlatformPrincipal is "SSL certificate". For GCM, PlatformPrincipal is not applicable. For ADM, PlatformPrincipal is "client id". The PlatformCredential is also received from the notification service. For APNS/APNS_SANDBOX, PlatformCredential is "private key". For GCM, PlatformCredential is "API key". For ADM, PlatformCredential is "client secret". The PlatformApplicationArn that is returned when using CreatePlatformApplication is then used as an attribute for the CreatePlatformEndpoint action. For more information, see Using Amazon SNS Mobile Push Notifications (http://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html).
func (*SNS) CreatePlatformApplicationRequest ¶
func (c *SNS) CreatePlatformApplicationRequest(input *CreatePlatformApplicationInput) (req *request.Request, output *CreatePlatformApplicationOutput)
CreatePlatformApplicationRequest generates a request for the CreatePlatformApplication operation.
func (*SNS) CreatePlatformEndpoint ¶
func (c *SNS) CreatePlatformEndpoint(input *CreatePlatformEndpointInput) (*CreatePlatformEndpointOutput, error)
Creates an endpoint for a device and mobile app on one of the supported push notification services, such as GCM and APNS. CreatePlatformEndpoint requires the PlatformApplicationArn that is returned from CreatePlatformApplication. The EndpointArn that is returned when using CreatePlatformEndpoint can then be used by the Publish action to send a message to a mobile app or by the Subscribe action for subscription to a topic. The CreatePlatformEndpoint action is idempotent, so if the requester already owns an endpoint with the same device token and attributes, that endpoint's ARN is returned without creating a new endpoint. For more information, see Using Amazon SNS Mobile Push Notifications (http://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html).
When using CreatePlatformEndpoint with Baidu, two attributes must be provided: ChannelId and UserId. The token field must also contain the ChannelId. For more information, see Creating an Amazon SNS Endpoint for Baidu (http://docs.aws.amazon.com/sns/latest/dg/SNSMobilePushBaiduEndpoint.html).
func (*SNS) CreatePlatformEndpointRequest ¶
func (c *SNS) CreatePlatformEndpointRequest(input *CreatePlatformEndpointInput) (req *request.Request, output *CreatePlatformEndpointOutput)
CreatePlatformEndpointRequest generates a request for the CreatePlatformEndpoint operation.
func (*SNS) CreateTopic ¶
func (c *SNS) CreateTopic(input *CreateTopicInput) (*CreateTopicOutput, error)
Creates a topic to which notifications can be published. Users can create at most 3000 topics. For more information, see http://aws.amazon.com/sns (http://aws.amazon.com/sns/). This action is idempotent, so if the requester already owns a topic with the specified name, that topic's ARN is returned without creating a new topic.
func (*SNS) CreateTopicRequest ¶
func (c *SNS) CreateTopicRequest(input *CreateTopicInput) (req *request.Request, output *CreateTopicOutput)
CreateTopicRequest generates a request for the CreateTopic operation.
func (*SNS) DeleteEndpoint ¶
func (c *SNS) DeleteEndpoint(input *DeleteEndpointInput) (*DeleteEndpointOutput, error)
Deletes the endpoint from Amazon SNS. This action is idempotent. For more information, see Using Amazon SNS Mobile Push Notifications (http://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html).
func (*SNS) DeleteEndpointRequest ¶
func (c *SNS) DeleteEndpointRequest(input *DeleteEndpointInput) (req *request.Request, output *DeleteEndpointOutput)
DeleteEndpointRequest generates a request for the DeleteEndpoint operation.
func (*SNS) DeletePlatformApplication ¶
func (c *SNS) DeletePlatformApplication(input *DeletePlatformApplicationInput) (*DeletePlatformApplicationOutput, error)
Deletes a platform application object for one of the supported push notification services, such as APNS and GCM. For more information, see Using Amazon SNS Mobile Push Notifications (http://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html).
func (*SNS) DeletePlatformApplicationRequest ¶
func (c *SNS) DeletePlatformApplicationRequest(input *DeletePlatformApplicationInput) (req *request.Request, output *DeletePlatformApplicationOutput)
DeletePlatformApplicationRequest generates a request for the DeletePlatformApplication operation.
func (*SNS) DeleteTopic ¶
func (c *SNS) DeleteTopic(input *DeleteTopicInput) (*DeleteTopicOutput, error)
Deletes a topic and all its subscriptions. Deleting a topic might prevent some messages previously sent to the topic from being delivered to subscribers. This action is idempotent, so deleting a topic that does not exist does not result in an error.
func (*SNS) DeleteTopicRequest ¶
func (c *SNS) DeleteTopicRequest(input *DeleteTopicInput) (req *request.Request, output *DeleteTopicOutput)
DeleteTopicRequest generates a request for the DeleteTopic operation.
func (*SNS) GetEndpointAttributes ¶
func (c *SNS) GetEndpointAttributes(input *GetEndpointAttributesInput) (*GetEndpointAttributesOutput, error)
Retrieves the endpoint attributes for a device on one of the supported push notification services, such as GCM and APNS. For more information, see Using Amazon SNS Mobile Push Notifications (http://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html).
func (*SNS) GetEndpointAttributesRequest ¶
func (c *SNS) GetEndpointAttributesRequest(input *GetEndpointAttributesInput) (req *request.Request, output *GetEndpointAttributesOutput)
GetEndpointAttributesRequest generates a request for the GetEndpointAttributes operation.
func (*SNS) GetPlatformApplicationAttributes ¶
func (c *SNS) GetPlatformApplicationAttributes(input *GetPlatformApplicationAttributesInput) (*GetPlatformApplicationAttributesOutput, error)
Retrieves the attributes of the platform application object for the supported push notification services, such as APNS and GCM. For more information, see Using Amazon SNS Mobile Push Notifications (http://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html).
func (*SNS) GetPlatformApplicationAttributesRequest ¶
func (c *SNS) GetPlatformApplicationAttributesRequest(input *GetPlatformApplicationAttributesInput) (req *request.Request, output *GetPlatformApplicationAttributesOutput)
GetPlatformApplicationAttributesRequest generates a request for the GetPlatformApplicationAttributes operation.
func (*SNS) GetSubscriptionAttributes ¶
func (c *SNS) GetSubscriptionAttributes(input *GetSubscriptionAttributesInput) (*GetSubscriptionAttributesOutput, error)
Returns all of the properties of a subscription.
func (*SNS) GetSubscriptionAttributesRequest ¶
func (c *SNS) GetSubscriptionAttributesRequest(input *GetSubscriptionAttributesInput) (req *request.Request, output *GetSubscriptionAttributesOutput)
GetSubscriptionAttributesRequest generates a request for the GetSubscriptionAttributes operation.
func (*SNS) GetTopicAttributes ¶
func (c *SNS) GetTopicAttributes(input *GetTopicAttributesInput) (*GetTopicAttributesOutput, error)
Returns all of the properties of a topic. Topic properties returned might differ based on the authorization of the user.
func (*SNS) GetTopicAttributesRequest ¶
func (c *SNS) GetTopicAttributesRequest(input *GetTopicAttributesInput) (req *request.Request, output *GetTopicAttributesOutput)
GetTopicAttributesRequest generates a request for the GetTopicAttributes operation.
func (*SNS) ListEndpointsByPlatformApplication ¶
func (c *SNS) ListEndpointsByPlatformApplication(input *ListEndpointsByPlatformApplicationInput) (*ListEndpointsByPlatformApplicationOutput, error)
Lists the endpoints and endpoint attributes for devices in a supported push notification service, such as GCM and APNS. The results for ListEndpointsByPlatformApplication are paginated and return a limited list of endpoints, up to 100. If additional records are available after the first page results, then a NextToken string will be returned. To receive the next page, you call ListEndpointsByPlatformApplication again using the NextToken string received from the previous call. When there are no more records to return, NextToken will be null. For more information, see Using Amazon SNS Mobile Push Notifications (http://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html).
func (*SNS) ListEndpointsByPlatformApplicationPages ¶
func (c *SNS) ListEndpointsByPlatformApplicationPages(input *ListEndpointsByPlatformApplicationInput, fn func(p *ListEndpointsByPlatformApplicationOutput, lastPage bool) (shouldContinue bool)) error
func (*SNS) ListEndpointsByPlatformApplicationRequest ¶
func (c *SNS) ListEndpointsByPlatformApplicationRequest(input *ListEndpointsByPlatformApplicationInput) (req *request.Request, output *ListEndpointsByPlatformApplicationOutput)
ListEndpointsByPlatformApplicationRequest generates a request for the ListEndpointsByPlatformApplication operation.
func (*SNS) ListPlatformApplications ¶
func (c *SNS) ListPlatformApplications(input *ListPlatformApplicationsInput) (*ListPlatformApplicationsOutput, error)
Lists the platform application objects for the supported push notification services, such as APNS and GCM. The results for ListPlatformApplications are paginated and return a limited list of applications, up to 100. If additional records are available after the first page results, then a NextToken string will be returned. To receive the next page, you call ListPlatformApplications using the NextToken string received from the previous call. When there are no more records to return, NextToken will be null. For more information, see Using Amazon SNS Mobile Push Notifications (http://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html).
func (*SNS) ListPlatformApplicationsPages ¶
func (c *SNS) ListPlatformApplicationsPages(input *ListPlatformApplicationsInput, fn func(p *ListPlatformApplicationsOutput, lastPage bool) (shouldContinue bool)) error
func (*SNS) ListPlatformApplicationsRequest ¶
func (c *SNS) ListPlatformApplicationsRequest(input *ListPlatformApplicationsInput) (req *request.Request, output *ListPlatformApplicationsOutput)
ListPlatformApplicationsRequest generates a request for the ListPlatformApplications operation.
func (*SNS) ListSubscriptions ¶
func (c *SNS) ListSubscriptions(input *ListSubscriptionsInput) (*ListSubscriptionsOutput, error)
Returns a list of the requester's subscriptions. Each call returns a limited list of subscriptions, up to 100. If there are more subscriptions, a NextToken is also returned. Use the NextToken parameter in a new ListSubscriptions call to get further results.
func (*SNS) ListSubscriptionsByTopic ¶
func (c *SNS) ListSubscriptionsByTopic(input *ListSubscriptionsByTopicInput) (*ListSubscriptionsByTopicOutput, error)
Returns a list of the subscriptions to a specific topic. Each call returns a limited list of subscriptions, up to 100. If there are more subscriptions, a NextToken is also returned. Use the NextToken parameter in a new ListSubscriptionsByTopic call to get further results.
func (*SNS) ListSubscriptionsByTopicPages ¶
func (c *SNS) ListSubscriptionsByTopicPages(input *ListSubscriptionsByTopicInput, fn func(p *ListSubscriptionsByTopicOutput, lastPage bool) (shouldContinue bool)) error
func (*SNS) ListSubscriptionsByTopicRequest ¶
func (c *SNS) ListSubscriptionsByTopicRequest(input *ListSubscriptionsByTopicInput) (req *request.Request, output *ListSubscriptionsByTopicOutput)
ListSubscriptionsByTopicRequest generates a request for the ListSubscriptionsByTopic operation.
func (*SNS) ListSubscriptionsPages ¶
func (c *SNS) ListSubscriptionsPages(input *ListSubscriptionsInput, fn func(p *ListSubscriptionsOutput, lastPage bool) (shouldContinue bool)) error
func (*SNS) ListSubscriptionsRequest ¶
func (c *SNS) ListSubscriptionsRequest(input *ListSubscriptionsInput) (req *request.Request, output *ListSubscriptionsOutput)
ListSubscriptionsRequest generates a request for the ListSubscriptions operation.
func (*SNS) ListTopics ¶
func (c *SNS) ListTopics(input *ListTopicsInput) (*ListTopicsOutput, error)
Returns a list of the requester's topics. Each call returns a limited list of topics, up to 100. If there are more topics, a NextToken is also returned. Use the NextToken parameter in a new ListTopics call to get further results.
func (*SNS) ListTopicsPages ¶
func (c *SNS) ListTopicsPages(input *ListTopicsInput, fn func(p *ListTopicsOutput, lastPage bool) (shouldContinue bool)) error
func (*SNS) ListTopicsRequest ¶
func (c *SNS) ListTopicsRequest(input *ListTopicsInput) (req *request.Request, output *ListTopicsOutput)
ListTopicsRequest generates a request for the ListTopics operation.
func (*SNS) Publish ¶
func (c *SNS) Publish(input *PublishInput) (*PublishOutput, error)
Sends a message to all of a topic's subscribed endpoints. When a messageId is returned, the message has been saved and Amazon SNS will attempt to deliver it to the topic's subscribers shortly. The format of the outgoing message to each subscribed endpoint depends on the notification protocol selected.
To use the Publish action for sending a message to a mobile endpoint, such as an app on a Kindle device or mobile phone, you must specify the EndpointArn. The EndpointArn is returned when making a call with the CreatePlatformEndpoint action. The second example below shows a request and response for publishing to a mobile endpoint.
func (*SNS) PublishRequest ¶
func (c *SNS) PublishRequest(input *PublishInput) (req *request.Request, output *PublishOutput)
PublishRequest generates a request for the Publish operation.
func (*SNS) RemovePermission ¶
func (c *SNS) RemovePermission(input *RemovePermissionInput) (*RemovePermissionOutput, error)
Removes a statement from a topic's access control policy.
func (*SNS) RemovePermissionRequest ¶
func (c *SNS) RemovePermissionRequest(input *RemovePermissionInput) (req *request.Request, output *RemovePermissionOutput)
RemovePermissionRequest generates a request for the RemovePermission operation.
func (*SNS) SetEndpointAttributes ¶
func (c *SNS) SetEndpointAttributes(input *SetEndpointAttributesInput) (*SetEndpointAttributesOutput, error)
Sets the attributes for an endpoint for a device on one of the supported push notification services, such as GCM and APNS. For more information, see Using Amazon SNS Mobile Push Notifications (http://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html).
func (*SNS) SetEndpointAttributesRequest ¶
func (c *SNS) SetEndpointAttributesRequest(input *SetEndpointAttributesInput) (req *request.Request, output *SetEndpointAttributesOutput)
SetEndpointAttributesRequest generates a request for the SetEndpointAttributes operation.
func (*SNS) SetPlatformApplicationAttributes ¶
func (c *SNS) SetPlatformApplicationAttributes(input *SetPlatformApplicationAttributesInput) (*SetPlatformApplicationAttributesOutput, error)
Sets the attributes of the platform application object for the supported push notification services, such as APNS and GCM. For more information, see Using Amazon SNS Mobile Push Notifications (http://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html).
func (*SNS) SetPlatformApplicationAttributesRequest ¶
func (c *SNS) SetPlatformApplicationAttributesRequest(input *SetPlatformApplicationAttributesInput) (req *request.Request, output *SetPlatformApplicationAttributesOutput)
SetPlatformApplicationAttributesRequest generates a request for the SetPlatformApplicationAttributes operation.
func (*SNS) SetSubscriptionAttributes ¶
func (c *SNS) SetSubscriptionAttributes(input *SetSubscriptionAttributesInput) (*SetSubscriptionAttributesOutput, error)
Allows a subscription owner to set an attribute of the topic to a new value.
func (*SNS) SetSubscriptionAttributesRequest ¶
func (c *SNS) SetSubscriptionAttributesRequest(input *SetSubscriptionAttributesInput) (req *request.Request, output *SetSubscriptionAttributesOutput)
SetSubscriptionAttributesRequest generates a request for the SetSubscriptionAttributes operation.
func (*SNS) SetTopicAttributes ¶
func (c *SNS) SetTopicAttributes(input *SetTopicAttributesInput) (*SetTopicAttributesOutput, error)
Allows a topic owner to set an attribute of the topic to a new value.
func (*SNS) SetTopicAttributesRequest ¶
func (c *SNS) SetTopicAttributesRequest(input *SetTopicAttributesInput) (req *request.Request, output *SetTopicAttributesOutput)
SetTopicAttributesRequest generates a request for the SetTopicAttributes operation.
func (*SNS) Subscribe ¶
func (c *SNS) Subscribe(input *SubscribeInput) (*SubscribeOutput, error)
Prepares to subscribe an endpoint by sending the endpoint a confirmation message. To actually create a subscription, the endpoint owner must call the ConfirmSubscription action with the token from the confirmation message. Confirmation tokens are valid for three days.
func (*SNS) SubscribeRequest ¶
func (c *SNS) SubscribeRequest(input *SubscribeInput) (req *request.Request, output *SubscribeOutput)
SubscribeRequest generates a request for the Subscribe operation.
func (*SNS) Unsubscribe ¶
func (c *SNS) Unsubscribe(input *UnsubscribeInput) (*UnsubscribeOutput, error)
Deletes a subscription. If the subscription requires authentication for deletion, only the owner of the subscription or the topic's owner can unsubscribe, and an AWS signature is required. If the Unsubscribe call does not require authentication and the requester is not the subscription owner, a final cancellation message is delivered to the endpoint, so that the endpoint owner can easily resubscribe to the topic if the Unsubscribe request was unintended.
func (*SNS) UnsubscribeRequest ¶
func (c *SNS) UnsubscribeRequest(input *UnsubscribeInput) (req *request.Request, output *UnsubscribeOutput)
UnsubscribeRequest generates a request for the Unsubscribe operation.
type SetEndpointAttributesInput ¶
type SetEndpointAttributesInput struct { // A map of the endpoint attributes. Attributes in this map include the following: // // CustomUserData -- arbitrary user data to associate with the endpoint. // Amazon SNS does not use this data. The data must be in UTF-8 format and less // than 2KB. Enabled -- flag that enables/disables delivery to the endpoint. // Amazon SNS will set this to false when a notification service indicates to // Amazon SNS that the endpoint is invalid. Users can set it back to true, typically // after updating Token. Token -- device token, also referred to as a registration // id, for an app and mobile device. This is returned from the notification // service when an app and mobile device are registered with the notification // service. Attributes map[string]*string `type:"map" required:"true"` // EndpointArn used for SetEndpointAttributes action. EndpointArn *string `type:"string" required:"true"` // contains filtered or unexported fields }
Input for SetEndpointAttributes action.
func (SetEndpointAttributesInput) GoString ¶ added in v0.6.5
func (s SetEndpointAttributesInput) GoString() string
GoString returns the string representation
func (SetEndpointAttributesInput) String ¶ added in v0.6.5
func (s SetEndpointAttributesInput) String() string
String returns the string representation
type SetEndpointAttributesOutput ¶
type SetEndpointAttributesOutput struct {
// contains filtered or unexported fields
}
func (SetEndpointAttributesOutput) GoString ¶ added in v0.6.5
func (s SetEndpointAttributesOutput) GoString() string
GoString returns the string representation
func (SetEndpointAttributesOutput) String ¶ added in v0.6.5
func (s SetEndpointAttributesOutput) String() string
String returns the string representation
type SetPlatformApplicationAttributesInput ¶
type SetPlatformApplicationAttributesInput struct { // A map of the platform application attributes. Attributes in this map include // the following: // // PlatformCredential -- The credential received from the notification service. // For APNS/APNS_SANDBOX, PlatformCredential is "private key". For GCM, PlatformCredential // is "API key". For ADM, PlatformCredential is "client secret". PlatformPrincipal // -- The principal received from the notification service. For APNS/APNS_SANDBOX, // PlatformPrincipal is "SSL certificate". For GCM, PlatformPrincipal is not // applicable. For ADM, PlatformPrincipal is "client id". EventEndpointCreated // -- Topic ARN to which EndpointCreated event notifications should be sent. // EventEndpointDeleted -- Topic ARN to which EndpointDeleted event notifications // should be sent. EventEndpointUpdated -- Topic ARN to which EndpointUpdate // event notifications should be sent. EventDeliveryFailure -- Topic ARN to // which DeliveryFailure event notifications should be sent upon Direct Publish // delivery failure (permanent) to one of the application's endpoints. Attributes map[string]*string `type:"map" required:"true"` // PlatformApplicationArn for SetPlatformApplicationAttributes action. PlatformApplicationArn *string `type:"string" required:"true"` // contains filtered or unexported fields }
Input for SetPlatformApplicationAttributes action.
func (SetPlatformApplicationAttributesInput) GoString ¶ added in v0.6.5
func (s SetPlatformApplicationAttributesInput) GoString() string
GoString returns the string representation
func (SetPlatformApplicationAttributesInput) String ¶ added in v0.6.5
func (s SetPlatformApplicationAttributesInput) String() string
String returns the string representation
type SetPlatformApplicationAttributesOutput ¶
type SetPlatformApplicationAttributesOutput struct {
// contains filtered or unexported fields
}
func (SetPlatformApplicationAttributesOutput) GoString ¶ added in v0.6.5
func (s SetPlatformApplicationAttributesOutput) GoString() string
GoString returns the string representation
func (SetPlatformApplicationAttributesOutput) String ¶ added in v0.6.5
func (s SetPlatformApplicationAttributesOutput) String() string
String returns the string representation
type SetSubscriptionAttributesInput ¶
type SetSubscriptionAttributesInput struct { // The name of the attribute you want to set. Only a subset of the subscriptions // attributes are mutable. // // Valid values: DeliveryPolicy | RawMessageDelivery AttributeName *string `type:"string" required:"true"` // The new value for the attribute in JSON format. AttributeValue *string `type:"string"` // The ARN of the subscription to modify. SubscriptionArn *string `type:"string" required:"true"` // contains filtered or unexported fields }
Input for SetSubscriptionAttributes action.
func (SetSubscriptionAttributesInput) GoString ¶ added in v0.6.5
func (s SetSubscriptionAttributesInput) GoString() string
GoString returns the string representation
func (SetSubscriptionAttributesInput) String ¶ added in v0.6.5
func (s SetSubscriptionAttributesInput) String() string
String returns the string representation
type SetSubscriptionAttributesOutput ¶
type SetSubscriptionAttributesOutput struct {
// contains filtered or unexported fields
}
func (SetSubscriptionAttributesOutput) GoString ¶ added in v0.6.5
func (s SetSubscriptionAttributesOutput) GoString() string
GoString returns the string representation
func (SetSubscriptionAttributesOutput) String ¶ added in v0.6.5
func (s SetSubscriptionAttributesOutput) String() string
String returns the string representation
type SetTopicAttributesInput ¶
type SetTopicAttributesInput struct { // The name of the attribute you want to set. Only a subset of the topic's attributes // are mutable. // // Valid values: Policy | DisplayName | DeliveryPolicy AttributeName *string `type:"string" required:"true"` // The new value for the attribute. AttributeValue *string `type:"string"` // The ARN of the topic to modify. TopicArn *string `type:"string" required:"true"` // contains filtered or unexported fields }
Input for SetTopicAttributes action.
func (SetTopicAttributesInput) GoString ¶ added in v0.6.5
func (s SetTopicAttributesInput) GoString() string
GoString returns the string representation
func (SetTopicAttributesInput) String ¶ added in v0.6.5
func (s SetTopicAttributesInput) String() string
String returns the string representation
type SetTopicAttributesOutput ¶
type SetTopicAttributesOutput struct {
// contains filtered or unexported fields
}
func (SetTopicAttributesOutput) GoString ¶ added in v0.6.5
func (s SetTopicAttributesOutput) GoString() string
GoString returns the string representation
func (SetTopicAttributesOutput) String ¶ added in v0.6.5
func (s SetTopicAttributesOutput) String() string
String returns the string representation
type SubscribeInput ¶
type SubscribeInput struct { // The endpoint that you want to receive notifications. Endpoints vary by protocol: // // For the http protocol, the endpoint is an URL beginning with "http://" // For the https protocol, the endpoint is a URL beginning with "https://" For // the email protocol, the endpoint is an email address For the email-json protocol, // the endpoint is an email address For the sms protocol, the endpoint is a // phone number of an SMS-enabled device For the sqs protocol, the endpoint // is the ARN of an Amazon SQS queue For the application protocol, the endpoint // is the EndpointArn of a mobile app and device. Endpoint *string `type:"string"` // The protocol you want to use. Supported protocols include: // // http -- delivery of JSON-encoded message via HTTP POST https -- delivery // of JSON-encoded message via HTTPS POST email -- delivery of message via // SMTP email-json -- delivery of JSON-encoded message via SMTP sms -- delivery // of message via SMS sqs -- delivery of JSON-encoded message to an Amazon // SQS queue application -- delivery of JSON-encoded message to an EndpointArn // for a mobile app and device. Protocol *string `type:"string" required:"true"` // The ARN of the topic you want to subscribe to. TopicArn *string `type:"string" required:"true"` // contains filtered or unexported fields }
Input for Subscribe action.
func (SubscribeInput) GoString ¶ added in v0.6.5
func (s SubscribeInput) GoString() string
GoString returns the string representation
func (SubscribeInput) String ¶ added in v0.6.5
func (s SubscribeInput) String() string
String returns the string representation
type SubscribeOutput ¶
type SubscribeOutput struct { // The ARN of the subscription, if the service was able to create a subscription // immediately (without requiring endpoint owner confirmation). SubscriptionArn *string `type:"string"` // contains filtered or unexported fields }
Response for Subscribe action.
func (SubscribeOutput) GoString ¶ added in v0.6.5
func (s SubscribeOutput) GoString() string
GoString returns the string representation
func (SubscribeOutput) String ¶ added in v0.6.5
func (s SubscribeOutput) String() string
String returns the string representation
type Subscription ¶
type Subscription struct { // The subscription's endpoint (format depends on the protocol). Endpoint *string `type:"string"` // The subscription's owner. Owner *string `type:"string"` // The subscription's protocol. Protocol *string `type:"string"` // The subscription's ARN. SubscriptionArn *string `type:"string"` // The ARN of the subscription's topic. TopicArn *string `type:"string"` // contains filtered or unexported fields }
A wrapper type for the attributes of an Amazon SNS subscription.
func (Subscription) GoString ¶ added in v0.6.5
func (s Subscription) GoString() string
GoString returns the string representation
func (Subscription) String ¶ added in v0.6.5
func (s Subscription) String() string
String returns the string representation
type Topic ¶
type Topic struct { // The topic's ARN. TopicArn *string `type:"string"` // contains filtered or unexported fields }
A wrapper type for the topic's Amazon Resource Name (ARN). To retrieve a topic's attributes, use GetTopicAttributes.
type UnsubscribeInput ¶
type UnsubscribeInput struct { // The ARN of the subscription to be deleted. SubscriptionArn *string `type:"string" required:"true"` // contains filtered or unexported fields }
Input for Unsubscribe action.
func (UnsubscribeInput) GoString ¶ added in v0.6.5
func (s UnsubscribeInput) GoString() string
GoString returns the string representation
func (UnsubscribeInput) String ¶ added in v0.6.5
func (s UnsubscribeInput) String() string
String returns the string representation
type UnsubscribeOutput ¶
type UnsubscribeOutput struct {
// contains filtered or unexported fields
}
func (UnsubscribeOutput) GoString ¶ added in v0.6.5
func (s UnsubscribeOutput) GoString() string
GoString returns the string representation
func (UnsubscribeOutput) String ¶ added in v0.6.5
func (s UnsubscribeOutput) String() string
String returns the string representation