campaigns

Creates, updates, deletes or gets a campaign resource or lists campaigns in a region

Overview

Name	campaigns
Type	Resource
Description	Definition of AWS::IoTFleetWise::Campaign Resource Type
Id	aws.iotfleetwise.campaigns

Fields

Name	Datatype	Description
status	string
action	string
creation_time	string
compression	string
description	string
priority	integer
signals_to_collect	array
data_destination_configs	array
start_time	string
name	string
expiry_time	string
last_modification_time	string
spooling_mode	string
signal_catalog_arn	string
post_trigger_collection_duration	number
data_extra_dimensions	array
diagnostics_mode	string
target_arn	string
arn	string
collection_scheme	undefined
tags	array
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	Name, Action, CollectionScheme, SignalCatalogArn, TargetArn, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all campaigns in a region.

SELECT
region,
status,
action,
creation_time,
compression,
description,
priority,
signals_to_collect,
data_destination_configs,
start_time,
name,
expiry_time,
last_modification_time,
spooling_mode,
signal_catalog_arn,
post_trigger_collection_duration,
data_extra_dimensions,
diagnostics_mode,
target_arn,
arn,
collection_scheme,
tags
FROM aws.iotfleetwise.campaigns
WHERE region = 'us-east-1';

Gets all properties from an individual campaign.

SELECT
region,
status,
action,
creation_time,
compression,
description,
priority,
signals_to_collect,
data_destination_configs,
start_time,
name,
expiry_time,
last_modification_time,
spooling_mode,
signal_catalog_arn,
post_trigger_collection_duration,
data_extra_dimensions,
diagnostics_mode,
target_arn,
arn,
collection_scheme,
tags
FROM aws.iotfleetwise.campaigns
WHERE region = 'us-east-1' AND data__Identifier = '<Name>';

INSERT example

Use the following StackQL query and manifest file to create a new campaign resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.iotfleetwise.campaigns (
 Action,
 Name,
 SignalCatalogArn,
 TargetArn,
 CollectionScheme,
 region
)
SELECT 
'{{ Action }}',
 '{{ Name }}',
 '{{ SignalCatalogArn }}',
 '{{ TargetArn }}',
 '{{ CollectionScheme }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.iotfleetwise.campaigns (
 Action,
 Compression,
 Description,
 Priority,
 SignalsToCollect,
 DataDestinationConfigs,
 StartTime,
 Name,
 ExpiryTime,
 SpoolingMode,
 SignalCatalogArn,
 PostTriggerCollectionDuration,
 DataExtraDimensions,
 DiagnosticsMode,
 TargetArn,
 CollectionScheme,
 Tags,
 region
)
SELECT 
 '{{ Action }}',
 '{{ Compression }}',
 '{{ Description }}',
 '{{ Priority }}',
 '{{ SignalsToCollect }}',
 '{{ DataDestinationConfigs }}',
 '{{ StartTime }}',
 '{{ Name }}',
 '{{ ExpiryTime }}',
 '{{ SpoolingMode }}',
 '{{ SignalCatalogArn }}',
 '{{ PostTriggerCollectionDuration }}',
 '{{ DataExtraDimensions }}',
 '{{ DiagnosticsMode }}',
 '{{ TargetArn }}',
 '{{ CollectionScheme }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: campaign
    props:
      - name: Action
        value: '{{ Action }}'
      - name: Compression
        value: '{{ Compression }}'
      - name: Description
        value: '{{ Description }}'
      - name: Priority
        value: '{{ Priority }}'
      - name: SignalsToCollect
        value:
          - MaxSampleCount: null
            Name: '{{ Name }}'
            MinimumSamplingIntervalMs: null
      - name: DataDestinationConfigs
        value:
          - null
      - name: StartTime
        value: '{{ StartTime }}'
      - name: Name
        value: '{{ Name }}'
      - name: ExpiryTime
        value: '{{ ExpiryTime }}'
      - name: SpoolingMode
        value: '{{ SpoolingMode }}'
      - name: SignalCatalogArn
        value: '{{ SignalCatalogArn }}'
      - name: PostTriggerCollectionDuration
        value: null
      - name: DataExtraDimensions
        value:
          - '{{ DataExtraDimensions[0] }}'
      - name: DiagnosticsMode
        value: '{{ DiagnosticsMode }}'
      - name: TargetArn
        value: '{{ TargetArn }}'
      - name: CollectionScheme
        value: null
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.iotfleetwise.campaigns
WHERE data__Identifier = '<Name>'
AND region = 'us-east-1';

Permissions

To operate on the campaigns resource, the following permissions are required:

Read

iotfleetwise:GetCampaign,
iotfleetwise:ListTagsForResource

Create

iotfleetwise:CreateCampaign,
iotfleetwise:GetCampaign,
iotfleetwise:ListTagsForResource,
iotfleetwise:TagResource,
iam:PassRole,
timestream:DescribeEndpoints,
timestream:DescribeTable

Update

iotfleetwise:GetCampaign,
iotfleetwise:ListTagsForResource,
iotfleetwise:UpdateCampaign,
iotfleetwise:TagResource,
iotfleetwise:UntagResource

List

iotfleetwise:ListCampaigns,
iotfleetwise:GetCampaign

Delete

iotfleetwise:DeleteCampaign,
iotfleetwise:GetCampaign