Skip to content
AWS for Query.Farm

aws.proton.get_resources_summary

Example SQL Queries

SELECT * FROM
aws.proton.get_resources_summary;

Description

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.

Table Definition

Column NameColumn Data Type
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
counts

Summary counts of each Proton resource type.

STRUCT(
    "components" STRUCT(
        "behind_major" BIGINT,
        "behind_minor" BIGINT,
        "failed" BIGINT,
        "total" BIGINT,
        "up_to_date" BIGINT
    ),
    "environment_templates" STRUCT(
        "behind_major" BIGINT,
        "behind_minor" BIGINT,
        "failed" BIGINT,
        "total" BIGINT,
        "up_to_date" BIGINT
    ),
    "environments" STRUCT(
        "behind_major" BIGINT,
        "behind_minor" BIGINT,
        "failed" BIGINT,
        "total" BIGINT,
        "up_to_date" BIGINT
    ),
    "pipelines" STRUCT(
        "behind_major" BIGINT,
        "behind_minor" BIGINT,
        "failed" BIGINT,
        "total" BIGINT,
        "up_to_date" BIGINT
    ),
    "service_instances" STRUCT(
        "behind_major" BIGINT,
        "behind_minor" BIGINT,
        "failed" BIGINT,
        "total" BIGINT,
        "up_to_date" BIGINT
    ),
    "service_templates" STRUCT(
        "behind_major" BIGINT,
        "behind_minor" BIGINT,
        "failed" BIGINT,
        "total" BIGINT,
        "up_to_date" BIGINT
    ),
    "services" STRUCT(
        "behind_major" BIGINT,
        "behind_minor" BIGINT,
        "failed" BIGINT,
        "total" BIGINT,
        "up_to_date" BIGINT
    )
)
Show child fields
counts.components

The 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.

Show child fields
counts.components.behind_major

The number of resources of this type in the Amazon Web Services account that need a major template version update.

counts.components.behind_minor

The number of resources of this type in the Amazon Web Services account that need a minor template version update.

counts.components.failed

The number of resources of this type in the Amazon Web Services account that failed to deploy.

counts.components.total

The total number of resources of this type in the Amazon Web Services account.

counts.components.up_to_date

The number of resources of this type in the Amazon Web Services account that are up-to-date with their template.

counts.environment_templates

The total number of environment templates in the Amazon Web Services account. The environmentTemplates object will only contain total members.

Show child fields
counts.environment_templates.behind_major

The number of resources of this type in the Amazon Web Services account that need a major template version update.

counts.environment_templates.behind_minor

The number of resources of this type in the Amazon Web Services account that need a minor template version update.

counts.environment_templates.failed

The number of resources of this type in the Amazon Web Services account that failed to deploy.

counts.environment_templates.total

The total number of resources of this type in the Amazon Web Services account.

counts.environment_templates.up_to_date

The number of resources of this type in the Amazon Web Services account that are up-to-date with their template.

counts.environments

The staleness counts for Proton environments in the Amazon Web Services account. The environments object will only contain total members.

Show child fields
counts.environments.behind_major

The number of resources of this type in the Amazon Web Services account that need a major template version update.

counts.environments.behind_minor

The number of resources of this type in the Amazon Web Services account that need a minor template version update.

counts.environments.failed

The number of resources of this type in the Amazon Web Services account that failed to deploy.

counts.environments.total

The total number of resources of this type in the Amazon Web Services account.

counts.environments.up_to_date

The number of resources of this type in the Amazon Web Services account that are up-to-date with their template.

counts.pipelines

The staleness counts for Proton pipelines in the Amazon Web Services account.

Show child fields
counts.pipelines.behind_major

The number of resources of this type in the Amazon Web Services account that need a major template version update.

counts.pipelines.behind_minor

The number of resources of this type in the Amazon Web Services account that need a minor template version update.

counts.pipelines.failed

The number of resources of this type in the Amazon Web Services account that failed to deploy.

counts.pipelines.total

The total number of resources of this type in the Amazon Web Services account.

counts.pipelines.up_to_date

The number of resources of this type in the Amazon Web Services account that are up-to-date with their template.

counts.service_instances

The staleness counts for Proton service instances in the Amazon Web Services account.

Show child fields
counts.service_instances.behind_major

The number of resources of this type in the Amazon Web Services account that need a major template version update.

counts.service_instances.behind_minor

The number of resources of this type in the Amazon Web Services account that need a minor template version update.

counts.service_instances.failed

The number of resources of this type in the Amazon Web Services account that failed to deploy.

counts.service_instances.total

The total number of resources of this type in the Amazon Web Services account.

counts.service_instances.up_to_date

The number of resources of this type in the Amazon Web Services account that are up-to-date with their template.

counts.service_templates

The total number of service templates in the Amazon Web Services account. The serviceTemplates object will only contain total members.

Show child fields
counts.service_templates.behind_major

The number of resources of this type in the Amazon Web Services account that need a major template version update.

counts.service_templates.behind_minor

The number of resources of this type in the Amazon Web Services account that need a minor template version update.

counts.service_templates.failed

The number of resources of this type in the Amazon Web Services account that failed to deploy.

counts.service_templates.total

The total number of resources of this type in the Amazon Web Services account.

counts.service_templates.up_to_date

The number of resources of this type in the Amazon Web Services account that are up-to-date with their template.

counts.services

The staleness counts for Proton services in the Amazon Web Services account.

Show child fields
counts.services.behind_major

The number of resources of this type in the Amazon Web Services account that need a major template version update.

counts.services.behind_minor

The number of resources of this type in the Amazon Web Services account that need a minor template version update.

counts.services.failed

The number of resources of this type in the Amazon Web Services account that failed to deploy.

counts.services.total

The total number of resources of this type in the Amazon Web Services account.

counts.services.up_to_date

The number of resources of this type in the Amazon Web Services account that are up-to-date with their template.