- 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.
GetIngestionCommand
Returns information about an ingestion.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { AppFabricClient, GetIngestionCommand } from "@aws-sdk/client-appfabric"; // ES Modules import
// const { AppFabricClient, GetIngestionCommand } = require("@aws-sdk/client-appfabric"); // CommonJS import
const client = new AppFabricClient(config);
const input = { // GetIngestionRequest
appBundleIdentifier: "STRING_VALUE", // required
ingestionIdentifier: "STRING_VALUE", // required
};
const command = new GetIngestionCommand(input);
const response = await client.send(command);
// { // GetIngestionResponse
// ingestion: { // Ingestion
// arn: "STRING_VALUE", // required
// appBundleArn: "STRING_VALUE", // required
// app: "STRING_VALUE", // required
// tenantId: "STRING_VALUE", // required
// createdAt: new Date("TIMESTAMP"), // required
// updatedAt: new Date("TIMESTAMP"), // required
// state: "enabled" || "disabled", // required
// ingestionType: "auditLog", // required
// },
// };
GetIngestionCommand Input
See GetIngestionCommandInput for more details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
appBundleIdentifier Required | string | undefined | The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request. |
ingestionIdentifier Required | string | undefined | The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion to use for the request. |
GetIngestionCommand Output
See GetIngestionCommandOutput for details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
ingestion Required | Ingestion | undefined | Contains information about an ingestion. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
AccessDeniedException | client | You are not authorized to perform this operation. |
InternalServerException | server | The request processing has failed because of an unknown error, exception, or failure with an internal server. |
ResourceNotFoundException | client | The specified resource does not exist. |
ThrottlingException | client | The request rate exceeds the limit. |
ValidationException | client | The request has invalid or missing parameters. |
AppFabricServiceException | Base exception class for all service exceptions from AppFabric service. |