Amazonka.Athena.GetQueryResults

Streams the results of a single query execution specified by QueryExecutionId from the Athena query results location in Amazon S3. For more information, see Query Results in the Amazon Athena User Guide. This request does not execute the query but returns results. Use StartQueryExecution to run a query.

To stream query results successfully, the IAM principal with permission to call GetQueryResults also must have permissions to the Amazon S3 GetObject action for the Athena query results location.

IAM principals with permission to the Amazon S3 GetObject action for the query results location are able to retrieve query results from Amazon S3 even if permission to the GetQueryResults action is denied. To restrict user or role access, ensure that Amazon S3 permissions to the Athena query location are denied.

This operation returns paginated results.

Creating a Request

data GetQueryResults

See: newGetQueryResults smart constructor.

Constructors

GetQueryResults'

Fields

• maxResults :: Maybe Natural

  The maximum number of results (rows) to return in this request.

• nextToken :: Maybe Text

  A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.

• queryExecutionId :: Text

  The unique ID of the query execution.

Instances

ToJSON GetQueryResults

Defined in Amazonka.Athena.GetQueryResults

Methods

toJSON :: GetQueryResults -> Value

toEncoding :: GetQueryResults -> Encoding

toJSONList :: [GetQueryResults] -> Value

toEncodingList :: [GetQueryResults] -> Encoding

ToHeaders GetQueryResults

Defined in Amazonka.Athena.GetQueryResults

Methods

toHeaders :: GetQueryResults -> [Header]

ToPath GetQueryResults

Defined in Amazonka.Athena.GetQueryResults

Methods

toPath :: GetQueryResults -> ByteString

ToQuery GetQueryResults

Defined in Amazonka.Athena.GetQueryResults

Methods

toQuery :: GetQueryResults -> QueryString

AWSPager GetQueryResults

Defined in Amazonka.Athena.GetQueryResults

Methods

page :: GetQueryResults -> AWSResponse GetQueryResults -> Maybe GetQueryResults

AWSRequest GetQueryResults

Defined in Amazonka.Athena.GetQueryResults

Associated Types

type AWSResponse GetQueryResults

Methods

request :: (Service -> Service) -> GetQueryResults -> Request GetQueryResults

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetQueryResults -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetQueryResults)))

Generic GetQueryResults

Defined in Amazonka.Athena.GetQueryResults

Associated Types

type Rep GetQueryResults :: Type -> Type

Methods

from :: GetQueryResults -> Rep GetQueryResults x

to :: Rep GetQueryResults x -> GetQueryResults

Read GetQueryResults

Defined in Amazonka.Athena.GetQueryResults

Methods

readsPrec :: Int -> ReadS GetQueryResults

readList :: ReadS [GetQueryResults]

readPrec :: ReadPrec GetQueryResults

readListPrec :: ReadPrec [GetQueryResults]

Show GetQueryResults

Defined in Amazonka.Athena.GetQueryResults

Methods

showsPrec :: Int -> GetQueryResults -> ShowS

show :: GetQueryResults -> String

showList :: [GetQueryResults] -> ShowS

NFData GetQueryResults

Defined in Amazonka.Athena.GetQueryResults

Methods

rnf :: GetQueryResults -> ()

Eq GetQueryResults

Defined in Amazonka.Athena.GetQueryResults

Methods

(==) :: GetQueryResults -> GetQueryResults -> Bool

(/=) :: GetQueryResults -> GetQueryResults -> Bool

Hashable GetQueryResults

Defined in Amazonka.Athena.GetQueryResults

Methods

hashWithSalt :: Int -> GetQueryResults -> Int

hash :: GetQueryResults -> Int

type AWSResponse GetQueryResults

Defined in Amazonka.Athena.GetQueryResults

type AWSResponse GetQueryResults = GetQueryResultsResponse

type Rep GetQueryResults

Defined in Amazonka.Athena.GetQueryResults

