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 archive.
16func (c *Client) DescribeArchive(ctx context.Context, params *DescribeArchiveInput, optFns ...func(*Options)) (*DescribeArchiveOutput, error) {
17	if params == nil {
18		params = &DescribeArchiveInput{}
19	}
20
21	result, metadata, err := c.invokeOperation(ctx, "DescribeArchive", params, optFns, addOperationDescribeArchiveMiddlewares)
22	if err != nil {
23		return nil, err
24	}
25
26	out := result.(*DescribeArchiveOutput)
27	out.ResultMetadata = metadata
28	return out, nil
29}
30
31type DescribeArchiveInput struct {
32
33	// The name of the archive to retrieve.
34	//
35	// This member is required.
36	ArchiveName *string
37}
38
39type DescribeArchiveOutput struct {
40
41	// The ARN of the archive.
42	ArchiveArn *string
43
44	// The name of the archive.
45	ArchiveName *string
46
47	// The time at which the archive was created.
48	CreationTime *time.Time
49
50	// The description of the archive.
51	Description *string
52
53	// The number of events in the archive.
54	EventCount int64
55
56	// The event pattern used to filter events sent to the archive.
57	EventPattern *string
58
59	// The ARN of the event source associated with the archive.
60	EventSourceArn *string
61
62	// The number of days to retain events for in the archive.
63	RetentionDays *int32
64
65	// The size of the archive in bytes.
66	SizeBytes int64
67
68	// The state of the archive.
69	State types.ArchiveState
70
71	// The reason that the archive is in the state.
72	StateReason *string
73
74	// Metadata pertaining to the operation's result.
75	ResultMetadata middleware.Metadata
76}
77
78func addOperationDescribeArchiveMiddlewares(stack *middleware.Stack, options Options) (err error) {
79	err = stack.Serialize.Add(&awsAwsjson11_serializeOpDescribeArchive{}, middleware.After)
80	if err != nil {
81		return err
82	}
83	err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpDescribeArchive{}, middleware.After)
84	if err != nil {
85		return err
86	}
87	if err = addSetLoggerMiddleware(stack, options); err != nil {
88		return err
89	}
90	if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
91		return err
92	}
93	if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
94		return err
95	}
96	if err = addResolveEndpointMiddleware(stack, options); err != nil {
97		return err
98	}
99	if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
100		return err
101	}
102	if err = addRetryMiddlewares(stack, options); err != nil {
103		return err
104	}
105	if err = addHTTPSignerV4Middleware(stack, options); err != nil {
106		return err
107	}
108	if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
109		return err
110	}
111	if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
112		return err
113	}
114	if err = addClientUserAgent(stack); err != nil {
115		return err
116	}
117	if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
118		return err
119	}
120	if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
121		return err
122	}
123	if err = addOpDescribeArchiveValidationMiddleware(stack); err != nil {
124		return err
125	}
126	if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDescribeArchive(options.Region), middleware.Before); err != nil {
127		return err
128	}
129	if err = addRequestIDRetrieverMiddleware(stack); err != nil {
130		return err
131	}
132	if err = addResponseErrorMiddleware(stack); err != nil {
133		return err
134	}
135	if err = addRequestResponseLogging(stack, options); err != nil {
136		return err
137	}
138	return nil
139}
140
141func newServiceMetadataMiddleware_opDescribeArchive(region string) *awsmiddleware.RegisterServiceMetadata {
142	return &awsmiddleware.RegisterServiceMetadata{
143		Region:        region,
144		ServiceID:     ServiceID,
145		SigningName:   "events",
146		OperationName: "DescribeArchive",
147	}
148}
149