GetIntegration
Returns the details of a single integration, identified by its identifier, Amazon Resource Name, or name.
Request Parameters
- identifier
-
Identifies the integration to return — 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
Response Elements
The following element is returned by the service.
- integration
-
The details of the requested integration.
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
Get an integration by id
The following example returns the integration with the given id. Payloads are shown as JSON; on the wire they are CBOR-encoded.
Sample Request
{
"identifier": {
"integrationId": "a1b2c3d4-5e6f-4a3b-8c9d-0e1f2a3b4c5d"
}
}
Sample Response
{
"integration": {
"createdAt": "2026-09-16T00:03:00Z",
"integrationArn": "arn:aws:cloudwatch:us-east-1:123456789012:integration/a1b2c3d4-5e6f-4a3b-8c9d-0e1f2a3b4c5d",
"integrationId": "a1b2c3d4-5e6f-4a3b-8c9d-0e1f2a3b4c5d",
"integrationType": "AWS_INTEGRATION",
"name": "my-aws-integration",
"roleArn": "arn:aws:iam::123456789012:role/service-role/CloudWatchIntegrationRole",
"status": "ACTIVE",
"updatedAt": "2026-09-16T00:03:00Z"
}
}
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: