iotfleetwise

package module
v1.22.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 21, 2024 License: Apache-2.0 Imports: 44 Imported by: 6

Documentation

Overview

Package iotfleetwise provides the API client, operations, and parameter types for AWS IoT FleetWise.

Amazon Web Services IoT FleetWise is a fully managed service that you can use to collect, model, and transfer vehicle data to the Amazon Web Services cloud at scale. With Amazon Web Services IoT FleetWise, you can standardize all of your vehicle data models, independent of the in-vehicle communication architecture, and define data collection rules to transfer only high-value data to the cloud.

For more information, see What is Amazon Web Services IoT FleetWise? 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 availabilityin the Amazon Web Services IoT FleetWise Developer Guide.

Index

Constants

View Source 
const ServiceAPIVersion = "2021-06-17"
View Source 
const ServiceID = "IoTFleetWise"

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver 

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions 

func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

WithAPIOptions returns a functional option for setting the Client's APIOptions option.

func WithEndpointResolver deprecated 

func WithEndpointResolver(v EndpointResolver) func(*Options)

Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for this field will likely prevent you from using any endpoint-related service features released after the introduction of EndpointResolverV2 and BaseEndpoint.

To migrate an EndpointResolver implementation that uses a custom endpoint, set the client option BaseEndpoint instead.

func WithEndpointResolverV2 added in v1.5.0 

func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)

WithEndpointResolverV2 returns a functional option for setting the Client's EndpointResolverV2 option.

func WithSigV4SigningName added in v1.8.2 

func WithSigV4SigningName(name string) func(*Options)

WithSigV4SigningName applies an override to the authentication workflow to use the given signing name for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing name from both auth scheme resolution and endpoint resolution.

func WithSigV4SigningRegion added in v1.8.2 

func WithSigV4SigningRegion(region string) func(*Options)

WithSigV4SigningRegion applies an override to the authentication workflow to use the given signing region for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing region from both auth scheme resolution and endpoint resolution.

Types

type AssociateVehicleFleetInput 

type AssociateVehicleFleetInput struct {

	//  The ID of a fleet.
	//
	// This member is required.
	FleetId *string

	//  The unique ID of the vehicle to associate with the fleet.
	//
	// This member is required.
	VehicleName *string
	// contains filtered or unexported fields
}

type AssociateVehicleFleetOutput 

type AssociateVehicleFleetOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type AuthResolverParameters added in v1.8.2 

type AuthResolverParameters struct {
	// The name of the operation being invoked.
	Operation string

	// The region in which the operation is being invoked.
	Region string
}

AuthResolverParameters contains the set of inputs necessary for auth scheme resolution.

type AuthSchemeResolver added in v1.8.2 

type AuthSchemeResolver interface {
	ResolveAuthSchemes(context.Context, *AuthResolverParameters) ([]*smithyauth.Option, error)
}

AuthSchemeResolver returns a set of possible authentication options for an operation.

type BatchCreateVehicleInput 

type BatchCreateVehicleInput struct {

	//  A list of information about each vehicle to create. For more information, see
	// the API data type.
	//
	// This member is required.
	Vehicles []types.CreateVehicleRequestItem
	// contains filtered or unexported fields
}

type BatchCreateVehicleOutput 

type BatchCreateVehicleOutput struct {

	// A list of information about creation errors, or an empty list if there aren't
	// any errors.
	Errors []types.CreateVehicleError

	//  A list of information about a batch of created vehicles. For more information,
	// see the API data type.
	Vehicles []types.CreateVehicleResponseItem

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type BatchUpdateVehicleInput 

type BatchUpdateVehicleInput struct {

	//  A list of information about the vehicles to update. For more information, see
	// the API data type.
	//
	// This member is required.
	Vehicles []types.UpdateVehicleRequestItem
	// contains filtered or unexported fields
}

type BatchUpdateVehicleOutput 

type BatchUpdateVehicleOutput struct {

	// A list of information about errors returned while updating a batch of vehicles,
	// or, if there aren't any errors, an empty list.
	Errors []types.UpdateVehicleError

	//  A list of information about the batch of updated vehicles.
	//
	// This list contains only unique IDs for the vehicles that were updated.
	Vehicles []types.UpdateVehicleResponseItem

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type Client 

type Client struct {
	// contains filtered or unexported fields
}

Client provides the API client to make operations call for AWS IoT FleetWise.

func New 

func New(options Options, optFns ...func(*Options)) *Client

New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

func NewFromConfig 

func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

NewFromConfig returns a new client from the provided config.

func (*Client) AssociateVehicleFleet 

func (c *Client) AssociateVehicleFleet(ctx context.Context, params *AssociateVehicleFleetInput, optFns ...func(*Options)) (*AssociateVehicleFleetOutput, error)

Adds, or associates, a vehicle with a fleet.

func (*Client) BatchCreateVehicle 

func (c *Client) BatchCreateVehicle(ctx context.Context, params *BatchCreateVehicleInput, optFns ...func(*Options)) (*BatchCreateVehicleOutput, error)
Creates a group, or batch, of vehicles.

You must specify a decoder manifest and a vehicle model (model manifest) for each vehicle.

For more information, see Create multiple vehicles (AWS CLI) in the Amazon Web Services IoT FleetWise Developer Guide.

func (*Client) BatchUpdateVehicle 

func (c *Client) BatchUpdateVehicle(ctx context.Context, params *BatchUpdateVehicleInput, optFns ...func(*Options)) (*BatchUpdateVehicleOutput, error)
Updates a group, or batch, of vehicles.

You must specify a decoder manifest and a vehicle model (model manifest) for each vehicle.

For more information, see Update multiple vehicles (AWS CLI) in the Amazon Web Services IoT FleetWise Developer Guide.

func (*Client) CreateCampaign 

func (c *Client) CreateCampaign(ctx context.Context, params *CreateCampaignInput, optFns ...func(*Options)) (*CreateCampaignOutput, error)

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 availabilityin the Amazon Web Services IoT FleetWise Developer Guide.

func (*Client) CreateDecoderManifest 

func (c *Client) CreateDecoderManifest(ctx context.Context, params *CreateDecoderManifestInput, optFns ...func(*Options)) (*CreateDecoderManifestOutput, error)

Creates the decoder manifest associated with a model manifest. To create a decoder manifest, the following must be true:

  • Every signal decoder has a unique name.

  • Each signal decoder is associated with a network interface.

  • Each network interface has a unique ID.

  • The signal decoders are specified in the model manifest.

func (*Client) CreateFleet 

func (c *Client) CreateFleet(ctx context.Context, params *CreateFleetInput, optFns ...func(*Options)) (*CreateFleetOutput, error)
Creates a fleet that represents a group of vehicles.

You must create both a signal catalog and vehicles before you can create a fleet.

For more information, see Fleets in the Amazon Web Services IoT FleetWise Developer Guide.

func (*Client) CreateModelManifest 

func (c *Client) CreateModelManifest(ctx context.Context, params *CreateModelManifestInput, optFns ...func(*Options)) (*CreateModelManifestOutput, error)
Creates a vehicle model (model manifest) that specifies signals (attributes,

branches, sensors, and actuators).

For more information, see Vehicle models in the Amazon Web Services IoT FleetWise Developer Guide.

func (*Client) CreateSignalCatalog 

func (c *Client) CreateSignalCatalog(ctx context.Context, params *CreateSignalCatalogInput, optFns ...func(*Options)) (*CreateSignalCatalogOutput, error)
Creates a collection of standardized signals that can be reused to create

vehicle models.

func (*Client) CreateStateTemplate added in v1.22.0 

func (c *Client) CreateStateTemplate(ctx context.Context, params *CreateStateTemplateInput, optFns ...func(*Options)) (*CreateStateTemplateOutput, error)

Creates a state template. State templates contain state properties, which are signals that belong to a signal catalog that is synchronized between the Amazon Web Services IoT FleetWise Edge and the Amazon Web Services Cloud.

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

func (*Client) CreateVehicle 

func (c *Client) CreateVehicle(ctx context.Context, params *CreateVehicleInput, optFns ...func(*Options)) (*CreateVehicleOutput, error)
Creates a vehicle, which is an instance of a vehicle model (model manifest).

Vehicles created from the same vehicle model consist of the same signals inherited from the vehicle model.

If you have an existing Amazon Web Services IoT thing, you can use Amazon Web Services IoT FleetWise to create a vehicle and collect data from your thing.

For more information, see Create a vehicle (AWS CLI) in the Amazon Web Services IoT FleetWise Developer Guide.

func (*Client) DeleteCampaign 

func (c *Client) DeleteCampaign(ctx context.Context, params *DeleteCampaignInput, optFns ...func(*Options)) (*DeleteCampaignOutput, error)
Deletes a data collection campaign. Deleting a campaign suspends all data

collection and removes it from any vehicles.

func (*Client) DeleteDecoderManifest 

func (c *Client) DeleteDecoderManifest(ctx context.Context, params *DeleteDecoderManifestInput, optFns ...func(*Options)) (*DeleteDecoderManifestOutput, error)
Deletes a decoder manifest. You can't delete a decoder manifest if it has

vehicles associated with it.

func (*Client) DeleteFleet 

func (c *Client) DeleteFleet(ctx context.Context, params *DeleteFleetInput, optFns ...func(*Options)) (*DeleteFleetOutput, error)
Deletes a fleet. Before you delete a fleet, all vehicles must be dissociated

from the fleet. For more information, see Delete a fleet (AWS CLI)in the Amazon Web Services IoT FleetWise Developer Guide.

func (*Client) DeleteModelManifest 

func (c *Client) DeleteModelManifest(ctx context.Context, params *DeleteModelManifestInput, optFns ...func(*Options)) (*DeleteModelManifestOutput, error)

Deletes a vehicle model (model manifest).

func (*Client) DeleteSignalCatalog 

func (c *Client) DeleteSignalCatalog(ctx context.Context, params *DeleteSignalCatalogInput, optFns ...func(*Options)) (*DeleteSignalCatalogOutput, error)

Deletes a signal catalog.

func (*Client) DeleteStateTemplate added in v1.22.0 

func (c *Client) DeleteStateTemplate(ctx context.Context, params *DeleteStateTemplateInput, optFns ...func(*Options)) (*DeleteStateTemplateOutput, error)

Deletes a state template.

func (*Client) DeleteVehicle 

func (c *Client) DeleteVehicle(ctx context.Context, params *DeleteVehicleInput, optFns ...func(*Options)) (*DeleteVehicleOutput, error)

Deletes a vehicle and removes it from any campaigns.

func (*Client) DisassociateVehicleFleet 

func (c *Client) DisassociateVehicleFleet(ctx context.Context, params *DisassociateVehicleFleetInput, optFns ...func(*Options)) (*DisassociateVehicleFleetOutput, error)

Removes, or disassociates, a vehicle from a fleet. Disassociating a vehicle from a fleet doesn't delete the vehicle.

func (*Client) GetCampaign 

func (c *Client) GetCampaign(ctx context.Context, params *GetCampaignInput, optFns ...func(*Options)) (*GetCampaignOutput, error)
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 availabilityin the Amazon Web Services IoT FleetWise Developer Guide.

func (*Client) GetDecoderManifest 

func (c *Client) GetDecoderManifest(ctx context.Context, params *GetDecoderManifestInput, optFns ...func(*Options)) (*GetDecoderManifestOutput, error)

Retrieves information about a created decoder manifest.

func (*Client) GetEncryptionConfiguration added in v1.6.0 

func (c *Client) GetEncryptionConfiguration(ctx context.Context, params *GetEncryptionConfigurationInput, optFns ...func(*Options)) (*GetEncryptionConfigurationOutput, error)

Retrieves the encryption configuration for resources and data in Amazon Web Services IoT FleetWise.

func (*Client) GetFleet 

func (c *Client) GetFleet(ctx context.Context, params *GetFleetInput, optFns ...func(*Options)) (*GetFleetOutput, error)

Retrieves information about a fleet.

func (*Client) GetLoggingOptions 

func (c *Client) GetLoggingOptions(ctx context.Context, params *GetLoggingOptionsInput, optFns ...func(*Options)) (*GetLoggingOptionsOutput, error)

Retrieves the logging options.

func (*Client) GetModelManifest 

func (c *Client) GetModelManifest(ctx context.Context, params *GetModelManifestInput, optFns ...func(*Options)) (*GetModelManifestOutput, error)

Retrieves information about a vehicle model (model manifest).

func (*Client) GetRegisterAccountStatus 

func (c *Client) GetRegisterAccountStatus(ctx context.Context, params *GetRegisterAccountStatusInput, optFns ...func(*Options)) (*GetRegisterAccountStatusOutput, error)
Retrieves information about the status of registering your Amazon Web Services

account, IAM, and Amazon Timestream resources so that Amazon Web Services IoT FleetWise can transfer your vehicle data to the Amazon Web Services Cloud.

For more information, including step-by-step procedures, see Setting up Amazon Web Services IoT FleetWise.

This API operation doesn't require input parameters.

func (*Client) GetSignalCatalog 

func (c *Client) GetSignalCatalog(ctx context.Context, params *GetSignalCatalogInput, optFns ...func(*Options)) (*GetSignalCatalogOutput, error)

Retrieves information about a signal catalog.

func (*Client) GetStateTemplate added in v1.22.0 

func (c *Client) GetStateTemplate(ctx context.Context, params *GetStateTemplateInput, optFns ...func(*Options)) (*GetStateTemplateOutput, error)

Retrieves information about a state template.

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

func (*Client) GetVehicle 

func (c *Client) GetVehicle(ctx context.Context, params *GetVehicleInput, optFns ...func(*Options)) (*GetVehicleOutput, error)

Retrieves information about a vehicle.

func (*Client) GetVehicleStatus 

func (c *Client) GetVehicleStatus(ctx context.Context, params *GetVehicleStatusInput, optFns ...func(*Options)) (*GetVehicleStatusOutput, error)
Retrieves information about the status of campaigns, decoder manifests, or

state templates associated with a vehicle.

func (*Client) ImportDecoderManifest 

func (c *Client) ImportDecoderManifest(ctx context.Context, params *ImportDecoderManifestInput, optFns ...func(*Options)) (*ImportDecoderManifestOutput, error)
Creates a decoder manifest using your existing CAN DBC file from your local

device.

The CAN signal name must be unique and not repeated across CAN message definitions in a .dbc file.

func (*Client) ImportSignalCatalog 

func (c *Client) ImportSignalCatalog(ctx context.Context, params *ImportSignalCatalogInput, optFns ...func(*Options)) (*ImportSignalCatalogOutput, error)
Creates a signal catalog using your existing VSS formatted content from your

local device.

func (*Client) ListCampaigns 

func (c *Client) ListCampaigns(ctx context.Context, params *ListCampaignsInput, optFns ...func(*Options)) (*ListCampaignsOutput, error)
Lists information about created campaigns.

This API operation uses pagination. Specify the nextToken parameter in the request to return more results.

func (*Client) ListDecoderManifestNetworkInterfaces 

func (c *Client) ListDecoderManifestNetworkInterfaces(ctx context.Context, params *ListDecoderManifestNetworkInterfacesInput, optFns ...func(*Options)) (*ListDecoderManifestNetworkInterfacesOutput, error)
Lists the network interfaces specified in a decoder manifest.

This API operation uses pagination. Specify the nextToken parameter in the request to return more results.

func (*Client) ListDecoderManifestSignals 

func (c *Client) ListDecoderManifestSignals(ctx context.Context, params *ListDecoderManifestSignalsInput, optFns ...func(*Options)) (*ListDecoderManifestSignalsOutput, error)
A list of information about signal decoders specified in a decoder manifest.

This API operation uses pagination. Specify the nextToken parameter in the request to return more results.

func (*Client) ListDecoderManifests 

func (c *Client) ListDecoderManifests(ctx context.Context, params *ListDecoderManifestsInput, optFns ...func(*Options)) (*ListDecoderManifestsOutput, error)
Lists decoder manifests.

This API operation uses pagination. Specify the nextToken parameter in the request to return more results.

func (*Client) ListFleets 

func (c *Client) ListFleets(ctx context.Context, params *ListFleetsInput, optFns ...func(*Options)) (*ListFleetsOutput, error)
Retrieves information for each created fleet in an Amazon Web Services

account.

This API operation uses pagination. Specify the nextToken parameter in the request to return more results.

func (*Client) ListFleetsForVehicle 

func (c *Client) ListFleetsForVehicle(ctx context.Context, params *ListFleetsForVehicleInput, optFns ...func(*Options)) (*ListFleetsForVehicleOutput, error)

Retrieves a list of IDs for all fleets that the vehicle is associated with.

This API operation uses pagination. Specify the nextToken parameter in the request to return more results.

func (*Client) ListModelManifestNodes 

func (c *Client) ListModelManifestNodes(ctx context.Context, params *ListModelManifestNodesInput, optFns ...func(*Options)) (*ListModelManifestNodesOutput, error)
Lists information about nodes specified in a vehicle model (model manifest).

This API operation uses pagination. Specify the nextToken parameter in the request to return more results.

func (*Client) ListModelManifests 

func (c *Client) ListModelManifests(ctx context.Context, params *ListModelManifestsInput, optFns ...func(*Options)) (*ListModelManifestsOutput, error)
Retrieves a list of vehicle models (model manifests).

This API operation uses pagination. Specify the nextToken parameter in the request to return more results.

func (*Client) ListSignalCatalogNodes 

func (c *Client) ListSignalCatalogNodes(ctx context.Context, params *ListSignalCatalogNodesInput, optFns ...func(*Options)) (*ListSignalCatalogNodesOutput, error)
Lists of information about the signals (nodes) specified in a signal catalog.

This API operation uses pagination. Specify the nextToken parameter in the request to return more results.

func (*Client) ListSignalCatalogs 

func (c *Client) ListSignalCatalogs(ctx context.Context, params *ListSignalCatalogsInput, optFns ...func(*Options)) (*ListSignalCatalogsOutput, error)
Lists all the created signal catalogs in an Amazon Web Services account.

You can use to list information about each signal (node) specified in a signal catalog.

This API operation uses pagination. Specify the nextToken parameter in the request to return more results.

func (*Client) ListStateTemplates added in v1.22.0 

func (c *Client) ListStateTemplates(ctx context.Context, params *ListStateTemplatesInput, optFns ...func(*Options)) (*ListStateTemplatesOutput, error)

Lists information about created state templates.

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

func (*Client) ListTagsForResource 

func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)

Lists the tags (metadata) you have assigned to the resource.

func (*Client) ListVehicles 

func (c *Client) ListVehicles(ctx context.Context, params *ListVehiclesInput, optFns ...func(*Options)) (*ListVehiclesOutput, error)
Retrieves a list of summaries of created vehicles.

This API operation uses pagination. Specify the nextToken parameter in the request to return more results.

func (*Client) ListVehiclesInFleet 

func (c *Client) ListVehiclesInFleet(ctx context.Context, params *ListVehiclesInFleetInput, optFns ...func(*Options)) (*ListVehiclesInFleetOutput, error)
Retrieves a list of summaries of all vehicles associated with a fleet.

This API operation uses pagination. Specify the nextToken parameter in the request to return more results.

func (*Client) Options added in v1.10.0 

func (c *Client) Options() Options

Options returns a copy of the client configuration.

Callers SHOULD NOT perform mutations on any inner structures within client config. Config overrides should instead be made on a per-operation basis through functional options.

func (*Client) PutEncryptionConfiguration added in v1.6.0 

func (c *Client) PutEncryptionConfiguration(ctx context.Context, params *PutEncryptionConfigurationInput, optFns ...func(*Options)) (*PutEncryptionConfigurationOutput, error)

Creates or updates the encryption configuration. Amazon Web Services IoT FleetWise can encrypt your data and resources using an Amazon Web Services managed key. Or, you can use a KMS key that you own and manage. For more information, see Data encryptionin the Amazon Web Services IoT FleetWise Developer Guide.

func (*Client) PutLoggingOptions 

func (c *Client) PutLoggingOptions(ctx context.Context, params *PutLoggingOptionsInput, optFns ...func(*Options)) (*PutLoggingOptionsOutput, error)

Creates or updates the logging option.

func (*Client) RegisterAccount 

func (c *Client) RegisterAccount(ctx context.Context, params *RegisterAccountInput, optFns ...func(*Options)) (*RegisterAccountOutput, error)

This API operation contains deprecated parameters. Register your account again without the Timestream resources parameter so that Amazon Web Services IoT FleetWise can remove the Timestream metadata stored. You should then pass the data destination into the CreateCampaignAPI operation.

You must delete any existing campaigns that include an empty data destination before you register your account again. For more information, see the DeleteCampaignAPI operation.

If you want to delete the Timestream inline policy from the service-linked role, such as to mitigate an overly permissive policy, you must first delete any existing campaigns. Then delete the service-linked role and register your account again to enable CloudWatch metrics. For more information, see DeleteServiceLinkedRolein the Identity and Access Management API Reference.

Registers your Amazon Web Services account, IAM, and Amazon Timestream resources so Amazon Web Services IoT FleetWise can transfer your vehicle data to the Amazon Web Services Cloud. For more information, including step-by-step procedures, see Setting up Amazon Web Services IoT FleetWise.

An Amazon Web Services account is not the same thing as a "user." An Amazon Web Services user is an identity that you create using Identity and Access Management (IAM) and takes the form of either an IAM useror an IAM role, both with credentials. A single Amazon Web Services account can, and typically does, contain many users and roles.

func (*Client) TagResource 

func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)

