1// Code generated by smithy-go-codegen DO NOT EDIT.
2
3package sns
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/smithy-go/middleware"
10	smithyhttp "github.com/aws/smithy-go/transport/http"
11)
12
13// Retrieves the endpoint attributes for a device on one of the supported push
14// notification services, such as GCM (Firebase Cloud Messaging) and APNS. For more
15// information, see Using Amazon SNS Mobile Push Notifications
16// (https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html).
17func (c *Client) GetEndpointAttributes(ctx context.Context, params *GetEndpointAttributesInput, optFns ...func(*Options)) (*GetEndpointAttributesOutput, error) {
18	if params == nil {
19		params = &GetEndpointAttributesInput{}
20	}
21
22	result, metadata, err := c.invokeOperation(ctx, "GetEndpointAttributes", params, optFns, addOperationGetEndpointAttributesMiddlewares)
23	if err != nil {
24		return nil, err
25	}
26
27	out := result.(*GetEndpointAttributesOutput)
28	out.ResultMetadata = metadata
29	return out, nil
30}
31
32// Input for GetEndpointAttributes action.
33type GetEndpointAttributesInput struct {
34
35	// EndpointArn for GetEndpointAttributes input.
36	//
37	// This member is required.
38	EndpointArn *string
39}
40
41// Response from GetEndpointAttributes of the EndpointArn.
42type GetEndpointAttributesOutput struct {
43
44	// Attributes include the following:
45	//
46	// * CustomUserData – arbitrary user data to
47	// associate with the endpoint. Amazon SNS does not use this data. The data must be
48	// in UTF-8 format and less than 2KB.
49	//
50	// * Enabled – flag that enables/disables
51	// delivery to the endpoint. Amazon SNS will set this to false when a notification
52	// service indicates to Amazon SNS that the endpoint is invalid. Users can set it
53	// back to true, typically after updating Token.
54	//
55	// * Token – device token, also
56	// referred to as a registration id, for an app and mobile device. This is returned
57	// from the notification service when an app and mobile device are registered with
58	// the notification service. The device token for the iOS platform is returned in
59	// lowercase.
60	Attributes map[string]string
61
62	// Metadata pertaining to the operation's result.
63	ResultMetadata middleware.Metadata
64}
65
66func addOperationGetEndpointAttributesMiddlewares(stack *middleware.Stack, options Options) (err error) {
67	err = stack.Serialize.Add(&awsAwsquery_serializeOpGetEndpointAttributes{}, middleware.After)
68	if err != nil {
69		return err
70	}
71	err = stack.Deserialize.Add(&awsAwsquery_deserializeOpGetEndpointAttributes{}, middleware.After)
72	if err != nil {
73		return err
74	}
75	if err = addSetLoggerMiddleware(stack, options); err != nil {
76		return err
77	}
78	if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
79		return err
80	}
81	if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
82		return err
83	}
84	if err = addResolveEndpointMiddleware(stack, options); err != nil {
85		return err
86	}
87	if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
88		return err
89	}
90	if err = addRetryMiddlewares(stack, options); err != nil {
91		return err
92	}
93	if err = addHTTPSignerV4Middleware(stack, options); err != nil {
94		return err
95	}
96	if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
97		return err
98	}
99	if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
100		return err
101	}
102	if err = addClientUserAgent(stack); err != nil {
103		return err
104	}
105	if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
106		return err
107	}
108	if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
109		return err
110	}
111	if err = addOpGetEndpointAttributesValidationMiddleware(stack); err != nil {
112		return err
113	}
114	if err = stack.Initialize.Add(newServiceMetadataMiddleware_opGetEndpointAttributes(options.Region), middleware.Before); err != nil {
115		return err
116	}
117	if err = addRequestIDRetrieverMiddleware(stack); err != nil {
118		return err
119	}
120	if err = addResponseErrorMiddleware(stack); err != nil {
121		return err
122	}
123	if err = addRequestResponseLogging(stack, options); err != nil {
124		return err
125	}
126	return nil
127}
128
129func newServiceMetadataMiddleware_opGetEndpointAttributes(region string) *awsmiddleware.RegisterServiceMetadata {
130	return &awsmiddleware.RegisterServiceMetadata{
131		Region:        region,
132		ServiceID:     ServiceID,
133		SigningName:   "sns",
134		OperationName: "GetEndpointAttributes",
135	}
136}
137