DataZone / Client / create_environment

create_environment

DataZone.Client.create_environment(**kwargs)

Create an Amazon DataZone environment.

See also: AWS API Documentation

Request Syntax

response = client.create_environment(
    description='string',
    domainIdentifier='string',
    environmentAccountIdentifier='string',
    environmentAccountRegion='string',
    environmentBlueprintIdentifier='string',
    environmentProfileIdentifier='string',
    glossaryTerms=[
        'string',
    ],
    name='string',
    projectIdentifier='string',
    userParameters=[
        {
            'name': 'string',
            'value': 'string'
        },
    ]
)

Parameters:

• description (string) – The description of the Amazon DataZone environment.

• domainIdentifier (string) –

  [REQUIRED]

  The identifier of the Amazon DataZone domain in which the environment is created.

• environmentAccountIdentifier (string) – The ID of the account in which the environment is being created.

• environmentAccountRegion (string) – The region of the account in which the environment is being created.

• environmentBlueprintIdentifier (string) – The ID of the blueprint with which the environment is being created.

• environmentProfileIdentifier (string) –

  [REQUIRED]

  The identifier of the environment profile that is used to create this Amazon DataZone environment.

• glossaryTerms (list) –

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

  • (string) –

• name (string) –

  [REQUIRED]

  The name of the Amazon DataZone environment.

• projectIdentifier (string) –

  [REQUIRED]

  The identifier of the Amazon DataZone project in which this environment is created.

• userParameters (list) –

  The user parameters of this Amazon DataZone environment.

  • (dict) –

    The parameter details of an evironment profile.

    • name (string) –

      The name of an environment profile parameter.

    • value (string) –

      The value of an environment profile parameter.

Return type:

dict

Returns:

Response Syntax

{
    'awsAccountId': 'string',
    'awsAccountRegion': 'string',
    'createdAt': datetime(2015, 1, 1),
    'createdBy': 'string',
    'deploymentProperties': {
        'endTimeoutMinutes': 123,
        'startTimeoutMinutes': 123
    },
    'description': 'string',
    'domainId': 'string',
    'environmentActions': [
        {
            'auth': 'IAM'|'HTTPS',
            'parameters': [
                {
                    'key': 'string',
                    'value': 'string'
                },
            ],
            'type': 'string'
        },
    ],
    'environmentBlueprintId': 'string',
    'environmentProfileId': 'string',
    'glossaryTerms': [
        'string',
    ],
    'id': 'string',
    'lastDeployment': {
        'deploymentId': 'string',
        'deploymentStatus': 'IN_PROGRESS'|'SUCCESSFUL'|'FAILED'|'PENDING_DEPLOYMENT',
        'deploymentType': 'CREATE'|'UPDATE'|'DELETE',
        'failureReason': {
            'code': 'string',
            'message': 'string'
        },
        'isDeploymentComplete': True|False,
        'messages': [
            'string',
        ]
    },
    'name': 'string',
    'projectId': 'string',
    'provider': 'string',
    'provisionedResources': [
        {
            'name': 'string',
            'provider': 'string',
            'type': 'string',
            'value': 'string'
        },
    ],
    'provisioningProperties': {
        'cloudFormation': {
            'templateUrl': 'string'
        }
    },
    'status': 'ACTIVE'|'CREATING'|'UPDATING'|'DELETING'|'CREATE_FAILED'|'UPDATE_FAILED'|'DELETE_FAILED'|'VALIDATION_FAILED'|'SUSPENDED'|'DISABLED'|'EXPIRED'|'DELETED'|'INACCESSIBLE',
    'updatedAt': datetime(2015, 1, 1),
    'userParameters': [
        {
            'defaultValue': 'string',
            'description': 'string',
            'fieldType': 'string',
            'isEditable': True|False,
            'isOptional': True|False,
            'keyName': 'string'
        },
    ]
}

Response Structure

