-
Notifications
You must be signed in to change notification settings - Fork 598
/
api_op_RefreshTrustedAdvisorCheck.go
142 lines (119 loc) · 4.74 KB
/
api_op_RefreshTrustedAdvisorCheck.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
132
133
134
135
136
137
138
139
140
141
142
// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
package support
import (
"context"
"github.com/aws/aws-sdk-go-v2/aws"
"github.com/aws/aws-sdk-go-v2/internal/awsutil"
)
// Please also see https://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/RefreshTrustedAdvisorCheckRequest
type RefreshTrustedAdvisorCheckInput struct {
_ struct{} `type:"structure"`
// The unique identifier for the Trusted Advisor check to refresh. Note: Specifying
// the check ID of a check that is automatically refreshed causes an InvalidParameterValue
// error.
//
// CheckId is a required field
CheckId *string `locationName:"checkId" type:"string" required:"true"`
}
// String returns the string representation
func (s RefreshTrustedAdvisorCheckInput) String() string {
return awsutil.Prettify(s)
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *RefreshTrustedAdvisorCheckInput) Validate() error {
invalidParams := aws.ErrInvalidParams{Context: "RefreshTrustedAdvisorCheckInput"}
if s.CheckId == nil {
invalidParams.Add(aws.NewErrParamRequired("CheckId"))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// The current refresh status of a Trusted Advisor check.
// Please also see https://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/RefreshTrustedAdvisorCheckResponse
type RefreshTrustedAdvisorCheckOutput struct {
_ struct{} `type:"structure"`
// The current refresh status for a check, including the amount of time until
// the check is eligible for refresh.
//
// Status is a required field
Status *TrustedAdvisorCheckRefreshStatus `locationName:"status" type:"structure" required:"true"`
}
// String returns the string representation
func (s RefreshTrustedAdvisorCheckOutput) String() string {
return awsutil.Prettify(s)
}
const opRefreshTrustedAdvisorCheck = "RefreshTrustedAdvisorCheck"
// RefreshTrustedAdvisorCheckRequest returns a request value for making API operation for
// AWS Support.
//
// Requests a refresh of the Trusted Advisor check that has the specified check
// ID. Check IDs can be obtained by calling DescribeTrustedAdvisorChecks.
//
// Some checks are refreshed automatically, and they cannot be refreshed by
// using this operation. Use of the RefreshTrustedAdvisorCheck operation for
// these checks causes an InvalidParameterValue error.
//
// The response contains a TrustedAdvisorCheckRefreshStatus object, which contains
// these fields:
//
// * status. The refresh status of the check: "none", "enqueued", "processing",
// "success", or "abandoned".
//
// * millisUntilNextRefreshable. The amount of time, in milliseconds, until
// the check is eligible for refresh.
//
// * checkId. The unique identifier for the check.
//
// // Example sending a request using RefreshTrustedAdvisorCheckRequest.
// req := client.RefreshTrustedAdvisorCheckRequest(params)
// resp, err := req.Send(context.TODO())
// if err == nil {
// fmt.Println(resp)
// }
//
// Please also see https://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/RefreshTrustedAdvisorCheck
func (c *Client) RefreshTrustedAdvisorCheckRequest(input *RefreshTrustedAdvisorCheckInput) RefreshTrustedAdvisorCheckRequest {
op := &aws.Operation{
Name: opRefreshTrustedAdvisorCheck,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &RefreshTrustedAdvisorCheckInput{}
}
req := c.newRequest(op, input, &RefreshTrustedAdvisorCheckOutput{})
return RefreshTrustedAdvisorCheckRequest{Request: req, Input: input, Copy: c.RefreshTrustedAdvisorCheckRequest}
}
// RefreshTrustedAdvisorCheckRequest is the request type for the
// RefreshTrustedAdvisorCheck API operation.
type RefreshTrustedAdvisorCheckRequest struct {
*aws.Request
Input *RefreshTrustedAdvisorCheckInput
Copy func(*RefreshTrustedAdvisorCheckInput) RefreshTrustedAdvisorCheckRequest
}
// Send marshals and sends the RefreshTrustedAdvisorCheck API request.
func (r RefreshTrustedAdvisorCheckRequest) Send(ctx context.Context) (*RefreshTrustedAdvisorCheckResponse, error) {
r.Request.SetContext(ctx)
err := r.Request.Send()
if err != nil {
return nil, err
}
resp := &RefreshTrustedAdvisorCheckResponse{
RefreshTrustedAdvisorCheckOutput: r.Request.Data.(*RefreshTrustedAdvisorCheckOutput),
response: &aws.Response{Request: r.Request},
}
return resp, nil
}
// RefreshTrustedAdvisorCheckResponse is the response type for the
// RefreshTrustedAdvisorCheck API operation.
type RefreshTrustedAdvisorCheckResponse struct {
*RefreshTrustedAdvisorCheckOutput
response *aws.Response
}
// SDKResponseMetdata returns the response metadata for the
// RefreshTrustedAdvisorCheck request.
func (r *RefreshTrustedAdvisorCheckResponse) SDKResponseMetdata() *aws.Response {
return r.response
}