remove_facet_from_object `async` ¶

remove_facet_from_object(
    directory_arn: Arn,
    schema_facet: SchemaFacet,
    object_reference: ObjectReference,
    *,
    config_overrides: Optional[AsyncCloudDirectoryClientConfig] = None,
) -> RemoveFacetFromObjectResponse

Removes the specified facet from the specified object.

Parameters:

directory_arn (Arn) –

The ARN of the directory in which the object resides.
schema_facet (SchemaFacet) –

The facet to remove. See SchemaFacet for details.
object_reference (ObjectReference) –

A reference to the object to remove the facet from.

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

Source code in docs_src/capo_clouddirectory/_services/async_cloud_directory.py

async def remove_facet_from_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,
) -> "capo_clouddirectory.types.remove_facet_from_object_response.RemoveFacetFromObjectResponse":
    """<p>Removes the specified facet from the specified object.</p>

    Args:
        directory_arn: <p>The ARN of the directory in which the object resides.</p>
        schema_facet: <p>The facet to remove. See <a>SchemaFacet</a> for details.</p>
        object_reference: <p>A reference to the object to remove the facet from.</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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_clouddirectory.types.remove_facet_from_object_request.RemoveFacetFromObjectRequest]",
    ) -> AsyncOperationResponse[
        "capo_clouddirectory.types.remove_facet_from_object_response.RemoveFacetFromObjectResponse"
    ]:
        import capo_clouddirectory._operations.amazon_cloud_directory_20170111.remove_facet_from_object

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("RemoveFacetFromObject")
    )
    input_: capo_clouddirectory.types.remove_facet_from_object_request.RemoveFacetFromObjectRequest = {
        "directory_arn": directory_arn,
        "schema_facet": schema_facet,
        "object_reference": object_reference,
    }

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

remove_facet_from_object async ¶

remove_facet_from_object `async` ¶