Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Athena.CreateNamedQuery

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a named query in the specified workgroup. Requires that you have access to the workgroup.

For code samples using the Amazon Web Services SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.

Synopsis

data CreateNamedQuery = CreateNamedQuery' {
- clientRequestToken :: Maybe Text
- description :: Maybe Text
- workGroup :: Maybe Text
- name :: Text
- database :: Text
- queryString :: Text
}
newCreateNamedQuery :: Text -> Text -> Text -> CreateNamedQuery
createNamedQuery_clientRequestToken :: Lens' CreateNamedQuery (Maybe Text)
createNamedQuery_description :: Lens' CreateNamedQuery (Maybe Text)
createNamedQuery_workGroup :: Lens' CreateNamedQuery (Maybe Text)
createNamedQuery_name :: Lens' CreateNamedQuery Text
createNamedQuery_database :: Lens' CreateNamedQuery Text
createNamedQuery_queryString :: Lens' CreateNamedQuery Text
data CreateNamedQueryResponse = CreateNamedQueryResponse' {
- namedQueryId :: Maybe Text
- httpStatus :: Int
}
newCreateNamedQueryResponse :: Int -> CreateNamedQueryResponse
createNamedQueryResponse_namedQueryId :: Lens' CreateNamedQueryResponse (Maybe Text)
createNamedQueryResponse_httpStatus :: Lens' CreateNamedQueryResponse Int

Creating a Request

data CreateNamedQuery Source #

See: newCreateNamedQuery smart constructor.

Constructors

CreateNamedQuery'

Fields

clientRequestToken :: Maybe Text
A unique case-sensitive string used to ensure the request to create the query is idempotent (executes only once). If another CreateNamedQuery request is received, the same response is returned and another query is not created. If a parameter has changed, for example, the QueryString, an error is returned.
This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) auto-generate the token for users. If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide this token or the action will fail.
description :: Maybe Text
The query description.
workGroup :: Maybe Text
The name of the workgroup in which the named query is being created.
name :: Text
The query name.
database :: Text
The database to which the query belongs.
queryString :: Text
The contents of the query with all query statements.

Instances

Instances details

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

newCreateNamedQuery Source #

Arguments

:: Text	`$sel:name:CreateNamedQuery'`
-> Text	`$sel:database:CreateNamedQuery'`
-> Text	`$sel:queryString:CreateNamedQuery'`
-> CreateNamedQuery

Create a value of CreateNamedQuery 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:clientRequestToken:CreateNamedQuery', createNamedQuery_clientRequestToken - A unique case-sensitive string used to ensure the request to create the query is idempotent (executes only once). If another CreateNamedQuery request is received, the same response is returned and another query is not created. If a parameter has changed, for example, the QueryString, an error is returned.

This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) auto-generate the token for users. If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide this token or the action will fail.

$sel:description:CreateNamedQuery', createNamedQuery_description - The query description.

$sel:workGroup:CreateNamedQuery', createNamedQuery_workGroup - The name of the workgroup in which the named query is being created.

$sel:name:CreateNamedQuery', createNamedQuery_name - The query name.

$sel:database:CreateNamedQuery', createNamedQuery_database - The database to which the query belongs.

$sel:queryString:CreateNamedQuery', createNamedQuery_queryString - The contents of the query with all query statements.

Request Lenses

createNamedQuery_clientRequestToken :: Lens' CreateNamedQuery (Maybe Text) Source #

A unique case-sensitive string used to ensure the request to create the query is idempotent (executes only once). If another CreateNamedQuery request is received, the same response is returned and another query is not created. If a parameter has changed, for example, the QueryString, an error is returned.

This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) auto-generate the token for users. If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide this token or the action will fail.

createNamedQuery_description :: Lens' CreateNamedQuery (Maybe Text) Source #

The query description.

createNamedQuery_workGroup :: Lens' CreateNamedQuery (Maybe Text) Source #

The name of the workgroup in which the named query is being created.

createNamedQuery_name :: Lens' CreateNamedQuery Text Source #

The query name.

createNamedQuery_database :: Lens' CreateNamedQuery Text Source #

The database to which the query belongs.

createNamedQuery_queryString :: Lens' CreateNamedQuery Text Source #

The contents of the query with all query statements.

Destructuring the Response

data CreateNamedQueryResponse Source #

See: newCreateNamedQueryResponse smart constructor.

Constructors

CreateNamedQueryResponse'
Fields namedQueryId :: Maybe Text The unique ID of the query. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newCreateNamedQueryResponse Source #

Arguments

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

Create a value of CreateNamedQueryResponse 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:namedQueryId:CreateNamedQueryResponse', createNamedQueryResponse_namedQueryId - The unique ID of the query.

$sel:httpStatus:CreateNamedQueryResponse', createNamedQueryResponse_httpStatus - The response's http status code.

Response Lenses

createNamedQueryResponse_namedQueryId :: Lens' CreateNamedQueryResponse (Maybe Text) Source #

The unique ID of the query.

createNamedQueryResponse_httpStatus :: Lens' CreateNamedQueryResponse Int Source #

The response's http status code.