DataZone / Client / update_domain

update_domain¶

DataZone.Client.update_domain(**kwargs)¶

Updates a Amazon DataZone domain.

Request Syntax

response = client.update_domain(
    identifier='string',
    description='string',
    singleSignOn={
        'type': 'IAM_IDC'|'DISABLED',
        'userAssignment': 'AUTOMATIC'|'MANUAL',
        'idcInstanceArn': 'string'
    },
    domainExecutionRole='string',
    serviceRole='string',
    name='string',
    clientToken='string'
)

Parameters:

identifier (string) –
[REQUIRED]

The ID of the Amazon Web Services domain that is to be updated.
description (string) – The description to be updated as part of the UpdateDomain action.
singleSignOn (dict) –
The single sign-on option to be updated as part of the UpdateDomain action.
- type (string) –
  
  The type of single sign-on in Amazon DataZone.
- userAssignment (string) –
  
  The single sign-on user assignment in Amazon DataZone.
- idcInstanceArn (string) –
  
  The ARN of the IDC instance.
domainExecutionRole (string) – The domain execution role to be updated as part of the UpdateDomain action.
serviceRole (string) – The service role of the domain.
name (string) – The name to be updated as part of the UpdateDomain action.
clientToken (string) –
A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

This field is autopopulated if not provided.

Return type:

dict

Returns:

Response Syntax

{
    'id': 'string',
    'rootDomainUnitId': 'string',
    'description': 'string',
    'singleSignOn': {
        'type': 'IAM_IDC'|'DISABLED',
        'userAssignment': 'AUTOMATIC'|'MANUAL',
        'idcInstanceArn': 'string'
    },
    'domainExecutionRole': 'string',
    'serviceRole': 'string',
    'name': 'string',
    'lastUpdatedAt': datetime(2015, 1, 1)
}

Response Structure

(dict) –
- id (string) –
  
  The identifier of the Amazon DataZone domain.
- rootDomainUnitId (string) –
  
  The ID of the root domain unit.
- description (string) –
  
  The description to be updated as part of the UpdateDomain action.
- singleSignOn (dict) –
  
  The single sign-on option of the Amazon DataZone domain.
  - type (string) –
    
    The type of single sign-on in Amazon DataZone.
  - userAssignment (string) –
    
    The single sign-on user assignment in Amazon DataZone.
  - idcInstanceArn (string) –
    
    The ARN of the IDC instance.
- domainExecutionRole (string) –
  
  The domain execution role to be updated as part of the UpdateDomain action.
- serviceRole (string) –
  
  The service role of the domain.
- name (string) –
  
  The name to be updated as part of the UpdateDomain action.
- lastUpdatedAt (datetime) –
  
  Specifies the timestamp of when the domain was last updated.

Exceptions

DataZone.Client.exceptions.InternalServerException
DataZone.Client.exceptions.ResourceNotFoundException
DataZone.Client.exceptions.AccessDeniedException
DataZone.Client.exceptions.ThrottlingException
DataZone.Client.exceptions.ServiceQuotaExceededException
DataZone.Client.exceptions.ConflictException
DataZone.Client.exceptions.ValidationException
DataZone.Client.exceptions.UnauthorizedException