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.ListSyncResources

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists the sync resources.

Synopsis

data ListSyncResources = ListSyncResources' {
- filters :: Maybe [SyncResourceFilter]
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- workspaceId :: Text
- syncSource :: Text
}
newListSyncResources :: Text -> Text -> ListSyncResources
listSyncResources_filters :: Lens' ListSyncResources (Maybe [SyncResourceFilter])
listSyncResources_maxResults :: Lens' ListSyncResources (Maybe Natural)
listSyncResources_nextToken :: Lens' ListSyncResources (Maybe Text)
listSyncResources_workspaceId :: Lens' ListSyncResources Text
listSyncResources_syncSource :: Lens' ListSyncResources Text
data ListSyncResourcesResponse = ListSyncResourcesResponse' {
- nextToken :: Maybe Text
- syncResources :: Maybe [SyncResourceSummary]
- httpStatus :: Int
}
newListSyncResourcesResponse :: Int -> ListSyncResourcesResponse
listSyncResourcesResponse_nextToken :: Lens' ListSyncResourcesResponse (Maybe Text)
listSyncResourcesResponse_syncResources :: Lens' ListSyncResourcesResponse (Maybe [SyncResourceSummary])
listSyncResourcesResponse_httpStatus :: Lens' ListSyncResourcesResponse Int

Creating a Request

data ListSyncResources Source #

See: newListSyncResources smart constructor.

Constructors

ListSyncResources'

Fields

filters :: Maybe [SyncResourceFilter]
A list of objects that filter the request.
maxResults :: Maybe Natural
The maximum number of results to return at one time. The default is 50.
Valid Range: Minimum value of 0. Maximum value of 200.
nextToken :: Maybe Text
The string that specifies the next page of results.
workspaceId :: Text
The ID of the workspace that contains the sync job.
syncSource :: Text
The sync soucre.
Currently the only supported syncSoucre is SITEWISE .

Instances

Instances details

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

newListSyncResources Source #

Arguments

:: Text	`ListSyncResources`
-> Text	`ListSyncResources`
-> ListSyncResources

Create a value of ListSyncResources 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:filters:ListSyncResources', listSyncResources_filters - A list of objects that filter the request.

$sel:maxResults:ListSyncResources', listSyncResources_maxResults - The maximum number of results to return at one time. The default is 50.

Valid Range: Minimum value of 0. Maximum value of 200.

ListSyncResources, listSyncResources_nextToken - The string that specifies the next page of results.

ListSyncResources, listSyncResources_workspaceId - The ID of the workspace that contains the sync job.

ListSyncResources, listSyncResources_syncSource - The sync soucre.

Currently the only supported syncSoucre is SITEWISE .

Request Lenses

listSyncResources_filters :: Lens' ListSyncResources (Maybe [SyncResourceFilter]) Source #

A list of objects that filter the request.

listSyncResources_maxResults :: Lens' ListSyncResources (Maybe Natural) Source #

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

Valid Range: Minimum value of 0. Maximum value of 200.

listSyncResources_nextToken :: Lens' ListSyncResources (Maybe Text) Source #

The string that specifies the next page of results.

listSyncResources_workspaceId :: Lens' ListSyncResources Text Source #

The ID of the workspace that contains the sync job.

listSyncResources_syncSource :: Lens' ListSyncResources Text Source #

The sync soucre.

Currently the only supported syncSoucre is SITEWISE .

Destructuring the Response

data ListSyncResourcesResponse Source #

See: newListSyncResourcesResponse smart constructor.

Constructors

ListSyncResourcesResponse'
Fields nextToken :: Maybe Text The string that specifies the next page of results. syncResources :: Maybe [SyncResourceSummary] The sync resources. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newListSyncResourcesResponse Source #

Arguments

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

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

ListSyncResources, listSyncResourcesResponse_nextToken - The string that specifies the next page of results.

$sel:syncResources:ListSyncResourcesResponse', listSyncResourcesResponse_syncResources - The sync resources.

$sel:httpStatus:ListSyncResourcesResponse', listSyncResourcesResponse_httpStatus - The response's http status code.

Response Lenses

listSyncResourcesResponse_nextToken :: Lens' ListSyncResourcesResponse (Maybe Text) Source #

The string that specifies the next page of results.

listSyncResourcesResponse_syncResources :: Lens' ListSyncResourcesResponse (Maybe [SyncResourceSummary]) Source #

The sync resources.

listSyncResourcesResponse_httpStatus :: Lens' ListSyncResourcesResponse Int Source #

The response's http status code.