Adds to or modifies the tags of the given resource. Tags are metadata which can be used to manage a resource.

func (*Client) UntagResource 

func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)

Removes the given tags (metadata) from the resource.

func (*Client) UpdateCampaign 

func (c *Client) UpdateCampaign(ctx context.Context, params *UpdateCampaignInput, optFns ...func(*Options)) (*UpdateCampaignOutput, error)

Updates a campaign.

func (*Client) UpdateDecoderManifest 

func (c *Client) UpdateDecoderManifest(ctx context.Context, params *UpdateDecoderManifestInput, optFns ...func(*Options)) (*UpdateDecoderManifestOutput, error)
Updates a decoder manifest.

A decoder manifest can only be updated when the status is DRAFT . Only ACTIVE decoder manifests can be associated with vehicles.

func (*Client) UpdateFleet 

func (c *Client) UpdateFleet(ctx context.Context, params *UpdateFleetInput, optFns ...func(*Options)) (*UpdateFleetOutput, error)

Updates the description of an existing fleet.

func (*Client) UpdateModelManifest 

func (c *Client) UpdateModelManifest(ctx context.Context, params *UpdateModelManifestInput, optFns ...func(*Options)) (*UpdateModelManifestOutput, error)
Updates a vehicle model (model manifest). If created vehicles are associated

with a vehicle model, it can't be updated.

func (*Client) UpdateSignalCatalog 

func (c *Client) UpdateSignalCatalog(ctx context.Context, params *UpdateSignalCatalogInput, optFns ...func(*Options)) (*UpdateSignalCatalogOutput, error)

Updates a signal catalog.

func (*Client) UpdateStateTemplate added in v1.22.0 

func (c *Client) UpdateStateTemplate(ctx context.Context, params *UpdateStateTemplateInput, optFns ...func(*Options)) (*UpdateStateTemplateOutput, error)

Updates a state template.

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

func (*Client) UpdateVehicle 

func (c *Client) UpdateVehicle(ctx context.Context, params *UpdateVehicleInput, optFns ...func(*Options)) (*UpdateVehicleOutput, error)

Updates a vehicle.

type CreateCampaignInput 

