DataZone / Client / update_environment_profile

update_environment_profile#

DataZone.Client.update_environment_profile(**kwargs)#

Updates the specified environment profile in Amazon DataZone.

See also: AWS API Documentation

Request Syntax

response = client.update_environment_profile(
    awsAccountId='string',
    awsAccountRegion='string',
    description='string',
    domainIdentifier='string',
    identifier='string',
    name='string',
    userParameters=[
        {
            'name': 'string',
            'value': 'string'
        },
    ]
)
Parameters:

  • awsAccountId (string) – The Amazon Web Services account in which a specified environment profile is to be udpated.

  • awsAccountRegion (string) – The Amazon Web Services Region in which a specified environment profile is to be updated.

  • description (string) – The description to be updated as part of the UpdateEnvironmentProfile action.

  • domainIdentifier (string) –

    [REQUIRED]

    The identifier of the Amazon DataZone domain in which an environment profile is to be updated.

  • identifier (string) –

    [REQUIRED]

    The identifier of the environment profile that is to be updated.

  • name (string) – The name to be updated as part of the UpdateEnvironmentProfile action.

  • userParameters (list) –

    The user parameters to be updated as part of the UpdateEnvironmentProfile action.

    • (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 in which a specified environment profile is to be udpated.

    • awsAccountRegion (string) –

      The Amazon Web Services Region in which a specified environment profile is to be updated.

    • createdAt (datetime) –

      The timestamp of when the environment profile was created.

    • createdBy (string) –

      The Amazon DataZone user who created the environment profile.

    • description (string) –

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

    • domainId (string) –

      The identifier of the Amazon DataZone domain in which the environment profile is to be updated.

    • environmentBlueprintId (string) –

      The identifier of the blueprint of the environment profile that is to be updated.

    • id (string) –

      The identifier of the environment profile that is to be udpated.

    • name (string) –

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

    • projectId (string) –

      The identifier of the project of the environment profile that is to be updated.

    • updatedAt (datetime) –

      The timestamp of when the environment profile was updated.

    • userParameters (list) –

      The user parameters to be updated as part of the UpdateEnvironmentProfile action.

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