- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
ListTrackersCommand
Lists tracker resources in your Amazon Web Services account.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { LocationClient, ListTrackersCommand } from "@aws-sdk/client-location"; // ES Modules import
// const { LocationClient, ListTrackersCommand } = require("@aws-sdk/client-location"); // CommonJS import
const client = new LocationClient(config);
const input = { // ListTrackersRequest
MaxResults: Number("int"),
NextToken: "STRING_VALUE",
};
const command = new ListTrackersCommand(input);
const response = await client.send(command);
// { // ListTrackersResponse
// Entries: [ // ListTrackersResponseEntryList // required
// { // ListTrackersResponseEntry
// TrackerName: "STRING_VALUE", // required
// Description: "STRING_VALUE", // required
// PricingPlan: "STRING_VALUE",
// PricingPlanDataSource: "STRING_VALUE",
// CreateTime: new Date("TIMESTAMP"), // required
// UpdateTime: new Date("TIMESTAMP"), // required
// },
// ],
// NextToken: "STRING_VALUE",
// };
ListTrackersCommand Input
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
MaxResults | number | undefined | An optional limit for the number of resources returned in a single call. Default value: |
NextToken | string | undefined | The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page. Default value: |
ListTrackersCommand Output
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
EntriesRequired | ListTrackersResponseEntry[] | undefined | Contains tracker resources in your Amazon Web Services account. Details include tracker name, description and timestamps for when the tracker was created and last updated. |
NextToken | string | undefined | A pagination token indicating there are additional pages available. You can use the token in a following request to fetch the next set of results. |
Throws
Name | Fault | Details |
|---|
Name | Fault | Details |
|---|---|---|
| AccessDeniedException | client | The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions. |
| InternalServerException | server | The request has failed to process because of an unknown server error, exception, or failure. |
| ThrottlingException | client | The request was denied because of request throttling. |
| ValidationException | client | The input failed to meet the constraints specified by the AWS service. |
| LocationServiceException | Base exception class for all service exceptions from Location service. |