add_facet_to_object async ¶

async def add_facet_to_object(
    self,
    directory_arn: "capo_clouddirectory.types.arn.Arn",
    schema_facet: "capo_clouddirectory.types.schema_facet.SchemaFacet",
    object_reference: "capo_clouddirectory.types.object_reference.ObjectReference",
    *,
    config_overrides: Optional[AsyncCloudDirectoryClientConfig] = None,
    object_attribute_list: Optional[
        "capo_clouddirectory.types.attribute_key_and_value_list.AttributeKeyAndValueList"
    ] = None,
) -> "capo_clouddirectory.types.add_facet_to_object_response.AddFacetToObjectResponse":
    """<p>Adds a new <a>Facet</a> to an object. An object can have more than one facet applied on it.</p>

    Args:
        directory_arn: <p>The Amazon Resource Name (ARN) that is associated with the <a>Directory</a> where the object resides. For more information, see <a>arns</a>.</p>
        schema_facet: <p>Identifiers for the facet that you are adding to the object. See <a>SchemaFacet</a> for details.</p>
        object_attribute_list: <p>Attributes on the facet that you are adding to the object.</p>
        object_reference: <p>A reference to the object you are adding the specified facet to.</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.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 add a facet to an object

        >>> await client.add_facet_to_object(directory_arn='arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY', schema_facet={'SchemaArn': 'arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY/schema/org/1', 'FacetName': 'node1'}, object_attribute_list=[], object_reference={'Selector': '$AQGG_ADlfNZBzYHY_JgDt3TWmspn1fxfQmSQaaVKSbvEiQ'})
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_clouddirectory.types.add_facet_to_object_request.AddFacetToObjectRequest]",
    ) -> AsyncOperationResponse[
        "capo_clouddirectory.types.add_facet_to_object_response.AddFacetToObjectResponse"
    ]:
        import capo_clouddirectory._operations.amazon_cloud_directory_20170111.add_facet_to_object

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("AddFacetToObject")
    )
    input_: capo_clouddirectory.types.add_facet_to_object_request.AddFacetToObjectRequest = {
        "directory_arn": directory_arn,
        "schema_facet": schema_facet,
        "object_reference": object_reference,
    }
    if object_attribute_list is not None:
        input_["object_attribute_list"] = object_attribute_list

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