AWS API Changes

2025/03/21 - Amazon DataZone - 3 updated api methods

Changes Add support for overriding selection of default AWS IAM Identity Center instance as part of Amazon DataZone domain APIs.

CreateDomain (updated)

Link ¶
Changes (both)

{'singleSignOn': {'idcInstanceArn': 'string'}}

Creates an Amazon DataZone domain.

See also: AWS API Documentation

Request Syntax

client.create_domain(
    clientToken='string',
    description='string',
    domainExecutionRole='string',
    domainVersion='V1'|'V2',
    kmsKeyIdentifier='string',
    name='string',
    serviceRole='string',
    singleSignOn={
        'idcInstanceArn': 'string',
        'type': 'IAM_IDC'|'DISABLED',
        'userAssignment': 'AUTOMATIC'|'MANUAL'
    },
    tags={
        'string': 'string'
    }
)

type clientToken:

string

param clientToken:

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

This field is autopopulated if not provided.

type description:

string

param description:

The description of the Amazon DataZone domain.

type domainExecutionRole:

string

param domainExecutionRole:

[REQUIRED]

The domain execution role that is created when an Amazon DataZone domain is created. The domain execution role is created in the Amazon Web Services account that houses the Amazon DataZone domain.

type domainVersion:

string

param domainVersion:

The version of the domain that is created.

type kmsKeyIdentifier:

string

param kmsKeyIdentifier:

The identifier of the Amazon Web Services Key Management Service (KMS) key that is used to encrypt the Amazon DataZone domain, metadata, and reporting data.

type name:

string

param name:

[REQUIRED]

The name of the Amazon DataZone domain.

type serviceRole:

string

param serviceRole:

The service role of the domain that is created.

type singleSignOn:

dict

param singleSignOn:

The single-sign on configuration of the Amazon DataZone domain.

idcInstanceArn (string) --

The ARN of the IDC instance.
type (string) --

The type of single sign-on in Amazon DataZone.
userAssignment (string) --

The single sign-on user assignment in Amazon DataZone.

type tags:

dict

param tags:

The tags specified for the Amazon DataZone domain.

(string) --
- (string) --

rtype:

dict

returns:

Response Syntax

{
    'arn': 'string',
    'description': 'string',
    'domainExecutionRole': 'string',
    'domainVersion': 'V1'|'V2',
    'id': 'string',
    'kmsKeyIdentifier': 'string',
    'name': 'string',
    'portalUrl': 'string',
    'rootDomainUnitId': 'string',
    'serviceRole': 'string',
    'singleSignOn': {
        'idcInstanceArn': 'string',
        'type': 'IAM_IDC'|'DISABLED',
        'userAssignment': 'AUTOMATIC'|'MANUAL'
    },
    'status': 'CREATING'|'AVAILABLE'|'CREATION_FAILED'|'DELETING'|'DELETED'|'DELETION_FAILED',
    'tags': {
        'string': 'string'
    }
}

Response Structure

(dict) --
- arn (string) --
  
  The ARN of the Amazon DataZone domain.
- description (string) --
  
  The description of the Amazon DataZone domain.
- domainExecutionRole (string) --
  
  The domain execution role that is created when an Amazon DataZone domain is created. The domain execution role is created in the Amazon Web Services account that houses the Amazon DataZone domain.
- domainVersion (string) --
  
  The version of the domain that is created.
- id (string) --
  
  The identifier of the Amazon DataZone domain.
- kmsKeyIdentifier (string) --
  
  The identifier of the Amazon Web Services Key Management Service (KMS) key that is used to encrypt the Amazon DataZone domain, metadata, and reporting data.
- name (string) --
  
  The name of the Amazon DataZone domain.
- portalUrl (string) --
  
  The URL of the data portal for this Amazon DataZone domain.
- rootDomainUnitId (string) --
  
  The ID of the root domain unit.
- serviceRole (string) --
  
  Te service role of the domain that is created.
- singleSignOn (dict) --
  
  The single-sign on configuration of the Amazon DataZone domain.
  - idcInstanceArn (string) --
    
    The ARN of the IDC instance.
  - type (string) --
    
    The type of single sign-on in Amazon DataZone.
  - userAssignment (string) --
    
    The single sign-on user assignment in Amazon DataZone.
- status (string) --
  
  The status of the Amazon DataZone domain.
- tags (dict) --
  
  The tags specified for the Amazon DataZone domain.
  - (string) --
    - (string) --

