File: api_op_ListThirdPartyFirewallFirewallPolicies.go

package info (click to toggle)
golang-github-aws-aws-sdk-go-v2 1.24.1-2~bpo12%2B1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm-backports
  • size: 554,032 kB
  • sloc: java: 15,941; makefile: 419; sh: 175
file content (262 lines) | stat: -rw-r--r-- 9,396 bytes parent folder | download
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
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
// Code generated by smithy-go-codegen DO NOT EDIT.

package fms

import (
	"context"
	"fmt"
	awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
	"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
	"github.com/aws/aws-sdk-go-v2/service/fms/types"
	"github.com/aws/smithy-go/middleware"
	smithyhttp "github.com/aws/smithy-go/transport/http"
)

// Retrieves a list of all of the third-party firewall policies that are
// associated with the third-party firewall administrator's account.
func (c *Client) ListThirdPartyFirewallFirewallPolicies(ctx context.Context, params *ListThirdPartyFirewallFirewallPoliciesInput, optFns ...func(*Options)) (*ListThirdPartyFirewallFirewallPoliciesOutput, error) {
	if params == nil {
		params = &ListThirdPartyFirewallFirewallPoliciesInput{}
	}

	result, metadata, err := c.invokeOperation(ctx, "ListThirdPartyFirewallFirewallPolicies", params, optFns, c.addOperationListThirdPartyFirewallFirewallPoliciesMiddlewares)
	if err != nil {
		return nil, err
	}

	out := result.(*ListThirdPartyFirewallFirewallPoliciesOutput)
	out.ResultMetadata = metadata
	return out, nil
}

type ListThirdPartyFirewallFirewallPoliciesInput struct {

	// The maximum number of third-party firewall policies that you want Firewall
	// Manager to return. If the specified third-party firewall vendor is associated
	// with more than MaxResults firewall policies, the response includes a NextToken
	// element. NextToken contains an encrypted token that identifies the first
	// third-party firewall policies that Firewall Manager will return if you submit
	// another request.
	//
	// This member is required.
	MaxResults *int32

	// The name of the third-party firewall vendor.
	//
	// This member is required.
	ThirdPartyFirewall types.ThirdPartyFirewall

	// If the previous response included a NextToken element, the specified
	// third-party firewall vendor is associated with more third-party firewall
	// policies. To get more third-party firewall policies, submit another
	// ListThirdPartyFirewallFirewallPoliciesRequest request. For the value of
	// NextToken , specify the value of NextToken from the previous response. If the
	// previous response didn't include a NextToken element, there are no more
	// third-party firewall policies to get.
	NextToken *string

	noSmithyDocumentSerde
}

type ListThirdPartyFirewallFirewallPoliciesOutput struct {

	// The value that you will use for NextToken in the next
	// ListThirdPartyFirewallFirewallPolicies request.
	NextToken *string

	// A list that contains one ThirdPartyFirewallFirewallPolicies element for each
	// third-party firewall policies that the specified third-party firewall vendor is
	// associated with. Each ThirdPartyFirewallFirewallPolicies element contains the
	// firewall policy name and ID.
	ThirdPartyFirewallFirewallPolicies []types.ThirdPartyFirewallFirewallPolicy

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata

	noSmithyDocumentSerde
}

func (c *Client) addOperationListThirdPartyFirewallFirewallPoliciesMiddlewares(stack *middleware.Stack, options Options) (err error) {
	if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
		return err
	}
	err = stack.Serialize.Add(&awsAwsjson11_serializeOpListThirdPartyFirewallFirewallPolicies{}, middleware.After)
	if err != nil {
		return err
	}
	err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpListThirdPartyFirewallFirewallPolicies{}, middleware.After)
	if err != nil {
		return err
	}
	if err := addProtocolFinalizerMiddlewares(stack, options, "ListThirdPartyFirewallFirewallPolicies"); 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 = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
		return err
	}
	if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
		return err
	}
	if err = addResolveEndpointMiddleware(stack, options); err != nil {
		return err
	}
	if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
		return err
	}
	if err = addRetryMiddlewares(stack, options); err != nil {
		return err
	}
	if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
		return err
	}
	if err = awsmiddleware.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 = addOpListThirdPartyFirewallFirewallPoliciesValidationMiddleware(stack); err != nil {
		return err
	}
	if err = stack.Initialize.Add(newServiceMetadataMiddleware_opListThirdPartyFirewallFirewallPolicies(options.Region), middleware.Before); err != nil {
		return err
	}
	if err = awsmiddleware.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
}

