DataZone / Client / list_environment_blueprints

list_environment_blueprints#

DataZone.Client.list_environment_blueprints(**kwargs)#

Lists blueprints in an Amazon DataZone environment.

Request Syntax

response = client.list_environment_blueprints(
    domainIdentifier='string',
    managed=True|False,
    maxResults=123,
    name='string',
    nextToken='string'
)

Parameters:

domainIdentifier (string) –
[REQUIRED]

The identifier of the Amazon DataZone domain.
managed (boolean) – Specifies whether the environment blueprint is managed by Amazon DataZone.
maxResults (integer) – The maximum number of blueprints to return in a single call to ListEnvironmentBlueprints. When the number of blueprints 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 ListEnvironmentBlueprints to list the next set of blueprints.
name (string) – The name of the Amazon DataZone environment.
nextToken (string) – When the number of blueprints in the environment 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 blueprints in the environment, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ``ListEnvironmentBlueprints``to list the next set of blueprints.

Return type:

dict

Returns:

Response Syntax

{
    'items': [
        {
            'createdAt': datetime(2015, 1, 1),
            'description': 'string',
            'id': 'string',
            'name': 'string',
            'provider': 'string',
            'provisioningProperties': {
                'cloudFormation': {
                    'templateUrl': 'string'
                }
            },
            'updatedAt': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- items (list) –
  
  The results of the ListEnvironmentBlueprints action.
  - (dict) –
    
    The details of an environment blueprint summary.
    - createdAt (datetime) –
      
      The timestamp of when an environment blueprint was created.
    - description (string) –
      
      The description of a blueprint.
    - id (string) –
      
      The identifier of the blueprint.
    - name (string) –
      
      The name of the blueprint.
    - provider (string) –
      
      The provider of the blueprint.
    - provisioningProperties (dict) –
      
      The provisioning properties of the blueprint.
      Note
      This is a Tagged Union structure. Only one of the following top level keys will be set: cloudFormation. 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'}
      - cloudFormation (dict) –
        
        The cloud formation properties included as part of the provisioning properties of an environment blueprint.
        
        templateUrl (string) –
        
        The template URL of the cloud formation provisioning properties of the environment blueprint.
    - updatedAt (datetime) –
      
      The timestamp of when the blueprint was enabled.
- nextToken (string) –
  
  When the number of blueprints in the environment 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 blueprints in the environment, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ``ListEnvironmentBlueprints``to list the next set of blueprints.

Exceptions

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