Skip to content

aws.sagemaker.describe_edge_deployment_plan

Example SQL Queries

SELECT * FROM
aws.sagemaker.describe_edge_deployment_plan
WHERE
"edge_deployment_plan_name" = 'VALUE';

Description

Describes an edge deployment plan with deployment status per stage.

Table Definition

Column NameColumn Data Type
edge_deployment_plan_name Required Input Column

The name of the edge deployment plan.

VARCHAR
max_results Input Column

The maximum number of results to select (50 by default).

BIGINT
next_token Input Column

Token to use when calling the next set of stages in the edge deployment plan.

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.

creation_time

The time when the edge deployment plan was created.

TIMESTAMP_S
device_fleet_name

The device fleet used for this edge deployment plan.

VARCHAR
edge_deployment_failed

The number of edge devices that failed the deployment.

BIGINT
edge_deployment_pending

The number of edge devices yet to pick up deployment, or in progress.

BIGINT
edge_deployment_plan_arn

The ARN of edge deployment plan.

VARCHAR
edge_deployment_success

The number of edge devices with the successful deployment.

BIGINT
last_modified_time

The time when the edge deployment plan was last updated.

TIMESTAMP_S
model_configs

List of models associated with the edge deployment plan.

STRUCT(
"model_handle" VARCHAR,
"edge_packaging_job_name" VARCHAR
)[]
Show child fields
model_configs[]
Show child fields
model_configs[].edge_packaging_job_name

The edge packaging job associated with this deployment.

model_configs[].model_handle

The name the device application uses to reference this model.

stages

List of stages in the edge deployment plan.

STRUCT(
"stage_name" VARCHAR,
"device_selection_config" STRUCT(
"device_subset_type" VARCHAR,
"percentage" BIGINT,
"device_names" VARCHAR[],
"device_name_contains" VARCHAR
),
"deployment_config" STRUCT(
"failure_handling_policy" VARCHAR
),
"deployment_status" STRUCT(
"stage_status" VARCHAR,
"edge_deployment_success_in_stage" BIGINT,
"edge_deployment_pending_in_stage" BIGINT,
"edge_deployment_failed_in_stage" BIGINT,
"edge_deployment_status_message" VARCHAR,
"edge_deployment_stage_start_time" TIMESTAMP_S
)
)[]
Show child fields
stages[]
Show child fields
stages[].deployment_config

Configuration of the deployment details.

Show child fields
stages[].deployment_config.failure_handling_policy

Toggle that determines whether to rollback to previous configuration if the current deployment fails. By default this is turned on. You may turn this off if you want to investigate the errors yourself.

stages[].deployment_status

General status of the current state.

Show child fields
stages[].deployment_status.edge_deployment_failed_in_stage

The number of edge devices that failed the deployment in current stage.

stages[].deployment_status.edge_deployment_pending_in_stage

The number of edge devices yet to pick up the deployment in current stage, or in progress.

stages[].deployment_status.edge_deployment_stage_start_time

The time when the deployment API started.

stages[].deployment_status.edge_deployment_status_message

A detailed message about deployment status in current stage.

stages[].deployment_status.edge_deployment_success_in_stage

The number of edge devices with the successful deployment in the current stage.

stages[].deployment_status.stage_status

The general status of the current stage.

stages[].device_selection_config

Configuration of the devices in the stage.

Show child fields
stages[].device_selection_config.device_name_contains

A filter to select devices with names containing this name.

stages[].device_selection_config.device_names[]
stages[].device_selection_config.device_subset_type

Type of device subsets to deploy to the current stage.

stages[].device_selection_config.percentage

Percentage of devices in the fleet to deploy to the current stage.

stages[].stage_name

The name of the stage.