import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { GetCampaignRequest, GetCampaignResponse } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; /** * @public * * The input for {@link GetCampaignCommand}. */ export interface GetCampaignCommandInput extends GetCampaignRequest { } /** * @public * * The output of {@link GetCampaignCommand}. */ export interface GetCampaignCommandOutput extends GetCampaignResponse, __MetadataBearer { } declare const GetCampaignCommand_base: { new (input: GetCampaignCommandInput): import("@smithy/core/client").CommandImpl; new (input: GetCampaignCommandInput): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions; }; /** *

Retrieves information about a campaign.

* *

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, GetCampaignCommand } from "@aws-sdk/client-iotfleetwise"; // ES Modules import * // const { IoTFleetWiseClient, GetCampaignCommand } = 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 = { // GetCampaignRequest * name: "STRING_VALUE", // required * }; * const command = new GetCampaignCommand(input); * const response = await client.send(command); * // { // GetCampaignResponse * // name: "STRING_VALUE", * // arn: "STRING_VALUE", * // description: "STRING_VALUE", * // signalCatalogArn: "STRING_VALUE", * // targetArn: "STRING_VALUE", * // status: "CREATING" || "WAITING_FOR_APPROVAL" || "RUNNING" || "SUSPENDED", * // 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", * // ], * // creationTime: new Date("TIMESTAMP"), * // lastModificationTime: new Date("TIMESTAMP"), * // 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", * // ], * // }, * // ], * // }; * * ``` * * @param GetCampaignCommandInput - {@link GetCampaignCommandInput} * @returns {@link GetCampaignCommandOutput} * @see {@link GetCampaignCommandInput} for command's `input` shape. * @see {@link GetCampaignCommandOutput} 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 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 GetCampaignCommand extends GetCampaignCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: GetCampaignRequest; output: GetCampaignResponse; }; sdk: { input: GetCampaignCommandInput; output: GetCampaignCommandOutput; }; }; }