AWS API Changes

2024/01/30 - Amazon DataZone - 6 updated api methods

Changes Add new skipDeletionCheck to DeleteDomain. Add new skipDeletionCheck to DeleteProject which also automatically deletes dependent objects

CreateProject (updated)

Link ¶
Changes (response)

{'failureReasons': [{'code': 'string', 'message': 'string'}],
 'projectStatus': 'ACTIVE | DELETING | DELETE_FAILED'}

Creates an Amazon DataZone project.

See also: AWS API Documentation

Request Syntax

client.create_project(
    description='string',
    domainIdentifier='string',
    glossaryTerms=[
        'string',
    ],
    name='string'
)

type description:

string

param description:

The description of the Amazon DataZone project.

type domainIdentifier:

string

param domainIdentifier:

[REQUIRED]

The ID of the Amazon DataZone domain in which this project is created.

type glossaryTerms:

list

param glossaryTerms:

The glossary terms that can be used in this Amazon DataZone project.

(string) --

type name:

string

param name:

[REQUIRED]

The name of the Amazon DataZone project.

rtype:

dict

returns:

Response Syntax

{
    'createdAt': datetime(2015, 1, 1),
    'createdBy': 'string',
    'description': 'string',
    'domainId': 'string',
    'failureReasons': [
        {
            'code': 'string',
            'message': 'string'
        },
    ],
    'glossaryTerms': [
        'string',
    ],
    'id': 'string',
    'lastUpdatedAt': datetime(2015, 1, 1),
    'name': 'string',
    'projectStatus': 'ACTIVE'|'DELETING'|'DELETE_FAILED'
}

Response Structure

(dict) --
- createdAt (datetime) --
  
  The timestamp of when the project was created.
- createdBy (string) --
  
  The Amazon DataZone user who created the project.
- description (string) --
  
  The description of the project.
- domainId (string) --
  
  The identifier of the Amazon DataZone domain in which the project was created.
- failureReasons (list) --
  
  Reasons for failed project deletion
  - (dict) --
    
    Error that occurred during project deletion
    - code (string) --
      
      Project Deletion Error Code
    - message (string) --
      
      Project Deletion Error Message
- glossaryTerms (list) --
  
  The glossary terms that can be used in the project.
  - (string) --
- id (string) --
  
  The ID of the Amazon DataZone project.
- lastUpdatedAt (datetime) --
  
  The timestamp of when the project was last updated.
- name (string) --
  
  The name of the project.
- projectStatus (string) --
  
  Status of the project

DeleteDomain (updated)

Link ¶
Changes (request)

{'skipDeletionCheck': 'boolean'}

Deletes a Amazon DataZone domain.

See also: AWS API Documentation

Request Syntax

client.delete_domain(
    clientToken='string',
    identifier='string',
    skipDeletionCheck=True|False
)

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

string

param identifier:

[REQUIRED]

The identifier of the Amazon Web Services domain that is to be deleted.

type skipDeletionCheck:

boolean

param skipDeletionCheck:

Optional flag to delete all child entities within the domain

rtype:

dict

returns:

Response Syntax

{
    'status': 'CREATING'|'AVAILABLE'|'CREATION_FAILED'|'DELETING'|'DELETED'|'DELETION_FAILED'
}

Response Structure

(dict) --
- status (string) --
  
  The status of the domain.

DeleteProject (updated)

Link ¶
Changes (request)

{'skipDeletionCheck': 'boolean'}

Deletes a project in Amazon DataZone.

See also: AWS API Documentation

Request Syntax

client.delete_project(
    domainIdentifier='string',
    identifier='string',
    skipDeletionCheck=True|False
)

type domainIdentifier:

string

param domainIdentifier:

[REQUIRED]

The ID of the Amazon DataZone domain in which the project is deleted.

type identifier:

string

param identifier:

[REQUIRED]

The identifier of the project that is to be deleted.

type skipDeletionCheck:

boolean

param skipDeletionCheck:

Optional flag to asynchronously delete child entities within the project

rtype:

dict

returns:

Response Syntax

{}

Response Structure

(dict) --

GetProject (updated)

Link ¶
Changes (response)

{'failureReasons': [{'code': 'string', 'message': 'string'}],
 'projectStatus': 'ACTIVE | DELETING | DELETE_FAILED'}

Gets a project in Amazon DataZone.

See also: AWS API Documentation

Request Syntax

client.get_project(
    domainIdentifier='string',
    identifier='string'
)

type domainIdentifier:

string

param domainIdentifier:

[REQUIRED]

The ID of the Amazon DataZone domain in which the project exists.

type identifier:

string

param identifier:

[REQUIRED]

The ID of the project.

rtype:

dict

returns:

Response Syntax

{
    'createdAt': datetime(2015, 1, 1),
    'createdBy': 'string',
    'description': 'string',
    'domainId': 'string',
    'failureReasons': [
        {
            'code': 'string',
            'message': 'string'
        },
    ],
    'glossaryTerms': [
        'string',
    ],
    'id': 'string',
    'lastUpdatedAt': datetime(2015, 1, 1),
    'name': 'string',
    'projectStatus': 'ACTIVE'|'DELETING'|'DELETE_FAILED'
}

Response Structure

(dict) --
- createdAt (datetime) --
  
  The timestamp of when the project was created.
- createdBy (string) --
  
  The Amazon DataZone user who created the project.
- description (string) --
  
  The description of the project.
- domainId (string) --
  
  The ID of the Amazon DataZone domain in which the project exists.
- failureReasons (list) --
  
  Reasons for failed project deletion
  - (dict) --
    
    Error that occurred during project deletion
    - code (string) --
      
      Project Deletion Error Code
    - message (string) --
      
      Project Deletion Error Message
- glossaryTerms (list) --
  
  The business glossary terms that can be used in the project.
  - (string) --
- id (string) --
  
  >The ID of the project.
- lastUpdatedAt (datetime) --
  
  The timestamp of when the project was last updated.
- name (string) --
  
  The name of the project.
- projectStatus (string) --
  
  Status of the project

ListProjects (updated)

Link ¶
Changes (response)

{'items': {'failureReasons': [{'code': 'string', 'message': 'string'}],
           'projectStatus': 'ACTIVE | DELETING | DELETE_FAILED'}}

Lists Amazon DataZone projects.

See also: AWS API Documentation

Request Syntax

client.list_projects(
    domainIdentifier='string',
    groupIdentifier='string',
    maxResults=123,
    name='string',
    nextToken='string',
    userIdentifier='string'
)

type domainIdentifier:

string

param domainIdentifier:

[REQUIRED]

The identifier of the Amazon DataZone domain.

type groupIdentifier:

string

param groupIdentifier:

The identifier of a group.

type maxResults:

integer

param maxResults:

The maximum number of projects to return in a single call to ListProjects. When the number of projects 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 ListProjects to list the next set of projects.

type name:

string

param name:

type nextToken:

string

param nextToken:

When the number of projects 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 projects, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListProjects to list the next set of projects.

type userIdentifier:

string

param userIdentifier:

The identifier of the Amazon DataZone user.

rtype:

dict

returns:

Response Syntax

{
    'items': [
        {
            'createdAt': datetime(2015, 1, 1),
            'createdBy': 'string',
            'description': 'string',
            'domainId': 'string',
            'failureReasons': [
                {
                    'code': 'string',
                    'message': 'string'
                },
            ],
            'id': 'string',
            'name': 'string',
            'projectStatus': 'ACTIVE'|'DELETING'|'DELETE_FAILED',
            'updatedAt': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) --
- items (list) --
  
  The results of the ListProjects action.
  - (dict) --
    
    The details of a Amazon DataZone project.
    - createdAt (datetime) --
      
      The timestamp of when a project was created.
    - createdBy (string) --
      
      The Amazon DataZone user who created the project.
    - description (string) --
      
      The description of a project.
    - domainId (string) --
      
      The identifier of a Amazon DataZone domain where the project exists.
    - failureReasons (list) --
      
      Reasons for failed project deletion
      - (dict) --
        
        Error that occurred during project deletion
        
        code (string) --
        
        Project Deletion Error Code
        
        message (string) --
        
        Project Deletion Error Message
    - id (string) --
      
      The identifier of a project.
    - name (string) --
      
      The name of a project.
    - projectStatus (string) --
      
      Status of the project
    - updatedAt (datetime) --
      
      The timestamp of when the project was updated.
- nextToken (string) --
  
  When the number of projects 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 projects, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListProjects to list the next set of projects.

UpdateProject (updated)

Link ¶
Changes (response)

{'failureReasons': [{'code': 'string', 'message': 'string'}],
 'projectStatus': 'ACTIVE | DELETING | DELETE_FAILED'}

Updates the specified project in Amazon DataZone.

See also: AWS API Documentation

Request Syntax

client.update_project(
    description='string',
    domainIdentifier='string',
    glossaryTerms=[
        'string',
    ],
    identifier='string',
    name='string'
)

type description:

string

param description:

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

type domainIdentifier:

string

param domainIdentifier:

[REQUIRED]

The identifier of the Amazon DataZone domain in which a project is to be updated.

type glossaryTerms:

list

param glossaryTerms:

The glossary terms to be updated as part of the UpdateProject action.

(string) --

type identifier:

string

param identifier:

[REQUIRED]

The identifier of the project that is to be updated.

type name:

string

param name:

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

rtype:

dict

returns:

Response Syntax

{
    'createdAt': datetime(2015, 1, 1),
    'createdBy': 'string',
    'description': 'string',
    'domainId': 'string',
    'failureReasons': [
        {
            'code': 'string',
            'message': 'string'
        },
    ],
    'glossaryTerms': [
        'string',
    ],
    'id': 'string',
    'lastUpdatedAt': datetime(2015, 1, 1),
    'name': 'string',
    'projectStatus': 'ACTIVE'|'DELETING'|'DELETE_FAILED'
}

Response Structure

(dict) --
- createdAt (datetime) --
  
  The timestamp of when the project was created.
- createdBy (string) --
  
  The Amazon DataZone user who created the project.
- description (string) --
  
  The description of the project that is to be updated.
- domainId (string) --
  
  The identifier of the Amazon DataZone domain in which a project is updated.
- failureReasons (list) --
  
  Reasons for failed project deletion
  - (dict) --
    
    Error that occurred during project deletion
    - code (string) --
      
      Project Deletion Error Code
    - message (string) --
      
      Project Deletion Error Message
- glossaryTerms (list) --
  
  The glossary terms of the project that are to be updated.
  - (string) --
- id (string) --
  
  The identifier of the project that is to be updated.
- lastUpdatedAt (datetime) --
  
  The timestamp of when the project was last updated.
- name (string) --
  
  The name of the project that is to be updated.
- projectStatus (string) --
  
  Status of the project