model_package_groups

Creates, updates, deletes or gets a model_package_group resource or lists model_package_groups in a region

Overview

Name	model_package_groups
Type	Resource
Description	Resource Type definition for AWS::SageMaker::ModelPackageGroup
Id	awscc.sagemaker.model_package_groups

Fields

get (all properties)

Name	Datatype	Description
▶tags	array	An array of key-value pairs to apply to this resource.
model_package_group_arn	string	The Amazon Resource Name (ARN) of the model package group.
model_package_group_name	string	The name of the model package group.
model_package_group_description	string	The description of the model package group.
model_package_group_policy	object
creation_time	string	The time at which the model package group was created.
model_package_group_status	string	The status of a modelpackage group job.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
model_package_group_arn	string	The Amazon Resource Name (ARN) of the model package group.
region	string	AWS region.

For more information, see AWS::SageMaker::ModelPackageGroup.

Methods

Name	Resource	Accessible by	Required Params
create_resource	model_package_groups	INSERT	ModelPackageGroupName, region
delete_resource	model_package_groups	DELETE	Identifier, region
update_resource	model_package_groups	UPDATE	Identifier, PatchDocument, region
list_resources	model_package_groups_list_only	SELECT	region
get_resource	model_package_groups	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual model_package_group.

SELECT
  region,
  tags,
  model_package_group_arn,
  model_package_group_name,
  model_package_group_description,
  model_package_group_policy,
  creation_time,
  model_package_group_status
FROM awscc.sagemaker.model_package_groups
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ model_package_group_arn }}';

list (identifiers only)

Lists all model_package_groups in a region.

SELECT
  region,
  model_package_group_arn
FROM awscc.sagemaker.model_package_groups_list_only
WHERE
  region = '{{ region }}';

INSERT example

Use the following StackQL query and manifest file to create a new model_package_group resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.sagemaker.model_package_groups (
  ModelPackageGroupName,
  region
)
SELECT
  '{{ model_package_group_name }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.sagemaker.model_package_groups (
  Tags,
  ModelPackageGroupName,
  ModelPackageGroupDescription,
  ModelPackageGroupPolicy,
  region
)
SELECT
  '{{ tags }}',
  '{{ model_package_group_name }}',
  '{{ model_package_group_description }}',
  '{{ model_package_group_policy }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Manifest

version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
  value: '{{ vars.AWS_REGION }}'
resources:
- name: model_package_group
  props:
    - name: tags
      value:
        - value: '{{ value }}'
          key: '{{ key }}'
    - name: model_package_group_name
      value: '{{ model_package_group_name }}'
    - name: model_package_group_description
      value: '{{ model_package_group_description }}'
    - name: model_package_group_policy
      value: {}

UPDATE example

Use the following StackQL query and manifest file to update a model_package_group resource, using stack-deploy.

/*+ update */
UPDATE awscc.sagemaker.model_package_groups
SET PatchDocument = string('{{ {
    "Tags": tags,
    "ModelPackageGroupPolicy": model_package_group_policy
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ model_package_group_arn }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.sagemaker.model_package_groups
WHERE
  Identifier = '{{ model_package_group_arn }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

Permissions

To operate on the model_package_groups resource, the following permissions are required:

Create

sagemaker:CreateModelPackageGroup,
sagemaker:DescribeModelPackageGroup,
sagemaker:GetModelPackageGroupPolicy,
sagemaker:PutModelPackageGroupPolicy,
sagemaker:ListTags,
sagemaker:AddTags

Delete

sagemaker:DeleteModelPackageGroup,
sagemaker:DescribeModelPackageGroup,
sagemaker:GetModelPackageGroupPolicy,
sagemaker:DeleteModelPackageGroupPolicy

List

sagemaker:ListModelPackageGroups

Read

sagemaker:DescribeModelPackageGroup,
sagemaker:GetModelPackageGroupPolicy,
sagemaker:ListTags

Update

sagemaker:DescribeModelPackageGroup,
sagemaker:GetModelPackageGroupPolicy,
sagemaker:DeleteModelPackageGroupPolicy,
sagemaker:PutModelPackageGroupPolicy,
sagemaker:ListTags,
sagemaker:AddTags,
sagemaker:DeleteTags