Skip to content
AWS for Query.Farm

aws.codeguruprofiler.list_profiling_groups

Example SQL Queries

SELECT * FROM
aws.codeguruprofiler.list_profiling_groups;

Description

Returns a list of profiling groups. The profiling groups are returned as ProfilingGroupDescription objects.

Table Definition

Column NameColumn Data Type
include_description Input Column

A Boolean value indicating whether to include a description. If true, then a list of ProfilingGroupDescription objects that contain detailed information about profiling groups is returned. If false, then a list of profiling group names is returned.

BOOLEAN
max_results Input Column

The maximum number of profiling groups results returned by ListProfilingGroups in paginated output. When this parameter is used, ListProfilingGroups only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListProfilingGroups request with the returned nextToken value. 

BIGINT
next_token Input Column

The nextToken value to include in a future ListProfilingGroups request. When the results of a ListProfilingGroups request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return. 

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.

profiling_group_names

A returned list of profiling group names. A list of the names is returned only if includeDescription is false, otherwise a list of ProfilingGroupDescription objects is returned. 

VARCHAR[]
Show child fields
profiling_group_names[]
profiling_groups

A returned list ProfilingGroupDescription objects. A list of ProfilingGroupDescription objects is returned only if includeDescription is true, otherwise a list of profiling group names is returned. 

STRUCT(
    "agent_orchestration_config" STRUCT(
        "profiling_enabled" BOOLEAN
    ),
    "arn" VARCHAR,
    "compute_platform" VARCHAR,
    "created_at" TIMESTAMP_S,
    "name" VARCHAR,
    "profiling_status" STRUCT(
        "latest_agent_orchestrated_at" TIMESTAMP_S,
        "latest_agent_profile_reported_at" TIMESTAMP_S,
        "latest_aggregated_profile" STRUCT(
            "period" VARCHAR,
            "start" TIMESTAMP_S
        )
    ),
    "tags" MAP(VARCHAR, VARCHAR),
    "updated_at" TIMESTAMP_S
)[]
Show child fields
profiling_groups[]
Show child fields
profiling_groups[].agent_orchestration_config

An AgentOrchestrationConfig object that indicates if the profiling group is enabled for profiled or not.

Show child fields
profiling_groups[].agent_orchestration_config.profiling_enabled

A Boolean that specifies whether the profiling agent collects profiling data or not. Set to true to enable profiling.

profiling_groups[].arn

The Amazon Resource Name (ARN) identifying the profiling group resource.

profiling_groups[].compute_platform

The compute platform of the profiling group. If it is set to AWSLambda, then the profiled application runs on AWS Lambda. If it is set to Default, then the profiled application runs on a compute platform that is not AWS Lambda, such an Amazon EC2 instance, an on-premises server, or a different platform. The default is Default.

profiling_groups[].created_at

The time when the profiling group was created. Specify using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.

profiling_groups[].name

The name of the profiling group.

profiling_groups[].profiling_status

A ProfilingStatus object that includes information about the last time a profile agent pinged back, the last time a profile was received, and the aggregation period and start time for the most recent aggregated profile.

Show child fields
profiling_groups[].profiling_status.latest_agent_orchestrated_at

The date and time when the profiling agent most recently pinged back. Specify using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.

profiling_groups[].profiling_status.latest_agent_profile_reported_at

The date and time when the most recent profile was received. Specify using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.

profiling_groups[].profiling_status.latest_aggregated_profile

An AggregatedProfileTime object that contains the aggregation period and start time for an aggregated profile.

Show child fields
profiling_groups[].profiling_status.latest_aggregated_profile.period

The aggregation period. This indicates the period during which an aggregation profile collects posted agent profiles for a profiling group. Use one of three valid durations that are specified using the ISO 8601 format.

  • P1D — 1 day

  • PT1H — 1 hour

  • PT5M — 5 minutes

profiling_groups[].profiling_status.latest_aggregated_profile.start

The time that aggregation of posted agent profiles for a profiling group starts. The aggregation profile contains profiles posted by the agent starting at this time for an aggregation period specified by the period property of the AggregatedProfileTime object.

Specify start using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.

profiling_groups[].tags

A list of the tags that belong to this profiling group.

profiling_groups[].updated_at

The date and time when the profiling group was last updated. Specify using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.