GetCampaignResponse ¶

class GetCampaignResponse(TypedDict, closed=True):
    name: NotRequired["capo_iotfleetwise.types.campaign_name.campaignName"]
    """<p>The name of the campaign.</p>"""
    arn: NotRequired["capo_iotfleetwise.types.campaign_arn.campaignArn"]
    """<p> The Amazon Resource Name (ARN) of the campaign. </p>"""
    description: NotRequired["capo_iotfleetwise.types.description.description"]
    """<p>The description of the campaign.</p>"""
    signal_catalog_arn: NotRequired["capo_iotfleetwise.types.arn.arn"]
    """<p> The ARN of a signal catalog. </p>"""
    target_arn: NotRequired["capo_iotfleetwise.types.arn.arn"]
    """<p> The ARN of the vehicle or the fleet targeted by the campaign. </p>"""
    status: NotRequired["capo_iotfleetwise.types.campaign_status.CampaignStatus"]
    """<p>The state of the campaign. The status can be one of: <code>CREATING</code>, <code>WAITING_FOR_APPROVAL</code>, <code>RUNNING</code>, and <code>SUSPENDED</code>. </p>"""
    start_time: NotRequired["capo_iotfleetwise.types.timestamp.timestamp"]
    """<p> The time, in milliseconds, to deliver a campaign after it was approved.</p>"""
    expiry_time: NotRequired["capo_iotfleetwise.types.timestamp.timestamp"]
    """<p> The time the campaign expires, in seconds since epoch (January 1, 1970 at midnight UTC time). Vehicle data won't be collected after the campaign expires.</p>"""
    post_trigger_collection_duration: NotRequired[
        "capo_iotfleetwise.types.uint32.uint32"
    ]
    """<p> How long (in seconds) to collect raw data after a triggering event initiates the collection. </p>"""
    diagnostics_mode: NotRequired[
        "capo_iotfleetwise.types.diagnostics_mode.DiagnosticsMode"
    ]
    """<p> Option for a vehicle to send diagnostic trouble codes to Amazon Web Services IoT FleetWise. </p>"""
    spooling_mode: NotRequired["capo_iotfleetwise.types.spooling_mode.SpoolingMode"]
    """<p> Whether to store collected data after a vehicle lost a connection with the cloud. After a connection is re-established, the data is automatically forwarded to Amazon Web Services IoT FleetWise. </p>"""
    compression: NotRequired["capo_iotfleetwise.types.compression.Compression"]
    """<p> Whether to compress signals before transmitting data to Amazon Web Services IoT FleetWise. If <code>OFF</code> is specified, the signals aren't compressed. If it's not specified, <code>SNAPPY</code> is used. </p>"""
    priority: NotRequired["capo_iotfleetwise.types.priority.priority"]
    """<p> A number indicating the priority of one campaign over another campaign for a certain vehicle or fleet. A campaign with the lowest value is deployed to vehicles before any other campaigns.</p>"""
    signals_to_collect: NotRequired[
        "capo_iotfleetwise.types.signal_information_list.SignalInformationList"
    ]
    """<p> Information about a list of signals to collect data on. </p>"""
    collection_scheme: NotRequired[
        "capo_iotfleetwise.types.collection_scheme.CollectionScheme"
    ]
    """<p> Information about the data collection scheme associated with the campaign. </p>"""
    data_extra_dimensions: NotRequired[
        "capo_iotfleetwise.types.data_extra_dimension_node_path_list.DataExtraDimensionNodePathList"
    ]
    """<p> A list of vehicle attributes associated with the campaign. </p>"""
    creation_time: NotRequired["capo_iotfleetwise.types.timestamp.timestamp"]
    """<p> The time the campaign was created in seconds since epoch (January 1, 1970 at midnight UTC time). </p>"""
    last_modification_time: NotRequired["capo_iotfleetwise.types.timestamp.timestamp"]
    """<p>The last time the campaign was modified.</p>"""
    data_destination_configs: NotRequired[
        "capo_iotfleetwise.types.data_destination_configs.DataDestinationConfigs"
    ]
    """<p>The destination where the campaign sends data. You can send data to an MQTT topic, or store it in Amazon S3 or Amazon Timestream.</p> <p>MQTT is the publish/subscribe messaging protocol used by Amazon Web Services IoT to communicate with your devices.</p> <p>Amazon S3 optimizes the cost of data storage and provides additional mechanisms to use vehicle data, such as data lakes, centralized data storage, data processing pipelines, and analytics. </p> <p>You can use Amazon Timestream to access and analyze time series data, and Timestream to query vehicle data so that you can identify trends and patterns.</p>"""
    data_partitions: NotRequired[
        "capo_iotfleetwise.types.data_partitions.DataPartitions"
    ]
    """<p>The data partitions associated with the signals collected from the vehicle.</p>"""
    signals_to_fetch: NotRequired[
        "capo_iotfleetwise.types.signal_fetch_information_list.SignalFetchInformationList"
    ]
    """<p>Information about a list of signals to fetch data from.</p>"""