Get Work Group

athena_get_work_group

R Documentation

Returns information about the workgroup with the specified name

Description

Returns information about the workgroup with the specified name.

Usage

athena_get_work_group(WorkGroup)

Arguments

WorkGroup

[required] The name of the workgroup.

Value

A list with the following syntax:

list(
  WorkGroup = list(
    Name = "string",
    State = "ENABLED"|"DISABLED",
    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",
    CreationTime = as.POSIXct(
      "2015-01-01"
    ),
    IdentityCenterApplicationArn = "string"
  )
)

Request syntax

svc$get_work_group(
  WorkGroup = "string"
)