Skip to content

Updates the workgroup with the specified name

Description

Updates the workgroup with the specified name. The workgroup's name cannot be changed. Only ConfigurationUpdates can be specified.

Usage

athena_update_work_group(WorkGroup, Description, ConfigurationUpdates,
  State)

Arguments

  • WorkGroup

    [required] The specified workgroup that will be updated.

  • Description

    The workgroup description.

  • ConfigurationUpdates

    Contains configuration updates for an Athena SQL workgroup.

  • State

    The workgroup state that will be updated for the given workgroup.

Value

An empty list.

Request syntax

svc$update_work_group(
  WorkGroup = "string",
  Description = "string",
  ConfigurationUpdates = list(
    EnforceWorkGroupConfiguration = TRUE|FALSE,
    ResultConfigurationUpdates = list(
      OutputLocation = "string",
      RemoveOutputLocation = TRUE|FALSE,
      EncryptionConfiguration = list(
        EncryptionOption = "SSE_S3"|"SSE_KMS"|"CSE_KMS",
        KmsKey = "string"
      ),
      RemoveEncryptionConfiguration = TRUE|FALSE,
      ExpectedBucketOwner = "string",
      RemoveExpectedBucketOwner = TRUE|FALSE,
      AclConfiguration = list(
        S3AclOption = "BUCKET_OWNER_FULL_CONTROL"
      ),
      RemoveAclConfiguration = TRUE|FALSE
    ),
    ManagedQueryResultsConfigurationUpdates = list(
      Enabled = TRUE|FALSE,
      EncryptionConfiguration = list(
        KmsKey = "string"
      ),
      RemoveEncryptionConfiguration = TRUE|FALSE
    ),
    PublishCloudWatchMetricsEnabled = TRUE|FALSE,
    BytesScannedCutoffPerQuery = 123,
    RemoveBytesScannedCutoffPerQuery = TRUE|FALSE,
    RequesterPaysEnabled = TRUE|FALSE,
    EngineVersion = list(
      SelectedEngineVersion = "string",
      EffectiveEngineVersion = "string"
    ),
    RemoveCustomerContentEncryptionConfiguration = TRUE|FALSE,
    AdditionalConfiguration = "string",
    ExecutionRole = "string",
    CustomerContentEncryptionConfiguration = list(
      KmsKey = "string"
    ),
    EnableMinimumEncryptionConfiguration = TRUE|FALSE,
    QueryResultsS3AccessGrantsConfiguration = list(
      EnableS3AccessGrants = TRUE|FALSE,
      CreateUserLevelPrefix = TRUE|FALSE,
      AuthenticationType = "DIRECTORY_IDENTITY"
    ),
    MonitoringConfiguration = list(
      CloudWatchLoggingConfiguration = list(
        Enabled = TRUE|FALSE,
        LogGroup = "string",
        LogStreamNamePrefix = "string",
        LogTypes = list(
          list(
            "string"
          )
        )
      ),
      ManagedLoggingConfiguration = list(
        Enabled = TRUE|FALSE,
        KmsKey = "string"
      ),
      S3LoggingConfiguration = list(
        Enabled = TRUE|FALSE,
        KmsKey = "string",
        LogLocation = "string"
      )
    ),
    EngineConfiguration = list(
      CoordinatorDpuSize = 123,
      MaxConcurrentDpus = 123,
      DefaultExecutorDpuSize = 123,
      AdditionalConfigs = list(
        "string"
      ),
      SparkProperties = list(
        "string"
      ),
      Classifications = list(
        list(
          Name = "string",
          Properties = list(
            "string"
          )
        )
      )
    )
  ),
  State = "ENABLED"|"DISABLED"
)