1// Code generated by smithy-go-codegen DO NOT EDIT.
2
3package cloudwatchevents
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/cloudwatchevents/types"
10	"github.com/aws/smithy-go/middleware"
11	smithyhttp "github.com/aws/smithy-go/transport/http"
12	"time"
13)
14
15// Retrieves details about an API destination.
16func (c *Client) DescribeApiDestination(ctx context.Context, params *DescribeApiDestinationInput, optFns ...func(*Options)) (*DescribeApiDestinationOutput, error) {
17	if params == nil {
18		params = &DescribeApiDestinationInput{}
19	}
20
21	result, metadata, err := c.invokeOperation(ctx, "DescribeApiDestination", params, optFns, addOperationDescribeApiDestinationMiddlewares)
22	if err != nil {
23		return nil, err
24	}
25
26	out := result.(*DescribeApiDestinationOutput)
27	out.ResultMetadata = metadata
28	return out, nil
29}
30
31type DescribeApiDestinationInput struct {
32
33	// The name of the API destination to retrieve.
34	//
35	// This member is required.
36	Name *string
37}
38
39type DescribeApiDestinationOutput struct {
40
41	// The ARN of the API destination retrieved.
42	ApiDestinationArn *string
43
44	// The state of the API destination retrieved.
45	ApiDestinationState types.ApiDestinationState
46
47	// The ARN of the connection specified for the API destination retrieved.
48	ConnectionArn *string
49
50	// A time stamp for the time that the API destination was created.
51	CreationTime *time.Time
52
53	// The description for the API destination retrieved.
54	Description *string
55
56	// The method to use to connect to the HTTP endpoint.
57	HttpMethod types.ApiDestinationHttpMethod
58
59	// The URL to use to connect to the HTTP endpoint.
60	InvocationEndpoint *string
61
62	// The maximum number of invocations per second to specified for the API
63	// destination. Note that if you set the invocation rate maximum to a value lower
64	// the rate necessary to send all events received on to the destination HTTP
65	// endpoint, some events may not be delivered within the 24-hour retry window. If
66	// you plan to set the rate lower than the rate necessary to deliver all events,
67	// consider using a dead-letter queue to catch events that are not delivered within
68	// 24 hours.
69	InvocationRateLimitPerSecond *int32
70
71	// A time stamp for the time that the API destination was last modified.
72	LastModifiedTime *time.Time
73
74	// The name of the API destination retrieved.
75	Name *string
76
77	// Metadata pertaining to the operation's result.
78	ResultMetadata middleware.Metadata
79}
80
81func addOperationDescribeApiDestinationMiddlewares(stack *middleware.Stack, options Options) (err error) {
82	err = stack.Serialize.Add(&awsAwsjson11_serializeOpDescribeApiDestination{}, middleware.After)
83	if err != nil {
84		return err
85	}
86	err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpDescribeApiDestination{}, middleware.After)
87	if err != nil {
88		return err
89	}
90	if err = addSetLoggerMiddleware(stack, options); err != nil {
91		return err
92	}
93	if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
94		return err
95	}
96	if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
97		return err
98	}
99	if err = addResolveEndpointMiddleware(stack, options); err != nil {
100		return err
101	}
102	if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
103		return err
104	}
105	if err = addRetryMiddlewares(stack, options); err != nil {
106		return err
107	}
108	if err = addHTTPSignerV4Middleware(stack, options); err != nil {
109		return err
110	}
111	if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
112		return err
113	}
114	if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
115		return err
116	}
117	if err = addClientUserAgent(stack); err != nil {
118		return err
119	}
120	if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
121		return err
122	}
123	if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
124		return err
125	}
126	if err = addOpDescribeApiDestinationValidationMiddleware(stack); err != nil {
127		return err
128	}
129	if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDescribeApiDestination(options.Region), middleware.Before); err != nil {
130		return err
131	}
132	if err = addRequestIDRetrieverMiddleware(stack); err != nil {
133		return err
134	}
135	if err = addResponseErrorMiddleware(stack); err != nil {
136		return err
137	}
138	if err = addRequestResponseLogging(stack, options); err != nil {
139		return err
140	}
141	return nil
142}
143
144func newServiceMetadataMiddleware_opDescribeApiDestination(region string) *awsmiddleware.RegisterServiceMetadata {
145	return &awsmiddleware.RegisterServiceMetadata{
146		Region:        region,
147		ServiceID:     ServiceID,
148		SigningName:   "events",
149		OperationName: "DescribeApiDestination",
150	}
151}
152