Skip to content

attach_typed_link async

attach_typed_link(
    directory_arn: Arn,
    source_object_reference: ObjectReference,
    target_object_reference: ObjectReference,
    typed_link_facet: TypedLinkSchemaAndFacetName,
    attributes: AttributeNameAndValueList,
    *,
    config_overrides: Optional[AsyncCloudDirectoryClientConfig] = None,
) -> AttachTypedLinkResponse

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

Parameters:

  • directory_arn (Arn) –

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

  • source_object_reference (ObjectReference) –

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

  • target_object_reference (ObjectReference) –

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

  • typed_link_facet (TypedLinkSchemaAndFacetName) –

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

  • attributes (AttributeNameAndValueList) –

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

Raises:

  • AccessDeniedException –

    Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.

  • DirectoryNotEnabledException –

    Operations are only permitted on enabled directories.

  • FacetValidationException –

    The Facet that you provided was not well formed or could not be validated with the schema.

  • InternalServiceException –

    Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.

  • InvalidArnException –

    Indicates that the provided ARN value is not valid.

  • InvalidAttachmentException –

    Indicates that an attempt to make an attachment was invalid. For example, attaching two nodes with a link type that is not applicable to the nodes or attempting to apply a schema to a directory a second time.

  • LimitExceededException –

    Indicates that limits are exceeded. See Limits for more information.

  • ResourceNotFoundException –

    The specified resource could not be found.

  • RetryableConflictException –

    Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.

  • ValidationException –

    Indicates that your request is malformed in some manner. See the exception message.

  • UnknownServiceError –

    The service returned an error code this client does not model.

Examples:

To attach a typed link to an object

>>> await client.attach_typed_link(directory_arn='arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY', source_object_reference={'Selector': '$AQGG_ADlfNZBzYHY_JgDt3TWSvfuEnDqTdmeCuTs6YBNUA'}, target_object_reference={'Selector': '$AQGG_ADlfNZBzYHY_JgDt3TWcU7IARvOTeaR09zme1sVsw'}, typed_link_facet={'TypedLinkName': 'exampletypedlink8', 'SchemaArn': 'arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY/schema/org/1'}, attributes=[{'AttributeName': '22', 'Value': {'BinaryValue': 'c3Ry'}}])
Source code in docs_src/capo_clouddirectory/_services/async_cloud_directory.py
async def attach_typed_link(
    self,
    directory_arn: "capo_clouddirectory.types.arn.Arn",
    source_object_reference: "capo_clouddirectory.types.object_reference.ObjectReference",
    target_object_reference: "capo_clouddirectory.types.object_reference.ObjectReference",
    typed_link_facet: "capo_clouddirectory.types.typed_link_schema_and_facet_name.TypedLinkSchemaAndFacetName",
    attributes: "capo_clouddirectory.types.attribute_name_and_value_list.AttributeNameAndValueList",
    *,
    config_overrides: Optional[AsyncCloudDirectoryClientConfig] = None,
) -> "capo_clouddirectory.types.attach_typed_link_response.AttachTypedLinkResponse":
    """<p>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>.</p>

    Args:
        directory_arn: <p>The Amazon Resource Name (ARN) of the directory where you want to attach the typed link.</p>
        source_object_reference: <p>Identifies the source object that the typed link will attach to.</p>
        target_object_reference: <p>Identifies the target object that the typed link will attach to.</p>
        typed_link_facet: <p>Identifies the typed link facet that is associated with the typed link.</p>
        attributes: <p>A set of attributes that are associated with the typed link.</p>

    Raises:
        capo_clouddirectory.errors.access_denied_exception.AccessDeniedException: <p>Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling <a>ListDirectories</a> and check your permissions.</p>
        capo_clouddirectory.errors.directory_not_enabled_exception.DirectoryNotEnabledException: <p>Operations are only permitted on enabled directories.</p>
        capo_clouddirectory.errors.facet_validation_exception.FacetValidationException: <p>The <a>Facet</a> that you provided was not well formed or could not be validated with the schema.</p>
        capo_clouddirectory.errors.internal_service_exception.InternalServiceException: <p>Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the <a href="http://status.aws.amazon.com/">AWS Service Health Dashboard</a> site to see if there are any operational issues with the service.</p>
        capo_clouddirectory.errors.invalid_arn_exception.InvalidArnException: <p>Indicates that the provided ARN value is not valid.</p>
        capo_clouddirectory.errors.invalid_attachment_exception.InvalidAttachmentException: <p>Indicates that an attempt to make an attachment was invalid. For example, attaching two nodes with a link type that is not applicable to the nodes or attempting to apply a schema to a directory a second time.</p>
        capo_clouddirectory.errors.limit_exceeded_exception.LimitExceededException: <p>Indicates that limits are exceeded. See <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/limits.html">Limits</a> for more information.</p>
        capo_clouddirectory.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource could not be found.</p>
        capo_clouddirectory.errors.retryable_conflict_exception.RetryableConflictException: <p>Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.</p>
        capo_clouddirectory.errors.validation_exception.ValidationException: <p>Indicates that your request is malformed in some manner. See the exception message.</p>
        capo_clouddirectory.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        To attach a typed link to an object

        >>> await client.attach_typed_link(directory_arn='arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY', source_object_reference={'Selector': '$AQGG_ADlfNZBzYHY_JgDt3TWSvfuEnDqTdmeCuTs6YBNUA'}, target_object_reference={'Selector': '$AQGG_ADlfNZBzYHY_JgDt3TWcU7IARvOTeaR09zme1sVsw'}, typed_link_facet={'TypedLinkName': 'exampletypedlink8', 'SchemaArn': 'arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY/schema/org/1'}, attributes=[{'AttributeName': '22', 'Value': {'BinaryValue': 'c3Ry'}}])
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_clouddirectory.types.attach_typed_link_request.AttachTypedLinkRequest]",
    ) -> AsyncOperationResponse[
        "capo_clouddirectory.types.attach_typed_link_response.AttachTypedLinkResponse"
    ]:
        import capo_clouddirectory._operations.amazon_cloud_directory_20170111.attach_typed_link

        (
            output,
            http_response,
        ) = await capo_clouddirectory._operations.amazon_cloud_directory_20170111.attach_typed_link.async_attach_typed_link(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("AttachTypedLink")
    )
    input_: capo_clouddirectory.types.attach_typed_link_request.AttachTypedLinkRequest = {
        "directory_arn": directory_arn,
        "source_object_reference": source_object_reference,
        "target_object_reference": target_object_reference,
        "typed_link_facet": typed_link_facet,
        "attributes": attributes,
    }

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output