import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { CreateCampaignRequest, CreateCampaignResponse } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; /** * @public * * The input for {@link CreateCampaignCommand}. */ export interface CreateCampaignCommandInput extends CreateCampaignRequest { } /** * @public * * The output of {@link CreateCampaignCommand}. */ export interface CreateCampaignCommandOutput extends CreateCampaignResponse, __MetadataBearer { } declare const CreateCampaignCommand_base: { new (input: CreateCampaignCommandInput): import("@smithy/core/client").CommandImpl; new (input: CreateCampaignCommandInput): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions; }; /** *

Creates an orchestration of data collection rules. The Amazon Web Services IoT FleetWise Edge Agent software * running in vehicles uses campaigns to decide how to collect and transfer data to the * cloud. You create campaigns in the cloud. After you or your team approve campaigns, * Amazon Web Services IoT FleetWise automatically deploys them to vehicles.

*

For more information, see Collect and transfer data * with campaigns in the Amazon Web Services IoT FleetWise Developer Guide.

* *

Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and feature availability in the Amazon Web Services IoT FleetWise Developer Guide.

*
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { IoTFleetWiseClient, CreateCampaignCommand } from "@aws-sdk/client-iotfleetwise"; // ES Modules import * // const { IoTFleetWiseClient, CreateCampaignCommand } = require("@aws-sdk/client-iotfleetwise"); // CommonJS import * // import type { IoTFleetWiseClientConfig } from "@aws-sdk/client-iotfleetwise"; * const config = {}; // type is IoTFleetWiseClientConfig * const client = new IoTFleetWiseClient(config); * const input = { // CreateCampaignRequest * name: "STRING_VALUE", // required * description: "STRING_VALUE", * signalCatalogArn: "STRING_VALUE", // required * targetArn: "STRING_VALUE", // required * startTime: new Date("TIMESTAMP"), * expiryTime: new Date("TIMESTAMP"), * postTriggerCollectionDuration: Number("long"), * diagnosticsMode: "OFF" || "SEND_ACTIVE_DTCS", * spoolingMode: "OFF" || "TO_DISK", * compression: "OFF" || "SNAPPY", * priority: Number("int"), * signalsToCollect: [ // SignalInformationList * { // SignalInformation * name: "STRING_VALUE", // required * maxSampleCount: Number("long"), * minimumSamplingIntervalMs: Number("long"), * dataPartitionId: "STRING_VALUE", * }, * ], * collectionScheme: { // CollectionScheme Union: only one key present * timeBasedCollectionScheme: { // TimeBasedCollectionScheme * periodMs: Number("long"), // required * }, * conditionBasedCollectionScheme: { // ConditionBasedCollectionScheme * expression: "STRING_VALUE", // required * minimumTriggerIntervalMs: Number("long"), * triggerMode: "ALWAYS" || "RISING_EDGE", * conditionLanguageVersion: Number("int"), * }, * }, * dataExtraDimensions: [ // DataExtraDimensionNodePathList * "STRING_VALUE", * ], * tags: [ // TagList * { // Tag * Key: "STRING_VALUE", // required * Value: "STRING_VALUE", // required * }, * ], * dataDestinationConfigs: [ // DataDestinationConfigs * { // DataDestinationConfig Union: only one key present * s3Config: { // S3Config * bucketArn: "STRING_VALUE", // required * dataFormat: "JSON" || "PARQUET", * storageCompressionFormat: "NONE" || "GZIP", * prefix: "STRING_VALUE", * }, * timestreamConfig: { // TimestreamConfig * timestreamTableArn: "STRING_VALUE", // required * executionRoleArn: "STRING_VALUE", // required * }, * mqttTopicConfig: { // MqttTopicConfig * mqttTopicArn: "STRING_VALUE", // required * executionRoleArn: "STRING_VALUE", // required * }, * }, * ], * dataPartitions: [ // DataPartitions * { // DataPartition * id: "STRING_VALUE", // required * storageOptions: { // DataPartitionStorageOptions * maximumSize: { // StorageMaximumSize * unit: "MB" || "GB" || "TB", // required * value: Number("int"), // required * }, * storageLocation: "STRING_VALUE", // required * minimumTimeToLive: { // StorageMinimumTimeToLive * unit: "HOURS" || "DAYS" || "WEEKS", // required * value: Number("int"), // required * }, * }, * uploadOptions: { // DataPartitionUploadOptions * expression: "STRING_VALUE", // required * conditionLanguageVersion: Number("int"), * }, * }, * ], * signalsToFetch: [ // SignalFetchInformationList * { // SignalFetchInformation * fullyQualifiedName: "STRING_VALUE", // required * signalFetchConfig: { // SignalFetchConfig Union: only one key present * timeBased: { // TimeBasedSignalFetchConfig * executionFrequencyMs: Number("long"), // required * }, * conditionBased: { // ConditionBasedSignalFetchConfig * conditionExpression: "STRING_VALUE", // required * triggerMode: "ALWAYS" || "RISING_EDGE", // required * }, * }, * conditionLanguageVersion: Number("int"), * actions: [ // EventExpressionList // required * "STRING_VALUE", * ], * }, * ], * }; * const command = new CreateCampaignCommand(input); * const response = await client.send(command); * // { // CreateCampaignResponse * // name: "STRING_VALUE", * // arn: "STRING_VALUE", * // }; * * ``` * * @param CreateCampaignCommandInput - {@link CreateCampaignCommandInput} * @returns {@link CreateCampaignCommandOutput} * @see {@link CreateCampaignCommandInput} for command's `input` shape. * @see {@link CreateCampaignCommandOutput} for command's `response` shape. * @see {@link IoTFleetWiseClientResolvedConfig | config} for IoTFleetWiseClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) *

You don't have sufficient permission to perform this action.

* * @throws {@link ConflictException} (client fault) *

The request has conflicting operations. This can occur if you're trying to perform * more than one operation on the same resource at the same time.

* * @throws {@link LimitExceededException} (client fault) *

A service quota was exceeded.

* * @throws {@link ResourceNotFoundException} (client fault) *

The resource wasn't found.

* * @throws {@link ThrottlingException} (client fault) *

The request couldn't be completed due to throttling.

* * @throws {@link ValidationException} (client fault) *

The input fails to satisfy the constraints specified by an Amazon Web Services service.

* * @throws {@link InternalServerException} (server fault) *

The request couldn't be completed because the server temporarily failed.

* * @throws {@link IoTFleetWiseServiceException} *

Base exception class for all service exceptions from IoTFleetWise service.

* * * @public */ export declare class CreateCampaignCommand extends CreateCampaignCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: CreateCampaignRequest; output: CreateCampaignResponse; }; sdk: { input: CreateCampaignCommandInput; output: CreateCampaignCommandOutput; }; }; }