AWSSDK.CloudDirectory

Amazon Cloud Directory

Amazon Cloud Directory is a component of the AWS Directory Service that simplifies the development and management of cloud-scale web, mobile, and IoT applications. This guide describes the Cloud Directory operations that you can call programmatically and includes detailed information on data types and errors. For information about AWS Directory Services features, see AWS Directory Service and the AWS Directory Service Administration Guide.

This document is generated from apis/clouddirectory-2016-05-10.normal.json. See JuliaCloud/AWSCore.jl.

AWSSDK.CloudDirectory.add_facet_to_object — Function.

using AWSSDK.CloudDirectory.add_facet_to_object
add_facet_to_object([::AWSConfig], arguments::Dict)
add_facet_to_object([::AWSConfig]; x-amz-data-partition=, SchemaFacet=, ObjectReference=, <keyword arguments>)

using AWSCore.Services.clouddirectory
clouddirectory([::AWSConfig], "PUT", "/amazonclouddirectory/2017-01-11/object/facets", arguments::Dict)
clouddirectory([::AWSConfig], "PUT", "/amazonclouddirectory/2017-01-11/object/facets", x-amz-data-partition=, SchemaFacet=, ObjectReference=, <keyword arguments>)

AddFacetToObject Operation

Adds a new Facet to an object.

Arguments

x-amz-data-partition = ::String – Required

The Amazon Resource Name (ARN) that is associated with the Directory where the object resides. For more information, see arns.

SchemaFacet = [ ... ] – Required

Identifiers for the facet that you are adding to the object.

 SchemaFacet = [
        "SchemaArn" =>  ::String,
        "FacetName" =>  ::String
    ]

ObjectAttributeList = [[ ... ], ...]

Attributes on the facet that you are adding to the object.

 ObjectAttributeList = [[
        "Key" => <required> [
            "SchemaArn" => <required> ::String,
            "FacetName" => <required> ::String,
            "Name" => <required> ::String
        ],
        "Value" => <required> [
            "StringValue" =>  ::String,
            "BinaryValue" =>  blob,
            "BooleanValue" =>  ::Bool,
            "NumberValue" =>  ::String,
            "DatetimeValue" =>  timestamp
        ]
    ], ...]

ObjectReference = ["Selector" => ::String] – Required

A reference to the object you are adding the specified facet to.

Returns

AddFacetToObjectResponse

Exceptions

InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryNotEnabledException, ResourceNotFoundException or FacetValidationException.

See also: AWS API Documentation

AWSSDK.CloudDirectory.apply_schema — Function.

using AWSSDK.CloudDirectory.apply_schema
apply_schema([::AWSConfig], arguments::Dict)
apply_schema([::AWSConfig]; PublishedSchemaArn=, x-amz-data-partition=)

using AWSCore.Services.clouddirectory
clouddirectory([::AWSConfig], "PUT", "/amazonclouddirectory/2017-01-11/schema/apply", arguments::Dict)
clouddirectory([::AWSConfig], "PUT", "/amazonclouddirectory/2017-01-11/schema/apply", PublishedSchemaArn=, x-amz-data-partition=)

ApplySchema Operation

Copies the input published schema into the Directory with the same name and version as that of the published schema .

Arguments

PublishedSchemaArn = ::String – Required

Published schema Amazon Resource Name (ARN) that needs to be copied. For more information, see arns.

x-amz-data-partition = ::String – Required

The Amazon Resource Name (ARN) that is associated with the Directory into which the schema is copied. For more information, see arns.

Returns

ApplySchemaResponse

Exceptions

See also: AWS API Documentation

AWSSDK.CloudDirectory.attach_object — Function.

using AWSSDK.CloudDirectory.attach_object
attach_object([::AWSConfig], arguments::Dict)
attach_object([::AWSConfig]; x-amz-data-partition=, ParentReference=, ChildReference=, LinkName=)

using AWSCore.Services.clouddirectory
clouddirectory([::AWSConfig], "PUT", "/amazonclouddirectory/2017-01-11/object/attach", arguments::Dict)
clouddirectory([::AWSConfig], "PUT", "/amazonclouddirectory/2017-01-11/object/attach", x-amz-data-partition=, ParentReference=, ChildReference=, LinkName=)

AttachObject Operation

Attaches an existing object to another object. An object can be accessed in two ways:

Using the path
Using ObjectIdentifier

Arguments

x-amz-data-partition = ::String – Required

Amazon Resource Name (ARN) that is associated with the Directory where both objects reside. For more information, see arns.

ParentReference = ["Selector" => ::String] – Required

The parent object reference.

ChildReference = ["Selector" => ::String] – Required

The child object reference to be attached to the object.

LinkName = ::String – Required

The link name with which the child object is attached to the parent.

Returns

AttachObjectResponse

Exceptions

See also: AWS API Documentation

AWSSDK.CloudDirectory.attach_policy — Function.

using AWSSDK.CloudDirectory.attach_policy
attach_policy([::AWSConfig], arguments::Dict)
attach_policy([::AWSConfig]; PolicyReference=, ObjectReference=, <keyword arguments>)

using AWSCore.Services.clouddirectory
clouddirectory([::AWSConfig], "PUT", "/amazonclouddirectory/2017-01-11/policy/attach", arguments::Dict)
clouddirectory([::AWSConfig], "PUT", "/amazonclouddirectory/2017-01-11/policy/attach", PolicyReference=, ObjectReference=, <keyword arguments>)

AttachPolicy Operation

Attaches a policy object to a regular object. An object can have a limited number of attached policies.

Arguments

x-amz-data-partition = ::String

The Amazon Resource Name (ARN) that is associated with the Directory where both objects reside. For more information, see arns.

PolicyReference = ["Selector" => ::String] – Required

The reference that is associated with the policy object.

ObjectReference = ["Selector" => ::String] – Required

The reference that identifies the object to which the policy will be attached.

Returns

AttachPolicyResponse

Exceptions

InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryNotEnabledException, InvalidArnException, ResourceNotFoundException or NotPolicyException.

See also: AWS API Documentation

AWSSDK.CloudDirectory.attach_to_index — Function.

using AWSSDK.CloudDirectory.attach_to_index
attach_to_index([::AWSConfig], arguments::Dict)
attach_to_index([::AWSConfig]; x-amz-data-partition=, IndexReference=, TargetReference=)

using AWSCore.Services.clouddirectory
clouddirectory([::AWSConfig], "PUT", "/amazonclouddirectory/2017-01-11/index/attach", arguments::Dict)
clouddirectory([::AWSConfig], "PUT", "/amazonclouddirectory/2017-01-11/index/attach", x-amz-data-partition=, IndexReference=, TargetReference=)

AttachToIndex Operation

Attaches the specified object to the specified index.

Arguments

x-amz-data-partition = ::String – Required

The Amazon Resource Name (ARN) of the directory where the object and index exist.

IndexReference = ["Selector" => ::String] – Required

A reference to the index that you are attaching the object to.

TargetReference = ["Selector" => ::String] – Required

A reference to the object that you are attaching to the index.

Returns

AttachToIndexResponse

Exceptions

See also: AWS API Documentation

AWSSDK.CloudDirectory.attach_typed_link — Function.

using AWSSDK.CloudDirectory.attach_typed_link
attach_typed_link([::AWSConfig], arguments::Dict)
attach_typed_link([::AWSConfig]; x-amz-data-partition=, SourceObjectReference=, TargetObjectReference=, TypedLinkFacet=, Attributes=)

using AWSCore.Services.clouddirectory
clouddirectory([::AWSConfig], "PUT", "/amazonclouddirectory/2017-01-11/typedlink/attach", arguments::Dict)
clouddirectory([::AWSConfig], "PUT", "/amazonclouddirectory/2017-01-11/typedlink/attach", x-amz-data-partition=, SourceObjectReference=, TargetObjectReference=, TypedLinkFacet=, Attributes=)

AttachTypedLink Operation

Attaches a typed link to a specified source and target object. For more information, see Typed link.

Arguments

x-amz-data-partition = ::String – Required

The Amazon Resource Name (ARN) of the directory where you want to attach the typed link.

SourceObjectReference = ["Selector" => ::String] – Required

Identifies the source object that the typed link will attach to.

TargetObjectReference = ["Selector" => ::String] – Required

Identifies the target object that the typed link will attach to.

TypedLinkFacet = [ ... ] – Required

Identifies the typed link facet that is associated with the typed link.

 TypedLinkFacet = [
        "SchemaArn" => <required> ::String,
        "TypedLinkName" => <required> ::String
    ]

Attributes = [[ ... ], ...] – Required

A set of attributes that are associated with the typed link.

 Attributes = [[
        "AttributeName" => <required> ::String,
        "Value" => <required> [
            "StringValue" =>  ::String,
            "BinaryValue" =>  blob,
            "BooleanValue" =>  ::Bool,
            "NumberValue" =>  ::String,
            "DatetimeValue" =>  timestamp
        ]
    ], ...]

Returns

AttachTypedLinkResponse

Exceptions

See also: AWS API Documentation

AWSSDK.CloudDirectory.batch_read — Function.

using AWSSDK.CloudDirectory.batch_read
batch_read([::AWSConfig], arguments::Dict)
batch_read([::AWSConfig]; x-amz-data-partition=, Operations=, <keyword arguments>)

using AWSCore.Services.clouddirectory
clouddirectory([::AWSConfig], "POST", "/amazonclouddirectory/2017-01-11/batchread", arguments::Dict)
clouddirectory([::AWSConfig], "POST", "/amazonclouddirectory/2017-01-11/batchread", x-amz-data-partition=, Operations=, <keyword arguments>)

BatchRead Operation

Performs all the read operations in a batch.

Arguments

x-amz-data-partition = ::String – Required

The Amazon Resource Name (ARN) that is associated with the Directory. For more information, see arns.

Operations = [[ ... ], ...] – Required

