GetResourcesSummaryCommand

Suggest an Edit

Get counts of Proton resources.

For infrastructure-provisioning resources (environments, services, service instances, pipelines), the action returns staleness counts. A resource is stale when it's behind the recommended version of the Proton template that it uses and it needs an update to become current.

The action returns staleness counts (counts of resources that are up-to-date, behind a template major version, or behind a template minor version), the total number of resources, and the number of resources that are in a failed state, grouped by resource type. Components, environments, and service templates return less information - see the components, environments, and serviceTemplates field descriptions.

For context, the action also returns the total number of each type of Proton template in the Amazon Web Services account.

For more information, see Proton dashboard  in the Proton User Guide.

Example Syntax

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

import { ProtonClient, GetResourcesSummaryCommand } from "@aws-sdk/client-proton"; // ES Modules import
// const { ProtonClient, GetResourcesSummaryCommand } = require("@aws-sdk/client-proton"); // CommonJS import
const client = new ProtonClient(config);
const input = {};
const command = new GetResourcesSummaryCommand(input);
const response = await client.send(command);
// { // GetResourcesSummaryOutput
//   counts: { // CountsSummary
//     components: { // ResourceCountsSummary
//       total: Number("int"), // required
//       failed: Number("int"),
//       upToDate: Number("int"),
//       behindMajor: Number("int"),
//       behindMinor: Number("int"),
//     },
//     environments: {
//       total: Number("int"), // required
//       failed: Number("int"),
//       upToDate: Number("int"),
//       behindMajor: Number("int"),
//       behindMinor: Number("int"),
//     },
//     environmentTemplates: {
//       total: Number("int"), // required
//       failed: Number("int"),
//       upToDate: Number("int"),
//       behindMajor: Number("int"),
//       behindMinor: Number("int"),
//     },
//     serviceInstances: {
//       total: Number("int"), // required
//       failed: Number("int"),
//       upToDate: Number("int"),
//       behindMajor: Number("int"),
//       behindMinor: Number("int"),
//     },
//     services: {
//       total: Number("int"), // required
//       failed: Number("int"),
//       upToDate: Number("int"),
//       behindMajor: Number("int"),
//       behindMinor: Number("int"),
//     },
//     serviceTemplates: "<ResourceCountsSummary>",
//     pipelines: "<ResourceCountsSummary>",
//   },
// };

GetResourcesSummaryCommand Input

See GetResourcesSummaryCommandInput for more details
GetResourcesSummaryCommandInput extends GetResourcesSummaryInput

GetResourcesSummaryCommand Output

See GetResourcesSummaryCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
counts
Required
CountsSummary | undefined

Summary counts of each Proton resource type.

Throws

Name
Fault
Details
AccessDeniedException
client

There isn't sufficient access for performing this action.

InternalServerException
server

The request failed to register with the service.

ThrottlingException
client

The request was denied due to request throttling.

ValidationException
client

The input is invalid or an out-of-range value was supplied for the input parameter.

ProtonServiceException
Base exception class for all service exceptions from Proton service.