Response Syntax Response Elements Errors See Also

GetResourcesSummary

Get counts of AWS 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 AWS 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 AWS Proton template in the AWS account.

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

Response Syntax


{
   "counts": { 
      "components": { 
         "behindMajor": number,
         "behindMinor": number,
         "failed": number,
         "total": number,
         "upToDate": number
      },
      "environments": { 
         "behindMajor": number,
         "behindMinor": number,
         "failed": number,
         "total": number,
         "upToDate": number
      },
      "environmentTemplates": { 
         "behindMajor": number,
         "behindMinor": number,
         "failed": number,
         "total": number,
         "upToDate": number
      },
      "pipelines": { 
         "behindMajor": number,
         "behindMinor": number,
         "failed": number,
         "total": number,
         "upToDate": number
      },
      "serviceInstances": { 
         "behindMajor": number,
         "behindMinor": number,
         "failed": number,
         "total": number,
         "upToDate": number
      },
      "services": { 
         "behindMajor": number,
         "behindMinor": number,
         "failed": number,
         "total": number,
         "upToDate": number
      },
      "serviceTemplates": { 
         "behindMajor": number,
         "behindMinor": number,
         "failed": number,
         "total": number,
         "upToDate": number
      }
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

counts

Summary counts of each AWS Proton resource type.

Type: CountsSummary object

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

There isn't sufficient access for performing this action.

HTTP Status Code: 400

InternalServerException

The request failed to register with the service.

HTTP Status Code: 500

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 400

ValidationException

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

HTTP Status Code: 400