A list of operations that are part of the batch.

 Operations = [[
        "ListObjectAttributes" =>  [
            "ObjectReference" => <required> ["Selector" =>  ::String],
            "NextToken" =>  ::String,
            "MaxResults" =>  ::Int,
            "FacetFilter" =>  [
                "SchemaArn" =>  ::String,
                "FacetName" =>  ::String
            ]
        ],
        "ListObjectChildren" =>  [
            "ObjectReference" => <required> ["Selector" =>  ::String],
            "NextToken" =>  ::String,
            "MaxResults" =>  ::Int
        ],
        "ListAttachedIndices" =>  [
            "TargetReference" => <required> ["Selector" =>  ::String],
            "NextToken" =>  ::String,
            "MaxResults" =>  ::Int
        ],
        "ListObjectParentPaths" =>  [
            "ObjectReference" => <required> ["Selector" =>  ::String],
            "NextToken" =>  ::String,
            "MaxResults" =>  ::Int
        ],
        "GetObjectInformation" =>  ["ObjectReference" => <required> ["Selector" =>  ::String]],
        "ListObjectPolicies" =>  [
            "ObjectReference" => <required> ["Selector" =>  ::String],
            "NextToken" =>  ::String,
            "MaxResults" =>  ::Int
        ],
        "ListPolicyAttachments" =>  [
            "PolicyReference" => <required> ["Selector" =>  ::String],
            "NextToken" =>  ::String,
            "MaxResults" =>  ::Int
        ],
        "LookupPolicy" =>  [
            "ObjectReference" => <required> ["Selector" =>  ::String],
            "NextToken" =>  ::String,
            "MaxResults" =>  ::Int
        ],
        "ListIndex" =>  [
            "RangesOnIndexedValues" =>  [[
                "AttributeKey" =>  [
                    "SchemaArn" => <required> ::String,
                    "FacetName" => <required> ::String,
                    "Name" => <required> ::String
                ],
                "Range" =>  [
                    "StartMode" => <required> "FIRST", "LAST", "LAST_BEFORE_MISSING_VALUES", "INCLUSIVE" or "EXCLUSIVE",
                    "StartValue" =>  [
                        "StringValue" =>  ::String,
                        "BinaryValue" =>  blob,
                        "BooleanValue" =>  ::Bool,
                        "NumberValue" =>  ::String,
                        "DatetimeValue" =>  timestamp
                    ],
                    "EndMode" => <required> "FIRST", "LAST", "LAST_BEFORE_MISSING_VALUES", "INCLUSIVE" or "EXCLUSIVE",
                    "EndValue" =>  [
                        "StringValue" =>  ::String,
                        "BinaryValue" =>  blob,
                        "BooleanValue" =>  ::Bool,
                        "NumberValue" =>  ::String,
                        "DatetimeValue" =>  timestamp
                    ]
                ]
            ], ...],
            "IndexReference" => <required> ["Selector" =>  ::String],
            "MaxResults" =>  ::Int,
            "NextToken" =>  ::String
        ],
        "ListOutgoingTypedLinks" =>  [
            "ObjectReference" => <required> ["Selector" =>  ::String],
            "FilterAttributeRanges" =>  [[
                "AttributeName" =>  ::String,
                "Range" => <required> [
                    "StartMode" => <required> "FIRST", "LAST", "LAST_BEFORE_MISSING_VALUES", "INCLUSIVE" or "EXCLUSIVE",
                    "StartValue" =>  [
                        "StringValue" =>  ::String,
                        "BinaryValue" =>  blob,
                        "BooleanValue" =>  ::Bool,
                        "NumberValue" =>  ::String,
                        "DatetimeValue" =>  timestamp
                    ],
                    "EndMode" => <required> "FIRST", "LAST", "LAST_BEFORE_MISSING_VALUES", "INCLUSIVE" or "EXCLUSIVE",
                    "EndValue" =>  [
                        "StringValue" =>  ::String,
                        "BinaryValue" =>  blob,
                        "BooleanValue" =>  ::Bool,
                        "NumberValue" =>  ::String,
                        "DatetimeValue" =>  timestamp
                    ]
                ]
            ], ...],
            "FilterTypedLink" =>  [
                "SchemaArn" => <required> ::String,
                "TypedLinkName" => <required> ::String
            ],
            "NextToken" =>  ::String,
            "MaxResults" =>  ::Int
        ],
        "ListIncomingTypedLinks" =>  [
            "ObjectReference" => <required> ["Selector" =>  ::String],
            "FilterAttributeRanges" =>  [[
                "AttributeName" =>  ::String,
                "Range" => <required> [
                    "StartMode" => <required> "FIRST", "LAST", "LAST_BEFORE_MISSING_VALUES", "INCLUSIVE" or "EXCLUSIVE",
                    "StartValue" =>  [
                        "StringValue" =>  ::String,
                        "BinaryValue" =>  blob,
                        "BooleanValue" =>  ::Bool,
                        "NumberValue" =>  ::String,
                        "DatetimeValue" =>  timestamp
                    ],
                    "EndMode" => <required> "FIRST", "LAST", "LAST_BEFORE_MISSING_VALUES", "INCLUSIVE" or "EXCLUSIVE",
                    "EndValue" =>  [
                        "StringValue" =>  ::String,
                        "BinaryValue" =>  blob,
                        "BooleanValue" =>  ::Bool,
                        "NumberValue" =>  ::String,
                        "DatetimeValue" =>  timestamp
                    ]
                ]
            ], ...],
            "FilterTypedLink" =>  [
                "SchemaArn" => <required> ::String,
                "TypedLinkName" => <required> ::String
            ],
            "NextToken" =>  ::String,
            "MaxResults" =>  ::Int
        ]
    ], ...]

x-amz-consistency-level = "SERIALIZABLE" or "EVENTUAL"

Represents the manner and timing in which the successful write or update of an object is reflected in a subsequent read operation of that same object.

Returns

BatchReadResponse

Exceptions

InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException or DirectoryNotEnabledException.

See also: AWS API Documentation

AWSSDK.CloudDirectory.batch_write — Function.

using AWSSDK.CloudDirectory.batch_write
batch_write([::AWSConfig], arguments::Dict)
batch_write([::AWSConfig]; x-amz-data-partition=, Operations=)

using AWSCore.Services.clouddirectory
clouddirectory([::AWSConfig], "PUT", "/amazonclouddirectory/2017-01-11/batchwrite", arguments::Dict)
clouddirectory([::AWSConfig], "PUT", "/amazonclouddirectory/2017-01-11/batchwrite", x-amz-data-partition=, Operations=)

BatchWrite Operation

Performs all the write operations in a batch. Either all the operations succeed or none. Batch writes supports only object-related operations.

Arguments

x-amz-data-partition = ::String – Required

The Amazon Resource Name (ARN) that is associated with the Directory. For more information, see arns.

Operations = [[ ... ], ...] – Required

A list of operations that are part of the batch.

 Operations = [[
        "CreateObject" =>  [
            "SchemaFacet" => <required> [[
                "SchemaArn" =>  ::String,
                "FacetName" =>  ::String
            ], ...],
            "ObjectAttributeList" => <required> [[
                "Key" => <required> [
                    "SchemaArn" => <required> ::String,
                    "FacetName" => <required> ::String,
                    "Name" => <required> ::String
                ],
                "Value" => <required> [
                    "StringValue" =>  ::String,
                    "BinaryValue" =>  blob,
                    "BooleanValue" =>  ::Bool,
                    "NumberValue" =>  ::String,
                    "DatetimeValue" =>  timestamp
                ]
            ], ...],
            "ParentReference" => <required> ["Selector" =>  ::String],
            "LinkName" => <required> ::String,
            "BatchReferenceName" => <required> ::String
        ],
        "AttachObject" =>  [
            "ParentReference" => <required> ["Selector" =>  ::String],
            "ChildReference" => <required> ["Selector" =>  ::String],
            "LinkName" => <required> ::String
        ],
        "DetachObject" =>  [
            "ParentReference" => <required> ["Selector" =>  ::String],
            "LinkName" => <required> ::String,
            "BatchReferenceName" => <required> ::String
        ],
        "UpdateObjectAttributes" =>  [
            "ObjectReference" => <required> ["Selector" =>  ::String],
            "AttributeUpdates" => <required> [[
                "ObjectAttributeKey" =>  [
                    "SchemaArn" => <required> ::String,
                    "FacetName" => <required> ::String,
                    "Name" => <required> ::String
                ],
                "ObjectAttributeAction" =>  [
                    "ObjectAttributeActionType" =>  "CREATE_OR_UPDATE" or "DELETE",
                    "ObjectAttributeUpdateValue" =>  [
                        "StringValue" =>  ::String,
                        "BinaryValue" =>  blob,
                        "BooleanValue" =>  ::Bool,
                        "NumberValue" =>  ::String,
                        "DatetimeValue" =>  timestamp
                    ]
                ]
            ], ...]
        ],
        "DeleteObject" =>  ["ObjectReference" => <required> ["Selector" =>  ::String]],
        "AddFacetToObject" =>  [
            "SchemaFacet" => <required> [
                "SchemaArn" =>  ::String,
                "FacetName" =>  ::String
            ],
            "ObjectAttributeList" => <required> [[
                "Key" => <required> [
                    "SchemaArn" => <required> ::String,
                    "FacetName" => <required> ::String,
                    "Name" => <required> ::String
                ],
                "Value" => <required> [
                    "StringValue" =>  ::String,
                    "BinaryValue" =>  blob,
                    "BooleanValue" =>  ::Bool,
                    "NumberValue" =>  ::String,
                    "DatetimeValue" =>  timestamp
                ]
            ], ...],
            "ObjectReference" => <required> ["Selector" =>  ::String]
        ],
        "RemoveFacetFromObject" =>  [
            "SchemaFacet" => <required> [
                "SchemaArn" =>  ::String,
                "FacetName" =>  ::String
            ],
            "ObjectReference" => <required> ["Selector" =>  ::String]
        ],
        "AttachPolicy" =>  [
            "PolicyReference" => <required> ["Selector" =>  ::String],
            "ObjectReference" => <required> ["Selector" =>  ::String]
        ],
        "DetachPolicy" =>  [
            "PolicyReference" => <required> ["Selector" =>  ::String],
            "ObjectReference" => <required> ["Selector" =>  ::String]
        ],
        "CreateIndex" =>  [
            "OrderedIndexedAttributeList" => <required> [[
                "SchemaArn" => <required> ::String,
                "FacetName" => <required> ::String,
                "Name" => <required> ::String
            ], ...],
            "IsUnique" => <required> ::Bool,
            "ParentReference" =>  ["Selector" =>  ::String],
            "LinkName" =>  ::String,
            "BatchReferenceName" =>  ::String
        ],
        "AttachToIndex" =>  [
            "IndexReference" => <required> ["Selector" =>  ::String],
            "TargetReference" => <required> ["Selector" =>  ::String]
        ],
        "DetachFromIndex" =>  [
            "IndexReference" => <required> ["Selector" =>  ::String],
            "TargetReference" => <required> ["Selector" =>  ::String]
        ],
        "AttachTypedLink" =>  [
            "SourceObjectReference" => <required> ["Selector" =>  ::String],
            "TargetObjectReference" => <required> ["Selector" =>  ::String],
            "TypedLinkFacet" => <required> [
                "SchemaArn" => <required> ::String,
                "TypedLinkName" => <required> ::String
            ],
            "Attributes" => <required> [[
                "AttributeName" => <required> ::String,
                "Value" => <required> [
                    "StringValue" =>  ::String,
                    "BinaryValue" =>  blob,
                    "BooleanValue" =>  ::Bool,
                    "NumberValue" =>  ::String,
                    "DatetimeValue" =>  timestamp
                ]
            ], ...]
        ],
        "DetachTypedLink" =>  ["TypedLinkSpecifier" => <required> [
                "TypedLinkFacet" => <required> [
                    "SchemaArn" => <required> ::String,
                    "TypedLinkName" => <required> ::String
                ],
                "SourceObjectReference" => <required> ["Selector" =>  ::String],
                "TargetObjectReference" => <required> ["Selector" =>  ::String],
                "IdentityAttributeValues" => <required> [[
                    "AttributeName" => <required> ::String,
                    "Value" => <required> [
                        "StringValue" =>  ::String,
                        "BinaryValue" =>  blob,
                        "BooleanValue" =>  ::Bool,
                        "NumberValue" =>  ::String,
                        "DatetimeValue" =>  timestamp
                    ]
                ], ...]
            ]]
    ], ...]

Returns

BatchWriteResponse

Exceptions

See also: AWS API Documentation

AWSSDK.CloudDirectory.create_directory — Function.

using AWSSDK.CloudDirectory.create_directory
create_directory([::AWSConfig], arguments::Dict)
create_directory([::AWSConfig]; Name=, x-amz-data-partition=)

using AWSCore.Services.clouddirectory
clouddirectory([::AWSConfig], "PUT", "/amazonclouddirectory/2017-01-11/directory/create", arguments::Dict)
clouddirectory([::AWSConfig], "PUT", "/amazonclouddirectory/2017-01-11/directory/create", Name=, x-amz-data-partition=)

