sns

package
v1.8.44 Latest Latest
Warning

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

 Go to latest Published: Jun 16, 2017 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Overview

Package sns provides the client and types for making API requests to Amazon Simple Notification Service.

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/).

See https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31 for more information on this service.

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

Using the Client

To use the client for Amazon Simple Notification Service you will first need to create a new instance of it.

When creating a client for an AWS service you'll first need to have a Session already created. The Session provides configuration that can be shared between multiple service clients. Additional configuration can be applied to the Session and service's client when they are constructed. The aws package's Config type contains several fields such as Region for the AWS Region the client should make API requests too. The optional Config value can be provided as the variadic argument for Sessions and client creation.

Once the service's client is created you can use it to make API requests the AWS service. These clients are safe to use concurrently. 

// Create a session to share configuration, and load external configuration.
sess := session.Must(session.NewSession())

// Create the service's client with the session.
svc := sns.New(sess)

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

See aws package's Config type for more information on configuration options. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the Amazon Simple Notification Service client SNS for more information on creating the service's client. https://docs.aws.amazon.com/sdk-for-go/api/service/sns/#New

Once the client is created you can make an API request to the service. Each API method takes a input parameter, and returns the service response and an error.

The API method will document which error codes the service can be returned by the operation if the service models the API operation's errors. These errors will also be available as const strings prefixed with "ErrCode". 

result, err := svc.AddPermission(params)
if err != nil {
    // Cast err to awserr.Error to handle specific error codes.
    aerr, ok := err.(awserr.Error)
    if ok && aerr.Code() == <error code to check for> {
        // Specific error code handling
    }
    return err
}

fmt.Println("AddPermission result:")
fmt.Println(result)

Using the Client with Context

The service's client also provides methods to make API requests with a Context value. This allows you to control the timeout, and cancellation of pending requests. These methods also take request Option as variadic parameter to apply additional configuration to the API request. 

ctx := context.Background()

result, err := svc.AddPermissionWithContext(ctx, params)

See the request package documentation for more information on using Context pattern with the SDK. https://docs.aws.amazon.com/sdk-for-go/api/aws/request/

Index

Constants

View Source 
const (

	// ErrCodeAuthorizationErrorException for service response error code
	// "AuthorizationError".
	//
	// Indicates that the user has been denied access to the requested resource.
	ErrCodeAuthorizationErrorException = "AuthorizationError"

	// ErrCodeEndpointDisabledException for service response error code
	// "EndpointDisabled".
	//
	// Exception error indicating endpoint disabled.
	ErrCodeEndpointDisabledException = "EndpointDisabled"

	// ErrCodeInternalErrorException for service response error code
	// "InternalError".
	//
	// Indicates an internal service error.
	ErrCodeInternalErrorException = "InternalError"

	// ErrCodeInvalidParameterException for service response error code
	// "InvalidParameter".
	//
	// Indicates that a request parameter does not comply with the associated constraints.
	ErrCodeInvalidParameterException = "InvalidParameter"

	// ErrCodeInvalidParameterValueException for service response error code
	// "ParameterValueInvalid".
	//
	// Indicates that a request parameter does not comply with the associated constraints.
	ErrCodeInvalidParameterValueException = "ParameterValueInvalid"

	// ErrCodeNotFoundException for service response error code
	// "NotFound".
	//
	// Indicates that the requested resource does not exist.
	ErrCodeNotFoundException = "NotFound"

	// ErrCodePlatformApplicationDisabledException for service response error code
	// "PlatformApplicationDisabled".
	//
	// Exception error indicating platform application disabled.
	ErrCodePlatformApplicationDisabledException = "PlatformApplicationDisabled"

	// ErrCodeSubscriptionLimitExceededException for service response error code
	// "SubscriptionLimitExceeded".
	//
	// Indicates that the customer already owns the maximum allowed number of subscriptions.
	ErrCodeSubscriptionLimitExceededException = "SubscriptionLimitExceeded"

	// ErrCodeThrottledException for service response error code
	// "Throttled".
	//
	// Indicates that the rate at which requests have been submitted for this action
	// exceeds the limit for your account.
	ErrCodeThrottledException = "Throttled"

	// ErrCodeTopicLimitExceededException for service response error code
	// "TopicLimitExceeded".
	//
	// Indicates that the customer already owns the maximum allowed number of topics.
	ErrCodeTopicLimitExceededException = "TopicLimitExceeded"
)
View Source 
const (
	ServiceName = "sns"       // Service endpoint prefix API calls made to.
	EndpointsID = ServiceName // Service ID for Regions and Endpoints metadata.
)

Service information constants

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 is a required field
	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 is a required field
	ActionName []*string `type:"list" required:"true"`

	// A unique identifier for the new policy statement.
	//
	// Label is a required field
	Label *string `type:"string" required:"true"`

	// The ARN of the topic whose access control policy you wish to modify.
	//
	// TopicArn is a required field
	TopicArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/AddPermissionInput

func (AddPermissionInput) GoString added in v0.6.5 

func (s AddPermissionInput) GoString() string

GoString returns the string representation

func (*AddPermissionInput) SetAWSAccountId added in v1.5.0 

func (s *AddPermissionInput) SetAWSAccountId(v []*string) *AddPermissionInput

SetAWSAccountId sets the AWSAccountId field's value.

func (*AddPermissionInput) SetActionName added in v1.5.0 

func (s *AddPermissionInput) SetActionName(v []*string) *AddPermissionInput

SetActionName sets the ActionName field's value.

func (*AddPermissionInput) SetLabel added in v1.5.0 

func (s *AddPermissionInput) SetLabel(v string) *AddPermissionInput

SetLabel sets the Label field's value.

func (*AddPermissionInput) SetTopicArn added in v1.5.0 

func (s *AddPermissionInput) SetTopicArn(v string) *AddPermissionInput

SetTopicArn sets the TopicArn field's value.

func (AddPermissionInput) String added in v0.6.5 

func (s AddPermissionInput) String() string

String returns the string representation

func (*AddPermissionInput) Validate added in v1.1.21 

func (s *AddPermissionInput) Validate() error

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

type AddPermissionOutput 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/AddPermissionOutput

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 CheckIfPhoneNumberIsOptedOutInput added in v1.2.1 