type Rep GetQueryResults = D1 ('MetaData "GetQueryResults" "Amazonka.Athena.GetQueryResults" "amazonka-athena-2.0-1BJA3HTvHJNEzwQRaEw59w" 'False) (C1 ('MetaCons "GetQueryResults'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "queryExecutionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newGetQueryResults

Arguments

:: Text

GetQueryResults

-> GetQueryResults

Create a value of GetQueryResults 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:maxResults:GetQueryResults', getQueryResults_maxResults - The maximum number of results (rows) to return in this request.

GetQueryResults, getQueryResults_nextToken - A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.

GetQueryResults, getQueryResults_queryExecutionId - The unique ID of the query execution.

Request Lenses

getQueryResults_maxResults :: Lens' GetQueryResults (Maybe Natural)

The maximum number of results (rows) to return in this request.

getQueryResults_nextToken :: Lens' GetQueryResults (Maybe Text)

A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.

getQueryResults_queryExecutionId :: Lens' GetQueryResults Text

The unique ID of the query execution.

Destructuring the Response

data GetQueryResultsResponse

See: newGetQueryResultsResponse smart constructor.

Constructors

GetQueryResultsResponse'

Fields

• nextToken :: Maybe Text

  A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.

• resultSet :: Maybe ResultSet

  The results of the query execution.

• updateCount :: Maybe Integer

  The number of rows inserted with a CREATE TABLE AS SELECT statement.

• httpStatus :: Int

  The response's http status code.

Instances

Generic GetQueryResultsResponse

Defined in Amazonka.Athena.GetQueryResults

Associated Types

type Rep GetQueryResultsResponse :: Type -> Type

Methods

from :: GetQueryResultsResponse -> Rep GetQueryResultsResponse x

to :: Rep GetQueryResultsResponse x -> GetQueryResultsResponse

Read GetQueryResultsResponse

Defined in Amazonka.Athena.GetQueryResults

Methods

readsPrec :: Int -> ReadS GetQueryResultsResponse

readList :: ReadS [GetQueryResultsResponse]

readPrec :: ReadPrec GetQueryResultsResponse

readListPrec :: ReadPrec [GetQueryResultsResponse]

Show GetQueryResultsResponse

Defined in Amazonka.Athena.GetQueryResults

Methods

showsPrec :: Int -> GetQueryResultsResponse -> ShowS

show :: GetQueryResultsResponse -> String

showList :: [GetQueryResultsResponse] -> ShowS

NFData GetQueryResultsResponse

Defined in Amazonka.Athena.GetQueryResults

Methods

rnf :: GetQueryResultsResponse -> ()

Eq GetQueryResultsResponse

Defined in Amazonka.Athena.GetQueryResults

Methods

(==) :: GetQueryResultsResponse -> GetQueryResultsResponse -> Bool

(/=) :: GetQueryResultsResponse -> GetQueryResultsResponse -> Bool

type Rep GetQueryResultsResponse

Defined in Amazonka.Athena.GetQueryResults

type Rep GetQueryResultsResponse = D1 ('MetaData "GetQueryResultsResponse" "Amazonka.Athena.GetQueryResults" "amazonka-athena-2.0-1BJA3HTvHJNEzwQRaEw59w" 'False) (C1 ('MetaCons "GetQueryResultsResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "resultSet") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ResultSet))) :*: (S1 ('MetaSel ('Just "updateCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetQueryResultsResponse

Arguments

:: Int

$sel:httpStatus:GetQueryResultsResponse'

-> GetQueryResultsResponse

Create a value of GetQueryResultsResponse 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:

GetQueryResults, getQueryResultsResponse_nextToken - A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.

$sel:resultSet:GetQueryResultsResponse', getQueryResultsResponse_resultSet - The results of the query execution.

$sel:updateCount:GetQueryResultsResponse', getQueryResultsResponse_updateCount - The number of rows inserted with a CREATE TABLE AS SELECT statement.

$sel:httpStatus:GetQueryResultsResponse', getQueryResultsResponse_httpStatus - The response's http status code.

Response Lenses

getQueryResultsResponse_nextToken :: Lens' GetQueryResultsResponse (Maybe Text)

A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.

getQueryResultsResponse_resultSet :: Lens' GetQueryResultsResponse (Maybe ResultSet)

The results of the query execution.

getQueryResultsResponse_updateCount :: Lens' GetQueryResultsResponse (Maybe Integer)

The number of rows inserted with a CREATE TABLE AS SELECT statement.

getQueryResultsResponse_httpStatus :: Lens' GetQueryResultsResponse Int

The response's http status code.