CloudWatchOmni / Client / get_domain_for_organization

get_domain_for_organization¶

CloudWatchOmni.Client.get_domain_for_organization(**kwargs)¶

Retrieves the details of an organization domain by ID.

Request Syntax

response = client.get_domain_for_organization(
    domainId='string'
)

Parameters:

domainId (string) –

[REQUIRED]

The ID of the organization domain.

Return type:

dict

Returns:

Response Syntax

{
    'organizationDomain': {
        'domainId': 'string',
        'domainArn': 'string',
        'name': 'string',
        'domainEndpointUrl': 'string',
        'customEndpointUrls': [
            'string',
        ],
        'organizationId': 'string',
        'ownerAccountId': 'string',
        'identityProviders': [
            'IAM'|'IDC',
        ],
        'identityProviderConfiguration': {
            'identityCenterConfiguration': {
                'identityCenterInstanceArn': 'string'
            }
        },
        'identityCenterApplicationArn': 'string',
        'region': 'string',
        'status': 'ACTIVE',
        'domainAccessRoleArn': 'string',
        'createdAt': datetime(2015, 1, 1),
        'updatedAt': datetime(2015, 1, 1)
    }
}

Response Structure

(dict) –
- organizationDomain (dict) –
  
  The details of the organization domain.
  - domainId (string) –
    
    The unique ID of the organization domain.
  - domainArn (string) –
    
    The Amazon Resource Name (ARN) of the organization domain.
  - name (string) –
    
    A name that identifies the organization domain.
  - domainEndpointUrl (string) –
    
    The HTTPS endpoint URL for accessing the organization domain.
  - customEndpointUrls (list) –
    
    Additional endpoint URLs derived from the domain name.
    - (string) –
  - organizationId (string) –
    
    The ID of the AWS Organization that owns the domain.
  - ownerAccountId (string) –
    
    The AWS account ID that owns the organization domain.
  - identityProviders (list) –
    
    The identity providers configured for the organization domain.
    - (string) –
      
      Identity provider type for a domain. Determines which identity mechanisms are active for authentication.
  - identityProviderConfiguration (dict) –
    
    Identity provider configuration for the organization domain.
    - identityCenterConfiguration (dict) –
      
      Identity Center configuration. Required when identityProviders includes IDC.
      - identityCenterInstanceArn (string) –
        
        Identity Center instance ARN
  - identityCenterApplicationArn (string) –
    
    The ARN of the Identity Center application. Absent for IAM-only domains.
  - region (string) –
    
    The Region where this organization domain was created.
  - status (string) –
    
    Current status of the organization domain.
  - domainAccessRoleArn (string) –
    
    The ARN of the customer-provided IAM role in the management account used for domain access.
  - createdAt (datetime) –
    
    The timestamp when the organization domain was created.
  - updatedAt (datetime) –
    
    The timestamp when the organization domain was last updated.

Exceptions

CloudWatchOmni.Client.exceptions.ThrottlingException
CloudWatchOmni.Client.exceptions.ValidationException
CloudWatchOmni.Client.exceptions.ResourceNotFoundException
CloudWatchOmni.Client.exceptions.AccessDeniedException
CloudWatchOmni.Client.exceptions.InternalServerException