type CheckIfPhoneNumberIsOptedOutInput struct {

	// The phone number for which you want to check the opt out status.
	//
	// PhoneNumber is a required field
	PhoneNumber *string `locationName:"phoneNumber" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The input for the CheckIfPhoneNumberIsOptedOut action. Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/CheckIfPhoneNumberIsOptedOutInput

func (CheckIfPhoneNumberIsOptedOutInput) GoString added in v1.2.1 

func (s CheckIfPhoneNumberIsOptedOutInput) GoString() string

GoString returns the string representation

func (*CheckIfPhoneNumberIsOptedOutInput) SetPhoneNumber added in v1.5.0 

func (s *CheckIfPhoneNumberIsOptedOutInput) SetPhoneNumber(v string) *CheckIfPhoneNumberIsOptedOutInput

SetPhoneNumber sets the PhoneNumber field's value.

func (CheckIfPhoneNumberIsOptedOutInput) String added in v1.2.1 

func (s CheckIfPhoneNumberIsOptedOutInput) String() string

String returns the string representation

func (*CheckIfPhoneNumberIsOptedOutInput) Validate added in v1.2.1 

func (s *CheckIfPhoneNumberIsOptedOutInput) Validate() error

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

type CheckIfPhoneNumberIsOptedOutOutput added in v1.2.1 

type CheckIfPhoneNumberIsOptedOutOutput struct {

	// Indicates whether the phone number is opted out:
	//
	//    * true – The phone number is opted out, meaning you cannot publish SMS
	//    messages to it.
	//
	//    * false – The phone number is opted in, meaning you can publish SMS messages
	//    to it.
	IsOptedOut *bool `locationName:"isOptedOut" type:"boolean"`
	// contains filtered or unexported fields
}

The response from the CheckIfPhoneNumberIsOptedOut action. Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/CheckIfPhoneNumberIsOptedOutResponse

func (CheckIfPhoneNumberIsOptedOutOutput) GoString added in v1.2.1 

func (s CheckIfPhoneNumberIsOptedOutOutput) GoString() string

GoString returns the string representation

func (*CheckIfPhoneNumberIsOptedOutOutput) SetIsOptedOut added in v1.5.0 

func (s *CheckIfPhoneNumberIsOptedOutOutput) SetIsOptedOut(v bool) *CheckIfPhoneNumberIsOptedOutOutput

SetIsOptedOut sets the IsOptedOut field's value.

func (CheckIfPhoneNumberIsOptedOutOutput) String added in v1.2.1 

func (s CheckIfPhoneNumberIsOptedOutOutput) 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 is a required field
	Token *string `type:"string" required:"true"`

	// The ARN of the topic for which you wish to confirm a subscription.
	//
	// TopicArn is a required field
	TopicArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Input for ConfirmSubscription action. Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/ConfirmSubscriptionInput

func (ConfirmSubscriptionInput) GoString added in v0.6.5 

func (s ConfirmSubscriptionInput) GoString() string

GoString returns the string representation

func (*ConfirmSubscriptionInput) SetAuthenticateOnUnsubscribe added in v1.5.0 

func (s *ConfirmSubscriptionInput) SetAuthenticateOnUnsubscribe(v string) *ConfirmSubscriptionInput

SetAuthenticateOnUnsubscribe sets the AuthenticateOnUnsubscribe field's value.

func (*ConfirmSubscriptionInput) SetToken added in v1.5.0 

func (s *ConfirmSubscriptionInput) SetToken(v string) *ConfirmSubscriptionInput

SetToken sets the Token field's value.

func (*ConfirmSubscriptionInput) SetTopicArn added in v1.5.0 

func (s *ConfirmSubscriptionInput) SetTopicArn(v string) *ConfirmSubscriptionInput

SetTopicArn sets the TopicArn field's value.

func (ConfirmSubscriptionInput) String added in v0.6.5 

func (s ConfirmSubscriptionInput) String() string

String returns the string representation

func (*ConfirmSubscriptionInput) Validate added in v1.1.21 

func (s *ConfirmSubscriptionInput) Validate() error

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

type ConfirmSubscriptionOutput 

type ConfirmSubscriptionOutput struct {

	// The ARN of the created subscription.
	SubscriptionArn *string `type:"string"`
	// contains filtered or unexported fields
}

Response for ConfirmSubscriptions action. Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/ConfirmSubscriptionResponse

func (ConfirmSubscriptionOutput) GoString added in v0.6.5 

func (s ConfirmSubscriptionOutput) GoString() string

GoString returns the string representation

func (*ConfirmSubscriptionOutput) SetSubscriptionArn added in v1.5.0 

func (s *ConfirmSubscriptionOutput) SetSubscriptionArn(v string) *ConfirmSubscriptionOutput

SetSubscriptionArn sets the SubscriptionArn field's value.

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 is a required field
	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 is a required field
	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 is a required field
	Platform *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Input for CreatePlatformApplication action. Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/CreatePlatformApplicationInput

func (CreatePlatformApplicationInput) GoString added in v0.6.5 

func (s CreatePlatformApplicationInput) GoString() string

GoString returns the string representation

func (*CreatePlatformApplicationInput) SetAttributes added in v1.5.0 

func (s *CreatePlatformApplicationInput) SetAttributes(v map[string]*string) *CreatePlatformApplicationInput

SetAttributes sets the Attributes field's value.

func (*CreatePlatformApplicationInput) SetName added in v1.5.0 

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

SetName sets the Name field's value.

func (*CreatePlatformApplicationInput) SetPlatform added in v1.5.0 

func (s *CreatePlatformApplicationInput) SetPlatform(v string) *CreatePlatformApplicationInput

SetPlatform sets the Platform field's value.

func (CreatePlatformApplicationInput) String added in v0.6.5 

func (s CreatePlatformApplicationInput) String() string

String returns the string representation

func (*CreatePlatformApplicationInput) Validate added in v1.1.21 

func (s *CreatePlatformApplicationInput) Validate() error

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

type CreatePlatformApplicationOutput 

type CreatePlatformApplicationOutput struct {

	// PlatformApplicationArn is returned.
	PlatformApplicationArn *string `type:"string"`
	// contains filtered or unexported fields
}

Response from CreatePlatformApplication action. Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/CreatePlatformApplicationResponse

func (CreatePlatformApplicationOutput) GoString added in v0.6.5 

func (s CreatePlatformApplicationOutput) GoString() string

GoString returns the string representation

func (*CreatePlatformApplicationOutput) SetPlatformApplicationArn added in v1.5.0 

func (s *CreatePlatformApplicationOutput) SetPlatformApplicationArn(v string) *CreatePlatformApplicationOutput

SetPlatformApplicationArn sets the PlatformApplicationArn field's value.

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 is a required field
	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 is a required field
	Token *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Input for CreatePlatformEndpoint action. Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/CreatePlatformEndpointInput

func (CreatePlatformEndpointInput) GoString added in v0.6.5 

func (s CreatePlatformEndpointInput) GoString() string

GoString returns the string representation

func (*CreatePlatformEndpointInput) SetAttributes added in v1.5.0 

func (s *CreatePlatformEndpointInput) SetAttributes(v map[string]*string) *CreatePlatformEndpointInput

SetAttributes sets the Attributes field's value.

func (*CreatePlatformEndpointInput) SetCustomUserData added in v1.5.0 

func (s *CreatePlatformEndpointInput) SetCustomUserData(v string) *CreatePlatformEndpointInput

SetCustomUserData sets the CustomUserData field's value.

func (*CreatePlatformEndpointInput) SetPlatformApplicationArn added in v1.5.0 

func (s *CreatePlatformEndpointInput) SetPlatformApplicationArn(v string) *CreatePlatformEndpointInput

SetPlatformApplicationArn sets the PlatformApplicationArn field's value.

func (*CreatePlatformEndpointInput) SetToken added in v1.5.0 

func (s *CreatePlatformEndpointInput) SetToken(v string) *CreatePlatformEndpointInput

SetToken sets the Token field's value.

func (CreatePlatformEndpointInput) String added in v0.6.5 

func (s CreatePlatformEndpointInput) String() string

String returns the string representation

func (*CreatePlatformEndpointInput) Validate added in v1.1.21 

func (s *CreatePlatformEndpointInput) Validate() error

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

type CreatePlatformEndpointOutput 

type CreatePlatformEndpointOutput struct {

	// EndpointArn returned from CreateEndpoint action.
	EndpointArn *string `type:"string"`
	// contains filtered or unexported fields
}

Response from CreateEndpoint action. Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/CreateEndpointResponse

func (CreatePlatformEndpointOutput) GoString added in v0.6.5 

func (s CreatePlatformEndpointOutput) GoString() string

GoString returns the string representation

func (*CreatePlatformEndpointOutput) SetEndpointArn added in v1.5.0 

func (s *CreatePlatformEndpointOutput) SetEndpointArn(v string) *CreatePlatformEndpointOutput

SetEndpointArn sets the EndpointArn field's value.

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 is a required field
	Name *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Input for CreateTopic action. Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/CreateTopicInput

func (CreateTopicInput) GoString added in v0.6.5 

func (s CreateTopicInput) GoString() string

GoString returns the string representation

func (*CreateTopicInput) SetName added in v1.5.0 

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

SetName sets the Name field's value.

func (CreateTopicInput) String added in v0.6.5 

func (s CreateTopicInput) String() string

String returns the string representation

func (*CreateTopicInput) Validate added in v1.1.21 

func (s *CreateTopicInput) Validate() error

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

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/CreateTopicResponse

func (CreateTopicOutput) GoString added in v0.6.5 

func (s CreateTopicOutput) GoString() string

GoString returns the string representation

func (*CreateTopicOutput) SetTopicArn added in v1.5.0 

func (s *CreateTopicOutput) SetTopicArn(v string) *CreateTopicOutput

SetTopicArn sets the TopicArn field's value.

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 is a required field
	EndpointArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Input for DeleteEndpoint action. Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/DeleteEndpointInput

func (DeleteEndpointInput) GoString added in v0.6.5 

func (s DeleteEndpointInput) GoString() string

GoString returns the string representation

func (*DeleteEndpointInput) SetEndpointArn added in v1.5.0 

func (s *DeleteEndpointInput) SetEndpointArn(v string) *DeleteEndpointInput

SetEndpointArn sets the EndpointArn field's value.

func (DeleteEndpointInput) String added in v0.6.5 

func (s DeleteEndpointInput) String() string

String returns the string representation

func (*DeleteEndpointInput) Validate added in v1.1.21 

func (s *DeleteEndpointInput) Validate() error

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

type DeleteEndpointOutput 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/DeleteEndpointOutput

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 is a required field
	PlatformApplicationArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Input for DeletePlatformApplication action. Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/DeletePlatformApplicationInput

func (DeletePlatformApplicationInput) GoString added in v0.6.5 

func (s DeletePlatformApplicationInput) GoString() string

GoString returns the string representation

func (*DeletePlatformApplicationInput) SetPlatformApplicationArn added in v1.5.0 

func (s *DeletePlatformApplicationInput) SetPlatformApplicationArn(v string) *DeletePlatformApplicationInput

SetPlatformApplicationArn sets the PlatformApplicationArn field's value.

func (DeletePlatformApplicationInput) String added in v0.6.5 

func (s DeletePlatformApplicationInput) String() string

String returns the string representation

func (*DeletePlatformApplicationInput) Validate added in v1.1.21 

func (s *DeletePlatformApplicationInput) Validate() error

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

type DeletePlatformApplicationOutput 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/DeletePlatformApplicationOutput

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 is a required field
	TopicArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/DeleteTopicInput

func (DeleteTopicInput) GoString added in v0.6.5 

func (s DeleteTopicInput) GoString() string

GoString returns the string representation

func (*DeleteTopicInput) SetTopicArn added in v1.5.0 

func (s *DeleteTopicInput) SetTopicArn(v string) *DeleteTopicInput

SetTopicArn sets the TopicArn field's value.

func (DeleteTopicInput) String added in v0.6.5 

func (s DeleteTopicInput) String() string

String returns the string representation

func (*DeleteTopicInput) Validate added in v1.1.21 

func (s *DeleteTopicInput) Validate() error

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

type DeleteTopicOutput 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/DeleteTopicOutput

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/Endpoint

func (Endpoint) GoString added in v0.6.5 

func (s Endpoint) GoString() string

GoString returns the string representation

func (*Endpoint) SetAttributes added in v1.5.0 

func (s *Endpoint) SetAttributes(v map[string]*string) *Endpoint

SetAttributes sets the Attributes field's value.

func (*Endpoint) SetEndpointArn added in v1.5.0 

func (s *Endpoint) SetEndpointArn(v string) *Endpoint

SetEndpointArn sets the EndpointArn field's value.

func (Endpoint) String added in v0.6.5 

func (s Endpoint) String() string

String returns the string representation

type GetEndpointAttributesInput 

type GetEndpointAttributesInput struct {

	// EndpointArn for GetEndpointAttributes input.
	//
	// EndpointArn is a required field
	EndpointArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Input for GetEndpointAttributes action. Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/GetEndpointAttributesInput

func (GetEndpointAttributesInput) GoString added in v0.6.5 

func (s GetEndpointAttributesInput) GoString() string

GoString returns the string representation

func (*GetEndpointAttributesInput) SetEndpointArn added in v1.5.0 

func (s *GetEndpointAttributesInput) SetEndpointArn(v string) *GetEndpointAttributesInput

SetEndpointArn sets the EndpointArn field's value.

func (GetEndpointAttributesInput) String added in v0.6.5 

func (s GetEndpointAttributesInput) String() string

String returns the string representation

func (*GetEndpointAttributesInput) Validate added in v1.1.21 

func (s *GetEndpointAttributesInput) Validate() error

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

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/GetEndpointAttributesResponse

func (GetEndpointAttributesOutput) GoString added in v0.6.5 

func (s GetEndpointAttributesOutput) GoString() string

GoString returns the string representation

func (*GetEndpointAttributesOutput) SetAttributes added in v1.5.0 

func (s *GetEndpointAttributesOutput) SetAttributes(v map[string]*string) *GetEndpointAttributesOutput

SetAttributes sets the Attributes field's value.

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 is a required field
	PlatformApplicationArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Input for GetPlatformApplicationAttributes action. Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/GetPlatformApplicationAttributesInput

func (GetPlatformApplicationAttributesInput) GoString added in v0.6.5 

func (s GetPlatformApplicationAttributesInput) GoString() string

GoString returns the string representation

func (*GetPlatformApplicationAttributesInput) SetPlatformApplicationArn added in v1.5.0 

func (s *GetPlatformApplicationAttributesInput) SetPlatformApplicationArn(v string) *GetPlatformApplicationAttributesInput

SetPlatformApplicationArn sets the PlatformApplicationArn field's value.

func (GetPlatformApplicationAttributesInput) String added in v0.6.5 

func (s GetPlatformApplicationAttributesInput) String() string

String returns the string representation

func (*GetPlatformApplicationAttributesInput) Validate added in v1.1.21 

func (s *GetPlatformApplicationAttributesInput) Validate() error

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

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/GetPlatformApplicationAttributesResponse

func (GetPlatformApplicationAttributesOutput) GoString added in v0.6.5 

func (s GetPlatformApplicationAttributesOutput) GoString() string

GoString returns the string representation

func (*GetPlatformApplicationAttributesOutput) SetAttributes added in v1.5.0 

func (s *GetPlatformApplicationAttributesOutput) SetAttributes(v map[string]*string) *GetPlatformApplicationAttributesOutput

SetAttributes sets the Attributes field's value.

func (GetPlatformApplicationAttributesOutput) String added in v0.6.5 

func (s GetPlatformApplicationAttributesOutput) String() string

String returns the string representation

type GetSMSAttributesInput added in v1.2.1 

type GetSMSAttributesInput struct {

	// A list of the individual attribute names, such as MonthlySpendLimit, for
	// which you want values.
	//
	// For all attribute names, see SetSMSAttributes (http://docs.aws.amazon.com/sns/latest/api/API_SetSMSAttributes.html).
	//
	// If you don't use this parameter, Amazon SNS returns all SMS attributes.
	Attributes []*string `locationName:"attributes" type:"list"`
	// contains filtered or unexported fields
}

The input for the GetSMSAttributes request. Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/GetSMSAttributesInput

func (GetSMSAttributesInput) GoString added in v1.2.1 

func (s GetSMSAttributesInput) GoString() string

GoString returns the string representation

func (*GetSMSAttributesInput) SetAttributes added in v1.5.0 

func (s *GetSMSAttributesInput) SetAttributes(v []*string) *GetSMSAttributesInput

SetAttributes sets the Attributes field's value.

func (GetSMSAttributesInput) String added in v1.2.1 

func (s GetSMSAttributesInput) String() string

String returns the string representation

type GetSMSAttributesOutput added in v1.2.1 

type GetSMSAttributesOutput struct {

	// The SMS attribute names and their values.
	Attributes map[string]*string `locationName:"attributes" type:"map"`
	// contains filtered or unexported fields
}

The response from the GetSMSAttributes request. Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/GetSMSAttributesResponse

func (GetSMSAttributesOutput) GoString added in v1.2.1 

func (s GetSMSAttributesOutput) GoString() string

GoString returns the string representation

func (*GetSMSAttributesOutput) SetAttributes added in v1.5.0 

func (s *GetSMSAttributesOutput) SetAttributes(v map[string]*string) *GetSMSAttributesOutput

SetAttributes sets the Attributes field's value.

func (GetSMSAttributesOutput) String added in v1.2.1 

func (s GetSMSAttributesOutput) String() string

String returns the string representation

type GetSubscriptionAttributesInput 

type GetSubscriptionAttributesInput struct {

	// The ARN of the subscription whose properties you want to get.
	//
	// SubscriptionArn is a required field
	SubscriptionArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Input for GetSubscriptionAttributes. Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/GetSubscriptionAttributesInput

func (GetSubscriptionAttributesInput) GoString added in v0.6.5 

func (s GetSubscriptionAttributesInput) GoString() string

GoString returns the string representation

func (*GetSubscriptionAttributesInput) SetSubscriptionArn added in v1.5.0 

func (s *GetSubscriptionAttributesInput) SetSubscriptionArn(v string) *GetSubscriptionAttributesInput

SetSubscriptionArn sets the SubscriptionArn field's value.

func (GetSubscriptionAttributesInput) String added in v0.6.5 

func (s GetSubscriptionAttributesInput) String() string

String returns the string representation

func (*GetSubscriptionAttributesInput) Validate added in v1.1.21 

func (s *GetSubscriptionAttributesInput) Validate() error

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

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/GetSubscriptionAttributesResponse

func (GetSubscriptionAttributesOutput) GoString added in v0.6.5 

func (s GetSubscriptionAttributesOutput) GoString() string

GoString returns the string representation

func (*GetSubscriptionAttributesOutput) SetAttributes added in v1.5.0 

func (s *GetSubscriptionAttributesOutput) SetAttributes(v map[string]*string) *GetSubscriptionAttributesOutput

SetAttributes sets the Attributes field's value.

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 is a required field
	TopicArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Input for GetTopicAttributes action. Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/GetTopicAttributesInput

func (GetTopicAttributesInput) GoString added in v0.6.5 

func (s GetTopicAttributesInput) GoString() string

GoString returns the string representation

func (*GetTopicAttributesInput) SetTopicArn added in v1.5.0 

func (s *GetTopicAttributesInput) SetTopicArn(v string) *GetTopicAttributesInput

SetTopicArn sets the TopicArn field's value.

func (GetTopicAttributesInput) String added in v0.6.5 

func (s GetTopicAttributesInput) String() string

String returns the string representation

func (*GetTopicAttributesInput) Validate added in v1.1.21 

func (s *GetTopicAttributesInput) Validate() error

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

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/GetTopicAttributesResponse

func (GetTopicAttributesOutput) GoString added in v0.6.5 

func (s GetTopicAttributesOutput) GoString() string

GoString returns the string representation

func (*GetTopicAttributesOutput) SetAttributes added in v1.5.0 

func (s *GetTopicAttributesOutput) SetAttributes(v map[string]*string) *GetTopicAttributesOutput

SetAttributes sets the Attributes field's value.

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 is a required field
	PlatformApplicationArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Input for ListEndpointsByPlatformApplication action. Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/ListEndpointsByPlatformApplicationInput

func (ListEndpointsByPlatformApplicationInput) GoString added in v0.6.5 

func (s ListEndpointsByPlatformApplicationInput) GoString() string

GoString returns the string representation

func (*ListEndpointsByPlatformApplicationInput) SetNextToken added in v1.5.0 

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

SetNextToken sets the NextToken field's value.

func (*ListEndpointsByPlatformApplicationInput) SetPlatformApplicationArn added in v1.5.0 

func (s *ListEndpointsByPlatformApplicationInput) SetPlatformApplicationArn(v string) *ListEndpointsByPlatformApplicationInput

SetPlatformApplicationArn sets the PlatformApplicationArn field's value.

func (ListEndpointsByPlatformApplicationInput) String added in v0.6.5 

func (s ListEndpointsByPlatformApplicationInput) String() string

String returns the string representation

func (*ListEndpointsByPlatformApplicationInput) Validate added in v1.1.21 

func (s *ListEndpointsByPlatformApplicationInput) Validate() error

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

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/ListEndpointsByPlatformApplicationResponse

func (ListEndpointsByPlatformApplicationOutput) GoString added in v0.6.5 

func (s ListEndpointsByPlatformApplicationOutput) GoString() string

GoString returns the string representation

func (*ListEndpointsByPlatformApplicationOutput) SetEndpoints added in v1.5.0 

func (s *ListEndpointsByPlatformApplicationOutput) SetEndpoints(v []*Endpoint) *ListEndpointsByPlatformApplicationOutput

SetEndpoints sets the Endpoints field's value.

func (*ListEndpointsByPlatformApplicationOutput) SetNextToken added in v1.5.0 

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

SetNextToken sets the NextToken field's value.

func (ListEndpointsByPlatformApplicationOutput) String added in v0.6.5 

func (s ListEndpointsByPlatformApplicationOutput) String() string

String returns the string representation

type ListPhoneNumbersOptedOutInput added in v1.2.1 

type ListPhoneNumbersOptedOutInput struct {

	// A NextToken string is used when you call the ListPhoneNumbersOptedOut action
	// to retrieve additional records that are available after the first page of
	// results.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

The input for the ListPhoneNumbersOptedOut action. Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/ListPhoneNumbersOptedOutInput

func (ListPhoneNumbersOptedOutInput) GoString added in v1.2.1 

func (s ListPhoneNumbersOptedOutInput) GoString() string

GoString returns the string representation

func (*ListPhoneNumbersOptedOutInput) SetNextToken added in v1.5.0 

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

SetNextToken sets the NextToken field's value.

func (ListPhoneNumbersOptedOutInput) String added in v1.2.1 

func (s ListPhoneNumbersOptedOutInput) String() string

String returns the string representation

type ListPhoneNumbersOptedOutOutput added in v1.2.1 

type ListPhoneNumbersOptedOutOutput struct {

	// A NextToken string is returned when you call the ListPhoneNumbersOptedOut
	// action if additional records are available after the first page of results.
	NextToken *string `locationName:"nextToken" type:"string"`

	// A list of phone numbers that are opted out of receiving SMS messages. The
	// list is paginated, and each page can contain up to 100 phone numbers.
	PhoneNumbers []*string `locationName:"phoneNumbers" type:"list"`
	// contains filtered or unexported fields
}

The response from the ListPhoneNumbersOptedOut action. Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/ListPhoneNumbersOptedOutResponse

func (ListPhoneNumbersOptedOutOutput) GoString added in v1.2.1 

func (s ListPhoneNumbersOptedOutOutput) GoString() string

GoString returns the string representation

func (*ListPhoneNumbersOptedOutOutput) SetNextToken added in v1.5.0 

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

SetNextToken sets the NextToken field's value.

func (*ListPhoneNumbersOptedOutOutput) SetPhoneNumbers added in v1.5.0 

func (s *ListPhoneNumbersOptedOutOutput) SetPhoneNumbers(v []*string) *ListPhoneNumbersOptedOutOutput

SetPhoneNumbers sets the PhoneNumbers field's value.

func (ListPhoneNumbersOptedOutOutput) String added in v1.2.1 

func (s ListPhoneNumbersOptedOutOutput) 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/ListPlatformApplicationsInput

func (ListPlatformApplicationsInput) GoString added in v0.6.5 

func (s ListPlatformApplicationsInput) GoString() string

GoString returns the string representation

func (*ListPlatformApplicationsInput) SetNextToken added in v1.5.0 

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

SetNextToken sets the NextToken field's value.

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/ListPlatformApplicationsResponse

func (ListPlatformApplicationsOutput) GoString added in v0.6.5 

func (s ListPlatformApplicationsOutput) GoString() string

GoString returns the string representation

func (*ListPlatformApplicationsOutput) SetNextToken added in v1.5.0 

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

SetNextToken sets the NextToken field's value.

func (*ListPlatformApplicationsOutput) SetPlatformApplications added in v1.5.0 

func (s *ListPlatformApplicationsOutput) SetPlatformApplications(v []*PlatformApplication) *ListPlatformApplicationsOutput

SetPlatformApplications sets the PlatformApplications field's value.

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 is a required field
	TopicArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Input for ListSubscriptionsByTopic action. Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/ListSubscriptionsByTopicInput

func (ListSubscriptionsByTopicInput) GoString added in v0.6.5 

func (s ListSubscriptionsByTopicInput) GoString() string

GoString returns the string representation

func (*ListSubscriptionsByTopicInput) SetNextToken added in v1.5.0 

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

SetNextToken sets the NextToken field's value.

func (*ListSubscriptionsByTopicInput) SetTopicArn added in v1.5.0 

func (s *ListSubscriptionsByTopicInput) SetTopicArn(v string) *ListSubscriptionsByTopicInput

SetTopicArn sets the TopicArn field's value.

func (ListSubscriptionsByTopicInput) String added in v0.6.5 

func (s ListSubscriptionsByTopicInput) String() string

String returns the string representation

func (*ListSubscriptionsByTopicInput) Validate added in v1.1.21 

func (s *ListSubscriptionsByTopicInput) Validate() error

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

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/ListSubscriptionsByTopicResponse

func (ListSubscriptionsByTopicOutput) GoString added in v0.6.5 

func (s ListSubscriptionsByTopicOutput) GoString() string

GoString returns the string representation

func (*ListSubscriptionsByTopicOutput) SetNextToken added in v1.5.0 

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

SetNextToken sets the NextToken field's value.

func (*ListSubscriptionsByTopicOutput) SetSubscriptions added in v1.5.0 

func (s *ListSubscriptionsByTopicOutput) SetSubscriptions(v []*Subscription) *ListSubscriptionsByTopicOutput

SetSubscriptions sets the Subscriptions field's value.

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/ListSubscriptionsInput

func (ListSubscriptionsInput) GoString added in v0.6.5 

func (s ListSubscriptionsInput) GoString() string

GoString returns the string representation

func (*ListSubscriptionsInput) SetNextToken added in v1.5.0 

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

SetNextToken sets the NextToken field's value.

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 Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/ListSubscriptionsResponse

func (ListSubscriptionsOutput) GoString added in v0.6.5 

func (s ListSubscriptionsOutput) GoString() string

GoString returns the string representation

func (*ListSubscriptionsOutput) SetNextToken added in v1.5.0 

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

SetNextToken sets the NextToken field's value.

func (*ListSubscriptionsOutput) SetSubscriptions added in v1.5.0 

func (s *ListSubscriptionsOutput) SetSubscriptions(v []*Subscription) *ListSubscriptionsOutput

SetSubscriptions sets the Subscriptions field's value.

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/ListTopicsInput

func (ListTopicsInput) GoString added in v0.6.5 

func (s ListTopicsInput) GoString() string

GoString returns the string representation

func (*ListTopicsInput) SetNextToken added in v1.5.0 

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

SetNextToken sets the NextToken field's value.

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/ListTopicsResponse

func (ListTopicsOutput) GoString added in v0.6.5 

func (s ListTopicsOutput) GoString() string

GoString returns the string representation

func (*ListTopicsOutput) SetNextToken added in v1.5.0 

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

SetNextToken sets the NextToken field's value.

func (*ListTopicsOutput) SetTopics added in v1.5.0 

func (s *ListTopicsOutput) SetTopics(v []*Topic) *ListTopicsOutput

SetTopics sets the Topics field's value.

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 is a required field
	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). Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/MessageAttributeValue

func (MessageAttributeValue) GoString added in v0.6.5 

func (s MessageAttributeValue) GoString() string

GoString returns the string representation

func (*MessageAttributeValue) SetBinaryValue added in v1.5.0 

func (s *MessageAttributeValue) SetBinaryValue(v []byte) *MessageAttributeValue

SetBinaryValue sets the BinaryValue field's value.

func (*MessageAttributeValue) SetDataType added in v1.5.0 

func (s *MessageAttributeValue) SetDataType(v string) *MessageAttributeValue

SetDataType sets the DataType field's value.

func (*MessageAttributeValue) SetStringValue added in v1.5.0 

func (s *MessageAttributeValue) SetStringValue(v string) *MessageAttributeValue

SetStringValue sets the StringValue field's value.

func (MessageAttributeValue) String added in v0.6.5 

func (s MessageAttributeValue) String() string

String returns the string representation

func (*MessageAttributeValue) Validate added in v1.1.21 

func (s *MessageAttributeValue) Validate() error

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

type OptInPhoneNumberInput added in v1.2.1 

type OptInPhoneNumberInput struct {

	// The phone number to opt in.
	//
	// PhoneNumber is a required field
	PhoneNumber *string `locationName:"phoneNumber" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Input for the OptInPhoneNumber action. Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/OptInPhoneNumberInput

func (OptInPhoneNumberInput) GoString added in v1.2.1 

func (s OptInPhoneNumberInput) GoString() string

GoString returns the string representation

func (*OptInPhoneNumberInput) SetPhoneNumber added in v1.5.0 

func (s *OptInPhoneNumberInput) SetPhoneNumber(v string) *OptInPhoneNumberInput

SetPhoneNumber sets the PhoneNumber field's value.

func (OptInPhoneNumberInput) String added in v1.2.1 

func (s OptInPhoneNumberInput) String() string

String returns the string representation

func (*OptInPhoneNumberInput) Validate added in v1.2.1 

func (s *OptInPhoneNumberInput) Validate() error

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

type OptInPhoneNumberOutput added in v1.2.1 

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

The response for the OptInPhoneNumber action. Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/OptInPhoneNumberResponse

func (OptInPhoneNumberOutput) GoString added in v1.2.1 

func (s OptInPhoneNumberOutput) GoString() string

GoString returns the string representation

func (OptInPhoneNumberOutput) String added in v1.2.1 

func (s OptInPhoneNumberOutput) 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/PlatformApplication

func (PlatformApplication) GoString added in v0.6.5 

func (s PlatformApplication) GoString() string

GoString returns the string representation

func (*PlatformApplication) SetAttributes added in v1.5.0 

func (s *PlatformApplication) SetAttributes(v map[string]*string) *PlatformApplication

SetAttributes sets the Attributes field's value.

func (*PlatformApplication) SetPlatformApplicationArn added in v1.5.0 

func (s *PlatformApplication) SetPlatformApplicationArn(v string) *PlatformApplication

SetPlatformApplicationArn sets the PlatformApplicationArn field's value.

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.
	//
	// 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 is a required field
	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"`

	// The phone number to which you want to deliver an SMS message. Use E.164 format.
	//
	// If you don't specify a value for the PhoneNumber parameter, you must specify
	// a value for the TargetArn or TopicArn parameters.
	PhoneNumber *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.
	//
	// If you don't specify a value for the TargetArn parameter, you must specify
	// a value for the PhoneNumber or TopicArn parameters.
	TargetArn *string `type:"string"`

	// The topic you want to publish to.
	//
	// If you don't specify a value for the TopicArn parameter, you must specify
	// a value for the PhoneNumber or TargetArn parameters.
	TopicArn *string `type:"string"`
	// contains filtered or unexported fields
}

