DataZone / Client / update_domain

update_domain#

DataZone.Client.update_domain(**kwargs)#

Updates a Amazon DataZone domain.

See also: AWS API Documentation

Request Syntax

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

  • clientToken (string) –

    A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

    This field is autopopulated if not provided.

  • description (string) – The description to be updated as part of the UpdateDomain action.

  • domainExecutionRole (string) – The domain execution role to be updated as part of the UpdateDomain action.

  • identifier (string) –

    [REQUIRED]

    The ID of the Amazon Web Services domain that is to be updated.

  • name (string) – The name to be updated as part of the UpdateDomain action.

  • serviceRole (string) – The service role of the domain.

  • 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.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • description (string) –

      The description to be updated as part of the UpdateDomain action.

    • domainExecutionRole (string) –

      The domain execution role to be updated as part of the UpdateDomain action.

    • id (string) –

      The identifier of the Amazon DataZone domain.

    • lastUpdatedAt (datetime) –

      Specifies the timestamp of when the domain was last updated.

    • name (string) –

      The name to be updated as part of the UpdateDomain action.

    • rootDomainUnitId (string) –

      The ID of the root domain unit.

    • serviceRole (string) –

      The service role of the domain.

    • 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.

Exceptions