[ aws . clouddirectory ]

get-object-information

Description

Retrieves metadata about an object.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-object-information
--directory-arn <value>
--object-reference <value>
[--consistency-level <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--directory-arn (string)

The ARN of the directory being retrieved.

--object-reference (structure)

A reference to the object.

Selector -> (string)

A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see Access Objects . You can identify an object in one of the following ways:

• $ObjectIdentifier - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier

• /some/path - Identifies the object based on path

• #SomeBatchReference - Identifies the object in a batch call

Shorthand Syntax:

Selector=string

JSON Syntax:

{
  "Selector": "string"
}

--consistency-level (string)

The consistency level at which to retrieve the object information.

Possible values:

• SERIALIZABLE

• EVENTUAL

--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.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Output

SchemaFacets -> (list)

The facets attached to the specified object. Although the response does not include minor version information, the most recently applied minor version of each Facet is in effect. See GetAppliedSchemaVersion for details.

(structure)

A facet.

SchemaArn -> (string)

The ARN of the schema that contains the facet with no minor component. See arns and In-Place Schema Upgrade for a description of when to provide minor versions.

FacetName -> (string)

The name of the facet.

ObjectIdentifier -> (string)

The ObjectIdentifier of the specified object.