Input for Publish action. Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/PublishInput

func (PublishInput) GoString added in v0.6.5 

func (s PublishInput) GoString() string

GoString returns the string representation

func (*PublishInput) SetMessage added in v1.5.0 

func (s *PublishInput) SetMessage(v string) *PublishInput

SetMessage sets the Message field's value.

func (*PublishInput) SetMessageAttributes added in v1.5.0 

func (s *PublishInput) SetMessageAttributes(v map[string]*MessageAttributeValue) *PublishInput

SetMessageAttributes sets the MessageAttributes field's value.

func (*PublishInput) SetMessageStructure added in v1.5.0 

func (s *PublishInput) SetMessageStructure(v string) *PublishInput

SetMessageStructure sets the MessageStructure field's value.

func (*PublishInput) SetPhoneNumber added in v1.5.0 

func (s *PublishInput) SetPhoneNumber(v string) *PublishInput

SetPhoneNumber sets the PhoneNumber field's value.

func (*PublishInput) SetSubject added in v1.5.0 

func (s *PublishInput) SetSubject(v string) *PublishInput

SetSubject sets the Subject field's value.

func (*PublishInput) SetTargetArn added in v1.5.0 

func (s *PublishInput) SetTargetArn(v string) *PublishInput

SetTargetArn sets the TargetArn field's value.

func (*PublishInput) SetTopicArn added in v1.5.0 

func (s *PublishInput) SetTopicArn(v string) *PublishInput

SetTopicArn sets the TopicArn field's value.

func (PublishInput) String added in v0.6.5 

func (s PublishInput) String() string

String returns the string representation

func (*PublishInput) Validate added in v1.1.21 

func (s *PublishInput) Validate() error

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

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/PublishResponse

func (PublishOutput) GoString added in v0.6.5 

func (s PublishOutput) GoString() string

GoString returns the string representation

func (*PublishOutput) SetMessageId added in v1.5.0 

func (s *PublishOutput) SetMessageId(v string) *PublishOutput

