model_package_groups

Creates, updates, deletes, gets or lists a model_package_groups resource.

Overview

Name	model_package_groups
Type	Resource
Id	aws.sagemaker.model_package_groups

Fields

The following fields are returned by SELECT queries:

describe_model_package_group

Name	Datatype	Description
created_by	object	Information about the user who created or modified a SageMaker resource.
creation_time	string (date-time)	The time that the model group was created.
managed_configuration	object	The managed configuration of the model package group.
model_package_group_arn	string	The Amazon Resource Name (ARN) of the model group. (pattern: <code>arn:aws[a-z-]*:sagemaker:[a-z0-9-]{9,16}:[0-9]{12}:model-package-group/[\S]{1,2048}</code>)
model_package_group_description	string	A description of the model group. (pattern: <code>[\p{L}\p{M}\p{Z}\p{S}\p{N}\p{P}]*</code>)
model_package_group_name	string	The name of the model group. (pattern: <code>[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}</code>)
model_package_group_status	string	The status of the model group. (Pending, InProgress, Completed, Failed, Deleting, DeleteFailed)

list_model_package_groups

Name	Datatype	Description
creation_time	string (date-time)	The time that the model group was created.
managed_configuration	object	The managed configuration of the model package group.
model_package_group_arn	string	The Amazon Resource Name (ARN) of the model group. (pattern: <code>arn:aws[a-z-]*:sagemaker:[a-z0-9-]{9,16}:[0-9]{12}:model-package-group/[\S]{1,2048}</code>)
model_package_group_description	string	A description of the model group. (pattern: <code>[\p{L}\p{M}\p{Z}\p{S}\p{N}\p{P}]*</code>)
model_package_group_name	string	The name of the model group. (pattern: <code>[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}</code>)
model_package_group_status	string	The status of the model group. (Pending, InProgress, Completed, Failed, Deleting, DeleteFailed)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_model_package_group	select	region		Gets a description for the specified model group.
list_model_package_groups	select	region		Gets a list of the model groups in your Amazon Web Services account.
create_model_package_group	insert	region, ModelPackageGroupName		Creates a model group. A model group contains a group of model versions.
delete_model_package_group	delete	region		Deletes the specified model group.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_model_package_group

Gets a description for the specified model group.

SELECT
created_by,
creation_time,
managed_configuration,
model_package_group_arn,
model_package_group_description,
model_package_group_name,
model_package_group_status
FROM aws.sagemaker.model_package_groups
WHERE region = '{{ region }}' -- required
;

list_model_package_groups

Gets a list of the model groups in your Amazon Web Services account.

SELECT
creation_time,
managed_configuration,
model_package_group_arn,
model_package_group_description,
model_package_group_name,
model_package_group_status
FROM aws.sagemaker.model_package_groups
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_model_package_group

Creates a model group. A model group contains a group of model versions.

INSERT INTO aws.sagemaker.model_package_groups (
ModelPackageGroupName,
ModelPackageGroupDescription,
Tags,
ManagedConfiguration,
region
)
SELECT 
'{{ ModelPackageGroupName }}' /* required */,
'{{ ModelPackageGroupDescription }}',
'{{ Tags }}',
'{{ ManagedConfiguration }}',
'{{ region }}'
RETURNING
model_package_group_arn
;

Manifest

# Description fields are for documentation purposes
- name: model_package_groups
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the model_package_groups resource.
  - name: ModelPackageGroupName
    value: "{{ ModelPackageGroupName }}"
    description: |
      The name of the model group.
  - name: ModelPackageGroupDescription
    value: "{{ ModelPackageGroupDescription }}"
    description: |
      A description for the model group.
  - name: Tags
    description: |
      A list of key value pairs associated with the model group. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"
  - name: ManagedConfiguration
    description: |
      The managed configuration of the model package group.
    value:
      ManagedStorageType: "{{ ManagedStorageType }}"

DELETE examples

delete_model_package_group

Deletes the specified model group.

DELETE FROM aws.sagemaker.model_package_groups
WHERE region = '{{ region }}' --required
;