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, 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
50type DescribeDatasetGroupOutput struct {
51
52	// When the dataset group was created.
53	CreationTime *time.Time
54
55	// An array of Amazon Resource Names (ARNs) of the datasets contained in the
56	// dataset group.
57	DatasetArns []string
58
59	// The ARN of the dataset group.
60	DatasetGroupArn *string
61
62	// The name of the dataset group.
63	DatasetGroupName *string
64
65	// The domain associated with the dataset group.
66	Domain types.Domain
67
68	// When the dataset group was created or last updated from a call to the
69	// UpdateDatasetGroup operation. While the dataset group is being updated,
70	// LastModificationTime is the current time of the DescribeDatasetGroup call.
71	LastModificationTime *time.Time
72
73	// The status of the dataset group. States include:
74	//
75	// * ACTIVE
76	//
77	// * CREATE_PENDING,
78	// CREATE_IN_PROGRESS, CREATE_FAILED
79	//
80	// * DELETE_PENDING, DELETE_IN_PROGRESS,
81	// DELETE_FAILED
82	//
83	// * UPDATE_PENDING, UPDATE_IN_PROGRESS, UPDATE_FAILED
84	//
85	// The UPDATE
86	// states apply when you call the UpdateDatasetGroup operation. The Status of the
87	// dataset group must be ACTIVE before you can use the dataset group to create a
88	// predictor.
89	Status *string
90
91	// Metadata pertaining to the operation's result.
92	ResultMetadata middleware.Metadata
93}
94
95func addOperationDescribeDatasetGroupMiddlewares(stack *middleware.Stack, options Options) (err error) {
96	err = stack.Serialize.Add(&awsAwsjson11_serializeOpDescribeDatasetGroup{}, middleware.After)
97	if err != nil {
98		return err
99	}
100	err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpDescribeDatasetGroup{}, middleware.After)
101	if err != nil {
102		return err
103	}
104	if err = addSetLoggerMiddleware(stack, options); err != nil {
105		return err
106	}
107	if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
108		return err
109	}
110	if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
111		return err
112	}
113	if err = addResolveEndpointMiddleware(stack, options); err != nil {
114		return err
115	}
116	if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
117		return err
118	}
119	if err = addRetryMiddlewares(stack, options); err != nil {
120		return err
121	}
122	if err = addHTTPSignerV4Middleware(stack, options); err != nil {
123		return err
124	}
125	if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
126		return err
127	}
128	if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
129		return err
130	}
131	if err = addClientUserAgent(stack); err != nil {
132		return err
133	}
134	if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
135		return err
136	}
137	if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
138		return err
139	}
140	if err = addOpDescribeDatasetGroupValidationMiddleware(stack); err != nil {
141		return err
142	}
143	if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDescribeDatasetGroup(options.Region), middleware.Before); err != nil {
144		return err
145	}
146	if err = addRequestIDRetrieverMiddleware(stack); err != nil {
147		return err
148	}
149	if err = addResponseErrorMiddleware(stack); err != nil {
150		return err
151	}
152	if err = addRequestResponseLogging(stack, options); err != nil {
153		return err
154	}
155	return nil
156}
157
158func newServiceMetadataMiddleware_opDescribeDatasetGroup(region string) *awsmiddleware.RegisterServiceMetadata {
159	return &awsmiddleware.RegisterServiceMetadata{
160		Region:        region,
161		ServiceID:     ServiceID,
162		SigningName:   "forecast",
163		OperationName: "DescribeDatasetGroup",
164	}
165}
166