DeleteResourceDataSync - AWS Systems Manager

DeleteResourceDataSync

Deletes a resource data sync configuration. After the configuration is deleted, changes to data on managed nodes are no longer synced to or from the target. Deleting a sync configuration doesn't delete data.

Request Syntax

{ "SyncName": "string", "SyncType": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

SyncName

The name of the configuration to delete.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Required: Yes

SyncType

Specify the type of resource data sync to delete.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Required: No

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.

InternalServerError

An error occurred on the server side.

HTTP Status Code: 500

ResourceDataSyncInvalidConfigurationException

The specified sync configuration is invalid.

HTTP Status Code: 400

ResourceDataSyncNotFoundException

The specified sync name wasn't found.

HTTP Status Code: 400

Examples

Example

This example illustrates one usage of DeleteResourceDataSync.

Sample Request

POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity X-Amz-Target: AmazonSSM.DeleteResourceDataSync Content-Type: application/x-amz-json-1.1 User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12 X-Amz-Date: 20240330T144518Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240330/us-east-2/ssm/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE Content-Length: 28 { "SyncName": "exampleSync" }

Sample Response

{}

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: