-
Notifications
You must be signed in to change notification settings - Fork 571
/
GenerateDataSetCommand.ts
151 lines (140 loc) · 5.82 KB
/
GenerateDataSetCommand.ts
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
// smithy-typescript generated code
import { EndpointParameterInstructions, getEndpointPlugin } from "@aws-sdk/middleware-endpoint";
import { getSerdePlugin } from "@aws-sdk/middleware-serde";
import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@aws-sdk/protocol-http";
import { Command as $Command } from "@aws-sdk/smithy-client";
import {
FinalizeHandlerArguments,
Handler,
HandlerExecutionContext,
HttpHandlerOptions as __HttpHandlerOptions,
MetadataBearer as __MetadataBearer,
MiddlewareStack,
SerdeContext as __SerdeContext,
} from "@aws-sdk/types";
import {
MarketplaceCommerceAnalyticsClientResolvedConfig,
ServiceInputTypes,
ServiceOutputTypes,
} from "../MarketplaceCommerceAnalyticsClient";
import {
GenerateDataSetRequest,
GenerateDataSetRequestFilterSensitiveLog,
GenerateDataSetResult,
GenerateDataSetResultFilterSensitiveLog,
} from "../models/models_0";
import {
deserializeAws_json1_1GenerateDataSetCommand,
serializeAws_json1_1GenerateDataSetCommand,
} from "../protocols/Aws_json1_1";
/**
* @public
*
* The input for {@link GenerateDataSetCommand}.
*/
export interface GenerateDataSetCommandInput extends GenerateDataSetRequest {}
/**
* @public
*
* The output of {@link GenerateDataSetCommand}.
*/
export interface GenerateDataSetCommandOutput extends GenerateDataSetResult, __MetadataBearer {}
/**
* @public
* Given a data set type and data set publication date, asynchronously publishes the requested data set to the specified
* S3 bucket and notifies the specified SNS topic once the data is available. Returns a unique request identifier that
* can be used to correlate requests with notifications from the SNS topic.
* Data sets will be published in comma-separated values (CSV) format with the file name \{data_set_type\}_YYYY-MM-DD.csv.
* If a file with the same name already exists (e.g. if the same data set is requested twice), the original file will
* be overwritten by the new file.
* Requires a Role with an attached permissions policy providing Allow permissions for the following actions:
* s3:PutObject, s3:GetBucketLocation, sns:GetTopicAttributes, sns:Publish, iam:GetRolePolicy.
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
* import { MarketplaceCommerceAnalyticsClient, GenerateDataSetCommand } from "@aws-sdk/client-marketplace-commerce-analytics"; // ES Modules import
* // const { MarketplaceCommerceAnalyticsClient, GenerateDataSetCommand } = require("@aws-sdk/client-marketplace-commerce-analytics"); // CommonJS import
* const client = new MarketplaceCommerceAnalyticsClient(config);
* const command = new GenerateDataSetCommand(input);
* const response = await client.send(command);
* ```
*
* @param GenerateDataSetCommandInput - {@link GenerateDataSetCommandInput}
* @returns {@link GenerateDataSetCommandOutput}
* @see {@link GenerateDataSetCommandInput} for command's `input` shape.
* @see {@link GenerateDataSetCommandOutput} for command's `response` shape.
* @see {@link MarketplaceCommerceAnalyticsClientResolvedConfig | config} for MarketplaceCommerceAnalyticsClient's `config` shape.
*
* @throws {@link MarketplaceCommerceAnalyticsException} (server fault)
* This exception is thrown when an internal service error occurs.
*
*
*/
export class GenerateDataSetCommand extends $Command<
GenerateDataSetCommandInput,
GenerateDataSetCommandOutput,
MarketplaceCommerceAnalyticsClientResolvedConfig
> {
// Start section: command_properties
// End section: command_properties
public static getEndpointParameterInstructions(): EndpointParameterInstructions {
return {
UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" },
Endpoint: { type: "builtInParams", name: "endpoint" },
Region: { type: "builtInParams", name: "region" },
UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" },
};
}
/**
* @public
*/
constructor(readonly input: GenerateDataSetCommandInput) {
// Start section: command_constructor
super();
// End section: command_constructor
}
/**
* @internal
*/
resolveMiddleware(
clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
configuration: MarketplaceCommerceAnalyticsClientResolvedConfig,
options?: __HttpHandlerOptions
): Handler<GenerateDataSetCommandInput, GenerateDataSetCommandOutput> {
this.middlewareStack.use(getSerdePlugin(configuration, this.serialize, this.deserialize));
this.middlewareStack.use(
getEndpointPlugin(configuration, GenerateDataSetCommand.getEndpointParameterInstructions())
);
const stack = clientStack.concat(this.middlewareStack);
const { logger } = configuration;
const clientName = "MarketplaceCommerceAnalyticsClient";
const commandName = "GenerateDataSetCommand";
const handlerExecutionContext: HandlerExecutionContext = {
logger,
clientName,
commandName,
inputFilterSensitiveLog: GenerateDataSetRequestFilterSensitiveLog,
outputFilterSensitiveLog: GenerateDataSetResultFilterSensitiveLog,
};
const { requestHandler } = configuration;
return stack.resolve(
(request: FinalizeHandlerArguments<any>) =>
requestHandler.handle(request.request as __HttpRequest, options || {}),
handlerExecutionContext
);
}
/**
* @internal
*/
private serialize(input: GenerateDataSetCommandInput, context: __SerdeContext): Promise<__HttpRequest> {
return serializeAws_json1_1GenerateDataSetCommand(input, context);
}
/**
* @internal
*/
private deserialize(output: __HttpResponse, context: __SerdeContext): Promise<GenerateDataSetCommandOutput> {
return deserializeAws_json1_1GenerateDataSetCommand(output, context);
}
// Start section: command_body_extra
// End section: command_body_extra
}