1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package lookoutequipment
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/service/lookoutequipment/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
"time"
)
// Provides a JSON description of the data in each time series dataset, including
// names, column names, and data types.
func (c *Client) DescribeDataset(ctx context.Context, params *DescribeDatasetInput, optFns ...func(*Options)) (*DescribeDatasetOutput, error) {
if params == nil {
params = &DescribeDatasetInput{}
}
result, metadata, err := c.invokeOperation(ctx, "DescribeDataset", params, optFns, c.addOperationDescribeDatasetMiddlewares)
if err != nil {
return nil, err
}
out := result.(*DescribeDatasetOutput)
out.ResultMetadata = metadata
return out, nil
}
type DescribeDatasetInput struct {
// The name of the dataset to be described.
//
// This member is required.
DatasetName *string
noSmithyDocumentSerde
}
type DescribeDatasetOutput struct {
// Specifies the time the dataset was created in Lookout for Equipment.
CreatedAt *time.Time
// Indicates the latest timestamp corresponding to data that was successfully
// ingested during the most recent ingestion of this particular dataset.
DataEndTime *time.Time
// Gives statistics associated with the given dataset for the latest successful
// associated ingestion job id. These statistics primarily relate to quantifying
// incorrect data such as MissingCompleteSensorData, MissingSensorData,
// UnsupportedDateFormats, InsufficientSensorData, and DuplicateTimeStamps.
DataQualitySummary *types.DataQualitySummary
// Indicates the earliest timestamp corresponding to data that was successfully
// ingested during the most recent ingestion of this particular dataset.
DataStartTime *time.Time
// The Amazon Resource Name (ARN) of the dataset being described.
DatasetArn *string
// The name of the dataset being described.
DatasetName *string
// IngestedFilesSummary associated with the given dataset for the latest
// successful associated ingestion job id.
IngestedFilesSummary *types.IngestedFilesSummary
// Specifies the S3 location configuration for the data input for the data
// ingestion job.
IngestionInputConfiguration *types.IngestionInputConfiguration
// Specifies the time the dataset was last updated, if it was.
LastUpdatedAt *time.Time
// The Amazon Resource Name (ARN) of the IAM role that you are using for this the
// data ingestion job.
RoleArn *string
// A JSON description of the data that is in each time series dataset, including
// names, column names, and data types.
//
// This value conforms to the media type: application/json
Schema *string
// Provides the identifier of the KMS key used to encrypt dataset data by Amazon
// Lookout for Equipment.
ServerSideKmsKeyId *string
// The Amazon Resource Name (ARN) of the source dataset from which the current
// data being described was imported from.
SourceDatasetArn *string
// Indicates the status of the dataset.
Status types.DatasetStatus
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationDescribeDatasetMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsAwsjson10_serializeOpDescribeDataset{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsAwsjson10_deserializeOpDescribeDataset{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "DescribeDataset"); err != nil {
return fmt.Errorf("add protocol finalizers: %v", err)
}
if err = addlegacyEndpointContextSetter(stack, options); err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = addClientRequestID(stack); err != nil {
return err
}
if err = addComputeContentLength(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = addComputePayloadSHA256(stack); err != nil {
return err
}
if err = addRetry(stack, options); err != nil {
return err
}
if err = addRawResponseToMetadata(stack); err != nil {
return err
}
if err = addRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack, options); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addSetLegacyContextSigningOptionsMiddleware(stack); err != nil {
return err
}
if err = addTimeOffsetBuild(stack, c); err != nil {
return err
}
if err = addUserAgentRetryMode(stack, options); err != nil {
return err
}
if err = addOpDescribeDatasetValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDescribeDataset(options.Region), middleware.Before); err != nil {
return err
}
if err = addRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
if err = addDisableHTTPSMiddleware(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opDescribeDataset(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "DescribeDataset",
}
}
|