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
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package connectcases
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Deletes a field from a cases template. You can delete up to 100 fields per
// domain.
//
// After a field is deleted:
//
// - You can still retrieve the field by calling BatchGetField .
//
// - You cannot update a deleted field by calling UpdateField ; it throws a
// ValidationException .
//
// - Deleted fields are not included in the ListFields response.
//
// - Calling CreateCase with a deleted field throws a ValidationException
// denoting which field IDs in the request have been deleted.
//
// - Calling GetCase with a deleted field ID returns the deleted field's value if
// one exists.
//
// - Calling UpdateCase with a deleted field ID throws a ValidationException if
// the case does not already contain a value for the deleted field. Otherwise it
// succeeds, allowing you to update or remove (using emptyValue: {} ) the field's
// value from the case.
//
// - GetTemplate does not return field IDs for deleted fields.
//
// - GetLayout does not return field IDs for deleted fields.
//
// - Calling SearchCases with the deleted field ID as a filter returns any cases
// that have a value for the deleted field that matches the filter criteria.
//
// - Calling SearchCases with a searchTerm value that matches a deleted field's
// value on a case returns the case in the response.
//
// - Calling BatchPutFieldOptions with a deleted field ID throw a
// ValidationException .
//
// - Calling GetCaseEventConfiguration does not return field IDs for deleted
// fields.
func (c *Client) DeleteField(ctx context.Context, params *DeleteFieldInput, optFns ...func(*Options)) (*DeleteFieldOutput, error) {
if params == nil {
params = &DeleteFieldInput{}
}
result, metadata, err := c.invokeOperation(ctx, "DeleteField", params, optFns, c.addOperationDeleteFieldMiddlewares)
if err != nil {
return nil, err
}
out := result.(*DeleteFieldOutput)
out.ResultMetadata = metadata
return out, nil
}
type DeleteFieldInput struct {
// The unique identifier of the Cases domain.
//
// This member is required.
DomainId *string
// Unique identifier of the field.
//
// This member is required.
FieldId *string
noSmithyDocumentSerde
}
type DeleteFieldOutput struct {
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationDeleteFieldMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsRestjson1_serializeOpDeleteField{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpDeleteField{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "DeleteField"); err != nil {
return fmt.Errorf("add protocol finalizers: %v", err)
}
if err = addlegacyEndpointContextSetter(stack, options); err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = addClientRequestID(stack); err != nil {
return err
}
if err = addComputeContentLength(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = addComputePayloadSHA256(stack); err != nil {
return err
}
if err = addRetry(stack, options); err != nil {
return err
}
if err = addRawResponseToMetadata(stack); err != nil {
return err
}
if err = addRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack, options); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addSetLegacyContextSigningOptionsMiddleware(stack); err != nil {
return err
}
if err = addTimeOffsetBuild(stack, c); err != nil {
return err
}
if err = addUserAgentRetryMode(stack, options); err != nil {
return err
}
if err = addOpDeleteFieldValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDeleteField(options.Region), middleware.Before); err != nil {
return err
}
if err = addRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
if err = addDisableHTTPSMiddleware(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opDeleteField(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "DeleteField",
}
}
|
