- 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.
GetAdmChannelCommand
Retrieves information about the status and settings of the ADM channel for an application.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { PinpointClient, GetAdmChannelCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import
// const { PinpointClient, GetAdmChannelCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import
const client = new PinpointClient(config);
const input = { // GetAdmChannelRequest
ApplicationId: "STRING_VALUE", // required
};
const command = new GetAdmChannelCommand(input);
const response = await client.send(command);
// { // GetAdmChannelResponse
// ADMChannelResponse: { // ADMChannelResponse
// ApplicationId: "STRING_VALUE",
// CreationDate: "STRING_VALUE",
// Enabled: true || false,
// HasCredential: true || false,
// Id: "STRING_VALUE",
// IsArchived: true || false,
// LastModifiedBy: "STRING_VALUE",
// LastModifiedDate: "STRING_VALUE",
// Platform: "STRING_VALUE", // required
// Version: Number("int"),
// },
// };
GetAdmChannelCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
ApplicationId Required | string | undefined | The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. |
GetAdmChannelCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
ADMChannelResponse Required | ADMChannelResponse | undefined | Provides information about the status and settings of the ADM (Amazon Device Messaging) channel for an application. |
Throws
Name | Fault | Details |
---|
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. |