Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Athena.CreateWorkGroup

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a workgroup with the specified name. Only one of Configurations or Configuration can be specified; Configurations for a workgroup with multi engine support (for example, an Apache Spark enabled workgroup) or Configuration for an Athena SQL workgroup.

Creating a Request

data CreateWorkGroup Source #

See: newCreateWorkGroup smart constructor.

Constructors

CreateWorkGroup'

Fields

configuration :: Maybe WorkGroupConfiguration
Contains configuration information for creating an Athena SQL workgroup, which includes the location in Amazon S3 where query 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 :: Maybe Text
The workgroup description.
tags :: Maybe [Tag]
A list of comma separated tags to add to the workgroup that is created.
name :: Text
The workgroup name.

Instances

Instances details

ToJSON CreateWorkGroup Source #
Instance details Defined in Amazonka.Athena.CreateWorkGroup Methods toJSON :: CreateWorkGroup -> Value # toEncoding :: CreateWorkGroup -> Encoding # toJSONList :: [CreateWorkGroup] -> Value # toEncodingList :: [CreateWorkGroup] -> Encoding #
ToHeaders CreateWorkGroup Source #
Instance details Defined in Amazonka.Athena.CreateWorkGroup Methods toHeaders :: CreateWorkGroup -> [Header] #
ToPath CreateWorkGroup Source #
Instance details Defined in Amazonka.Athena.CreateWorkGroup Methods toPath :: CreateWorkGroup -> ByteString #
ToQuery CreateWorkGroup Source #
Instance details Defined in Amazonka.Athena.CreateWorkGroup Methods toQuery :: CreateWorkGroup -> QueryString #
AWSRequest CreateWorkGroup Source #
Instance details Defined in Amazonka.Athena.CreateWorkGroup Associated Types type AWSResponse CreateWorkGroup # Methods request :: (Service -> Service) -> CreateWorkGroup -> Request CreateWorkGroup # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateWorkGroup -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateWorkGroup))) #
Generic CreateWorkGroup Source #
Instance details Defined in Amazonka.Athena.CreateWorkGroup Associated Types type Rep CreateWorkGroup :: Type -> Type # Methods from :: CreateWorkGroup -> Rep CreateWorkGroup x # to :: Rep CreateWorkGroup x -> CreateWorkGroup #
Read CreateWorkGroup Source #
Instance details Defined in Amazonka.Athena.CreateWorkGroup Methods readsPrec :: Int -> ReadS CreateWorkGroup # readList :: ReadS [CreateWorkGroup] # readPrec :: ReadPrec CreateWorkGroup # readListPrec :: ReadPrec [CreateWorkGroup] #
Show CreateWorkGroup Source #
Instance details Defined in Amazonka.Athena.CreateWorkGroup Methods showsPrec :: Int -> CreateWorkGroup -> ShowS # show :: CreateWorkGroup -> String # showList :: [CreateWorkGroup] -> ShowS #
NFData CreateWorkGroup Source #
Instance details Defined in Amazonka.Athena.CreateWorkGroup Methods rnf :: CreateWorkGroup -> () #
Eq CreateWorkGroup Source #
Instance details Defined in Amazonka.Athena.CreateWorkGroup Methods (==) :: CreateWorkGroup -> CreateWorkGroup -> Bool # (/=) :: CreateWorkGroup -> CreateWorkGroup -> Bool #
Hashable CreateWorkGroup Source #
Instance details Defined in Amazonka.Athena.CreateWorkGroup Methods hashWithSalt :: Int -> CreateWorkGroup -> Int # hash :: CreateWorkGroup -> Int #
type AWSResponse CreateWorkGroup Source #
Instance details Defined in Amazonka.Athena.CreateWorkGroup type AWSResponse CreateWorkGroup = CreateWorkGroupResponse
type Rep CreateWorkGroup Source #
Instance details Defined in Amazonka.Athena.CreateWorkGroup type Rep CreateWorkGroup = D1 ('MetaData "CreateWorkGroup" "Amazonka.Athena.CreateWorkGroup" "amazonka-athena-2.0-1BJA3HTvHJNEzwQRaEw59w" 'False) (C1 ('MetaCons "CreateWorkGroup'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "configuration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WorkGroupConfiguration)) :: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newCreateWorkGroup Source #

Arguments

:: Text	`CreateWorkGroup`
-> CreateWorkGroup

Create a value of CreateWorkGroup with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CreateWorkGroup, createWorkGroup_configuration - Contains configuration information for creating an Athena SQL workgroup, which includes the location in Amazon S3 where query 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.

CreateWorkGroup, createWorkGroup_description - The workgroup description.

$sel:tags:CreateWorkGroup', createWorkGroup_tags - A list of comma separated tags to add to the workgroup that is created.

CreateWorkGroup, createWorkGroup_name - The workgroup name.

Request Lenses

createWorkGroup_configuration :: Lens' CreateWorkGroup (Maybe WorkGroupConfiguration) Source #

Contains configuration information for creating an Athena SQL workgroup, which includes the location in Amazon S3 where query 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.

createWorkGroup_description :: Lens' CreateWorkGroup (Maybe Text) Source #

The workgroup description.

createWorkGroup_tags :: Lens' CreateWorkGroup (Maybe [Tag]) Source #

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

createWorkGroup_name :: Lens' CreateWorkGroup Text Source #

The workgroup name.

Destructuring the Response

data CreateWorkGroupResponse Source #

See: newCreateWorkGroupResponse smart constructor.

Constructors

CreateWorkGroupResponse'
Fields httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CreateWorkGroupResponse Source #
Instance details Defined in Amazonka.Athena.CreateWorkGroup Associated Types type Rep CreateWorkGroupResponse :: Type -> Type # Methods from :: CreateWorkGroupResponse -> Rep CreateWorkGroupResponse x # to :: Rep CreateWorkGroupResponse x -> CreateWorkGroupResponse #
Read CreateWorkGroupResponse Source #
Instance details Defined in Amazonka.Athena.CreateWorkGroup Methods readsPrec :: Int -> ReadS CreateWorkGroupResponse # readList :: ReadS [CreateWorkGroupResponse] # readPrec :: ReadPrec CreateWorkGroupResponse # readListPrec :: ReadPrec [CreateWorkGroupResponse] #
Show CreateWorkGroupResponse Source #
Instance details Defined in Amazonka.Athena.CreateWorkGroup Methods showsPrec :: Int -> CreateWorkGroupResponse -> ShowS # show :: CreateWorkGroupResponse -> String # showList :: [CreateWorkGroupResponse] -> ShowS #
NFData CreateWorkGroupResponse Source #
Instance details Defined in Amazonka.Athena.CreateWorkGroup Methods rnf :: CreateWorkGroupResponse -> () #
Eq CreateWorkGroupResponse Source #
Instance details Defined in Amazonka.Athena.CreateWorkGroup Methods (==) :: CreateWorkGroupResponse -> CreateWorkGroupResponse -> Bool # (/=) :: CreateWorkGroupResponse -> CreateWorkGroupResponse -> Bool #
type Rep CreateWorkGroupResponse Source #
Instance details Defined in Amazonka.Athena.CreateWorkGroup type Rep CreateWorkGroupResponse = D1 ('MetaData "CreateWorkGroupResponse" "Amazonka.Athena.CreateWorkGroup" "amazonka-athena-2.0-1BJA3HTvHJNEzwQRaEw59w" 'False) (C1 ('MetaCons "CreateWorkGroupResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateWorkGroupResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateWorkGroupResponse'`
-> CreateWorkGroupResponse

Create a value of CreateWorkGroupResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:CreateWorkGroupResponse', createWorkGroupResponse_httpStatus - The response's http status code.

Response Lenses

createWorkGroupResponse_httpStatus :: Lens' CreateWorkGroupResponse Int Source #

The response's http status code.