1// Code generated by smithy-go-codegen DO NOT EDIT. 2 3package rds 4 5import ( 6 "context" 7 "fmt" 8 awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware" 9 "github.com/aws/aws-sdk-go-v2/aws/signer/v4" 10 "github.com/aws/aws-sdk-go-v2/service/rds/types" 11 "github.com/aws/smithy-go/middleware" 12 smithyhttp "github.com/aws/smithy-go/transport/http" 13) 14 15// Returns the detailed parameter list for a particular DB parameter group. 16func (c *Client) DescribeDBParameters(ctx context.Context, params *DescribeDBParametersInput, optFns ...func(*Options)) (*DescribeDBParametersOutput, error) { 17 if params == nil { 18 params = &DescribeDBParametersInput{} 19 } 20 21 result, metadata, err := c.invokeOperation(ctx, "DescribeDBParameters", params, optFns, addOperationDescribeDBParametersMiddlewares) 22 if err != nil { 23 return nil, err 24 } 25 26 out := result.(*DescribeDBParametersOutput) 27 out.ResultMetadata = metadata 28 return out, nil 29} 30 31type DescribeDBParametersInput struct { 32 33 // The name of a specific DB parameter group to return details for. Constraints: 34 // 35 // * 36 // If supplied, must match the name of an existing DBParameterGroup. 37 // 38 // This member is required. 39 DBParameterGroupName *string 40 41 // This parameter isn't currently supported. 42 Filters []types.Filter 43 44 // An optional pagination token provided by a previous DescribeDBParameters 45 // request. If this parameter is specified, the response includes only records 46 // beyond the marker, up to the value specified by MaxRecords. 47 Marker *string 48 49 // The maximum number of records to include in the response. If more records exist 50 // than the specified MaxRecords value, a pagination token called a marker is 51 // included in the response so that you can retrieve the remaining results. 52 // Default: 100 Constraints: Minimum 20, maximum 100. 53 MaxRecords *int32 54 55 // The parameter types to return. Default: All parameter types returned Valid 56 // Values: user | system | engine-default 57 Source *string 58} 59 60// Contains the result of a successful invocation of the DescribeDBParameters 61// action. 62type DescribeDBParametersOutput struct { 63 64 // An optional pagination token provided by a previous request. If this parameter 65 // is specified, the response includes only records beyond the marker, up to the 66 // value specified by MaxRecords. 67 Marker *string 68 69 // A list of Parameter values. 70 Parameters []types.Parameter 71 72 // Metadata pertaining to the operation's result. 73 ResultMetadata middleware.Metadata 74} 75 76func addOperationDescribeDBParametersMiddlewares(stack *middleware.Stack, options Options) (err error) { 77 err = stack.Serialize.Add(&awsAwsquery_serializeOpDescribeDBParameters{}, middleware.After) 78 if err != nil { 79 return err 80 } 81 err = stack.Deserialize.Add(&awsAwsquery_deserializeOpDescribeDBParameters{}, middleware.After) 82 if err != nil { 83 return err 84 } 85 if err = addSetLoggerMiddleware(stack, options); err != nil { 86 return err 87 } 88 if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil { 89 return err 90 } 91 if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil { 92 return err 93 } 94 if err = addResolveEndpointMiddleware(stack, options); err != nil { 95 return err 96 } 97 if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil { 98 return err 99 } 100 if err = addRetryMiddlewares(stack, options); err != nil { 101 return err 102 } 103 if err = addHTTPSignerV4Middleware(stack, options); err != nil { 104 return err 105 } 106 if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil { 107 return err 108 } 109 if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil { 110 return err 111 } 112 if err = addClientUserAgent(stack); err != nil { 113 return err 114 } 115 if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil { 116 return err 117 } 118 if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil { 119 return err 120 } 121 if err = addOpDescribeDBParametersValidationMiddleware(stack); err != nil { 122 return err 123 } 124 if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDescribeDBParameters(options.Region), middleware.Before); err != nil { 125 return err 126 } 127 if err = addRequestIDRetrieverMiddleware(stack); err != nil { 128 return err 129 } 130 if err = addResponseErrorMiddleware(stack); err != nil { 131 return err 132 } 133 if err = addRequestResponseLogging(stack, options); err != nil { 134 return err 135 } 136 return nil 137} 138 139// DescribeDBParametersAPIClient is a client that implements the 140// DescribeDBParameters operation. 141type DescribeDBParametersAPIClient interface { 142 DescribeDBParameters(context.Context, *DescribeDBParametersInput, ...func(*Options)) (*DescribeDBParametersOutput, error) 143} 144 145var _ DescribeDBParametersAPIClient = (*Client)(nil) 146 147// DescribeDBParametersPaginatorOptions is the paginator options for 148// DescribeDBParameters 149type DescribeDBParametersPaginatorOptions struct { 150 // The maximum number of records to include in the response. If more records exist 151 // than the specified MaxRecords value, a pagination token called a marker is 152 // included in the response so that you can retrieve the remaining results. 153 // Default: 100 Constraints: Minimum 20, maximum 100. 154 Limit int32 155 156 // Set to true if pagination should stop if the service returns a pagination token 157 // that matches the most recent token provided to the service. 158 StopOnDuplicateToken bool 159} 160 161// DescribeDBParametersPaginator is a paginator for DescribeDBParameters 162type DescribeDBParametersPaginator struct { 163 options DescribeDBParametersPaginatorOptions 164 client DescribeDBParametersAPIClient 165 params *DescribeDBParametersInput 166 nextToken *string 167 firstPage bool 168} 169 170// NewDescribeDBParametersPaginator returns a new DescribeDBParametersPaginator 171func NewDescribeDBParametersPaginator(client DescribeDBParametersAPIClient, params *DescribeDBParametersInput, optFns ...func(*DescribeDBParametersPaginatorOptions)) *DescribeDBParametersPaginator { 172 options := DescribeDBParametersPaginatorOptions{} 173 if params.MaxRecords != nil { 174 options.Limit = *params.MaxRecords 175 } 176 177 for _, fn := range optFns { 178 fn(&options) 179 } 180 181 if params == nil { 182 params = &DescribeDBParametersInput{} 183 } 184 185 return &DescribeDBParametersPaginator{ 186 options: options, 187 client: client, 188 params: params, 189 firstPage: true, 190 } 191} 192 193// HasMorePages returns a boolean indicating whether more pages are available 194func (p *DescribeDBParametersPaginator) HasMorePages() bool { 195 return p.firstPage || p.nextToken != nil 196} 197 198// NextPage retrieves the next DescribeDBParameters page. 199func (p *DescribeDBParametersPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeDBParametersOutput, error) { 200 if !p.HasMorePages() { 201 return nil, fmt.Errorf("no more pages available") 202 } 203 204 params := *p.params 205 params.Marker = p.nextToken 206 207 var limit *int32 208 if p.options.Limit > 0 { 209 limit = &p.options.Limit 210 } 211 params.MaxRecords = limit 212 213 result, err := p.client.DescribeDBParameters(ctx, ¶ms, optFns...) 214 if err != nil { 215 return nil, err 216 } 217 p.firstPage = false 218 219 prevToken := p.nextToken 220 p.nextToken = result.Marker 221 222 if p.options.StopOnDuplicateToken && prevToken != nil && p.nextToken != nil && *prevToken == *p.nextToken { 223 p.nextToken = nil 224 } 225 226 return result, nil 227} 228 229func newServiceMetadataMiddleware_opDescribeDBParameters(region string) *awsmiddleware.RegisterServiceMetadata { 230 return &awsmiddleware.RegisterServiceMetadata{ 231 Region: region, 232 ServiceID: ServiceID, 233 SigningName: "rds", 234 OperationName: "DescribeDBParameters", 235 } 236} 237