GetAppsCommand

Suggest an Edit

Retrieves information about all the applications that are associated with your Amazon Pinpoint account.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { PinpointClient, GetAppsCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import
// const { PinpointClient, GetAppsCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import
const client = new PinpointClient(config);
const input = { // GetAppsRequest
  PageSize: "STRING_VALUE",
  Token: "STRING_VALUE",
};
const command = new GetAppsCommand(input);
const response = await client.send(command);
// { // GetAppsResponse
//   ApplicationsResponse: { // ApplicationsResponse
//     Item: [ // ListOfApplicationResponse
//       { // ApplicationResponse
//         Arn: "STRING_VALUE", // required
//         Id: "STRING_VALUE", // required
//         Name: "STRING_VALUE", // required
//         tags: { // MapOf__string
//           "<keys>": "STRING_VALUE",
//         },
//         CreationDate: "STRING_VALUE",
//       },
//     ],
//     NextToken: "STRING_VALUE",
//   },
// };

GetAppsCommand Input

See GetAppsCommandInput for more details

Parameter
Type
Description
PageSize
string | undefined

The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

Token
string | undefined

The NextToken string that specifies which page of results to return in a paginated response.

GetAppsCommand Output

See GetAppsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
ApplicationsResponse
Required
ApplicationsResponse | undefined

Provides information about all of your applications.

Throws

Name
Fault
Details
BadRequestException
client

Provides information about an API request or response.

ForbiddenException
client

Provides information about an API request or response.

InternalServerErrorException
server

Provides information about an API request or response.

MethodNotAllowedException
client

Provides information about an API request or response.

NotFoundException
client

Provides information about an API request or response.

PayloadTooLargeException
client

Provides information about an API request or response.

TooManyRequestsException
client

Provides information about an API request or response.

PinpointServiceException
Base exception class for all service exceptions from Pinpoint service.