AWS.Tools.CloudDirectory.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.CloudDirectory</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.CDIR.AddCDIRFacetToObjectCmdlet"> <summary> Adds a new <a>Facet</a> to an object. An object can have more than one facet applied on it. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.AddCDIRFacetToObjectCmdlet.DirectoryArn"> <summary> <para> <para>The Amazon Resource Name (ARN) that is associated with the <a>Directory</a> where the object resides. For more information, see <a>arns</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.AddCDIRFacetToObjectCmdlet.SchemaFacet_FacetName"> <summary> <para> <para>The name of the facet. If this value is set, SchemaArn must also be set.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.AddCDIRFacetToObjectCmdlet.ObjectAttributeList"> <summary> <para> <para>Attributes on the facet that you are adding to the object.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.AddCDIRFacetToObjectCmdlet.SchemaFacet_SchemaArn"> <summary> <para> <para>The ARN of the schema that contains the facet with no minor component. See <a>arns</a> and <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/schemas_inplaceschemaupgrade.html">In-Place Schema Upgrade</a> for a description of when to provide minor versions. If this value is set, FacetName must also be set.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.AddCDIRFacetToObjectCmdlet.ObjectReference_Selector"> <summary> <para> <para>A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_access_objects.html">Access Objects</a>. You can identify an object in one of the following ways:</para><ul><li><para><i>$ObjectIdentifier</i> - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes. </para></li><li><para><i>/some/path</i> - Identifies the object based on path</para></li><li><para><i>#SomeBatchReference</i> - Identifies the object in a batch call</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.AddCDIRFacetToObjectCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudDirectory.Model.AddFacetToObjectResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.AddCDIRFacetToObjectCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DirectoryArn parameter. The -PassThru parameter is deprecated, use -Select '^DirectoryArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.AddCDIRFacetToObjectCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CDIR.AddCDIRResourceTagCmdlet"> <summary> An API operation for adding tags to a resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.AddCDIRResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource. Tagging is only supported for directories.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.AddCDIRResourceTagCmdlet.Tag"> <summary> <para> <para>A list of tag key-value pairs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.AddCDIRResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudDirectory.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.AddCDIRResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.AddCDIRResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CDIR.AddCDIRSchemaCmdlet"> <summary> Copies the input published schema, at the specified version, into the <a>Directory</a> with the same name and version as that of the published schema. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.AddCDIRSchemaCmdlet.DirectoryArn"> <summary> <para> <para>The Amazon Resource Name (ARN) that is associated with the <a>Directory</a> into which the schema is copied. For more information, see <a>arns</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.AddCDIRSchemaCmdlet.PublishedSchemaArn"> <summary> <para> <para>Published schema Amazon Resource Name (ARN) that needs to be copied. For more information, see <a>arns</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.AddCDIRSchemaCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudDirectory.Model.ApplySchemaResponse). Specifying the name of a property of type Amazon.CloudDirectory.Model.ApplySchemaResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.AddCDIRSchemaCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DirectoryArn parameter. The -PassThru parameter is deprecated, use -Select '^DirectoryArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.AddCDIRSchemaCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CDIR.ConnectCDIRObjectCmdlet"> <summary> Attaches an existing object to another object. An object can be accessed in two ways: <ol><li><para> Using the path </para></li><li><para> Using <c>ObjectIdentifier</c></para></li></ol> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.ConnectCDIRObjectCmdlet.DirectoryArn"> <summary> <para> <para>Amazon Resource Name (ARN) that is associated with the <a>Directory</a> where both objects reside. For more information, see <a>arns</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.ConnectCDIRObjectCmdlet.LinkName"> <summary> <para> <para>The link name with which the child object is attached to the parent.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.ConnectCDIRObjectCmdlet.ChildReference_Selector"> <summary> <para> <para>A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_access_objects.html">Access Objects</a>. You can identify an object in one of the following ways:</para><ul><li><para><i>$ObjectIdentifier</i> - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes. </para></li><li><para><i>/some/path</i> - Identifies the object based on path</para></li><li><para><i>#SomeBatchReference</i> - Identifies the object in a batch call</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.ConnectCDIRObjectCmdlet.ParentReference_Selector"> <summary> <para> <para>A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_access_objects.html">Access Objects</a>. You can identify an object in one of the following ways:</para><ul><li><para><i>$ObjectIdentifier</i> - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes. </para></li><li><para><i>/some/path</i> - Identifies the object based on path</para></li><li><para><i>#SomeBatchReference</i> - Identifies the object in a batch call</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.ConnectCDIRObjectCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AttachedObjectIdentifier'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudDirectory.Model.AttachObjectResponse). Specifying the name of a property of type Amazon.CloudDirectory.Model.AttachObjectResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.ConnectCDIRObjectCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DirectoryArn parameter. The -PassThru parameter is deprecated, use -Select '^DirectoryArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.ConnectCDIRObjectCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CDIR.DisableCDIRDirectoryCmdlet"> <summary> Disables the specified directory. Disabled directories cannot be read or written to. Only enabled directories can be disabled. Disabled directories may be reenabled. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.DisableCDIRDirectoryCmdlet.DirectoryArn"> <summary> <para> <para>The ARN of the directory to disable.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.DisableCDIRDirectoryCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DirectoryArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudDirectory.Model.DisableDirectoryResponse). Specifying the name of a property of type Amazon.CloudDirectory.Model.DisableDirectoryResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.DisableCDIRDirectoryCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DirectoryArn parameter. The -PassThru parameter is deprecated, use -Select '^DirectoryArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.DisableCDIRDirectoryCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CDIR.DisconnectCDIRObjectCmdlet"> <summary> Detaches a given object from the parent object. The object that is to be detached from the parent is specified by the link name. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.DisconnectCDIRObjectCmdlet.DirectoryArn"> <summary> <para> <para>The Amazon Resource Name (ARN) that is associated with the <a>Directory</a> where objects reside. For more information, see <a>arns</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.DisconnectCDIRObjectCmdlet.LinkName"> <summary> <para> <para>The link name associated with the object that needs to be detached.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.DisconnectCDIRObjectCmdlet.ParentReference_Selector"> <summary> <para> <para>A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_access_objects.html">Access Objects</a>. You can identify an object in one of the following ways:</para><ul><li><para><i>$ObjectIdentifier</i> - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes. </para></li><li><para><i>/some/path</i> - Identifies the object based on path</para></li><li><para><i>#SomeBatchReference</i> - Identifies the object in a batch call</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.DisconnectCDIRObjectCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DetachedObjectIdentifier'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudDirectory.Model.DetachObjectResponse). Specifying the name of a property of type Amazon.CloudDirectory.Model.DetachObjectResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.DisconnectCDIRObjectCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DirectoryArn parameter. The -PassThru parameter is deprecated, use -Select '^DirectoryArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.DisconnectCDIRObjectCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CDIR.DismountCDIRObjectFromIndexCmdlet"> <summary> Detaches the specified object from the specified index. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.DismountCDIRObjectFromIndexCmdlet.DirectoryArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the directory the index and object exist in.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.DismountCDIRObjectFromIndexCmdlet.IndexReference_Selector"> <summary> <para> <para>A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_access_objects.html">Access Objects</a>. You can identify an object in one of the following ways:</para><ul><li><para><i>$ObjectIdentifier</i> - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes. </para></li><li><para><i>/some/path</i> - Identifies the object based on path</para></li><li><para><i>#SomeBatchReference</i> - Identifies the object in a batch call</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.DismountCDIRObjectFromIndexCmdlet.TargetReference_Selector"> <summary> <para> <para>A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_access_objects.html">Access Objects</a>. You can identify an object in one of the following ways:</para><ul><li><para><i>$ObjectIdentifier</i> - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes. </para></li><li><para><i>/some/path</i> - Identifies the object based on path</para></li><li><para><i>#SomeBatchReference</i> - Identifies the object in a batch call</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.DismountCDIRObjectFromIndexCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DetachedObjectIdentifier'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudDirectory.Model.DetachFromIndexResponse). Specifying the name of a property of type Amazon.CloudDirectory.Model.DetachFromIndexResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.DismountCDIRObjectFromIndexCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DirectoryArn parameter. The -PassThru parameter is deprecated, use -Select '^DirectoryArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.DismountCDIRObjectFromIndexCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CDIR.DismountCDIRPolicyFromObjectCmdlet"> <summary> Detaches a policy from an object. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.DismountCDIRPolicyFromObjectCmdlet.DirectoryArn"> <summary> <para> <para>The Amazon Resource Name (ARN) that is associated with the <a>Directory</a> where both objects reside. For more information, see <a>arns</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.DismountCDIRPolicyFromObjectCmdlet.ObjectReference_Selector"> <summary> <para> <para>A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_access_objects.html">Access Objects</a>. You can identify an object in one of the following ways:</para><ul><li><para><i>$ObjectIdentifier</i> - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes. </para></li><li><para><i>/some/path</i> - Identifies the object based on path</para></li><li><para><i>#SomeBatchReference</i> - Identifies the object in a batch call</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.DismountCDIRPolicyFromObjectCmdlet.PolicyReference_Selector"> <summary> <para> <para>A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_access_objects.html">Access Objects</a>. You can identify an object in one of the following ways:</para><ul><li><para><i>$ObjectIdentifier</i> - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes. </para></li><li><para><i>/some/path</i> - Identifies the object based on path</para></li><li><para><i>#SomeBatchReference</i> - Identifies the object in a batch call</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.DismountCDIRPolicyFromObjectCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudDirectory.Model.DetachPolicyResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.DismountCDIRPolicyFromObjectCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DirectoryArn parameter. The -PassThru parameter is deprecated, use -Select '^DirectoryArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.DismountCDIRPolicyFromObjectCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CDIR.DismountCDIRTypedLinkCmdlet"> <summary> Detaches a typed link from a specified source and target object. For more information, see <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink">Typed Links</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.DismountCDIRTypedLinkCmdlet.DirectoryArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the directory where you want to detach the typed link.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.DismountCDIRTypedLinkCmdlet.TypedLinkSpecifier_IdentityAttributeValue"> <summary> <para> <para>Identifies the attribute value to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.DismountCDIRTypedLinkCmdlet.TypedLinkFacet_SchemaArn"> <summary> <para> <para>The Amazon Resource Name (ARN) that is associated with the schema. For more information, see <a>arns</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.DismountCDIRTypedLinkCmdlet.SourceObjectReference_Selector"> <summary> <para> <para>A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_access_objects.html">Access Objects</a>. You can identify an object in one of the following ways:</para><ul><li><para><i>$ObjectIdentifier</i> - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes. </para></li><li><para><i>/some/path</i> - Identifies the object based on path</para></li><li><para><i>#SomeBatchReference</i> - Identifies the object in a batch call</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.DismountCDIRTypedLinkCmdlet.TargetObjectReference_Selector"> <summary> <para> <para>A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_access_objects.html">Access Objects</a>. You can identify an object in one of the following ways:</para><ul><li><para><i>$ObjectIdentifier</i> - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes. </para></li><li><para><i>/some/path</i> - Identifies the object based on path</para></li><li><para><i>#SomeBatchReference</i> - Identifies the object in a batch call</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.DismountCDIRTypedLinkCmdlet.TypedLinkFacet_TypedLinkName"> <summary> <para> <para>The unique name of the typed link facet.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.DismountCDIRTypedLinkCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudDirectory.Model.DetachTypedLinkResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.DismountCDIRTypedLinkCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DirectoryArn parameter. The -PassThru parameter is deprecated, use -Select '^DirectoryArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.DismountCDIRTypedLinkCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CDIR.EnableCDIRDirectoryCmdlet"> <summary> Enables the specified directory. Only disabled directories can be enabled. Once enabled, the directory can then be read and written to. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.EnableCDIRDirectoryCmdlet.DirectoryArn"> <summary> <para> <para>The ARN of the directory to enable.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.EnableCDIRDirectoryCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DirectoryArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudDirectory.Model.EnableDirectoryResponse). Specifying the name of a property of type Amazon.CloudDirectory.Model.EnableDirectoryResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.EnableCDIRDirectoryCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DirectoryArn parameter. The -PassThru parameter is deprecated, use -Select '^DirectoryArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.EnableCDIRDirectoryCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRAppliedSchemaArnCmdlet"> <summary> Lists schema major versions applied to a directory. If <c>SchemaArn</c> is provided, lists the minor version.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRAppliedSchemaArnCmdlet.DirectoryArn"> <summary> <para> <para>The ARN of the directory you are listing.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRAppliedSchemaArnCmdlet.SchemaArn"> <summary> <para> <para>The response for <c>ListAppliedSchemaArns</c> when this parameter is used will list all minor version ARNs for a major version.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRAppliedSchemaArnCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to retrieve.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRAppliedSchemaArnCmdlet.NextToken"> <summary> <para> <para>The pagination token.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRAppliedSchemaArnCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'SchemaArns'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudDirectory.Model.ListAppliedSchemaArnsResponse). Specifying the name of a property of type Amazon.CloudDirectory.Model.ListAppliedSchemaArnsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRAppliedSchemaArnCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DirectoryArn parameter. The -PassThru parameter is deprecated, use -Select '^DirectoryArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRAppliedSchemaArnCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRAppliedSchemaVersionCmdlet"> <summary> Returns current applied schema version ARN, including the minor version in use. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRAppliedSchemaVersionCmdlet.SchemaArn"> <summary> <para> <para>The ARN of the applied schema.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRAppliedSchemaVersionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AppliedSchemaArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudDirectory.Model.GetAppliedSchemaVersionResponse). Specifying the name of a property of type Amazon.CloudDirectory.Model.GetAppliedSchemaVersionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRAppliedSchemaVersionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SchemaArn parameter. The -PassThru parameter is deprecated, use -Select '^SchemaArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRDevelopmentSchemaArnCmdlet"> <summary> Retrieves each Amazon Resource Name (ARN) of schemas in the development state.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRDevelopmentSchemaArnCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to retrieve.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRDevelopmentSchemaArnCmdlet.NextToken"> <summary> <para> <para>The pagination token.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRDevelopmentSchemaArnCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'SchemaArns'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudDirectory.Model.ListDevelopmentSchemaArnsResponse). Specifying the name of a property of type Amazon.CloudDirectory.Model.ListDevelopmentSchemaArnsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRDevelopmentSchemaArnCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the MaxResult parameter. The -PassThru parameter is deprecated, use -Select '^MaxResult' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRDevelopmentSchemaArnCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRDirectoryCmdlet"> <summary> Lists directories created within an account.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRDirectoryCmdlet.State"> <summary> <para> <para>The state of the directories in the list. Can be either Enabled, Disabled, or Deleted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRDirectoryCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to retrieve.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRDirectoryCmdlet.NextToken"> <summary> <para> <para>The pagination token.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRDirectoryCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Directories'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudDirectory.Model.ListDirectoriesResponse). Specifying the name of a property of type Amazon.CloudDirectory.Model.ListDirectoriesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRDirectoryCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRDirectoryMetadataCmdlet"> <summary> Retrieves metadata about a directory. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRDirectoryMetadataCmdlet.DirectoryArn"> <summary> <para> <para>The ARN of the directory.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRDirectoryMetadataCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Directory'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudDirectory.Model.GetDirectoryResponse). Specifying the name of a property of type Amazon.CloudDirectory.Model.GetDirectoryResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRDirectoryMetadataCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DirectoryArn parameter. The -PassThru parameter is deprecated, use -Select '^DirectoryArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRDirectoryPolicyCmdlet"> <summary> Lists all policies from the root of the <a>Directory</a> 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 <c>ObjectIdentifier</c> for such objects. If policies are present, it returns <c>ObjectIdentifier</c>, <c>policyId</c>, and <c>policyType</c>. Paths that don't lead to the root from the target object are ignored. For more information, see <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/key_concepts_directory.html#key_concepts_policies">Policies</a>.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRDirectoryPolicyCmdlet.DirectoryArn"> <summary> <para> <para>The Amazon Resource Name (ARN) that is associated with the <a>Directory</a>. For more information, see <a>arns</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRDirectoryPolicyCmdlet.ObjectReference_Selector"> <summary> <para> <para>A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_access_objects.html">Access Objects</a>. You can identify an object in one of the following ways:</para><ul><li><para><i>$ObjectIdentifier</i> - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes. </para></li><li><para><i>/some/path</i> - Identifies the object based on path</para></li><li><para><i>#SomeBatchReference</i> - Identifies the object in a batch call</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRDirectoryPolicyCmdlet.MaxResult"> <summary> <para> <para>The maximum number of items to be retrieved in a single call. This is an approximate number.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRDirectoryPolicyCmdlet.NextToken"> <summary> <para> <para>The token to request the next page of results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRDirectoryPolicyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'PolicyToPathList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudDirectory.Model.LookupPolicyResponse). Specifying the name of a property of type Amazon.CloudDirectory.Model.LookupPolicyResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRDirectoryPolicyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DirectoryArn parameter. The -PassThru parameter is deprecated, use -Select '^DirectoryArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRDirectoryPolicyCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRFacetCmdlet"> <summary> Gets details of the <a>Facet</a>, such as facet name, attributes, <a>Rule</a>s, or <c>ObjectType</c>. You can call this on all kinds of schema facets -- published, development, or applied. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRFacetCmdlet.Name"> <summary> <para> <para>The name of the facet to retrieve.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRFacetCmdlet.SchemaArn"> <summary> <para> <para>The Amazon Resource Name (ARN) that is associated with the <a>Facet</a>. For more information, see <a>arns</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRFacetCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Facet'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudDirectory.Model.GetFacetResponse). Specifying the name of a property of type Amazon.CloudDirectory.Model.GetFacetResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRFacetCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SchemaArn parameter. The -PassThru parameter is deprecated, use -Select '^SchemaArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRFacetAttributeCmdlet"> <summary> Retrieves attributes attached to the facet.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRFacetAttributeCmdlet.Name"> <summary> <para> <para>The name of the facet whose attributes will be retrieved.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRFacetAttributeCmdlet.SchemaArn"> <summary> <para> <para>The ARN of the schema where the facet resides.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRFacetAttributeCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to retrieve.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRFacetAttributeCmdlet.NextToken"> <summary> <para> <para>The pagination token.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRFacetAttributeCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Attributes'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudDirectory.Model.ListFacetAttributesResponse). Specifying the name of a property of type Amazon.CloudDirectory.Model.ListFacetAttributesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRFacetAttributeCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SchemaArn parameter. The -PassThru parameter is deprecated, use -Select '^SchemaArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRFacetAttributeCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRFacetNameCmdlet"> <summary> Retrieves the names of facets that exist in a schema.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRFacetNameCmdlet.SchemaArn"> <summary> <para> <para>The Amazon Resource Name (ARN) to retrieve facet names from.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRFacetNameCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to retrieve.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRFacetNameCmdlet.NextToken"> <summary> <para> <para>The pagination token.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRFacetNameCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'FacetNames'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudDirectory.Model.ListFacetNamesResponse). Specifying the name of a property of type Amazon.CloudDirectory.Model.ListFacetNamesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRFacetNameCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SchemaArn parameter. The -PassThru parameter is deprecated, use -Select '^SchemaArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRFacetNameCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRIncomingTypedLinkCmdlet"> <summary> Returns a paginated list of all the incoming <a>TypedLinkSpecifier</a> information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink">Typed Links</a>.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRIncomingTypedLinkCmdlet.ConsistencyLevel"> <summary> <para> <para>The consistency level to execute the request at.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRIncomingTypedLinkCmdlet.DirectoryArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the directory where you want to list the typed links.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRIncomingTypedLinkCmdlet.FilterAttributeRange"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRIncomingTypedLinkCmdlet.FilterTypedLink_SchemaArn"> <summary> <para> <para>The Amazon Resource Name (ARN) that is associated with the schema. For more information, see <a>arns</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRIncomingTypedLinkCmdlet.ObjectReference_Selector"> <summary> <para> <para>A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_access_objects.html">Access Objects</a>. You can identify an object in one of the following ways:</para><ul><li><para><i>$ObjectIdentifier</i> - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes. </para></li><li><para><i>/some/path</i> - Identifies the object based on path</para></li><li><para><i>#SomeBatchReference</i> - Identifies the object in a batch call</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRIncomingTypedLinkCmdlet.FilterTypedLink_TypedLinkName"> <summary> <para> <para>The unique name of the typed link facet.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRIncomingTypedLinkCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to retrieve.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRIncomingTypedLinkCmdlet.NextToken"> <summary> <para> <para>The pagination token.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRIncomingTypedLinkCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'LinkSpecifiers'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudDirectory.Model.ListIncomingTypedLinksResponse). Specifying the name of a property of type Amazon.CloudDirectory.Model.ListIncomingTypedLinksResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRIncomingTypedLinkCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DirectoryArn parameter. The -PassThru parameter is deprecated, use -Select '^DirectoryArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRIncomingTypedLinkCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRIndexCmdlet"> <summary> Lists objects attached to the specified index.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRIndexCmdlet.ConsistencyLevel"> <summary> <para> <para>The consistency level to execute the request at.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRIndexCmdlet.DirectoryArn"> <summary> <para> <para>The ARN of the directory that the index exists in.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRIndexCmdlet.RangesOnIndexedValue"> <summary> <para> <para>Specifies the ranges of indexed values that you want to query.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRIndexCmdlet.IndexReference_Selector"> <summary> <para> <para>A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_access_objects.html">Access Objects</a>. You can identify an object in one of the following ways:</para><ul><li><para><i>$ObjectIdentifier</i> - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes. </para></li><li><para><i>/some/path</i> - Identifies the object based on path</para></li><li><para><i>#SomeBatchReference</i> - Identifies the object in a batch call</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRIndexCmdlet.MaxResult"> <summary> <para> <para>The maximum number of objects in a single page to retrieve from the index during a request. For more information, see <a href="http://docs.aws.amazon.com/clouddirectory/latest/developerguide/limits.html">Amazon Cloud Directory Limits</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRIndexCmdlet.NextToken"> <summary> <para> <para>The pagination token.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRIndexCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'IndexAttachments'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudDirectory.Model.ListIndexResponse). Specifying the name of a property of type Amazon.CloudDirectory.Model.ListIndexResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRIndexCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DirectoryArn parameter. The -PassThru parameter is deprecated, use -Select '^DirectoryArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRIndexCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRLinkAttributeCmdlet"> <summary> Retrieves attributes that are associated with a typed link. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRLinkAttributeCmdlet.AttributeName"> <summary> <para> <para>A list of attribute names whose values will be retrieved.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRLinkAttributeCmdlet.ConsistencyLevel"> <summary> <para> <para>The consistency level at which to retrieve the attributes on a typed link.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRLinkAttributeCmdlet.DirectoryArn"> <summary> <para> <para>The Amazon Resource Name (ARN) that is associated with the Directory where the typed link resides. For more information, see <a>arns</a> or <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink">Typed Links</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRLinkAttributeCmdlet.TypedLinkSpecifier_IdentityAttributeValue"> <summary> <para> <para>Identifies the attribute value to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRLinkAttributeCmdlet.TypedLinkFacet_SchemaArn"> <summary> <para> <para>The Amazon Resource Name (ARN) that is associated with the schema. For more information, see <a>arns</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRLinkAttributeCmdlet.SourceObjectReference_Selector"> <summary> <para> <para>A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_access_objects.html">Access Objects</a>. You can identify an object in one of the following ways:</para><ul><li><para><i>$ObjectIdentifier</i> - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes. </para></li><li><para><i>/some/path</i> - Identifies the object based on path</para></li><li><para><i>#SomeBatchReference</i> - Identifies the object in a batch call</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRLinkAttributeCmdlet.TargetObjectReference_Selector"> <summary> <para> <para>A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_access_objects.html">Access Objects</a>. You can identify an object in one of the following ways:</para><ul><li><para><i>$ObjectIdentifier</i> - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes. </para></li><li><para><i>/some/path</i> - Identifies the object based on path</para></li><li><para><i>#SomeBatchReference</i> - Identifies the object in a batch call</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRLinkAttributeCmdlet.TypedLinkFacet_TypedLinkName"> <summary> <para> <para>The unique name of the typed link facet.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRLinkAttributeCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Attributes'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudDirectory.Model.GetLinkAttributesResponse). Specifying the name of a property of type Amazon.CloudDirectory.Model.GetLinkAttributesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRLinkAttributeCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DirectoryArn parameter. The -PassThru parameter is deprecated, use -Select '^DirectoryArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRManagedSchemaArnCmdlet"> <summary> Lists the major version families of each managed schema. If a major version ARN is provided as SchemaArn, the minor version revisions in that family are listed instead.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRManagedSchemaArnCmdlet.SchemaArn"> <summary> <para> <para>The response for ListManagedSchemaArns. When this parameter is used, all minor version ARNs for a major version are listed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRManagedSchemaArnCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to retrieve.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRManagedSchemaArnCmdlet.NextToken"> <summary> <para> <para>The pagination token.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRManagedSchemaArnCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'SchemaArns'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudDirectory.Model.ListManagedSchemaArnsResponse). Specifying the name of a property of type Amazon.CloudDirectory.Model.ListManagedSchemaArnsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRManagedSchemaArnCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRObjectAttributeCmdlet"> <summary> Retrieves attributes within a facet that are associated with an object. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRObjectAttributeCmdlet.AttributeName"> <summary> <para> <para>List of attribute names whose values will be retrieved.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRObjectAttributeCmdlet.ConsistencyLevel"> <summary> <para> <para>The consistency level at which to retrieve the attributes on an object.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRObjectAttributeCmdlet.DirectoryArn"> <summary> <para> <para>The Amazon Resource Name (ARN) that is associated with the <a>Directory</a> where the object resides.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRObjectAttributeCmdlet.SchemaFacet_FacetName"> <summary> <para> <para>The name of the facet. If this value is set, SchemaArn must also be set.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRObjectAttributeCmdlet.SchemaFacet_SchemaArn"> <summary> <para> <para>The ARN of the schema that contains the facet with no minor component. See <a>arns</a> and <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/schemas_inplaceschemaupgrade.html">In-Place Schema Upgrade</a> for a description of when to provide minor versions. If this value is set, FacetName must also be set.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRObjectAttributeCmdlet.ObjectReference_Selector"> <summary> <para> <para>A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_access_objects.html">Access Objects</a>. You can identify an object in one of the following ways:</para><ul><li><para><i>$ObjectIdentifier</i> - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes. </para></li><li><para><i>/some/path</i> - Identifies the object based on path</para></li><li><para><i>#SomeBatchReference</i> - Identifies the object in a batch call</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRObjectAttributeCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Attributes'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudDirectory.Model.GetObjectAttributesResponse). Specifying the name of a property of type Amazon.CloudDirectory.Model.GetObjectAttributesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRObjectAttributeCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AttributeName parameter. The -PassThru parameter is deprecated, use -Select '^AttributeName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRObjectAttributeListCmdlet"> <summary> Lists all attributes that are associated with an object.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRObjectAttributeListCmdlet.ConsistencyLevel"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRObjectAttributeListCmdlet.DirectoryArn"> <summary> <para> <para>The Amazon Resource Name (ARN) that is associated with the <a>Directory</a> where the object resides. For more information, see <a>arns</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRObjectAttributeListCmdlet.FacetFilter_FacetName"> <summary> <para> <para>The name of the facet. If this value is set, SchemaArn must also be set.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRObjectAttributeListCmdlet.FacetFilter_SchemaArn"> <summary> <para> <para>The ARN of the schema that contains the facet with no minor component. See <a>arns</a> and <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/schemas_inplaceschemaupgrade.html">In-Place Schema Upgrade</a> for a description of when to provide minor versions. If this value is set, FacetName must also be set.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRObjectAttributeListCmdlet.ObjectReference_Selector"> <summary> <para> <para>A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_access_objects.html">Access Objects</a>. You can identify an object in one of the following ways:</para><ul><li><para><i>$ObjectIdentifier</i> - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes. </para></li><li><para><i>/some/path</i> - Identifies the object based on path</para></li><li><para><i>#SomeBatchReference</i> - Identifies the object in a batch call</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRObjectAttributeListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of items to be retrieved in a single call. This is an approximate number.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRObjectAttributeListCmdlet.NextToken"> <summary> <para> <para>The pagination token.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRObjectAttributeListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Attributes'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudDirectory.Model.ListObjectAttributesResponse). Specifying the name of a property of type Amazon.CloudDirectory.Model.ListObjectAttributesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRObjectAttributeListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ObjectReference_Selector parameter. The -PassThru parameter is deprecated, use -Select '^ObjectReference_Selector' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRObjectAttributeListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRObjectChildCmdlet"> <summary> Returns a paginated list of child objects that are associated with a given object.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRObjectChildCmdlet.ConsistencyLevel"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRObjectChildCmdlet.DirectoryArn"> <summary> <para> <para>The Amazon Resource Name (ARN) that is associated with the <a>Directory</a> where the object resides. For more information, see <a>arns</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRObjectChildCmdlet.ObjectReference_Selector"> <summary> <para> <para>A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_access_objects.html">Access Objects</a>. You can identify an object in one of the following ways:</para><ul><li><para><i>$ObjectIdentifier</i> - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes. </para></li><li><para><i>/some/path</i> - Identifies the object based on path</para></li><li><para><i>#SomeBatchReference</i> - Identifies the object in a batch call</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRObjectChildCmdlet.MaxResult"> <summary> <para> <para>The maximum number of items to be retrieved in a single call. This is an approximate number.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRObjectChildCmdlet.NextToken"> <summary> <para> <para>The pagination token.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRObjectChildCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Children'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudDirectory.Model.ListObjectChildrenResponse). Specifying the name of a property of type Amazon.CloudDirectory.Model.ListObjectChildrenResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRObjectChildCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DirectoryArn parameter. The -PassThru parameter is deprecated, use -Select '^DirectoryArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRObjectChildCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRObjectIndexCmdlet"> <summary> Lists indices attached to the specified object.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRObjectIndexCmdlet.ConsistencyLevel"> <summary> <para> <para>The consistency level to use for this operation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRObjectIndexCmdlet.DirectoryArn"> <summary> <para> <para>The ARN of the directory.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRObjectIndexCmdlet.TargetReference_Selector"> <summary> <para> <para>A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_access_objects.html">Access Objects</a>. You can identify an object in one of the following ways:</para><ul><li><para><i>$ObjectIdentifier</i> - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes. </para></li><li><para><i>/some/path</i> - Identifies the object based on path</para></li><li><para><i>#SomeBatchReference</i> - Identifies the object in a batch call</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRObjectIndexCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to retrieve.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRObjectIndexCmdlet.NextToken"> <summary> <para> <para>The pagination token.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRObjectIndexCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'IndexAttachments'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudDirectory.Model.ListAttachedIndicesResponse). Specifying the name of a property of type Amazon.CloudDirectory.Model.ListAttachedIndicesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRObjectIndexCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DirectoryArn parameter. The -PassThru parameter is deprecated, use -Select '^DirectoryArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRObjectIndexCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRObjectInformationCmdlet"> <summary> Retrieves metadata about an object. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRObjectInformationCmdlet.ConsistencyLevel"> <summary> <para> <para>The consistency level at which to retrieve the object information.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRObjectInformationCmdlet.DirectoryArn"> <summary> <para> <para>The ARN of the directory being retrieved.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRObjectInformationCmdlet.ObjectReference_Selector"> <summary> <para> <para>A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_access_objects.html">Access Objects</a>. You can identify an object in one of the following ways:</para><ul><li><para><i>$ObjectIdentifier</i> - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes. </para></li><li><para><i>/some/path</i> - Identifies the object based on path</para></li><li><para><i>#SomeBatchReference</i> - Identifies the object in a batch call</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRObjectInformationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudDirectory.Model.GetObjectInformationResponse). Specifying the name of a property of type Amazon.CloudDirectory.Model.GetObjectInformationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRObjectInformationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DirectoryArn parameter. The -PassThru parameter is deprecated, use -Select '^DirectoryArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRObjectParentCmdlet"> <summary> Lists parent objects that are associated with a given object in pagination fashion.<br/><br/>In the AWS.Tools.CloudDirectory module, this cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRObjectParentCmdlet.ConsistencyLevel"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRObjectParentCmdlet.DirectoryArn"> <summary> <para> <para>The Amazon Resource Name (ARN) that is associated with the <a>Directory</a> where the object resides. For more information, see <a>arns</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRObjectParentCmdlet.IncludeAllLinksToEachParent"> <summary> <para> <para>When set to True, returns all <a>ListObjectParentsResponse$ParentLinks</a>. There could be multiple links between a parent-child pair.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRObjectParentCmdlet.ObjectReference_Selector"> <summary> <para> <para>A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_access_objects.html">Access Objects</a>. You can identify an object in one of the following ways:</para><ul><li><para><i>$ObjectIdentifier</i> - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes. </para></li><li><para><i>/some/path</i> - Identifies the object based on path</para></li><li><para><i>#SomeBatchReference</i> - Identifies the object in a batch call</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRObjectParentCmdlet.MaxResult"> <summary> <para> <para>The maximum number of items to be retrieved in a single call. This is an approximate number.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRObjectParentCmdlet.NextToken"> <summary> <para> <para>The pagination token.</para> </para> <para> <br/><b>Note:</b> In the AWS.Tools.CloudDirectory module, this parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRObjectParentCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudDirectory.Model.ListObjectParentsResponse). Specifying the name of a property of type Amazon.CloudDirectory.Model.ListObjectParentsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRObjectParentCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DirectoryArn parameter. The -PassThru parameter is deprecated, use -Select '^DirectoryArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRObjectParentCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRObjectParentPathCmdlet"> <summary> 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 <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/key_concepts_directorystructure.html">Directory Structure</a>. <para> 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 <c>MaxResults</c>, 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. </para><br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRObjectParentPathCmdlet.DirectoryArn"> <summary> <para> <para>The ARN of the directory to which the parent path applies.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRObjectParentPathCmdlet.ObjectReference_Selector"> <summary> <para> <para>A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_access_objects.html">Access Objects</a>. You can identify an object in one of the following ways:</para><ul><li><para><i>$ObjectIdentifier</i> - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes. </para></li><li><para><i>/some/path</i> - Identifies the object based on path</para></li><li><para><i>#SomeBatchReference</i> - Identifies the object in a batch call</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRObjectParentPathCmdlet.MaxResult"> <summary> <para> <para>The maximum number of items to be retrieved in a single call. This is an approximate number.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRObjectParentPathCmdlet.NextToken"> <summary> <para> <para>The pagination token.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRObjectParentPathCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'PathToObjectIdentifiersList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudDirectory.Model.ListObjectParentPathsResponse). Specifying the name of a property of type Amazon.CloudDirectory.Model.ListObjectParentPathsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRObjectParentPathCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DirectoryArn parameter. The -PassThru parameter is deprecated, use -Select '^DirectoryArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRObjectParentPathCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRObjectPolicyCmdlet"> <summary> Returns policies attached to an object in pagination fashion.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRObjectPolicyCmdlet.ConsistencyLevel"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRObjectPolicyCmdlet.DirectoryArn"> <summary> <para> <para>The Amazon Resource Name (ARN) that is associated with the <a>Directory</a> where objects reside. For more information, see <a>arns</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRObjectPolicyCmdlet.ObjectReference_Selector"> <summary> <para> <para>A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_access_objects.html">Access Objects</a>. You can identify an object in one of the following ways:</para><ul><li><para><i>$ObjectIdentifier</i> - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes. </para></li><li><para><i>/some/path</i> - Identifies the object based on path</para></li><li><para><i>#SomeBatchReference</i> - Identifies the object in a batch call</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRObjectPolicyCmdlet.MaxResult"> <summary> <para> <para>The maximum number of items to be retrieved in a single call. This is an approximate number.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRObjectPolicyCmdlet.NextToken"> <summary> <para> <para>The pagination token.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRObjectPolicyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AttachedPolicyIds'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudDirectory.Model.ListObjectPoliciesResponse). Specifying the name of a property of type Amazon.CloudDirectory.Model.ListObjectPoliciesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRObjectPolicyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DirectoryArn parameter. The -PassThru parameter is deprecated, use -Select '^DirectoryArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRObjectPolicyCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CDIR.GetCDIROutgoingTypedLinkCmdlet"> <summary> Returns a paginated list of all the outgoing <a>TypedLinkSpecifier</a> information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink">Typed Links</a>.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIROutgoingTypedLinkCmdlet.ConsistencyLevel"> <summary> <para> <para>The consistency level to execute the request at.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIROutgoingTypedLinkCmdlet.DirectoryArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the directory where you want to list the typed links.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIROutgoingTypedLinkCmdlet.FilterAttributeRange"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIROutgoingTypedLinkCmdlet.FilterTypedLink_SchemaArn"> <summary> <para> <para>The Amazon Resource Name (ARN) that is associated with the schema. For more information, see <a>arns</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIROutgoingTypedLinkCmdlet.ObjectReference_Selector"> <summary> <para> <para>A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_access_objects.html">Access Objects</a>. You can identify an object in one of the following ways:</para><ul><li><para><i>$ObjectIdentifier</i> - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes. </para></li><li><para><i>/some/path</i> - Identifies the object based on path</para></li><li><para><i>#SomeBatchReference</i> - Identifies the object in a batch call</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIROutgoingTypedLinkCmdlet.FilterTypedLink_TypedLinkName"> <summary> <para> <para>The unique name of the typed link facet.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIROutgoingTypedLinkCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to retrieve.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIROutgoingTypedLinkCmdlet.NextToken"> <summary> <para> <para>The pagination token.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIROutgoingTypedLinkCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'TypedLinkSpecifiers'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudDirectory.Model.ListOutgoingTypedLinksResponse). Specifying the name of a property of type Amazon.CloudDirectory.Model.ListOutgoingTypedLinksResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIROutgoingTypedLinkCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DirectoryArn parameter. The -PassThru parameter is deprecated, use -Select '^DirectoryArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIROutgoingTypedLinkCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRPolicyAttachmentCmdlet"> <summary> Returns all of the <c>ObjectIdentifiers</c> to which a given policy is attached.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRPolicyAttachmentCmdlet.ConsistencyLevel"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRPolicyAttachmentCmdlet.DirectoryArn"> <summary> <para> <para>The Amazon Resource Name (ARN) that is associated with the <a>Directory</a> where objects reside. For more information, see <a>arns</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRPolicyAttachmentCmdlet.PolicyReference_Selector"> <summary> <para> <para>A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_access_objects.html">Access Objects</a>. You can identify an object in one of the following ways:</para><ul><li><para><i>$ObjectIdentifier</i> - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes. </para></li><li><para><i>/some/path</i> - Identifies the object based on path</para></li><li><para><i>#SomeBatchReference</i> - Identifies the object in a batch call</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRPolicyAttachmentCmdlet.MaxResult"> <summary> <para> <para>The maximum number of items to be retrieved in a single call. This is an approximate number.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRPolicyAttachmentCmdlet.NextToken"> <summary> <para> <para>The pagination token.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRPolicyAttachmentCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ObjectIdentifiers'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudDirectory.Model.ListPolicyAttachmentsResponse). Specifying the name of a property of type Amazon.CloudDirectory.Model.ListPolicyAttachmentsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRPolicyAttachmentCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DirectoryArn parameter. The -PassThru parameter is deprecated, use -Select '^DirectoryArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRPolicyAttachmentCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRPublishedSchemaArnCmdlet"> <summary> Lists the major version families of each published schema. If a major version ARN is provided as <c>SchemaArn</c>, the minor version revisions in that family are listed instead.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRPublishedSchemaArnCmdlet.SchemaArn"> <summary> <para> <para>The response for <c>ListPublishedSchemaArns</c> when this parameter is used will list all minor version ARNs for a major version.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRPublishedSchemaArnCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to retrieve.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRPublishedSchemaArnCmdlet.NextToken"> <summary> <para> <para>The pagination token.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRPublishedSchemaArnCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'SchemaArns'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudDirectory.Model.ListPublishedSchemaArnsResponse). Specifying the name of a property of type Amazon.CloudDirectory.Model.ListPublishedSchemaArnsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRPublishedSchemaArnCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRResourceTagCmdlet"> <summary> 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.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource. Tagging is only supported for directories.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRResourceTagCmdlet.MaxResult"> <summary> <para> <para>The <c>MaxResults</c> parameter sets the maximum number of results returned in a single page. This is for future use and is not supported currently.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRResourceTagCmdlet.NextToken"> <summary> <para> <para>The pagination token. This is for future use. Currently pagination is not supported for tagging.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Tags'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudDirectory.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.CloudDirectory.Model.ListTagsForResourceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRResourceTagCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRSchemaAsJsonCmdlet"> <summary> Retrieves a JSON representation of the schema. See <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/schemas_jsonformat.html#schemas_json">JSON Schema Format</a> for more information. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRSchemaAsJsonCmdlet.SchemaArn"> <summary> <para> <para>The ARN of the schema to retrieve.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRSchemaAsJsonCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudDirectory.Model.GetSchemaAsJsonResponse). Specifying the name of a property of type Amazon.CloudDirectory.Model.GetSchemaAsJsonResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRSchemaAsJsonCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SchemaArn parameter. The -PassThru parameter is deprecated, use -Select '^SchemaArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRTypedLinkFacetAttributeCmdlet"> <summary> Returns a paginated list of all attribute definitions for a particular <a>TypedLinkFacet</a>. For more information, see <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink">Typed Links</a>.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRTypedLinkFacetAttributeCmdlet.Name"> <summary> <para> <para>The unique name of the typed link facet.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRTypedLinkFacetAttributeCmdlet.SchemaArn"> <summary> <para> <para>The Amazon Resource Name (ARN) that is associated with the schema. For more information, see <a>arns</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRTypedLinkFacetAttributeCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to retrieve.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRTypedLinkFacetAttributeCmdlet.NextToken"> <summary> <para> <para>The pagination token.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRTypedLinkFacetAttributeCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Attributes'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudDirectory.Model.ListTypedLinkFacetAttributesResponse). Specifying the name of a property of type Amazon.CloudDirectory.Model.ListTypedLinkFacetAttributesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRTypedLinkFacetAttributeCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRTypedLinkFacetAttributeCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRTypedLinkFacetInformationCmdlet"> <summary> Returns the identity attribute order for a specific <a>TypedLinkFacet</a>. For more information, see <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink">Typed Links</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRTypedLinkFacetInformationCmdlet.Name"> <summary> <para> <para>The unique name of the typed link facet.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRTypedLinkFacetInformationCmdlet.SchemaArn"> <summary> <para> <para>The Amazon Resource Name (ARN) that is associated with the schema. For more information, see <a>arns</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRTypedLinkFacetInformationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'IdentityAttributeOrder'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudDirectory.Model.GetTypedLinkFacetInformationResponse). Specifying the name of a property of type Amazon.CloudDirectory.Model.GetTypedLinkFacetInformationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRTypedLinkFacetInformationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRTypedLinkFacetNameCmdlet"> <summary> Returns a paginated list of <c>TypedLink</c> facet names for a particular schema. For more information, see <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink">Typed Links</a>.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRTypedLinkFacetNameCmdlet.SchemaArn"> <summary> <para> <para>The Amazon Resource Name (ARN) that is associated with the schema. For more information, see <a>arns</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRTypedLinkFacetNameCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to retrieve.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRTypedLinkFacetNameCmdlet.NextToken"> <summary> <para> <para>The pagination token.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRTypedLinkFacetNameCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'FacetNames'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudDirectory.Model.ListTypedLinkFacetNamesResponse). Specifying the name of a property of type Amazon.CloudDirectory.Model.ListTypedLinkFacetNamesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRTypedLinkFacetNameCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SchemaArn parameter. The -PassThru parameter is deprecated, use -Select '^SchemaArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.GetCDIRTypedLinkFacetNameCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CDIR.MountCDIRObjectToIndexCmdlet"> <summary> Attaches the specified object to the specified index. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.MountCDIRObjectToIndexCmdlet.DirectoryArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the directory where the object and index exist.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.MountCDIRObjectToIndexCmdlet.IndexReference_Selector"> <summary> <para> <para>A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_access_objects.html">Access Objects</a>. You can identify an object in one of the following ways:</para><ul><li><para><i>$ObjectIdentifier</i> - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes. </para></li><li><para><i>/some/path</i> - Identifies the object based on path</para></li><li><para><i>#SomeBatchReference</i> - Identifies the object in a batch call</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.MountCDIRObjectToIndexCmdlet.TargetReference_Selector"> <summary> <para> <para>A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_access_objects.html">Access Objects</a>. You can identify an object in one of the following ways:</para><ul><li><para><i>$ObjectIdentifier</i> - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes. </para></li><li><para><i>/some/path</i> - Identifies the object based on path</para></li><li><para><i>#SomeBatchReference</i> - Identifies the object in a batch call</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.MountCDIRObjectToIndexCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AttachedObjectIdentifier'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudDirectory.Model.AttachToIndexResponse). Specifying the name of a property of type Amazon.CloudDirectory.Model.AttachToIndexResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.MountCDIRObjectToIndexCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DirectoryArn parameter. The -PassThru parameter is deprecated, use -Select '^DirectoryArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.MountCDIRObjectToIndexCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CDIR.MountCDIRPolicyCmdlet"> <summary> Attaches a policy object to a regular object. An object can have a limited number of attached policies. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.MountCDIRPolicyCmdlet.DirectoryArn"> <summary> <para> <para>The Amazon Resource Name (ARN) that is associated with the <a>Directory</a> where both objects reside. For more information, see <a>arns</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.MountCDIRPolicyCmdlet.ObjectReference_Selector"> <summary> <para> <para>A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_access_objects.html">Access Objects</a>. You can identify an object in one of the following ways:</para><ul><li><para><i>$ObjectIdentifier</i> - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes. </para></li><li><para><i>/some/path</i> - Identifies the object based on path</para></li><li><para><i>#SomeBatchReference</i> - Identifies the object in a batch call</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.MountCDIRPolicyCmdlet.PolicyReference_Selector"> <summary> <para> <para>A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_access_objects.html">Access Objects</a>. You can identify an object in one of the following ways:</para><ul><li><para><i>$ObjectIdentifier</i> - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes. </para></li><li><para><i>/some/path</i> - Identifies the object based on path</para></li><li><para><i>#SomeBatchReference</i> - Identifies the object in a batch call</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.MountCDIRPolicyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudDirectory.Model.AttachPolicyResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.MountCDIRPolicyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DirectoryArn parameter. The -PassThru parameter is deprecated, use -Select '^DirectoryArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.MountCDIRPolicyCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CDIR.MountCDIRTypedLinkCmdlet"> <summary> Attaches a typed link to a specified source and target object. For more information, see <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink">Typed Links</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.MountCDIRTypedLinkCmdlet.Attribute"> <summary> <para> <para>A set of attributes that are associated with the typed link.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.MountCDIRTypedLinkCmdlet.DirectoryArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the directory where you want to attach the typed link.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.MountCDIRTypedLinkCmdlet.TypedLinkFacet_SchemaArn"> <summary> <para> <para>The Amazon Resource Name (ARN) that is associated with the schema. For more information, see <a>arns</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.MountCDIRTypedLinkCmdlet.SourceObjectReference_Selector"> <summary> <para> <para>A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_access_objects.html">Access Objects</a>. You can identify an object in one of the following ways:</para><ul><li><para><i>$ObjectIdentifier</i> - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes. </para></li><li><para><i>/some/path</i> - Identifies the object based on path</para></li><li><para><i>#SomeBatchReference</i> - Identifies the object in a batch call</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.MountCDIRTypedLinkCmdlet.TargetObjectReference_Selector"> <summary> <para> <para>A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_access_objects.html">Access Objects</a>. You can identify an object in one of the following ways:</para><ul><li><para><i>$ObjectIdentifier</i> - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes. </para></li><li><para><i>/some/path</i> - Identifies the object based on path</para></li><li><para><i>#SomeBatchReference</i> - Identifies the object in a batch call</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.MountCDIRTypedLinkCmdlet.TypedLinkFacet_TypedLinkName"> <summary> <para> <para>The unique name of the typed link facet.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.MountCDIRTypedLinkCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'TypedLinkSpecifier'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudDirectory.Model.AttachTypedLinkResponse). Specifying the name of a property of type Amazon.CloudDirectory.Model.AttachTypedLinkResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.MountCDIRTypedLinkCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DirectoryArn parameter. The -PassThru parameter is deprecated, use -Select '^DirectoryArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.MountCDIRTypedLinkCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CDIR.NewCDIRDirectoryCmdlet"> <summary> Creates a <a>Directory</a> by copying the published schema into the directory. A directory cannot be created without a schema. <para> You can also quickly create a directory using a managed schema, called the <c>QuickStartSchema</c>. For more information, see <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/schemas_managed.html">Managed Schema</a> in the <i>Amazon Cloud Directory Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.NewCDIRDirectoryCmdlet.Name"> <summary> <para> <para>The name of the <a>Directory</a>. Should be unique per account, per region.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.NewCDIRDirectoryCmdlet.SchemaArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the published schema that will be copied into the data <a>Directory</a>. For more information, see <a>arns</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.NewCDIRDirectoryCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudDirectory.Model.CreateDirectoryResponse). Specifying the name of a property of type Amazon.CloudDirectory.Model.CreateDirectoryResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.NewCDIRDirectoryCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SchemaArn parameter. The -PassThru parameter is deprecated, use -Select '^SchemaArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.NewCDIRDirectoryCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CDIR.NewCDIRDirectoryObjectCmdlet"> <summary> Creates an object in a <a>Directory</a>. Additionally attaches the object to a parent, if a parent reference and <c>LinkName</c> is specified. An object is simply a collection of <a>Facet</a> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.NewCDIRDirectoryObjectCmdlet.DirectoryArn"> <summary> <para> <para>The Amazon Resource Name (ARN) that is associated with the <a>Directory</a> in which the object will be created. For more information, see <a>arns</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.NewCDIRDirectoryObjectCmdlet.LinkName"> <summary> <para> <para>The name of link that is used to attach this object to a parent.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.NewCDIRDirectoryObjectCmdlet.ObjectAttributeList"> <summary> <para> <para>The attribute map whose attribute ARN contains the key and attribute value as the map value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.NewCDIRDirectoryObjectCmdlet.SchemaFacet"> <summary> <para> <para>A list of schema facets to be associated with the object. Do not provide minor version components. See <a>SchemaFacet</a> for details.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.NewCDIRDirectoryObjectCmdlet.ParentReference_Selector"> <summary> <para> <para>A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_access_objects.html">Access Objects</a>. You can identify an object in one of the following ways:</para><ul><li><para><i>$ObjectIdentifier</i> - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes. </para></li><li><para><i>/some/path</i> - Identifies the object based on path</para></li><li><para><i>#SomeBatchReference</i> - Identifies the object in a batch call</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.NewCDIRDirectoryObjectCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ObjectIdentifier'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudDirectory.Model.CreateObjectResponse). Specifying the name of a property of type Amazon.CloudDirectory.Model.CreateObjectResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.NewCDIRDirectoryObjectCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DirectoryArn parameter. The -PassThru parameter is deprecated, use -Select '^DirectoryArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.NewCDIRDirectoryObjectCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CDIR.NewCDIRFacetCmdlet"> <summary> Creates a new <a>Facet</a> in a schema. Facet creation is allowed only in development or applied schemas. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.NewCDIRFacetCmdlet.Attribute"> <summary> <para> <para>The attributes that are associated with the <a>Facet</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.NewCDIRFacetCmdlet.FacetStyle"> <summary> <para> <para>There are two different styles that you can define on any given facet, <c>Static</c> and <c>Dynamic</c>. For static facets, all attributes must be defined in the schema. For dynamic facets, attributes can be defined during data plane operations.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.NewCDIRFacetCmdlet.Name"> <summary> <para> <para>The name of the <a>Facet</a>, which is unique for a given schema.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.NewCDIRFacetCmdlet.ObjectType"> <summary> <para> <para>Specifies whether a given object created from this facet is of type node, leaf node, policy or index.</para><ul><li><para>Node: Can have multiple children but one parent.</para></li></ul><ul><li><para>Leaf node: Cannot have children but can have multiple parents.</para></li></ul><ul><li><para>Policy: Allows you to store a policy document and policy type. For more information, see <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/key_concepts_directory.html#key_concepts_policies">Policies</a>.</para></li></ul><ul><li><para>Index: Can be created with the Index API.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.NewCDIRFacetCmdlet.SchemaArn"> <summary> <para> <para>The schema ARN in which the new <a>Facet</a> will be created. For more information, see <a>arns</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.NewCDIRFacetCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudDirectory.Model.CreateFacetResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.NewCDIRFacetCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SchemaArn parameter. The -PassThru parameter is deprecated, use -Select '^SchemaArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.NewCDIRFacetCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CDIR.NewCDIRIndexCmdlet"> <summary> Creates an index object. See <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/indexing_search.html">Indexing and search</a> for more information. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.NewCDIRIndexCmdlet.DirectoryArn"> <summary> <para> <para>The ARN of the directory where the index should be created.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.NewCDIRIndexCmdlet.IsUnique"> <summary> <para> <para>Indicates whether the attribute that is being indexed has unique values or not.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.NewCDIRIndexCmdlet.LinkName"> <summary> <para> <para>The name of the link between the parent object and the index object.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.NewCDIRIndexCmdlet.OrderedIndexedAttributeList"> <summary> <para> <para>Specifies the attributes that should be indexed on. Currently only a single attribute is supported.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.NewCDIRIndexCmdlet.ParentReference_Selector"> <summary> <para> <para>A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_access_objects.html">Access Objects</a>. You can identify an object in one of the following ways:</para><ul><li><para><i>$ObjectIdentifier</i> - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes. </para></li><li><para><i>/some/path</i> - Identifies the object based on path</para></li><li><para><i>#SomeBatchReference</i> - Identifies the object in a batch call</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.NewCDIRIndexCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ObjectIdentifier'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudDirectory.Model.CreateIndexResponse). Specifying the name of a property of type Amazon.CloudDirectory.Model.CreateIndexResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.NewCDIRIndexCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DirectoryArn parameter. The -PassThru parameter is deprecated, use -Select '^DirectoryArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.NewCDIRIndexCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CDIR.NewCDIRSchemaCmdlet"> <summary> Creates a new schema in a development state. A schema can exist in three phases: <ul><li><para><i>Development:</i> 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. </para></li><li><para><i>Published:</i> Published schemas are immutable and have a version associated with them. </para></li><li><para><i>Applied:</i> 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. </para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.NewCDIRSchemaCmdlet.Name"> <summary> <para> <para>The name that is associated with the schema. This is unique to each account and in each region.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.NewCDIRSchemaCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'SchemaArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudDirectory.Model.CreateSchemaResponse). Specifying the name of a property of type Amazon.CloudDirectory.Model.CreateSchemaResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.NewCDIRSchemaCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.NewCDIRSchemaCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CDIR.NewCDIRTypedLinkFacetCmdlet"> <summary> Creates a <a>TypedLinkFacet</a>. For more information, see <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink">Typed Links</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.NewCDIRTypedLinkFacetCmdlet.Facet_Attribute"> <summary> <para> <para>A set of key-value pairs associated with the typed link. Typed link attributes are used when you have data values that are related to the link itself, and not to one of the two objects being linked. Identity attributes also serve to distinguish the link from others of the same type between the same objects.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.NewCDIRTypedLinkFacetCmdlet.Facet_IdentityAttributeOrder"> <summary> <para> <para>The set of attributes that distinguish links made from this facet from each other, in the order of significance. Listing typed links can filter on the values of these attributes. See <a>ListOutgoingTypedLinks</a> and <a>ListIncomingTypedLinks</a> for details.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.NewCDIRTypedLinkFacetCmdlet.Facet_Name"> <summary> <para> <para>The unique name of the typed link facet.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.NewCDIRTypedLinkFacetCmdlet.SchemaArn"> <summary> <para> <para>The Amazon Resource Name (ARN) that is associated with the schema. For more information, see <a>arns</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.NewCDIRTypedLinkFacetCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudDirectory.Model.CreateTypedLinkFacetResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.NewCDIRTypedLinkFacetCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SchemaArn parameter. The -PassThru parameter is deprecated, use -Select '^SchemaArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.NewCDIRTypedLinkFacetCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CDIR.PublishCDIRSchemaCmdlet"> <summary> Publishes a development schema with a major version and a recommended minor version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.PublishCDIRSchemaCmdlet.DevelopmentSchemaArn"> <summary> <para> <para>The Amazon Resource Name (ARN) that is associated with the development schema. For more information, see <a>arns</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.PublishCDIRSchemaCmdlet.MinorVersion"> <summary> <para> <para>The minor version under which the schema will be published. This parameter is recommended. Schemas have both a major and minor version associated with them.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.PublishCDIRSchemaCmdlet.Name"> <summary> <para> <para>The new name under which the schema will be published. If this is not provided, the development schema is considered.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.PublishCDIRSchemaCmdlet.Version"> <summary> <para> <para>The major version under which the schema will be published. Schemas have both a major and minor version associated with them.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.PublishCDIRSchemaCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'PublishedSchemaArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudDirectory.Model.PublishSchemaResponse). Specifying the name of a property of type Amazon.CloudDirectory.Model.PublishSchemaResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.PublishCDIRSchemaCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DevelopmentSchemaArn parameter. The -PassThru parameter is deprecated, use -Select '^DevelopmentSchemaArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.PublishCDIRSchemaCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CDIR.ReadCDIRDirectoryBatchCmdlet"> <summary> Performs all the read operations in a batch. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.ReadCDIRDirectoryBatchCmdlet.ConsistencyLevel"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.ReadCDIRDirectoryBatchCmdlet.DirectoryArn"> <summary> <para> <para>The Amazon Resource Name (ARN) that is associated with the <a>Directory</a>. For more information, see <a>arns</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.ReadCDIRDirectoryBatchCmdlet.Operation"> <summary> <para> <para>A list of operations that are part of the batch.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.ReadCDIRDirectoryBatchCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Responses'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudDirectory.Model.BatchReadResponse). Specifying the name of a property of type Amazon.CloudDirectory.Model.BatchReadResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.ReadCDIRDirectoryBatchCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DirectoryArn parameter. The -PassThru parameter is deprecated, use -Select '^DirectoryArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.ReadCDIRDirectoryBatchCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CDIR.RemoveCDIRDirectoryCmdlet"> <summary> Deletes a directory. Only disabled directories can be deleted. A deleted directory cannot be undone. Exercise extreme caution when deleting directories. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.RemoveCDIRDirectoryCmdlet.DirectoryArn"> <summary> <para> <para>The ARN of the directory to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.RemoveCDIRDirectoryCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DirectoryArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudDirectory.Model.DeleteDirectoryResponse). Specifying the name of a property of type Amazon.CloudDirectory.Model.DeleteDirectoryResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.RemoveCDIRDirectoryCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DirectoryArn parameter. The -PassThru parameter is deprecated, use -Select '^DirectoryArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.RemoveCDIRDirectoryCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CDIR.RemoveCDIRDirectoryObjectCmdlet"> <summary> Deletes an object and its associated attributes. Only objects with no children and no parents can be deleted. The maximum number of attributes that can be deleted during an object deletion is 30. For more information, see <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/limits.html">Amazon Cloud Directory Limits</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.RemoveCDIRDirectoryObjectCmdlet.DirectoryArn"> <summary> <para> <para>The Amazon Resource Name (ARN) that is associated with the <a>Directory</a> where the object resides. For more information, see <a>arns</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.RemoveCDIRDirectoryObjectCmdlet.ObjectReference_Selector"> <summary> <para> <para>A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_access_objects.html">Access Objects</a>. You can identify an object in one of the following ways:</para><ul><li><para><i>$ObjectIdentifier</i> - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes. </para></li><li><para><i>/some/path</i> - Identifies the object based on path</para></li><li><para><i>#SomeBatchReference</i> - Identifies the object in a batch call</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.RemoveCDIRDirectoryObjectCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudDirectory.Model.DeleteObjectResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.RemoveCDIRDirectoryObjectCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DirectoryArn parameter. The -PassThru parameter is deprecated, use -Select '^DirectoryArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.RemoveCDIRDirectoryObjectCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CDIR.RemoveCDIRFacetCmdlet"> <summary> Deletes a given <a>Facet</a>. All attributes and <a>Rule</a>s that are associated with the facet will be deleted. Only development schema facets are allowed deletion. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.RemoveCDIRFacetCmdlet.Name"> <summary> <para> <para>The name of the facet to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.RemoveCDIRFacetCmdlet.SchemaArn"> <summary> <para> <para>The Amazon Resource Name (ARN) that is associated with the <a>Facet</a>. For more information, see <a>arns</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.RemoveCDIRFacetCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudDirectory.Model.DeleteFacetResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.RemoveCDIRFacetCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SchemaArn parameter. The -PassThru parameter is deprecated, use -Select '^SchemaArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.RemoveCDIRFacetCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CDIR.RemoveCDIRFacetFromObjectCmdlet"> <summary> Removes the specified facet from the specified object. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.RemoveCDIRFacetFromObjectCmdlet.DirectoryArn"> <summary> <para> <para>The ARN of the directory in which the object resides.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.RemoveCDIRFacetFromObjectCmdlet.SchemaFacet_FacetName"> <summary> <para> <para>The name of the facet. If this value is set, SchemaArn must also be set.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.RemoveCDIRFacetFromObjectCmdlet.SchemaFacet_SchemaArn"> <summary> <para> <para>The ARN of the schema that contains the facet with no minor component. See <a>arns</a> and <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/schemas_inplaceschemaupgrade.html">In-Place Schema Upgrade</a> for a description of when to provide minor versions. If this value is set, FacetName must also be set.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.RemoveCDIRFacetFromObjectCmdlet.ObjectReference_Selector"> <summary> <para> <para>A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_access_objects.html">Access Objects</a>. You can identify an object in one of the following ways:</para><ul><li><para><i>$ObjectIdentifier</i> - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes. </para></li><li><para><i>/some/path</i> - Identifies the object based on path</para></li><li><para><i>#SomeBatchReference</i> - Identifies the object in a batch call</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.RemoveCDIRFacetFromObjectCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudDirectory.Model.RemoveFacetFromObjectResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.RemoveCDIRFacetFromObjectCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DirectoryArn parameter. The -PassThru parameter is deprecated, use -Select '^DirectoryArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.RemoveCDIRFacetFromObjectCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CDIR.RemoveCDIRResourceTagCmdlet"> <summary> An API operation for removing tags from a resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.RemoveCDIRResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource. Tagging is only supported for directories.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.RemoveCDIRResourceTagCmdlet.TagKey"> <summary> <para> <para>Keys of the tag that need to be removed from the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.RemoveCDIRResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudDirectory.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.RemoveCDIRResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.RemoveCDIRResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CDIR.RemoveCDIRSchemaCmdlet"> <summary> Deletes a given schema. Schemas in a development and published state can only be deleted. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.RemoveCDIRSchemaCmdlet.SchemaArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the development schema. For more information, see <a>arns</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.RemoveCDIRSchemaCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'SchemaArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudDirectory.Model.DeleteSchemaResponse). Specifying the name of a property of type Amazon.CloudDirectory.Model.DeleteSchemaResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.RemoveCDIRSchemaCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SchemaArn parameter. The -PassThru parameter is deprecated, use -Select '^SchemaArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.RemoveCDIRSchemaCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CDIR.RemoveCDIRTypedLinkFacetCmdlet"> <summary> Deletes a <a>TypedLinkFacet</a>. For more information, see <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink">Typed Links</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.RemoveCDIRTypedLinkFacetCmdlet.Name"> <summary> <para> <para>The unique name of the typed link facet.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.RemoveCDIRTypedLinkFacetCmdlet.SchemaArn"> <summary> <para> <para>The Amazon Resource Name (ARN) that is associated with the schema. For more information, see <a>arns</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.RemoveCDIRTypedLinkFacetCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudDirectory.Model.DeleteTypedLinkFacetResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.RemoveCDIRTypedLinkFacetCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.RemoveCDIRTypedLinkFacetCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CDIR.UpdateCDIRAppliedSchemaCmdlet"> <summary> Upgrades a single directory in-place using the <c>PublishedSchemaArn</c> with schema updates found in <c>MinorVersion</c>. Backwards-compatible minor version upgrades are instantaneously available for readers on all objects in the directory. Note: This is a synchronous API call and upgrades only one schema on a given directory per call. To upgrade multiple directories from one schema, you would need to call this API on each directory. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.UpdateCDIRAppliedSchemaCmdlet.DirectoryArn"> <summary> <para> <para>The ARN for the directory to which the upgraded schema will be applied.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.UpdateCDIRAppliedSchemaCmdlet.DryRun"> <summary> <para> <para>Used for testing whether the major version schemas are backward compatible or not. If schema compatibility fails, an exception would be thrown else the call would succeed but no changes will be saved. This parameter is optional.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.UpdateCDIRAppliedSchemaCmdlet.PublishedSchemaArn"> <summary> <para> <para>The revision of the published schema to upgrade the directory to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.UpdateCDIRAppliedSchemaCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudDirectory.Model.UpgradeAppliedSchemaResponse). Specifying the name of a property of type Amazon.CloudDirectory.Model.UpgradeAppliedSchemaResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.UpdateCDIRAppliedSchemaCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DirectoryArn parameter. The -PassThru parameter is deprecated, use -Select '^DirectoryArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.UpdateCDIRAppliedSchemaCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CDIR.UpdateCDIRFacetCmdlet"> <summary> Does the following: <ol><li><para> Adds new <c>Attributes</c>, <c>Rules</c>, or <c>ObjectTypes</c>. </para></li><li><para> Updates existing <c>Attributes</c>, <c>Rules</c>, or <c>ObjectTypes</c>. </para></li><li><para> Deletes existing <c>Attributes</c>, <c>Rules</c>, or <c>ObjectTypes</c>. </para></li></ol> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.UpdateCDIRFacetCmdlet.AttributeUpdate"> <summary> <para> <para>List of attributes that need to be updated in a given schema <a>Facet</a>. Each attribute is followed by <c>AttributeAction</c>, which specifies the type of update operation to perform. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.UpdateCDIRFacetCmdlet.Name"> <summary> <para> <para>The name of the facet.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.UpdateCDIRFacetCmdlet.ObjectType"> <summary> <para> <para>The object type that is associated with the facet. See <a>CreateFacetRequest$ObjectType</a> for more details.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.UpdateCDIRFacetCmdlet.SchemaArn"> <summary> <para> <para>The Amazon Resource Name (ARN) that is associated with the <a>Facet</a>. For more information, see <a>arns</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.UpdateCDIRFacetCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudDirectory.Model.UpdateFacetResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.UpdateCDIRFacetCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SchemaArn parameter. The -PassThru parameter is deprecated, use -Select '^SchemaArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.UpdateCDIRFacetCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CDIR.UpdateCDIRLinkAttributeCmdlet"> <summary> Updates a given typed link’s attributes. Attributes to be updated must not contribute to the typed link’s identity, as defined by its <c>IdentityAttributeOrder</c>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.UpdateCDIRLinkAttributeCmdlet.AttributeUpdate"> <summary> <para> <para>The attributes update structure.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.UpdateCDIRLinkAttributeCmdlet.DirectoryArn"> <summary> <para> <para>The Amazon Resource Name (ARN) that is associated with the Directory where the updated typed link resides. For more information, see <a>arns</a> or <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink">Typed Links</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.UpdateCDIRLinkAttributeCmdlet.TypedLinkSpecifier_IdentityAttributeValue"> <summary> <para> <para>Identifies the attribute value to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.UpdateCDIRLinkAttributeCmdlet.TypedLinkFacet_SchemaArn"> <summary> <para> <para>The Amazon Resource Name (ARN) that is associated with the schema. For more information, see <a>arns</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.UpdateCDIRLinkAttributeCmdlet.SourceObjectReference_Selector"> <summary> <para> <para>A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_access_objects.html">Access Objects</a>. You can identify an object in one of the following ways:</para><ul><li><para><i>$ObjectIdentifier</i> - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes. </para></li><li><para><i>/some/path</i> - Identifies the object based on path</para></li><li><para><i>#SomeBatchReference</i> - Identifies the object in a batch call</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.UpdateCDIRLinkAttributeCmdlet.TargetObjectReference_Selector"> <summary> <para> <para>A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_access_objects.html">Access Objects</a>. You can identify an object in one of the following ways:</para><ul><li><para><i>$ObjectIdentifier</i> - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes. </para></li><li><para><i>/some/path</i> - Identifies the object based on path</para></li><li><para><i>#SomeBatchReference</i> - Identifies the object in a batch call</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.UpdateCDIRLinkAttributeCmdlet.TypedLinkFacet_TypedLinkName"> <summary> <para> <para>The unique name of the typed link facet.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.UpdateCDIRLinkAttributeCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudDirectory.Model.UpdateLinkAttributesResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.UpdateCDIRLinkAttributeCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DirectoryArn parameter. The -PassThru parameter is deprecated, use -Select '^DirectoryArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.UpdateCDIRLinkAttributeCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CDIR.UpdateCDIRObjectAttributeCmdlet"> <summary> Updates a given object's attributes. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.UpdateCDIRObjectAttributeCmdlet.AttributeUpdate"> <summary> <para> <para>The attributes update structure.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.UpdateCDIRObjectAttributeCmdlet.DirectoryArn"> <summary> <para> <para>The Amazon Resource Name (ARN) that is associated with the <a>Directory</a> where the object resides. For more information, see <a>arns</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.UpdateCDIRObjectAttributeCmdlet.ObjectReference_Selector"> <summary> <para> <para>A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_access_objects.html">Access Objects</a>. You can identify an object in one of the following ways:</para><ul><li><para><i>$ObjectIdentifier</i> - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes. </para></li><li><para><i>/some/path</i> - Identifies the object based on path</para></li><li><para><i>#SomeBatchReference</i> - Identifies the object in a batch call</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.UpdateCDIRObjectAttributeCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ObjectIdentifier'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudDirectory.Model.UpdateObjectAttributesResponse). Specifying the name of a property of type Amazon.CloudDirectory.Model.UpdateObjectAttributesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.UpdateCDIRObjectAttributeCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DirectoryArn parameter. The -PassThru parameter is deprecated, use -Select '^DirectoryArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.UpdateCDIRObjectAttributeCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CDIR.UpdateCDIRPublishedSchemaCmdlet"> <summary> Upgrades a published schema under a new minor version revision using the current contents of <c>DevelopmentSchemaArn</c>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.UpdateCDIRPublishedSchemaCmdlet.DevelopmentSchemaArn"> <summary> <para> <para>The ARN of the development schema with the changes used for the upgrade.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.UpdateCDIRPublishedSchemaCmdlet.DryRun"> <summary> <para> <para>Used for testing whether the Development schema provided is backwards compatible, or not, with the publish schema provided by the user to be upgraded. If schema compatibility fails, an exception would be thrown else the call would succeed. This parameter is optional and defaults to false.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.UpdateCDIRPublishedSchemaCmdlet.MinorVersion"> <summary> <para> <para>Identifies the minor version of the published schema that will be created. This parameter is NOT optional.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.UpdateCDIRPublishedSchemaCmdlet.PublishedSchemaArn"> <summary> <para> <para>The ARN of the published schema to be upgraded.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.UpdateCDIRPublishedSchemaCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'UpgradedSchemaArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudDirectory.Model.UpgradePublishedSchemaResponse). Specifying the name of a property of type Amazon.CloudDirectory.Model.UpgradePublishedSchemaResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.UpdateCDIRPublishedSchemaCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DevelopmentSchemaArn parameter. The -PassThru parameter is deprecated, use -Select '^DevelopmentSchemaArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.UpdateCDIRPublishedSchemaCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CDIR.UpdateCDIRSchemaCmdlet"> <summary> Updates the schema name with a new name. Only development schema names can be updated. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.UpdateCDIRSchemaCmdlet.Name"> <summary> <para> <para>The name of the schema.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.UpdateCDIRSchemaCmdlet.SchemaArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the development schema. For more information, see <a>arns</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.UpdateCDIRSchemaCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'SchemaArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudDirectory.Model.UpdateSchemaResponse). Specifying the name of a property of type Amazon.CloudDirectory.Model.UpdateSchemaResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.UpdateCDIRSchemaCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SchemaArn parameter. The -PassThru parameter is deprecated, use -Select '^SchemaArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.UpdateCDIRSchemaCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CDIR.UpdateCDIRTypedLinkFacetCmdlet"> <summary> Updates a <a>TypedLinkFacet</a>. For more information, see <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink">Typed Links</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.UpdateCDIRTypedLinkFacetCmdlet.AttributeUpdate"> <summary> <para> <para>Attributes update structure.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.UpdateCDIRTypedLinkFacetCmdlet.IdentityAttributeOrder"> <summary> <para> <para>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 <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink">Typed Links</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.UpdateCDIRTypedLinkFacetCmdlet.Name"> <summary> <para> <para>The unique name of the typed link facet.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.UpdateCDIRTypedLinkFacetCmdlet.SchemaArn"> <summary> <para> <para>The Amazon Resource Name (ARN) that is associated with the schema. For more information, see <a>arns</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.UpdateCDIRTypedLinkFacetCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudDirectory.Model.UpdateTypedLinkFacetResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.UpdateCDIRTypedLinkFacetCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.UpdateCDIRTypedLinkFacetCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CDIR.WriteCDIRDirectoryBatchCmdlet"> <summary> Performs all the write operations in a batch. Either all the operations succeed or none. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.WriteCDIRDirectoryBatchCmdlet.DirectoryArn"> <summary> <para> <para>The Amazon Resource Name (ARN) that is associated with the <a>Directory</a>. For more information, see <a>arns</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.WriteCDIRDirectoryBatchCmdlet.Operation"> <summary> <para> <para>A list of operations that are part of the batch.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.WriteCDIRDirectoryBatchCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Responses'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudDirectory.Model.BatchWriteResponse). Specifying the name of a property of type Amazon.CloudDirectory.Model.BatchWriteResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.WriteCDIRDirectoryBatchCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DirectoryArn parameter. The -PassThru parameter is deprecated, use -Select '^DirectoryArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.WriteCDIRDirectoryBatchCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CDIR.WriteCDIRSchemaFromJsonCmdlet"> <summary> Allows a schema to be updated using JSON upload. Only available for development schemas. See <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/schemas_jsonformat.html#schemas_json">JSON Schema Format</a> for more information. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.WriteCDIRSchemaFromJsonCmdlet.Document"> <summary> <para> <para>The replacement JSON schema.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.WriteCDIRSchemaFromJsonCmdlet.SchemaArn"> <summary> <para> <para>The ARN of the schema to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.WriteCDIRSchemaFromJsonCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Arn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudDirectory.Model.PutSchemaFromJsonResponse). Specifying the name of a property of type Amazon.CloudDirectory.Model.PutSchemaFromJsonResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.WriteCDIRSchemaFromJsonCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SchemaArn parameter. The -PassThru parameter is deprecated, use -Select '^SchemaArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CDIR.WriteCDIRSchemaFromJsonCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> </members> </doc> |