SetMessageId sets the MessageId field's value.

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 is a required field
	Label *string `type:"string" required:"true"`

	// The ARN of the topic whose access control policy you wish to modify.
	//
	// TopicArn is a required field
	TopicArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Input for RemovePermission action. Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/RemovePermissionInput

func (RemovePermissionInput) GoString added in v0.6.5 

func (s RemovePermissionInput) GoString() string

GoString returns the string representation

func (*RemovePermissionInput) SetLabel added in v1.5.0 

func (s *RemovePermissionInput) SetLabel(v string) *RemovePermissionInput

SetLabel sets the Label field's value.

func (*RemovePermissionInput) SetTopicArn added in v1.5.0 

func (s *RemovePermissionInput) SetTopicArn(v string) *RemovePermissionInput

SetTopicArn sets the TopicArn field's value.

func (RemovePermissionInput) String added in v0.6.5 

func (s RemovePermissionInput) String() string

String returns the string representation

func (*RemovePermissionInput) Validate added in v1.1.21 

func (s *RemovePermissionInput) Validate() error

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

type RemovePermissionOutput 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/RemovePermissionOutput

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 

type SNS struct {
	*client.Client
}

SNS provides the API operation methods for making requests to Amazon Simple Notification Service. See this package's package overview docs for details on the service.

SNS methods are safe to use concurrently. It is not safe to modify mutate any of the struct'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)

AddPermission API operation for Amazon Simple Notification Service.

Adds a statement to a topic's access control policy, granting access for the specified AWS accounts to the specified actions.

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 Simple Notification Service's API operation AddPermission for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterException "InvalidParameter" Indicates that a request parameter does not comply with the associated constraints.

  • ErrCodeInternalErrorException "InternalError" Indicates an internal service error.

  • ErrCodeAuthorizationErrorException "AuthorizationError" Indicates that the user has been denied access to the requested resource.

  • ErrCodeNotFoundException "NotFound" Indicates that the requested resource does not exist.

Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/AddPermission

func (*SNS) AddPermissionRequest 

func (c *SNS) AddPermissionRequest(input *AddPermissionInput) (req *request.Request, output *AddPermissionOutput)

AddPermissionRequest generates a "aws/request.Request" representing the client's request for the AddPermission operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See AddPermission for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the AddPermission method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

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

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/AddPermission

func (*SNS) AddPermissionWithContext added in v1.8.0 

func (c *SNS) AddPermissionWithContext(ctx aws.Context, input *AddPermissionInput, opts ...request.Option) (*AddPermissionOutput, error)

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

See AddPermission 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 (*SNS) CheckIfPhoneNumberIsOptedOut added in v1.2.1 

func (c *SNS) CheckIfPhoneNumberIsOptedOut(input *CheckIfPhoneNumberIsOptedOutInput) (*CheckIfPhoneNumberIsOptedOutOutput, error)

CheckIfPhoneNumberIsOptedOut API operation for Amazon Simple Notification Service.

Accepts a phone number and indicates whether the phone holder has opted out of receiving SMS messages from your account. You cannot send SMS messages to a number that is opted out.

To resume sending messages, you can opt in the number by using the OptInPhoneNumber action.

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 Simple Notification Service's API operation CheckIfPhoneNumberIsOptedOut for usage and error information.

Returned Error Codes:

  • ErrCodeThrottledException "Throttled" Indicates that the rate at which requests have been submitted for this action exceeds the limit for your account.

  • ErrCodeInternalErrorException "InternalError" Indicates an internal service error.

  • ErrCodeAuthorizationErrorException "AuthorizationError" Indicates that the user has been denied access to the requested resource.

  • ErrCodeInvalidParameterException "InvalidParameter" Indicates that a request parameter does not comply with the associated constraints.

Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/CheckIfPhoneNumberIsOptedOut

func (*SNS) CheckIfPhoneNumberIsOptedOutRequest added in v1.2.1 

func (c *SNS) CheckIfPhoneNumberIsOptedOutRequest(input *CheckIfPhoneNumberIsOptedOutInput) (req *request.Request, output *CheckIfPhoneNumberIsOptedOutOutput)

CheckIfPhoneNumberIsOptedOutRequest generates a "aws/request.Request" representing the client's request for the CheckIfPhoneNumberIsOptedOut operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See CheckIfPhoneNumberIsOptedOut for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CheckIfPhoneNumberIsOptedOut method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

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

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/CheckIfPhoneNumberIsOptedOut

func (*SNS) CheckIfPhoneNumberIsOptedOutWithContext added in v1.8.0 

func (c *SNS) CheckIfPhoneNumberIsOptedOutWithContext(ctx aws.Context, input *CheckIfPhoneNumberIsOptedOutInput, opts ...request.Option) (*CheckIfPhoneNumberIsOptedOutOutput, error)

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

See CheckIfPhoneNumberIsOptedOut 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 (*SNS) ConfirmSubscription 

func (c *SNS) ConfirmSubscription(input *ConfirmSubscriptionInput) (*ConfirmSubscriptionOutput, error)

ConfirmSubscription API operation for Amazon Simple Notification Service.

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".

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 Simple Notification Service's API operation ConfirmSubscription for usage and error information.

Returned Error Codes:

  • ErrCodeSubscriptionLimitExceededException "SubscriptionLimitExceeded" Indicates that the customer already owns the maximum allowed number of subscriptions.

  • ErrCodeInvalidParameterException "InvalidParameter" Indicates that a request parameter does not comply with the associated constraints.

  • ErrCodeNotFoundException "NotFound" Indicates that the requested resource does not exist.

  • ErrCodeInternalErrorException "InternalError" Indicates an internal service error.

  • ErrCodeAuthorizationErrorException "AuthorizationError" Indicates that the user has been denied access to the requested resource.

Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/ConfirmSubscription

func (*SNS) ConfirmSubscriptionRequest 

func (c *SNS) ConfirmSubscriptionRequest(input *ConfirmSubscriptionInput) (req *request.Request, output *ConfirmSubscriptionOutput)

ConfirmSubscriptionRequest generates a "aws/request.Request" representing the client's request for the ConfirmSubscription operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See ConfirmSubscription for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ConfirmSubscription method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

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

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/ConfirmSubscription

func (*SNS) ConfirmSubscriptionWithContext added in v1.8.0 

func (c *SNS) ConfirmSubscriptionWithContext(ctx aws.Context, input *ConfirmSubscriptionInput, opts ...request.Option) (*ConfirmSubscriptionOutput, error)

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

See ConfirmSubscription 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 (*SNS) CreatePlatformApplication 

func (c *SNS) CreatePlatformApplication(input *CreatePlatformApplicationInput) (*CreatePlatformApplicationOutput, error)

CreatePlatformApplication API operation for Amazon Simple Notification Service.

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 WNS, PlatformPrincipal is "Package Security Identifier". For MPNS, PlatformPrincipal is "TLS certificate". For Baidu, PlatformPrincipal is "API key".

For APNS/APNS_SANDBOX, PlatformCredential is "private key". For GCM, PlatformCredential is "API key". For ADM, PlatformCredential is "client secret". For WNS, PlatformCredential is "secret key". For MPNS, PlatformCredential is "private key". For Baidu, PlatformCredential is "secret key". 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). For more information about obtaining the PlatformPrincipal and PlatformCredential for each of the supported push notification services, see Getting Started with Apple Push Notification Service (http://docs.aws.amazon.com/sns/latest/dg/mobile-push-apns.html), Getting Started with Amazon Device Messaging (http://docs.aws.amazon.com/sns/latest/dg/mobile-push-adm.html), Getting Started with Baidu Cloud Push (http://docs.aws.amazon.com/sns/latest/dg/mobile-push-baidu.html), Getting Started with Google Cloud Messaging for Android (http://docs.aws.amazon.com/sns/latest/dg/mobile-push-gcm.html), Getting Started with MPNS (http://docs.aws.amazon.com/sns/latest/dg/mobile-push-mpns.html), or Getting Started with WNS (http://docs.aws.amazon.com/sns/latest/dg/mobile-push-wns.html).

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 Simple Notification Service's API operation CreatePlatformApplication for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterException "InvalidParameter" Indicates that a request parameter does not comply with the associated constraints.

  • ErrCodeInternalErrorException "InternalError" Indicates an internal service error.

  • ErrCodeAuthorizationErrorException "AuthorizationError" Indicates that the user has been denied access to the requested resource.

Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/CreatePlatformApplication

func (*SNS) CreatePlatformApplicationRequest 

func (c *SNS) CreatePlatformApplicationRequest(input *CreatePlatformApplicationInput) (req *request.Request, output *CreatePlatformApplicationOutput)

CreatePlatformApplicationRequest generates a "aws/request.Request" representing the client's request for the CreatePlatformApplication operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See CreatePlatformApplication for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreatePlatformApplication method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

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

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/CreatePlatformApplication

func (*SNS) CreatePlatformApplicationWithContext added in v1.8.0 

func (c *SNS) CreatePlatformApplicationWithContext(ctx aws.Context, input *CreatePlatformApplicationInput, opts ...request.Option) (*CreatePlatformApplicationOutput, error)

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

See CreatePlatformApplication 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 (*SNS) CreatePlatformEndpoint 

func (c *SNS) CreatePlatformEndpoint(input *CreatePlatformEndpointInput) (*CreatePlatformEndpointOutput, error)

CreatePlatformEndpoint API operation for Amazon Simple Notification Service.

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).

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 Simple Notification Service's API operation CreatePlatformEndpoint for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterException "InvalidParameter" Indicates that a request parameter does not comply with the associated constraints.

  • ErrCodeInternalErrorException "InternalError" Indicates an internal service error.

  • ErrCodeAuthorizationErrorException "AuthorizationError" Indicates that the user has been denied access to the requested resource.

  • ErrCodeNotFoundException "NotFound" Indicates that the requested resource does not exist.

Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/CreatePlatformEndpoint

func (*SNS) CreatePlatformEndpointRequest 

func (c *SNS) CreatePlatformEndpointRequest(input *CreatePlatformEndpointInput) (req *request.Request, output *CreatePlatformEndpointOutput)

CreatePlatformEndpointRequest generates a "aws/request.Request" representing the client's request for the CreatePlatformEndpoint operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See CreatePlatformEndpoint for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreatePlatformEndpoint method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

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

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/CreatePlatformEndpoint

func (*SNS) CreatePlatformEndpointWithContext added in v1.8.0 

func (c *SNS) CreatePlatformEndpointWithContext(ctx aws.Context, input *CreatePlatformEndpointInput, opts ...request.Option) (*CreatePlatformEndpointOutput, error)

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

See CreatePlatformEndpoint 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 (*SNS) CreateTopic 

func (c *SNS) CreateTopic(input *CreateTopicInput) (*CreateTopicOutput, error)

CreateTopic API operation for Amazon Simple Notification Service.

Creates a topic to which notifications can be published. Users can create at most 100,000 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.

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 Simple Notification Service's API operation CreateTopic for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterException "InvalidParameter" Indicates that a request parameter does not comply with the associated constraints.

  • ErrCodeTopicLimitExceededException "TopicLimitExceeded" Indicates that the customer already owns the maximum allowed number of topics.

  • ErrCodeInternalErrorException "InternalError" Indicates an internal service error.

  • ErrCodeAuthorizationErrorException "AuthorizationError" Indicates that the user has been denied access to the requested resource.

Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/CreateTopic

func (*SNS) CreateTopicRequest 

func (c *SNS) CreateTopicRequest(input *CreateTopicInput) (req *request.Request, output *CreateTopicOutput)

CreateTopicRequest generates a "aws/request.Request" representing the client's request for the CreateTopic operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See CreateTopic for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreateTopic method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

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

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/CreateTopic

func (*SNS) CreateTopicWithContext added in v1.8.0 

func (c *SNS) CreateTopicWithContext(ctx aws.Context, input *CreateTopicInput, opts ...request.Option) (*CreateTopicOutput, error)

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

See CreateTopic 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 (*SNS) DeleteEndpoint 

func (c *SNS) DeleteEndpoint(input *DeleteEndpointInput) (*DeleteEndpointOutput, error)

DeleteEndpoint API operation for Amazon Simple Notification Service.

Deletes the endpoint for a device and mobile app 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).

When you delete an endpoint that is also subscribed to a topic, then you must also unsubscribe the endpoint from the 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 Simple Notification Service's API operation DeleteEndpoint for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterException "InvalidParameter" Indicates that a request parameter does not comply with the associated constraints.

  • ErrCodeInternalErrorException "InternalError" Indicates an internal service error.

  • ErrCodeAuthorizationErrorException "AuthorizationError" Indicates that the user has been denied access to the requested resource.

Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/DeleteEndpoint

func (*SNS) DeleteEndpointRequest 

func (c *SNS) DeleteEndpointRequest(input *DeleteEndpointInput) (req *request.Request, output *DeleteEndpointOutput)

DeleteEndpointRequest generates a "aws/request.Request" representing the client's request for the DeleteEndpoint operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See DeleteEndpoint for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteEndpoint method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

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

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/DeleteEndpoint

func (*SNS) DeleteEndpointWithContext added in v1.8.0 

func (c *SNS) DeleteEndpointWithContext(ctx aws.Context, input *DeleteEndpointInput, opts ...request.Option) (*DeleteEndpointOutput, error)

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

See DeleteEndpoint 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 (*SNS) DeletePlatformApplication 

func (c *SNS) DeletePlatformApplication(input *DeletePlatformApplicationInput) (*DeletePlatformApplicationOutput, error)

