SageMaker / Client / describe_model_package_group

describe_model_package_group#

SageMaker.Client.describe_model_package_group(**kwargs)#

Gets a description for the specified model group.

See also: AWS API Documentation

Request Syntax

response = client.describe_model_package_group(
    ModelPackageGroupName='string'
)
Parameters:

ModelPackageGroupName (string) –

[REQUIRED]

The name of the model group to describe.

Return type:

dict

Returns:

Response Syntax

{
    'ModelPackageGroupName': 'string',
    'ModelPackageGroupArn': 'string',
    'ModelPackageGroupDescription': 'string',
    'CreationTime': datetime(2015, 1, 1),
    'CreatedBy': {
        'UserProfileArn': 'string',
        'UserProfileName': 'string',
        'DomainId': 'string',
        'IamIdentity': {
            'Arn': 'string',
            'PrincipalId': 'string',
            'SourceIdentity': 'string'
        }
    },
    'ModelPackageGroupStatus': 'Pending'|'InProgress'|'Completed'|'Failed'|'Deleting'|'DeleteFailed'
}

Response Structure

  • (dict) –

    • ModelPackageGroupName (string) –

      The name of the model group.

    • ModelPackageGroupArn (string) –

      The Amazon Resource Name (ARN) of the model group.

    • ModelPackageGroupDescription (string) –

      A description of the model group.

    • CreationTime (datetime) –

      The time that the model group was created.

    • CreatedBy (dict) –

      Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.

      • UserProfileArn (string) –

        The Amazon Resource Name (ARN) of the user’s profile.

      • UserProfileName (string) –

        The name of the user’s profile.

      • DomainId (string) –

        The domain associated with the user.

      • IamIdentity (dict) –

        The IAM Identity details associated with the user. These details are associated with model package groups, model packages, and project entities only.

        • Arn (string) –

          The Amazon Resource Name (ARN) of the IAM identity.

        • PrincipalId (string) –

          The ID of the principal that assumes the IAM identity.

        • SourceIdentity (string) –

          The person or application which assumes the IAM identity.

    • ModelPackageGroupStatus (string) –

      The status of the model group.