1// Code generated by smithy-go-codegen DO NOT EDIT.
2
3package gamelift
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/gamelift/types"
10	"github.com/aws/smithy-go/middleware"
11	smithyhttp "github.com/aws/smithy-go/transport/http"
12)
13
14// Retrieves one or more matchmaking tickets. Use this operation to retrieve ticket
15// information, including--after a successful match is made--connection information
16// for the resulting new game session. To request matchmaking tickets, provide a
17// list of up to 10 ticket IDs. If the request is successful, a ticket object is
18// returned for each requested ID that currently exists. This operation is not
19// designed to be continually called to track matchmaking ticket status. This
20// practice can cause you to exceed your API limit, which results in errors.
21// Instead, as a best practice, set up an Amazon Simple Notification Service (SNS)
22// to receive notifications, and provide the topic ARN in the matchmaking
23// configuration. Continuously poling ticket status with DescribeMatchmaking should
24// only be used for games in development with low matchmaking usage. Learn more
25// Add FlexMatch to a game client
26// (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-client.html)
27// Set Up FlexMatch event notification
28// (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-notification.html)
29// Related actions StartMatchmaking | DescribeMatchmaking | StopMatchmaking |
30// AcceptMatch | StartMatchBackfill | All APIs by task
31// (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets)
32func (c *Client) DescribeMatchmaking(ctx context.Context, params *DescribeMatchmakingInput, optFns ...func(*Options)) (*DescribeMatchmakingOutput, error) {
33	if params == nil {
34		params = &DescribeMatchmakingInput{}
35	}
36
37	result, metadata, err := c.invokeOperation(ctx, "DescribeMatchmaking", params, optFns, addOperationDescribeMatchmakingMiddlewares)
38	if err != nil {
39		return nil, err
40	}
41
42	out := result.(*DescribeMatchmakingOutput)
43	out.ResultMetadata = metadata
44	return out, nil
45}
46
47// Represents the input for a request operation.
48type DescribeMatchmakingInput struct {
49
50	// A unique identifier for a matchmaking ticket. You can include up to 10 ID
51	// values.
52	//
53	// This member is required.
54	TicketIds []string
55}
56
57// Represents the returned data in response to a request operation.
58type DescribeMatchmakingOutput struct {
59
60	// A collection of existing matchmaking ticket objects matching the request.
61	TicketList []types.MatchmakingTicket
62
63	// Metadata pertaining to the operation's result.
64	ResultMetadata middleware.Metadata
65}
66
67func addOperationDescribeMatchmakingMiddlewares(stack *middleware.Stack, options Options) (err error) {
68	err = stack.Serialize.Add(&awsAwsjson11_serializeOpDescribeMatchmaking{}, middleware.After)
69	if err != nil {
70		return err
71	}
72	err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpDescribeMatchmaking{}, 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 = addOpDescribeMatchmakingValidationMiddleware(stack); err != nil {
113		return err
114	}
115	if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDescribeMatchmaking(options.Region), middleware.Before); err != nil {
116		return err
117	}
118	if err = addRequestIDRetrieverMiddleware(stack); err != nil {
119		return err
120	}
121	if err = addResponseErrorMiddleware(stack); err != nil {
122		return err
123	}
124	if err = addRequestResponseLogging(stack, options); err != nil {
125		return err
126	}
127	return nil
128}
129
130func newServiceMetadataMiddleware_opDescribeMatchmaking(region string) *awsmiddleware.RegisterServiceMetadata {
131	return &awsmiddleware.RegisterServiceMetadata{
132		Region:        region,
133		ServiceID:     ServiceID,
134		SigningName:   "gamelift",
135		OperationName: "DescribeMatchmaking",
136	}
137}
138