1// Code generated by smithy-go-codegen DO NOT EDIT. 2 3package elasticache 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/elasticache/types" 11 "github.com/aws/smithy-go/middleware" 12 smithyhttp "github.com/aws/smithy-go/transport/http" 13) 14 15// Returns information about a particular global replication group. If no 16// identifier is specified, returns information about all Global datastores. 17func (c *Client) DescribeGlobalReplicationGroups(ctx context.Context, params *DescribeGlobalReplicationGroupsInput, optFns ...func(*Options)) (*DescribeGlobalReplicationGroupsOutput, error) { 18 if params == nil { 19 params = &DescribeGlobalReplicationGroupsInput{} 20 } 21 22 result, metadata, err := c.invokeOperation(ctx, "DescribeGlobalReplicationGroups", params, optFns, addOperationDescribeGlobalReplicationGroupsMiddlewares) 23 if err != nil { 24 return nil, err 25 } 26 27 out := result.(*DescribeGlobalReplicationGroupsOutput) 28 out.ResultMetadata = metadata 29 return out, nil 30} 31 32type DescribeGlobalReplicationGroupsInput struct { 33 34 // The name of the Global datastore 35 GlobalReplicationGroupId *string 36 37 // An optional marker returned from a prior request. Use this marker for pagination 38 // of results from this operation. If this parameter is specified, the response 39 // includes only records beyond the marker, up to the value specified by 40 // MaxRecords. 41 Marker *string 42 43 // The maximum number of records to include in the response. If more records exist 44 // than the specified MaxRecords value, a marker is included in the response so 45 // that the remaining results can be retrieved. 46 MaxRecords *int32 47 48 // Returns the list of members that comprise the Global datastore. 49 ShowMemberInfo *bool 50} 51 52type DescribeGlobalReplicationGroupsOutput struct { 53 54 // Indicates the slot configuration and global identifier for each slice group. 55 GlobalReplicationGroups []types.GlobalReplicationGroup 56 57 // An optional marker returned from a prior request. Use this marker for pagination 58 // of results from this operation. If this parameter is specified, the response 59 // includes only records beyond the marker, up to the value specified by 60 // MaxRecords. > 61 Marker *string 62 63 // Metadata pertaining to the operation's result. 64 ResultMetadata middleware.Metadata 65} 66 67func addOperationDescribeGlobalReplicationGroupsMiddlewares(stack *middleware.Stack, options Options) (err error) { 68 err = stack.Serialize.Add(&awsAwsquery_serializeOpDescribeGlobalReplicationGroups{}, middleware.After) 69 if err != nil { 70 return err 71 } 72 err = stack.Deserialize.Add(&awsAwsquery_deserializeOpDescribeGlobalReplicationGroups{}, middleware.After) 73 if err != nil { 74 return err 75 } 76 if err = addSetLoggerMiddleware(stack, options); err != nil { 77 return err 78 } 79 if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil { 80 return err 81 } 82 if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil { 83 return err 84 } 85 if err = addResolveEndpointMiddleware(stack, options); err != nil { 86 return err 87 } 88 if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil { 89 return err 90 } 91 if err = addRetryMiddlewares(stack, options); err != nil { 92 return err 93 } 94 if err = addHTTPSignerV4Middleware(stack, options); err != nil { 95 return err 96 } 97 if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil { 98 return err 99 } 100 if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil { 101 return err 102 } 103 if err = addClientUserAgent(stack); err != nil { 104 return err 105 } 106 if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil { 107 return err 108 } 109 if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil { 110 return err 111 } 112 if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDescribeGlobalReplicationGroups(options.Region), middleware.Before); err != nil { 113 return err 114 } 115 if err = addRequestIDRetrieverMiddleware(stack); err != nil { 116 return err 117 } 118 if err = addResponseErrorMiddleware(stack); err != nil { 119 return err 120 } 121 if err = addRequestResponseLogging(stack, options); err != nil { 122 return err 123 } 124 return nil 125} 126 127// DescribeGlobalReplicationGroupsAPIClient is a client that implements the 128// DescribeGlobalReplicationGroups operation. 129type DescribeGlobalReplicationGroupsAPIClient interface { 130 DescribeGlobalReplicationGroups(context.Context, *DescribeGlobalReplicationGroupsInput, ...func(*Options)) (*DescribeGlobalReplicationGroupsOutput, error) 131} 132 133var _ DescribeGlobalReplicationGroupsAPIClient = (*Client)(nil) 134 135// DescribeGlobalReplicationGroupsPaginatorOptions is the paginator options for 136// DescribeGlobalReplicationGroups 137type DescribeGlobalReplicationGroupsPaginatorOptions struct { 138 // The maximum number of records to include in the response. If more records exist 139 // than the specified MaxRecords value, a marker is included in the response so 140 // that the remaining results can be retrieved. 141 Limit int32 142 143 // Set to true if pagination should stop if the service returns a pagination token 144 // that matches the most recent token provided to the service. 145 StopOnDuplicateToken bool 146} 147 148// DescribeGlobalReplicationGroupsPaginator is a paginator for 149// DescribeGlobalReplicationGroups 150type DescribeGlobalReplicationGroupsPaginator struct { 151 options DescribeGlobalReplicationGroupsPaginatorOptions 152 client DescribeGlobalReplicationGroupsAPIClient 153 params *DescribeGlobalReplicationGroupsInput 154 nextToken *string 155 firstPage bool 156} 157 158// NewDescribeGlobalReplicationGroupsPaginator returns a new 159// DescribeGlobalReplicationGroupsPaginator 160func NewDescribeGlobalReplicationGroupsPaginator(client DescribeGlobalReplicationGroupsAPIClient, params *DescribeGlobalReplicationGroupsInput, optFns ...func(*DescribeGlobalReplicationGroupsPaginatorOptions)) *DescribeGlobalReplicationGroupsPaginator { 161 if params == nil { 162 params = &DescribeGlobalReplicationGroupsInput{} 163 } 164 165 options := DescribeGlobalReplicationGroupsPaginatorOptions{} 166 if params.MaxRecords != nil { 167 options.Limit = *params.MaxRecords 168 } 169 170 for _, fn := range optFns { 171 fn(&options) 172 } 173 174 return &DescribeGlobalReplicationGroupsPaginator{ 175 options: options, 176 client: client, 177 params: params, 178 firstPage: true, 179 } 180} 181 182// HasMorePages returns a boolean indicating whether more pages are available 183func (p *DescribeGlobalReplicationGroupsPaginator) HasMorePages() bool { 184 return p.firstPage || p.nextToken != nil 185} 186 187// NextPage retrieves the next DescribeGlobalReplicationGroups page. 188func (p *DescribeGlobalReplicationGroupsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeGlobalReplicationGroupsOutput, error) { 189 if !p.HasMorePages() { 190 return nil, fmt.Errorf("no more pages available") 191 } 192 193 params := *p.params 194 params.Marker = p.nextToken 195 196 var limit *int32 197 if p.options.Limit > 0 { 198 limit = &p.options.Limit 199 } 200 params.MaxRecords = limit 201 202 result, err := p.client.DescribeGlobalReplicationGroups(ctx, ¶ms, optFns...) 203 if err != nil { 204 return nil, err 205 } 206 p.firstPage = false 207 208 prevToken := p.nextToken 209 p.nextToken = result.Marker 210 211 if p.options.StopOnDuplicateToken && prevToken != nil && p.nextToken != nil && *prevToken == *p.nextToken { 212 p.nextToken = nil 213 } 214 215 return result, nil 216} 217 218func newServiceMetadataMiddleware_opDescribeGlobalReplicationGroups(region string) *awsmiddleware.RegisterServiceMetadata { 219 return &awsmiddleware.RegisterServiceMetadata{ 220 Region: region, 221 ServiceID: ServiceID, 222 SigningName: "elasticache", 223 OperationName: "DescribeGlobalReplicationGroups", 224 } 225} 226