- 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.
GetReportCommand
Get the content for a single report.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { ArtifactClient, GetReportCommand } from "@aws-sdk/client-artifact"; // ES Modules import
// const { ArtifactClient, GetReportCommand } = require("@aws-sdk/client-artifact"); // CommonJS import
const client = new ArtifactClient(config);
const input = { // GetReportRequest
reportId: "STRING_VALUE", // required
reportVersion: Number("long"),
termToken: "STRING_VALUE", // required
};
const command = new GetReportCommand(input);
const response = await client.send(command);
// { // GetReportResponse
// documentPresignedUrl: "STRING_VALUE",
// };
Example Usage
Loading code editorLoading code editor
GetReportCommand Input
See GetReportCommandInput for more details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
reportId Required | string | undefined | Unique resource ID for the report resource. |
termToken Required | string | undefined | Unique download token provided by GetTermForReport API. |
reportVersion | number | undefined | Version for the report resource. |
GetReportCommand Output
See GetReportCommandOutput for details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
documentPresignedUrl | string | undefined | Presigned S3 url to access the report content. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
AccessDeniedException | client | User does not have sufficient access to perform this action. |
ConflictException | client | Request to create/modify content would result in a conflict. |
InternalServerException | server | An unknown server exception has occurred. |
ResourceNotFoundException | client | Request references a resource which does not exist. |
ServiceQuotaExceededException | client | Request would cause a service quota to be exceeded. |
ThrottlingException | client | Request was denied due to request throttling. |
ValidationException | client | Request fails to satisfy the constraints specified by an AWS service. |
ArtifactServiceException | Base exception class for all service exceptions from Artifact service. |