// Code generated by smithy-go-codegen DO NOT EDIT. package chime 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/chime/types" "github.com/aws/smithy-go/middleware" smithyhttp "github.com/aws/smithy-go/transport/http" ) // Lists all the users banned from a particular channel. The x-amz-chime-bearer // request header is mandatory. Use the AppInstanceUserArn of the user that makes // the API call as the value in the header. This API is is no longer supported and // will not be updated. We recommend using the latest version, ListChannelBans (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_ListChannelBans.html) // , in the Amazon Chime SDK. Using the latest version requires migrating to a // dedicated namespace. For more information, refer to Migrating from the Amazon // Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) // in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by ListChannelBans in the Amazon Chime SDK Messaging // Namespace func (c *Client) ListChannelBans(ctx context.Context, params *ListChannelBansInput, optFns ...func(*Options)) (*ListChannelBansOutput, error) { if params == nil { params = &ListChannelBansInput{} } result, metadata, err := c.invokeOperation(ctx, "ListChannelBans", params, optFns, c.addOperationListChannelBansMiddlewares) if err != nil { return nil, err } out := result.(*ListChannelBansOutput) out.ResultMetadata = metadata return out, nil } type ListChannelBansInput struct { // The ARN of the channel. // // This member is required. ChannelArn *string // The AppInstanceUserArn of the user that makes the API call. ChimeBearer *string // The maximum number of bans that you want returned. MaxResults *int32 // The token passed by previous API calls until all requested bans are returned. NextToken *string noSmithyDocumentSerde } type ListChannelBansOutput struct { // The ARN of the channel. ChannelArn *string // The information for each requested ban. ChannelBans []types.ChannelBanSummary // The token passed by previous API calls until all requested bans are returned. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata noSmithyDocumentSerde } func (c *Client) addOperationListChannelBansMiddlewares(stack *middleware.Stack, options Options) (err error) { err = stack.Serialize.Add(&awsRestjson1_serializeOpListChannelBans{}, middleware.After) if err != nil { return err } err = stack.Deserialize.Add(&awsRestjson1_deserializeOpListChannelBans{}, middleware.After) if 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 = addHTTPSignerV4Middleware(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 = addEndpointPrefix_opListChannelBansMiddleware(stack); err != nil { return err } if err = addOpListChannelBansValidationMiddleware(stack); err != nil { return err } if err = stack.Initialize.Add(newServiceMetadataMiddleware_opListChannelBans(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 } return nil } type endpointPrefix_opListChannelBansMiddleware struct { } func (*endpointPrefix_opListChannelBansMiddleware) ID() string { return "EndpointHostPrefix" } func (m *endpointPrefix_opListChannelBansMiddleware) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) ( out middleware.SerializeOutput, metadata middleware.Metadata, err error, ) { if smithyhttp.GetHostnameImmutable(ctx) || smithyhttp.IsEndpointHostPrefixDisabled(ctx) { return next.HandleSerialize(ctx, in) } req, ok := in.Request.(*smithyhttp.Request) if !ok { return out, metadata, fmt.Errorf("unknown transport type %T", in.Request) } req.URL.Host = "messaging-" + req.URL.Host return next.HandleSerialize(ctx, in) } func addEndpointPrefix_opListChannelBansMiddleware(stack *middleware.Stack) error { return stack.Serialize.Insert(&endpointPrefix_opListChannelBansMiddleware{}, `OperationSerializer`, middleware.After) } // ListChannelBansAPIClient is a client that implements the ListChannelBans // operation. type ListChannelBansAPIClient interface { ListChannelBans(context.Context, *ListChannelBansInput, ...func(*Options)) (*ListChannelBansOutput, error) } var _ ListChannelBansAPIClient = (*Client)(nil) // ListChannelBansPaginatorOptions is the paginator options for ListChannelBans type ListChannelBansPaginatorOptions struct { // The maximum number of bans that you want returned. 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 } // ListChannelBansPaginator is a paginator for ListChannelBans type ListChannelBansPaginator struct { options ListChannelBansPaginatorOptions client ListChannelBansAPIClient params *ListChannelBansInput nextToken *string firstPage bool } // NewListChannelBansPaginator returns a new ListChannelBansPaginator func NewListChannelBansPaginator(client ListChannelBansAPIClient, params *ListChannelBansInput, optFns ...func(*ListChannelBansPaginatorOptions)) *ListChannelBansPaginator { if params == nil { params = &ListChannelBansInput{} } options := ListChannelBansPaginatorOptions{} if params.MaxResults != nil { options.Limit = *params.MaxResults } for _, fn := range optFns { fn(&options) } return &ListChannelBansPaginator{ options: options, client: client, params: params, firstPage: true, nextToken: params.NextToken, } } // HasMorePages returns a boolean indicating whether more pages are available func (p *ListChannelBansPaginator) HasMorePages() bool { return p.firstPage || (p.nextToken != nil && len(*p.nextToken) != 0) } // NextPage retrieves the next ListChannelBans page. func (p *ListChannelBansPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListChannelBansOutput, 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.ListChannelBans(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 } func newServiceMetadataMiddleware_opListChannelBans(region string) *awsmiddleware.RegisterServiceMetadata { return &awsmiddleware.RegisterServiceMetadata{ Region: region, ServiceID: ServiceID, SigningName: "chime", OperationName: "ListChannelBans", } }