1// Code generated by smithy-go-codegen DO NOT EDIT.
2
3package location
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/location/types"
10	"github.com/aws/smithy-go/middleware"
11	smithyhttp "github.com/aws/smithy-go/transport/http"
12	"time"
13)
14
15// Retrieves the geofence details from a geofence collection.
16func (c *Client) GetGeofence(ctx context.Context, params *GetGeofenceInput, optFns ...func(*Options)) (*GetGeofenceOutput, error) {
17	if params == nil {
18		params = &GetGeofenceInput{}
19	}
20
21	result, metadata, err := c.invokeOperation(ctx, "GetGeofence", params, optFns, addOperationGetGeofenceMiddlewares)
22	if err != nil {
23		return nil, err
24	}
25
26	out := result.(*GetGeofenceOutput)
27	out.ResultMetadata = metadata
28	return out, nil
29}
30
31type GetGeofenceInput struct {
32
33	// The geofence collection storing the target geofence.
34	//
35	// This member is required.
36	CollectionName *string
37
38	// The geofence you're retrieving details for.
39	//
40	// This member is required.
41	GeofenceId *string
42}
43
44type GetGeofenceOutput struct {
45
46	// The timestamp for when the geofence collection was created in ISO 8601
47	// (https://www.iso.org/iso-8601-date-and-time-format.html) format:
48	// YYYY-MM-DDThh:mm:ss.sssZ
49	//
50	// This member is required.
51	CreateTime *time.Time
52
53	// The geofence identifier.
54	//
55	// This member is required.
56	GeofenceId *string
57
58	// Contains the geofence geometry details describing a polygon.
59	//
60	// This member is required.
61	Geometry *types.GeofenceGeometry
62
63	// Identifies the state of the geofence. A geofence will hold one of the following
64	// states:
65	//
66	// * ACTIVE — The geofence has been indexed by the system.
67	//
68	// * PENDING —
69	// The geofence is being processed by the system.
70	//
71	// * FAILED — The geofence failed
72	// to be indexed by the system.
73	//
74	// * DELETED — The geofence has been deleted from the
75	// system index.
76	//
77	// * DELETING — The geofence is being deleted from the system index.
78	//
79	// This member is required.
80	Status *string
81
82	// The timestamp for when the geofence collection was last updated in ISO 8601
83	// (https://www.iso.org/iso-8601-date-and-time-format.html) format:
84	// YYYY-MM-DDThh:mm:ss.sssZ
85	//
86	// This member is required.
87	UpdateTime *time.Time
88
89	// Metadata pertaining to the operation's result.
90	ResultMetadata middleware.Metadata
91}
92
93func addOperationGetGeofenceMiddlewares(stack *middleware.Stack, options Options) (err error) {
94	err = stack.Serialize.Add(&awsRestjson1_serializeOpGetGeofence{}, middleware.After)
95	if err != nil {
96		return err
97	}
98	err = stack.Deserialize.Add(&awsRestjson1_deserializeOpGetGeofence{}, middleware.After)
99	if err != nil {
100		return err
101	}
102	if err = addSetLoggerMiddleware(stack, options); err != nil {
103		return err
104	}
105	if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
106		return err
107	}
108	if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
109		return err
110	}
111	if err = addResolveEndpointMiddleware(stack, options); err != nil {
112		return err
113	}
114	if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
115		return err
116	}
117	if err = addRetryMiddlewares(stack, options); err != nil {
118		return err
119	}
120	if err = addHTTPSignerV4Middleware(stack, options); err != nil {
121		return err
122	}
123	if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
124		return err
125	}
126	if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
127		return err
128	}
129	if err = addClientUserAgent(stack); err != nil {
130		return err
131	}
132	if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
133		return err
134	}
135	if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
136		return err
137	}
138	if err = addOpGetGeofenceValidationMiddleware(stack); err != nil {
139		return err
140	}
141	if err = addRequestIDRetrieverMiddleware(stack); err != nil {
142		return err
143	}
144	if err = addResponseErrorMiddleware(stack); err != nil {
145		return err
146	}
147	if err = addRequestResponseLogging(stack, options); err != nil {
148		return err
149	}
150	return nil
151}
152