[ aws . sagemaker ]

describe-partner-app

Description

Gets information about a SageMaker Partner AI App.

See also: AWS API Documentation

Synopsis

  describe-partner-app
--arn <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--arn (string)

The ARN of the SageMaker Partner AI App to describe.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

• json
• text
• table
• yaml
• yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

• base64
• raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output

Arn -> (string)

The ARN of the SageMaker Partner AI App that was described.

Name -> (string)

The name of the SageMaker Partner AI App.

Type -> (string)

The type of SageMaker Partner AI App. Must be one of the following: lakera-guard , comet , deepchecks-llm-evaluation , or fiddler .

Status -> (string)

The status of the SageMaker Partner AI App.

CreationTime -> (timestamp)

The time that the SageMaker Partner AI App was created.

ExecutionRoleArn -> (string)

The ARN of the IAM role associated with the SageMaker Partner AI App.

BaseUrl -> (string)

The URL of the SageMaker Partner AI App that the Application SDK uses to support in-app calls for the user.

MaintenanceConfig -> (structure)

Maintenance configuration settings for the SageMaker Partner AI App.

MaintenanceWindowStart -> (string)

The day and time of the week in Coordinated Universal Time (UTC) 24-hour standard time that weekly maintenance updates are scheduled. This value must take the following format: 3-letter-day:24-h-hour:minute . For example: TUE:03:30 .

Tier -> (string)

The instance type and size of the cluster attached to the SageMaker Partner AI App.

Version -> (string)

The version of the SageMaker Partner AI App.

ApplicationConfig -> (structure)

Configuration settings for the SageMaker Partner AI App.

AdminUsers -> (list)

The list of users that are given admin access to the SageMaker Partner AI App.

(string)

Arguments -> (map)

This is a map of required inputs for a SageMaker Partner AI App. Based on the application type, the map is populated with a key and value pair that is specific to the user and application.

key -> (string)

value -> (string)

AuthType -> (string)

The authorization type that users use to access the SageMaker Partner AI App.

EnableIamSessionBasedIdentity -> (boolean)

When set to TRUE , the SageMaker Partner AI App sets the Amazon Web Services IAM session name or the authenticated IAM user as the identity of the SageMaker Partner AI App user.

Error -> (structure)

This is an error field object that contains the error code and the reason for an operation failure.

Code -> (string)

The error code for an invalid or failed operation.

Reason -> (string)

The failure reason for the operation.