1// Code generated by smithy-go-codegen DO NOT EDIT.
2
3package appstream
4
5import (
6	"context"
7	awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
8	"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
9	"github.com/aws/aws-sdk-go-v2/service/appstream/types"
10	"github.com/aws/smithy-go/middleware"
11	smithyhttp "github.com/aws/smithy-go/transport/http"
12)
13
14// Retrieves a list that describes the streaming sessions for a specified stack and
15// fleet. If a UserId is provided for the stack and fleet, only streaming sessions
16// for that user are described. If an authentication type is not provided, the
17// default is to authenticate users using a streaming URL.
18func (c *Client) DescribeSessions(ctx context.Context, params *DescribeSessionsInput, optFns ...func(*Options)) (*DescribeSessionsOutput, error) {
19	if params == nil {
20		params = &DescribeSessionsInput{}
21	}
22
23	result, metadata, err := c.invokeOperation(ctx, "DescribeSessions", params, optFns, addOperationDescribeSessionsMiddlewares)
24	if err != nil {
25		return nil, err
26	}
27
28	out := result.(*DescribeSessionsOutput)
29	out.ResultMetadata = metadata
30	return out, nil
31}
32
33type DescribeSessionsInput struct {
34
35	// The name of the fleet. This value is case-sensitive.
36	//
37	// This member is required.
38	FleetName *string
39
40	// The name of the stack. This value is case-sensitive.
41	//
42	// This member is required.
43	StackName *string
44
45	// The authentication method. Specify API for a user authenticated using a
46	// streaming URL or SAML for a SAML federated user. The default is to authenticate
47	// users using a streaming URL.
48	AuthenticationType types.AuthenticationType
49
50	// The size of each page of results. The default value is 20 and the maximum value
51	// is 50.
52	Limit *int32
53
54	// The pagination token to use to retrieve the next page of results for this
55	// operation. If this value is null, it retrieves the first page.
56	NextToken *string
57
58	// The user identifier (ID). If you specify a user ID, you must also specify the
59	// authentication type.
60	UserId *string
61}
62
63type DescribeSessionsOutput struct {
64
65	// The pagination token to use to retrieve the next page of results for this
66	// operation. If there are no more pages, this value is null.
67	NextToken *string
68
69	// Information about the streaming sessions.
70	Sessions []types.Session
71
72	// Metadata pertaining to the operation's result.
73	ResultMetadata middleware.Metadata
74}
75
76func addOperationDescribeSessionsMiddlewares(stack *middleware.Stack, options Options) (err error) {
77	err = stack.Serialize.Add(&awsAwsjson11_serializeOpDescribeSessions{}, middleware.After)
78	if err != nil {
79		return err
80	}
81	err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpDescribeSessions{}, 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 = addOpDescribeSessionsValidationMiddleware(stack); err != nil {
122		return err
123	}
124	if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDescribeSessions(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
139func newServiceMetadataMiddleware_opDescribeSessions(region string) *awsmiddleware.RegisterServiceMetadata {
140	return &awsmiddleware.RegisterServiceMetadata{
141		Region:        region,
142		ServiceID:     ServiceID,
143		SigningName:   "appstream",
144		OperationName: "DescribeSessions",
145	}
146}
147