Skip to main content

resources_summaries

Creates, updates, deletes, gets or lists a resources_summaries resource.

Overview

Nameresources_summaries
TypeResource
Idaws.proton.resources_summaries

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
componentsobjectThe total number of components in the Amazon Web Services account. The semantics of the components field are different from the semantics of results for other infrastructure-provisioning resources. That's because at this time components don't have associated templates, therefore they don't have the concept of staleness. The components object will only contain total and failed members.
environment_templatesobjectThe total number of environment templates in the Amazon Web Services account. The environmentTemplates object will only contain total members.
environmentsobjectThe staleness counts for Proton environments in the Amazon Web Services account. The environments object will only contain total members.
pipelinesobjectThe staleness counts for Proton pipelines in the Amazon Web Services account.
service_instancesobjectThe staleness counts for Proton service instances in the Amazon Web Services account.
service_templatesobjectThe total number of service templates in the Amazon Web Services account. The serviceTemplates object will only contain total members.
servicesobjectThe staleness counts for Proton services in the Amazon Web Services account.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
get_resources_summaryselectregionGet 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.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
regionstringAWS region (default: us-east-1)

SELECT examples

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.

SELECT
components,
environment_templates,
environments,
pipelines,
service_instances,
service_templates,
services
FROM aws.proton.resources_summaries
WHERE region = '{{ region }}' -- required
;