CloudWatchOmni / Client / update_domain

update_domain¶

CloudWatchOmni.Client.update_domain(**kwargs)¶

Updates a domain’s name or identity provider configuration.

Only the provided fields are changed; omitted fields are left unchanged. Renaming a domain also changes the endpoint URLs derived from its name.

Request Syntax

response = client.update_domain(
    domainId='string',
    name='string',
    identityProviders=[
        'IAM'|'IDC',
    ],
    identityProviderConfiguration={
        'identityCenterConfiguration': {
            'identityCenterInstanceArn': 'string'
        }
    }
)

Parameters:

domainId (string) –
[REQUIRED]

The unique ID of the domain to update.
name (string) – A new name for the domain. Omit to leave unchanged. Must be 3-63 characters: lowercase letters, numbers, and hyphens. It must begin and end with a letter or number and cannot contain consecutive hyphens.
identityProviders (list) –
The identity providers to configure for the domain.
- (string) –
  
  Identity provider type for a domain. Determines which identity mechanisms are active for authentication.
identityProviderConfiguration (dict) –
Identity provider configuration for the domain.
- identityCenterConfiguration (dict) –
  
  Identity Center configuration. Required when identityProviders includes IDC.
  - identityCenterInstanceArn (string) –
    
    Identity Center instance ARN

Return type:

dict

Returns:

Response Syntax

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

Response Structure

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

Exceptions

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