CreateDirectory Operation

Creates a Directory by copying the published schema into the directory. A directory cannot be created without a schema.

Arguments

Name = ::String – Required

The name of the Directory. Should be unique per account, per region.

x-amz-data-partition = ::String – Required

The Amazon Resource Name (ARN) of the published schema that will be copied into the data Directory. For more information, see arns.

Returns

CreateDirectoryResponse

Exceptions

InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryAlreadyExistsException, InvalidArnException or ResourceNotFoundException.

See also: AWS API Documentation

AWSSDK.CloudDirectory.create_facet — Function.

using AWSSDK.CloudDirectory.create_facet
create_facet([::AWSConfig], arguments::Dict)
create_facet([::AWSConfig]; x-amz-data-partition=, Name=, ObjectType=, <keyword arguments>)

using AWSCore.Services.clouddirectory
clouddirectory([::AWSConfig], "PUT", "/amazonclouddirectory/2017-01-11/facet/create", arguments::Dict)
clouddirectory([::AWSConfig], "PUT", "/amazonclouddirectory/2017-01-11/facet/create", x-amz-data-partition=, Name=, ObjectType=, <keyword arguments>)

CreateFacet Operation

Creates a new Facet in a schema. Facet creation is allowed only in development or applied schemas.

Arguments

x-amz-data-partition = ::String – Required

The schema ARN in which the new Facet will be created. For more information, see arns.

Name = ::String – Required

The name of the Facet, which is unique for a given schema.

Attributes = [[ ... ], ...]

The attributes that are associated with the Facet.

 Attributes = [[
        "Name" => <required> ::String,
        "AttributeDefinition" =>  [
            "Type" => <required> "STRING", "BINARY", "BOOLEAN", "NUMBER" or "DATETIME",
            "DefaultValue" =>  [
                "StringValue" =>  ::String,
                "BinaryValue" =>  blob,
                "BooleanValue" =>  ::Bool,
                "NumberValue" =>  ::String,
                "DatetimeValue" =>  timestamp
            ],
            "IsImmutable" =>  ::Bool,
            "Rules" =>  ::Dict{String,String}
        ],
        "AttributeReference" =>  [
            "TargetFacetName" => <required> ::String,
            "TargetAttributeName" => <required> ::String
        ],
        "RequiredBehavior" =>  "REQUIRED_ALWAYS" or "NOT_REQUIRED"
    ], ...]

ObjectType = "NODE", "LEAF_NODE", "POLICY" or "INDEX" – Required

Specifies whether a given object created from this facet is of type node, leaf node, policy or index.

Node: Can have multiple children but one parent.
Leaf node: Cannot have children but can have multiple parents.
Policy: Allows you to store a policy document and policy type. For more information, see Policies.
Index: Can be created with the Index API.

Returns

CreateFacetResponse

Exceptions

InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, ResourceNotFoundException, FacetAlreadyExistsException, InvalidRuleException or FacetValidationException.

See also: AWS API Documentation

AWSSDK.CloudDirectory.create_index — Function.

using AWSSDK.CloudDirectory.create_index
create_index([::AWSConfig], arguments::Dict)
create_index([::AWSConfig]; x-amz-data-partition=, OrderedIndexedAttributeList=, IsUnique=, <keyword arguments>)

using AWSCore.Services.clouddirectory
clouddirectory([::AWSConfig], "PUT", "/amazonclouddirectory/2017-01-11/index", arguments::Dict)
clouddirectory([::AWSConfig], "PUT", "/amazonclouddirectory/2017-01-11/index", x-amz-data-partition=, OrderedIndexedAttributeList=, IsUnique=, <keyword arguments>)

CreateIndex Operation

Creates an index object. See Indexing for more information.

Arguments

x-amz-data-partition = ::String – Required

The ARN of the directory where the index should be created.

OrderedIndexedAttributeList = [[ ... ], ...] – Required

Specifies the attributes that should be indexed on. Currently only a single attribute is supported.

 OrderedIndexedAttributeList = [[
        "SchemaArn" => <required> ::String,
        "FacetName" => <required> ::String,
        "Name" => <required> ::String
    ], ...]

IsUnique = ::Bool – Required

Indicates whether the attribute that is being indexed has unique values or not.

ParentReference = ["Selector" => ::String]

A reference to the parent object that contains the index object.

LinkName = ::String

The name of the link between the parent object and the index object.

Returns

CreateIndexResponse

Exceptions

See also: AWS API Documentation

AWSSDK.CloudDirectory.create_object — Function.

using AWSSDK.CloudDirectory.create_object
create_object([::AWSConfig], arguments::Dict)
create_object([::AWSConfig]; x-amz-data-partition=, SchemaFacets=, <keyword arguments>)

using AWSCore.Services.clouddirectory
clouddirectory([::AWSConfig], "PUT", "/amazonclouddirectory/2017-01-11/object", arguments::Dict)
clouddirectory([::AWSConfig], "PUT", "/amazonclouddirectory/2017-01-11/object", x-amz-data-partition=, SchemaFacets=, <keyword arguments>)

CreateObject Operation

Creates an object in a Directory. Additionally attaches the object to a parent, if a parent reference and LinkName is specified. An object is simply a collection of Facet attributes. You can also use this API call to create a policy object, if the facet from which you create the object is a policy facet.

Arguments

x-amz-data-partition = ::String – Required

The Amazon Resource Name (ARN) that is associated with the Directory in which the object will be created. For more information, see arns.

SchemaFacets = [[ ... ], ...] – Required

A list of schema facets to be associated with the object that contains SchemaArn and facet name. For more information, see arns.

 SchemaFacets = [[
        "SchemaArn" =>  ::String,
        "FacetName" =>  ::String
    ], ...]

ObjectAttributeList = [[ ... ], ...]

The attribute map whose attribute ARN contains the key and attribute value as the map value.

 ObjectAttributeList = [[
        "Key" => <required> [
            "SchemaArn" => <required> ::String,
            "FacetName" => <required> ::String,
            "Name" => <required> ::String
        ],
        "Value" => <required> [
            "StringValue" =>  ::String,
            "BinaryValue" =>  blob,
            "BooleanValue" =>  ::Bool,
            "NumberValue" =>  ::String,
            "DatetimeValue" =>  timestamp
        ]
    ], ...]

ParentReference = ["Selector" => ::String]

If specified, the parent reference to which this object will be attached.

LinkName = ::String

The name of link that is used to attach this object to a parent.

Returns

CreateObjectResponse

Exceptions

InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryNotEnabledException, InvalidArnException, ResourceNotFoundException, FacetValidationException, LinkNameAlreadyInUseException or UnsupportedIndexTypeException.

See also: AWS API Documentation

AWSSDK.CloudDirectory.create_schema — Function.

using AWSSDK.CloudDirectory.create_schema
create_schema([::AWSConfig], arguments::Dict)
create_schema([::AWSConfig]; Name=)

using AWSCore.Services.clouddirectory
clouddirectory([::AWSConfig], "PUT", "/amazonclouddirectory/2017-01-11/schema/create", arguments::Dict)
clouddirectory([::AWSConfig], "PUT", "/amazonclouddirectory/2017-01-11/schema/create", Name=)

CreateSchema Operation

Creates a new schema in a development state. A schema can exist in three phases:

Development: This is a mutable phase of the schema. All new schemas are in the development phase. Once the schema is finalized, it can be published.
Published: Published schemas are immutable and have a version associated with them.
Applied: Applied schemas are mutable in a way that allows you to add new schema facets. You can also add new, nonrequired attributes to existing schema facets. You can apply only published schemas to directories.

Arguments

Name = ::String – Required

The name that is associated with the schema. This is unique to each account and in each region.

Returns

CreateSchemaResponse

Exceptions

See also: AWS API Documentation

AWSSDK.CloudDirectory.create_typed_link_facet — Function.

using AWSSDK.CloudDirectory.create_typed_link_facet
create_typed_link_facet([::AWSConfig], arguments::Dict)
create_typed_link_facet([::AWSConfig]; x-amz-data-partition=, Facet=)

using AWSCore.Services.clouddirectory
clouddirectory([::AWSConfig], "PUT", "/amazonclouddirectory/2017-01-11/typedlink/facet/create", arguments::Dict)
clouddirectory([::AWSConfig], "PUT", "/amazonclouddirectory/2017-01-11/typedlink/facet/create", x-amz-data-partition=, Facet=)

CreateTypedLinkFacet Operation

Creates a TypedLinkFacet. For more information, see Typed link.

Arguments

x-amz-data-partition = ::String – Required

The Amazon Resource Name (ARN) that is associated with the schema. For more information, see arns.

Facet = [ ... ] – Required

Facet structure that is associated with the typed link facet.

 Facet = [
        "Name" => <required> ::String,
        "Attributes" => <required> [[
            "Name" => <required> ::String,
            "Type" => <required> "STRING", "BINARY", "BOOLEAN", "NUMBER" or "DATETIME",
            "DefaultValue" =>  [
                "StringValue" =>  ::String,
                "BinaryValue" =>  blob,
                "BooleanValue" =>  ::Bool,
                "NumberValue" =>  ::String,
                "DatetimeValue" =>  timestamp
            ],
            "IsImmutable" =>  ::Bool,
            "Rules" =>  ::Dict{String,String},
            "RequiredBehavior" => <required> "REQUIRED_ALWAYS" or "NOT_REQUIRED"
        ], ...],
        "IdentityAttributeOrder" => <required> [::String, ...]
    ]

Returns

CreateTypedLinkFacetResponse

Exceptions

InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, ResourceNotFoundException, FacetAlreadyExistsException, InvalidRuleException or FacetValidationException.

See also: AWS API Documentation

AWSSDK.CloudDirectory.delete_directory — Function.

using AWSSDK.CloudDirectory.delete_directory
delete_directory([::AWSConfig], arguments::Dict)
delete_directory([::AWSConfig]; x-amz-data-partition=)

using AWSCore.Services.clouddirectory
clouddirectory([::AWSConfig], "PUT", "/amazonclouddirectory/2017-01-11/directory", arguments::Dict)
clouddirectory([::AWSConfig], "PUT", "/amazonclouddirectory/2017-01-11/directory", x-amz-data-partition=)

DeleteDirectory Operation

Deletes a directory. Only disabled directories can be deleted. A deleted directory cannot be undone. Exercise extreme caution when deleting directories.

Arguments

x-amz-data-partition = ::String – Required

The ARN of the directory to delete.

Returns

DeleteDirectoryResponse

Exceptions

ResourceNotFoundException, DirectoryNotDisabledException, InternalServiceException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryDeletedException, RetryableConflictException or InvalidArnException.

See also: AWS API Documentation

AWSSDK.CloudDirectory.delete_facet — Function.

using AWSSDK.CloudDirectory.delete_facet
delete_facet([::AWSConfig], arguments::Dict)
delete_facet([::AWSConfig]; x-amz-data-partition=, Name=)

using AWSCore.Services.clouddirectory
clouddirectory([::AWSConfig], "PUT", "/amazonclouddirectory/2017-01-11/facet/delete", arguments::Dict)
clouddirectory([::AWSConfig], "PUT", "/amazonclouddirectory/2017-01-11/facet/delete", x-amz-data-partition=, Name=)

DeleteFacet Operation

Deletes a given Facet. All attributes and Rules that are associated with the facet will be deleted. Only development schema facets are allowed deletion.

Arguments

x-amz-data-partition = ::String – Required

The Amazon Resource Name (ARN) that is associated with the Facet. For more information, see arns.

Name = ::String – Required

The name of the facet to delete.

Returns

DeleteFacetResponse

Exceptions

InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, ResourceNotFoundException, FacetNotFoundException or FacetInUseException.

See also: AWS API Documentation

AWSSDK.CloudDirectory.delete_object — Function.

using AWSSDK.CloudDirectory.delete_object
delete_object([::AWSConfig], arguments::Dict)
delete_object([::AWSConfig]; x-amz-data-partition=, ObjectReference=)

using AWSCore.Services.clouddirectory
clouddirectory([::AWSConfig], "PUT", "/amazonclouddirectory/2017-01-11/object/delete", arguments::Dict)
clouddirectory([::AWSConfig], "PUT", "/amazonclouddirectory/2017-01-11/object/delete", x-amz-data-partition=, ObjectReference=)

DeleteObject Operation

Deletes an object and its associated attributes. Only objects with no children and no parents can be deleted.

Arguments

x-amz-data-partition = ::String – Required

The Amazon Resource Name (ARN) that is associated with the Directory where the object resides. For more information, see arns.

ObjectReference = ["Selector" => ::String] – Required

A reference that identifies the object.

Returns

DeleteObjectResponse

Exceptions

See also: AWS API Documentation

AWSSDK.CloudDirectory.delete_schema — Function.

using AWSSDK.CloudDirectory.delete_schema
delete_schema([::AWSConfig], arguments::Dict)
delete_schema([::AWSConfig]; x-amz-data-partition=)

using AWSCore.Services.clouddirectory
clouddirectory([::AWSConfig], "PUT", "/amazonclouddirectory/2017-01-11/schema", arguments::Dict)
clouddirectory([::AWSConfig], "PUT", "/amazonclouddirectory/2017-01-11/schema", x-amz-data-partition=)

DeleteSchema Operation

Deletes a given schema. Schemas in a development and published state can only be deleted.

Arguments

x-amz-data-partition = ::String – Required

The Amazon Resource Name (ARN) of the development schema. For more information, see arns.

Returns

DeleteSchemaResponse

Exceptions

See also: AWS API Documentation

AWSSDK.CloudDirectory.delete_typed_link_facet — Function.

using AWSSDK.CloudDirectory.delete_typed_link_facet
delete_typed_link_facet([::AWSConfig], arguments::Dict)
delete_typed_link_facet([::AWSConfig]; x-amz-data-partition=, Name=)

using AWSCore.Services.clouddirectory
clouddirectory([::AWSConfig], "PUT", "/amazonclouddirectory/2017-01-11/typedlink/facet/delete", arguments::Dict)
clouddirectory([::AWSConfig], "PUT", "/amazonclouddirectory/2017-01-11/typedlink/facet/delete", x-amz-data-partition=, Name=)

DeleteTypedLinkFacet Operation

Deletes a TypedLinkFacet. For more information, see Typed link.

Arguments

x-amz-data-partition = ::String – Required

The Amazon Resource Name (ARN) that is associated with the schema. For more information, see arns.

Name = ::String – Required

The unique name of the typed link facet.

Returns

DeleteTypedLinkFacetResponse

Exceptions

See also: AWS API Documentation

AWSSDK.CloudDirectory.detach_from_index — Function.

using AWSSDK.CloudDirectory.detach_from_index
detach_from_index([::AWSConfig], arguments::Dict)
detach_from_index([::AWSConfig]; x-amz-data-partition=, IndexReference=, TargetReference=)

using AWSCore.Services.clouddirectory
clouddirectory([::AWSConfig], "PUT", "/amazonclouddirectory/2017-01-11/index/detach", arguments::Dict)
clouddirectory([::AWSConfig], "PUT", "/amazonclouddirectory/2017-01-11/index/detach", x-amz-data-partition=, IndexReference=, TargetReference=)

DetachFromIndex Operation

Detaches the specified object from the specified index.

Arguments

x-amz-data-partition = ::String – Required

The Amazon Resource Name (ARN) of the directory the index and object exist in.

IndexReference = ["Selector" => ::String] – Required

A reference to the index object.

TargetReference = ["Selector" => ::String] – Required

A reference to the object being detached from the index.

Returns

DetachFromIndexResponse

Exceptions

See also: AWS API Documentation

AWSSDK.CloudDirectory.detach_object — Function.

using AWSSDK.CloudDirectory.detach_object
detach_object([::AWSConfig], arguments::Dict)
detach_object([::AWSConfig]; x-amz-data-partition=, ParentReference=, LinkName=)

using AWSCore.Services.clouddirectory
clouddirectory([::AWSConfig], "PUT", "/amazonclouddirectory/2017-01-11/object/detach", arguments::Dict)
clouddirectory([::AWSConfig], "PUT", "/amazonclouddirectory/2017-01-11/object/detach", x-amz-data-partition=, ParentReference=, LinkName=)

DetachObject Operation

Detaches a given object from the parent object. The object that is to be detached from the parent is specified by the link name.

Arguments

x-amz-data-partition = ::String – Required

The Amazon Resource Name (ARN) that is associated with the Directory where objects reside. For more information, see arns.

ParentReference = ["Selector" => ::String] – Required

The parent reference from which the object with the specified link name is detached.

LinkName = ::String – Required

The link name associated with the object that needs to be detached.

Returns

DetachObjectResponse

Exceptions

See also: AWS API Documentation

AWSSDK.CloudDirectory.detach_policy — Function.

using AWSSDK.CloudDirectory.detach_policy
detach_policy([::AWSConfig], arguments::Dict)
detach_policy([::AWSConfig]; x-amz-data-partition=, PolicyReference=, ObjectReference=)

using AWSCore.Services.clouddirectory
clouddirectory([::AWSConfig], "PUT", "/amazonclouddirectory/2017-01-11/policy/detach", arguments::Dict)
clouddirectory([::AWSConfig], "PUT", "/amazonclouddirectory/2017-01-11/policy/detach", x-amz-data-partition=, PolicyReference=, ObjectReference=)

DetachPolicy Operation

Detaches a policy from an object.

Arguments

x-amz-data-partition = ::String – Required

The Amazon Resource Name (ARN) that is associated with the Directory where both objects reside. For more information, see arns.

PolicyReference = ["Selector" => ::String] – Required

Reference that identifies the policy object.

ObjectReference = ["Selector" => ::String] – Required

Reference that identifies the object whose policy object will be detached.

Returns

DetachPolicyResponse

Exceptions

InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryNotEnabledException, InvalidArnException, ResourceNotFoundException or NotPolicyException.

See also: AWS API Documentation

AWSSDK.CloudDirectory.detach_typed_link — Function.

using AWSSDK.CloudDirectory.detach_typed_link
detach_typed_link([::AWSConfig], arguments::Dict)
detach_typed_link([::AWSConfig]; x-amz-data-partition=, TypedLinkSpecifier=)

using AWSCore.Services.clouddirectory
clouddirectory([::AWSConfig], "PUT", "/amazonclouddirectory/2017-01-11/typedlink/detach", arguments::Dict)
clouddirectory([::AWSConfig], "PUT", "/amazonclouddirectory/2017-01-11/typedlink/detach", x-amz-data-partition=, TypedLinkSpecifier=)

DetachTypedLink Operation

Detaches a typed link from a specified source and target object. For more information, see Typed link.

Arguments

x-amz-data-partition = ::String – Required

The Amazon Resource Name (ARN) of the directory where you want to detach the typed link.

TypedLinkSpecifier = [ ... ] – Required

Used to accept a typed link specifier as input.

 TypedLinkSpecifier = [
        "TypedLinkFacet" => <required> [
            "SchemaArn" => <required> ::String,
            "TypedLinkName" => <required> ::String
        ],
        "SourceObjectReference" => <required> ["Selector" =>  ::String],
        "TargetObjectReference" => <required> ["Selector" =>  ::String],
        "IdentityAttributeValues" => <required> [[
            "AttributeName" => <required> ::String,
            "Value" => <required> [
                "StringValue" =>  ::String,
                "BinaryValue" =>  blob,
                "BooleanValue" =>  ::Bool,
                "NumberValue" =>  ::String,
                "DatetimeValue" =>  timestamp
            ]
        ], ...]
    ]

Exceptions

See also: AWS API Documentation

AWSSDK.CloudDirectory.disable_directory — Function.

using AWSSDK.CloudDirectory.disable_directory
disable_directory([::AWSConfig], arguments::Dict)
disable_directory([::AWSConfig]; x-amz-data-partition=)

using AWSCore.Services.clouddirectory
clouddirectory([::AWSConfig], "PUT", "/amazonclouddirectory/2017-01-11/directory/disable", arguments::Dict)
clouddirectory([::AWSConfig], "PUT", "/amazonclouddirectory/2017-01-11/directory/disable", x-amz-data-partition=)

DisableDirectory Operation

Disables the specified directory. Disabled directories cannot be read or written to. Only enabled directories can be disabled. Disabled directories may be reenabled.

Arguments

x-amz-data-partition = ::String – Required

The ARN of the directory to disable.

Returns

DisableDirectoryResponse

Exceptions

ResourceNotFoundException, DirectoryDeletedException, InternalServiceException, ValidationException, LimitExceededException, AccessDeniedException, RetryableConflictException or InvalidArnException.

See also: AWS API Documentation

AWSSDK.CloudDirectory.enable_directory — Function.

using AWSSDK.CloudDirectory.enable_directory
enable_directory([::AWSConfig], arguments::Dict)
enable_directory([::AWSConfig]; x-amz-data-partition=)

using AWSCore.Services.clouddirectory
clouddirectory([::AWSConfig], "PUT", "/amazonclouddirectory/2017-01-11/directory/enable", arguments::Dict)
clouddirectory([::AWSConfig], "PUT", "/amazonclouddirectory/2017-01-11/directory/enable", x-amz-data-partition=)

EnableDirectory Operation

Enables the specified directory. Only disabled directories can be enabled. Once enabled, the directory can then be read and written to.

Arguments

x-amz-data-partition = ::String – Required

The ARN of the directory to enable.

Returns

EnableDirectoryResponse

Exceptions

See also: AWS API Documentation

AWSSDK.CloudDirectory.get_directory — Function.

using AWSSDK.CloudDirectory.get_directory
get_directory([::AWSConfig], arguments::Dict)
get_directory([::AWSConfig]; x-amz-data-partition=)

using AWSCore.Services.clouddirectory
clouddirectory([::AWSConfig], "POST", "/amazonclouddirectory/2017-01-11/directory/get", arguments::Dict)
clouddirectory([::AWSConfig], "POST", "/amazonclouddirectory/2017-01-11/directory/get", x-amz-data-partition=)

GetDirectory Operation

Retrieves metadata about a directory.

Arguments

x-amz-data-partition = ::String – Required

The ARN of the directory.

Returns

GetDirectoryResponse

Exceptions

InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException or AccessDeniedException.

See also: AWS API Documentation

AWSSDK.CloudDirectory.get_facet — Function.

using AWSSDK.CloudDirectory.get_facet
get_facet([::AWSConfig], arguments::Dict)
get_facet([::AWSConfig]; x-amz-data-partition=, Name=)

using AWSCore.Services.clouddirectory
clouddirectory([::AWSConfig], "POST", "/amazonclouddirectory/2017-01-11/facet", arguments::Dict)
clouddirectory([::AWSConfig], "POST", "/amazonclouddirectory/2017-01-11/facet", x-amz-data-partition=, Name=)