// ListThirdPartyFirewallFirewallPoliciesAPIClient is a client that implements the
// ListThirdPartyFirewallFirewallPolicies operation.
type ListThirdPartyFirewallFirewallPoliciesAPIClient interface {
	ListThirdPartyFirewallFirewallPolicies(context.Context, *ListThirdPartyFirewallFirewallPoliciesInput, ...func(*Options)) (*ListThirdPartyFirewallFirewallPoliciesOutput, error)
}

var _ ListThirdPartyFirewallFirewallPoliciesAPIClient = (*Client)(nil)

// ListThirdPartyFirewallFirewallPoliciesPaginatorOptions is the paginator options
// for ListThirdPartyFirewallFirewallPolicies
type ListThirdPartyFirewallFirewallPoliciesPaginatorOptions struct {
	// The maximum number of third-party firewall policies that you want Firewall
	// Manager to return. If the specified third-party firewall vendor is associated
	// with more than MaxResults firewall policies, the response includes a NextToken
	// element. NextToken contains an encrypted token that identifies the first
	// third-party firewall policies that Firewall Manager will return if you submit
	// another request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

// ListThirdPartyFirewallFirewallPoliciesPaginator is a paginator for
// ListThirdPartyFirewallFirewallPolicies
type ListThirdPartyFirewallFirewallPoliciesPaginator struct {
	options   ListThirdPartyFirewallFirewallPoliciesPaginatorOptions
	client    ListThirdPartyFirewallFirewallPoliciesAPIClient
	params    *ListThirdPartyFirewallFirewallPoliciesInput
	nextToken *string
	firstPage bool
}

// NewListThirdPartyFirewallFirewallPoliciesPaginator returns a new
// ListThirdPartyFirewallFirewallPoliciesPaginator
func NewListThirdPartyFirewallFirewallPoliciesPaginator(client ListThirdPartyFirewallFirewallPoliciesAPIClient, params *ListThirdPartyFirewallFirewallPoliciesInput, optFns ...func(*ListThirdPartyFirewallFirewallPoliciesPaginatorOptions)) *ListThirdPartyFirewallFirewallPoliciesPaginator {
	if params == nil {
		params = &ListThirdPartyFirewallFirewallPoliciesInput{}
	}

	options := ListThirdPartyFirewallFirewallPoliciesPaginatorOptions{}
	if params.MaxResults != nil {
		options.Limit = *params.MaxResults
	}

	for _, fn := range optFns {
		fn(&options)
	}

	return &ListThirdPartyFirewallFirewallPoliciesPaginator{
		options:   options,
		client:    client,
		params:    params,
		firstPage: true,
		nextToken: params.NextToken,
	}
}

// HasMorePages returns a boolean indicating whether more pages are available
func (p *ListThirdPartyFirewallFirewallPoliciesPaginator) HasMorePages() bool {
	return p.firstPage || (p.nextToken != nil && len(*p.nextToken) != 0)
}

// NextPage retrieves the next ListThirdPartyFirewallFirewallPolicies page.
func (p *ListThirdPartyFirewallFirewallPoliciesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListThirdPartyFirewallFirewallPoliciesOutput, error) {
	if !p.HasMorePages() {
		return nil, fmt.Errorf("no more pages available")
	}

	params := *p.params
	params.NextToken = p.nextToken

	var limit *int32
	if p.options.Limit > 0 {
		limit = &p.options.Limit
	}
	params.MaxResults = limit

	result, err := p.client.ListThirdPartyFirewallFirewallPolicies(ctx, &params, optFns...)
	if err != nil {
		return nil, err
	}
	p.firstPage = false

	prevToken := p.nextToken
	p.nextToken = result.NextToken

	if p.options.StopOnDuplicateToken &&
		prevToken != nil &&
		p.nextToken != nil &&
		*prevToken == *p.nextToken {
		p.nextToken = nil
	}

	return result, nil
}

func newServiceMetadataMiddleware_opListThirdPartyFirewallFirewallPolicies(region string) *awsmiddleware.RegisterServiceMetadata {
	return &awsmiddleware.RegisterServiceMetadata{
		Region:        region,
		ServiceID:     ServiceID,
		OperationName: "ListThirdPartyFirewallFirewallPolicies",
	}
}