[ aws . personalize ]

describe-dataset-group

Description

Describes the given dataset group. For more information on dataset groups, see CreateDatasetGroup .

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-dataset-group
--dataset-group-arn <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--dataset-group-arn (string)

The Amazon Resource Name (ARN) of the dataset group 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

datasetGroup -> (structure)

A listing of the dataset group’s properties.

name -> (string)

The name of the dataset group.

datasetGroupArn -> (string)

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

status -> (string)

The current status of the dataset group.

A dataset group can be in one of the following states:

• CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

• DELETE PENDING

roleArn -> (string)

The ARN of the IAM role that has permissions to create the dataset group.

kmsKeyArn -> (string)

The Amazon Resource Name (ARN) of the Key Management Service (KMS) key used to encrypt the datasets.

creationDateTime -> (timestamp)

The creation date and time (in Unix time) of the dataset group.

lastUpdatedDateTime -> (timestamp)

The last update date and time (in Unix time) of the dataset group.

failureReason -> (string)

If creating a dataset group fails, provides the reason why.

domain -> (string)

The domain of a Domain dataset group.