GetFacet Operation

Gets details of the Facet, such as facet name, attributes, Rules, or ObjectType. You can call this on all kinds of schema facets – published, development, or applied.

Arguments

x-amz-data-partition = ::String – Required

The Amazon Resource Name (ARN) that is associated with the Facet. For more information, see arns.

Name = ::String – Required

The name of the facet to retrieve.

Returns

GetFacetResponse

Exceptions

See also: AWS API Documentation

AWSSDK.CloudDirectory.get_object_information — Function.

using AWSSDK.CloudDirectory.get_object_information
get_object_information([::AWSConfig], arguments::Dict)
get_object_information([::AWSConfig]; x-amz-data-partition=, ObjectReference=, <keyword arguments>)

using AWSCore.Services.clouddirectory
clouddirectory([::AWSConfig], "POST", "/amazonclouddirectory/2017-01-11/object/information", arguments::Dict)
clouddirectory([::AWSConfig], "POST", "/amazonclouddirectory/2017-01-11/object/information", x-amz-data-partition=, ObjectReference=, <keyword arguments>)

GetObjectInformation Operation

Retrieves metadata about an object.

Arguments

x-amz-data-partition = ::String – Required

The ARN of the directory being retrieved.

ObjectReference = ["Selector" => ::String] – Required

A reference to the object.

x-amz-consistency-level = "SERIALIZABLE" or "EVENTUAL"

The consistency level at which to retrieve the object information.

Returns

GetObjectInformationResponse

Exceptions

See also: AWS API Documentation

AWSSDK.CloudDirectory.get_schema_as_json — Function.

using AWSSDK.CloudDirectory.get_schema_as_json
get_schema_as_json([::AWSConfig], arguments::Dict)
get_schema_as_json([::AWSConfig]; x-amz-data-partition=)

using AWSCore.Services.clouddirectory
clouddirectory([::AWSConfig], "POST", "/amazonclouddirectory/2017-01-11/schema/json", arguments::Dict)
clouddirectory([::AWSConfig], "POST", "/amazonclouddirectory/2017-01-11/schema/json", x-amz-data-partition=)

GetSchemaAsJson Operation

Retrieves a JSON representation of the schema. See JSON Schema Format for more information.

Arguments

x-amz-data-partition = ::String – Required

The ARN of the schema to retrieve.

Returns

GetSchemaAsJsonResponse

Exceptions

See also: AWS API Documentation

AWSSDK.CloudDirectory.get_typed_link_facet_information — Function.

using AWSSDK.CloudDirectory.get_typed_link_facet_information
get_typed_link_facet_information([::AWSConfig], arguments::Dict)
get_typed_link_facet_information([::AWSConfig]; x-amz-data-partition=, Name=)

using AWSCore.Services.clouddirectory
clouddirectory([::AWSConfig], "POST", "/amazonclouddirectory/2017-01-11/typedlink/facet/get", arguments::Dict)
clouddirectory([::AWSConfig], "POST", "/amazonclouddirectory/2017-01-11/typedlink/facet/get", x-amz-data-partition=, Name=)

GetTypedLinkFacetInformation Operation

Returns the identity attribute order for a specific TypedLinkFacet. For more information, see Typed link.

Arguments

x-amz-data-partition = ::String – Required

The Amazon Resource Name (ARN) that is associated with the schema. For more information, see arns.

Name = ::String – Required

The unique name of the typed link facet.

Returns

GetTypedLinkFacetInformationResponse

Exceptions

InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, ResourceNotFoundException, InvalidNextTokenException or FacetNotFoundException.

See also: AWS API Documentation

AWSSDK.CloudDirectory.list_applied_schema_arns — Function.

using AWSSDK.CloudDirectory.list_applied_schema_arns
list_applied_schema_arns([::AWSConfig], arguments::Dict)
list_applied_schema_arns([::AWSConfig]; DirectoryArn=, <keyword arguments>)

using AWSCore.Services.clouddirectory
clouddirectory([::AWSConfig], "POST", "/amazonclouddirectory/2017-01-11/schema/applied", arguments::Dict)
clouddirectory([::AWSConfig], "POST", "/amazonclouddirectory/2017-01-11/schema/applied", DirectoryArn=, <keyword arguments>)

ListAppliedSchemaArns Operation

Lists schemas applied to a directory.

Arguments

DirectoryArn = ::String – Required

The ARN of the directory you are listing.

NextToken = ::String

The pagination token.

MaxResults = ::Int

The maximum number of results to retrieve.

Returns

ListAppliedSchemaArnsResponse

Exceptions

See also: AWS API Documentation

AWSSDK.CloudDirectory.list_attached_indices — Function.

using AWSSDK.CloudDirectory.list_attached_indices
list_attached_indices([::AWSConfig], arguments::Dict)
list_attached_indices([::AWSConfig]; x-amz-data-partition=, TargetReference=, <keyword arguments>)

using AWSCore.Services.clouddirectory
clouddirectory([::AWSConfig], "POST", "/amazonclouddirectory/2017-01-11/object/indices", arguments::Dict)
clouddirectory([::AWSConfig], "POST", "/amazonclouddirectory/2017-01-11/object/indices", x-amz-data-partition=, TargetReference=, <keyword arguments>)

ListAttachedIndices Operation

Lists indices attached to an object.

Arguments

x-amz-data-partition = ::String – Required

The ARN of the directory.

TargetReference = ["Selector" => ::String] – Required

A reference to the object that has indices attached.

NextToken = ::String

The pagination token.

MaxResults = ::Int

The maximum number of results to retrieve.

x-amz-consistency-level = "SERIALIZABLE" or "EVENTUAL"

The consistency level to use for this operation.

Returns

ListAttachedIndicesResponse

Exceptions

See also: AWS API Documentation

AWSSDK.CloudDirectory.list_development_schema_arns — Function.

using AWSSDK.CloudDirectory.list_development_schema_arns
list_development_schema_arns([::AWSConfig], arguments::Dict)
list_development_schema_arns([::AWSConfig]; <keyword arguments>)

using AWSCore.Services.clouddirectory
clouddirectory([::AWSConfig], "POST", "/amazonclouddirectory/2017-01-11/schema/development", arguments::Dict)
clouddirectory([::AWSConfig], "POST", "/amazonclouddirectory/2017-01-11/schema/development", <keyword arguments>)

ListDevelopmentSchemaArns Operation

Retrieves each Amazon Resource Name (ARN) of schemas in the development state.

Arguments

NextToken = ::String

The pagination token.

MaxResults = ::Int

The maximum number of results to retrieve.

Returns

ListDevelopmentSchemaArnsResponse

Exceptions

See also: AWS API Documentation

AWSSDK.CloudDirectory.list_directories — Function.

using AWSSDK.CloudDirectory.list_directories
list_directories([::AWSConfig], arguments::Dict)
list_directories([::AWSConfig]; <keyword arguments>)

using AWSCore.Services.clouddirectory
clouddirectory([::AWSConfig], "POST", "/amazonclouddirectory/2017-01-11/directory/list", arguments::Dict)
clouddirectory([::AWSConfig], "POST", "/amazonclouddirectory/2017-01-11/directory/list", <keyword arguments>)

ListDirectories Operation

Lists directories created within an account.

Arguments

NextToken = ::String

The pagination token.

MaxResults = ::Int

The maximum number of results to retrieve.

state = "ENABLED", "DISABLED" or "DELETED"

The state of the directories in the list. Can be either Enabled, Disabled, or Deleted.

Returns

ListDirectoriesResponse

Exceptions

InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException or InvalidNextTokenException.

See also: AWS API Documentation

AWSSDK.CloudDirectory.list_facet_attributes — Function.

using AWSSDK.CloudDirectory.list_facet_attributes
list_facet_attributes([::AWSConfig], arguments::Dict)
list_facet_attributes([::AWSConfig]; x-amz-data-partition=, Name=, <keyword arguments>)

using AWSCore.Services.clouddirectory
clouddirectory([::AWSConfig], "POST", "/amazonclouddirectory/2017-01-11/facet/attributes", arguments::Dict)
clouddirectory([::AWSConfig], "POST", "/amazonclouddirectory/2017-01-11/facet/attributes", x-amz-data-partition=, Name=, <keyword arguments>)

ListFacetAttributes Operation

Retrieves attributes attached to the facet.

Arguments

x-amz-data-partition = ::String – Required

The ARN of the schema where the facet resides.

Name = ::String – Required

The name of the facet whose attributes will be retrieved.

NextToken = ::String

The pagination token.

MaxResults = ::Int

The maximum number of results to retrieve.

Returns

ListFacetAttributesResponse

Exceptions

InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, ResourceNotFoundException, FacetNotFoundException or InvalidNextTokenException.

See also: AWS API Documentation

AWSSDK.CloudDirectory.list_facet_names — Function.

using AWSSDK.CloudDirectory.list_facet_names
list_facet_names([::AWSConfig], arguments::Dict)
list_facet_names([::AWSConfig]; x-amz-data-partition=, <keyword arguments>)

using AWSCore.Services.clouddirectory
clouddirectory([::AWSConfig], "POST", "/amazonclouddirectory/2017-01-11/facet/list", arguments::Dict)
clouddirectory([::AWSConfig], "POST", "/amazonclouddirectory/2017-01-11/facet/list", x-amz-data-partition=, <keyword arguments>)

ListFacetNames Operation

Retrieves the names of facets that exist in a schema.

Arguments

x-amz-data-partition = ::String – Required

The Amazon Resource Name (ARN) to retrieve facet names from.

NextToken = ::String

The pagination token.

MaxResults = ::Int

The maximum number of results to retrieve.

Returns

ListFacetNamesResponse

Exceptions

See also: AWS API Documentation

AWSSDK.CloudDirectory.list_incoming_typed_links — Function.

using AWSSDK.CloudDirectory.list_incoming_typed_links
list_incoming_typed_links([::AWSConfig], arguments::Dict)
list_incoming_typed_links([::AWSConfig]; x-amz-data-partition=, ObjectReference=, <keyword arguments>)

using AWSCore.Services.clouddirectory
clouddirectory([::AWSConfig], "POST", "/amazonclouddirectory/2017-01-11/typedlink/incoming", arguments::Dict)
clouddirectory([::AWSConfig], "POST", "/amazonclouddirectory/2017-01-11/typedlink/incoming", x-amz-data-partition=, ObjectReference=, <keyword arguments>)

ListIncomingTypedLinks Operation

Returns a paginated list of all the incoming TypedLinkSpecifier information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see Typed link.

Arguments

x-amz-data-partition = ::String – Required

The Amazon Resource Name (ARN) of the directory where you want to list the typed links.

ObjectReference = ["Selector" => ::String] – Required

Reference that identifies the object whose attributes will be listed.

FilterAttributeRanges = [[ ... ], ...]

Provides range filters for multiple attributes. When providing ranges to typed link selection, any inexact ranges must be specified at the end. Any attributes that do not have a range specified are presumed to match the entire range.

 FilterAttributeRanges = [[
        "AttributeName" =>  ::String,
        "Range" => <required> [
            "StartMode" => <required> "FIRST", "LAST", "LAST_BEFORE_MISSING_VALUES", "INCLUSIVE" or "EXCLUSIVE",
            "StartValue" =>  [
                "StringValue" =>  ::String,
                "BinaryValue" =>  blob,
                "BooleanValue" =>  ::Bool,
                "NumberValue" =>  ::String,
                "DatetimeValue" =>  timestamp
            ],
            "EndMode" => <required> "FIRST", "LAST", "LAST_BEFORE_MISSING_VALUES", "INCLUSIVE" or "EXCLUSIVE",
            "EndValue" =>  [
                "StringValue" =>  ::String,
                "BinaryValue" =>  blob,
                "BooleanValue" =>  ::Bool,
                "NumberValue" =>  ::String,
                "DatetimeValue" =>  timestamp
            ]
        ]
    ], ...]

