get_object_information

CloudDirectory.Client.get_object_information(**kwargs)

Retrieves metadata about an object.

See also: AWS API Documentation

Request Syntax

response = client.get_object_information(
    DirectoryArn='string',
    ObjectReference={
        'Selector': 'string'
    },
    ConsistencyLevel='SERIALIZABLE'|'EVENTUAL'
)

Parameters

• DirectoryArn (string) --

  [REQUIRED]

  The ARN of the directory being retrieved.

• ObjectReference (dict) --

  [REQUIRED]

  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. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes.
    • /some/path - Identifies the object based on path
    • #SomeBatchReference - Identifies the object in a batch call
• ConsistencyLevel (string) -- The consistency level at which to retrieve the object information.

Return type

dict

Returns

Response Syntax

{
    'SchemaFacets': [
        {
            'SchemaArn': 'string',
            'FacetName': 'string'
        },
    ],
    'ObjectIdentifier': 'string'
}

Response Structure

• (dict) --

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

    • (dict) --

      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. If this value is set, FacetName must also be set.

      • FacetName (string) --

        The name of the facet. If this value is set, SchemaArn must also be set.

  • ObjectIdentifier (string) --

    The ObjectIdentifier of the specified object.

Exceptions

• CloudDirectory.Client.exceptions.InternalServiceException
• CloudDirectory.Client.exceptions.InvalidArnException
• CloudDirectory.Client.exceptions.RetryableConflictException
• CloudDirectory.Client.exceptions.ValidationException
• CloudDirectory.Client.exceptions.LimitExceededException
• CloudDirectory.Client.exceptions.AccessDeniedException
• CloudDirectory.Client.exceptions.DirectoryNotEnabledException
• CloudDirectory.Client.exceptions.ResourceNotFoundException