type CreateCampaignInput struct {

	//  The data collection scheme associated with the campaign. You can specify a
	// scheme that collects data based on time or an event.
	//
	// This member is required.
	CollectionScheme types.CollectionScheme

	//  The name of the campaign to create.
	//
	// This member is required.
	Name *string

	// The Amazon Resource Name (ARN) of the signal catalog to associate with the
	// campaign.
	//
	// This member is required.
	SignalCatalogArn *string

	//  The ARN of the vehicle or fleet to deploy a campaign to.
	//
	// This member is required.
	TargetArn *string

	// Determines whether to compress signals before transmitting data to Amazon Web
	// Services IoT FleetWise. If you don't want to compress the signals, use OFF . If
	// it's not specified, SNAPPY is used.
	//
	// Default: SNAPPY
	Compression types.Compression

	// The destination where the campaign sends data. You can send data to an MQTT
	// topic, or store it in Amazon S3 or Amazon Timestream.
	//
	// MQTT is the publish/subscribe messaging protocol used by Amazon Web Services
	// IoT to communicate with your devices.
	//
	// 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. Amazon Web Services IoT FleetWise supports
	// at-least-once file delivery to S3. Your vehicle data is stored on multiple
	// Amazon Web Services IoT FleetWise servers for redundancy and high availability.
	//
	// 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.
	DataDestinationConfigs []types.DataDestinationConfig

	// A list of vehicle attributes to associate with a campaign.
	//
	// Enrich the data with specified vehicle attributes. For example, add make and
	// model to the campaign, and Amazon Web Services IoT FleetWise will associate the
	// data with those attributes as dimensions in Amazon Timestream. You can then
	// query the data against make and model .
	//
	// Default: An empty array
	DataExtraDimensions []string

	// The data partitions associated with the signals collected from the vehicle.
	DataPartitions []types.DataPartition

	// An optional description of the campaign to help identify its purpose.
	Description *string

	// Option for a vehicle to send diagnostic trouble codes to Amazon Web Services
	// IoT FleetWise. If you want to send diagnostic trouble codes, use
	// SEND_ACTIVE_DTCS . If it's not specified, OFF is used.
	//
	// Default: OFF
	DiagnosticsMode types.DiagnosticsMode

	// The time the campaign expires, in seconds since epoch (January 1, 1970 at
	// midnight UTC time). Vehicle data isn't collected after the campaign expires.
	//
	// Default: 253402214400 (December 31, 9999, 00:00:00 UTC)
	ExpiryTime *time.Time

	// How long (in milliseconds) to collect raw data after a triggering event
	// initiates the collection. If it's not specified, 0 is used.
	//
	// Default: 0
	PostTriggerCollectionDuration *int64

	// 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. If it's not specified, 0 is used.
	//
	// Default: 0
	//
	// Deprecated: priority is no longer used or needed as input
	Priority *int32

	// A list of information about signals to collect.
	//
	// If you upload a signal as a condition in a data partition for a campaign, then
	// those same signals must be included in signalsToCollect .
	SignalsToCollect []types.SignalInformation

	// A list of information about signals to fetch.
	SignalsToFetch []types.SignalFetchInformation

	// Determines 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. If you want to store collected
	// data when a vehicle loses connection with the cloud, use TO_DISK . If it's not
	// specified, OFF is used.
	//
	// Default: OFF
	SpoolingMode types.SpoolingMode

	// The time, in milliseconds, to deliver a campaign after it was approved. If it's
	// not specified, 0 is used.
	//
	// Default: 0
	StartTime *time.Time

	// Metadata that can be used to manage the campaign.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateCampaignOutput 

type CreateCampaignOutput struct {

	//  The ARN of the created campaign.
	Arn *string

	// The name of the created campaign.
	Name *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateDecoderManifestInput 

type CreateDecoderManifestInput struct {

	//  The Amazon Resource Name (ARN) of the vehicle model (model manifest).
	//
	// This member is required.
	ModelManifestArn *string

	//  The unique name of the decoder manifest to create.
	//
	// This member is required.
	Name *string

	// Use default decoders for all unmapped signals in the model. You don't need to
	// provide any detailed decoding information.
	//
	// 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.
	//
	// [Amazon Web Services Region and feature availability]: https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/fleetwise-regions.html
	DefaultForUnmappedSignals types.DefaultForUnmappedSignalsType

	// A brief description of the decoder manifest.
	Description *string

	//  A list of information about available network interfaces.
	NetworkInterfaces []types.NetworkInterface

	//  A list of information about signal decoders.
	SignalDecoders []types.SignalDecoder

	// Metadata that can be used to manage the decoder manifest.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateDecoderManifestOutput 

type CreateDecoderManifestOutput struct {

	//  The ARN of the created decoder manifest.
	//
	// This member is required.
	Arn *string

	//  The name of the created decoder manifest.
	//
	// This member is required.
	Name *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateFleetInput 

type CreateFleetInput struct {

	//  The unique ID of the fleet to create.
	//
	// This member is required.
	FleetId *string

	//  The Amazon Resource Name (ARN) of a signal catalog.
	//
	// This member is required.
	SignalCatalogArn *string

	//  A brief description of the fleet to create.
	Description *string

	// Metadata that can be used to manage the fleet.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateFleetOutput 

type CreateFleetOutput struct {

	//  The ARN of the created fleet.
	//
	// This member is required.
	Arn *string

	//  The ID of the created fleet.
	//
	// This member is required.
	Id *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateModelManifestInput 

type CreateModelManifestInput struct {

	//  The name of the vehicle model to create.
	//
	// This member is required.
	Name *string

	//  A list of nodes, which are a general abstraction of signals.
	//
	// This member is required.
	Nodes []string

	//  The Amazon Resource Name (ARN) of a signal catalog.
	//
	// This member is required.
	SignalCatalogArn *string

	//  A brief description of the vehicle model.
	Description *string

	// Metadata that can be used to manage the vehicle model.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateModelManifestOutput 

type CreateModelManifestOutput struct {

	//  The ARN of the created vehicle model.
	//
	// This member is required.
	Arn *string

	//  The name of the created vehicle model.
	//
	// This member is required.
	Name *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateSignalCatalogInput 

type CreateSignalCatalogInput struct {

	//  The name of the signal catalog to create.
	//
	// This member is required.
	Name *string

	// A brief description of the signal catalog.
	Description *string

	//  A list of information about nodes, which are a general abstraction of signals.
	// For more information, see the API data type.
	Nodes []types.Node

	// Metadata that can be used to manage the signal catalog.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateSignalCatalogOutput 

type CreateSignalCatalogOutput struct {

	//  The ARN of the created signal catalog.
	//
	// This member is required.
	Arn *string

	//  The name of the created signal catalog.
	//
	// This member is required.
	Name *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateStateTemplateInput added in v1.22.0 

type CreateStateTemplateInput struct {

	// The name of the state template.
	//
	// This member is required.
	Name *string

	// The ARN of the signal catalog associated with the state template.
	//
	// This member is required.
	SignalCatalogArn *string

	// A list of signals from which data is collected. The state template properties
	// contain the fully qualified names of the signals.
	//
	// This member is required.
	StateTemplateProperties []string

	// A list of vehicle attributes to associate with the payload published on the
	// state template's MQTT topic. (See [Processing last known state vehicle data using MQTT messaging]). For example, if you add
	// Vehicle.Attributes.Make and Vehicle.Attributes.Model attributes, Amazon Web
	// Services IoT FleetWise will enrich the protobuf encoded payload with those
	// attributes in the extraDimensions field.
	//
	// [Processing last known state vehicle data using MQTT messaging]: https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/process-visualize-data.html#process-last-known-state-vehicle-data
	DataExtraDimensions []string

	// A brief description of the state template.
	Description *string

	// A list of vehicle attributes to associate with user properties of the messages
	// published on the state template's MQTT topic. (See [Processing last known state vehicle data using MQTT messaging]). For example, if you add
	// Vehicle.Attributes.Make and Vehicle.Attributes.Model attributes, Amazon Web
	// Services IoT FleetWise will include these attributes as User Properties with the
	// MQTT message.
	//
	// Default: An empty array
	//
	// [Processing last known state vehicle data using MQTT messaging]: https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/process-visualize-data.html#process-last-known-state-vehicle-data
	MetadataExtraDimensions []string

	// Metadata that can be used to manage the state template.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateStateTemplateOutput added in v1.22.0 

type CreateStateTemplateOutput struct {

	// The Amazon Resource Name (ARN) of the state template.
	Arn *string

	// The unique ID of the state template.
	Id *string

	// The name of the state template.
	Name *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateVehicleInput 

type CreateVehicleInput struct {

	//  The ARN of a decoder manifest.
	//
	// This member is required.
	DecoderManifestArn *string

	//  The Amazon Resource Name ARN of a vehicle model.
	//
	// This member is required.
	ModelManifestArn *string

	//  The unique ID of the vehicle to create.
	//
	// This member is required.
	VehicleName *string

	//  An option to create a new Amazon Web Services IoT thing when creating a
	// vehicle, or to validate an existing Amazon Web Services IoT thing as a vehicle.
	//
	// Default:
	AssociationBehavior types.VehicleAssociationBehavior

	// Static information about a vehicle in a key-value pair. For example:
	// "engineType" : "1.3 L R2"
	//
	// To use attributes with Campaigns or State Templates, you must include them
	// using the request parameters dataExtraDimensions and/or metadataExtraDimensions
	// (for state templates only) when creating your campaign/state template.
	Attributes map[string]string

	// Associate state templates with the vehicle. You can monitor the last known
	// state of the vehicle in near real time.
	StateTemplates []types.StateTemplateAssociation

	// Metadata that can be used to manage the vehicle.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateVehicleOutput 

type CreateVehicleOutput struct {

	//  The ARN of the created vehicle.
	Arn *string

	//  The ARN of a created or validated Amazon Web Services IoT thing.
	ThingArn *string

	// The unique ID of the created vehicle.
	VehicleName *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteCampaignInput 

type DeleteCampaignInput struct {

	//  The name of the campaign to delete.
	//
	// This member is required.
	Name *string
	// contains filtered or unexported fields
}

type DeleteCampaignOutput 

type DeleteCampaignOutput struct {

	//  The Amazon Resource Name (ARN) of the deleted campaign.
	//
	// The ARN isn’t returned if a campaign doesn’t exist.
	Arn *string

	// The name of the deleted campaign.
	Name *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteDecoderManifestInput 

type DeleteDecoderManifestInput struct {

	//  The name of the decoder manifest to delete.
	//
	// This member is required.
	Name *string
	// contains filtered or unexported fields
}

type DeleteDecoderManifestOutput 

type DeleteDecoderManifestOutput struct {

	// The Amazon Resource Name (ARN) of the deleted decoder manifest.
	//
	// This member is required.
	Arn *string

	// The name of the deleted decoder manifest.
	//
	// This member is required.
	Name *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteFleetInput 

type DeleteFleetInput struct {

	//  The ID of the fleet to delete.
	//
	// This member is required.
	FleetId *string
	// contains filtered or unexported fields
}

type DeleteFleetOutput 

type DeleteFleetOutput struct {

	// The Amazon Resource Name (ARN) of the deleted fleet.
	Arn *string

	// The ID of the deleted fleet.
	Id *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteModelManifestInput 

type DeleteModelManifestInput struct {

	//  The name of the model manifest to delete.
	//
	// This member is required.
	Name *string
	// contains filtered or unexported fields
}

type DeleteModelManifestOutput 

type DeleteModelManifestOutput struct {

	// The Amazon Resource Name (ARN) of the deleted model manifest.
	//
	// This member is required.
	Arn *string

	// The name of the deleted model manifest.
	//
	// This member is required.
	Name *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteSignalCatalogInput 

type DeleteSignalCatalogInput struct {

	//  The name of the signal catalog to delete.
	//
	// This member is required.
	Name *string
	// contains filtered or unexported fields
}

type DeleteSignalCatalogOutput 

type DeleteSignalCatalogOutput struct {

	// The Amazon Resource Name (ARN) of the deleted signal catalog.
	//
	// This member is required.
	Arn *string

	// The name of the deleted signal catalog.
	//
	// This member is required.
	Name *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteStateTemplateInput added in v1.22.0 

type DeleteStateTemplateInput struct {

	// A unique, service-generated identifier.
	//
	// This member is required.
	Identifier *string
	// contains filtered or unexported fields
}

type DeleteStateTemplateOutput added in v1.22.0 

type DeleteStateTemplateOutput struct {

	// The Amazon Resource Name (ARN) of the state template.
	Arn *string

	// The unique ID of the state template.
	Id *string

	// The name of the state template.
	Name *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteVehicleInput 

type DeleteVehicleInput struct {

	// The ID of the vehicle to delete.
	//
	// This member is required.
	VehicleName *string
	// contains filtered or unexported fields
}

type DeleteVehicleOutput 

type DeleteVehicleOutput struct {

	// The Amazon Resource Name (ARN) of the deleted vehicle.
	//
	// This member is required.
	Arn *string

	// The ID of the deleted vehicle.
	//
	// This member is required.
	VehicleName *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DisassociateVehicleFleetInput 

type DisassociateVehicleFleetInput struct {

	//  The unique ID of a fleet.
	//
	// This member is required.
	FleetId *string

	//  The unique ID of the vehicle to disassociate from the fleet.
	//
	// This member is required.
	VehicleName *string
	// contains filtered or unexported fields
}

type DisassociateVehicleFleetOutput 

type DisassociateVehicleFleetOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type EndpointParameters added in v1.5.0 

type EndpointParameters struct {
	// The AWS region used to dispatch the request.
	//
	// Parameter is
	// required.
	//
	// AWS::Region
	Region *string

	// When true, use the dual-stack endpoint. If the configured endpoint does not
	// support dual-stack, dispatching the request MAY return an error.
	//
	// Defaults to
	// false if no value is provided.
	//
	// AWS::UseDualStack
	UseDualStack *bool

	// When true, send this request to the FIPS-compliant regional endpoint. If the
	// configured endpoint does not have a FIPS compliant endpoint, dispatching the
	// request will return an error.
	//
	// Defaults to false if no value is
	// provided.
	//
	// AWS::UseFIPS
	UseFIPS *bool

	// Override the endpoint used to send this request
	//
	// Parameter is
	// required.
	//
	// SDK::Endpoint
	Endpoint *string
}

EndpointParameters provides the parameters that influence how endpoints are resolved.

func (EndpointParameters) ValidateRequired added in v1.5.0 

func (p EndpointParameters) ValidateRequired() error

ValidateRequired validates required parameters are set.

func (EndpointParameters) WithDefaults added in v1.5.0 

func (p EndpointParameters) WithDefaults() EndpointParameters

WithDefaults returns a shallow copy of EndpointParameterswith default values applied to members where applicable.

type EndpointResolver 

type EndpointResolver interface {
	ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}

EndpointResolver interface for resolving service endpoints.

func EndpointResolverFromURL 

func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

type EndpointResolverFunc 

type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)

EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

func (EndpointResolverFunc) ResolveEndpoint 

func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)

type EndpointResolverOptions 

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type EndpointResolverV2 added in v1.5.0 

type EndpointResolverV2 interface {
	// ResolveEndpoint attempts to resolve the endpoint with the provided options,
	// returning the endpoint if found. Otherwise an error is returned.
	ResolveEndpoint(ctx context.Context, params EndpointParameters) (
		smithyendpoints.Endpoint, error,
	)
}

EndpointResolverV2 provides the interface for resolving service endpoints.

func NewDefaultEndpointResolverV2 added in v1.5.0 

func NewDefaultEndpointResolverV2() EndpointResolverV2

type GetCampaignInput 

type GetCampaignInput struct {

	//  The name of the campaign to retrieve information about.
	//
	// This member is required.
	Name *string
	// contains filtered or unexported fields
}

type GetCampaignOutput 

type GetCampaignOutput struct {

	//  The Amazon Resource Name (ARN) of the campaign.
	Arn *string

	//  Information about the data collection scheme associated with the campaign.
	CollectionScheme types.CollectionScheme

	//  Whether to compress signals before transmitting data to Amazon Web Services
	// IoT FleetWise. If OFF is specified, the signals aren't compressed. If it's not
	// specified, SNAPPY is used.
	Compression types.Compression

	//  The time the campaign was created in seconds since epoch (January 1, 1970 at
	// midnight UTC time).
	CreationTime *time.Time

	// The destination where the campaign sends data. You can send data to an MQTT
	// topic, or store it in Amazon S3 or Amazon Timestream.
	//
	// MQTT is the publish/subscribe messaging protocol used by Amazon Web Services
	// IoT to communicate with your devices.
	//
	// 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.
	//
	// 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.
	DataDestinationConfigs []types.DataDestinationConfig

	//  A list of vehicle attributes associated with the campaign.
	DataExtraDimensions []string

	// The data partitions associated with the signals collected from the vehicle.
	DataPartitions []types.DataPartition

	// The description of the campaign.
	Description *string

	//  Option for a vehicle to send diagnostic trouble codes to Amazon Web Services
	// IoT FleetWise.
	DiagnosticsMode types.DiagnosticsMode

	//  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.
	ExpiryTime *time.Time

	// The last time the campaign was modified.
	LastModificationTime *time.Time

	// The name of the campaign.
	Name *string

	//  How long (in seconds) to collect raw data after a triggering event initiates
	// the collection.
	PostTriggerCollectionDuration *int64

	//  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.
	Priority *int32

	//  The ARN of a signal catalog.
	SignalCatalogArn *string

	//  Information about a list of signals to collect data on.
	SignalsToCollect []types.SignalInformation

	// Information about a list of signals to fetch data from.
	SignalsToFetch []types.SignalFetchInformation

	//  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.
	SpoolingMode types.SpoolingMode

	//  The time, in milliseconds, to deliver a campaign after it was approved.
	StartTime *time.Time

	// The state of the campaign. The status can be one of: CREATING ,
	// WAITING_FOR_APPROVAL , RUNNING , and SUSPENDED .
	Status types.CampaignStatus

	//  The ARN of the vehicle or the fleet targeted by the campaign.
	TargetArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetDecoderManifestInput 

type GetDecoderManifestInput struct {

	//  The name of the decoder manifest to retrieve information about.
	//
	// This member is required.
	Name *string
	// contains filtered or unexported fields
}

type GetDecoderManifestOutput 

type GetDecoderManifestOutput struct {

	//  The Amazon Resource Name (ARN) of the decoder manifest.
	//
	// This member is required.
	Arn *string

	//  The time the decoder manifest was created in seconds since epoch (January 1,
	// 1970 at midnight UTC time).
	//
	// This member is required.
	CreationTime *time.Time

	//  The time the decoder manifest was last updated in seconds since epoch (January
	// 1, 1970 at midnight UTC time).
	//
	// This member is required.
	LastModificationTime *time.Time

	//  The name of the decoder manifest.
	//
	// This member is required.
	Name *string

	//  A brief description of the decoder manifest.
	Description *string

	// The detailed message for the decoder manifest. When a decoder manifest is in an
	// INVALID status, the message contains detailed reason and help information.
	Message *string

	//  The ARN of a vehicle model (model manifest) associated with the decoder
	// manifest.
	ModelManifestArn *string

	//  The state of the decoder manifest. If the status is ACTIVE , the decoder
	// manifest can't be edited. If the status is marked DRAFT , you can edit the
	// decoder manifest.
	Status types.ManifestStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetEncryptionConfigurationInput added in v1.6.0 

type GetEncryptionConfigurationInput struct {
	// contains filtered or unexported fields
}

type GetEncryptionConfigurationOutput added in v1.6.0 

type GetEncryptionConfigurationOutput struct {

	// The encryption status.
	//
	// This member is required.
	EncryptionStatus types.EncryptionStatus

	// The type of encryption. Set to KMS_BASED_ENCRYPTION to use a KMS key that you
	// own and manage. Set to FLEETWISE_DEFAULT_ENCRYPTION to use an Amazon Web
	// Services managed key that is owned by the Amazon Web Services IoT FleetWise
	// service account.
	//
	// This member is required.
	EncryptionType types.EncryptionType

	// The time when encryption was configured in seconds since epoch (January 1, 1970
	// at midnight UTC time).
	CreationTime *time.Time

	// The error message that describes why encryption settings couldn't be
	// configured, if applicable.
	ErrorMessage *string

	// The ID of the KMS key that is used for encryption.
	KmsKeyId *string

	// The time when encryption was last updated in seconds since epoch (January 1,
	// 1970 at midnight UTC time).
	LastModificationTime *time.Time

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetFleetInput 

type GetFleetInput struct {

	//  The ID of the fleet to retrieve information about.
	//
	// This member is required.
	FleetId *string
	// contains filtered or unexported fields
}

type GetFleetOutput 

type GetFleetOutput struct {

	//  The Amazon Resource Name (ARN) of the fleet.
	//
	// This member is required.
	Arn *string

	//  The time the fleet was created in seconds since epoch (January 1, 1970 at
	// midnight UTC time).
	//
	// This member is required.
	CreationTime *time.Time

	//  The ID of the fleet.
	//
	// This member is required.
	Id *string

	//  The time the fleet was last updated, in seconds since epoch (January 1, 1970
	// at midnight UTC time).
	//
	// This member is required.
	LastModificationTime *time.Time

	//  The ARN of a signal catalog associated with the fleet.
	//
	// This member is required.
	SignalCatalogArn *string

	//  A brief description of the fleet.
	Description *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetLoggingOptionsInput 

type GetLoggingOptionsInput struct {
	// contains filtered or unexported fields
}

type GetLoggingOptionsOutput 

type GetLoggingOptionsOutput struct {

	// Returns information about log delivery to Amazon CloudWatch Logs.
	//
	// This member is required.
	CloudWatchLogDelivery *types.CloudWatchLogDeliveryOptions

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetModelManifestInput 

type GetModelManifestInput struct {

	//  The name of the vehicle model to retrieve information about.
	//
	// This member is required.
	Name *string
	// contains filtered or unexported fields
}

type GetModelManifestOutput 

type GetModelManifestOutput struct {

	//  The Amazon Resource Name (ARN) of the vehicle model.
	//
	// This member is required.
	Arn *string

	// The time the vehicle model was created, in seconds since epoch (January 1, 1970
	// at midnight UTC time).
	//
	// This member is required.
	CreationTime *time.Time

	// The last time the vehicle model was modified.
	//
	// This member is required.
	LastModificationTime *time.Time

	//  The name of the vehicle model.
	//
	// This member is required.
	Name *string

	//  A brief description of the vehicle model.
	Description *string

	//  The ARN of the signal catalog associated with the vehicle model.
	SignalCatalogArn *string

	//  The state of the vehicle model. If the status is ACTIVE , the vehicle model
	// can't be edited. You can edit the vehicle model if the status is marked DRAFT .
	Status types.ManifestStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetRegisterAccountStatusInput 

type GetRegisterAccountStatusInput struct {
	// contains filtered or unexported fields
}

type GetRegisterAccountStatusOutput 

type GetRegisterAccountStatusOutput struct {

	//  The status of registering your account and resources. The status can be one of:
	//
	//   - REGISTRATION_SUCCESS - The Amazon Web Services resource is successfully
	//   registered.
	//
	//   - REGISTRATION_PENDING - Amazon Web Services IoT FleetWise is processing the
	//   registration request. This process takes approximately five minutes to complete.
	//
	//   - REGISTRATION_FAILURE - Amazon Web Services IoT FleetWise can't register the
	//   AWS resource. Try again later.
	//
	// This member is required.
	AccountStatus types.RegistrationStatus

	//  The time the account was registered, in seconds since epoch (January 1, 1970
	// at midnight UTC time).
	//
	// This member is required.
	CreationTime *time.Time

	//  The unique ID of the Amazon Web Services account, provided at account
	// creation.
	//
	// This member is required.
	CustomerAccountId *string

	//  Information about the registered IAM resources or errors, if any.
	//
	// This member is required.
	IamRegistrationResponse *types.IamRegistrationResponse

	//  The time this registration was last updated, in seconds since epoch (January
	// 1, 1970 at midnight UTC time).
	//
	// This member is required.
	LastModificationTime *time.Time

	//  Information about the registered Amazon Timestream resources or errors, if any.
	TimestreamRegistrationResponse *types.TimestreamRegistrationResponse

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetSignalCatalogInput 

type GetSignalCatalogInput struct {

	//  The name of the signal catalog to retrieve information about.
	//
	// This member is required.
	Name *string
	// contains filtered or unexported fields
}

type GetSignalCatalogOutput 

type GetSignalCatalogOutput struct {

	//  The Amazon Resource Name (ARN) of the signal catalog.
	//
	// This member is required.
	Arn *string

	//  The time the signal catalog was created in seconds since epoch (January 1,
	// 1970 at midnight UTC time).
	//
	// This member is required.
	CreationTime *time.Time

	// The last time the signal catalog was modified.
	//
	// This member is required.
	LastModificationTime *time.Time

	//  The name of the signal catalog.
	//
	// This member is required.
	Name *string

	//  A brief description of the signal catalog.
	Description *string

	//  The total number of network nodes specified in a signal catalog.
	NodeCounts *types.NodeCounts

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetStateTemplateInput added in v1.22.0 

type GetStateTemplateInput struct {

	// A unique, service-generated identifier.
	//
	// This member is required.
	Identifier *string
	// contains filtered or unexported fields
}

type GetStateTemplateOutput added in v1.22.0 

type GetStateTemplateOutput struct {

	// The Amazon Resource Name (ARN) of the state template.
	Arn *string

	// The time the state template was created in seconds since epoch (January 1, 1970
	// at midnight UTC time).
	CreationTime *time.Time

	// A list of vehicle attributes associated with the payload published on the state
	// template's MQTT topic.
	//
	// Default: An empty array
	DataExtraDimensions []string

	// A brief description of the state template.
	Description *string

	// The unique ID of the state template.
	Id *string

	// The time the state template was last updated in seconds since epoch (January 1,
	// 1970 at midnight UTC time).
	LastModificationTime *time.Time

	// A list of vehicle attributes to associate with user properties of the messages
	// published on the state template's MQTT topic.
	//
	// Default: An empty array
	MetadataExtraDimensions []string

	// The name of the state template.
	Name *string

	// The ARN of the signal catalog associated with the state template.
	SignalCatalogArn *string

	// A list of signals from which data is collected. The state template properties
	// contain the fully qualified names of the signals.
	StateTemplateProperties []string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetVehicleInput 

type GetVehicleInput struct {

	//  The ID of the vehicle to retrieve information about.
	//
	// This member is required.
	VehicleName *string
	// contains filtered or unexported fields
}

type GetVehicleOutput 

type GetVehicleOutput struct {

	//  The Amazon Resource Name (ARN) of the vehicle to retrieve information about.
	Arn *string

	// Static information about a vehicle in a key-value pair. For example:
	//
	// "engineType" : "1.3 L R2"
	Attributes map[string]string

	//  The time the vehicle was created in seconds since epoch (January 1, 1970 at
	// midnight UTC time).
	CreationTime *time.Time

	//  The ARN of a decoder manifest associated with the vehicle.
	DecoderManifestArn *string

	//  The time the vehicle was last updated in seconds since epoch (January 1, 1970
	// at midnight UTC time).
	LastModificationTime *time.Time

	//  The ARN of a vehicle model (model manifest) associated with the vehicle.
	ModelManifestArn *string

	// State templates associated with the vehicle.
	StateTemplates []types.StateTemplateAssociation

	// The ID of the vehicle.
	VehicleName *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetVehicleStatusAPIClient 

type GetVehicleStatusAPIClient interface {
	GetVehicleStatus(context.Context, *GetVehicleStatusInput, ...func(*Options)) (*GetVehicleStatusOutput, error)
}

GetVehicleStatusAPIClient is a client that implements the GetVehicleStatus operation.

type GetVehicleStatusInput 

type GetVehicleStatusInput struct {

	//  The ID of the vehicle to retrieve information about.
	//
	// This member is required.
	VehicleName *string

	// The maximum number of items to return, between 1 and 100, inclusive. This
	// parameter is only supported for resources of type CAMPAIGN .
	MaxResults *int32

	// A pagination token for the next set of results.
	//
	// If the results of a search are large, only a portion of the results are
	// returned, and a nextToken pagination token is returned in the response. To
	// retrieve the next set of results, reissue the search request and include the
	// returned token. When all results have been returned, the response does not
	// contain a pagination token value. This parameter is only supported for resources
	// of type CAMPAIGN .
	NextToken *string
	// contains filtered or unexported fields
}

type GetVehicleStatusOutput 

type GetVehicleStatusOutput struct {

	//  Lists information about the state of the vehicle with deployed campaigns.
	Campaigns []types.VehicleStatus

	//  The token to retrieve the next set of results, or null if there are no more
	// results.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetVehicleStatusPaginator 

type GetVehicleStatusPaginator struct {
	// contains filtered or unexported fields
}

GetVehicleStatusPaginator is a paginator for GetVehicleStatus

func NewGetVehicleStatusPaginator 

func NewGetVehicleStatusPaginator(client GetVehicleStatusAPIClient, params *GetVehicleStatusInput, optFns ...func(*GetVehicleStatusPaginatorOptions)) *GetVehicleStatusPaginator

NewGetVehicleStatusPaginator returns a new GetVehicleStatusPaginator

func (*GetVehicleStatusPaginator) HasMorePages 

func (p *GetVehicleStatusPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*GetVehicleStatusPaginator) NextPage 

func (p *GetVehicleStatusPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetVehicleStatusOutput, error)

NextPage retrieves the next GetVehicleStatus page.

type GetVehicleStatusPaginatorOptions 

type GetVehicleStatusPaginatorOptions struct {
	// The maximum number of items to return, between 1 and 100, inclusive. This
	// parameter is only supported for resources of type CAMPAIGN .
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

GetVehicleStatusPaginatorOptions is the paginator options for GetVehicleStatus

type HTTPClient 

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

type HTTPSignerV4 

type HTTPSignerV4 interface {
	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error
}

type ImportDecoderManifestInput 

type ImportDecoderManifestInput struct {

	//  The name of the decoder manifest to import.
	//
	// This member is required.
	Name *string

	//  The file to load into an Amazon Web Services account.
	//
	// This member is required.
	NetworkFileDefinitions []types.NetworkFileDefinition
	// contains filtered or unexported fields
}

type ImportDecoderManifestOutput 

type ImportDecoderManifestOutput struct {

	//  The Amazon Resource Name (ARN) of the decoder manifest that was imported.
	//
	// This member is required.
	Arn *string

	//  The name of the imported decoder manifest.
	//
	// This member is required.
	Name *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ImportSignalCatalogInput 

type ImportSignalCatalogInput struct {

	// The name of the signal catalog to import.
	//
	// This member is required.
	Name *string

	//  A brief description of the signal catalog.
	Description *string

	// Metadata that can be used to manage the signal catalog.
	Tags []types.Tag

	// The contents of the Vehicle Signal Specification (VSS) configuration. VSS is a
	// precise language used to describe and model signals in vehicle networks.
	Vss types.FormattedVss
	// contains filtered or unexported fields
}

type ImportSignalCatalogOutput 

type ImportSignalCatalogOutput struct {

	//  The Amazon Resource Name (ARN) of the imported signal catalog.
	//
	// This member is required.
	Arn *string

	//  The name of the imported signal catalog.
	//
	// This member is required.
	Name *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListCampaignsAPIClient 

type ListCampaignsAPIClient interface {
	ListCampaigns(context.Context, *ListCampaignsInput, ...func(*Options)) (*ListCampaignsOutput, error)
}

ListCampaignsAPIClient is a client that implements the ListCampaigns operation.

type ListCampaignsInput 

type ListCampaignsInput struct {

	// The maximum number of items to return, between 1 and 100, inclusive.
	MaxResults *int32

	// A pagination token for the next set of results.
	//
	// If the results of a search are large, only a portion of the results are
	// returned, and a nextToken pagination token is returned in the response. To
	// retrieve the next set of results, reissue the search request and include the
	// returned token. When all results have been returned, the response does not
	// contain a pagination token value.
	NextToken *string

	// An optional parameter to filter the results by the status of each created
	// campaign in your account. The status can be one of: CREATING ,
	// WAITING_FOR_APPROVAL , RUNNING , or SUSPENDED .
	Status *string
	// contains filtered or unexported fields
}

type ListCampaignsOutput 

type ListCampaignsOutput struct {

	//  A summary of information about each campaign.
	CampaignSummaries []types.CampaignSummary

	//  The token to retrieve the next set of results, or null if there are no more
	// results.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListCampaignsPaginator 

type ListCampaignsPaginator struct {
	// contains filtered or unexported fields
}

ListCampaignsPaginator is a paginator for ListCampaigns

func NewListCampaignsPaginator 

func NewListCampaignsPaginator(client ListCampaignsAPIClient, params *ListCampaignsInput, optFns ...func(*ListCampaignsPaginatorOptions)) *ListCampaignsPaginator

NewListCampaignsPaginator returns a new ListCampaignsPaginator

func (*ListCampaignsPaginator) HasMorePages 

func (p *ListCampaignsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListCampaignsPaginator) NextPage 

func (p *ListCampaignsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListCampaignsOutput, error)

NextPage retrieves the next ListCampaigns page.

type ListCampaignsPaginatorOptions 

type ListCampaignsPaginatorOptions struct {
	// The maximum number of items to return, between 1 and 100, inclusive.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListCampaignsPaginatorOptions is the paginator options for ListCampaigns

type ListDecoderManifestNetworkInterfacesAPIClient 

type ListDecoderManifestNetworkInterfacesAPIClient interface {
	ListDecoderManifestNetworkInterfaces(context.Context, *ListDecoderManifestNetworkInterfacesInput, ...func(*Options)) (*ListDecoderManifestNetworkInterfacesOutput, error)
}

ListDecoderManifestNetworkInterfacesAPIClient is a client that implements the ListDecoderManifestNetworkInterfaces operation.

type ListDecoderManifestNetworkInterfacesInput 

type ListDecoderManifestNetworkInterfacesInput struct {

	//  The name of the decoder manifest to list information about.
	//
	// This member is required.
	Name *string

	// The maximum number of items to return, between 1 and 100, inclusive.
	MaxResults *int32

	// A pagination token for the next set of results.
	//
	// If the results of a search are large, only a portion of the results are
	// returned, and a nextToken pagination token is returned in the response. To
	// retrieve the next set of results, reissue the search request and include the
	// returned token. When all results have been returned, the response does not
	// contain a pagination token value.
	NextToken *string
	// contains filtered or unexported fields
}

type ListDecoderManifestNetworkInterfacesOutput 

type ListDecoderManifestNetworkInterfacesOutput struct {

	//  A list of information about network interfaces.
	NetworkInterfaces []types.NetworkInterface

	//  The token to retrieve the next set of results, or null if there are no more
	// results.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListDecoderManifestNetworkInterfacesPaginator 

type ListDecoderManifestNetworkInterfacesPaginator struct {
	// contains filtered or unexported fields
}

ListDecoderManifestNetworkInterfacesPaginator is a paginator for ListDecoderManifestNetworkInterfaces

func NewListDecoderManifestNetworkInterfacesPaginator 

func NewListDecoderManifestNetworkInterfacesPaginator(client ListDecoderManifestNetworkInterfacesAPIClient, params *ListDecoderManifestNetworkInterfacesInput, optFns ...func(*ListDecoderManifestNetworkInterfacesPaginatorOptions)) *ListDecoderManifestNetworkInterfacesPaginator

NewListDecoderManifestNetworkInterfacesPaginator returns a new ListDecoderManifestNetworkInterfacesPaginator

func (*ListDecoderManifestNetworkInterfacesPaginator) HasMorePages 

func (p *ListDecoderManifestNetworkInterfacesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListDecoderManifestNetworkInterfacesPaginator) NextPage 

func (p *ListDecoderManifestNetworkInterfacesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListDecoderManifestNetworkInterfacesOutput, error)

NextPage retrieves the next ListDecoderManifestNetworkInterfaces page.

type ListDecoderManifestNetworkInterfacesPaginatorOptions 

type ListDecoderManifestNetworkInterfacesPaginatorOptions struct {
	// The maximum number of items to return, between 1 and 100, inclusive.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListDecoderManifestNetworkInterfacesPaginatorOptions is the paginator options for ListDecoderManifestNetworkInterfaces

type ListDecoderManifestSignalsAPIClient 

type ListDecoderManifestSignalsAPIClient interface {
	ListDecoderManifestSignals(context.Context, *ListDecoderManifestSignalsInput, ...func(*Options)) (*ListDecoderManifestSignalsOutput, error)
}

ListDecoderManifestSignalsAPIClient is a client that implements the ListDecoderManifestSignals operation.

type ListDecoderManifestSignalsInput 

type ListDecoderManifestSignalsInput struct {

	//  The name of the decoder manifest to list information about.
	//
	// This member is required.
	Name *string

	// The maximum number of items to return, between 1 and 100, inclusive.
	MaxResults *int32

	// A pagination token for the next set of results.
	//
	// If the results of a search are large, only a portion of the results are
	// returned, and a nextToken pagination token is returned in the response. To
	// retrieve the next set of results, reissue the search request and include the
	// returned token. When all results have been returned, the response does not
	// contain a pagination token value.
	NextToken *string
	// contains filtered or unexported fields
}

type ListDecoderManifestSignalsOutput 

type ListDecoderManifestSignalsOutput struct {

	//  The token to retrieve the next set of results, or null if there are no more
	// results.
	NextToken *string

	//  Information about a list of signals to decode.
	SignalDecoders []types.SignalDecoder

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListDecoderManifestSignalsPaginator 

type ListDecoderManifestSignalsPaginator struct {
	// contains filtered or unexported fields
}

ListDecoderManifestSignalsPaginator is a paginator for ListDecoderManifestSignals

func NewListDecoderManifestSignalsPaginator 

func NewListDecoderManifestSignalsPaginator(client ListDecoderManifestSignalsAPIClient, params *ListDecoderManifestSignalsInput, optFns ...func(*ListDecoderManifestSignalsPaginatorOptions)) *ListDecoderManifestSignalsPaginator

NewListDecoderManifestSignalsPaginator returns a new ListDecoderManifestSignalsPaginator

func (*ListDecoderManifestSignalsPaginator) HasMorePages 

func (p *ListDecoderManifestSignalsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListDecoderManifestSignalsPaginator) NextPage 

func (p *ListDecoderManifestSignalsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListDecoderManifestSignalsOutput, error)

NextPage retrieves the next ListDecoderManifestSignals page.

type ListDecoderManifestSignalsPaginatorOptions 

type ListDecoderManifestSignalsPaginatorOptions struct {
	// The maximum number of items to return, between 1 and 100, inclusive.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListDecoderManifestSignalsPaginatorOptions is the paginator options for ListDecoderManifestSignals

type ListDecoderManifestsAPIClient 

type ListDecoderManifestsAPIClient interface {
	ListDecoderManifests(context.Context, *ListDecoderManifestsInput, ...func(*Options)) (*ListDecoderManifestsOutput, error)
}

ListDecoderManifestsAPIClient is a client that implements the ListDecoderManifests operation.

type ListDecoderManifestsInput 

type ListDecoderManifestsInput struct {

	// The maximum number of items to return, between 1 and 100, inclusive.
	MaxResults *int32

	//  The Amazon Resource Name (ARN) of a vehicle model (model manifest) associated
	// with the decoder manifest.
	ModelManifestArn *string

	// A pagination token for the next set of results.
	//
	// If the results of a search are large, only a portion of the results are
	// returned, and a nextToken pagination token is returned in the response. To
	// retrieve the next set of results, reissue the search request and include the
	// returned token. When all results have been returned, the response does not
	// contain a pagination token value.
	NextToken *string
	// contains filtered or unexported fields
}

type ListDecoderManifestsOutput 

type ListDecoderManifestsOutput struct {

	//  The token to retrieve the next set of results, or null if there are no more
	// results.
	NextToken *string

	//  A list of information about each decoder manifest.
	Summaries []types.DecoderManifestSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListDecoderManifestsPaginator 

type ListDecoderManifestsPaginator struct {
	// contains filtered or unexported fields
}

ListDecoderManifestsPaginator is a paginator for ListDecoderManifests

func NewListDecoderManifestsPaginator 

func NewListDecoderManifestsPaginator(client ListDecoderManifestsAPIClient, params *ListDecoderManifestsInput, optFns ...func(*ListDecoderManifestsPaginatorOptions)) *ListDecoderManifestsPaginator

NewListDecoderManifestsPaginator returns a new ListDecoderManifestsPaginator

func (*ListDecoderManifestsPaginator) HasMorePages 

func (p *ListDecoderManifestsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListDecoderManifestsPaginator) NextPage 

func (p *ListDecoderManifestsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListDecoderManifestsOutput, error)

NextPage retrieves the next ListDecoderManifests page.

type ListDecoderManifestsPaginatorOptions 

type ListDecoderManifestsPaginatorOptions struct {
	// The maximum number of items to return, between 1 and 100, inclusive.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListDecoderManifestsPaginatorOptions is the paginator options for ListDecoderManifests

type ListFleetsAPIClient 

type ListFleetsAPIClient interface {
	ListFleets(context.Context, *ListFleetsInput, ...func(*Options)) (*ListFleetsOutput, error)
}

ListFleetsAPIClient is a client that implements the ListFleets operation.

type ListFleetsForVehicleAPIClient 

type ListFleetsForVehicleAPIClient interface {
	ListFleetsForVehicle(context.Context, *ListFleetsForVehicleInput, ...func(*Options)) (*ListFleetsForVehicleOutput, error)
}

ListFleetsForVehicleAPIClient is a client that implements the ListFleetsForVehicle operation.

type ListFleetsForVehicleInput 

type ListFleetsForVehicleInput struct {

	//  The ID of the vehicle to retrieve information about.
	//
	// This member is required.
	VehicleName *string

	// The maximum number of items to return, between 1 and 100, inclusive.
	MaxResults *int32

	// A pagination token for the next set of results.
	//
	// If the results of a search are large, only a portion of the results are
	// returned, and a nextToken pagination token is returned in the response. To
	// retrieve the next set of results, reissue the search request and include the
	// returned token. When all results have been returned, the response does not
	// contain a pagination token value.
	NextToken *string
	// contains filtered or unexported fields
}

type ListFleetsForVehicleOutput 

type ListFleetsForVehicleOutput struct {

	//  A list of fleet IDs that the vehicle is associated with.
	Fleets []string

	//  The token to retrieve the next set of results, or null if there are no more
	// results.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListFleetsForVehiclePaginator 

type ListFleetsForVehiclePaginator struct {
	// contains filtered or unexported fields
}

ListFleetsForVehiclePaginator is a paginator for ListFleetsForVehicle

func NewListFleetsForVehiclePaginator 

func NewListFleetsForVehiclePaginator(client ListFleetsForVehicleAPIClient, params *ListFleetsForVehicleInput, optFns ...func(*ListFleetsForVehiclePaginatorOptions)) *ListFleetsForVehiclePaginator

NewListFleetsForVehiclePaginator returns a new ListFleetsForVehiclePaginator

func (*ListFleetsForVehiclePaginator) HasMorePages 

func (p *ListFleetsForVehiclePaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListFleetsForVehiclePaginator) NextPage 

func (p *ListFleetsForVehiclePaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListFleetsForVehicleOutput, error)

NextPage retrieves the next ListFleetsForVehicle page.

type ListFleetsForVehiclePaginatorOptions 

type ListFleetsForVehiclePaginatorOptions struct {
	// The maximum number of items to return, between 1 and 100, inclusive.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListFleetsForVehiclePaginatorOptions is the paginator options for ListFleetsForVehicle

type ListFleetsInput 

type ListFleetsInput struct {

	// The maximum number of items to return, between 1 and 100, inclusive.
	MaxResults *int32

	// A pagination token for the next set of results.
	//
	// If the results of a search are large, only a portion of the results are
	// returned, and a nextToken pagination token is returned in the response. To
	// retrieve the next set of results, reissue the search request and include the
	// returned token. When all results have been returned, the response does not
	// contain a pagination token value.
	NextToken *string
	// contains filtered or unexported fields
}

type ListFleetsOutput 

type ListFleetsOutput struct {

	//  A list of information for each fleet.
	FleetSummaries []types.FleetSummary

	//  The token to retrieve the next set of results, or null if there are no more
	// results.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListFleetsPaginator 

type ListFleetsPaginator struct {
	// contains filtered or unexported fields
}

ListFleetsPaginator is a paginator for ListFleets

func NewListFleetsPaginator 

func NewListFleetsPaginator(client ListFleetsAPIClient, params *ListFleetsInput, optFns ...func(*ListFleetsPaginatorOptions)) *ListFleetsPaginator

NewListFleetsPaginator returns a new ListFleetsPaginator

func (*ListFleetsPaginator) HasMorePages 

func (p *ListFleetsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListFleetsPaginator) NextPage 

func (p *ListFleetsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListFleetsOutput, error)

NextPage retrieves the next ListFleets page.

type ListFleetsPaginatorOptions 

type ListFleetsPaginatorOptions struct {
	// The maximum number of items to return, between 1 and 100, inclusive.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListFleetsPaginatorOptions is the paginator options for ListFleets

type ListModelManifestNodesAPIClient 

type ListModelManifestNodesAPIClient interface {
	ListModelManifestNodes(context.Context, *ListModelManifestNodesInput, ...func(*Options)) (*ListModelManifestNodesOutput, error)
}

ListModelManifestNodesAPIClient is a client that implements the ListModelManifestNodes operation.

type ListModelManifestNodesInput 

type ListModelManifestNodesInput struct {

	//  The name of the vehicle model to list information about.
	//
	// This member is required.
	Name *string

	// The maximum number of items to return, between 1 and 100, inclusive.
	MaxResults *int32

	// A pagination token for the next set of results.
	//
	// If the results of a search are large, only a portion of the results are
	// returned, and a nextToken pagination token is returned in the response. To
	// retrieve the next set of results, reissue the search request and include the
	// returned token. When all results have been returned, the response does not
	// contain a pagination token value.
	NextToken *string
	// contains filtered or unexported fields
}

type ListModelManifestNodesOutput 

type ListModelManifestNodesOutput struct {

	//  The token to retrieve the next set of results, or null if there are no more
	// results.
	NextToken *string

	//  A list of information about nodes.
	Nodes []types.Node

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListModelManifestNodesPaginator 

type ListModelManifestNodesPaginator struct {
	// contains filtered or unexported fields
}

ListModelManifestNodesPaginator is a paginator for ListModelManifestNodes

func NewListModelManifestNodesPaginator 

func NewListModelManifestNodesPaginator(client ListModelManifestNodesAPIClient, params *ListModelManifestNodesInput, optFns ...func(*ListModelManifestNodesPaginatorOptions)) *ListModelManifestNodesPaginator

NewListModelManifestNodesPaginator returns a new ListModelManifestNodesPaginator

func (*ListModelManifestNodesPaginator) HasMorePages 

func (p *ListModelManifestNodesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListModelManifestNodesPaginator) NextPage 

func (p *ListModelManifestNodesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListModelManifestNodesOutput, error)

NextPage retrieves the next ListModelManifestNodes page.

type ListModelManifestNodesPaginatorOptions 

type ListModelManifestNodesPaginatorOptions struct {
	// The maximum number of items to return, between 1 and 100, inclusive.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListModelManifestNodesPaginatorOptions is the paginator options for ListModelManifestNodes

type ListModelManifestsAPIClient 

type ListModelManifestsAPIClient interface {
	ListModelManifests(context.Context, *ListModelManifestsInput, ...func(*Options)) (*ListModelManifestsOutput, error)
}

ListModelManifestsAPIClient is a client that implements the ListModelManifests operation.

type ListModelManifestsInput 

type ListModelManifestsInput struct {

	// The maximum number of items to return, between 1 and 100, inclusive.
	MaxResults *int32

	// A pagination token for the next set of results.
	//
	// If the results of a search are large, only a portion of the results are
	// returned, and a nextToken pagination token is returned in the response. To
	// retrieve the next set of results, reissue the search request and include the
	// returned token. When all results have been returned, the response does not
	// contain a pagination token value.
	NextToken *string

	//  The ARN of a signal catalog. If you specify a signal catalog, only the vehicle
	// models associated with it are returned.
	SignalCatalogArn *string
	// contains filtered or unexported fields
}

type ListModelManifestsOutput 

type ListModelManifestsOutput struct {

	//  The token to retrieve the next set of results, or null if there are no more
	// results.
	NextToken *string

	//  A list of information about vehicle models.
	Summaries []types.ModelManifestSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListModelManifestsPaginator 

type ListModelManifestsPaginator struct {
	// contains filtered or unexported fields
}

ListModelManifestsPaginator is a paginator for ListModelManifests

func NewListModelManifestsPaginator 

func NewListModelManifestsPaginator(client ListModelManifestsAPIClient, params *ListModelManifestsInput, optFns ...func(*ListModelManifestsPaginatorOptions)) *ListModelManifestsPaginator

NewListModelManifestsPaginator returns a new ListModelManifestsPaginator

func (*ListModelManifestsPaginator) HasMorePages 

func (p *ListModelManifestsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListModelManifestsPaginator) NextPage 

func (p *ListModelManifestsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListModelManifestsOutput, error)

NextPage retrieves the next ListModelManifests page.

type ListModelManifestsPaginatorOptions 

type ListModelManifestsPaginatorOptions struct {
	// The maximum number of items to return, between 1 and 100, inclusive.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListModelManifestsPaginatorOptions is the paginator options for ListModelManifests

type ListSignalCatalogNodesAPIClient 

type ListSignalCatalogNodesAPIClient interface {
	ListSignalCatalogNodes(context.Context, *ListSignalCatalogNodesInput, ...func(*Options)) (*ListSignalCatalogNodesOutput, error)
}

ListSignalCatalogNodesAPIClient is a client that implements the ListSignalCatalogNodes operation.

type ListSignalCatalogNodesInput 

type ListSignalCatalogNodesInput struct {

	//  The name of the signal catalog to list information about.
	//
	// This member is required.
	Name *string

	// The maximum number of items to return, between 1 and 100, inclusive.
	MaxResults *int32

	// A pagination token for the next set of results.
	//
	// If the results of a search are large, only a portion of the results are
	// returned, and a nextToken pagination token is returned in the response. To
	// retrieve the next set of results, reissue the search request and include the
	// returned token. When all results have been returned, the response does not
	// contain a pagination token value.
	NextToken *string

	// The type of node in the signal catalog.
	SignalNodeType types.SignalNodeType
	// contains filtered or unexported fields
}

type ListSignalCatalogNodesOutput 

type ListSignalCatalogNodesOutput struct {

	//  The token to retrieve the next set of results, or null if there are no more
	// results.
	NextToken *string

	//  A list of information about nodes.
	Nodes []types.Node

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListSignalCatalogNodesPaginator 

type ListSignalCatalogNodesPaginator struct {
	// contains filtered or unexported fields
}

ListSignalCatalogNodesPaginator is a paginator for ListSignalCatalogNodes

func NewListSignalCatalogNodesPaginator 

func NewListSignalCatalogNodesPaginator(client ListSignalCatalogNodesAPIClient, params *ListSignalCatalogNodesInput, optFns ...func(*ListSignalCatalogNodesPaginatorOptions)) *ListSignalCatalogNodesPaginator

NewListSignalCatalogNodesPaginator returns a new ListSignalCatalogNodesPaginator

func (*ListSignalCatalogNodesPaginator) HasMorePages 

func (p *ListSignalCatalogNodesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListSignalCatalogNodesPaginator) NextPage 

func (p *ListSignalCatalogNodesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListSignalCatalogNodesOutput, error)

NextPage retrieves the next ListSignalCatalogNodes page.

type ListSignalCatalogNodesPaginatorOptions 

type ListSignalCatalogNodesPaginatorOptions struct {
	// The maximum number of items to return, between 1 and 100, inclusive.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListSignalCatalogNodesPaginatorOptions is the paginator options for ListSignalCatalogNodes

type ListSignalCatalogsAPIClient 

type ListSignalCatalogsAPIClient interface {
	ListSignalCatalogs(context.Context, *ListSignalCatalogsInput, ...func(*Options)) (*ListSignalCatalogsOutput, error)
}

ListSignalCatalogsAPIClient is a client that implements the ListSignalCatalogs operation.

type ListSignalCatalogsInput 

type ListSignalCatalogsInput struct {

	// The maximum number of items to return, between 1 and 100, inclusive.
	MaxResults *int32

	// A pagination token for the next set of results.
	//
	// If the results of a search are large, only a portion of the results are
	// returned, and a nextToken pagination token is returned in the response. To
	// retrieve the next set of results, reissue the search request and include the
	// returned token. When all results have been returned, the response does not
	// contain a pagination token value.
	NextToken *string
	// contains filtered or unexported fields
}

type ListSignalCatalogsOutput 

type ListSignalCatalogsOutput struct {

	//  The token to retrieve the next set of results, or null if there are no more
	// results.
	NextToken *string

	//  A list of information about each signal catalog.
	Summaries []types.SignalCatalogSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListSignalCatalogsPaginator 

type ListSignalCatalogsPaginator struct {
	// contains filtered or unexported fields
}

ListSignalCatalogsPaginator is a paginator for ListSignalCatalogs

func NewListSignalCatalogsPaginator 

func NewListSignalCatalogsPaginator(client ListSignalCatalogsAPIClient, params *ListSignalCatalogsInput, optFns ...func(*ListSignalCatalogsPaginatorOptions)) *ListSignalCatalogsPaginator

NewListSignalCatalogsPaginator returns a new ListSignalCatalogsPaginator

func (*ListSignalCatalogsPaginator) HasMorePages 

func (p *ListSignalCatalogsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListSignalCatalogsPaginator) NextPage 

func (p *ListSignalCatalogsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListSignalCatalogsOutput, error)

NextPage retrieves the next ListSignalCatalogs page.

type ListSignalCatalogsPaginatorOptions 

type ListSignalCatalogsPaginatorOptions struct {
	// The maximum number of items to return, between 1 and 100, inclusive.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListSignalCatalogsPaginatorOptions is the paginator options for ListSignalCatalogs

type ListStateTemplatesAPIClient added in v1.22.0 

type ListStateTemplatesAPIClient interface {
	ListStateTemplates(context.Context, *ListStateTemplatesInput, ...func(*Options)) (*ListStateTemplatesOutput, error)
}

ListStateTemplatesAPIClient is a client that implements the ListStateTemplates operation.

type ListStateTemplatesInput added in v1.22.0 

type ListStateTemplatesInput struct {

	// The maximum number of items to return, between 1 and 100, inclusive.
	MaxResults *int32

	//  The token to retrieve the next set of results, or null if there are no more
	// results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListStateTemplatesOutput added in v1.22.0 

type ListStateTemplatesOutput struct {

	//  The token to retrieve the next set of results, or null if there are no more
	// results.
	NextToken *string

	// A list of information about each state template.
	Summaries []types.StateTemplateSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListStateTemplatesPaginator added in v1.22.0 

type ListStateTemplatesPaginator struct {
	// contains filtered or unexported fields
}

ListStateTemplatesPaginator is a paginator for ListStateTemplates

func NewListStateTemplatesPaginator added in v1.22.0 

func NewListStateTemplatesPaginator(client ListStateTemplatesAPIClient, params *ListStateTemplatesInput, optFns ...func(*ListStateTemplatesPaginatorOptions)) *ListStateTemplatesPaginator

NewListStateTemplatesPaginator returns a new ListStateTemplatesPaginator

func (*ListStateTemplatesPaginator) HasMorePages added in v1.22.0 

func (p *ListStateTemplatesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListStateTemplatesPaginator) NextPage added in v1.22.0 

func (p *ListStateTemplatesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListStateTemplatesOutput, error)

NextPage retrieves the next ListStateTemplates page.

type ListStateTemplatesPaginatorOptions added in v1.22.0 

type ListStateTemplatesPaginatorOptions struct {
	// The maximum number of items to return, between 1 and 100, inclusive.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListStateTemplatesPaginatorOptions is the paginator options for ListStateTemplates

type ListTagsForResourceInput 

type ListTagsForResourceInput struct {

	// The ARN of the resource.
	//
	// This member is required.
	ResourceARN *string
	// contains filtered or unexported fields
}

type ListTagsForResourceOutput 

type ListTagsForResourceOutput struct {

	// The list of tags assigned to the resource.
	Tags []types.Tag

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListVehiclesAPIClient 

type ListVehiclesAPIClient interface {
	ListVehicles(context.Context, *ListVehiclesInput, ...func(*Options)) (*ListVehiclesOutput, error)
}

ListVehiclesAPIClient is a client that implements the ListVehicles operation.

type ListVehiclesInFleetAPIClient 

type ListVehiclesInFleetAPIClient interface {
	ListVehiclesInFleet(context.Context, *ListVehiclesInFleetInput, ...func(*Options)) (*ListVehiclesInFleetOutput, error)
}

ListVehiclesInFleetAPIClient is a client that implements the ListVehiclesInFleet operation.

type ListVehiclesInFleetInput 

type ListVehiclesInFleetInput struct {

	//  The ID of a fleet.
	//
	// This member is required.
	FleetId *string

	// The maximum number of items to return, between 1 and 100, inclusive.
	MaxResults *int32

	// A pagination token for the next set of results.
	//
	// If the results of a search are large, only a portion of the results are
	// returned, and a nextToken pagination token is returned in the response. To
	// retrieve the next set of results, reissue the search request and include the
	// returned token. When all results have been returned, the response does not
	// contain a pagination token value.
	NextToken *string
	// contains filtered or unexported fields
}

type ListVehiclesInFleetOutput 

type ListVehiclesInFleetOutput struct {

	//  The token to retrieve the next set of results, or null if there are no more
	// results.
	NextToken *string

	//  A list of vehicles associated with the fleet.
	Vehicles []string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListVehiclesInFleetPaginator 

type ListVehiclesInFleetPaginator struct {
	// contains filtered or unexported fields
}

ListVehiclesInFleetPaginator is a paginator for ListVehiclesInFleet

func NewListVehiclesInFleetPaginator 

func NewListVehiclesInFleetPaginator(client ListVehiclesInFleetAPIClient, params *ListVehiclesInFleetInput, optFns ...func(*ListVehiclesInFleetPaginatorOptions)) *ListVehiclesInFleetPaginator

NewListVehiclesInFleetPaginator returns a new ListVehiclesInFleetPaginator

func (*ListVehiclesInFleetPaginator) HasMorePages 

func (p *ListVehiclesInFleetPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListVehiclesInFleetPaginator) NextPage 

func (p *ListVehiclesInFleetPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListVehiclesInFleetOutput, error)

NextPage retrieves the next ListVehiclesInFleet page.

type ListVehiclesInFleetPaginatorOptions 

type ListVehiclesInFleetPaginatorOptions struct {
	// The maximum number of items to return, between 1 and 100, inclusive.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListVehiclesInFleetPaginatorOptions is the paginator options for ListVehiclesInFleet

type ListVehiclesInput 

type ListVehiclesInput struct {

	// The fully qualified names of the attributes. You can use this optional
	// parameter to list the vehicles containing all the attributes in the request. For
	// example, attributeNames could be " Vehicle.Body.Engine.Type, Vehicle.Color " and
	// the corresponding attributeValues could be " 1.3 L R2, Blue " . In this case,
	// the API will filter vehicles with an attribute name Vehicle.Body.Engine.Type
	// that contains a value of 1.3 L R2 AND an attribute name Vehicle.Color that
	// contains a value of " Blue ". A request must contain unique values for the
	// attributeNames filter and the matching number of attributeValues filters to
	// return the subset of vehicles that match the attributes filter condition.
	AttributeNames []string

	// Static information about a vehicle attribute value in string format. You can
	// use this optional parameter in conjunction with attributeNames to list the
	// vehicles containing all the attributeValues corresponding to the attributeNames
	// filter. For example, attributeValues could be " 1.3 L R2, Blue " and the
	// corresponding attributeNames filter could be " Vehicle.Body.Engine.Type,
	// Vehicle.Color ". In this case, the API will filter vehicles with attribute name
	// Vehicle.Body.Engine.Type that contains a value of 1.3 L R2 AND an attribute
	// name Vehicle.Color that contains a value of " Blue ". A request must contain
	// unique values for the attributeNames filter and the matching number of
	// attributeValues filter to return the subset of vehicles that match the
	// attributes filter condition.
	AttributeValues []string

	// The maximum number of items to return, between 1 and 100, inclusive.
	MaxResults *int32

	//  The Amazon Resource Name (ARN) of a vehicle model (model manifest). You can
	// use this optional parameter to list only the vehicles created from a certain
	// vehicle model.
	ModelManifestArn *string

	// A pagination token for the next set of results.
	//
	// If the results of a search are large, only a portion of the results are
	// returned, and a nextToken pagination token is returned in the response. To
	// retrieve the next set of results, reissue the search request and include the
	// returned token. When all results have been returned, the response does not
	// contain a pagination token value.
	NextToken *string
	// contains filtered or unexported fields
}

type ListVehiclesOutput 

type ListVehiclesOutput struct {

	//  The token to retrieve the next set of results, or null if there are no more
	// results.
	NextToken *string

	//  A list of vehicles and information about them.
	VehicleSummaries []types.VehicleSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListVehiclesPaginator 

type ListVehiclesPaginator struct {
	// contains filtered or unexported fields
}

ListVehiclesPaginator is a paginator for ListVehicles

func NewListVehiclesPaginator 

func NewListVehiclesPaginator(client ListVehiclesAPIClient, params *ListVehiclesInput, optFns ...func(*ListVehiclesPaginatorOptions)) *ListVehiclesPaginator

NewListVehiclesPaginator returns a new ListVehiclesPaginator

func (*ListVehiclesPaginator) HasMorePages 

func (p *ListVehiclesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListVehiclesPaginator) NextPage 

func (p *ListVehiclesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListVehiclesOutput, error)

NextPage retrieves the next ListVehicles page.

type ListVehiclesPaginatorOptions 

type ListVehiclesPaginatorOptions struct {
	// The maximum number of items to return, between 1 and 100, inclusive.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListVehiclesPaginatorOptions is the paginator options for ListVehicles

type Options 

type Options struct {
	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	APIOptions []func(*middleware.Stack) error

	// The optional application specific identifier appended to the User-Agent header.
	AppID string

	// This endpoint will be given as input to an EndpointResolverV2. It is used for
	// providing a custom base endpoint that is subject to modifications by the
	// processing EndpointResolverV2.
	BaseEndpoint *string

	// Configures the events that will be sent to the configured logger.
	ClientLogMode aws.ClientLogMode

	// The credentials object to use when signing requests.
	Credentials aws.CredentialsProvider

	// The configuration DefaultsMode that the SDK should use when constructing the
	// clients initial default settings.
	DefaultsMode aws.DefaultsMode

	// The endpoint options to be used when attempting to resolve an endpoint.
	EndpointOptions EndpointResolverOptions

	// The service endpoint resolver.
	//
	// Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a
	// value for this field will likely prevent you from using any endpoint-related
	// service features released after the introduction of EndpointResolverV2 and
	// BaseEndpoint.
	//
	// To migrate an EndpointResolver implementation that uses a custom endpoint, set
	// the client option BaseEndpoint instead.
	EndpointResolver EndpointResolver

	// Resolves the endpoint used for a particular service operation. This should be
	// used over the deprecated EndpointResolver.
	EndpointResolverV2 EndpointResolverV2

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// The logger writer interface to write logging messages to.
	Logger logging.Logger

	// The client meter provider.
	MeterProvider metrics.MeterProvider

	// The region to send requests to. (Required)
	Region string

	// RetryMaxAttempts specifies the maximum number attempts an API client will call
	// an operation that fails with a retryable error. A value of 0 is ignored, and
	// will not be used to configure the API client created default retryer, or modify
	// per operation call's retry max attempts.
	//
	// If specified in an operation call's functional options with a value that is
	// different than the constructed client's Options, the Client's Retryer will be
	// wrapped to use the operation's specific RetryMaxAttempts value.
	RetryMaxAttempts int

	// RetryMode specifies the retry mode the API client will be created with, if
	// Retryer option is not also specified.
	//
	// When creating a new API Clients this member will only be used if the Retryer
	// Options member is nil. This value will be ignored if Retryer is not nil.
	//
	// Currently does not support per operation call overrides, may in the future.
	RetryMode aws.RetryMode

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer. The kind of
	// default retry created by the API client can be changed with the RetryMode
	// option.
	Retryer aws.Retryer

	// The RuntimeEnvironment configuration, only populated if the DefaultsMode is set
	// to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You
	// should not populate this structure programmatically, or rely on the values here
	// within your applications.
	RuntimeEnvironment aws.RuntimeEnvironment

	// The client tracer provider.
	TracerProvider tracing.TracerProvider

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient

	// The auth scheme resolver which determines how to authenticate for each
	// operation.
	AuthSchemeResolver AuthSchemeResolver

	// The list of auth schemes supported by the client.
	AuthSchemes []smithyhttp.AuthScheme
	// contains filtered or unexported fields
}

func (Options) Copy 

func (o Options) Copy() Options

Copy creates a clone where the APIOptions list is deep copied.

func (Options) GetIdentityResolver added in v1.8.2 

func (o Options) GetIdentityResolver(schemeID string) smithyauth.IdentityResolver

type PutEncryptionConfigurationInput added in v1.6.0 

type PutEncryptionConfigurationInput struct {

	// The type of encryption. Choose KMS_BASED_ENCRYPTION to use a KMS key or
	// FLEETWISE_DEFAULT_ENCRYPTION to use an Amazon Web Services managed key.
	//
	// This member is required.
	EncryptionType types.EncryptionType

	// The ID of the KMS key that is used for encryption.
	KmsKeyId *string
	// contains filtered or unexported fields
}

type PutEncryptionConfigurationOutput added in v1.6.0 

type PutEncryptionConfigurationOutput struct {

	// The encryption status.
	//
	// This member is required.
	EncryptionStatus types.EncryptionStatus

	// The type of encryption. Set to KMS_BASED_ENCRYPTION to use an KMS key that you
	// own and manage. Set to FLEETWISE_DEFAULT_ENCRYPTION to use an Amazon Web
	// Services managed key that is owned by the Amazon Web Services IoT FleetWise
	// service account.
	//
	// This member is required.
	EncryptionType types.EncryptionType

	// The ID of the KMS key that is used for encryption.
	KmsKeyId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type PutLoggingOptionsInput 

type PutLoggingOptionsInput struct {

	// Creates or updates the log delivery option to Amazon CloudWatch Logs.
	//
	// This member is required.
	CloudWatchLogDelivery *types.CloudWatchLogDeliveryOptions
	// contains filtered or unexported fields
}

type PutLoggingOptionsOutput 

type PutLoggingOptionsOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type RegisterAccountInput 

type RegisterAccountInput struct {

	// The IAM resource that allows Amazon Web Services IoT FleetWise to send data to
	// Amazon Timestream.
	//
	// Deprecated: iamResources is no longer used or needed as input
	IamResources *types.IamResources

	// The registered Amazon Timestream resources that Amazon Web Services IoT
	// FleetWise edge agent software can transfer your vehicle data to.
	//
	// Deprecated: Amazon Timestream metadata is now passed in the CreateCampaign API.
	TimestreamResources *types.TimestreamResources
	// contains filtered or unexported fields
}

type RegisterAccountOutput 

type RegisterAccountOutput struct {

	//  The time the account was registered, in seconds since epoch (January 1, 1970
	// at midnight UTC time).
	//
	// This member is required.
	CreationTime *time.Time

	//  The registered IAM resource that allows Amazon Web Services IoT FleetWise to
	// send data to Amazon Timestream.
	//
	// This member is required.
	IamResources *types.IamResources

	//  The time this registration was last updated, in seconds since epoch (January
	// 1, 1970 at midnight UTC time).
	//
	// This member is required.
	LastModificationTime *time.Time

	//  The status of registering your Amazon Web Services account, IAM role, and
	// Timestream resources.
	//
	// This member is required.
	RegisterAccountStatus types.RegistrationStatus

	// The registered Amazon Timestream resources that Amazon Web Services IoT
	// FleetWise edge agent software can transfer your vehicle data to.
	TimestreamResources *types.TimestreamResources

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ResolveEndpoint 

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

func (*ResolveEndpoint) HandleSerialize 

func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) (
	out middleware.SerializeOutput, metadata middleware.Metadata, err error,
)

func (*ResolveEndpoint) ID 

func (*ResolveEndpoint) ID() string

type TagResourceInput 

type TagResourceInput struct {

	// The ARN of the resource.
	//
	// This member is required.
	ResourceARN *string

	// The new or modified tags for the resource.
	//
	// This member is required.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type TagResourceOutput 

type TagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UntagResourceInput 

type UntagResourceInput struct {

	// The ARN of the resource.
	//
	// This member is required.
	ResourceARN *string

	// A list of the keys of the tags to be removed from the resource.
	//
	// This member is required.
	TagKeys []string
	// contains filtered or unexported fields
}

type UntagResourceOutput 

type UntagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateCampaignInput 

type UpdateCampaignInput struct {

	//  Specifies how to update a campaign. The action can be one of the following:
	//
	//   - APPROVE - To approve delivering a data collection scheme to vehicles.
	//
	//   - SUSPEND - To suspend collecting signal data. The campaign is deleted from
	//   vehicles and all vehicles in the suspended campaign will stop sending data.
	//
	//   - RESUME - To reactivate the SUSPEND campaign. The campaign is redeployed to
	//   all vehicles and the vehicles will resume sending data.
	//
	//   - UPDATE - To update a campaign.
	//
	// This member is required.
	Action types.UpdateCampaignAction

	//  The name of the campaign to update.
	//
	// This member is required.
	Name *string

	//  A list of vehicle attributes to associate with a signal.
	//
	// Default: An empty array
	DataExtraDimensions []string

	// The description of the campaign.
	Description *string
	// contains filtered or unexported fields
}

type UpdateCampaignOutput 

type UpdateCampaignOutput struct {

	//  The Amazon Resource Name (ARN) of the campaign.
	Arn *string

	// The name of the updated campaign.
	Name *string

	// The state of a campaign. The status can be one of:
	//
	//   - CREATING - Amazon Web Services IoT FleetWise is processing your request to
	//   create the campaign.
	//
	//   - WAITING_FOR_APPROVAL - After a campaign is created, it enters the
	//   WAITING_FOR_APPROVAL state. To allow Amazon Web Services IoT FleetWise to
	//   deploy the campaign to the target vehicle or fleet, use the API operation to
	//   approve the campaign.
	//
	//   - RUNNING - The campaign is active.
	//
	//   - SUSPENDED - The campaign is suspended. To resume the campaign, use the API
	//   operation.
	Status types.CampaignStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateDecoderManifestInput 

type UpdateDecoderManifestInput struct {

	//  The name of the decoder manifest to update.
	//
	// This member is required.
	Name *string

	// Use default decoders for all unmapped signals in the model. You don't need to
	// provide any detailed decoding information.
	//
	// 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.
	//
	// [Amazon Web Services Region and feature availability]: https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/fleetwise-regions.html
	DefaultForUnmappedSignals types.DefaultForUnmappedSignalsType

	//  A brief description of the decoder manifest to update.
	Description *string

	//  A list of information about the network interfaces to add to the decoder
	// manifest.
	NetworkInterfacesToAdd []types.NetworkInterface

	//  A list of network interfaces to remove from the decoder manifest.
	NetworkInterfacesToRemove []string

	//  A list of information about the network interfaces to update in the decoder
	// manifest.
	NetworkInterfacesToUpdate []types.NetworkInterface

	//  A list of information about decoding additional signals to add to the decoder
	// manifest.
	SignalDecodersToAdd []types.SignalDecoder

	//  A list of signal decoders to remove from the decoder manifest.
	SignalDecodersToRemove []string

	//  A list of updated information about decoding signals to update in the decoder
	// manifest.
	SignalDecodersToUpdate []types.SignalDecoder

	//  The state of the decoder manifest. If the status is ACTIVE , the decoder
	// manifest can't be edited. If the status is DRAFT , you can edit the decoder
	// manifest.
	Status types.ManifestStatus
	// contains filtered or unexported fields
}

type UpdateDecoderManifestOutput 

type UpdateDecoderManifestOutput struct {

	//  The Amazon Resource Name (ARN) of the updated decoder manifest.
	//
	// This member is required.
	Arn *string

	//  The name of the updated decoder manifest.
	//
	// This member is required.
	Name *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateFleetInput 

type UpdateFleetInput struct {

	//  The ID of the fleet to update.
	//
	// This member is required.
	FleetId *string

	//  An updated description of the fleet.
	Description *string
	// contains filtered or unexported fields
}

type UpdateFleetOutput 

type UpdateFleetOutput struct {

	// The Amazon Resource Name (ARN) of the updated fleet.
	Arn *string

	// The ID of the updated fleet.
	Id *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateModelManifestInput 

type UpdateModelManifestInput struct {

	//  The name of the vehicle model to update.
	//
	// This member is required.
	Name *string

	//  A brief description of the vehicle model.
	Description *string

	//  A list of fullyQualifiedName of nodes, which are a general abstraction of
	// signals, to add to the vehicle model.
	NodesToAdd []string

	//  A list of fullyQualifiedName of nodes, which are a general abstraction of
	// signals, to remove from the vehicle model.
	NodesToRemove []string

	//  The state of the vehicle model. If the status is ACTIVE , the vehicle model
	// can't be edited. If the status is DRAFT , you can edit the vehicle model.
	Status types.ManifestStatus
	// contains filtered or unexported fields
}

type UpdateModelManifestOutput 

type UpdateModelManifestOutput struct {

	//  The Amazon Resource Name (ARN) of the updated vehicle model.
	//
	// This member is required.
	Arn *string

	//  The name of the updated vehicle model.
	//
	// This member is required.
	Name *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateSignalCatalogInput 

type UpdateSignalCatalogInput struct {

	//  The name of the signal catalog to update.
	//
	// This member is required.
	Name *string

	//  A brief description of the signal catalog to update.
	Description *string

	//  A list of information about nodes to add to the signal catalog.
	NodesToAdd []types.Node

	//  A list of fullyQualifiedName of nodes to remove from the signal catalog.
	NodesToRemove []string

	//  A list of information about nodes to update in the signal catalog.
	NodesToUpdate []types.Node
	// contains filtered or unexported fields
}

type UpdateSignalCatalogOutput 

type UpdateSignalCatalogOutput struct {

	//  The ARN of the updated signal catalog.
	//
	// This member is required.
	Arn *string

	//  The name of the updated signal catalog.
	//
	// This member is required.
	Name *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateStateTemplateInput added in v1.22.0 

type UpdateStateTemplateInput struct {

	// A unique, service-generated identifier.
	//
	// This member is required.
	Identifier *string

	// A list of vehicle attributes to associate with the payload published on the
	// state template's MQTT topic. (See [Processing last known state vehicle data using MQTT messaging]). For example, if you add
	// Vehicle.Attributes.Make and Vehicle.Attributes.Model attributes, Amazon Web
	// Services IoT FleetWise will enrich the protobuf encoded payload with those
	// attributes in the extraDimensions field.
	//
	// Default: An empty array
	//
	// [Processing last known state vehicle data using MQTT messaging]: https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/process-visualize-data.html#process-last-known-state-vehicle-data
	DataExtraDimensions []string

	// A brief description of the state template.
	Description *string

	// A list of vehicle attributes to associate with user properties of the messages
	// published on the state template's MQTT topic. (See [Processing last known state vehicle data using MQTT messaging]). For example, if you add
	// Vehicle.Attributes.Make and Vehicle.Attributes.Model attributes, Amazon Web
	// Services IoT FleetWise will include these attributes as User Properties with the
	// MQTT message.
	//
	// [Processing last known state vehicle data using MQTT messaging]: https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/process-visualize-data.html#process-last-known-state-vehicle-data
	MetadataExtraDimensions []string

	// Add signals from which data is collected as part of the state template.
	StateTemplatePropertiesToAdd []string

	// Remove signals from which data is collected as part of the state template.
	StateTemplatePropertiesToRemove []string
	// contains filtered or unexported fields
}

type UpdateStateTemplateOutput added in v1.22.0 

type UpdateStateTemplateOutput struct {

	// The Amazon Resource Name (ARN) of the state template.
	Arn *string

	// The unique ID of the state template.
	Id *string

	// The name of the state template.
	Name *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateVehicleInput 

type UpdateVehicleInput struct {

	// The unique ID of the vehicle to update.
	//
	// This member is required.
	VehicleName *string

	// The method the specified attributes will update the existing attributes on the
	// vehicle. Use Overwite to replace the vehicle attributes with the specified
	// attributes. Or use Merge to combine all attributes.
	//
	// This is required if attributes are present in the input.
	AttributeUpdateMode types.UpdateMode

	// Static information about a vehicle in a key-value pair. For example:
	//
	// "engineType" : "1.3 L R2"
	Attributes map[string]string

	// The ARN of the decoder manifest associated with this vehicle.
	DecoderManifestArn *string

	// The ARN of a vehicle model (model manifest) associated with the vehicle.
	ModelManifestArn *string

	// Associate state templates with the vehicle.
	StateTemplatesToAdd []types.StateTemplateAssociation

	// Remove state templates from the vehicle.
	StateTemplatesToRemove []string
	// contains filtered or unexported fields
}

type UpdateVehicleOutput 

type UpdateVehicleOutput struct {

	// The ARN of the updated vehicle.
	Arn *string

	// The ID of the updated vehicle.
	VehicleName *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Source Files

View all Source files

Directories

Path Synopsis
internal
endpoints

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.