FilterTypedLink = [ ... ]

Filters are interpreted in the order of the attributes on the typed link facet, not the order in which they are supplied to any API calls.

 FilterTypedLink = [
        "SchemaArn" => <required> ::String,
        "TypedLinkName" => <required> ::String
    ]

NextToken = ::String

The pagination token.

MaxResults = ::Int

The maximum number of results to retrieve.

ConsistencyLevel = "SERIALIZABLE" or "EVENTUAL"

The consistency level to execute the request at.

Returns

ListIncomingTypedLinksResponse

Exceptions

See also: AWS API Documentation

AWSSDK.CloudDirectory.list_index — Function.

using AWSSDK.CloudDirectory.list_index
list_index([::AWSConfig], arguments::Dict)
list_index([::AWSConfig]; x-amz-data-partition=, IndexReference=, <keyword arguments>)

using AWSCore.Services.clouddirectory
clouddirectory([::AWSConfig], "POST", "/amazonclouddirectory/2017-01-11/index/targets", arguments::Dict)
clouddirectory([::AWSConfig], "POST", "/amazonclouddirectory/2017-01-11/index/targets", x-amz-data-partition=, IndexReference=, <keyword arguments>)

ListIndex Operation

Lists objects attached to the specified index.

Arguments

x-amz-data-partition = ::String – Required

The ARN of the directory that the index exists in.

RangesOnIndexedValues = [[ ... ], ...]

Specifies the ranges of indexed values that you want to query.

 RangesOnIndexedValues = [[
        "AttributeKey" =>  [
            "SchemaArn" => <required> ::String,
            "FacetName" => <required> ::String,
            "Name" => <required> ::String
        ],
        "Range" =>  [
            "StartMode" => <required> "FIRST", "LAST", "LAST_BEFORE_MISSING_VALUES", "INCLUSIVE" or "EXCLUSIVE",
            "StartValue" =>  [
                "StringValue" =>  ::String,
                "BinaryValue" =>  blob,
                "BooleanValue" =>  ::Bool,
                "NumberValue" =>  ::String,
                "DatetimeValue" =>  timestamp
            ],
            "EndMode" => <required> "FIRST", "LAST", "LAST_BEFORE_MISSING_VALUES", "INCLUSIVE" or "EXCLUSIVE",
            "EndValue" =>  [
                "StringValue" =>  ::String,
                "BinaryValue" =>  blob,
                "BooleanValue" =>  ::Bool,
                "NumberValue" =>  ::String,
                "DatetimeValue" =>  timestamp
            ]
        ]
    ], ...]

IndexReference = ["Selector" => ::String] – Required

The reference to the index to list.

MaxResults = ::Int

The maximum number of results to retrieve from the index.

NextToken = ::String

The pagination token.

x-amz-consistency-level = "SERIALIZABLE" or "EVENTUAL"

The consistency level to execute the request at.

Returns

ListIndexResponse

Exceptions

See also: AWS API Documentation

AWSSDK.CloudDirectory.list_object_attributes — Function.

using AWSSDK.CloudDirectory.list_object_attributes
list_object_attributes([::AWSConfig], arguments::Dict)
list_object_attributes([::AWSConfig]; x-amz-data-partition=, ObjectReference=, <keyword arguments>)

using AWSCore.Services.clouddirectory
clouddirectory([::AWSConfig], "POST", "/amazonclouddirectory/2017-01-11/object/attributes", arguments::Dict)
clouddirectory([::AWSConfig], "POST", "/amazonclouddirectory/2017-01-11/object/attributes", x-amz-data-partition=, ObjectReference=, <keyword arguments>)

ListObjectAttributes Operation

Lists all attributes that are associated with an object.

Arguments

x-amz-data-partition = ::String – Required

The Amazon Resource Name (ARN) that is associated with the Directory where the object resides. For more information, see arns.

ObjectReference = ["Selector" => ::String] – Required

The reference that identifies the object whose attributes will be listed.

NextToken = ::String

The pagination token.

MaxResults = ::Int

The maximum number of items to be retrieved in a single call. This is an approximate number.

x-amz-consistency-level = "SERIALIZABLE" or "EVENTUAL"

Represents the manner and timing in which the successful write or update of an object is reflected in a subsequent read operation of that same object.

FacetFilter = [ ... ]

Used to filter the list of object attributes that are associated with a certain facet.

 FacetFilter = [
        "SchemaArn" =>  ::String,
        "FacetName" =>  ::String
    ]

Returns

ListObjectAttributesResponse

Exceptions

InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryNotEnabledException, InvalidArnException, ResourceNotFoundException, InvalidNextTokenException or FacetValidationException.

See also: AWS API Documentation

AWSSDK.CloudDirectory.list_object_children — Function.

using AWSSDK.CloudDirectory.list_object_children
list_object_children([::AWSConfig], arguments::Dict)
list_object_children([::AWSConfig]; x-amz-data-partition=, ObjectReference=, <keyword arguments>)

using AWSCore.Services.clouddirectory
clouddirectory([::AWSConfig], "POST", "/amazonclouddirectory/2017-01-11/object/children", arguments::Dict)
clouddirectory([::AWSConfig], "POST", "/amazonclouddirectory/2017-01-11/object/children", x-amz-data-partition=, ObjectReference=, <keyword arguments>)

ListObjectChildren Operation

Returns a paginated list of child objects that are associated with a given object.

Arguments

x-amz-data-partition = ::String – Required

The Amazon Resource Name (ARN) that is associated with the Directory where the object resides. For more information, see arns.

ObjectReference = ["Selector" => ::String] – Required

The reference that identifies the object for which child objects are being listed.

NextToken = ::String

The pagination token.

MaxResults = ::Int

The maximum number of items to be retrieved in a single call. This is an approximate number.

x-amz-consistency-level = "SERIALIZABLE" or "EVENTUAL"

Represents the manner and timing in which the successful write or update of an object is reflected in a subsequent read operation of that same object.

Returns

ListObjectChildrenResponse

Exceptions

InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryNotEnabledException, InvalidArnException, ResourceNotFoundException, InvalidNextTokenException or NotNodeException.

See also: AWS API Documentation

AWSSDK.CloudDirectory.list_object_parent_paths — Function.

using AWSSDK.CloudDirectory.list_object_parent_paths
list_object_parent_paths([::AWSConfig], arguments::Dict)
list_object_parent_paths([::AWSConfig]; x-amz-data-partition=, ObjectReference=, <keyword arguments>)

using AWSCore.Services.clouddirectory
clouddirectory([::AWSConfig], "POST", "/amazonclouddirectory/2017-01-11/object/parentpaths", arguments::Dict)
clouddirectory([::AWSConfig], "POST", "/amazonclouddirectory/2017-01-11/object/parentpaths", x-amz-data-partition=, ObjectReference=, <keyword arguments>)

ListObjectParentPaths Operation

Retrieves all available parent paths for any object type such as node, leaf node, policy node, and index node objects. For more information about objects, see Directory Structure.

Use this API to evaluate all parents for an object. The call returns all objects from the root of the directory up to the requested object. The API returns the number of paths based on user-defined MaxResults, in case there are multiple paths to the parent. The order of the paths and nodes returned is consistent among multiple API calls unless the objects are deleted or moved. Paths not leading to the directory root are ignored from the target object.

Arguments

x-amz-data-partition = ::String – Required

The ARN of the directory to which the parent path applies.

ObjectReference = ["Selector" => ::String] – Required

The reference that identifies the object whose parent paths are listed.

NextToken = ::String

The pagination token.

MaxResults = ::Int

The maximum number of items to be retrieved in a single call. This is an approximate number.

Returns

ListObjectParentPathsResponse

Exceptions

InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryNotEnabledException, InvalidNextTokenException or ResourceNotFoundException.

See also: AWS API Documentation

AWSSDK.CloudDirectory.list_object_parents — Function.

using AWSSDK.CloudDirectory.list_object_parents
list_object_parents([::AWSConfig], arguments::Dict)
list_object_parents([::AWSConfig]; x-amz-data-partition=, ObjectReference=, <keyword arguments>)

using AWSCore.Services.clouddirectory
clouddirectory([::AWSConfig], "POST", "/amazonclouddirectory/2017-01-11/object/parent", arguments::Dict)
clouddirectory([::AWSConfig], "POST", "/amazonclouddirectory/2017-01-11/object/parent", x-amz-data-partition=, ObjectReference=, <keyword arguments>)

ListObjectParents Operation

Lists parent objects that are associated with a given object in pagination fashion.

Arguments

x-amz-data-partition = ::String – Required

The Amazon Resource Name (ARN) that is associated with the Directory where the object resides. For more information, see arns.

ObjectReference = ["Selector" => ::String] – Required

The reference that identifies the object for which parent objects are being listed.

NextToken = ::String

The pagination token.

MaxResults = ::Int

The maximum number of items to be retrieved in a single call. This is an approximate number.

x-amz-consistency-level = "SERIALIZABLE" or "EVENTUAL"

Represents the manner and timing in which the successful write or update of an object is reflected in a subsequent read operation of that same object.

Returns

ListObjectParentsResponse

Exceptions

InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryNotEnabledException, InvalidArnException, ResourceNotFoundException, InvalidNextTokenException or CannotListParentOfRootException.

See also: AWS API Documentation

AWSSDK.CloudDirectory.list_object_policies — Function.

using AWSSDK.CloudDirectory.list_object_policies
list_object_policies([::AWSConfig], arguments::Dict)
list_object_policies([::AWSConfig]; x-amz-data-partition=, ObjectReference=, <keyword arguments>)

using AWSCore.Services.clouddirectory
clouddirectory([::AWSConfig], "POST", "/amazonclouddirectory/2017-01-11/object/policy", arguments::Dict)
clouddirectory([::AWSConfig], "POST", "/amazonclouddirectory/2017-01-11/object/policy", x-amz-data-partition=, ObjectReference=, <keyword arguments>)

ListObjectPolicies Operation

Returns policies attached to an object in pagination fashion.

Arguments

x-amz-data-partition = ::String – Required

The Amazon Resource Name (ARN) that is associated with the Directory where objects reside. For more information, see arns.

ObjectReference = ["Selector" => ::String] – Required

Reference that identifies the object for which policies will be listed.

NextToken = ::String

The pagination token.

MaxResults = ::Int

The maximum number of items to be retrieved in a single call. This is an approximate number.

x-amz-consistency-level = "SERIALIZABLE" or "EVENTUAL"

Represents the manner and timing in which the successful write or update of an object is reflected in a subsequent read operation of that same object.

Returns

ListObjectPoliciesResponse

Exceptions

See also: AWS API Documentation

AWSSDK.CloudDirectory.list_outgoing_typed_links — Function.

using AWSSDK.CloudDirectory.list_outgoing_typed_links
list_outgoing_typed_links([::AWSConfig], arguments::Dict)
list_outgoing_typed_links([::AWSConfig]; x-amz-data-partition=, ObjectReference=, <keyword arguments>)

