Update Environment

datazone_update_environment

R Documentation

Updates the specified environment in Amazon DataZone

Description

Updates the specified environment in Amazon DataZone.

Usage

datazone_update_environment(domainIdentifier, identifier, name,
  description, glossaryTerms, blueprintVersion, userParameters,
  environmentConfigurationName)

Arguments

domainIdentifier	[required] The identifier of the domain in which the environment is to be updated.
identifier	[required] The identifier of the environment that is to be updated.
name	The name to be updated as part of the update_environment action.
description	The description to be updated as part of the update_environment action.
glossaryTerms	The glossary terms to be updated as part of the update_environment action.
blueprintVersion	The blueprint version to which the environment should be updated. You can only specify the following string for this parameter: latest.
userParameters	The user parameters of the environment.
environmentConfigurationName	The configuration name of the environment.

Value

A list with the following syntax:

list(
  projectId = "string",
  id = "string",
  domainId = "string",
  createdBy = "string",
  createdAt = as.POSIXct(
    "2015-01-01"
  ),
  updatedAt = as.POSIXct(
    "2015-01-01"
  ),
  name = "string",
  description = "string",
  environmentProfileId = "string",
  awsAccountId = "string",
  awsAccountRegion = "string",
  provider = "string",
  provisionedResources = list(
    list(
      provider = "string",
      name = "string",
      value = "string",
      type = "string"
    )
  ),
  status = "ACTIVE"|"CREATING"|"UPDATING"|"DELETING"|"CREATE_FAILED"|"UPDATE_FAILED"|"DELETE_FAILED"|"VALIDATION_FAILED"|"SUSPENDED"|"DISABLED"|"EXPIRED"|"DELETED"|"INACCESSIBLE",
  environmentActions = list(
    list(
      type = "string",
      auth = "IAM"|"HTTPS",
      parameters = list(
        list(
          key = "string",
          value = "string"
        )
      )
    )
  ),
  glossaryTerms = list(
    "string"
  ),
  userParameters = list(
    list(
      keyName = "string",
      description = "string",
      fieldType = "string",
      defaultValue = "string",
      isEditable = TRUE|FALSE,
      isOptional = TRUE|FALSE,
      isUpdateSupported = TRUE|FALSE
    )
  ),
  lastDeployment = list(
    deploymentId = "string",
    deploymentType = "CREATE"|"UPDATE"|"DELETE",
    deploymentStatus = "IN_PROGRESS"|"SUCCESSFUL"|"FAILED"|"PENDING_DEPLOYMENT",
    failureReason = list(
      code = "string",
      message = "string"
    ),
    messages = list(
      "string"
    ),
    isDeploymentComplete = TRUE|FALSE
  ),
  provisioningProperties = list(
    cloudFormation = list(
      templateUrl = "string"
    )
  ),
  deploymentProperties = list(
    startTimeoutMinutes = 123,
    endTimeoutMinutes = 123
  ),
  environmentBlueprintId = "string",
  environmentConfigurationId = "string",
  environmentConfigurationName = "string"
)

Request syntax

svc$update_environment(
  domainIdentifier = "string",
  identifier = "string",
  name = "string",
  description = "string",
  glossaryTerms = list(
    "string"
  ),
  blueprintVersion = "string",
  userParameters = list(
    list(
      name = "string",
      value = "string"
    )
  ),
  environmentConfigurationName = "string"
)