GetDomain (updated)

Link ¶
Changes (response)

{'singleSignOn': {'idcInstanceArn': 'string'}}

Gets an Amazon DataZone domain.

See also: AWS API Documentation

Request Syntax

client.get_domain(
    identifier='string'
)

type identifier:

string

param identifier:

[REQUIRED]

The identifier of the specified Amazon DataZone domain.

rtype:

dict

returns:

Response Syntax

{
    'arn': 'string',
    'createdAt': datetime(2015, 1, 1),
    'description': 'string',
    'domainExecutionRole': 'string',
    'domainVersion': 'V1'|'V2',
    'id': 'string',
    'kmsKeyIdentifier': 'string',
    'lastUpdatedAt': datetime(2015, 1, 1),
    'name': 'string',
    'portalUrl': 'string',
    'rootDomainUnitId': 'string',
    'serviceRole': 'string',
    'singleSignOn': {
        'idcInstanceArn': 'string',
        'type': 'IAM_IDC'|'DISABLED',
        'userAssignment': 'AUTOMATIC'|'MANUAL'
    },
    'status': 'CREATING'|'AVAILABLE'|'CREATION_FAILED'|'DELETING'|'DELETED'|'DELETION_FAILED',
    'tags': {
        'string': 'string'
    }
}

Response Structure

(dict) --
- arn (string) --
  
  The ARN of the specified Amazon DataZone domain.
- createdAt (datetime) --
  
  The timestamp of when the Amazon DataZone domain was created.
- description (string) --
  
  The description of the Amazon DataZone domain.
- domainExecutionRole (string) --
  
  The domain execution role with which the Amazon DataZone domain is created.
- domainVersion (string) --
  
  The version of the domain.
- id (string) --
  
  The identifier of the specified Amazon DataZone domain.
- kmsKeyIdentifier (string) --
  
  The identifier of the Amazon Web Services Key Management Service (KMS) key that is used to encrypt the Amazon DataZone domain, metadata, and reporting data.
- lastUpdatedAt (datetime) --
  
  The timestamp of when the Amazon DataZone domain was last updated.
- name (string) --
  
  The name of the Amazon DataZone domain.
- portalUrl (string) --
  
  The URL of the data portal for this Amazon DataZone domain.
- rootDomainUnitId (string) --
  
  The ID of the root domain in Amazon Datazone.
- serviceRole (string) --
  
  The service role of the domain.
- singleSignOn (dict) --
  
  The single sing-on option of the specified Amazon DataZone domain.
  - idcInstanceArn (string) --
    
    The ARN of the IDC instance.
  - type (string) --
    
    The type of single sign-on in Amazon DataZone.
  - userAssignment (string) --
    
    The single sign-on user assignment in Amazon DataZone.
- status (string) --
  
  The status of the specified Amazon DataZone domain.
- tags (dict) --
  
  The tags specified for the Amazon DataZone domain.
  - (string) --
    - (string) --

UpdateDomain (updated)

Link ¶
Changes (both)

{'singleSignOn': {'idcInstanceArn': 'string'}}

Updates a Amazon DataZone domain.

See also: AWS API Documentation

Request Syntax

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

type clientToken:

string

param clientToken:

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

This field is autopopulated if not provided.

type description:

string

param description:

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

type domainExecutionRole:

string

param domainExecutionRole:

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

type identifier:

string

param identifier:

[REQUIRED]

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

type name:

string

param name:

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

type serviceRole:

string

param serviceRole:

The service role of the domain.

type singleSignOn:

dict

param singleSignOn:

The single sign-on option to be updated as part of the UpdateDomain action.

idcInstanceArn (string) --

The ARN of the IDC instance.
type (string) --

The type of single sign-on in Amazon DataZone.
userAssignment (string) --

The single sign-on user assignment in Amazon DataZone.

rtype:

dict

returns:

Response Syntax

{
    'description': 'string',
    'domainExecutionRole': 'string',
    'id': 'string',
    'lastUpdatedAt': datetime(2015, 1, 1),
    'name': 'string',
    'rootDomainUnitId': 'string',
    'serviceRole': 'string',
    'singleSignOn': {
        'idcInstanceArn': 'string',
        '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.
  - idcInstanceArn (string) --
    
    The ARN of the IDC instance.
  - type (string) --
    
    The type of single sign-on in Amazon DataZone.
  - userAssignment (string) --
    
    The single sign-on user assignment in Amazon DataZone.