AWS API Changes

2025/09/11 - Amazon DataZone - 4 updated api methods

Changes adding IAM principal id to IAM user profile details

CreateUserProfile (updated)

Link ¶
Changes (response)

{'details': {'iam': {'principalId': 'string'}}}

Creates a user profile in Amazon DataZone.

See also: AWS API Documentation

Request Syntax

client.create_user_profile(
    clientToken='string',
    domainIdentifier='string',
    userIdentifier='string',
    userType='IAM_USER'|'IAM_ROLE'|'SSO_USER'
)

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 domainIdentifier:

string

param domainIdentifier:

[REQUIRED]

The identifier of the Amazon DataZone domain in which a user profile is created.

type userIdentifier:

string

param userIdentifier:

[REQUIRED]

The identifier of the user for which the user profile is created.

type userType:

string

param userType:

The user type of the user for which the user profile is created.

rtype:

dict

returns:

Response Syntax

{
    'details': {
        'iam': {
            'arn': 'string',
            'principalId': 'string'
        },
        'sso': {
            'firstName': 'string',
            'lastName': 'string',
            'username': 'string'
        }
    },
    'domainId': 'string',
    'id': 'string',
    'status': 'ASSIGNED'|'NOT_ASSIGNED'|'ACTIVATED'|'DEACTIVATED',
    'type': 'IAM'|'SSO'
}

Response Structure

(dict) --
- details (dict) --
  
  The details of the user profile in Amazon DataZone.
  Note
  
  This is a Tagged Union structure. Only one of the following top level keys will be set: iam, sso. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
```
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
```
  - iam (dict) --
    
    The IAM details included in the user profile details.
    - arn (string) --
      
      The ARN of an IAM user profile in Amazon DataZone.
    - principalId (string) --
      
      Principal ID of the IAM user.
  - sso (dict) --
    
    The single sign-on details included in the user profile details.
    - firstName (string) --
      
      The first name included in the single sign-on details of the user profile.
    - lastName (string) --
      
      The last name included in the single sign-on details of the user profile.
    - username (string) --
      
      The username included in the single sign-on details of the user profile.
- domainId (string) --
  
  The identifier of the Amazon DataZone domain in which a user profile is created.
- id (string) --
  
  The identifier of the user profile.
- status (string) --
  
  The status of the user profile.
- type (string) --
  
  The type of the user profile.

GetUserProfile (updated)

Link ¶
Changes (response)

{'details': {'iam': {'principalId': 'string'}}}

Gets a user profile in Amazon DataZone.

See also: AWS API Documentation

Request Syntax

client.get_user_profile(
    domainIdentifier='string',
    type='IAM'|'SSO',
    userIdentifier='string'
)

type domainIdentifier:

string

param domainIdentifier:

[REQUIRED]

the ID of the Amazon DataZone domain the data portal of which you want to get.

type type:

string

param type:

The type of the user profile.

type userIdentifier:

string

param userIdentifier:

[REQUIRED]

The identifier of the user for which you want to get the user profile.

rtype:

dict

returns:

Response Syntax

{
    'details': {
        'iam': {
            'arn': 'string',
            'principalId': 'string'
        },
        'sso': {
            'firstName': 'string',
            'lastName': 'string',
            'username': 'string'
        }
    },
    'domainId': 'string',
    'id': 'string',
    'status': 'ASSIGNED'|'NOT_ASSIGNED'|'ACTIVATED'|'DEACTIVATED',
    'type': 'IAM'|'SSO'
}

Response Structure

(dict) --
- details (dict) --
  
  The details of the user profile in Amazon DataZone.
  Note
  
  This is a Tagged Union structure. Only one of the following top level keys will be set: iam, sso. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
```
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
```
  - iam (dict) --
    
    The IAM details included in the user profile details.
    - arn (string) --
      
      The ARN of an IAM user profile in Amazon DataZone.
    - principalId (string) --
      
      Principal ID of the IAM user.
  - sso (dict) --
    
    The single sign-on details included in the user profile details.
    - firstName (string) --
      
      The first name included in the single sign-on details of the user profile.
    - lastName (string) --
      
      The last name included in the single sign-on details of the user profile.
    - username (string) --
      
      The username included in the single sign-on details of the user profile.
- domainId (string) --
  
  the identifier of the Amazon DataZone domain of which you want to get the user profile.
- id (string) --
  
  The identifier of the user profile.
- status (string) --
  
  The status of the user profile.
- type (string) --
  
  The type of the user profile.

SearchUserProfiles (updated)

Link ¶
Changes (response)

{'items': {'details': {'iam': {'principalId': 'string'}}}}

Searches user profiles in Amazon DataZone.

See also: AWS API Documentation

Request Syntax

client.search_user_profiles(
    domainIdentifier='string',
    maxResults=123,
    nextToken='string',
    searchText='string',
    userType='SSO_USER'|'DATAZONE_USER'|'DATAZONE_SSO_USER'|'DATAZONE_IAM_USER'
)

type domainIdentifier:

string

param domainIdentifier:

[REQUIRED]

The identifier of the Amazon DataZone domain in which you want to search user profiles.

type maxResults:

integer

param maxResults:

The maximum number of results to return in a single call to SearchUserProfiles. When the number of results to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to SearchUserProfiles to list the next set of results.

type nextToken:

string

param nextToken:

When the number of results is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of results, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to SearchUserProfiles to list the next set of results.

type searchText:

string

param searchText:

Specifies the text for which to search.

type userType:

string

param userType:

[REQUIRED]

Specifies the user type for the SearchUserProfiles action.

rtype:

dict

returns:

Response Syntax

{
    'items': [
        {
            'details': {
                'iam': {
                    'arn': 'string',
                    'principalId': 'string'
                },
                'sso': {
                    'firstName': 'string',
                    'lastName': 'string',
                    'username': 'string'
                }
            },
            'domainId': 'string',
            'id': 'string',
            'status': 'ASSIGNED'|'NOT_ASSIGNED'|'ACTIVATED'|'DEACTIVATED',
            'type': 'IAM'|'SSO'
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) --
- items (list) --
  
  The results of the SearchUserProfiles action.
  - (dict) --
    
    The details of the user profile.
    - details (dict) --
      
      The details of the user profile.
      Note
      
      This is a Tagged Union structure. Only one of the following top level keys will be set: iam, sso. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
      
      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      - iam (dict) --
        
        The IAM details included in the user profile details.
        
        arn (string) --
        
        The ARN of an IAM user profile in Amazon DataZone.
        
        principalId (string) --
        
        Principal ID of the IAM user.
      - sso (dict) --
        
        The single sign-on details included in the user profile details.
        
        firstName (string) --
        
        The first name included in the single sign-on details of the user profile.
        
        lastName (string) --
        
        The last name included in the single sign-on details of the user profile.
        
        username (string) --
        
        The username included in the single sign-on details of the user profile.
    - domainId (string) --
      
      The ID of the Amazon DataZone domain of the user profile.
    - id (string) --
      
      The ID of the user profile.
    - status (string) --
      
      The status of the user profile.
    - type (string) --
      
      The type of the user profile.
- nextToken (string) --
  
  When the number of results is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of results, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to SearchUserProfiles to list the next set of results.

UpdateUserProfile (updated)

Link ¶
Changes (response)

{'details': {'iam': {'principalId': 'string'}}}

Updates the specified user profile in Amazon DataZone.

See also: AWS API Documentation

Request Syntax

client.update_user_profile(
    domainIdentifier='string',
    status='ASSIGNED'|'NOT_ASSIGNED'|'ACTIVATED'|'DEACTIVATED',
    type='IAM'|'SSO',
    userIdentifier='string'
)

type domainIdentifier:

string

param domainIdentifier:

[REQUIRED]

The identifier of the Amazon DataZone domain in which a user profile is updated.

type status:

string

param status:

[REQUIRED]

The status of the user profile that are to be updated.

type type:

string

param type:

The type of the user profile that are to be updated.

type userIdentifier:

string

param userIdentifier:

[REQUIRED]

The identifier of the user whose user profile is to be updated.

rtype:

dict

returns:

Response Syntax

{
    'details': {
        'iam': {
            'arn': 'string',
            'principalId': 'string'
        },
        'sso': {
            'firstName': 'string',
            'lastName': 'string',
            'username': 'string'
        }
    },
    'domainId': 'string',
    'id': 'string',
    'status': 'ASSIGNED'|'NOT_ASSIGNED'|'ACTIVATED'|'DEACTIVATED',
    'type': 'IAM'|'SSO'
}

Response Structure

(dict) --
- details (dict) --
  
  The details of the user profile in Amazon DataZone.
  Note
  
  This is a Tagged Union structure. Only one of the following top level keys will be set: iam, sso. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
```
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
```
  - iam (dict) --
    
    The IAM details included in the user profile details.
    - arn (string) --
      
      The ARN of an IAM user profile in Amazon DataZone.
    - principalId (string) --
      
      Principal ID of the IAM user.
  - sso (dict) --
    
    The single sign-on details included in the user profile details.
    - firstName (string) --
      
      The first name included in the single sign-on details of the user profile.
    - lastName (string) --
      
      The last name included in the single sign-on details of the user profile.
    - username (string) --
      
      The username included in the single sign-on details of the user profile.
- domainId (string) --
  
  The identifier of the Amazon DataZone domain in which a user profile is updated.
- id (string) --
  
  The identifier of the user profile.
- status (string) --
  
  The status of the user profile.
- type (string) --
  
  The type of the user profile.