DeletePlatformApplication API operation for Amazon Simple Notification Service.

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).

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 Simple Notification Service's API operation DeletePlatformApplication for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterException "InvalidParameter" Indicates that a request parameter does not comply with the associated constraints.

  • ErrCodeInternalErrorException "InternalError" Indicates an internal service error.

  • ErrCodeAuthorizationErrorException "AuthorizationError" Indicates that the user has been denied access to the requested resource.

Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/DeletePlatformApplication

func (*SNS) DeletePlatformApplicationRequest 

func (c *SNS) DeletePlatformApplicationRequest(input *DeletePlatformApplicationInput) (req *request.Request, output *DeletePlatformApplicationOutput)

DeletePlatformApplicationRequest generates a "aws/request.Request" representing the client's request for the DeletePlatformApplication operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See DeletePlatformApplication for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeletePlatformApplication method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

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

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/DeletePlatformApplication

func (*SNS) DeletePlatformApplicationWithContext added in v1.8.0 

func (c *SNS) DeletePlatformApplicationWithContext(ctx aws.Context, input *DeletePlatformApplicationInput, opts ...request.Option) (*DeletePlatformApplicationOutput, error)

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

See DeletePlatformApplication 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 (*SNS) DeleteTopic 

func (c *SNS) DeleteTopic(input *DeleteTopicInput) (*DeleteTopicOutput, error)

DeleteTopic API operation for Amazon Simple Notification Service.

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.

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 Simple Notification Service's API operation DeleteTopic for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterException "InvalidParameter" Indicates that a request parameter does not comply with the associated constraints.

  • ErrCodeInternalErrorException "InternalError" Indicates an internal service error.

  • ErrCodeAuthorizationErrorException "AuthorizationError" Indicates that the user has been denied access to the requested resource.

  • ErrCodeNotFoundException "NotFound" Indicates that the requested resource does not exist.

Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/DeleteTopic

func (*SNS) DeleteTopicRequest 

func (c *SNS) DeleteTopicRequest(input *DeleteTopicInput) (req *request.Request, output *DeleteTopicOutput)

DeleteTopicRequest generates a "aws/request.Request" representing the client's request for the DeleteTopic operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See DeleteTopic for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteTopic method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

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

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/DeleteTopic

func (*SNS) DeleteTopicWithContext added in v1.8.0 

func (c *SNS) DeleteTopicWithContext(ctx aws.Context, input *DeleteTopicInput, opts ...request.Option) (*DeleteTopicOutput, error)

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

See DeleteTopic 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 (*SNS) GetEndpointAttributes 

func (c *SNS) GetEndpointAttributes(input *GetEndpointAttributesInput) (*GetEndpointAttributesOutput, error)

GetEndpointAttributes API operation for Amazon Simple Notification Service.

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).

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 Simple Notification Service's API operation GetEndpointAttributes for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterException "InvalidParameter" Indicates that a request parameter does not comply with the associated constraints.

  • ErrCodeInternalErrorException "InternalError" Indicates an internal service error.

  • ErrCodeAuthorizationErrorException "AuthorizationError" Indicates that the user has been denied access to the requested resource.

  • ErrCodeNotFoundException "NotFound" Indicates that the requested resource does not exist.

Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/GetEndpointAttributes

func (*SNS) GetEndpointAttributesRequest 

func (c *SNS) GetEndpointAttributesRequest(input *GetEndpointAttributesInput) (req *request.Request, output *GetEndpointAttributesOutput)

GetEndpointAttributesRequest generates a "aws/request.Request" representing the client's request for the GetEndpointAttributes operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See GetEndpointAttributes for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetEndpointAttributes method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

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

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/GetEndpointAttributes

func (*SNS) GetEndpointAttributesWithContext added in v1.8.0 

func (c *SNS) GetEndpointAttributesWithContext(ctx aws.Context, input *GetEndpointAttributesInput, opts ...request.Option) (*GetEndpointAttributesOutput, error)

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

See GetEndpointAttributes 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 (*SNS) GetPlatformApplicationAttributes 

func (c *SNS) GetPlatformApplicationAttributes(input *GetPlatformApplicationAttributesInput) (*GetPlatformApplicationAttributesOutput, error)

GetPlatformApplicationAttributes API operation for Amazon Simple Notification Service.

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).

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 Simple Notification Service's API operation GetPlatformApplicationAttributes for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterException "InvalidParameter" Indicates that a request parameter does not comply with the associated constraints.

  • ErrCodeInternalErrorException "InternalError" Indicates an internal service error.

  • ErrCodeAuthorizationErrorException "AuthorizationError" Indicates that the user has been denied access to the requested resource.

  • ErrCodeNotFoundException "NotFound" Indicates that the requested resource does not exist.

Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/GetPlatformApplicationAttributes

func (*SNS) GetPlatformApplicationAttributesRequest 

func (c *SNS) GetPlatformApplicationAttributesRequest(input *GetPlatformApplicationAttributesInput) (req *request.Request, output *GetPlatformApplicationAttributesOutput)

GetPlatformApplicationAttributesRequest generates a "aws/request.Request" representing the client's request for the GetPlatformApplicationAttributes operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See GetPlatformApplicationAttributes for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetPlatformApplicationAttributes method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

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

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/GetPlatformApplicationAttributes

func (*SNS) GetPlatformApplicationAttributesWithContext added in v1.8.0 

func (c *SNS) GetPlatformApplicationAttributesWithContext(ctx aws.Context, input *GetPlatformApplicationAttributesInput, opts ...request.Option) (*GetPlatformApplicationAttributesOutput, error)

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

See GetPlatformApplicationAttributes 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 (*SNS) GetSMSAttributes added in v1.2.1 

func (c *SNS) GetSMSAttributes(input *GetSMSAttributesInput) (*GetSMSAttributesOutput, error)

GetSMSAttributes API operation for Amazon Simple Notification Service.

Returns the settings for sending SMS messages from your account.

These settings are set with the SetSMSAttributes action.

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 Simple Notification Service's API operation GetSMSAttributes for usage and error information.

Returned Error Codes:

  • ErrCodeThrottledException "Throttled" Indicates that the rate at which requests have been submitted for this action exceeds the limit for your account.

  • ErrCodeInternalErrorException "InternalError" Indicates an internal service error.

  • ErrCodeAuthorizationErrorException "AuthorizationError" Indicates that the user has been denied access to the requested resource.

  • ErrCodeInvalidParameterException "InvalidParameter" Indicates that a request parameter does not comply with the associated constraints.

Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/GetSMSAttributes

func (*SNS) GetSMSAttributesRequest added in v1.2.1 

func (c *SNS) GetSMSAttributesRequest(input *GetSMSAttributesInput) (req *request.Request, output *GetSMSAttributesOutput)

GetSMSAttributesRequest generates a "aws/request.Request" representing the client's request for the GetSMSAttributes operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See GetSMSAttributes for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetSMSAttributes method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

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

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/GetSMSAttributes

func (*SNS) GetSMSAttributesWithContext added in v1.8.0 

func (c *SNS) GetSMSAttributesWithContext(ctx aws.Context, input *GetSMSAttributesInput, opts ...request.Option) (*GetSMSAttributesOutput, error)

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

See GetSMSAttributes 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 (*SNS) GetSubscriptionAttributes 

func (c *SNS) GetSubscriptionAttributes(input *GetSubscriptionAttributesInput) (*GetSubscriptionAttributesOutput, error)

GetSubscriptionAttributes API operation for Amazon Simple Notification Service.

Returns all of the properties of a subscription.

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 Simple Notification Service's API operation GetSubscriptionAttributes for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterException "InvalidParameter" Indicates that a request parameter does not comply with the associated constraints.

  • ErrCodeInternalErrorException "InternalError" Indicates an internal service error.

  • ErrCodeNotFoundException "NotFound" Indicates that the requested resource does not exist.

  • ErrCodeAuthorizationErrorException "AuthorizationError" Indicates that the user has been denied access to the requested resource.

Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/GetSubscriptionAttributes

func (*SNS) GetSubscriptionAttributesRequest 

func (c *SNS) GetSubscriptionAttributesRequest(input *GetSubscriptionAttributesInput) (req *request.Request, output *GetSubscriptionAttributesOutput)

GetSubscriptionAttributesRequest generates a "aws/request.Request" representing the client's request for the GetSubscriptionAttributes operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See GetSubscriptionAttributes for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetSubscriptionAttributes method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

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

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/GetSubscriptionAttributes

func (*SNS) GetSubscriptionAttributesWithContext added in v1.8.0 

func (c *SNS) GetSubscriptionAttributesWithContext(ctx aws.Context, input *GetSubscriptionAttributesInput, opts ...request.Option) (*GetSubscriptionAttributesOutput, error)

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

See GetSubscriptionAttributes 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 (*SNS) GetTopicAttributes 

func (c *SNS) GetTopicAttributes(input *GetTopicAttributesInput) (*GetTopicAttributesOutput, error)

GetTopicAttributes API operation for Amazon Simple Notification Service.

Returns all of the properties of a topic. Topic properties returned might differ based on the authorization of the user.

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 Simple Notification Service's API operation GetTopicAttributes for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterException "InvalidParameter" Indicates that a request parameter does not comply with the associated constraints.

  • ErrCodeInternalErrorException "InternalError" Indicates an internal service error.

  • ErrCodeNotFoundException "NotFound" Indicates that the requested resource does not exist.

  • ErrCodeAuthorizationErrorException "AuthorizationError" Indicates that the user has been denied access to the requested resource.

Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/GetTopicAttributes

func (*SNS) GetTopicAttributesRequest 

func (c *SNS) GetTopicAttributesRequest(input *GetTopicAttributesInput) (req *request.Request, output *GetTopicAttributesOutput)

GetTopicAttributesRequest generates a "aws/request.Request" representing the client's request for the GetTopicAttributes operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See GetTopicAttributes for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetTopicAttributes method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

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

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/GetTopicAttributes

func (*SNS) GetTopicAttributesWithContext added in v1.8.0 

func (c *SNS) GetTopicAttributesWithContext(ctx aws.Context, input *GetTopicAttributesInput, opts ...request.Option) (*GetTopicAttributesOutput, error)

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

See GetTopicAttributes 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 (*SNS) ListEndpointsByPlatformApplication 

func (c *SNS) ListEndpointsByPlatformApplication(input *ListEndpointsByPlatformApplicationInput) (*ListEndpointsByPlatformApplicationOutput, error)

ListEndpointsByPlatformApplication API operation for Amazon Simple Notification Service.

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).

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 Simple Notification Service's API operation ListEndpointsByPlatformApplication for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterException "InvalidParameter" Indicates that a request parameter does not comply with the associated constraints.

  • ErrCodeInternalErrorException "InternalError" Indicates an internal service error.

  • ErrCodeAuthorizationErrorException "AuthorizationError" Indicates that the user has been denied access to the requested resource.

  • ErrCodeNotFoundException "NotFound" Indicates that the requested resource does not exist.

Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/ListEndpointsByPlatformApplication

func (*SNS) ListEndpointsByPlatformApplicationPages 

func (c *SNS) ListEndpointsByPlatformApplicationPages(input *ListEndpointsByPlatformApplicationInput, fn func(*ListEndpointsByPlatformApplicationOutput, bool) bool) error

ListEndpointsByPlatformApplicationPages iterates over the pages of a ListEndpointsByPlatformApplication operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListEndpointsByPlatformApplication 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 ListEndpointsByPlatformApplication operation.
pageNum := 0
err := client.ListEndpointsByPlatformApplicationPages(params,
    func(page *ListEndpointsByPlatformApplicationOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*SNS) ListEndpointsByPlatformApplicationPagesWithContext added in v1.8.0 

func (c *SNS) ListEndpointsByPlatformApplicationPagesWithContext(ctx aws.Context, input *ListEndpointsByPlatformApplicationInput, fn func(*ListEndpointsByPlatformApplicationOutput, bool) bool, opts ...request.Option) error

ListEndpointsByPlatformApplicationPagesWithContext same as ListEndpointsByPlatformApplicationPages 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 (*SNS) ListEndpointsByPlatformApplicationRequest 

func (c *SNS) ListEndpointsByPlatformApplicationRequest(input *ListEndpointsByPlatformApplicationInput) (req *request.Request, output *ListEndpointsByPlatformApplicationOutput)

ListEndpointsByPlatformApplicationRequest generates a "aws/request.Request" representing the client's request for the ListEndpointsByPlatformApplication operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See ListEndpointsByPlatformApplication for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ListEndpointsByPlatformApplication method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

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

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/ListEndpointsByPlatformApplication

func (*SNS) ListEndpointsByPlatformApplicationWithContext added in v1.8.0 

func (c *SNS) ListEndpointsByPlatformApplicationWithContext(ctx aws.Context, input *ListEndpointsByPlatformApplicationInput, opts ...request.Option) (*ListEndpointsByPlatformApplicationOutput, error)

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

See ListEndpointsByPlatformApplication 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 (*SNS) ListPhoneNumbersOptedOut added in v1.2.1 

func (c *SNS) ListPhoneNumbersOptedOut(input *ListPhoneNumbersOptedOutInput) (*ListPhoneNumbersOptedOutOutput, error)

ListPhoneNumbersOptedOut API operation for Amazon Simple Notification Service.

Returns a list of phone numbers that are opted out, meaning you cannot send SMS messages to them.

The results for ListPhoneNumbersOptedOut are paginated, and each page returns up to 100 phone numbers. If additional phone numbers are available after the first page of results, then a NextToken string will be returned. To receive the next page, you call ListPhoneNumbersOptedOut again using the NextToken string received from the previous call. When there are no more records to return, NextToken will be null.

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 Simple Notification Service's API operation ListPhoneNumbersOptedOut for usage and error information.

Returned Error Codes:

  • ErrCodeThrottledException "Throttled" Indicates that the rate at which requests have been submitted for this action exceeds the limit for your account.

  • ErrCodeInternalErrorException "InternalError" Indicates an internal service error.

  • ErrCodeAuthorizationErrorException "AuthorizationError" Indicates that the user has been denied access to the requested resource.

  • ErrCodeInvalidParameterException "InvalidParameter" Indicates that a request parameter does not comply with the associated constraints.

Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/ListPhoneNumbersOptedOut

func (*SNS) ListPhoneNumbersOptedOutRequest added in v1.2.1 

func (c *SNS) ListPhoneNumbersOptedOutRequest(input *ListPhoneNumbersOptedOutInput) (req *request.Request, output *ListPhoneNumbersOptedOutOutput)

ListPhoneNumbersOptedOutRequest generates a "aws/request.Request" representing the client's request for the ListPhoneNumbersOptedOut operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See ListPhoneNumbersOptedOut for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ListPhoneNumbersOptedOut method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

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

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/ListPhoneNumbersOptedOut

func (*SNS) ListPhoneNumbersOptedOutWithContext added in v1.8.0 

func (c *SNS) ListPhoneNumbersOptedOutWithContext(ctx aws.Context, input *ListPhoneNumbersOptedOutInput, opts ...request.Option) (*ListPhoneNumbersOptedOutOutput, error)

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

See ListPhoneNumbersOptedOut 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 (*SNS) ListPlatformApplications 

func (c *SNS) ListPlatformApplications(input *ListPlatformApplicationsInput) (*ListPlatformApplicationsOutput, error)

ListPlatformApplications API operation for Amazon Simple Notification Service.

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).

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 Simple Notification Service's API operation ListPlatformApplications for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterException "InvalidParameter" Indicates that a request parameter does not comply with the associated constraints.

  • ErrCodeInternalErrorException "InternalError" Indicates an internal service error.

  • ErrCodeAuthorizationErrorException "AuthorizationError" Indicates that the user has been denied access to the requested resource.

Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/ListPlatformApplications

