View a markdown version of this page

DeleteIntegration - Amazon CloudWatch Omni

DeleteIntegration

Deletes an integration. Returns the resulting status.

Request Parameters

identifier

Identifies the integration to delete — exactly one of integrationId, integrationArn, or integrationName.

Type: IntegrationIdentifier object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: Yes

Errors

For information about the errors that are common to all actions, see Common Error Types.

AccessDeniedException

The caller is not authorized to perform this action.

HTTP Status Code: 403

InternalServerException

An unexpected error occurred while processing the request.

errorCode

The error code associated with the internal error.

HTTP Status Code: 500

ThrottlingException

The request was throttled due to exceeding the allowed request rate.

retryAfterSeconds

The number of seconds to wait before retrying the request. Not always present.

HTTP Status Code: 429

ValidationException

A parameter is specified incorrectly.

errorCode

The error code associated with the validation failure.

HTTP Status Code: 400

Examples

Delete an integration by id

The following example deletes the integration identified by its id. DeleteIntegration is idempotent and returns an empty response. Payloads are shown as JSON; on the wire they are CBOR-encoded.

Sample Request

{ "identifier": { "integrationId": "a1b2c3d4-5e6f-4a3b-8c9d-0e1f2a3b4c5d" } }

Sample Response

{}

See Also

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