GetReportMetadataCommand

Get the metadata for a single report.

Example Syntax

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

import { ArtifactClient, GetReportMetadataCommand } from "@aws-sdk/client-artifact"; // ES Modules import
// const { ArtifactClient, GetReportMetadataCommand } = require("@aws-sdk/client-artifact"); // CommonJS import
const client = new ArtifactClient(config);
const input = { // GetReportMetadataRequest
  reportId: "STRING_VALUE", // required
  reportVersion: Number("long"),
};
const command = new GetReportMetadataCommand(input);
const response = await client.send(command);
// { // GetReportMetadataResponse
//   reportDetails: { // ReportDetail
//     id: "STRING_VALUE",
//     name: "STRING_VALUE",
//     description: "STRING_VALUE",
//     periodStart: new Date("TIMESTAMP"),
//     periodEnd: new Date("TIMESTAMP"),
//     createdAt: new Date("TIMESTAMP"),
//     lastModifiedAt: new Date("TIMESTAMP"),
//     deletedAt: new Date("TIMESTAMP"),
//     state: "PUBLISHED" || "UNPUBLISHED",
//     arn: "STRING_VALUE",
//     series: "STRING_VALUE",
//     category: "STRING_VALUE",
//     companyName: "STRING_VALUE",
//     productName: "STRING_VALUE",
//     termArn: "STRING_VALUE",
//     version: Number("long"),
//     acceptanceType: "PASSTHROUGH" || "EXPLICIT",
//     sequenceNumber: Number("long"),
//     uploadState: "PROCESSING" || "COMPLETE" || "FAILED" || "FAULT",
//     statusMessage: "STRING_VALUE",
//   },
// };

Example Usage

 Loading code editor

GetReportMetadataCommand Input

See GetReportMetadataCommandInput for more details

Parameter
Type
Description
reportId
Required
string | undefined

Unique resource ID for the report resource.

reportVersion
number | undefined

Version for the report resource.

GetReportMetadataCommand Output

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

Report resource detail.

Throws

Name
Fault
Details
AccessDeniedException
client

User does not have sufficient access to perform this action.

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.