Class: Aws::IoTFleetWise::Types::ListVehiclesRequest

Inherits:

Struct

• Object
• Struct
• Aws::IoTFleetWise::Types::ListVehiclesRequest

Defined in:

gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/types.rb

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #attribute_names ⇒ Array<String>

  The fully qualified names of the attributes.

• #attribute_values ⇒ Array<String>

  Static information about a vehicle attribute value in string format.

• #max_results ⇒ Integer

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

• #model_manifest_arn ⇒ String

  The Amazon Resource Name (ARN) of a vehicle model (model manifest).

• #next_token ⇒ String

  A pagination token for the next set of results.

Instance Attribute Details

#attribute_names ⇒ Array<String>

The fully qualified names of the attributes. For example, the fully qualified name of an attribute might be Vehicle.Body.Engine.Type.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/types.rb', line 2774

class ListVehiclesRequest < Struct.new(
  :model_manifest_arn,
  :attribute_names,
  :attribute_values,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#attribute_values ⇒ Array<String>

Static information about a vehicle attribute value in string format. For example:

"1.3 L R2"

Returns:

• (Array<String>)

# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/types.rb', line 2774

class ListVehiclesRequest < Struct.new(
  :model_manifest_arn,
  :attribute_names,
  :attribute_values,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ Integer

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

Returns:

• (Integer)

# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/types.rb', line 2774

class ListVehiclesRequest < Struct.new(
  :model_manifest_arn,
  :attribute_names,
  :attribute_values,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#model_manifest_arn ⇒ String

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.

Returns:

• (String)

# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/types.rb', line 2774

class ListVehiclesRequest < Struct.new(
  :model_manifest_arn,
  :attribute_names,
  :attribute_values,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ 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.

Returns:

• (String)

# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/types.rb', line 2774

class ListVehiclesRequest < Struct.new(
  :model_manifest_arn,
  :attribute_names,
  :attribute_values,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end