DataZone / Client / create_environment_profile

create_environment_profile

DataZone.Client.create_environment_profile(**kwargs)

Creates an Amazon DataZone environment profile.

See also: AWS API Documentation

Request Syntax

response = client.create_environment_profile(
    awsAccountId='string',
    awsAccountRegion='string',
    description='string',
    domainIdentifier='string',
    environmentBlueprintIdentifier='string',
    name='string',
    projectIdentifier='string',
    userParameters=[
        {
            'name': 'string',
            'value': 'string'
        },
    ]
)

Parameters:

• awsAccountId (string) – The Amazon Web Services account in which the Amazon DataZone environment is created.

• awsAccountRegion (string) – The Amazon Web Services region in which this environment profile is created.

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

• domainIdentifier (string) –

  [REQUIRED]

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

• environmentBlueprintIdentifier (string) –

  [REQUIRED]

  The ID of the blueprint with which this environment profile is created.

• name (string) –

  [REQUIRED]

  The name of this Amazon DataZone environment profile.

• projectIdentifier (string) –

  [REQUIRED]

  The identifier of the project in which to create the environment profile.

• userParameters (list) –

  The user parameters of this Amazon DataZone environment profile.

  • (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',
    'description': 'string',
    'domainId': 'string',
    'environmentBlueprintId': 'string',
    'id': 'string',
    'name': 'string',
    'projectId': 'string',
    '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 ID in which this Amazon DataZone environment profile is created.

  • awsAccountRegion (string) –

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

  • createdAt (datetime) –

    The timestamp of when this environment profile was created.

  • createdBy (string) –

    The Amazon DataZone user who created this environment profile.

  • description (string) –

    The description of this Amazon DataZone environment profile.

  • domainId (string) –

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

  • environmentBlueprintId (string) –

    The ID of the blueprint with which this environment profile is created.

  • id (string) –

    The ID of this Amazon DataZone environment profile.

  • name (string) –

    The name of this Amazon DataZone environment profile.

  • projectId (string) –

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

  • updatedAt (datetime) –

    The timestamp of when this environment profile was updated.

  • userParameters (list) –

    The user parameters of this Amazon DataZone environment profile.

    • (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.ServiceQuotaExceededException

• DataZone.Client.exceptions.ConflictException

• DataZone.Client.exceptions.ValidationException

• DataZone.Client.exceptions.UnauthorizedException