func (*SNS) ListPlatformApplicationsPages 

func (c *SNS) ListPlatformApplicationsPages(input *ListPlatformApplicationsInput, fn func(*ListPlatformApplicationsOutput, bool) bool) error

ListPlatformApplicationsPages iterates over the pages of a ListPlatformApplications operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListPlatformApplications 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 ListPlatformApplications operation.
pageNum := 0
err := client.ListPlatformApplicationsPages(params,
    func(page *ListPlatformApplicationsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*SNS) ListPlatformApplicationsPagesWithContext added in v1.8.0 

func (c *SNS) ListPlatformApplicationsPagesWithContext(ctx aws.Context, input *ListPlatformApplicationsInput, fn func(*ListPlatformApplicationsOutput, bool) bool, opts ...request.Option) error

ListPlatformApplicationsPagesWithContext same as ListPlatformApplicationsPages 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 (*SNS) ListPlatformApplicationsRequest 

func (c *SNS) ListPlatformApplicationsRequest(input *ListPlatformApplicationsInput) (req *request.Request, output *ListPlatformApplicationsOutput)

ListPlatformApplicationsRequest generates a "aws/request.Request" representing the client's request for the ListPlatformApplications operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See ListPlatformApplications for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ListPlatformApplications method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

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

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/ListPlatformApplications

func (*SNS) ListPlatformApplicationsWithContext added in v1.8.0 

func (c *SNS) ListPlatformApplicationsWithContext(ctx aws.Context, input *ListPlatformApplicationsInput, opts ...request.Option) (*ListPlatformApplicationsOutput, error)

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

See ListPlatformApplications 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 (*SNS) ListSubscriptions 

func (c *SNS) ListSubscriptions(input *ListSubscriptionsInput) (*ListSubscriptionsOutput, error)

ListSubscriptions API operation for Amazon Simple Notification Service.

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.

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 Simple Notification Service's API operation ListSubscriptions for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterException "InvalidParameter" Indicates that a request parameter does not comply with the associated constraints.

  • ErrCodeInternalErrorException "InternalError" Indicates an internal service error.

  • ErrCodeAuthorizationErrorException "AuthorizationError" Indicates that the user has been denied access to the requested resource.

Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/ListSubscriptions

func (*SNS) ListSubscriptionsByTopic 

func (c *SNS) ListSubscriptionsByTopic(input *ListSubscriptionsByTopicInput) (*ListSubscriptionsByTopicOutput, error)

ListSubscriptionsByTopic API operation for Amazon Simple Notification Service.

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.

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 Simple Notification Service's API operation ListSubscriptionsByTopic for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterException "InvalidParameter" Indicates that a request parameter does not comply with the associated constraints.

  • ErrCodeInternalErrorException "InternalError" Indicates an internal service error.

  • ErrCodeNotFoundException "NotFound" Indicates that the requested resource does not exist.

  • ErrCodeAuthorizationErrorException "AuthorizationError" Indicates that the user has been denied access to the requested resource.

Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/ListSubscriptionsByTopic

func (*SNS) ListSubscriptionsByTopicPages 

func (c *SNS) ListSubscriptionsByTopicPages(input *ListSubscriptionsByTopicInput, fn func(*ListSubscriptionsByTopicOutput, bool) bool) error

ListSubscriptionsByTopicPages iterates over the pages of a ListSubscriptionsByTopic operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListSubscriptionsByTopic 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 ListSubscriptionsByTopic operation.
pageNum := 0
err := client.ListSubscriptionsByTopicPages(params,
    func(page *ListSubscriptionsByTopicOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*SNS) ListSubscriptionsByTopicPagesWithContext added in v1.8.0 

func (c *SNS) ListSubscriptionsByTopicPagesWithContext(ctx aws.Context, input *ListSubscriptionsByTopicInput, fn func(*ListSubscriptionsByTopicOutput, bool) bool, opts ...request.Option) error

ListSubscriptionsByTopicPagesWithContext same as ListSubscriptionsByTopicPages 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 (*SNS) ListSubscriptionsByTopicRequest 

func (c *SNS) ListSubscriptionsByTopicRequest(input *ListSubscriptionsByTopicInput) (req *request.Request, output *ListSubscriptionsByTopicOutput)

ListSubscriptionsByTopicRequest generates a "aws/request.Request" representing the client's request for the ListSubscriptionsByTopic operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See ListSubscriptionsByTopic for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ListSubscriptionsByTopic method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

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

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/ListSubscriptionsByTopic

func (*SNS) ListSubscriptionsByTopicWithContext added in v1.8.0 

func (c *SNS) ListSubscriptionsByTopicWithContext(ctx aws.Context, input *ListSubscriptionsByTopicInput, opts ...request.Option) (*ListSubscriptionsByTopicOutput, error)

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

See ListSubscriptionsByTopic 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 (*SNS) ListSubscriptionsPages 

func (c *SNS) ListSubscriptionsPages(input *ListSubscriptionsInput, fn func(*ListSubscriptionsOutput, bool) bool) error

ListSubscriptionsPages iterates over the pages of a ListSubscriptions operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListSubscriptions 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 ListSubscriptions operation.
pageNum := 0
err := client.ListSubscriptionsPages(params,
    func(page *ListSubscriptionsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*SNS) ListSubscriptionsPagesWithContext added in v1.8.0 

func (c *SNS) ListSubscriptionsPagesWithContext(ctx aws.Context, input *ListSubscriptionsInput, fn func(*ListSubscriptionsOutput, bool) bool, opts ...request.Option) error

ListSubscriptionsPagesWithContext same as ListSubscriptionsPages 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 (*SNS) ListSubscriptionsRequest 

func (c *SNS) ListSubscriptionsRequest(input *ListSubscriptionsInput) (req *request.Request, output *ListSubscriptionsOutput)

ListSubscriptionsRequest generates a "aws/request.Request" representing the client's request for the ListSubscriptions operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See ListSubscriptions for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ListSubscriptions method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

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

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/ListSubscriptions

func (*SNS) ListSubscriptionsWithContext added in v1.8.0 

func (c *SNS) ListSubscriptionsWithContext(ctx aws.Context, input *ListSubscriptionsInput, opts ...request.Option) (*ListSubscriptionsOutput, error)

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

See ListSubscriptions 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 (*SNS) ListTopics 

func (c *SNS) ListTopics(input *ListTopicsInput) (*ListTopicsOutput, error)

ListTopics API operation for Amazon Simple Notification Service.

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.

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 Simple Notification Service's API operation ListTopics for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterException "InvalidParameter" Indicates that a request parameter does not comply with the associated constraints.

  • ErrCodeInternalErrorException "InternalError" Indicates an internal service error.

  • ErrCodeAuthorizationErrorException "AuthorizationError" Indicates that the user has been denied access to the requested resource.

Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/ListTopics

func (*SNS) ListTopicsPages 

func (c *SNS) ListTopicsPages(input *ListTopicsInput, fn func(*ListTopicsOutput, bool) bool) error

ListTopicsPages iterates over the pages of a ListTopics operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListTopics 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 ListTopics operation.
pageNum := 0
err := client.ListTopicsPages(params,
    func(page *ListTopicsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*SNS) ListTopicsPagesWithContext added in v1.8.0 

func (c *SNS) ListTopicsPagesWithContext(ctx aws.Context, input *ListTopicsInput, fn func(*ListTopicsOutput, bool) bool, opts ...request.Option) error

ListTopicsPagesWithContext same as ListTopicsPages 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 (*SNS) ListTopicsRequest 

func (c *SNS) ListTopicsRequest(input *ListTopicsInput) (req *request.Request, output *ListTopicsOutput)

ListTopicsRequest generates a "aws/request.Request" representing the client's request for the ListTopics operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See ListTopics for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ListTopics method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

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

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/ListTopics

func (*SNS) ListTopicsWithContext added in v1.8.0 

func (c *SNS) ListTopicsWithContext(ctx aws.Context, input *ListTopicsInput, opts ...request.Option) (*ListTopicsOutput, error)

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

See ListTopics 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 (*SNS) OptInPhoneNumber added in v1.2.1 

func (c *SNS) OptInPhoneNumber(input *OptInPhoneNumberInput) (*OptInPhoneNumberOutput, error)

OptInPhoneNumber API operation for Amazon Simple Notification Service.

Use this request to opt in a phone number that is opted out, which enables you to resume sending SMS messages to the number.

You can opt in a phone number only once every 30 days.

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 Simple Notification Service's API operation OptInPhoneNumber for usage and error information.

Returned Error Codes:

  • ErrCodeThrottledException "Throttled" Indicates that the rate at which requests have been submitted for this action exceeds the limit for your account.

  • ErrCodeInternalErrorException "InternalError" Indicates an internal service error.

  • ErrCodeAuthorizationErrorException "AuthorizationError" Indicates that the user has been denied access to the requested resource.

  • ErrCodeInvalidParameterException "InvalidParameter" Indicates that a request parameter does not comply with the associated constraints.

Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/OptInPhoneNumber

func (*SNS) OptInPhoneNumberRequest added in v1.2.1 

func (c *SNS) OptInPhoneNumberRequest(input *OptInPhoneNumberInput) (req *request.Request, output *OptInPhoneNumberOutput)

OptInPhoneNumberRequest generates a "aws/request.Request" representing the client's request for the OptInPhoneNumber operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See OptInPhoneNumber for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the OptInPhoneNumber method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

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

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/OptInPhoneNumber

func (*SNS) OptInPhoneNumberWithContext added in v1.8.0 

func (c *SNS) OptInPhoneNumberWithContext(ctx aws.Context, input *OptInPhoneNumberInput, opts ...request.Option) (*OptInPhoneNumberOutput, error)

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

See OptInPhoneNumber 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 (*SNS) Publish 

func (c *SNS) Publish(input *PublishInput) (*PublishOutput, error)

Publish API operation for Amazon Simple Notification Service.

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.

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 for the TargetArn parameter. The EndpointArn is returned when making a call with the CreatePlatformEndpoint action.

For more information about formatting messages, see Send Custom Platform-Specific Payloads in Messages to Mobile Devices (http://docs.aws.amazon.com/sns/latest/dg/mobile-push-send-custommessage.html).

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 Simple Notification Service's API operation Publish for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterException "InvalidParameter" Indicates that a request parameter does not comply with the associated constraints.

  • ErrCodeInvalidParameterValueException "ParameterValueInvalid" Indicates that a request parameter does not comply with the associated constraints.

  • ErrCodeInternalErrorException "InternalError" Indicates an internal service error.

  • ErrCodeNotFoundException "NotFound" Indicates that the requested resource does not exist.

  • ErrCodeEndpointDisabledException "EndpointDisabled" Exception error indicating endpoint disabled.

  • ErrCodePlatformApplicationDisabledException "PlatformApplicationDisabled" Exception error indicating platform application disabled.

  • ErrCodeAuthorizationErrorException "AuthorizationError" Indicates that the user has been denied access to the requested resource.

Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/Publish

func (*SNS) PublishRequest 

func (c *SNS) PublishRequest(input *PublishInput) (req *request.Request, output *PublishOutput)

PublishRequest generates a "aws/request.Request" representing the client's request for the Publish operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See Publish for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the Publish method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

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

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/Publish

func (*SNS) PublishWithContext added in v1.8.0 

func (c *SNS) PublishWithContext(ctx aws.Context, input *PublishInput, opts ...request.Option) (*PublishOutput, error)

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

See Publish 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 (*SNS) RemovePermission 

func (c *SNS) RemovePermission(input *RemovePermissionInput) (*RemovePermissionOutput, error)

RemovePermission API operation for Amazon Simple Notification Service.

Removes a statement from a topic's access control policy.

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 Simple Notification Service's API operation RemovePermission for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterException "InvalidParameter" Indicates that a request parameter does not comply with the associated constraints.

  • ErrCodeInternalErrorException "InternalError" Indicates an internal service error.

  • ErrCodeAuthorizationErrorException "AuthorizationError" Indicates that the user has been denied access to the requested resource.

  • ErrCodeNotFoundException "NotFound" Indicates that the requested resource does not exist.

Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/RemovePermission

func (*SNS) RemovePermissionRequest 

func (c *SNS) RemovePermissionRequest(input *RemovePermissionInput) (req *request.Request, output *RemovePermissionOutput)

RemovePermissionRequest generates a "aws/request.Request" representing the client's request for the RemovePermission operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See RemovePermission for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the RemovePermission method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

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

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/RemovePermission

func (*SNS) RemovePermissionWithContext added in v1.8.0 

func (c *SNS) RemovePermissionWithContext(ctx aws.Context, input *RemovePermissionInput, opts ...request.Option) (*RemovePermissionOutput, error)

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

See RemovePermission 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 (*SNS) SetEndpointAttributes 

func (c *SNS) SetEndpointAttributes(input *SetEndpointAttributesInput) (*SetEndpointAttributesOutput, error)

SetEndpointAttributes API operation for Amazon Simple Notification Service.

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).

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 Simple Notification Service's API operation SetEndpointAttributes for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterException "InvalidParameter" Indicates that a request parameter does not comply with the associated constraints.

  • ErrCodeInternalErrorException "InternalError" Indicates an internal service error.

  • ErrCodeAuthorizationErrorException "AuthorizationError" Indicates that the user has been denied access to the requested resource.

  • ErrCodeNotFoundException "NotFound" Indicates that the requested resource does not exist.

Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/SetEndpointAttributes

func (*SNS) SetEndpointAttributesRequest 

func (c *SNS) SetEndpointAttributesRequest(input *SetEndpointAttributesInput) (req *request.Request, output *SetEndpointAttributesOutput)

SetEndpointAttributesRequest generates a "aws/request.Request" representing the client's request for the SetEndpointAttributes operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See SetEndpointAttributes for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the SetEndpointAttributes method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

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

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/SetEndpointAttributes

func (*SNS) SetEndpointAttributesWithContext added in v1.8.0 

func (c *SNS) SetEndpointAttributesWithContext(ctx aws.Context, input *SetEndpointAttributesInput, opts ...request.Option) (*SetEndpointAttributesOutput, error)

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

See SetEndpointAttributes 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 (*SNS) SetPlatformApplicationAttributes 

func (c *SNS) SetPlatformApplicationAttributes(input *SetPlatformApplicationAttributesInput) (*SetPlatformApplicationAttributesOutput, error)

SetPlatformApplicationAttributes API operation for Amazon Simple Notification Service.

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). For information on configuring attributes for message delivery status, see Using Amazon SNS Application Attributes for Message Delivery Status (http://docs.aws.amazon.com/sns/latest/dg/sns-msg-status.html).

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 Simple Notification Service's API operation SetPlatformApplicationAttributes for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterException "InvalidParameter" Indicates that a request parameter does not comply with the associated constraints.

  • ErrCodeInternalErrorException "InternalError" Indicates an internal service error.

  • ErrCodeAuthorizationErrorException "AuthorizationError" Indicates that the user has been denied access to the requested resource.

  • ErrCodeNotFoundException "NotFound" Indicates that the requested resource does not exist.

Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/SetPlatformApplicationAttributes

func (*SNS) SetPlatformApplicationAttributesRequest 

func (c *SNS) SetPlatformApplicationAttributesRequest(input *SetPlatformApplicationAttributesInput) (req *request.Request, output *SetPlatformApplicationAttributesOutput)

SetPlatformApplicationAttributesRequest generates a "aws/request.Request" representing the client's request for the SetPlatformApplicationAttributes operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See SetPlatformApplicationAttributes for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the SetPlatformApplicationAttributes method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

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

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/SetPlatformApplicationAttributes

func (*SNS) SetPlatformApplicationAttributesWithContext added in v1.8.0 

func (c *SNS) SetPlatformApplicationAttributesWithContext(ctx aws.Context, input *SetPlatformApplicationAttributesInput, opts ...request.Option) (*SetPlatformApplicationAttributesOutput, error)

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

See SetPlatformApplicationAttributes 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 (*SNS) SetSMSAttributes added in v1.2.1 

func (c *SNS) SetSMSAttributes(input *SetSMSAttributesInput) (*SetSMSAttributesOutput, error)

SetSMSAttributes API operation for Amazon Simple Notification Service.

Use this request to set the default settings for sending SMS messages and receiving daily SMS usage reports.

You can override some of these settings for a single message when you use the Publish action with the MessageAttributes.entry.N parameter. For more information, see Sending an SMS Message (http://docs.aws.amazon.com/sns/latest/dg/sms_publish-to-phone.html) in the Amazon SNS 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 Simple Notification Service's API operation SetSMSAttributes for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterException "InvalidParameter" Indicates that a request parameter does not comply with the associated constraints.

  • ErrCodeThrottledException "Throttled" Indicates that the rate at which requests have been submitted for this action exceeds the limit for your account.

  • ErrCodeInternalErrorException "InternalError" Indicates an internal service error.

  • ErrCodeAuthorizationErrorException "AuthorizationError" Indicates that the user has been denied access to the requested resource.

Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/SetSMSAttributes

func (*SNS) SetSMSAttributesRequest added in v1.2.1 

func (c *SNS) SetSMSAttributesRequest(input *SetSMSAttributesInput) (req *request.Request, output *SetSMSAttributesOutput)

SetSMSAttributesRequest generates a "aws/request.Request" representing the client's request for the SetSMSAttributes operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See SetSMSAttributes for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the SetSMSAttributes method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

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

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/SetSMSAttributes

func (*SNS) SetSMSAttributesWithContext added in v1.8.0 

func (c *SNS) SetSMSAttributesWithContext(ctx aws.Context, input *SetSMSAttributesInput, opts ...request.Option) (*SetSMSAttributesOutput, error)

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

See SetSMSAttributes 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 (*SNS) SetSubscriptionAttributes 

func (c *SNS) SetSubscriptionAttributes(input *SetSubscriptionAttributesInput) (*SetSubscriptionAttributesOutput, error)

SetSubscriptionAttributes API operation for Amazon Simple Notification Service.

Allows a subscription owner to set an attribute of the topic to a new value.

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 Simple Notification Service's API operation SetSubscriptionAttributes for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterException "InvalidParameter" Indicates that a request parameter does not comply with the associated constraints.

  • ErrCodeInternalErrorException "InternalError" Indicates an internal service error.

  • ErrCodeNotFoundException "NotFound" Indicates that the requested resource does not exist.

  • ErrCodeAuthorizationErrorException "AuthorizationError" Indicates that the user has been denied access to the requested resource.

Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/SetSubscriptionAttributes

func (*SNS) SetSubscriptionAttributesRequest 

func (c *SNS) SetSubscriptionAttributesRequest(input *SetSubscriptionAttributesInput) (req *request.Request, output *SetSubscriptionAttributesOutput)

SetSubscriptionAttributesRequest generates a "aws/request.Request" representing the client's request for the SetSubscriptionAttributes operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See SetSubscriptionAttributes for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the SetSubscriptionAttributes method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

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

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/SetSubscriptionAttributes

func (*SNS) SetSubscriptionAttributesWithContext added in v1.8.0 

func (c *SNS) SetSubscriptionAttributesWithContext(ctx aws.Context, input *SetSubscriptionAttributesInput, opts ...request.Option) (*SetSubscriptionAttributesOutput, error)

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

See SetSubscriptionAttributes 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 (*SNS) SetTopicAttributes 

func (c *SNS) SetTopicAttributes(input *SetTopicAttributesInput) (*SetTopicAttributesOutput, error)

SetTopicAttributes API operation for Amazon Simple Notification Service.

Allows a topic owner to set an attribute of the topic to a new value.

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 Simple Notification Service's API operation SetTopicAttributes for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterException "InvalidParameter" Indicates that a request parameter does not comply with the associated constraints.

  • ErrCodeInternalErrorException "InternalError" Indicates an internal service error.

  • ErrCodeNotFoundException "NotFound" Indicates that the requested resource does not exist.

  • ErrCodeAuthorizationErrorException "AuthorizationError" Indicates that the user has been denied access to the requested resource.

Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/SetTopicAttributes

func (*SNS) SetTopicAttributesRequest 

func (c *SNS) SetTopicAttributesRequest(input *SetTopicAttributesInput) (req *request.Request, output *SetTopicAttributesOutput)

SetTopicAttributesRequest generates a "aws/request.Request" representing the client's request for the SetTopicAttributes operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See SetTopicAttributes for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the SetTopicAttributes method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

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

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/SetTopicAttributes

func (*SNS) SetTopicAttributesWithContext added in v1.8.0 

func (c *SNS) SetTopicAttributesWithContext(ctx aws.Context, input *SetTopicAttributesInput, opts ...request.Option) (*SetTopicAttributesOutput, error)

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

See SetTopicAttributes 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 (*SNS) Subscribe 

func (c *SNS) Subscribe(input *SubscribeInput) (*SubscribeOutput, error)

Subscribe API operation for Amazon Simple Notification Service.

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.

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 Simple Notification Service's API operation Subscribe for usage and error information.

Returned Error Codes:

  • ErrCodeSubscriptionLimitExceededException "SubscriptionLimitExceeded" Indicates that the customer already owns the maximum allowed number of subscriptions.

  • ErrCodeInvalidParameterException "InvalidParameter" Indicates that a request parameter does not comply with the associated constraints.

  • ErrCodeInternalErrorException "InternalError" Indicates an internal service error.

  • ErrCodeNotFoundException "NotFound" Indicates that the requested resource does not exist.

  • ErrCodeAuthorizationErrorException "AuthorizationError" Indicates that the user has been denied access to the requested resource.

Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/Subscribe

func (*SNS) SubscribeRequest 

func (c *SNS) SubscribeRequest(input *SubscribeInput) (req *request.Request, output *SubscribeOutput)

SubscribeRequest generates a "aws/request.Request" representing the client's request for the Subscribe operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See Subscribe for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the Subscribe method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

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

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/Subscribe

func (*SNS) SubscribeWithContext added in v1.8.0 

func (c *SNS) SubscribeWithContext(ctx aws.Context, input *SubscribeInput, opts ...request.Option) (*SubscribeOutput, error)

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

See Subscribe 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 (*SNS) Unsubscribe 

func (c *SNS) Unsubscribe(input *UnsubscribeInput) (*UnsubscribeOutput, error)

Unsubscribe API operation for Amazon Simple Notification Service.

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.

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 Simple Notification Service's API operation Unsubscribe for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterException "InvalidParameter" Indicates that a request parameter does not comply with the associated constraints.

  • ErrCodeInternalErrorException "InternalError" Indicates an internal service error.

  • ErrCodeAuthorizationErrorException "AuthorizationError" Indicates that the user has been denied access to the requested resource.

  • ErrCodeNotFoundException "NotFound" Indicates that the requested resource does not exist.

Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/Unsubscribe

func (*SNS) UnsubscribeRequest 

func (c *SNS) UnsubscribeRequest(input *UnsubscribeInput) (req *request.Request, output *UnsubscribeOutput)

UnsubscribeRequest generates a "aws/request.Request" representing the client's request for the Unsubscribe operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See Unsubscribe for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the Unsubscribe method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

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

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/Unsubscribe

func (*SNS) UnsubscribeWithContext added in v1.8.0 

func (c *SNS) UnsubscribeWithContext(ctx aws.Context, input *UnsubscribeInput, opts ...request.Option) (*UnsubscribeOutput, error)

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

See Unsubscribe 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 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 is a required field
	Attributes map[string]*string `type:"map" required:"true"`

	// EndpointArn used for SetEndpointAttributes action.
	//
	// EndpointArn is a required field
	EndpointArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Input for SetEndpointAttributes action. Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/SetEndpointAttributesInput

func (SetEndpointAttributesInput) GoString added in v0.6.5 

func (s SetEndpointAttributesInput) GoString() string

GoString returns the string representation

func (*SetEndpointAttributesInput) SetAttributes added in v1.5.0 

func (s *SetEndpointAttributesInput) SetAttributes(v map[string]*string) *SetEndpointAttributesInput

SetAttributes sets the Attributes field's value.

func (*SetEndpointAttributesInput) SetEndpointArn added in v1.5.0 

func (s *SetEndpointAttributesInput) SetEndpointArn(v string) *SetEndpointAttributesInput

SetEndpointArn sets the EndpointArn field's value.

func (SetEndpointAttributesInput) String added in v0.6.5 

func (s SetEndpointAttributesInput) String() string

String returns the string representation

func (*SetEndpointAttributesInput) Validate added in v1.1.21 

func (s *SetEndpointAttributesInput) Validate() error

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

type SetEndpointAttributesOutput 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/SetEndpointAttributesOutput

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.
	//
	//    * SuccessFeedbackRoleArn -- IAM role ARN used to give Amazon SNS write
	//    access to use CloudWatch Logs on your behalf.
	//
	//    * FailureFeedbackRoleArn -- IAM role ARN used to give Amazon SNS write
	//    access to use CloudWatch Logs on your behalf.
	//
	//    * SuccessFeedbackSampleRate -- Sample rate percentage (0-100) of successfully
	//    delivered messages.
	//
	// Attributes is a required field
	Attributes map[string]*string `type:"map" required:"true"`

	// PlatformApplicationArn for SetPlatformApplicationAttributes action.
	//
	// PlatformApplicationArn is a required field
	PlatformApplicationArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Input for SetPlatformApplicationAttributes action. Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/SetPlatformApplicationAttributesInput

func (SetPlatformApplicationAttributesInput) GoString added in v0.6.5 

func (s SetPlatformApplicationAttributesInput) GoString() string

GoString returns the string representation

func (*SetPlatformApplicationAttributesInput) SetAttributes added in v1.5.0 

func (s *SetPlatformApplicationAttributesInput) SetAttributes(v map[string]*string) *SetPlatformApplicationAttributesInput

SetAttributes sets the Attributes field's value.

func (*SetPlatformApplicationAttributesInput) SetPlatformApplicationArn added in v1.5.0 

func (s *SetPlatformApplicationAttributesInput) SetPlatformApplicationArn(v string) *SetPlatformApplicationAttributesInput

SetPlatformApplicationArn sets the PlatformApplicationArn field's value.

func (SetPlatformApplicationAttributesInput) String added in v0.6.5 

func (s SetPlatformApplicationAttributesInput) String() string

String returns the string representation

func (*SetPlatformApplicationAttributesInput) Validate added in v1.1.21 

func (s *SetPlatformApplicationAttributesInput) Validate() error

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

type SetPlatformApplicationAttributesOutput 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/SetPlatformApplicationAttributesOutput

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 SetSMSAttributesInput added in v1.2.1 

type SetSMSAttributesInput struct {

	// The default settings for sending SMS messages from your account. You can
	// set values for the following attribute names:
	//
	// MonthlySpendLimit – The maximum amount in USD that you are willing to spend
	// each month to send SMS messages. When Amazon SNS determines that sending
	// an SMS message would incur a cost that exceeds this limit, it stops sending
	// SMS messages within minutes.
	//
	// Amazon SNS stops sending SMS messages within minutes of the limit being crossed.
	// During that interval, if you continue to send SMS messages, you will incur
	// costs that exceed your limit.
	//
	// By default, the spend limit is set to the maximum allowed by Amazon SNS.
	// If you want to exceed the maximum, contact AWS Support (https://aws.amazon.com/premiumsupport/)
	// or your AWS sales representative for a service limit increase.
	//
	// DeliveryStatusIAMRole – The ARN of the IAM role that allows Amazon SNS to
	// write logs about SMS deliveries in CloudWatch Logs. For each SMS message
	// that you send, Amazon SNS writes a log that includes the message price, the
	// success or failure status, the reason for failure (if the message failed),
	// the message dwell time, and other information.
	//
	// DeliveryStatusSuccessSamplingRate – The percentage of successful SMS deliveries
	// for which Amazon SNS will write logs in CloudWatch Logs. The value can be
	// an integer from 0 - 100. For example, to write logs only for failed deliveries,
	// set this value to 0. To write logs for 10% of your successful deliveries,
	// set it to 10.
	//
	// DefaultSenderID – A string, such as your business brand, that is displayed
	// as the sender on the receiving device. Support for sender IDs varies by country.
	// The sender ID can be 1 - 11 alphanumeric characters, and it must contain
	// at least one letter.
	//
	// DefaultSMSType – The type of SMS message that you will send by default. You
	// can assign the following values:
	//
	//    * Promotional – (Default) Noncritical messages, such as marketing messages.
	//    Amazon SNS optimizes the message delivery to incur the lowest cost.
	//
	//    * Transactional – Critical messages that support customer transactions,
	//    such as one-time passcodes for multi-factor authentication. Amazon SNS
	//    optimizes the message delivery to achieve the highest reliability.
	//
	// UsageReportS3Bucket – The name of the Amazon S3 bucket to receive daily SMS
	// usage reports from Amazon SNS. Each day, Amazon SNS will deliver a usage
	// report as a CSV file to the bucket. The report includes the following information
	// for each SMS message that was successfully delivered by your account:
	//
	//    * Time that the message was published (in UTC)
	//
	//    * Message ID
	//
	//    * Destination phone number
	//
	//    * Message type
	//
	//    * Delivery status
	//
	//    * Message price (in USD)
	//
	//    * Part number (a message is split into multiple parts if it is too long
	//    for a single message)
	//
	//    * Total number of parts
	//
	// To receive the report, the bucket must have a policy that allows the Amazon
	// SNS service principle to perform the s3:PutObject and s3:GetBucketLocation
	// actions.
	//
	// For an example bucket policy and usage report, see Monitoring SMS Activity
	// (http://docs.aws.amazon.com/sns/latest/dg/sms_stats.html) in the Amazon SNS
	// Developer Guide.
	//
	// Attributes is a required field
	Attributes map[string]*string `locationName:"attributes" type:"map" required:"true"`
	// contains filtered or unexported fields
}

The input for the SetSMSAttributes action. Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/SetSMSAttributesInput

func (SetSMSAttributesInput) GoString added in v1.2.1 

func (s SetSMSAttributesInput) GoString() string

GoString returns the string representation

func (*SetSMSAttributesInput) SetAttributes added in v1.5.0 

func (s *SetSMSAttributesInput) SetAttributes(v map[string]*string) *SetSMSAttributesInput

SetAttributes sets the Attributes field's value.

func (SetSMSAttributesInput) String added in v1.2.1 

func (s SetSMSAttributesInput) String() string

String returns the string representation

func (*SetSMSAttributesInput) Validate added in v1.2.1 

func (s *SetSMSAttributesInput) Validate() error

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

type SetSMSAttributesOutput added in v1.2.1 

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

The response for the SetSMSAttributes action. Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/SetSMSAttributesResponse

func (SetSMSAttributesOutput) GoString added in v1.2.1 

func (s SetSMSAttributesOutput) GoString() string

GoString returns the string representation

func (SetSMSAttributesOutput) String added in v1.2.1 

func (s SetSMSAttributesOutput) 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 is a required field
	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 is a required field
	SubscriptionArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Input for SetSubscriptionAttributes action. Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/SetSubscriptionAttributesInput

func (SetSubscriptionAttributesInput) GoString added in v0.6.5 

func (s SetSubscriptionAttributesInput) GoString() string

GoString returns the string representation

func (*SetSubscriptionAttributesInput) SetAttributeName added in v1.5.0 

func (s *SetSubscriptionAttributesInput) SetAttributeName(v string) *SetSubscriptionAttributesInput

SetAttributeName sets the AttributeName field's value.

func (*SetSubscriptionAttributesInput) SetAttributeValue added in v1.5.0 

func (s *SetSubscriptionAttributesInput) SetAttributeValue(v string) *SetSubscriptionAttributesInput

SetAttributeValue sets the AttributeValue field's value.

func (*SetSubscriptionAttributesInput) SetSubscriptionArn added in v1.5.0 

func (s *SetSubscriptionAttributesInput) SetSubscriptionArn(v string) *SetSubscriptionAttributesInput

SetSubscriptionArn sets the SubscriptionArn field's value.

func (SetSubscriptionAttributesInput) String added in v0.6.5 

func (s SetSubscriptionAttributesInput) String() string

String returns the string representation

func (*SetSubscriptionAttributesInput) Validate added in v1.1.21 

func (s *SetSubscriptionAttributesInput) Validate() error

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

type SetSubscriptionAttributesOutput 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/SetSubscriptionAttributesOutput

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 is a required field
	AttributeName *string `type:"string" required:"true"`

	// The new value for the attribute.
	AttributeValue *string `type:"string"`

	// The ARN of the topic to modify.
	//
	// TopicArn is a required field
	TopicArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Input for SetTopicAttributes action. Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/SetTopicAttributesInput

func (SetTopicAttributesInput) GoString added in v0.6.5 

func (s SetTopicAttributesInput) GoString() string

GoString returns the string representation

func (*SetTopicAttributesInput) SetAttributeName added in v1.5.0 

func (s *SetTopicAttributesInput) SetAttributeName(v string) *SetTopicAttributesInput

SetAttributeName sets the AttributeName field's value.

func (*SetTopicAttributesInput) SetAttributeValue added in v1.5.0 

func (s *SetTopicAttributesInput) SetAttributeValue(v string) *SetTopicAttributesInput

SetAttributeValue sets the AttributeValue field's value.

func (*SetTopicAttributesInput) SetTopicArn added in v1.5.0 

func (s *SetTopicAttributesInput) SetTopicArn(v string) *SetTopicAttributesInput

SetTopicArn sets the TopicArn field's value.

func (SetTopicAttributesInput) String added in v0.6.5 

func (s SetTopicAttributesInput) String() string

String returns the string representation

func (*SetTopicAttributesInput) Validate added in v1.1.21 

func (s *SetTopicAttributesInput) Validate() error

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

type SetTopicAttributesOutput 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/SetTopicAttributesOutput

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.
	//
	//    * For the lambda protocol, the endpoint is the ARN of an AWS Lambda function.
	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.
	//
	//    * lambda -- delivery of JSON-encoded message to an AWS Lambda function.
	//
	// Protocol is a required field
	Protocol *string `type:"string" required:"true"`

	// The ARN of the topic you want to subscribe to.
	//
	// TopicArn is a required field
	TopicArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Input for Subscribe action. Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/SubscribeInput

func (SubscribeInput) GoString added in v0.6.5 

func (s SubscribeInput) GoString() string

GoString returns the string representation

func (*SubscribeInput) SetEndpoint added in v1.5.0 

func (s *SubscribeInput) SetEndpoint(v string) *SubscribeInput

SetEndpoint sets the Endpoint field's value.

func (*SubscribeInput) SetProtocol added in v1.5.0 

func (s *SubscribeInput) SetProtocol(v string) *SubscribeInput

SetProtocol sets the Protocol field's value.

func (*SubscribeInput) SetTopicArn added in v1.5.0 

func (s *SubscribeInput) SetTopicArn(v string) *SubscribeInput

SetTopicArn sets the TopicArn field's value.

func (SubscribeInput) String added in v0.6.5 

func (s SubscribeInput) String() string

String returns the string representation

func (*SubscribeInput) Validate added in v1.1.21 

func (s *SubscribeInput) Validate() error

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

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/SubscribeResponse

func (SubscribeOutput) GoString added in v0.6.5 

func (s SubscribeOutput) GoString() string

GoString returns the string representation

func (*SubscribeOutput) SetSubscriptionArn added in v1.5.0 

func (s *SubscribeOutput) SetSubscriptionArn(v string) *SubscribeOutput

SetSubscriptionArn sets the SubscriptionArn field's value.

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/Subscription

func (Subscription) GoString added in v0.6.5 

func (s Subscription) GoString() string

GoString returns the string representation

func (*Subscription) SetEndpoint added in v1.5.0 

func (s *Subscription) SetEndpoint(v string) *Subscription

SetEndpoint sets the Endpoint field's value.

func (*Subscription) SetOwner added in v1.5.0 

func (s *Subscription) SetOwner(v string) *Subscription

SetOwner sets the Owner field's value.

func (*Subscription) SetProtocol added in v1.5.0 

func (s *Subscription) SetProtocol(v string) *Subscription

SetProtocol sets the Protocol field's value.

func (*Subscription) SetSubscriptionArn added in v1.5.0 

func (s *Subscription) SetSubscriptionArn(v string) *Subscription

SetSubscriptionArn sets the SubscriptionArn field's value.

func (*Subscription) SetTopicArn added in v1.5.0 

func (s *Subscription) SetTopicArn(v string) *Subscription

SetTopicArn sets the TopicArn field's value.

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/Topic

func (Topic) GoString added in v0.6.5 

func (s Topic) GoString() string

GoString returns the string representation

func (*Topic) SetTopicArn added in v1.5.0 

func (s *Topic) SetTopicArn(v string) *Topic

SetTopicArn sets the TopicArn field's value.

func (Topic) String added in v0.6.5 

func (s Topic) String() string

String returns the string representation

type UnsubscribeInput 

type UnsubscribeInput struct {

	// The ARN of the subscription to be deleted.
	//
	// SubscriptionArn is a required field
	SubscriptionArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Input for Unsubscribe action. Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/UnsubscribeInput

func (UnsubscribeInput) GoString added in v0.6.5 

func (s UnsubscribeInput) GoString() string

GoString returns the string representation

func (*UnsubscribeInput) SetSubscriptionArn added in v1.5.0 

func (s *UnsubscribeInput) SetSubscriptionArn(v string) *UnsubscribeInput

SetSubscriptionArn sets the SubscriptionArn field's value.

func (UnsubscribeInput) String added in v0.6.5 

func (s UnsubscribeInput) String() string

String returns the string representation

func (*UnsubscribeInput) Validate added in v1.1.21 

func (s *UnsubscribeInput) Validate() error

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

type UnsubscribeOutput 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/UnsubscribeOutput

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

Source Files

View all Source files

Directories

Path Synopsis
Package snsiface provides an interface to enable mocking the Amazon Simple Notification Service service client for testing your code.
 Package snsiface provides an interface to enable mocking the Amazon Simple Notification Service service client for testing your code.

Jump to

Keyboard shortcuts

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