- 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.
GetTermForReportCommand
Get the Term content associated with a single report.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { ArtifactClient, GetTermForReportCommand } from "@aws-sdk/client-artifact"; // ES Modules import
// const { ArtifactClient, GetTermForReportCommand } = require("@aws-sdk/client-artifact"); // CommonJS import
const client = new ArtifactClient(config);
const input = { // GetTermForReportRequest
reportId: "STRING_VALUE", // required
reportVersion: Number("long"),
};
const command = new GetTermForReportCommand(input);
const response = await client.send(command);
// { // GetTermForReportResponse
// documentPresignedUrl: "STRING_VALUE",
// termToken: "STRING_VALUE",
// };
Example Usage
There was an error loading the code editor. Retry
GetTermForReportCommand Input
See GetTermForReportCommandInput for more details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
reportIdRequired | string | undefined | Unique resource ID for the report resource. |
reportVersion | number | undefined | Version for the report resource. |
GetTermForReportCommand Output
See GetTermForReportCommandOutput for details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
documentPresignedUrl | string | undefined | Presigned S3 url to access the term content. |
termToken | string | undefined | Unique token representing this request event. |
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. |