[ aws . sagemaker ]

describe-context

Description

Describes a context.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-context
--context-name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--context-name (string)

The name of the context 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.

See ‘aws help’ for descriptions of global parameters.

Output

ContextName -> (string)

The name of the context.

ContextArn -> (string)

The Amazon Resource Name (ARN) of the context.

Source -> (structure)

The source of the context.

SourceUri -> (string)

The URI of the source.

SourceType -> (string)

The type of the source.

SourceId -> (string)

The ID of the source.

ContextType -> (string)

The type of the context.

Description -> (string)

The description of the context.

Properties -> (map)

A list of the context’s properties.

key -> (string)

value -> (string)

CreationTime -> (timestamp)

When the context was created.

CreatedBy -> (structure)

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

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.

LastModifiedTime -> (timestamp)

When the context was last modified.

LastModifiedBy -> (structure)

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

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.

LineageGroupArn -> (string)

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