using AWSCore.Services.clouddirectory
clouddirectory([::AWSConfig], "POST", "/amazonclouddirectory/2017-01-11/typedlink/outgoing", arguments::Dict)
clouddirectory([::AWSConfig], "POST", "/amazonclouddirectory/2017-01-11/typedlink/outgoing", x-amz-data-partition=, ObjectReference=, <keyword arguments>)

ListOutgoingTypedLinks Operation

Returns a paginated list of all the outgoing TypedLinkSpecifier information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see Typed link.

Arguments

x-amz-data-partition = ::String – Required

The Amazon Resource Name (ARN) of the directory where you want to list the typed links.

ObjectReference = ["Selector" => ::String] – Required

A reference that identifies the object whose attributes will be listed.

FilterAttributeRanges = [[ ... ], ...]

 FilterAttributeRanges = [[
        "AttributeName" =>  ::String,
        "Range" => <required> [
            "StartMode" => <required> "FIRST", "LAST", "LAST_BEFORE_MISSING_VALUES", "INCLUSIVE" or "EXCLUSIVE",
            "StartValue" =>  [
                "StringValue" =>  ::String,
                "BinaryValue" =>  blob,
                "BooleanValue" =>  ::Bool,
                "NumberValue" =>  ::String,
                "DatetimeValue" =>  timestamp
            ],
            "EndMode" => <required> "FIRST", "LAST", "LAST_BEFORE_MISSING_VALUES", "INCLUSIVE" or "EXCLUSIVE",
            "EndValue" =>  [
                "StringValue" =>  ::String,
                "BinaryValue" =>  blob,
                "BooleanValue" =>  ::Bool,
                "NumberValue" =>  ::String,
                "DatetimeValue" =>  timestamp
            ]
        ]
    ], ...]

FilterTypedLink = [ ... ]

Filters are interpreted in the order of the attributes defined on the typed link facet, not the order they are supplied to any API calls.

 FilterTypedLink = [
        "SchemaArn" => <required> ::String,
        "TypedLinkName" => <required> ::String
    ]

NextToken = ::String

The pagination token.

MaxResults = ::Int

The maximum number of results to retrieve.

ConsistencyLevel = "SERIALIZABLE" or "EVENTUAL"

The consistency level to execute the request at.

Returns

ListOutgoingTypedLinksResponse

Exceptions

See also: AWS API Documentation

AWSSDK.CloudDirectory.list_policy_attachments — Function.

using AWSSDK.CloudDirectory.list_policy_attachments
list_policy_attachments([::AWSConfig], arguments::Dict)
list_policy_attachments([::AWSConfig]; x-amz-data-partition=, PolicyReference=, <keyword arguments>)

using AWSCore.Services.clouddirectory
clouddirectory([::AWSConfig], "POST", "/amazonclouddirectory/2017-01-11/policy/attachment", arguments::Dict)
clouddirectory([::AWSConfig], "POST", "/amazonclouddirectory/2017-01-11/policy/attachment", x-amz-data-partition=, PolicyReference=, <keyword arguments>)

ListPolicyAttachments Operation

Returns all of the ObjectIdentifiers to which a given policy is attached.

Arguments

x-amz-data-partition = ::String – Required

The Amazon Resource Name (ARN) that is associated with the Directory where objects reside. For more information, see arns.

PolicyReference = ["Selector" => ::String] – Required

The reference that identifies the policy object.

NextToken = ::String

The pagination token.

MaxResults = ::Int

The maximum number of items to be retrieved in a single call. This is an approximate number.

x-amz-consistency-level = "SERIALIZABLE" or "EVENTUAL"

Represents the manner and timing in which the successful write or update of an object is reflected in a subsequent read operation of that same object.

Returns

ListPolicyAttachmentsResponse

Exceptions

InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryNotEnabledException, InvalidArnException, InvalidNextTokenException, ResourceNotFoundException or NotPolicyException.

See also: AWS API Documentation

AWSSDK.CloudDirectory.list_published_schema_arns — Function.

using AWSSDK.CloudDirectory.list_published_schema_arns
list_published_schema_arns([::AWSConfig], arguments::Dict)
list_published_schema_arns([::AWSConfig]; <keyword arguments>)

using AWSCore.Services.clouddirectory
clouddirectory([::AWSConfig], "POST", "/amazonclouddirectory/2017-01-11/schema/published", arguments::Dict)
clouddirectory([::AWSConfig], "POST", "/amazonclouddirectory/2017-01-11/schema/published", <keyword arguments>)

ListPublishedSchemaArns Operation

Retrieves each published schema Amazon Resource Name (ARN).

Arguments

NextToken = ::String

The pagination token.

MaxResults = ::Int

The maximum number of results to retrieve.

Returns

ListPublishedSchemaArnsResponse

Exceptions

See also: AWS API Documentation

AWSSDK.CloudDirectory.list_tags_for_resource — Function.

using AWSSDK.CloudDirectory.list_tags_for_resource
list_tags_for_resource([::AWSConfig], arguments::Dict)
list_tags_for_resource([::AWSConfig]; ResourceArn=, <keyword arguments>)

using AWSCore.Services.clouddirectory
clouddirectory([::AWSConfig], "POST", "/amazonclouddirectory/2017-01-11/tags", arguments::Dict)
clouddirectory([::AWSConfig], "POST", "/amazonclouddirectory/2017-01-11/tags", ResourceArn=, <keyword arguments>)

ListTagsForResource Operation

Returns tags for a resource. Tagging is currently supported only for directories with a limit of 50 tags per directory. All 50 tags are returned for a given directory with this API call.

Arguments

ResourceArn = ::String – Required

The Amazon Resource Name (ARN) of the resource. Tagging is only supported for directories.

NextToken = ::String

The pagination token. This is for future use. Currently pagination is not supported for tagging.

MaxResults = ::Int

The MaxResults parameter sets the maximum number of results returned in a single page. This is for future use and is not supported currently.

Returns

ListTagsForResourceResponse

Exceptions

See also: AWS API Documentation

AWSSDK.CloudDirectory.list_typed_link_facet_attributes — Function.

using AWSSDK.CloudDirectory.list_typed_link_facet_attributes
list_typed_link_facet_attributes([::AWSConfig], arguments::Dict)
list_typed_link_facet_attributes([::AWSConfig]; x-amz-data-partition=, Name=, <keyword arguments>)

using AWSCore.Services.clouddirectory
clouddirectory([::AWSConfig], "POST", "/amazonclouddirectory/2017-01-11/typedlink/facet/attributes", arguments::Dict)
clouddirectory([::AWSConfig], "POST", "/amazonclouddirectory/2017-01-11/typedlink/facet/attributes", x-amz-data-partition=, Name=, <keyword arguments>)

ListTypedLinkFacetAttributes Operation

Returns a paginated list of all attribute definitions for a particular TypedLinkFacet. For more information, see Typed link.

Arguments

x-amz-data-partition = ::String – Required

The Amazon Resource Name (ARN) that is associated with the schema. For more information, see arns.

Name = ::String – Required

The unique name of the typed link facet.

NextToken = ::String

The pagination token.

MaxResults = ::Int

The maximum number of results to retrieve.

Returns

ListTypedLinkFacetAttributesResponse

Exceptions

InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, ResourceNotFoundException, FacetNotFoundException or InvalidNextTokenException.

See also: AWS API Documentation

AWSSDK.CloudDirectory.list_typed_link_facet_names — Function.

using AWSSDK.CloudDirectory.list_typed_link_facet_names
list_typed_link_facet_names([::AWSConfig], arguments::Dict)
list_typed_link_facet_names([::AWSConfig]; x-amz-data-partition=, <keyword arguments>)

using AWSCore.Services.clouddirectory
clouddirectory([::AWSConfig], "POST", "/amazonclouddirectory/2017-01-11/typedlink/facet/list", arguments::Dict)
clouddirectory([::AWSConfig], "POST", "/amazonclouddirectory/2017-01-11/typedlink/facet/list", x-amz-data-partition=, <keyword arguments>)

ListTypedLinkFacetNames Operation

Returns a paginated list of TypedLink facet names for a particular schema. For more information, see Typed link.

Arguments

x-amz-data-partition = ::String – Required

The Amazon Resource Name (ARN) that is associated with the schema. For more information, see arns.

NextToken = ::String

The pagination token.

MaxResults = ::Int

The maximum number of results to retrieve.

Returns

ListTypedLinkFacetNamesResponse

Exceptions

See also: AWS API Documentation

AWSSDK.CloudDirectory.lookup_policy — Function.

using AWSSDK.CloudDirectory.lookup_policy
lookup_policy([::AWSConfig], arguments::Dict)
lookup_policy([::AWSConfig]; x-amz-data-partition=, ObjectReference=, <keyword arguments>)

using AWSCore.Services.clouddirectory
clouddirectory([::AWSConfig], "POST", "/amazonclouddirectory/2017-01-11/policy/lookup", arguments::Dict)
clouddirectory([::AWSConfig], "POST", "/amazonclouddirectory/2017-01-11/policy/lookup", x-amz-data-partition=, ObjectReference=, <keyword arguments>)

LookupPolicy Operation

Lists all policies from the root of the Directory to the object specified. If there are no policies present, an empty list is returned. If policies are present, and if some objects don't have the policies attached, it returns the ObjectIdentifier for such objects. If policies are present, it returns ObjectIdentifier, policyId, and policyType. Paths that don't lead to the root from the target object are ignored. For more information, see Policies.

Arguments

x-amz-data-partition = ::String – Required

The Amazon Resource Name (ARN) that is associated with the Directory. For more information, see arns.

ObjectReference = ["Selector" => ::String] – Required

Reference that identifies the object whose policies will be looked up.

NextToken = ::String

The token to request the next page of results.

MaxResults = ::Int

The maximum number of items to be retrieved in a single call. This is an approximate number.

Returns

LookupPolicyResponse

Exceptions

InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryNotEnabledException, InvalidArnException, InvalidNextTokenException or ResourceNotFoundException.

See also: AWS API Documentation

AWSSDK.CloudDirectory.publish_schema — Function.

using AWSSDK.CloudDirectory.publish_schema
publish_schema([::AWSConfig], arguments::Dict)
publish_schema([::AWSConfig]; x-amz-data-partition=, Version=, <keyword arguments>)

using AWSCore.Services.clouddirectory
clouddirectory([::AWSConfig], "PUT", "/amazonclouddirectory/2017-01-11/schema/publish", arguments::Dict)
clouddirectory([::AWSConfig], "PUT", "/amazonclouddirectory/2017-01-11/schema/publish", x-amz-data-partition=, Version=, <keyword arguments>)

PublishSchema Operation

Publishes a development schema with a version. If description and attributes are specified, PublishSchema overrides the development schema description and attributes. If not, the development schema description and attributes are used.

Arguments

x-amz-data-partition = ::String – Required

The Amazon Resource Name (ARN) that is associated with the development schema. For more information, see arns.

Version = ::String – Required

The version under which the schema will be published.

Name = ::String

The new name under which the schema will be published. If this is not provided, the development schema is considered.

Returns

PublishSchemaResponse

Exceptions

See also: AWS API Documentation

AWSSDK.CloudDirectory.put_schema_from_json — Function.

using AWSSDK.CloudDirectory.put_schema_from_json
put_schema_from_json([::AWSConfig], arguments::Dict)
put_schema_from_json([::AWSConfig]; x-amz-data-partition=, Document=)

