update_facet ¶

def update_facet(
    self,
    schema_arn: "capo_clouddirectory.types.arn.Arn",
    name: "capo_clouddirectory.types.facet_name.FacetName",
    *,
    config_overrides: Optional[CloudDirectoryClientConfig] = None,
    attribute_updates: Optional[
        "capo_clouddirectory.types.facet_attribute_update_list.FacetAttributeUpdateList"
    ] = None,
    object_type: Optional[
        "capo_clouddirectory.types.object_type.ObjectType"
    ] = None,
) -> "capo_clouddirectory.types.update_facet_response.UpdateFacetResponse":
    """<p>Does the following:</p> <ol> <li> <p>Adds new <code>Attributes</code>, <code>Rules</code>, or <code>ObjectTypes</code>.</p> </li> <li> <p>Updates existing <code>Attributes</code>, <code>Rules</code>, or <code>ObjectTypes</code>.</p> </li> <li> <p>Deletes existing <code>Attributes</code>, <code>Rules</code>, or <code>ObjectTypes</code>.</p> </li> </ol>

    Args:
        schema_arn: <p>The Amazon Resource Name (ARN) that is associated with the <a>Facet</a>. For more information, see <a>arns</a>.</p>
        name: <p>The name of the facet.</p>
        attribute_updates: <p>List of attributes that need to be updated in a given schema <a>Facet</a>. Each attribute is followed by <code>AttributeAction</code>, which specifies the type of update operation to perform. </p>
        object_type: <p>The object type that is associated with the facet. See <a>CreateFacetRequest$ObjectType</a> for more details.</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.facet_not_found_exception.FacetNotFoundException: <p>The specified <a>Facet</a> could not be found.</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_facet_update_exception.InvalidFacetUpdateException: <p>An attempt to modify a <a>Facet</a> resulted in an invalid schema exception.</p>
        capo_clouddirectory.errors.invalid_rule_exception.InvalidRuleException: <p>Occurs when any of the rule parameter keys or values are invalid.</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.
    """

    def _handler(
        req: "OperationRequest[capo_clouddirectory.types.update_facet_request.UpdateFacetRequest]",
    ) -> OperationResponse[
        "capo_clouddirectory.types.update_facet_response.UpdateFacetResponse"
    ]:
        import capo_clouddirectory._operations.amazon_cloud_directory_20170111.update_facet

        output, http_response = (
            capo_clouddirectory._operations.amazon_cloud_directory_20170111.update_facet.update_facet(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateFacet")
    )
    input_: capo_clouddirectory.types.update_facet_request.UpdateFacetRequest = {
        "schema_arn": schema_arn,
        "name": name,
    }
    if attribute_updates is not None:
        input_["attribute_updates"] = attribute_updates
    if object_type is not None:
        input_["object_type"] = object_type

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output