UpdateIntegration
Updates an existing integration, identified by its id, ARN, or name. Only the fields you provide are changed.
Request Parameters
- credential
-
The replacement credential used to authenticate with the provider.
Type: IntegrationCredential object
Note: This object is a Union. Only one member of this object can be specified or returned.
Required: No
- identifier
-
Identifies the integration to update — 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
- integrationAttributes
-
The provider-specific attributes to associate with the integration.
Type: String to string map
Key Length Constraints: Minimum length of 0. Maximum length of 128.
Value Length Constraints: Minimum length of 0. Maximum length of 4096.
Required: No
- roleArn
-
The Amazon Resource Name of the IAM role assumed to access the integration.
Type: String
Required: No
Response Elements
The following element is returned by the service.
- integration
-
The details of the updated integration. This is the same object returned by GetIntegration and CreateIntegration. Populated on a successful update; absent only if the post-update read-back of the resource did not complete.
Type: Integration object
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
- ResourceNotFoundException
-
The specified resource does not exist.
- errorCode
-
The error code associated with the failure.
- resourceId
-
The identifier of the resource that could not be found. Not always present.
- resourceType
-
The type of the resource that could not be found. Not always present.
HTTP Status Code: 404
- 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
Update an integration's attributes
The following example replaces the provider-specific attributes of the integration identified by its id. Payloads are shown as JSON; on the wire they are CBOR-encoded.
Sample Request
{
"identifier": {
"integrationId": "a1b2c3d4-5e6f-4a3b-8c9d-0e1f2a3b4c5d"
},
"integrationAttributes": {
"notificationChannel": "ops-oncall"
}
}
Sample Response
{
"integration": {
"createdAt": "2026-09-16T00:03:00Z",
"integrationArn": "arn:aws:cloudwatch:us-east-1:123456789012:integration/a1b2c3d4-5e6f-4a3b-8c9d-0e1f2a3b4c5d",
"integrationAttributes": {
"notificationChannel": "ops-oncall"
},
"integrationId": "a1b2c3d4-5e6f-4a3b-8c9d-0e1f2a3b4c5d",
"integrationType": "AWS_INTEGRATION",
"name": "my-aws-integration",
"status": "ACTIVE",
"updatedAt": "2026-09-16T12:00:00Z"
}
}
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: