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.IotTwinMaker.ExecuteQuery

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Run queries to access information from your knowledge graph of entities within individual workspaces.

Synopsis

data ExecuteQuery = ExecuteQuery' {
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- workspaceId :: Text
- queryStatement :: Text
}
newExecuteQuery :: Text -> Text -> ExecuteQuery
executeQuery_maxResults :: Lens' ExecuteQuery (Maybe Natural)
executeQuery_nextToken :: Lens' ExecuteQuery (Maybe Text)
executeQuery_workspaceId :: Lens' ExecuteQuery Text
executeQuery_queryStatement :: Lens' ExecuteQuery Text
data ExecuteQueryResponse = ExecuteQueryResponse' {
- columnDescriptions :: Maybe [ColumnDescription]
- nextToken :: Maybe Text
- rows :: Maybe [Row]
- httpStatus :: Int
}
newExecuteQueryResponse :: Int -> ExecuteQueryResponse
executeQueryResponse_columnDescriptions :: Lens' ExecuteQueryResponse (Maybe [ColumnDescription])
executeQueryResponse_nextToken :: Lens' ExecuteQueryResponse (Maybe Text)
executeQueryResponse_rows :: Lens' ExecuteQueryResponse (Maybe [Row])
executeQueryResponse_httpStatus :: Lens' ExecuteQueryResponse Int

Creating a Request

data ExecuteQuery Source #

See: newExecuteQuery smart constructor.

Constructors

ExecuteQuery'
Fields maxResults :: Maybe Natural The maximum number of results to return at one time. The default is 25. Valid Range: Minimum value of 1. Maximum value of 250. nextToken :: Maybe Text The string that specifies the next page of results. workspaceId :: Text The ID of the workspace. queryStatement :: Text The query statement.

Instances

Instances details

ToJSON ExecuteQuery Source #
Instance details Defined in Amazonka.IotTwinMaker.ExecuteQuery Methods toJSON :: ExecuteQuery -> Value # toEncoding :: ExecuteQuery -> Encoding # toJSONList :: [ExecuteQuery] -> Value # toEncodingList :: [ExecuteQuery] -> Encoding #
ToHeaders ExecuteQuery Source #
Instance details Defined in Amazonka.IotTwinMaker.ExecuteQuery Methods toHeaders :: ExecuteQuery -> [Header] #
ToPath ExecuteQuery Source #
Instance details Defined in Amazonka.IotTwinMaker.ExecuteQuery Methods toPath :: ExecuteQuery -> ByteString #
ToQuery ExecuteQuery Source #
Instance details Defined in Amazonka.IotTwinMaker.ExecuteQuery Methods toQuery :: ExecuteQuery -> QueryString #
AWSRequest ExecuteQuery Source #
Instance details Defined in Amazonka.IotTwinMaker.ExecuteQuery Associated Types type AWSResponse ExecuteQuery # Methods request :: (Service -> Service) -> ExecuteQuery -> Request ExecuteQuery # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ExecuteQuery -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ExecuteQuery))) #
Generic ExecuteQuery Source #
Instance details Defined in Amazonka.IotTwinMaker.ExecuteQuery Associated Types type Rep ExecuteQuery :: Type -> Type # Methods from :: ExecuteQuery -> Rep ExecuteQuery x # to :: Rep ExecuteQuery x -> ExecuteQuery #
Read ExecuteQuery Source #
Instance details Defined in Amazonka.IotTwinMaker.ExecuteQuery Methods readsPrec :: Int -> ReadS ExecuteQuery # readList :: ReadS [ExecuteQuery] # readPrec :: ReadPrec ExecuteQuery # readListPrec :: ReadPrec [ExecuteQuery] #
Show ExecuteQuery Source #
Instance details Defined in Amazonka.IotTwinMaker.ExecuteQuery Methods showsPrec :: Int -> ExecuteQuery -> ShowS # show :: ExecuteQuery -> String # showList :: [ExecuteQuery] -> ShowS #
NFData ExecuteQuery Source #
Instance details Defined in Amazonka.IotTwinMaker.ExecuteQuery Methods rnf :: ExecuteQuery -> () #
Eq ExecuteQuery Source #
Instance details Defined in Amazonka.IotTwinMaker.ExecuteQuery Methods (==) :: ExecuteQuery -> ExecuteQuery -> Bool # (/=) :: ExecuteQuery -> ExecuteQuery -> Bool #
Hashable ExecuteQuery Source #
Instance details Defined in Amazonka.IotTwinMaker.ExecuteQuery Methods hashWithSalt :: Int -> ExecuteQuery -> Int # hash :: ExecuteQuery -> Int #
type AWSResponse ExecuteQuery Source #
Instance details Defined in Amazonka.IotTwinMaker.ExecuteQuery type AWSResponse ExecuteQuery = ExecuteQueryResponse
type Rep ExecuteQuery Source #
Instance details Defined in Amazonka.IotTwinMaker.ExecuteQuery type Rep ExecuteQuery = D1 ('MetaData "ExecuteQuery" "Amazonka.IotTwinMaker.ExecuteQuery" "amazonka-iottwinmaker-2.0-F9krWmdiZsuIxDlP9hNtjs" 'False) (C1 ('MetaCons "ExecuteQuery'" '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 "workspaceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "queryStatement") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newExecuteQuery Source #

Arguments

:: Text	`ExecuteQuery`
-> Text	`$sel:queryStatement:ExecuteQuery'`
-> ExecuteQuery

Create a value of ExecuteQuery 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:ExecuteQuery', executeQuery_maxResults - The maximum number of results to return at one time. The default is 25.

Valid Range: Minimum value of 1. Maximum value of 250.

ExecuteQuery, executeQuery_nextToken - The string that specifies the next page of results.

ExecuteQuery, executeQuery_workspaceId - The ID of the workspace.

$sel:queryStatement:ExecuteQuery', executeQuery_queryStatement - The query statement.

Request Lenses

executeQuery_maxResults :: Lens' ExecuteQuery (Maybe Natural) Source #

The maximum number of results to return at one time. The default is 25.

Valid Range: Minimum value of 1. Maximum value of 250.

executeQuery_nextToken :: Lens' ExecuteQuery (Maybe Text) Source #

The string that specifies the next page of results.

executeQuery_workspaceId :: Lens' ExecuteQuery Text Source #

The ID of the workspace.

executeQuery_queryStatement :: Lens' ExecuteQuery Text Source #

The query statement.

Destructuring the Response

data ExecuteQueryResponse Source #

See: newExecuteQueryResponse smart constructor.

Constructors

ExecuteQueryResponse'
Fields columnDescriptions :: Maybe [ColumnDescription] A list of ColumnDescription objects. nextToken :: Maybe Text The string that specifies the next page of results. rows :: Maybe [Row] Represents a single row in the query results. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic ExecuteQueryResponse Source #
Instance details Defined in Amazonka.IotTwinMaker.ExecuteQuery Associated Types type Rep ExecuteQueryResponse :: Type -> Type # Methods from :: ExecuteQueryResponse -> Rep ExecuteQueryResponse x # to :: Rep ExecuteQueryResponse x -> ExecuteQueryResponse #
Read ExecuteQueryResponse Source #
Instance details Defined in Amazonka.IotTwinMaker.ExecuteQuery Methods readsPrec :: Int -> ReadS ExecuteQueryResponse # readList :: ReadS [ExecuteQueryResponse] # readPrec :: ReadPrec ExecuteQueryResponse # readListPrec :: ReadPrec [ExecuteQueryResponse] #
Show ExecuteQueryResponse Source #
Instance details Defined in Amazonka.IotTwinMaker.ExecuteQuery Methods showsPrec :: Int -> ExecuteQueryResponse -> ShowS # show :: ExecuteQueryResponse -> String # showList :: [ExecuteQueryResponse] -> ShowS #
NFData ExecuteQueryResponse Source #
Instance details Defined in Amazonka.IotTwinMaker.ExecuteQuery Methods rnf :: ExecuteQueryResponse -> () #
Eq ExecuteQueryResponse Source #
Instance details Defined in Amazonka.IotTwinMaker.ExecuteQuery Methods (==) :: ExecuteQueryResponse -> ExecuteQueryResponse -> Bool # (/=) :: ExecuteQueryResponse -> ExecuteQueryResponse -> Bool #
type Rep ExecuteQueryResponse Source #
Instance details Defined in Amazonka.IotTwinMaker.ExecuteQuery type Rep ExecuteQueryResponse = D1 ('MetaData "ExecuteQueryResponse" "Amazonka.IotTwinMaker.ExecuteQuery" "amazonka-iottwinmaker-2.0-F9krWmdiZsuIxDlP9hNtjs" 'False) (C1 ('MetaCons "ExecuteQueryResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "columnDescriptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ColumnDescription])) :: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "rows") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Row])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newExecuteQueryResponse Source #

Arguments

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

Create a value of ExecuteQueryResponse 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:columnDescriptions:ExecuteQueryResponse', executeQueryResponse_columnDescriptions - A list of ColumnDescription objects.

ExecuteQuery, executeQueryResponse_nextToken - The string that specifies the next page of results.

$sel:rows:ExecuteQueryResponse', executeQueryResponse_rows - Represents a single row in the query results.

$sel:httpStatus:ExecuteQueryResponse', executeQueryResponse_httpStatus - The response's http status code.

Response Lenses

executeQueryResponse_columnDescriptions :: Lens' ExecuteQueryResponse (Maybe [ColumnDescription]) Source #

A list of ColumnDescription objects.

executeQueryResponse_nextToken :: Lens' ExecuteQueryResponse (Maybe Text) Source #

The string that specifies the next page of results.

executeQueryResponse_rows :: Lens' ExecuteQueryResponse (Maybe [Row]) Source #

Represents a single row in the query results.

executeQueryResponse_httpStatus :: Lens' ExecuteQueryResponse Int Source #

The response's http status code.