using AWSCore.Services.clouddirectory
clouddirectory([::AWSConfig], "PUT", "/amazonclouddirectory/2017-01-11/schema/json", arguments::Dict)
clouddirectory([::AWSConfig], "PUT", "/amazonclouddirectory/2017-01-11/schema/json", x-amz-data-partition=, Document=)

PutSchemaFromJson Operation

Allows a schema to be updated using JSON upload. Only available for development schemas. See JSON Schema Format for more information.

Arguments

x-amz-data-partition = ::String – Required

The ARN of the schema to update.

Document = ::String – Required

The replacement JSON schema.

Returns

PutSchemaFromJsonResponse

Exceptions

See also: AWS API Documentation

AWSSDK.CloudDirectory.remove_facet_from_object — Function.

using AWSSDK.CloudDirectory.remove_facet_from_object
remove_facet_from_object([::AWSConfig], arguments::Dict)
remove_facet_from_object([::AWSConfig]; x-amz-data-partition=, SchemaFacet=, ObjectReference=)

using AWSCore.Services.clouddirectory
clouddirectory([::AWSConfig], "PUT", "/amazonclouddirectory/2017-01-11/object/facets/delete", arguments::Dict)
clouddirectory([::AWSConfig], "PUT", "/amazonclouddirectory/2017-01-11/object/facets/delete", x-amz-data-partition=, SchemaFacet=, ObjectReference=)

RemoveFacetFromObject Operation

Removes the specified facet from the specified object.

Arguments

x-amz-data-partition = ::String – Required

The ARN of the directory in which the object resides.

SchemaFacet = [ ... ] – Required

The facet to remove.

 SchemaFacet = [
        "SchemaArn" =>  ::String,
        "FacetName" =>  ::String
    ]

ObjectReference = ["Selector" => ::String] – Required

A reference to the object to remove the facet from.

Returns

RemoveFacetFromObjectResponse

Exceptions

See also: AWS API Documentation

AWSSDK.CloudDirectory.tag_resource — Function.

using AWSSDK.CloudDirectory.tag_resource
tag_resource([::AWSConfig], arguments::Dict)
tag_resource([::AWSConfig]; ResourceArn=, Tags=)

using AWSCore.Services.clouddirectory
clouddirectory([::AWSConfig], "PUT", "/amazonclouddirectory/2017-01-11/tags/add", arguments::Dict)
clouddirectory([::AWSConfig], "PUT", "/amazonclouddirectory/2017-01-11/tags/add", ResourceArn=, Tags=)

TagResource Operation

An API operation for adding tags to a resource.

Arguments

ResourceArn = ::String – Required

The Amazon Resource Name (ARN) of the resource. Tagging is only supported for directories.

Tags = [[ ... ], ...] – Required

A list of tag key-value pairs.

 Tags = [[
        "Key" =>  ::String,
        "Value" =>  ::String
    ], ...]

Returns

TagResourceResponse

Exceptions

See also: AWS API Documentation

AWSSDK.CloudDirectory.untag_resource — Function.

using AWSSDK.CloudDirectory.untag_resource
untag_resource([::AWSConfig], arguments::Dict)
untag_resource([::AWSConfig]; ResourceArn=, TagKeys=)

using AWSCore.Services.clouddirectory
clouddirectory([::AWSConfig], "PUT", "/amazonclouddirectory/2017-01-11/tags/remove", arguments::Dict)
clouddirectory([::AWSConfig], "PUT", "/amazonclouddirectory/2017-01-11/tags/remove", ResourceArn=, TagKeys=)

UntagResource Operation

An API operation for removing tags from a resource.

Arguments

ResourceArn = ::String – Required

The Amazon Resource Name (ARN) of the resource. Tagging is only supported for directories.

TagKeys = [::String, ...] – Required

Keys of the tag that need to be removed from the resource.

Returns

UntagResourceResponse

Exceptions

See also: AWS API Documentation

AWSSDK.CloudDirectory.update_facet — Function.

using AWSSDK.CloudDirectory.update_facet
update_facet([::AWSConfig], arguments::Dict)
update_facet([::AWSConfig]; x-amz-data-partition=, Name=, <keyword arguments>)

using AWSCore.Services.clouddirectory
clouddirectory([::AWSConfig], "PUT", "/amazonclouddirectory/2017-01-11/facet", arguments::Dict)
clouddirectory([::AWSConfig], "PUT", "/amazonclouddirectory/2017-01-11/facet", x-amz-data-partition=, Name=, <keyword arguments>)

UpdateFacet Operation

Does the following:

Adds new Attributes, Rules, or ObjectTypes.
Updates existing Attributes, Rules, or ObjectTypes.
Deletes existing Attributes, Rules, or ObjectTypes.

Arguments

x-amz-data-partition = ::String – Required

The Amazon Resource Name (ARN) that is associated with the Facet. For more information, see arns.

Name = ::String – Required

The name of the facet.

AttributeUpdates = [[ ... ], ...]

List of attributes that need to be updated in a given schema Facet. Each attribute is followed by AttributeAction, which specifies the type of update operation to perform.

 AttributeUpdates = [[
        "Attribute" =>  [
            "Name" => <required> ::String,
            "AttributeDefinition" =>  [
                "Type" => <required> "STRING", "BINARY", "BOOLEAN", "NUMBER" or "DATETIME",
                "DefaultValue" =>  [
                    "StringValue" =>  ::String,
                    "BinaryValue" =>  blob,
                    "BooleanValue" =>  ::Bool,
                    "NumberValue" =>  ::String,
                    "DatetimeValue" =>  timestamp
                ],
                "IsImmutable" =>  ::Bool,
                "Rules" =>  ::Dict{String,String}
            ],
            "AttributeReference" =>  [
                "TargetFacetName" => <required> ::String,
                "TargetAttributeName" => <required> ::String
            ],
            "RequiredBehavior" =>  "REQUIRED_ALWAYS" or "NOT_REQUIRED"
        ],
        "Action" =>  "CREATE_OR_UPDATE" or "DELETE"
    ], ...]

ObjectType = "NODE", "LEAF_NODE", "POLICY" or "INDEX"

The object type that is associated with the facet. See CreateFacetRequestObjectType for more details.

Returns

UpdateFacetResponse

Exceptions

InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, InvalidFacetUpdateException, ResourceNotFoundException, FacetNotFoundException or InvalidRuleException.

See also: AWS API Documentation

AWSSDK.CloudDirectory.update_object_attributes — Function.

using AWSSDK.CloudDirectory.update_object_attributes
update_object_attributes([::AWSConfig], arguments::Dict)
update_object_attributes([::AWSConfig]; x-amz-data-partition=, ObjectReference=, AttributeUpdates=)

using AWSCore.Services.clouddirectory
clouddirectory([::AWSConfig], "PUT", "/amazonclouddirectory/2017-01-11/object/update", arguments::Dict)
clouddirectory([::AWSConfig], "PUT", "/amazonclouddirectory/2017-01-11/object/update", x-amz-data-partition=, ObjectReference=, AttributeUpdates=)

UpdateObjectAttributes Operation

Updates a given object's attributes.

Arguments

x-amz-data-partition = ::String – Required

The Amazon Resource Name (ARN) that is associated with the Directory where the object resides. For more information, see arns.

ObjectReference = ["Selector" => ::String] – Required

The reference that identifies the object.

AttributeUpdates = [[ ... ], ...] – Required

The attributes update structure.

 AttributeUpdates = [[
        "ObjectAttributeKey" =>  [
            "SchemaArn" => <required> ::String,
            "FacetName" => <required> ::String,
            "Name" => <required> ::String
        ],
        "ObjectAttributeAction" =>  [
            "ObjectAttributeActionType" =>  "CREATE_OR_UPDATE" or "DELETE",
            "ObjectAttributeUpdateValue" =>  [
                "StringValue" =>  ::String,
                "BinaryValue" =>  blob,
                "BooleanValue" =>  ::Bool,
                "NumberValue" =>  ::String,
                "DatetimeValue" =>  timestamp
            ]
        ]
    ], ...]

Returns

UpdateObjectAttributesResponse

Exceptions

See also: AWS API Documentation

AWSSDK.CloudDirectory.update_schema — Function.

using AWSSDK.CloudDirectory.update_schema
update_schema([::AWSConfig], arguments::Dict)
update_schema([::AWSConfig]; x-amz-data-partition=, Name=)

using AWSCore.Services.clouddirectory
clouddirectory([::AWSConfig], "PUT", "/amazonclouddirectory/2017-01-11/schema/update", arguments::Dict)
clouddirectory([::AWSConfig], "PUT", "/amazonclouddirectory/2017-01-11/schema/update", x-amz-data-partition=, Name=)

UpdateSchema Operation

Updates the schema name with a new name. Only development schema names can be updated.

Arguments

x-amz-data-partition = ::String – Required

The Amazon Resource Name (ARN) of the development schema. For more information, see arns.

Name = ::String – Required

The name of the schema.

Returns

UpdateSchemaResponse

Exceptions

InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException or ResourceNotFoundException.

See also: AWS API Documentation

AWSSDK.CloudDirectory.update_typed_link_facet — Function.

using AWSSDK.CloudDirectory.update_typed_link_facet
update_typed_link_facet([::AWSConfig], arguments::Dict)
update_typed_link_facet([::AWSConfig]; x-amz-data-partition=, Name=, AttributeUpdates=, IdentityAttributeOrder=)

using AWSCore.Services.clouddirectory
clouddirectory([::AWSConfig], "PUT", "/amazonclouddirectory/2017-01-11/typedlink/facet", arguments::Dict)
clouddirectory([::AWSConfig], "PUT", "/amazonclouddirectory/2017-01-11/typedlink/facet", x-amz-data-partition=, Name=, AttributeUpdates=, IdentityAttributeOrder=)

UpdateTypedLinkFacet Operation

Updates a TypedLinkFacet. For more information, see Typed link.

Arguments

x-amz-data-partition = ::String – Required

The Amazon Resource Name (ARN) that is associated with the schema. For more information, see arns.

Name = ::String – Required

The unique name of the typed link facet.

AttributeUpdates = [[ ... ], ...] – Required

Attributes update structure.

 AttributeUpdates = [[
        "Attribute" => <required> [
            "Name" => <required> ::String,
            "Type" => <required> "STRING", "BINARY", "BOOLEAN", "NUMBER" or "DATETIME",
            "DefaultValue" =>  [
                "StringValue" =>  ::String,
                "BinaryValue" =>  blob,
                "BooleanValue" =>  ::Bool,
                "NumberValue" =>  ::String,
                "DatetimeValue" =>  timestamp
            ],
            "IsImmutable" =>  ::Bool,
            "Rules" =>  ::Dict{String,String},
            "RequiredBehavior" => <required> "REQUIRED_ALWAYS" or "NOT_REQUIRED"
        ],
        "Action" => <required> "CREATE_OR_UPDATE" or "DELETE"
    ], ...]

IdentityAttributeOrder = [::String, ...] – Required

The order of identity attributes for the facet, from most significant to least significant. The ability to filter typed links considers the order that the attributes are defined on the typed link facet. When providing ranges to a typed link selection, any inexact ranges must be specified at the end. Any attributes that do not have a range specified are presumed to match the entire range. Filters are interpreted in the order of the attributes on the typed link facet, not the order in which they are supplied to any API calls. For more information about identity attributes, see Typed link.

Returns

UpdateTypedLinkFacetResponse

Exceptions

InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, FacetValidationException, InvalidFacetUpdateException, ResourceNotFoundException, FacetNotFoundException or InvalidRuleException.

See also: AWS API Documentation