Skip to content

Describe Partner App

sagemaker_describe_partner_app R Documentation

Gets information about a SageMaker Partner AI App

Description

Gets information about a SageMaker Partner AI App.

Usage

sagemaker_describe_partner_app(Arn, IncludeAvailableUpgrade)

Arguments

Arn

[required] The ARN of the SageMaker Partner AI App to describe.

IncludeAvailableUpgrade

When set to TRUE, the response includes available upgrade information for the SageMaker Partner AI App. Default is FALSE.

Value

A list with the following syntax:

list(
  Arn = "string",
  Name = "string",
  Type = "lakera-guard"|"comet"|"deepchecks-llm-evaluation"|"fiddler",
  Status = "Creating"|"Updating"|"Deleting"|"Available"|"Failed"|"UpdateFailed"|"Deleted",
  CreationTime = as.POSIXct(
    "2015-01-01"
  ),
  LastModifiedTime = as.POSIXct(
    "2015-01-01"
  ),
  ExecutionRoleArn = "string",
  KmsKeyId = "string",
  BaseUrl = "string",
  MaintenanceConfig = list(
    MaintenanceWindowStart = "string"
  ),
  Tier = "string",
  Version = "string",
  ApplicationConfig = list(
    AdminUsers = list(
      "string"
    ),
    Arguments = list(
      "string"
    ),
    AssignedGroupPatterns = list(
      "string"
    ),
    RoleGroupAssignments = list(
      list(
        RoleName = "string",
        GroupPatterns = list(
          "string"
        )
      )
    )
  ),
  AuthType = "IAM",
  EnableIamSessionBasedIdentity = TRUE|FALSE,
  Error = list(
    Code = "string",
    Reason = "string"
  ),
  EnableAutoMinorVersionUpgrade = TRUE|FALSE,
  CurrentVersionEolDate = as.POSIXct(
    "2015-01-01"
  ),
  AvailableUpgrade = list(
    Version = "string",
    ReleaseNotes = list(
      "string"
    )
  )
)

Request syntax

svc$describe_partner_app(
  Arn = "string",
  IncludeAvailableUpgrade = TRUE|FALSE
)