Skip to content

Creates a workgroup with the specified name

Description

Creates a workgroup with the specified name. A workgroup can be an Apache Spark enabled workgroup or an Athena SQL workgroup.

Usage

athena_create_work_group(Name, Configuration, Description, Tags)

Arguments

  • Name

    [required] The workgroup name.

  • Configuration

    Contains configuration information for creating an Athena SQL workgroup or Spark enabled Athena workgroup. Athena SQL workgroup configuration includes the location in Amazon S3 where query and calculation results are stored, the encryption configuration, if any, used for encrypting query results, whether the Amazon CloudWatch Metrics are enabled for the workgroup, the limit for the amount of bytes scanned (cutoff) per query, if it is specified, and whether workgroup's settings (specified with EnforceWorkGroupConfiguration) in the WorkGroupConfiguration override client-side settings. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.

  • Description

    The workgroup description.

  • Tags

    A list of comma separated tags to add to the workgroup that is created.

Value

An empty list.

Request syntax

svc$create_work_group(
  Name = "string",
  Configuration = list(
    ResultConfiguration = list(
      OutputLocation = "string",
      EncryptionConfiguration = list(
        EncryptionOption = "SSE_S3"|"SSE_KMS"|"CSE_KMS",
        KmsKey = "string"
      ),
      ExpectedBucketOwner = "string",
      AclConfiguration = list(
        S3AclOption = "BUCKET_OWNER_FULL_CONTROL"
      )
    ),
    ManagedQueryResultsConfiguration = list(
      Enabled = TRUE|FALSE,
      EncryptionConfiguration = list(
        KmsKey = "string"
      )
    ),
    EnforceWorkGroupConfiguration = TRUE|FALSE,
    PublishCloudWatchMetricsEnabled = TRUE|FALSE,
    BytesScannedCutoffPerQuery = 123,
    RequesterPaysEnabled = TRUE|FALSE,
    EngineVersion = list(
      SelectedEngineVersion = "string",
      EffectiveEngineVersion = "string"
    ),
    AdditionalConfiguration = "string",
    ExecutionRole = "string",
    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"
          )
        )
      )
    ),
    CustomerContentEncryptionConfiguration = list(
      KmsKey = "string"
    ),
    EnableMinimumEncryptionConfiguration = TRUE|FALSE,
    IdentityCenterConfiguration = list(
      EnableIdentityCenter = TRUE|FALSE,
      IdentityCenterInstanceArn = "string"
    ),
    QueryResultsS3AccessGrantsConfiguration = list(
      EnableS3AccessGrants = TRUE|FALSE,
      CreateUserLevelPrefix = TRUE|FALSE,
      AuthenticationType = "DIRECTORY_IDENTITY"
    )
  ),
  Description = "string",
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  )
)