Skip to content
AWS for Query.Farm

aws.proton.get_environment

Example SQL Queries

SELECT * FROM
aws.proton.get_environment
WHERE
"name" = 'VALUE';

Description

Get detailed data for an environment.

Table Definition

Column NameColumn Data Type
name Required Input Column

The name of the environment that you want to get the detailed data for.

VARCHAR
_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
environment

The detailed data of the requested environment.

STRUCT(
    "arn" VARCHAR,
    "codebuild_role_arn" VARCHAR,
    "component_role_arn" VARCHAR,
    "created_at" TIMESTAMP_S,
    "deployment_status" VARCHAR,
    "deployment_status_message" VARCHAR,
    "description" VARCHAR,
    "environment_account_connection_id" VARCHAR,
    "environment_account_id" VARCHAR,
    "last_attempted_deployment_id" VARCHAR,
    "last_deployment_attempted_at" TIMESTAMP_S,
    "last_deployment_succeeded_at" TIMESTAMP_S,
    "last_succeeded_deployment_id" VARCHAR,
    "name" VARCHAR,
    "proton_service_role_arn" VARCHAR,
    "provisioning" VARCHAR,
    "provisioning_repository" STRUCT(
        "arn" VARCHAR,
        "branch" VARCHAR,
        "name" VARCHAR,
        "provider" VARCHAR
    ),
    "spec" VARCHAR,
    "template_major_version" VARCHAR,
    "template_minor_version" VARCHAR,
    "template_name" VARCHAR
)
Show child fields
environment.arn

The Amazon Resource Name (ARN) of the environment.

environment.codebuild_role_arn

The Amazon Resource Name (ARN) of the IAM service role that allows Proton to provision infrastructure using CodeBuild-based provisioning on your behalf.

environment.component_role_arn

The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in this environment. It determines the scope of infrastructure that a component can provision.

The environment must have a componentRoleArn to allow directly defined components to be associated with the environment.

For more information about components, see Proton components in the Proton User Guide.

environment.created_at

The time when the environment was created.

environment.deployment_status

The environment deployment status.

environment.deployment_status_message

An environment deployment status message.

environment.description

The description of the environment.

environment.environment_account_connection_id

The ID of the environment account connection that's used to provision infrastructure resources in an environment account.

environment.environment_account_id

The ID of the environment account that the environment infrastructure resources are provisioned in.

environment.last_attempted_deployment_id

The ID of the last attempted deployment of this environment.

environment.last_deployment_attempted_at

The time when a deployment of the environment was last attempted.

environment.last_deployment_succeeded_at

The time when the environment was last deployed successfully.

environment.last_succeeded_deployment_id

The ID of the last successful deployment of this environment.

environment.name

The name of the environment.

environment.proton_service_role_arn

The Amazon Resource Name (ARN) of the Proton service role that allows Proton to make calls to other services on your behalf.

environment.provisioning

When included, indicates that the environment template is for customer provisioned and managed infrastructure.

environment.provisioning_repository

The linked repository that you use to host your rendered infrastructure templates for self-managed provisioning. A linked repository is a repository that has been registered with Proton. For more information, see CreateRepository.

Show child fields
environment.provisioning_repository.arn

The Amazon Resource Name (ARN) of the linked repository.

environment.provisioning_repository.branch

The repository branch.

environment.provisioning_repository.name

The repository name.

environment.provisioning_repository.provider

The repository provider.

environment.spec

The environment spec.

environment.template_major_version

The major version of the environment template.

environment.template_minor_version

The minor version of the environment template.

environment.template_name

The Amazon Resource Name (ARN) of the environment template.