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 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package accessanalyzer
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/service/accessanalyzer/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
"time"
)
// Retrieves information about a finding recommendation for the specified analyzer.
func (c *Client) GetFindingRecommendation(ctx context.Context, params *GetFindingRecommendationInput, optFns ...func(*Options)) (*GetFindingRecommendationOutput, error) {
if params == nil {
params = &GetFindingRecommendationInput{}
}
result, metadata, err := c.invokeOperation(ctx, "GetFindingRecommendation", params, optFns, c.addOperationGetFindingRecommendationMiddlewares)
if err != nil {
return nil, err
}
out := result.(*GetFindingRecommendationOutput)
out.ResultMetadata = metadata
return out, nil
}
type GetFindingRecommendationInput struct {
// The [ARN of the analyzer] used to generate the finding recommendation.
//
// [ARN of the analyzer]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-getting-started.html#permission-resources
//
// This member is required.
AnalyzerArn *string
// The unique ID for the finding recommendation.
//
// This member is required.
Id *string
// The maximum number of results to return in the response.
MaxResults *int32
// A token used for pagination of results returned.
NextToken *string
noSmithyDocumentSerde
}
type GetFindingRecommendationOutput struct {
// The type of recommendation for the finding.
//
// This member is required.
RecommendationType types.RecommendationType
// The ARN of the resource of the finding.
//
// This member is required.
ResourceArn *string
// The time at which the retrieval of the finding recommendation was started.
//
// This member is required.
StartedAt *time.Time
// The status of the retrieval of the finding recommendation.
//
// This member is required.
Status types.Status
// The time at which the retrieval of the finding recommendation was completed.
CompletedAt *time.Time
// Detailed information about the reason that the retrieval of a recommendation
// for the finding failed.
Error *types.RecommendationError
// A token used for pagination of results returned.
NextToken *string
// A group of recommended steps for the finding.
RecommendedSteps []types.RecommendedStep
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationGetFindingRecommendationMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsRestjson1_serializeOpGetFindingRecommendation{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpGetFindingRecommendation{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "GetFindingRecommendation"); 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 = addOpGetFindingRecommendationValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opGetFindingRecommendation(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
}
// GetFindingRecommendationPaginatorOptions is the paginator options for
// GetFindingRecommendation
type GetFindingRecommendationPaginatorOptions struct {
// The maximum number of results to return in the response.
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
}
// GetFindingRecommendationPaginator is a paginator for GetFindingRecommendation
type GetFindingRecommendationPaginator struct {
options GetFindingRecommendationPaginatorOptions
client GetFindingRecommendationAPIClient
params *GetFindingRecommendationInput
nextToken *string
firstPage bool
}
// NewGetFindingRecommendationPaginator returns a new
// GetFindingRecommendationPaginator
func NewGetFindingRecommendationPaginator(client GetFindingRecommendationAPIClient, params *GetFindingRecommendationInput, optFns ...func(*GetFindingRecommendationPaginatorOptions)) *GetFindingRecommendationPaginator {
if params == nil {
params = &GetFindingRecommendationInput{}
}
options := GetFindingRecommendationPaginatorOptions{}
if params.MaxResults != nil {
options.Limit = *params.MaxResults
}
for _, fn := range optFns {
fn(&options)
}
return &GetFindingRecommendationPaginator{
options: options,
client: client,
params: params,
firstPage: true,
nextToken: params.NextToken,
}
}
// HasMorePages returns a boolean indicating whether more pages are available
func (p *GetFindingRecommendationPaginator) HasMorePages() bool {
return p.firstPage || (p.nextToken != nil && len(*p.nextToken) != 0)
}
// NextPage retrieves the next GetFindingRecommendation page.
func (p *GetFindingRecommendationPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetFindingRecommendationOutput, 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
optFns = append([]func(*Options){
addIsPaginatorUserAgent,
}, optFns...)
result, err := p.client.GetFindingRecommendation(ctx, ¶ms, 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
}
// GetFindingRecommendationAPIClient is a client that implements the
// GetFindingRecommendation operation.
type GetFindingRecommendationAPIClient interface {
GetFindingRecommendation(context.Context, *GetFindingRecommendationInput, ...func(*Options)) (*GetFindingRecommendationOutput, error)
}
var _ GetFindingRecommendationAPIClient = (*Client)(nil)
func newServiceMetadataMiddleware_opGetFindingRecommendation(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "GetFindingRecommendation",
}
}
|