-
Notifications
You must be signed in to change notification settings - Fork 622
/
api_op_CheckIfPhoneNumberIsOptedOut.go
131 lines (108 loc) · 4.18 KB
/
api_op_CheckIfPhoneNumberIsOptedOut.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
package sns
import (
"context"
"github.com/aws/aws-sdk-go-v2/aws"
"github.com/aws/aws-sdk-go-v2/internal/awsutil"
)
// The input for the CheckIfPhoneNumberIsOptedOut action.
type CheckIfPhoneNumberIsOptedOutInput struct {
_ struct{} `type:"structure"`
// 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"`
}
// String returns the string representation
func (s CheckIfPhoneNumberIsOptedOutInput) String() string {
return awsutil.Prettify(s)
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *CheckIfPhoneNumberIsOptedOutInput) Validate() error {
invalidParams := aws.ErrInvalidParams{Context: "CheckIfPhoneNumberIsOptedOutInput"}
if s.PhoneNumber == nil {
invalidParams.Add(aws.NewErrParamRequired("PhoneNumber"))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// The response from the CheckIfPhoneNumberIsOptedOut action.
type CheckIfPhoneNumberIsOptedOutOutput struct {
_ struct{} `type:"structure"`
// 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"`
}
// String returns the string representation
func (s CheckIfPhoneNumberIsOptedOutOutput) String() string {
return awsutil.Prettify(s)
}
const opCheckIfPhoneNumberIsOptedOut = "CheckIfPhoneNumberIsOptedOut"
// CheckIfPhoneNumberIsOptedOutRequest returns a request value for making 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.
//
// // Example sending a request using CheckIfPhoneNumberIsOptedOutRequest.
// req := client.CheckIfPhoneNumberIsOptedOutRequest(params)
// resp, err := req.Send(context.TODO())
// if err == nil {
// fmt.Println(resp)
// }
//
// Please also see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/CheckIfPhoneNumberIsOptedOut
func (c *Client) CheckIfPhoneNumberIsOptedOutRequest(input *CheckIfPhoneNumberIsOptedOutInput) CheckIfPhoneNumberIsOptedOutRequest {
op := &aws.Operation{
Name: opCheckIfPhoneNumberIsOptedOut,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &CheckIfPhoneNumberIsOptedOutInput{}
}
req := c.newRequest(op, input, &CheckIfPhoneNumberIsOptedOutOutput{})
return CheckIfPhoneNumberIsOptedOutRequest{Request: req, Input: input, Copy: c.CheckIfPhoneNumberIsOptedOutRequest}
}
// CheckIfPhoneNumberIsOptedOutRequest is the request type for the
// CheckIfPhoneNumberIsOptedOut API operation.
type CheckIfPhoneNumberIsOptedOutRequest struct {
*aws.Request
Input *CheckIfPhoneNumberIsOptedOutInput
Copy func(*CheckIfPhoneNumberIsOptedOutInput) CheckIfPhoneNumberIsOptedOutRequest
}
// Send marshals and sends the CheckIfPhoneNumberIsOptedOut API request.
func (r CheckIfPhoneNumberIsOptedOutRequest) Send(ctx context.Context) (*CheckIfPhoneNumberIsOptedOutResponse, error) {
r.Request.SetContext(ctx)
err := r.Request.Send()
if err != nil {
return nil, err
}
resp := &CheckIfPhoneNumberIsOptedOutResponse{
CheckIfPhoneNumberIsOptedOutOutput: r.Request.Data.(*CheckIfPhoneNumberIsOptedOutOutput),
response: &aws.Response{Request: r.Request},
}
return resp, nil
}
// CheckIfPhoneNumberIsOptedOutResponse is the response type for the
// CheckIfPhoneNumberIsOptedOut API operation.
type CheckIfPhoneNumberIsOptedOutResponse struct {
*CheckIfPhoneNumberIsOptedOutOutput
response *aws.Response
}
// SDKResponseMetdata returns the response metadata for the
// CheckIfPhoneNumberIsOptedOut request.
func (r *CheckIfPhoneNumberIsOptedOutResponse) SDKResponseMetdata() *aws.Response {
return r.response
}