View a markdown version of this page

GetDomainForOrganization - Amazon CloudWatch Omni

GetDomainForOrganization

Retrieves the details of an organization domain by ID.

Request Parameters

domainId

The ID of the organization domain.

Type: String

Pattern: d-[0-9a-z]{1,25}

Required: Yes

Response Elements

The following element is returned by the service.

organizationDomain

The details of the organization domain.

Type: OrganizationDomain 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 organization domain

The following example retrieves the configuration and status of an organization-scoped domain by its ID. Payloads are shown as JSON; on the wire they are CBOR-encoded.

Sample Request

{ "domainId": "d-9z8y7x6w5v" }

Sample Response

{ "organizationDomain": { "createdAt": "2026-09-16T14:22:31Z", "customEndpointUrls": [ "https://prod-observability-org.cloudwatch-omni.global.app.aws" ], "domainAccessRoleArn": "arn:aws:iam::123456789012:role/CloudWatchOrganizationDomainAccessRole", "domainArn": "arn:aws:cloudwatch:us-east-1:123456789012:organization-domain/d-9z8y7x6w5v", "domainEndpointUrl": "https://d-9z8y7x6w5v.cloudwatch-omni.global.app.aws", "domainId": "d-9z8y7x6w5v", "identityCenterApplicationArn": "arn:aws:sso::123456789012:application/ssoins-1234567890abcdef/apl-0f9e8d7c6b5a4938", "identityProviderConfiguration": { "identityCenterConfiguration": { "identityCenterInstanceArn": "arn:aws:sso:::instance/ssoins-1234567890abcdef" } }, "identityProviders": [ "IDC" ], "name": "prod-observability-org", "organizationId": "o-a1b2c3d4e5", "ownerAccountId": "123456789012", "region": "us-east-1", "status": "ACTIVE", "updatedAt": "2026-09-16T14:22:31Z" } }

See Also

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