• (dict) –

  • awsAccountId (string) –

    The Amazon Web Services account in which the Amazon DataZone environment is created.

  • awsAccountRegion (string) –

    The Amazon Web Services region in which the Amazon DataZone environment is created.

  • createdAt (datetime) –

    The timestamp of when the environment was created.

  • createdBy (string) –

    The Amazon DataZone user who created this environment.

  • deploymentProperties (dict) –

    The deployment properties of this Amazon DataZone environment.

    • endTimeoutMinutes (integer) –

      The end timeout of the environment blueprint deployment.

    • startTimeoutMinutes (integer) –

      The start timeout of the environment blueprint deployment.

  • description (string) –

    The description of this Amazon DataZone environment.

  • domainId (string) –

    The identifier of the Amazon DataZone domain in which the environment is created.

  • environmentActions (list) –

    The configurable actions of this Amazon DataZone environment.

    • (dict) –

      The configurable action of a Amazon DataZone environment.

      • auth (string) –

        The authentication type of a configurable action of a Amazon DataZone environment.

      • parameters (list) –

        The parameters of a configurable action in a Amazon DataZone environment.

        • (dict) –

          The details of the parameters for the configurable environment action.

          • key (string) –

            The key of the configurable action parameter.

          • value (string) –

            The value of the configurable action parameter.

      • type (string) –

        The type of a configurable action in a Amazon DataZone environment.

  • environmentBlueprintId (string) –

    The ID of the blueprint with which this Amazon DataZone environment was created.

  • environmentProfileId (string) –

    The ID of the environment profile with which this Amazon DataZone environment was created.

  • glossaryTerms (list) –

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

    • (string) –

  • id (string) –

    The ID of this Amazon DataZone environment.

  • lastDeployment (dict) –

    The details of the last deployment of this Amazon DataZone environment.

    • deploymentId (string) –

      The identifier of the last deployment of the environment.

    • deploymentStatus (string) –

      The status of the last deployment of the environment.

    • deploymentType (string) –

      The type of the last deployment of the environment.

    • failureReason (dict) –

      The failure reason of the last deployment of the environment.

      • code (string) –

        The error code for the failure reason for the environment deployment.

      • message (string) –

        The error message for the failure reason for the environment deployment.

    • isDeploymentComplete (boolean) –

      Specifies whether the last deployment of the environment is complete.

    • messages (list) –

      The messages of the last deployment of the environment.

      • (string) –

  • name (string) –

    The name of this environment.

  • projectId (string) –

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

  • provider (string) –

    The provider of this Amazon DataZone environment.

  • provisionedResources (list) –

    The provisioned resources of this Amazon DataZone environment.

    • (dict) –

      The details of a provisioned resource of this Amazon DataZone environment.

      • name (string) –

        The name of a provisioned resource of this Amazon DataZone environment.

      • provider (string) –

        The provider of a provisioned resource of this Amazon DataZone environment.

      • type (string) –

        The type of a provisioned resource of this Amazon DataZone environment.

      • value (string) –

        The value of a provisioned resource of this Amazon DataZone environment.

  • provisioningProperties (dict) –

    The provisioning properties of this Amazon DataZone environment.

    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.

  • status (string) –

    The status of this Amazon DataZone environment.

  • updatedAt (datetime) –

    The timestamp of when this environment was updated.

  • userParameters (list) –

    The user parameters of this Amazon DataZone environment.

    • (dict) –

      The details of user parameters of an environment blueprint.

      • defaultValue (string) –

        The default value of the parameter.

      • description (string) –

        The description of the parameter.

      • fieldType (string) –

        The filed type of the parameter.

      • isEditable (boolean) –

        Specifies whether the parameter is editable.

      • isOptional (boolean) –

        Specifies whether the custom parameter is optional.

      • keyName (string) –

        The key name of the parameter.

Exceptions

• DataZone.Client.exceptions.InternalServerException

• DataZone.Client.exceptions.ResourceNotFoundException

• DataZone.Client.exceptions.AccessDeniedException

• DataZone.Client.exceptions.ThrottlingException

• DataZone.Client.exceptions.ConflictException

• DataZone.Client.exceptions.ValidationException

• DataZone.Client.exceptions.UnauthorizedException