DeleteFacet
Deletes a given Facet. All attributes and Rules that are associated with the facet will be deleted. Only development schema facets are allowed deletion.
Request Syntax
PUT /amazonclouddirectory/2017-01-11/facet/delete HTTP/1.1
x-amz-data-partition: SchemaArn
Content-type: application/json
{
"Name": "string
"
}
URI Request Parameters
The request uses the following URI parameters.
- SchemaArn
-
The Amazon Resource Name (ARN) that is associated with the Facet. For more information, see Arn Examples.
Required: Yes
Request Body
The request accepts the following data in JSON format.
- Name
-
The name of the facet to delete.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
^[a-zA-Z0-9._-]*$
Required: Yes
Response Syntax
HTTP/1.1 200
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors.
- 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.
HTTP Status Code: 403
- FacetInUseException
-
Occurs when deleting a facet that contains an attribute that is a target to an attribute reference in a different facet.
HTTP Status Code: 400
- FacetNotFoundException
-
The specified Facet could not be found.
HTTP Status Code: 400
- 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. HTTP Status Code: 500
- InvalidArnException
-
Indicates that the provided ARN value is not valid.
HTTP Status Code: 400
- LimitExceededException
-
Indicates that limits are exceeded. See Limits for more information.
HTTP Status Code: 400
- ResourceNotFoundException
-
The specified resource could not be found.
HTTP Status Code: 404
- 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.
HTTP Status Code: 409
- ValidationException
-
Indicates that your request is malformed in some manner. See the exception message.
HTTP Status Code: 400
Examples
The following examples are formatted for legibility.
Example Request
This example illustrates one usage of DeleteFacet.
PUT /amazonclouddirectory/2017-01-11/facet/delete HTTP/1.1 Host: clouddirectory.us-west-2.amazonaws.com Accept-Encoding: identity Content-Length: 24 Authorization: AWS4-HMAC-SHA256 Credential=AKIAI7E3BYXS3example/20171009/us-west-2/clouddirectory/aws4_request, SignedHeaders=host;x-amz-data-partition;x-amz-date, Signature=67a330fb824e90451da06dd85e94ac37865044e9c933657a298457bd46660b07 x-amz-data-partition: arn:aws:clouddirectory:us-west-2:45132example:schema/development/exampleorgtest X-Amz-Date: 20171009T182210Z User-Agent: aws-cli/1.11.150 Python/2.7.9 Windows/8 botocore/1.7.8 { "Name": "Organization" }
Example Response
This example illustrates one usage of DeleteFacet.
HTTP/1.1 200 OK x-amzn-RequestId: c4f739ec-ad1e-11e7-a6de-b54884d62153 Date: Mon, 09 Oct 2017 18:22:11 GMT x-amzn-RequestId: c4f739ec-ad1e-11e7-a6de-b54884d62153 Content-Type: application/json Content-Length: 2 {}
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: