1// Code generated by smithy-go-codegen DO NOT EDIT.
2
3package forecast
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/forecast/types"
10	"github.com/aws/smithy-go/middleware"
11	smithyhttp "github.com/aws/smithy-go/transport/http"
12	"time"
13)
14
15// Describes a dataset group created using the CreateDatasetGroup operation. In
16// addition to listing the parameters provided in the CreateDatasetGroup request,
17// this operation includes the following properties:
18//
19// * DatasetArns - The datasets
20// belonging to the group.
21//
22// * CreationTime
23//
24// * LastModificationTime
25//
26// * Status
27func (c *Client) DescribeDatasetGroup(ctx context.Context, params *DescribeDatasetGroupInput, optFns ...func(*Options)) (*DescribeDatasetGroupOutput, error) {
28	if params == nil {
29		params = &DescribeDatasetGroupInput{}
30	}
31
32	result, metadata, err := c.invokeOperation(ctx, "DescribeDatasetGroup", params, optFns, c.addOperationDescribeDatasetGroupMiddlewares)
33	if err != nil {
34		return nil, err
35	}
36
37	out := result.(*DescribeDatasetGroupOutput)
38	out.ResultMetadata = metadata
39	return out, nil
40}
41
42type DescribeDatasetGroupInput struct {
43
44	// The Amazon Resource Name (ARN) of the dataset group.
45	//
46	// This member is required.
47	DatasetGroupArn *string
48
49	noSmithyDocumentSerde
50}
51
52type DescribeDatasetGroupOutput struct {
53
54	// When the dataset group was created.
55	CreationTime *time.Time
56
57	// An array of Amazon Resource Names (ARNs) of the datasets contained in the
58	// dataset group.
59	DatasetArns []string
60
61	// The ARN of the dataset group.
62	DatasetGroupArn *string
63
64	// The name of the dataset group.
65	DatasetGroupName *string
66
67	// The domain associated with the dataset group.
68	Domain types.Domain
69
70	// When the dataset group was created or last updated from a call to the
71	// UpdateDatasetGroup operation. While the dataset group is being updated,
72	// LastModificationTime is the current time of the DescribeDatasetGroup call.
73	LastModificationTime *time.Time
74
75	// The status of the dataset group. States include:
76	//
77	// * ACTIVE
78	//
79	// * CREATE_PENDING,
80	// CREATE_IN_PROGRESS, CREATE_FAILED
81	//
82	// * DELETE_PENDING, DELETE_IN_PROGRESS,
83	// DELETE_FAILED
84	//
85	// * UPDATE_PENDING, UPDATE_IN_PROGRESS, UPDATE_FAILED
86	//
87	// The UPDATE
88	// states apply when you call the UpdateDatasetGroup operation. The Status of the
89	// dataset group must be ACTIVE before you can use the dataset group to create a
90	// predictor.
91	Status *string
92
93	// Metadata pertaining to the operation's result.
94	ResultMetadata middleware.Metadata
95
96	noSmithyDocumentSerde
97}
98
99func (c *Client) addOperationDescribeDatasetGroupMiddlewares(stack *middleware.Stack, options Options) (err error) {
100	err = stack.Serialize.Add(&awsAwsjson11_serializeOpDescribeDatasetGroup{}, middleware.After)
101	if err != nil {
102		return err
103	}
104	err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpDescribeDatasetGroup{}, middleware.After)
105	if err != nil {
106		return err
107	}
108	if err = addSetLoggerMiddleware(stack, options); err != nil {
109		return err
110	}
111	if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
112		return err
113	}
114	if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
115		return err
116	}
117	if err = addResolveEndpointMiddleware(stack, options); err != nil {
118		return err
119	}
120	if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
121		return err
122	}
123	if err = addRetryMiddlewares(stack, options); err != nil {
124		return err
125	}
126	if err = addHTTPSignerV4Middleware(stack, options); err != nil {
127		return err
128	}
129	if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
130		return err
131	}
132	if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
133		return err
134	}
135	if err = addClientUserAgent(stack); err != nil {
136		return err
137	}
138	if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
139		return err
140	}
141	if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
142		return err
143	}
144	if err = addOpDescribeDatasetGroupValidationMiddleware(stack); err != nil {
145		return err
146	}
147	if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDescribeDatasetGroup(options.Region), middleware.Before); err != nil {
148		return err
149	}
150	if err = addRequestIDRetrieverMiddleware(stack); err != nil {
151		return err
152	}
153	if err = addResponseErrorMiddleware(stack); err != nil {
154		return err
155	}
156	if err = addRequestResponseLogging(stack, options); err != nil {
157		return err
158	}
159	return nil
160}
161
162func newServiceMetadataMiddleware_opDescribeDatasetGroup(region string) *awsmiddleware.RegisterServiceMetadata {
163	return &awsmiddleware.RegisterServiceMetadata{
164		Region:        region,
165		ServiceID:     ServiceID,
166		SigningName:   "forecast",
167		OperationName: "DescribeDatasetGroup",
168	}
169}
170