AWS API Changes

2025/02/26 - AWS IoT FleetWise - 6 updated api methods

Changes This release adds an optional listResponseScope request parameter in certain list API requests to limit the response to metadata only.

ListCampaigns (updated)

Link ¶
Changes (request)

{'listResponseScope': 'METADATA_ONLY'}

Lists information about created campaigns.

See also: AWS API Documentation

Request Syntax

client.list_campaigns(
    nextToken='string',
    maxResults=123,
    status='string',
    listResponseScope='METADATA_ONLY'
)

type nextToken:

string

param nextToken:

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.

type maxResults:

integer

param maxResults:

The maximum number of items to return, between 1 and 100, inclusive.

type status:

string

param status:

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.

type listResponseScope:

string

param listResponseScope:

When you set the listResponseScope parameter to METADATA_ONLY, the list response includes: campaign name, Amazon Resource Name (ARN), creation time, and last modification time.

rtype:

dict

returns:

Response Syntax

{
    'campaignSummaries': [
        {
            'arn': 'string',
            'name': 'string',
            'description': 'string',
            'signalCatalogArn': 'string',
            'targetArn': 'string',
            'status': 'CREATING'|'WAITING_FOR_APPROVAL'|'RUNNING'|'SUSPENDED',
            'creationTime': datetime(2015, 1, 1),
            'lastModificationTime': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) --
- campaignSummaries (list) --
  
  A summary of information about each campaign.
  - (dict) --
    
    Information about a campaign.
    
    You can use the API operation to return this information about multiple created campaigns.
    - arn (string) --
      
      The Amazon Resource Name (ARN) of a campaign.
    - name (string) --
      
      The name of a campaign.
    - description (string) --
      
      The description of the campaign.
    - signalCatalogArn (string) --
      
      The ARN of the signal catalog associated with the campaign.
    - targetArn (string) --
      
      The ARN of a vehicle or fleet to which the campaign is deployed.
    - status (string) --
      
      The state of a campaign. The status can be one of the following:
      - 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.
    - creationTime (datetime) --
      
      The time the campaign was created.
    - lastModificationTime (datetime) --
      
      The last time the campaign was modified.
- nextToken (string) --
  
  The token to retrieve the next set of results, or null if there are no more results.

ListDecoderManifests (updated)

Link ¶
Changes (request)

{'listResponseScope': 'METADATA_ONLY'}

Lists decoder manifests.

See also: AWS API Documentation

Request Syntax

client.list_decoder_manifests(
    modelManifestArn='string',
    nextToken='string',
    maxResults=123,
    listResponseScope='METADATA_ONLY'
)

type modelManifestArn:

string

param modelManifestArn:

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

type nextToken:

string

param nextToken:

A pagination token for the next set of results.

type maxResults:

integer

param maxResults:

The maximum number of items to return, between 1 and 100, inclusive.

type listResponseScope:

string

param listResponseScope:

When you set the listResponseScope parameter to METADATA_ONLY, the list response includes: decoder manifest name, Amazon Resource Name (ARN), creation time, and last modification time.

rtype:

dict

returns:

Response Syntax

{
    'summaries': [
        {
            'name': 'string',
            'arn': 'string',
            'modelManifestArn': 'string',
            'description': 'string',
            'status': 'ACTIVE'|'DRAFT'|'INVALID'|'VALIDATING',
            'creationTime': datetime(2015, 1, 1),
            'lastModificationTime': datetime(2015, 1, 1),
            'message': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) --
- summaries (list) --
  
  A list of information about each decoder manifest.
  - (dict) --
    
    Information about a created decoder manifest. You can use the API operation to return this information about multiple decoder manifests.
    - name (string) --
      
      The name of the decoder manifest.
    - arn (string) --
      
      The ARN of a vehicle model (model manifest) associated with the decoder manifest.
    - modelManifestArn (string) --
      
      The ARN of a vehicle model (model manifest) associated with the decoder manifest.
    - description (string) --
      
      A brief description of the decoder manifest.
    - status (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.
    - creationTime (datetime) --
      
      The time the decoder manifest was created in seconds since epoch (January 1, 1970 at midnight UTC time).
    - lastModificationTime (datetime) --
      
      The time the decoder manifest was last updated in seconds since epoch (January 1, 1970 at midnight UTC time).
    - message (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.
- nextToken (string) --
  
  The token to retrieve the next set of results, or null if there are no more results.

ListFleets (updated)

Link ¶
Changes (request)

{'listResponseScope': 'METADATA_ONLY'}

Retrieves information for each created fleet in an Amazon Web Services account.

See also: AWS API Documentation

Request Syntax

client.list_fleets(
    nextToken='string',
    maxResults=123,
    listResponseScope='METADATA_ONLY'
)

type nextToken:

string

param nextToken:

A pagination token for the next set of results.

type maxResults:

integer

param maxResults:

The maximum number of items to return, between 1 and 100, inclusive.

type listResponseScope:

string

param listResponseScope:

When you set the listResponseScope parameter to METADATA_ONLY, the list response includes: fleet ID, Amazon Resource Name (ARN), creation time, and last modification time.

rtype:

dict

returns:

Response Syntax

{
    'fleetSummaries': [
        {
            'id': 'string',
            'arn': 'string',
            'description': 'string',
            'signalCatalogArn': 'string',
            'creationTime': datetime(2015, 1, 1),
            'lastModificationTime': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) --
- fleetSummaries (list) --
  
  A list of information for each fleet.
  - (dict) --
    
    Information about a fleet.
    
    You can use the API operation to return this information about multiple fleets.
    - id (string) --
      
      The unique ID of the fleet.
    - arn (string) --
      
      The Amazon Resource Name (ARN) of the fleet.
    - description (string) --
      
      A brief description of the fleet.
    - signalCatalogArn (string) --
      
      The ARN of the signal catalog associated with the fleet.
    - creationTime (datetime) --
      
      The time the fleet was created, in seconds since epoch (January 1, 1970 at midnight UTC time).
    - lastModificationTime (datetime) --
      
      The time the fleet was last updated in seconds since epoch (January 1, 1970 at midnight UTC time).
- nextToken (string) --
  
  The token to retrieve the next set of results, or null if there are no more results.

ListModelManifests (updated)

Link ¶
Changes (request)

{'listResponseScope': 'METADATA_ONLY'}

Retrieves a list of vehicle models (model manifests).

See also: AWS API Documentation

Request Syntax

client.list_model_manifests(
    signalCatalogArn='string',
    nextToken='string',
    maxResults=123,
    listResponseScope='METADATA_ONLY'
)

type signalCatalogArn:

string

param signalCatalogArn:

The ARN of a signal catalog. If you specify a signal catalog, only the vehicle models associated with it are returned.

type nextToken:

string

param nextToken:

A pagination token for the next set of results.

type maxResults:

integer

param maxResults:

The maximum number of items to return, between 1 and 100, inclusive.

type listResponseScope:

string

param listResponseScope:

When you set the listResponseScope parameter to METADATA_ONLY, the list response includes: model manifest name, Amazon Resource Name (ARN), creation time, and last modification time.

rtype:

dict

returns:

Response Syntax

{
    'summaries': [
        {
            'name': 'string',
            'arn': 'string',
            'signalCatalogArn': 'string',
            'description': 'string',
            'status': 'ACTIVE'|'DRAFT'|'INVALID'|'VALIDATING',
            'creationTime': datetime(2015, 1, 1),
            'lastModificationTime': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) --
- summaries (list) --
  
  A list of information about vehicle models.
  - (dict) --
    
    Information about a vehicle model (model manifest). You can use the API operation to return this information about multiple vehicle models.
    - name (string) --
      
      The name of the vehicle model.
    - arn (string) --
      
      The Amazon Resource Name (ARN) of the vehicle model.
    - signalCatalogArn (string) --
      
      The ARN of the signal catalog associated with the vehicle model.
    - description (string) --
      
      A brief description of the vehicle model.
    - status (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.
    - creationTime (datetime) --
      
      The time the vehicle model was created, in seconds since epoch (January 1, 1970 at midnight UTC time).
    - lastModificationTime (datetime) --
      
      The time the vehicle model was last updated, in seconds since epoch (January 1, 1970 at midnight UTC time).
- nextToken (string) --
  
  The token to retrieve the next set of results, or null if there are no more results.

ListStateTemplates (updated)

Link ¶
Changes (request)

{'listResponseScope': 'METADATA_ONLY'}

Lists information about created state templates.

See also: AWS API Documentation

Request Syntax

client.list_state_templates(
    nextToken='string',
    maxResults=123,
    listResponseScope='METADATA_ONLY'
)

type nextToken:

string

param nextToken:

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

type maxResults:

integer

param maxResults:

The maximum number of items to return, between 1 and 100, inclusive.

type listResponseScope:

string

param listResponseScope:

When you set the listResponseScope parameter to METADATA_ONLY, the list response includes: state template ID, Amazon Resource Name (ARN), creation time, and last modification time.

rtype:

dict

returns:

Response Syntax

{
    'summaries': [
        {
            'name': 'string',
            'arn': 'string',
            'signalCatalogArn': 'string',
            'description': 'string',
            'creationTime': datetime(2015, 1, 1),
            'lastModificationTime': datetime(2015, 1, 1),
            'id': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) --
- summaries (list) --
  
  A list of information about each state template.
  - (dict) --
    
    Information about a state template.
    
    Warning
    
    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.
    - name (string) --
      
      The name of the state template.
    - arn (string) --
      
      The Amazon Resource Name (ARN) of the state template.
    - signalCatalogArn (string) --
      
      The Amazon Resource Name (ARN) of the signal catalog associated with the state template.
    - description (string) --
      
      A brief description of the state template.
    - creationTime (datetime) --
      
      The time the state template was created, in seconds since epoch (January 1, 1970 at midnight UTC time).
    - lastModificationTime (datetime) --
      
      The time the state template was last updated, in seconds since epoch (January 1, 1970 at midnight UTC time).
    - id (string) --
      
      The unique ID of the state template.
- nextToken (string) --
  
  The token to retrieve the next set of results, or null if there are no more results.

ListVehicles (updated)

Link ¶
Changes (request)

{'listResponseScope': 'METADATA_ONLY'}

Retrieves a list of summaries of created vehicles.

See also: AWS API Documentation

Request Syntax

client.list_vehicles(
    modelManifestArn='string',
    attributeNames=[
        'string',
    ],
    attributeValues=[
        'string',
    ],
    nextToken='string',
    maxResults=123,
    listResponseScope='METADATA_ONLY'
)

type modelManifestArn:

string

param modelManifestArn:

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.

type attributeNames:

list

param attributeNames:

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.

(string) --

type attributeValues:

list

param attributeValues:

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.

(string) --

type nextToken:

string

param nextToken:

A pagination token for the next set of results.

type maxResults:

integer

param maxResults:

The maximum number of items to return, between 1 and 100, inclusive.

type listResponseScope:

string

param listResponseScope:

When you set the listResponseScope parameter to METADATA_ONLY, the list response includes: vehicle name, Amazon Resource Name (ARN), creation time, and last modification time.

rtype:

dict

returns:

Response Syntax

{
    'vehicleSummaries': [
        {
            'vehicleName': 'string',
            'arn': 'string',
            'modelManifestArn': 'string',
            'decoderManifestArn': 'string',
            'creationTime': datetime(2015, 1, 1),
            'lastModificationTime': datetime(2015, 1, 1),
            'attributes': {
                'string': 'string'
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) --
- vehicleSummaries (list) --
  
  A list of vehicles and information about them.
  - (dict) --
    
    Information about a vehicle.
    
    To return this information about vehicles in your account, you can use the API operation.
    - vehicleName (string) --
      
      The unique ID of the vehicle.
    - arn (string) --
      
      The Amazon Resource Name (ARN) of the vehicle.
    - modelManifestArn (string) --
      
      The ARN of a vehicle model (model manifest) associated with the vehicle.
    - decoderManifestArn (string) --
      
      The ARN of a decoder manifest associated with the vehicle.
    - creationTime (datetime) --
      
      The time the vehicle was created in seconds since epoch (January 1, 1970 at midnight UTC time).
    - lastModificationTime (datetime) --
      
      The time the vehicle was last updated in seconds since epoch (January 1, 1970 at midnight UTC time).
    - attributes (dict) --
      
      Static information about a vehicle in a key-value pair. For example:
      
      "engineType" : "1.3 L R2"
      - (string) --
        
        (string) --
- nextToken (string) --
  
  The token to retrieve the next set of results, or null if there are no more results.