DataZone / Client / get_environment_profile

get_environment_profile#

DataZone.Client.get_environment_profile(**kwargs)#

Gets an evinronment profile in Amazon DataZone.

See also: AWS API Documentation

Request Syntax

response = client.get_environment_profile(
    domainIdentifier='string',
    identifier='string'
)
Parameters:

  • domainIdentifier (string) –

    [REQUIRED]

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

  • identifier (string) –

    [REQUIRED]

    The ID of the environment profile.

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 ID of the Amazon Web Services account where this environment profile exists.

    • awsAccountRegion (string) –

      The Amazon Web Services region where this environment profile exists.

    • 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 the environment profile.

    • domainId (string) –

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

    • environmentBlueprintId (string) –

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

    • id (string) –

      The ID of the environment profile.

    • name (string) –

      The name of the 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 upated.

    • userParameters (list) –

      The user parameters of the 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